ab76e873bdb3566e47942d61c1cf5b600a0f4974
[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 space after the first
5493 colon in the example above is necessary. If it 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 won't matter, but if you
6428   # have to comment it out then this will at least log whether you succeed
6429   # 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
8792 .next
8793 Any of the single-key lookup type names may be preceded by
8794 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
8795 .code
8796 domains = partial-dbm;/partial/domains
8797 .endd
8798 This causes partial matching logic to be invoked; a description of how this
8799 works is given in section &<<SECTpartiallookup>>&.
8800
8801 .next
8802 .cindex "asterisk" "in lookup type"
8803 Any of the single-key lookup types may be followed by an asterisk. This causes
8804 a default lookup for a key consisting of a single asterisk to be done if the
8805 original lookup fails. This is not a useful feature when using a domain list to
8806 select particular domains (because any domain would match), but it might have
8807 value if the result of the lookup is being used via the &$domain_data$&
8808 expansion variable.
8809
8810 .next
8811 If the pattern starts with the name of a query-style lookup type followed by a
8812 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
8813 pattern must be an appropriate query for the lookup type, as described in
8814 chapter &<<CHAPfdlookup>>&. For example:
8815 .code
8816 hold_domains = mysql;select domain from holdlist \
8817   where domain = '${quote_mysql:$domain}';
8818 .endd
8819 In most cases, the value resulting from the lookup is not used (so for an SQL query, for
8820 example, it doesn't matter what field you select). Exim is interested only in
8821 whether or not the query succeeds. However, when a lookup is used for the
8822 &%domains%& option on a router, the value is preserved in the &$domain_data$&
8823 variable and can be referred to in other options.
8824 .cindex "tainted data" "de-tainting"
8825 The value will be untainted.
8826
8827 .next
8828 If the pattern starts with the name of a lookup type
8829 of either kind (single-key or query-style) it may be
8830 followed by a comma and options,
8831 The options are lookup-type specific and consist of a comma-separated list.
8832 Each item starts with a tag and and equals "=".
8833
8834 .next
8835 .cindex "domain list" "matching literal domain name"
8836 If none of the above cases apply, a caseless textual comparison is made
8837 between the pattern and the domain.
8838
8839 The value for a match will be the list element string.
8840 .cindex "tainted data" "de-tainting"
8841 Note that this is commonly untainted
8842 (depending on the way the list was created).
8843 Specifically, explicit text in the configuration file in not tainted.
8844 This is a useful way of obtaining an untainted equivalent to
8845 the domain, for later operations.
8846
8847 However if the list (including one-element lists)
8848 is created by expanding a variable containing tainted data,
8849 it is tainted and so will the match value be.
8850 .endlist
8851
8852
8853 Here is an example that uses several different kinds of pattern:
8854 .code
8855 domainlist funny_domains = \
8856   @ : \
8857   lib.unseen.edu : \
8858   *.foundation.fict.example : \
8859   \N^[1-2]\d{3}\.fict\.example$\N : \
8860   partial-dbm;/opt/data/penguin/book : \
8861   nis;domains.byname : \
8862   nisplus;[name=$domain,status=local],domains.org_dir
8863 .endd
8864 There are obvious processing trade-offs among the various matching modes. Using
8865 an asterisk is faster than a regular expression, and listing a few names
8866 explicitly probably is too. The use of a file or database lookup is expensive,
8867 but may be the only option if hundreds of names are required. Because the
8868 patterns are tested in order, it makes sense to put the most commonly matched
8869 patterns earlier.
8870
8871
8872
8873 .section "Host lists" "SECThostlist"
8874 .cindex "host list" "patterns in"
8875 .cindex "list" "host list"
8876 Host lists are used to control what remote hosts are allowed to do. For
8877 example, some hosts may be allowed to use the local host as a relay, and some
8878 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8879 two different ways, by name or by IP address. In a host list, some types of
8880 pattern are matched to a host name, and some are matched to an IP address.
8881 You need to be particularly careful with this when single-key lookups are
8882 involved, to ensure that the right value is being used as the key.
8883
8884
8885 .section "Special host list patterns" "SECID80"
8886 .cindex "empty item in hosts list"
8887 .cindex "host list" "empty string in"
8888 If a host list item is the empty string, it matches only when no remote host is
8889 involved. This is the case when a message is being received from a local
8890 process using SMTP on the standard input, that is, when a TCP/IP connection is
8891 not used.
8892
8893 .cindex "asterisk" "in host list"
8894 The special pattern &"*"& in a host list matches any host or no host. Neither
8895 the IP address nor the name is actually inspected.
8896
8897
8898
8899 .section "Host list patterns that match by IP address" "SECThoslispatip"
8900 .cindex "host list" "matching IP addresses"
8901 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8902 the incoming address actually appears in the IPv6 host as
8903 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8904 list, it is converted into a traditional IPv4 address first. (Not all operating
8905 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8906 concerns.)
8907
8908 The following types of pattern in a host list check the remote host by
8909 inspecting its IP address:
8910
8911 .ilist
8912 If the pattern is a plain domain name (not a regular expression, not starting
8913 with *, not a lookup of any kind), Exim calls the operating system function
8914 to find the associated IP address(es). Exim uses the newer
8915 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8916 This typically causes a forward DNS lookup of the name. The result is compared
8917 with the IP address of the subject host.
8918
8919 If there is a temporary problem (such as a DNS timeout) with the host name
8920 lookup, a temporary error occurs. For example, if the list is being used in an
8921 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8922 temporary SMTP error code. If no IP address can be found for the host name,
8923 what happens is described in section &<<SECTbehipnot>>& below.
8924
8925 .next
8926 .cindex "@ in a host list"
8927 If the pattern is &"@"&, the primary host name is substituted and used as a
8928 domain name, as just described.
8929
8930 .next
8931 If the pattern is an IP address, it is matched against the IP address of the
8932 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8933 IPv6 addresses can be given in colon-separated format, but the colons have to
8934 be doubled so as not to be taken as item separators when the default list
8935 separator is used. IPv6 addresses are recognized even when Exim is compiled
8936 without IPv6 support. This means that if they appear in a host list on an
8937 IPv4-only host, Exim will not treat them as host names. They are just addresses
8938 that can never match a client host.
8939
8940 .next
8941 .cindex "@[] in a host list"
8942 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8943 the local host. For example, if the local host is an IPv4 host with one
8944 interface address 10.45.23.56, these two ACL statements have the same effect:
8945 .code
8946 accept hosts = 127.0.0.1 : 10.45.23.56
8947 accept hosts = @[]
8948 .endd
8949 .next
8950 .cindex "CIDR notation"
8951 If the pattern is an IP address followed by a slash and a mask length (for
8952 example 10.11.42.0/24), it is matched against the IP address of the subject
8953 host under the given mask. This allows, an entire network of hosts to be
8954 included (or excluded) by a single item. The mask uses CIDR notation; it
8955 specifies the number of address bits that must match, starting from the most
8956 significant end of the address.
8957
8958 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8959 of a range of addresses. It is the number of bits in the network portion of the
8960 address. The above example specifies a 24-bit netmask, so it matches all 256
8961 addresses in the 10.11.42.0 network. An item such as
8962 .code
8963 192.168.23.236/31
8964 .endd
8965 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8966 32 for an IPv4 address is the same as no mask at all; just a single address
8967 matches.
8968
8969 Here is another example which shows an IPv4 and an IPv6 network:
8970 .code
8971 recipient_unqualified_hosts = 192.168.0.0/16: \
8972                               3ffe::ffff::836f::::/48
8973 .endd
8974 The doubling of list separator characters applies only when these items
8975 appear inline in a host list. It is not required when indirecting via a file.
8976 For example:
8977 .code
8978 recipient_unqualified_hosts = /opt/exim/unqualnets
8979 .endd
8980 could make use of a file containing
8981 .code
8982 172.16.0.0/12
8983 3ffe:ffff:836f::/48
8984 .endd
8985 to have exactly the same effect as the previous example. When listing IPv6
8986 addresses inline, it is usually more convenient to use the facility for
8987 changing separator characters. This list contains the same two networks:
8988 .code
8989 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8990                                  3ffe:ffff:836f::/48
8991 .endd
8992 The separator is changed to semicolon by the leading &"<;"& at the start of the
8993 list.
8994 .endlist
8995
8996
8997
8998 .section "Host list patterns for single-key lookups by host address" &&&
8999          "SECThoslispatsikey"
9000 .cindex "host list" "lookup of IP address"
9001 When a host is to be identified by a single-key lookup of its complete IP
9002 address, the pattern takes this form:
9003 .display
9004 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
9005 .endd
9006 For example:
9007 .code
9008 hosts_lookup = net-cdb;/hosts-by-ip.db
9009 .endd
9010 The text form of the IP address of the subject host is used as the lookup key.
9011 IPv6 addresses are converted to an unabbreviated form, using lower case
9012 letters, with dots as separators because colon is the key terminator in
9013 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
9014 quoting the keys, but this is a facility that was added later.] The data
9015 returned by the lookup is not used.
9016
9017 .cindex "IP address" "masking"
9018 .cindex "host list" "masked IP address"
9019 Single-key lookups can also be performed using masked IP addresses, using
9020 patterns of this form:
9021 .display
9022 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
9023 .endd
9024 For example:
9025 .code
9026 net24-dbm;/networks.db
9027 .endd
9028 The IP address of the subject host is masked using <&'number'&> as the mask
9029 length. A textual string is constructed from the masked value, followed by the
9030 mask, and this is used as the lookup key. For example, if the host's IP address
9031 is 192.168.34.6, the key that is looked up for the above example is
9032 &"192.168.34.0/24"&.
9033
9034 When an IPv6 address is converted to a string, dots are normally used instead
9035 of colons, so that keys in &(lsearch)& files need not contain colons (which
9036 terminate &(lsearch)& keys). This was implemented some time before the ability
9037 to quote keys was made available in &(lsearch)& files. However, the more
9038 recently implemented &(iplsearch)& files do require colons in IPv6 keys
9039 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
9040 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
9041 converted using colons and not dots.
9042 In all cases except IPv4-mapped IPv6, full, unabbreviated IPv6
9043 addresses are always used.
9044 The latter are converted to IPv4 addresses, in dotted-quad form.
9045
9046 Ideally, it would be nice to tidy up this anomalous situation by changing to
9047 colons in all cases, given that quoting is now available for &(lsearch)&.
9048 However, this would be an incompatible change that might break some existing
9049 configurations.
9050
9051 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
9052 IPv6 address) is not the same as specifying just &%net-%& without a number. In
9053 the former case the key strings include the mask value, whereas in the latter
9054 case the IP address is used on its own.
9055
9056
9057
9058 .section "Host list patterns that match by host name" "SECThoslispatnam"
9059 .cindex "host" "lookup failures"
9060 .cindex "unknown host name"
9061 .cindex "host list" "matching host name"
9062 There are several types of pattern that require Exim to know the name of the
9063 remote host. These are either wildcard patterns or lookups by name. (If a
9064 complete hostname is given without any wildcarding, it is used to find an IP
9065 address to match against, as described in section &<<SECThoslispatip>>&
9066 above.)
9067
9068 If the remote host name is not already known when Exim encounters one of these
9069 patterns, it has to be found from the IP address.
9070 Although many sites on the Internet are conscientious about maintaining reverse
9071 DNS data for their hosts, there are also many that do not do this.
9072 Consequently, a name cannot always be found, and this may lead to unwanted
9073 effects. Take care when configuring host lists with wildcarded name patterns.
9074 Consider what will happen if a name cannot be found.
9075
9076 Because of the problems of determining host names from IP addresses, matching
9077 against host names is not as common as matching against IP addresses.
9078
9079 By default, in order to find a host name, Exim first does a reverse DNS lookup;
9080 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
9081 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
9082 are done can be changed by setting the &%host_lookup_order%& option. For
9083 security, once Exim has found one or more names, it looks up the IP addresses
9084 for these names and compares them with the IP address that it started with.
9085 Only those names whose IP addresses match are accepted. Any other names are
9086 discarded. If no names are left, Exim behaves as if the host name cannot be
9087 found. In the most common case there is only one name and one IP address.
9088
9089 There are some options that control what happens if a host name cannot be
9090 found. These are described in section &<<SECTbehipnot>>& below.
9091
9092 .cindex "host" "alias for"
9093 .cindex "alias for host"
9094 As a result of aliasing, hosts may have more than one name. When processing any
9095 of the following types of pattern, all the host's names are checked:
9096
9097 .ilist
9098 .cindex "asterisk" "in host list"
9099 If a pattern starts with &"*"& the remainder of the item must match the end of
9100 the host name. For example, &`*.b.c`& matches all hosts whose names end in
9101 &'.b.c'&. This special simple form is provided because this is a very common
9102 requirement. Other kinds of wildcarding require the use of a regular
9103 expression.
9104 .next
9105 .cindex "regular expressions" "in host list"
9106 .cindex "host list" "regular expression in"
9107 If the item starts with &"^"& it is taken to be a regular expression which is
9108 matched against the host name. Host names are case-independent, so this regular
9109 expression match is by default case-independent, but you can make it
9110 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
9111 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
9112 example,
9113 .code
9114 ^(a|b)\.c\.d$
9115 .endd
9116 is a regular expression that matches either of the two hosts &'a.c.d'& or
9117 &'b.c.d'&. When a regular expression is used in a host list, you must take care
9118 that backslash and dollar characters are not misinterpreted as part of the
9119 string expansion. The simplest way to do this is to use &`\N`& to mark that
9120 part of the string as non-expandable. For example:
9121 .code
9122 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
9123 .endd
9124 &*Warning*&: If you want to match a complete host name, you must include the
9125 &`$`& terminating metacharacter in the regular expression, as in the above
9126 example. Without it, a match at the start of the host name is all that is
9127 required.
9128 .endlist
9129
9130
9131
9132
9133 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
9134 .cindex "host" "lookup failures, permanent"
9135 While processing a host list, Exim may need to look up an IP address from a
9136 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
9137 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
9138 behaviour when it fails to find the information it is seeking is the same.
9139
9140 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
9141 apply to temporary DNS errors, whose handling is described in the next section.
9142
9143 .cindex "&`+include_unknown`&"
9144 .cindex "&`+ignore_unknown`&"
9145 Exim parses a host list from left to right. If it encounters a permanent
9146 lookup failure in any item in the host list before it has found a match,
9147 Exim treats it as a failure and the default behavior is as if the host
9148 does not match the list. This may not always be what you want to happen.
9149 To change Exim's behaviour, the special items &`+include_unknown`& or
9150 &`+ignore_unknown`& may appear in the list (at top level &-- they are
9151 not recognized in an indirected file).
9152
9153 .ilist
9154 If any item that follows &`+include_unknown`& requires information that
9155 cannot found, Exim behaves as if the host does match the list. For example,
9156 .code
9157 host_reject_connection = +include_unknown:*.enemy.ex
9158 .endd
9159 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
9160 any hosts whose name it cannot find.
9161
9162 .next
9163 If any item that follows &`+ignore_unknown`& requires information that cannot
9164 be found, Exim ignores that item and proceeds to the rest of the list. For
9165 example:
9166 .code
9167 accept hosts = +ignore_unknown : friend.example : \
9168                192.168.4.5
9169 .endd
9170 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
9171 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
9172 name can be found for 192.168.4.5, it is rejected.
9173 .endlist
9174
9175 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
9176 list. The effect of each one lasts until the next, or until the end of the
9177 list.
9178
9179 .section "Mixing wildcarded host names and addresses in host lists" &&&
9180          "SECTmixwilhos"
9181 .cindex "host list" "mixing names and addresses in"
9182
9183 This section explains the host/ip processing logic with the same concepts
9184 as the previous section, but specifically addresses what happens when a
9185 wildcarded hostname is one of the items in the hostlist.
9186
9187 .ilist
9188 If you have name lookups or wildcarded host names and
9189 IP addresses in the same host list, you should normally put the IP
9190 addresses first. For example, in an ACL you could have:
9191 .code
9192 accept hosts = 10.9.8.7 : *.friend.example
9193 .endd
9194 The reason you normally would order it this way lies in the
9195 left-to-right way that Exim processes lists.  It can test IP addresses
9196 without doing any DNS lookups, but when it reaches an item that requires
9197 a host name, it fails if it cannot find a host name to compare with the
9198 pattern. If the above list is given in the opposite order, the
9199 &%accept%& statement fails for a host whose name cannot be found, even
9200 if its IP address is 10.9.8.7.
9201
9202 .next
9203 If you really do want to do the name check first, and still recognize the IP
9204 address, you can rewrite the ACL like this:
9205 .code
9206 accept hosts = *.friend.example
9207 accept hosts = 10.9.8.7
9208 .endd
9209 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
9210 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
9211 &`+ignore_unknown`&, which was discussed in depth in the first example in
9212 this section.
9213 .endlist
9214
9215
9216 .section "Temporary DNS errors when looking up host information" &&&
9217          "SECTtemdnserr"
9218 .cindex "host" "lookup failures, temporary"
9219 .cindex "&`+include_defer`&"
9220 .cindex "&`+ignore_defer`&"
9221 A temporary DNS lookup failure normally causes a defer action (except when
9222 &%dns_again_means_nonexist%& converts it into a permanent error). However,
9223 host lists can include &`+ignore_defer`& and &`+include_defer`&, analogous to
9224 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
9225 section. These options should be used with care, probably only in non-critical
9226 host lists such as whitelists.
9227
9228
9229
9230 .section "Host list patterns for single-key lookups by host name" &&&
9231          "SECThoslispatnamsk"
9232 .cindex "unknown host name"
9233 .cindex "host list" "matching host name"
9234 If a pattern is of the form
9235 .display
9236 <&'single-key-search-type'&>;<&'search-data'&>
9237 .endd
9238 for example
9239 .code
9240 dbm;/host/accept/list
9241 .endd
9242 a single-key lookup is performed, using the host name as its key. If the
9243 lookup succeeds, the host matches the item. The actual data that is looked up
9244 is not used.
9245
9246 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
9247 keys in the file, not IP addresses. If you want to do lookups based on IP
9248 addresses, you must precede the search type with &"net-"& (see section
9249 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
9250 two items in the same list, one doing an address lookup and one doing a name
9251 lookup, both using the same file.
9252
9253
9254
9255 .section "Host list patterns for query-style lookups" "SECID81"
9256 If a pattern is of the form
9257 .display
9258 <&'query-style-search-type'&>;<&'query'&>
9259 .endd
9260 the query is obeyed, and if it succeeds, the host matches the item. The actual
9261 data that is looked up is not used. The variables &$sender_host_address$& and
9262 &$sender_host_name$& can be used in the query. For example:
9263 .code
9264 hosts_lookup = pgsql;\
9265   select ip from hostlist where ip='$sender_host_address'
9266 .endd
9267 The value of &$sender_host_address$& for an IPv6 address contains colons. You
9268 can use the &%sg%& expansion item to change this if you need to. If you want to
9269 use masked IP addresses in database queries, you can use the &%mask%& expansion
9270 operator.
9271
9272 If the query contains a reference to &$sender_host_name$&, Exim automatically
9273 looks up the host name if it has not already done so. (See section
9274 &<<SECThoslispatnam>>& for comments on finding host names.)
9275
9276 Historical note: prior to release 4.30, Exim would always attempt to find a
9277 host name before running the query, unless the search type was preceded by
9278 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
9279 still recognized for query-style lookups, but its presence or absence has no
9280 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
9281 See section &<<SECThoslispatsikey>>&.)
9282
9283
9284
9285
9286
9287 .section "Address lists" "SECTaddresslist"
9288 .cindex "list" "address list"
9289 .cindex "address list" "empty item"
9290 .cindex "address list" "patterns"
9291 Address lists contain patterns that are matched against mail addresses. There
9292 is one special case to be considered: the sender address of a bounce message is
9293 always empty. You can test for this by providing an empty item in an address
9294 list. For example, you can set up a router to process bounce messages by
9295 using this option setting:
9296 .code
9297 senders = :
9298 .endd
9299 The presence of the colon creates an empty item. If you do not provide any
9300 data, the list is empty and matches nothing. The empty sender can also be
9301 detected by a regular expression that matches an empty string,
9302 and by a query-style lookup that succeeds when &$sender_address$& is empty.
9303
9304 Non-empty items in an address list can be straightforward email addresses. For
9305 example:
9306 .code
9307 senders = jbc@askone.example : hs@anacreon.example
9308 .endd
9309 A certain amount of wildcarding is permitted. If a pattern contains an @
9310 character, but is not a regular expression and does not begin with a
9311 semicolon-terminated lookup type (described below), the local part of the
9312 subject address is compared with the local part of the pattern, which may start
9313 with an asterisk. If the local parts match, the domain is checked in exactly
9314 the same way as for a pattern in a domain list. For example, the domain can be
9315 wildcarded, refer to a named list, or be a lookup:
9316 .code
9317 deny senders = *@*.spamming.site:\
9318                *@+hostile_domains:\
9319                bozo@partial-lsearch;/list/of/dodgy/sites:\
9320                *@dbm;/bad/domains.db
9321 .endd
9322 .cindex "local part" "starting with !"
9323 .cindex "address list" "local part starting with !"
9324 If a local part that begins with an exclamation mark is required, it has to be
9325 specified using a regular expression, because otherwise the exclamation mark is
9326 treated as a sign of negation, as is standard in lists.
9327
9328 If a non-empty pattern that is not a regular expression or a lookup does not
9329 contain an @ character, it is matched against the domain part of the subject
9330 address. The only two formats that are recognized this way are a literal
9331 domain, or a domain pattern that starts with *. In both these cases, the effect
9332 is the same as if &`*@`& preceded the pattern. For example:
9333 .code
9334 deny senders = enemy.domain : *.enemy.domain
9335 .endd
9336
9337 The following kinds of more complicated address list pattern can match any
9338 address, including the empty address that is characteristic of bounce message
9339 senders:
9340
9341 .ilist
9342 .cindex "regular expressions" "in address list"
9343 .cindex "address list" "regular expression in"
9344 If (after expansion) a pattern starts with &"^"&, a regular expression match is
9345 done against the complete address, with the pattern as the regular expression.
9346 You must take care that backslash and dollar characters are not misinterpreted
9347 as part of the string expansion. The simplest way to do this is to use &`\N`&
9348 to mark that part of the string as non-expandable. For example:
9349 .code
9350 deny senders = \N^.*this.*@example\.com$\N : \
9351                \N^\d{8}.+@spamhaus.example$\N : ...
9352 .endd
9353 The &`\N`& sequences are removed by the expansion, so these items do indeed
9354 start with &"^"& by the time they are being interpreted as address patterns.
9355
9356 .next
9357 .cindex "address list" "lookup for complete address"
9358 Complete addresses can be looked up by using a pattern that starts with a
9359 lookup type terminated by a semicolon, followed by the data for the lookup. For
9360 example:
9361 .code
9362 deny senders = cdb;/etc/blocked.senders : \
9363   mysql;select address from blocked where \
9364   address='${quote_mysql:$sender_address}'
9365 .endd
9366 Both query-style and single-key lookup types can be used. For a single-key
9367 lookup type, Exim uses the complete address as the key. However, empty keys are
9368 not supported for single-key lookups, so a match against the empty address
9369 always fails. This restriction does not apply to query-style lookups.
9370
9371 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
9372 cannot be used, and is ignored if specified, with an entry being written to the
9373 panic log.
9374 .cindex "*@ with single-key lookup"
9375 However, you can configure lookup defaults, as described in section
9376 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
9377 default. For example, with this lookup:
9378 .code
9379 accept senders = lsearch*@;/some/file
9380 .endd
9381 the file could contains lines like this:
9382 .code
9383 user1@domain1.example
9384 *@domain2.example
9385 .endd
9386 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
9387 that are tried is:
9388 .code
9389 nimrod@jaeger.example
9390 *@jaeger.example
9391 *
9392 .endd
9393 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
9394 would mean that every address matches, thus rendering the test useless.
9395
9396 &*Warning 2*&: Do not confuse these two kinds of item:
9397 .code
9398 deny recipients = dbm*@;/some/file
9399 deny recipients = *@dbm;/some/file
9400 .endd
9401 The first does a whole address lookup, with defaulting, as just described,
9402 because it starts with a lookup type. The second matches the local part and
9403 domain independently, as described in a bullet point below.
9404 .endlist
9405
9406
9407 The following kinds of address list pattern can match only non-empty addresses.
9408 If the subject address is empty, a match against any of these pattern types
9409 always fails.
9410
9411
9412 .ilist
9413 .cindex "@@ with single-key lookup"
9414 .cindex "address list" "@@ lookup type"
9415 .cindex "address list" "split local part and domain"
9416 If a pattern starts with &"@@"& followed by a single-key lookup item
9417 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
9418 split into a local part and a domain. The domain is looked up in the file. If
9419 it is not found, there is no match. If it is found, the data that is looked up
9420 from the file is treated as a colon-separated list of local part patterns, each
9421 of which is matched against the subject local part in turn.
9422
9423 .cindex "asterisk" "in address list"
9424 The lookup may be a partial one, and/or one involving a search for a default
9425 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
9426 patterns that are looked up can be regular expressions or begin with &"*"&, or
9427 even be further lookups. They may also be independently negated. For example,
9428 with
9429 .code
9430 deny senders = @@dbm;/etc/reject-by-domain
9431 .endd
9432 the data from which the DBM file is built could contain lines like
9433 .code
9434 baddomain.com:  !postmaster : *
9435 .endd
9436 to reject all senders except &%postmaster%& from that domain.
9437
9438 .cindex "local part" "starting with !"
9439 If a local part that actually begins with an exclamation mark is required, it
9440 has to be specified using a regular expression. In &(lsearch)& files, an entry
9441 may be split over several lines by indenting the second and subsequent lines,
9442 but the separating colon must still be included at line breaks. White space
9443 surrounding the colons is ignored. For example:
9444 .code
9445 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
9446   spammer3 : spammer4
9447 .endd
9448 As in all colon-separated lists in Exim, a colon can be included in an item by
9449 doubling.
9450
9451 If the last item in the list starts with a right angle-bracket, the remainder
9452 of the item is taken as a new key to look up in order to obtain a continuation
9453 list of local parts. The new key can be any sequence of characters. Thus one
9454 might have entries like
9455 .code
9456 aol.com: spammer1 : spammer 2 : >*
9457 xyz.com: spammer3 : >*
9458 *:       ^\d{8}$
9459 .endd
9460 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
9461 local parts for all domains, in addition to the specific local parts listed for
9462 each domain. Of course, using this feature costs another lookup each time a
9463 chain is followed, but the effort needed to maintain the data is reduced.
9464
9465 .cindex "loop" "in lookups"
9466 It is possible to construct loops using this facility, and in order to catch
9467 them, the chains may be no more than fifty items long.
9468
9469 .next
9470 The @@<&'lookup'&> style of item can also be used with a query-style
9471 lookup, but in this case, the chaining facility is not available. The lookup
9472 can only return a single list of local parts.
9473 .endlist
9474
9475 &*Warning*&: There is an important difference between the address list items
9476 in these two examples:
9477 .code
9478 senders = +my_list
9479 senders = *@+my_list
9480 .endd
9481 In the first one, &`my_list`& is a named address list, whereas in the second
9482 example it is a named domain list.
9483
9484
9485
9486
9487 .section "Case of letters in address lists" "SECTcasletadd"
9488 .cindex "case of local parts"
9489 .cindex "address list" "case forcing"
9490 .cindex "case forcing in address lists"
9491 Domains in email addresses are always handled caselessly, but for local parts
9492 case may be significant on some systems (see &%caseful_local_part%& for how
9493 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
9494 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
9495 blocking lists should be done in a case-independent manner. Since most address
9496 lists in Exim are used for this kind of control, Exim attempts to do this by
9497 default.
9498
9499 The domain portion of an address is always lowercased before matching it to an
9500 address list. The local part is lowercased by default, and any string
9501 comparisons that take place are done caselessly. This means that the data in
9502 the address list itself, in files included as plain filenames, and in any file
9503 that is looked up using the &"@@"& mechanism, can be in any case. However, the
9504 keys in files that are looked up by a search type other than &(lsearch)& (which
9505 works caselessly) must be in lower case, because these lookups are not
9506 case-independent.
9507
9508 .cindex "&`+caseful`&"
9509 To allow for the possibility of caseful address list matching, if an item in
9510 an address list is the string &"+caseful"&, the original case of the local
9511 part is restored for any comparisons that follow, and string comparisons are no
9512 longer case-independent. This does not affect the domain, which remains in
9513 lower case. However, although independent matches on the domain alone are still
9514 performed caselessly, regular expressions that match against an entire address
9515 become case-sensitive after &"+caseful"& has been seen.
9516
9517
9518
9519 .section "Local part lists" "SECTlocparlis"
9520 .cindex "list" "local part list"
9521 .cindex "local part" "list"
9522 These behave in the same way as domain and host lists, with the following
9523 changes:
9524
9525 Case-sensitivity in local part lists is handled in the same way as for address
9526 lists, as just described. The &"+caseful"& item can be used if required. In a
9527 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
9528 set false, the subject is lowercased and the matching is initially
9529 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
9530 matching in the local part list, but not elsewhere in the router. If
9531 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
9532 option is case-sensitive from the start.
9533
9534 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
9535 comments are handled in the same way as address lists &-- they are recognized
9536 only if the # is preceded by white space or the start of the line.
9537 Otherwise, local part lists are matched in the same way as domain lists, except
9538 that the special items that refer to the local host (&`@`&, &`@[]`&,
9539 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
9540 Refer to section &<<SECTdomainlist>>& for details of the other available item
9541 types.
9542 .ecindex IIDdohoadli
9543
9544
9545
9546
9547 . ////////////////////////////////////////////////////////////////////////////
9548 . ////////////////////////////////////////////////////////////////////////////
9549
9550 .chapter "String expansions" "CHAPexpand"
9551 .scindex IIDstrexp "expansion" "of strings"
9552 Many strings in Exim's runtime configuration are expanded before use. Some of
9553 them are expanded every time they are used; others are expanded only once.
9554
9555 When a string is being expanded it is copied verbatim from left to right except
9556 .cindex expansion "string concatenation"
9557 when a dollar or backslash character is encountered. A dollar specifies the
9558 start of a portion of the string that is interpreted and replaced as described
9559 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
9560 escape character, as described in the following section.
9561
9562 Whether a string is expanded depends upon the context.  Usually this is solely
9563 dependent upon the option for which a value is sought; in this documentation,
9564 options for which string expansion is performed are marked with &dagger; after
9565 the data type.  ACL rules always expand strings.  A couple of expansion
9566 conditions do not expand some of the brace-delimited branches, for security
9567 reasons,
9568 .cindex "tainted data" expansion
9569 .cindex "tainted data" definition
9570 .cindex expansion "tainted data"
9571 and expansion of data deriving from the sender (&"tainted data"&)
9572 .new
9573 is not permitted (including acessing a file using a tainted name).
9574 .wen
9575
9576 .new
9577 Common ways of obtaining untainted equivalents of variables with
9578 tainted values
9579 .cindex "tainted data" "de-tainting"
9580 come down to using the tainted value as a lookup key in a trusted database.
9581 This database could be the filesystem structure,
9582 or the password file,
9583 or accessed via a DBMS.
9584 Specific methods are indexed under &"de-tainting"&.
9585 .wen
9586
9587
9588
9589 .section "Literal text in expanded strings" "SECTlittext"
9590 .cindex "expansion" "including literal text"
9591 An uninterpreted dollar can be included in an expanded string by putting a
9592 backslash in front of it. A backslash can be used to prevent any special
9593 character being treated specially in an expansion, including backslash itself.
9594 If the string appears in quotes in the configuration file, two backslashes are
9595 required because the quotes themselves cause interpretation of backslashes when
9596 the string is read in (see section &<<SECTstrings>>&).
9597
9598 .cindex "expansion" "non-expandable substrings"
9599 A portion of the string can specified as non-expandable by placing it between
9600 two occurrences of &`\N`&. This is particularly useful for protecting regular
9601 expressions, which often contain backslashes and dollar signs. For example:
9602 .code
9603 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
9604 .endd
9605 On encountering the first &`\N`&, the expander copies subsequent characters
9606 without interpretation until it reaches the next &`\N`& or the end of the
9607 string.
9608
9609
9610
9611 .section "Character escape sequences in expanded strings" "SECID82"
9612 .cindex "expansion" "escape sequences"
9613 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
9614 expanded string is recognized as an escape sequence for the character newline,
9615 carriage return, or tab, respectively. A backslash followed by up to three
9616 octal digits is recognized as an octal encoding for a single character, and a
9617 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
9618 encoding.
9619
9620 These escape sequences are also recognized in quoted strings when they are read
9621 in. Their interpretation in expansions as well is useful for unquoted strings,
9622 and for other cases such as looked-up strings that are then expanded.
9623
9624
9625 .section "Testing string expansions" "SECID83"
9626 .cindex "expansion" "testing"
9627 .cindex "testing" "string expansion"
9628 .oindex "&%-be%&"
9629 Many expansions can be tested by calling Exim with the &%-be%& option. This
9630 takes the command arguments, or lines from the standard input if there are no
9631 arguments, runs them through the string expansion code, and writes the results
9632 to the standard output. Variables based on configuration values are set up, but
9633 since no message is being processed, variables such as &$local_part$& have no
9634 value. Nevertheless the &%-be%& option can be useful for checking out file and
9635 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
9636 and &%nhash%&.
9637
9638 Exim gives up its root privilege when it is called with the &%-be%& option, and
9639 instead runs under the uid and gid it was called with, to prevent users from
9640 using &%-be%& for reading files to which they do not have access.
9641
9642 .oindex "&%-bem%&"
9643 If you want to test expansions that include variables whose values are taken
9644 from a message, there are two other options that can be used. The &%-bem%&
9645 option is like &%-be%& except that it is followed by a filename. The file is
9646 read as a message before doing the test expansions. For example:
9647 .code
9648 exim -bem /tmp/test.message '$h_subject:'
9649 .endd
9650 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
9651 Exim message identifier. For example:
9652 .code
9653 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
9654 .endd
9655 This loads the message from Exim's spool before doing the test expansions, and
9656 is therefore restricted to admin users.
9657
9658
9659 .section "Forced expansion failure" "SECTforexpfai"
9660 .cindex "expansion" "forced failure"
9661 A number of expansions that are described in the following section have
9662 alternative &"true"& and &"false"& substrings, enclosed in brace characters
9663 (which are sometimes called &"curly brackets"&). Which of the two strings is
9664 used depends on some condition that is evaluated as part of the expansion. If,
9665 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
9666 the entire string expansion fails in a way that can be detected by the code
9667 that requested the expansion. This is called &"forced expansion failure"&, and
9668 its consequences depend on the circumstances. In some cases it is no different
9669 from any other expansion failure, but in others a different action may be
9670 taken. Such variations are mentioned in the documentation of the option that is
9671 being expanded.
9672
9673
9674
9675
9676 .section "Expansion items" "SECTexpansionitems"
9677 The following items are recognized in expanded strings. White space may be used
9678 between sub-items that are keywords or substrings enclosed in braces inside an
9679 outer set of braces, to improve readability. &*Warning*&: Within braces,
9680 white space is significant.
9681
9682 .vlist
9683 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
9684 .cindex "expansion" "variables"
9685 Substitute the contents of the named variable, for example:
9686 .code
9687 $local_part
9688 ${domain}
9689 .endd
9690 The second form can be used to separate the name from subsequent alphanumeric
9691 characters. This form (using braces) is available only for variables; it does
9692 &'not'& apply to message headers. The names of the variables are given in
9693 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
9694 given, the expansion fails.
9695
9696 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
9697 .cindex "expansion" "operators"
9698 The string is first itself expanded, and then the operation specified by
9699 <&'op'&> is applied to it. For example:
9700 .code
9701 ${lc:$local_part}
9702 .endd
9703 The string starts with the first character after the colon, which may be
9704 leading white space. A list of operators is given in section &<<SECTexpop>>&
9705 below. The operator notation is used for simple expansion items that have just
9706 one argument, because it reduces the number of braces and therefore makes the
9707 string easier to understand.
9708
9709 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
9710 This item inserts &"basic"& header lines. It is described with the &%header%&
9711 expansion item below.
9712
9713
9714 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
9715 .cindex "expansion" "calling an acl"
9716 .cindex "&%acl%&" "call from expansion"
9717 The name and zero to nine argument strings are first expanded separately.  The expanded
9718 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
9719 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
9720 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
9721 and may use the variables; if another acl expansion is used the values
9722 are restored after it returns.  If the ACL sets
9723 a value using a "message =" modifier and returns accept or deny, the value becomes
9724 the result of the expansion.
9725 If no message is set and the ACL returns accept or deny
9726 the expansion result is an empty string.
9727 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
9728
9729
9730 .vitem "&*${authresults{*&<&'authserv-id'&>&*}}*&"
9731 .cindex authentication "results header"
9732 .chindex Authentication-Results:
9733 .cindex authentication "expansion item"
9734 This item returns a string suitable for insertion as an
9735 &'Authentication-Results:'&
9736 header line.
9737 The given <&'authserv-id'&> is included in the result; typically this
9738 will be a domain name identifying the system performing the authentications.
9739 Methods that might be present in the result include:
9740 .code
9741 none
9742 iprev
9743 auth
9744 spf
9745 dkim
9746 .endd
9747
9748 Example use (as an ACL modifier):
9749 .code
9750       add_header = :at_start:${authresults {$primary_hostname}}
9751 .endd
9752 This is safe even if no authentication results are available.
9753
9754
9755 .vitem "&*${certextract{*&<&'field'&>&*}{*&<&'certificate'&>&*}&&&
9756        {*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9757 .cindex "expansion" "extracting certificate fields"
9758 .cindex "&%certextract%&" "certificate fields"
9759 .cindex "certificate" "extracting fields"
9760 The <&'certificate'&> must be a variable of type certificate.
9761 The field name is expanded and used to retrieve the relevant field from
9762 the certificate.  Supported fields are:
9763 .display
9764 &`version        `&
9765 &`serial_number  `&
9766 &`subject        `& RFC4514 DN
9767 &`issuer         `& RFC4514 DN
9768 &`notbefore      `& time
9769 &`notafter       `& time
9770 &`sig_algorithm  `&
9771 &`signature      `&
9772 &`subj_altname   `& tagged list
9773 &`ocsp_uri       `& list
9774 &`crl_uri        `& list
9775 .endd
9776 If the field is found,
9777 <&'string2'&> is expanded, and replaces the whole item;
9778 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9779 variable &$value$& contains the value that has been extracted. Afterwards, it
9780 is restored to any previous value it might have had.
9781
9782 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9783 key is not found. If {<&'string2'&>} is also omitted, the value that was
9784 extracted is used.
9785
9786 Some field names take optional modifiers, appended and separated by commas.
9787
9788 The field selectors marked as "RFC4514" above
9789 output a Distinguished Name string which is
9790 not quite
9791 parseable by Exim as a comma-separated tagged list
9792 (the exceptions being elements containing commas).
9793 RDN elements of a single type may be selected by
9794 a modifier of the type label; if so the expansion
9795 result is a list (newline-separated by default).
9796 The separator may be changed by another modifier of
9797 a right angle-bracket followed immediately by the new separator.
9798 Recognised RDN type labels include "CN", "O", "OU" and "DC".
9799
9800 The field selectors marked as "time" above
9801 take an optional modifier of "int"
9802 for which the result is the number of seconds since epoch.
9803 Otherwise the result is a human-readable string
9804 in the timezone selected by the main "timezone" option.
9805
9806 The field selectors marked as "list" above return a list,
9807 newline-separated by default,
9808 (embedded separator characters in elements are doubled).
9809 The separator may be changed by a modifier of
9810 a right angle-bracket followed immediately by the new separator.
9811
9812 The field selectors marked as "tagged" above
9813 prefix each list element with a type string and an equals sign.
9814 Elements of only one type may be selected by a modifier
9815 which is one of "dns", "uri" or "mail";
9816 if so the element tags are omitted.
9817
9818 If not otherwise noted field values are presented in human-readable form.
9819
9820 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
9821        {*&<&'arg'&>&*}...}*&"
9822 .cindex &%dlfunc%&
9823 This expansion dynamically loads and then calls a locally-written C function.
9824 This functionality is available only if Exim is compiled with
9825 .code
9826 EXPAND_DLFUNC=yes
9827 .endd
9828 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
9829 object so that it doesn't reload the same object file in the same Exim process
9830 (but of course Exim does start new processes frequently).
9831
9832 There may be from zero to eight arguments to the function.
9833
9834 When compiling
9835 a local function that is to be called in this way,
9836 first &_DLFUNC_IMPL_& should be defined,
9837 and second &_local_scan.h_& should be included.
9838 The Exim variables and functions that are defined by that API
9839 are also available for dynamically loaded functions. The function itself
9840 must have the following type:
9841 .code
9842 int dlfunction(uschar **yield, int argc, uschar *argv[])
9843 .endd
9844 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
9845 function should return one of the following values:
9846
9847 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
9848 into the expanded string that is being built.
9849
9850 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
9851 from &'yield'&, if it is set.
9852
9853 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
9854 taken from &'yield'& if it is set.
9855
9856 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
9857
9858 When compiling a function that is to be used in this way with gcc,
9859 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
9860 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
9861
9862
9863 .vitem "&*${env{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&"
9864 .cindex "expansion" "extracting value from environment"
9865 .cindex "environment" "values from"
9866 The key is first expanded separately, and leading and trailing white space
9867 removed.
9868 This is then searched for as a name in the environment.
9869 If a variable is found then its value is placed in &$value$&
9870 and <&'string1'&> is expanded, otherwise <&'string2'&> is expanded.
9871
9872 Instead of {<&'string2'&>} the word &"fail"& (not in curly brackets) can
9873 appear, for example:
9874 .code
9875 ${env{USER}{$value} fail }
9876 .endd
9877 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9878 {<&'string1'&>} must be present for &"fail"& to be recognized.
9879
9880 If {<&'string2'&>} is omitted an empty string is substituted on
9881 search failure.
9882 If {<&'string1'&>} is omitted the search result is substituted on
9883 search success.
9884
9885 The environment is adjusted by the &%keep_environment%& and
9886 &%add_environment%& main section options.
9887
9888
9889 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9890        {*&<&'string3'&>&*}}*&"
9891 .cindex "expansion" "extracting substrings by key"
9892 .cindex "&%extract%&" "substrings by key"
9893 The key and <&'string1'&> are first expanded separately. Leading and trailing
9894 white space is removed from the key (but not from any of the strings). The key
9895 must not be empty and must not consist entirely of digits.
9896 The expanded <&'string1'&> must be of the form:
9897 .display
9898 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
9899 .endd
9900 .vindex "&$value$&"
9901 where the equals signs and spaces (but not both) are optional. If any of the
9902 values contain white space, they must be enclosed in double quotes, and any
9903 values that are enclosed in double quotes are subject to escape processing as
9904 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
9905 for the value that corresponds to the key. The search is case-insensitive. If
9906 the key is found, <&'string2'&> is expanded, and replaces the whole item;
9907 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9908 variable &$value$& contains the value that has been extracted. Afterwards, it
9909 is restored to any previous value it might have had.
9910
9911 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9912 key is not found. If {<&'string2'&>} is also omitted, the value that was
9913 extracted is used. Thus, for example, these two expansions are identical, and
9914 yield &"2001"&:
9915 .code
9916 ${extract{gid}{uid=1984 gid=2001}}
9917 ${extract{gid}{uid=1984 gid=2001}{$value}}
9918 .endd
9919 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
9920 appear, for example:
9921 .code
9922 ${extract{Z}{A=... B=...}{$value} fail }
9923 .endd
9924 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9925 {<&'string2'&>} must be present for &"fail"& to be recognized.
9926
9927 .vitem "&*${extract json{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9928        {*&<&'string3'&>&*}}*&" &&&
9929        "&*${extract jsons{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9930        {*&<&'string3'&>&*}}*&"
9931 .cindex "expansion" "extracting from JSON object"
9932 .cindex JSON expansions
9933 The key and <&'string1'&> are first expanded separately. Leading and trailing
9934 white space is removed from the key (but not from any of the strings). The key
9935 must not be empty and must not consist entirely of digits.
9936 The expanded <&'string1'&> must be of the form:
9937 .display
9938 { <&'"key1"'&> : <&'value1'&> ,  <&'"key2"'&> , <&'value2'&> ... }
9939 .endd
9940 .vindex "&$value$&"
9941 The braces, commas and colons, and the quoting of the member name are required;
9942 the spaces are optional.
9943 Matching of the key against the member names is done case-sensitively.
9944 For the &"json"& variant,
9945 if a returned value is a JSON string, it retains its leading and
9946 trailing quotes.
9947 For the &"jsons"& variant, which is intended for use with JSON strings, the
9948 leading and trailing quotes are removed from the returned value.
9949 . XXX should be a UTF-8 compare
9950
9951 The results of matching are handled as above.
9952
9953
9954 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
9955         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9956 .cindex "expansion" "extracting substrings by number"
9957 .cindex "&%extract%&" "substrings by number"
9958 The <&'number'&> argument must consist entirely of decimal digits,
9959 apart from leading and trailing white space, which is ignored.
9960 This is what distinguishes this form of &%extract%& from the previous kind. It
9961 behaves in the same way, except that, instead of extracting a named field, it
9962 extracts from <&'string1'&> the field whose number is given as the first
9963 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
9964 <&'string3'&> as before.
9965
9966 The fields in the string are separated by any one of the characters in the
9967 separator string. These may include space or tab characters.
9968 The first field is numbered one. If the number is negative, the fields are
9969 counted from the end of the string, with the rightmost one numbered -1. If the
9970 number given is zero, the entire string is returned. If the modulus of the
9971 number is greater than the number of fields in the string, the result is the
9972 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
9973 provided. For example:
9974 .code
9975 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
9976 .endd
9977 yields &"42"&, and
9978 .code
9979 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
9980 .endd
9981 yields &"99"&. Two successive separators mean that the field between them is
9982 empty (for example, the fifth field above).
9983
9984
9985 .vitem "&*${extract json {*&<&'number'&>&*}}&&&
9986         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&" &&&
9987        "&*${extract jsons{*&<&'number'&>&*}}&&&
9988         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9989 .cindex "expansion" "extracting from JSON array"
9990 .cindex JSON expansions
9991 The <&'number'&> argument must consist entirely of decimal digits,
9992 apart from leading and trailing white space, which is ignored.
9993
9994 Field selection and result handling is as above;
9995 there is no choice of field separator.
9996 For the &"json"& variant,
9997 if a returned value is a JSON string, it retains its leading and
9998 trailing quotes.
9999 For the &"jsons"& variant, which is intended for use with JSON strings, the
10000 leading and trailing quotes are removed from the returned value.
10001
10002
10003 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
10004 .cindex "list" "selecting by condition"
10005 .cindex "expansion" "selecting from list by condition"
10006 .vindex "&$item$&"
10007 After expansion, <&'string'&> is interpreted as a list, colon-separated by
10008 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10009 For each item
10010 in this list, its value is place in &$item$&, and then the condition is
10011 evaluated. If the condition is true, &$item$& is added to the output as an
10012 item in a new list; if the condition is false, the item is discarded. The
10013 separator used for the output list is the same as the one used for the
10014 input, but a separator setting is not included in the output. For example:
10015 .code
10016 ${filter{a:b:c}{!eq{$item}{b}}}
10017 .endd
10018 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
10019 to what it was before. See also the &%map%& and &%reduce%& expansion items.
10020
10021
10022 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10023 .cindex "hash function" "textual"
10024 .cindex "expansion" "textual hash"
10025 This is a textual hashing function, and was the first to be implemented in
10026 early versions of Exim. In current releases, there are other hashing functions
10027 (numeric, MD5, and SHA-1), which are described below.
10028
10029 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
10030 <&'n'&>. If you are using fixed values for these numbers, that is, if
10031 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
10032 use the simpler operator notation that avoids some of the braces:
10033 .code
10034 ${hash_<n>_<m>:<string>}
10035 .endd
10036 The second number is optional (in both notations). If <&'n'&> is greater than
10037 or equal to the length of the string, the expansion item returns the string.
10038 Otherwise it computes a new string of length <&'n'&> by applying a hashing
10039 function to the string. The new string consists of characters taken from the
10040 first <&'m'&> characters of the string
10041 .code
10042 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
10043 .endd
10044 If <&'m'&> is not present the value 26 is used, so that only lower case
10045 letters appear. For example:
10046 .display
10047 &`$hash{3}{monty}}           `&   yields  &`jmg`&
10048 &`$hash{5}{monty}}           `&   yields  &`monty`&
10049 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
10050 .endd
10051
10052 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
10053         &*$h_*&<&'header&~name'&>&*:*&" &&&
10054        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
10055         &*$bh_*&<&'header&~name'&>&*:*&" &&&
10056        "&*$lheader_*&<&'header&~name'&>&*:*&&~or&~&&&
10057         &*$lh_*&<&'header&~name'&>&*:*&" &&&
10058        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
10059         &*$rh_*&<&'header&~name'&>&*:*&"
10060 .cindex "expansion" "header insertion"
10061 .vindex "&$header_$&"
10062 .vindex "&$bheader_$&"
10063 .vindex "&$lheader_$&"
10064 .vindex "&$rheader_$&"
10065 .cindex "header lines" "in expansion strings"
10066 .cindex "header lines" "character sets"
10067 .cindex "header lines" "decoding"
10068 Substitute the contents of the named message header line, for example
10069 .code
10070 $header_reply-to:
10071 .endd
10072 The newline that terminates a header line is not included in the expansion, but
10073 internal newlines (caused by splitting the header line over several physical
10074 lines) may be present.
10075
10076 The difference between the four pairs of expansions is in the way
10077 the data in the header line is interpreted.
10078
10079 .ilist
10080 .cindex "white space" "in header lines"
10081 &%rheader%& gives the original &"raw"& content of the header line, with no
10082 processing at all, and without the removal of leading and trailing white space.
10083
10084 .next
10085 .cindex "list" "of header lines"
10086 &%lheader%& gives a colon-separated list, one element per header when there
10087 are multiple headers with a given name.
10088 Any embedded colon characters within an element are doubled, so normal Exim
10089 list-processing facilities can be used.
10090 The terminating newline of each element is removed; in other respects
10091 the content is &"raw"&.
10092
10093 .next
10094 .cindex "base64 encoding" "in header lines"
10095 &%bheader%& removes leading and trailing white space, and then decodes base64
10096 or quoted-printable MIME &"words"& within the header text, but does no
10097 character set translation. If decoding of what looks superficially like a MIME
10098 &"word"& fails, the raw string is returned. If decoding
10099 .cindex "binary zero" "in header line"
10100 produces a binary zero character, it is replaced by a question mark &-- this is
10101 what Exim does for binary zeros that are actually received in header lines.
10102
10103 .next
10104 &%header%& tries to translate the string as decoded by &%bheader%& to a
10105 standard character set. This is an attempt to produce the same string as would
10106 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
10107 returned. Translation is attempted only on operating systems that support the
10108 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
10109 a system Makefile or in &_Local/Makefile_&.
10110 .endlist ilist
10111
10112 In a filter file, the target character set for &%header%& can be specified by a
10113 command of the following form:
10114 .code
10115 headers charset "UTF-8"
10116 .endd
10117 This command affects all references to &$h_$& (or &$header_$&) expansions in
10118 subsequently obeyed filter commands. In the absence of this command, the target
10119 character set in a filter is taken from the setting of the &%headers_charset%&
10120 option in the runtime configuration. The value of this option defaults to the
10121 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
10122 ISO-8859-1.
10123
10124 Header names follow the syntax of RFC 2822, which states that they may contain
10125 any printing characters except space and colon. Consequently, curly brackets
10126 &'do not'& terminate header names, and should not be used to enclose them as
10127 if they were variables. Attempting to do so causes a syntax error.
10128
10129 Only header lines that are common to all copies of a message are visible to
10130 this mechanism. These are the original header lines that are received with the
10131 message, and any that are added by an ACL statement or by a system
10132 filter. Header lines that are added to a particular copy of a message by a
10133 router or transport are not accessible.
10134
10135 For incoming SMTP messages, no header lines are visible in
10136 ACLs that are obeyed before the data phase completes,
10137 because the header structure is not set up until the message is received.
10138 They are visible in DKIM, PRDR and DATA ACLs.
10139 Header lines that are added in a RCPT ACL (for example)
10140 are saved until the message's incoming header lines are available, at which
10141 point they are added.
10142 When any of the above ACLs ar
10143 running, however, header lines added by earlier ACLs are visible.
10144
10145 Upper case and lower case letters are synonymous in header names. If the
10146 following character is white space, the terminating colon may be omitted, but
10147 this is not recommended, because you may then forget it when it is needed. When
10148 white space terminates the header name, this white space is included in the
10149 expanded string.  If the message does not contain the given header, the
10150 expansion item is replaced by an empty string. (See the &%def%& condition in
10151 section &<<SECTexpcond>>& for a means of testing for the existence of a
10152 header.)
10153
10154 If there is more than one header with the same name, they are all concatenated
10155 to form the substitution string, up to a maximum length of 64K. Unless
10156 &%rheader%& is being used, leading and trailing white space is removed from
10157 each header before concatenation, and a completely empty header is ignored. A
10158 newline character is then inserted between non-empty headers, but there is no
10159 newline at the very end. For the &%header%& and &%bheader%& expansion, for
10160 those headers that contain lists of addresses, a comma is also inserted at the
10161 junctions between headers. This does not happen for the &%rheader%& expansion.
10162
10163 .cindex "tainted data" "message headers"
10164 When the headers are from an incoming message,
10165 the result of expanding any of these variables is tainted.
10166
10167
10168 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
10169 .cindex "expansion" "hmac hashing"
10170 .cindex &%hmac%&
10171 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
10172 shared secret and some text into a message authentication code, as specified in
10173 RFC 2104. This differs from &`${md5:secret_text...}`& or
10174 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
10175 cryptographic hash, allowing for authentication that is not possible with MD5
10176 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
10177 present. For example:
10178 .code
10179 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
10180 .endd
10181 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
10182 produces:
10183 .code
10184 dd97e3ba5d1a61b5006108f8c8252953
10185 .endd
10186 As an example of how this might be used, you might put in the main part of
10187 an Exim configuration:
10188 .code
10189 SPAMSCAN_SECRET=cohgheeLei2thahw
10190 .endd
10191 In a router or a transport you could then have:
10192 .code
10193 headers_add = \
10194   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
10195   ${hmac{md5}{SPAMSCAN_SECRET}\
10196   {${primary_hostname},${message_exim_id},$h_message-id:}}
10197 .endd
10198 Then given a message, you can check where it was scanned by looking at the
10199 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
10200 this header line is authentic by recomputing the authentication code from the
10201 host name, message ID and the &'Message-id:'& header line. This can be done
10202 using Exim's &%-be%& option, or by other means, for example, by using the
10203 &'hmac_md5_hex()'& function in Perl.
10204
10205
10206 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10207 .cindex "expansion" "conditional"
10208 .cindex "&%if%&, expansion item"
10209 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
10210 item; otherwise <&'string2'&> is used. The available conditions are described
10211 in section &<<SECTexpcond>>& below. For example:
10212 .code
10213 ${if eq {$local_part}{postmaster} {yes}{no} }
10214 .endd
10215 The second string need not be present; if it is not and the condition is not
10216 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
10217 be present instead of the second string (without any curly brackets). In this
10218 case, the expansion is forced to fail if the condition is not true (see section
10219 &<<SECTforexpfai>>&).
10220
10221 If both strings are omitted, the result is the string &`true`& if the condition
10222 is true, and the empty string if the condition is false. This makes it less
10223 cumbersome to write custom ACL and router conditions. For example, instead of
10224 .code
10225 condition = ${if >{$acl_m4}{3}{true}{false}}
10226 .endd
10227 you can use
10228 .code
10229 condition = ${if >{$acl_m4}{3}}
10230 .endd
10231
10232
10233
10234 .vitem &*${imapfolder{*&<&'foldername'&>&*}}*&
10235 .cindex expansion "imap folder"
10236 .cindex "&%imapfolder%& expansion item"
10237 This item converts a (possibly multilevel, or with non-ASCII characters)
10238 folder specification to a Maildir name for filesystem use.
10239 For information on internationalisation support see &<<SECTi18nMDA>>&.
10240
10241
10242
10243 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10244 .cindex "expansion" "string truncation"
10245 .cindex "&%length%& expansion item"
10246 The &%length%& item is used to extract the initial portion of a string. Both
10247 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
10248 you are using a fixed value for the number, that is, if <&'string1'&> does not
10249 change when expanded, you can use the simpler operator notation that avoids
10250 some of the braces:
10251 .code
10252 ${length_<n>:<string>}
10253 .endd
10254 The result of this item is either the first <&'n'&> bytes or the whole
10255 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
10256 &%strlen%&, which gives the length of a string.
10257 All measurement is done in bytes and is not UTF-8 aware.
10258
10259
10260 .vitem "&*${listextract{*&<&'number'&>&*}&&&
10261         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
10262 .cindex "expansion" "extracting list elements by number"
10263 .cindex "&%listextract%&" "extract list elements by number"
10264 .cindex "list" "extracting elements by number"
10265 The <&'number'&> argument must consist entirely of decimal digits,
10266 apart from an optional leading minus,
10267 and leading and trailing white space (which is ignored).
10268
10269 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
10270 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10271
10272 The first field of the list is numbered one.
10273 If the number is negative, the fields are
10274 counted from the end of the list, with the rightmost one numbered -1.
10275 The numbered element of the list is extracted and placed in &$value$&,
10276 then <&'string2'&> is expanded as the result.
10277
10278 If the modulus of the
10279 number is zero or greater than the number of fields in the string,
10280 the result is the expansion of <&'string3'&>.
10281
10282 For example:
10283 .code
10284 ${listextract{2}{x:42:99}}
10285 .endd
10286 yields &"42"&, and
10287 .code
10288 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
10289 .endd
10290 yields &"result: 42"&.
10291
10292 If {<&'string3'&>} is omitted, an empty string is used for string3.
10293 If {<&'string2'&>} is also omitted, the value that was
10294 extracted is used.
10295 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
10296
10297
10298 .new
10299 .vitem &*${listquote{*&<&'separator'&>&*}{*&<&'string'&>&*}}*&
10300 .cindex quoting "for list"
10301 .cindex list quoting
10302 This item doubles any occurrence of the separator character
10303 in the given string.
10304 An empty string is replaced with a single space.
10305 This converts the string into a safe form for use as a list element,
10306 in a list using the given separator.
10307 .wen
10308
10309
10310 .vitem "&*${lookup&~{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
10311         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&" &&&
10312        "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
10313         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
10314 .cindex "expansion" "lookup in"
10315 .cindex "file" "lookups"
10316 .cindex "lookup" "in expanded string"
10317 The two forms of lookup item specify data lookups in files and databases, as
10318 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
10319 lookups, and the second is used for query-style lookups. The <&'key'&>,
10320 <&'file'&>, and <&'query'&> strings are expanded before use.
10321
10322 If there is any white space in a lookup item which is part of a filter command,
10323 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
10324 other place where white space is significant, the lookup item must be enclosed
10325 in double quotes. The use of data lookups in users' filter files may be locked
10326 out by the system administrator.
10327
10328 .vindex "&$value$&"
10329 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
10330 During its expansion, the variable &$value$& contains the data returned by the
10331 lookup. Afterwards it reverts to the value it had previously (at the outer
10332 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
10333 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
10334 string on failure. If <&'string2'&> is provided, it can itself be a nested
10335 lookup, thus providing a mechanism for looking up a default value when the
10336 original lookup fails.
10337
10338 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
10339 data for the outer lookup while the parameters of the second lookup are
10340 expanded, and also while <&'string2'&> of the second lookup is expanded, should
10341 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
10342 appear, and in this case, if the lookup fails, the entire expansion is forced
10343 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
10344 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
10345 successful lookup, and nothing in the case of failure.
10346
10347 For single-key lookups, the string &"partial"& is permitted to precede the
10348 search type in order to do partial matching, and * or *@ may follow a search
10349 type to request default lookups if the key does not match (see sections
10350 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
10351
10352 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
10353 If a partial search is used, the variables &$1$& and &$2$& contain the wild
10354 and non-wild parts of the key during the expansion of the replacement text.
10355 They return to their previous values at the end of the lookup item.
10356
10357 This example looks up the postmaster alias in the conventional alias file:
10358 .code
10359 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
10360 .endd
10361 This example uses NIS+ to look up the full name of the user corresponding to
10362 the local part of an address, forcing the expansion to fail if it is not found:
10363 .code
10364 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
10365   {$value}fail}
10366 .endd
10367
10368
10369 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10370 .cindex "expansion" "list creation"
10371 .vindex "&$item$&"
10372 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
10373 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10374 For each item
10375 in this list, its value is place in &$item$&, and then <&'string2'&> is
10376 expanded and added to the output as an item in a new list. The separator used
10377 for the output list is the same as the one used for the input, but a separator
10378 setting is not included in the output. For example:
10379 .code
10380 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
10381 .endd
10382 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
10383 value of &$item$& is restored to what it was before. See also the &%filter%&
10384 and &%reduce%& expansion items.
10385
10386 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10387 .cindex "expansion" "numeric hash"
10388 .cindex "hash function" "numeric"
10389 The three strings are expanded; the first two must yield numbers. Call them
10390 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10391 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
10392 can use the simpler operator notation that avoids some of the braces:
10393 .code
10394 ${nhash_<n>_<m>:<string>}
10395 .endd
10396 The second number is optional (in both notations). If there is only one number,
10397 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
10398 processed by a div/mod hash function that returns two numbers, separated by a
10399 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
10400 example,
10401 .code
10402 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
10403 .endd
10404 returns the string &"6/33"&.
10405
10406
10407
10408 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
10409 .cindex "Perl" "use in expanded string"
10410 .cindex "expansion" "calling Perl from"
10411 This item is available only if Exim has been built to include an embedded Perl
10412 interpreter. The subroutine name and the arguments are first separately
10413 expanded, and then the Perl subroutine is called with those arguments. No
10414 additional arguments need be given; the maximum number permitted, including the
10415 name of the subroutine, is nine.
10416
10417 The return value of the subroutine is inserted into the expanded string, unless
10418 the return value is &%undef%&. In that case, the expansion fails in the same
10419 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
10420 Whatever you return is evaluated in a scalar context. For example, if you
10421 return the name of a Perl vector, the return value is the size of the vector,
10422 not its contents.
10423
10424 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
10425 with the error message that was passed to &%die%&. More details of the embedded
10426 Perl facility are given in chapter &<<CHAPperl>>&.
10427
10428 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
10429 out the use of this expansion item in filter files.
10430
10431
10432 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
10433 .cindex "&%prvs%& expansion item"
10434 The first argument is a complete email address and the second is secret
10435 keystring. The third argument, specifying a key number, is optional. If absent,
10436 it defaults to 0. The result of the expansion is a prvs-signed email address,
10437 to be typically used with the &%return_path%& option on an &(smtp)& transport
10438 as part of a bounce address tag validation (BATV) scheme. For more discussion
10439 and an example, see section &<<SECTverifyPRVS>>&.
10440
10441 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
10442         {*&<&'string'&>&*}}*&"
10443 .cindex "&%prvscheck%& expansion item"
10444 This expansion item is the complement of the &%prvs%& item. It is used for
10445 checking prvs-signed addresses. If the expansion of the first argument does not
10446 yield a syntactically valid prvs-signed address, the whole item expands to the
10447 empty string. When the first argument does expand to a syntactically valid
10448 prvs-signed address, the second argument is expanded, with the prvs-decoded
10449 version of the address and the key number extracted from the address in the
10450 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
10451
10452 These two variables can be used in the expansion of the second argument to
10453 retrieve the secret. The validity of the prvs-signed address is then checked
10454 against the secret. The result is stored in the variable &$prvscheck_result$&,
10455 which is empty for failure or &"1"& for success.
10456
10457 The third argument is optional; if it is missing, it defaults to an empty
10458 string. This argument is now expanded. If the result is an empty string, the
10459 result of the expansion is the decoded version of the address. This is the case
10460 whether or not the signature was valid. Otherwise, the result of the expansion
10461 is the expansion of the third argument.
10462
10463 All three variables can be used in the expansion of the third argument.
10464 However, once the expansion is complete, only &$prvscheck_result$& remains set.
10465 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
10466
10467 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
10468 .cindex "expansion" "inserting an entire file"
10469 .cindex "file" "inserting into expansion"
10470 .cindex "&%readfile%& expansion item"
10471 The filename and end-of-line string are first expanded separately. The file is
10472 then read, and its contents replace the entire item. All newline characters in
10473 the file are replaced by the end-of-line string if it is present. Otherwise,
10474 newlines are left in the string.
10475 String expansion is not applied to the contents of the file. If you want this,
10476 you must wrap the item in an &%expand%& operator. If the file cannot be read,
10477 the string expansion fails.
10478
10479 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
10480 locks out the use of this expansion item in filter files.
10481
10482
10483
10484 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
10485         {*&<&'options'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
10486 .cindex "expansion" "inserting from a socket"
10487 .cindex "socket, use of in expansion"
10488 .cindex "&%readsocket%& expansion item"
10489 This item inserts data from a Unix domain or TCP socket into the expanded
10490 string. The minimal way of using it uses just two arguments, as in these
10491 examples:
10492 .code
10493 ${readsocket{/socket/name}{request string}}
10494 ${readsocket{inet:some.host:1234}{request string}}
10495 .endd
10496 For a Unix domain socket, the first substring must be the path to the socket.
10497 For an Internet socket, the first substring must contain &`inet:`& followed by
10498 a host name or IP address, followed by a colon and a port, which can be a
10499 number or the name of a TCP port in &_/etc/services_&. An IP address may
10500 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
10501 example:
10502 .code
10503 ${readsocket{inet:[::1]:1234}{request string}}
10504 .endd
10505 Only a single host name may be given, but if looking it up yields more than
10506 one IP address, they are each tried in turn until a connection is made. For
10507 both kinds of socket, Exim makes a connection, writes the request string
10508 unless it is an empty string; and no terminating NUL is ever sent)
10509 and reads from the socket until an end-of-file
10510 is read. A timeout of 5 seconds is applied. Additional, optional arguments
10511 extend what can be done. Firstly, you can vary the timeout. For example:
10512 .code
10513 ${readsocket{/socket/name}{request string}{3s}}
10514 .endd
10515
10516 The third argument is a list of options, of which the first element is the timeout
10517 and must be present if any options are given.
10518 Further elements are options of form &'name=value'&.
10519 Example:
10520 .code
10521 ${readsocket{/socket/name}{request string}{3s:shutdown=no}}
10522 .endd
10523
10524 The following option names are recognised:
10525 .ilist
10526 &*cache*&
10527 Defines if the result data can be cached for use by a later identical
10528 request in the same process.
10529 Values are &"yes"& or &"no"& (the default).
10530 If not, all cached results for this connection specification
10531 will be invalidated.
10532
10533 .next
10534 &*shutdown*&
10535 Defines whether or not a write-shutdown is done on the connection after
10536 sending the request. Values are &"yes"& (the default) or &"no"&
10537 (preferred, eg. by some webservers).
10538
10539 .next
10540 &*tls*&
10541 Controls the use of TLS on the connection.
10542 Values are &"yes"& or &"no"& (the default).
10543 If it is enabled, a shutdown as descripbed above is never done.
10544 .endlist
10545
10546
10547 A fourth argument allows you to change any newlines that are in the data
10548 that is read, in the same way as for &%readfile%& (see above). This example
10549 turns them into spaces:
10550 .code
10551 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
10552 .endd
10553 As with all expansions, the substrings are expanded before the processing
10554 happens. Errors in these sub-expansions cause the expansion to fail. In
10555 addition, the following errors can occur:
10556
10557 .ilist
10558 Failure to create a socket file descriptor;
10559 .next
10560 Failure to connect the socket;
10561 .next
10562 Failure to write the request string;
10563 .next
10564 Timeout on reading from the socket.
10565 .endlist
10566
10567 By default, any of these errors causes the expansion to fail. However, if
10568 you supply a fifth substring, it is expanded and used when any of the above
10569 errors occurs. For example:
10570 .code
10571 ${readsocket{/socket/name}{request string}{3s}{\n}\
10572   {socket failure}}
10573 .endd
10574 You can test for the existence of a Unix domain socket by wrapping this
10575 expansion in &`${if exists`&, but there is a race condition between that test
10576 and the actual opening of the socket, so it is safer to use the fifth argument
10577 if you want to be absolutely sure of avoiding an expansion error for a
10578 non-existent Unix domain socket, or a failure to connect to an Internet socket.
10579
10580 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
10581 locks out the use of this expansion item in filter files.
10582
10583
10584 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10585 .cindex "expansion" "reducing a list to a scalar"
10586 .cindex "list" "reducing to a scalar"
10587 .vindex "&$value$&"
10588 .vindex "&$item$&"
10589 This operation reduces a list to a single, scalar string. After expansion,
10590 <&'string1'&> is interpreted as a list, colon-separated by default, but the
10591 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10592 Then <&'string2'&> is expanded and
10593 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
10594 list is assigned to &$item$&, in turn, and <&'string3'&> is expanded for each of
10595 them. The result of that expansion is assigned to &$value$& before the next
10596 iteration. When the end of the list is reached, the final value of &$value$& is
10597 added to the expansion output. The &%reduce%& expansion item can be used in a
10598 number of ways. For example, to add up a list of numbers:
10599 .code
10600 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
10601 .endd
10602 The result of that expansion would be &`6`&. The maximum of a list of numbers
10603 can be found:
10604 .code
10605 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
10606 .endd
10607 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
10608 restored to what they were before. See also the &%filter%& and &%map%&
10609 expansion items.
10610
10611 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
10612 This item inserts &"raw"& header lines. It is described with the &%header%&
10613 expansion item in section &<<SECTexpansionitems>>& above.
10614
10615 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
10616         {*&<&'string2'&>&*}}*&"
10617 .cindex "expansion" "running a command"
10618 .cindex "&%run%& expansion item"
10619 The command and its arguments are first expanded as one string. The string is
10620 split apart into individual arguments by spaces, and then the command is run
10621 in a separate process, but under the same uid and gid.  As in other command
10622 executions from Exim, a shell is not used by default. If the command requires
10623 a shell, you must explicitly code it.
10624
10625 Since the arguments are split by spaces, when there is a variable expansion
10626 which has an empty result, it will cause the situation that the argument will
10627 simply be omitted when the program is actually executed by Exim. If the
10628 script/program requires a specific number of arguments and the expanded
10629 variable could possibly result in this empty expansion, the variable must be
10630 quoted. This is more difficult if the expanded variable itself could result
10631 in a string containing quotes, because it would interfere with the quotes
10632 around the command arguments. A possible guard against this is to wrap the
10633 variable in the &%sg%& operator to change any quote marks to some other
10634 character.
10635
10636 The standard input for the command exists, but is empty. The standard output
10637 and standard error are set to the same file descriptor.
10638 .cindex "return code" "from &%run%& expansion"
10639 .vindex "&$value$&"
10640 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
10641 and replaces the entire item; during this expansion, the standard output/error
10642 from the command is in the variable &$value$&. If the command fails,
10643 <&'string2'&>, if present, is expanded and used. Once again, during the
10644 expansion, the standard output/error from the command is in the variable
10645 &$value$&.
10646
10647 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
10648 can be the word &"fail"& (not in braces) to force expansion failure if the
10649 command does not succeed. If both strings are omitted, the result is contents
10650 of the standard output/error on success, and nothing on failure.
10651
10652 .vindex "&$run_in_acl$&"
10653 The standard output/error of the command is put in the variable &$value$&.
10654 In this ACL example, the output of a command is logged for the admin to
10655 troubleshoot:
10656 .code
10657 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
10658       log_message  = Output of id: $value
10659 .endd
10660 If the command requires shell idioms, such as the > redirect operator, the
10661 shell must be invoked directly, such as with:
10662 .code
10663 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
10664 .endd
10665
10666 .vindex "&$runrc$&"
10667 The return code from the command is put in the variable &$runrc$&, and this
10668 remains set afterwards, so in a filter file you can do things like this:
10669 .code
10670 if "${run{x y z}{}}$runrc" is 1 then ...
10671   elif $runrc is 2 then ...
10672   ...
10673 endif
10674 .endd
10675 If execution of the command fails (for example, the command does not exist),
10676 the return code is 127 &-- the same code that shells use for non-existent
10677 commands.
10678
10679 &*Warning*&: In a router or transport, you cannot assume the order in which
10680 option values are expanded, except for those preconditions whose order of
10681 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
10682 by the expansion of one option, and use it in another.
10683
10684 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
10685 out the use of this expansion item in filter files.
10686
10687
10688 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
10689 .cindex "expansion" "string substitution"
10690 .cindex "&%sg%& expansion item"
10691 This item works like Perl's substitution operator (s) with the global (/g)
10692 option; hence its name. However, unlike the Perl equivalent, Exim does not
10693 modify the subject string; instead it returns the modified string for insertion
10694 into the overall expansion. The item takes three arguments: the subject string,
10695 a regular expression, and a substitution string. For example:
10696 .code
10697 ${sg{abcdefabcdef}{abc}{xyz}}
10698 .endd
10699 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
10700 if any $, } or \ characters are required in the regular expression or in the
10701 substitution string, they have to be escaped. For example:
10702 .code
10703 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
10704 .endd
10705 yields &"defabc"&, and
10706 .code
10707 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
10708 .endd
10709 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
10710 the regular expression from string expansion.
10711
10712 The regular expression is compiled in 8-bit mode, working against bytes
10713 rather than any Unicode-aware character handling.
10714
10715
10716 .vitem &*${sort{*&<&'string'&>&*}{*&<&'comparator'&>&*}{*&<&'extractor'&>&*}}*&
10717 .cindex sorting "a list"
10718 .cindex list sorting
10719 .cindex expansion "list sorting"
10720 After expansion, <&'string'&> is interpreted as a list, colon-separated by
10721 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10722 The <&'comparator'&> argument is interpreted as the operator
10723 of a two-argument expansion condition.
10724 The numeric operators plus ge, gt, le, lt (and ~i variants) are supported.
10725 The comparison should return true when applied to two values
10726 if the first value should sort before the second value.
10727 The <&'extractor'&> expansion is applied repeatedly to elements of the list,
10728 the element being placed in &$item$&,
10729 to give values for comparison.
10730
10731 The item result is a sorted list,
10732 with the original list separator,
10733 of the list elements (in full) of the original.
10734
10735 Examples:
10736 .code
10737 ${sort{3:2:1:4}{<}{$item}}
10738 .endd
10739 sorts a list of numbers, and
10740 .code
10741 ${sort {${lookup dnsdb{>:,,mx=example.com}}} {<} {${listextract{1}{<,$item}}}}
10742 .endd
10743 will sort an MX lookup into priority order.
10744
10745
10746
10747 .new
10748 .vitem &*${srs_encode&~{*&<&'secret'&>&*}{*&<&'return&~path'&>&*}{*&<&'original&~domain'&>&*}}*&
10749 SRS encoding.  See SECT &<<SECTSRS>>& for details.
10750 .wen
10751
10752
10753
10754 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10755 .cindex "&%substr%& expansion item"
10756 .cindex "substring extraction"
10757 .cindex "expansion" "substring extraction"
10758 The three strings are expanded; the first two must yield numbers. Call them
10759 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10760 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
10761 can use the simpler operator notation that avoids some of the braces:
10762 .code
10763 ${substr_<n>_<m>:<string>}
10764 .endd
10765 The second number is optional (in both notations).
10766 If it is absent in the simpler format, the preceding underscore must also be
10767 omitted.
10768
10769 The &%substr%& item can be used to extract more general substrings than
10770 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
10771 length required. For example
10772 .code
10773 ${substr{3}{2}{$local_part}}
10774 .endd
10775 If the starting offset is greater than the string length the result is the
10776 null string; if the length plus starting offset is greater than the string
10777 length, the result is the right-hand part of the string, starting from the
10778 given offset. The first byte (character) in the string has offset zero.
10779
10780 The &%substr%& expansion item can take negative offset values to count
10781 from the right-hand end of its operand. The last byte (character) is offset -1,
10782 the second-last is offset -2, and so on. Thus, for example,
10783 .code
10784 ${substr{-5}{2}{1234567}}
10785 .endd
10786 yields &"34"&. If the absolute value of a negative offset is greater than the
10787 length of the string, the substring starts at the beginning of the string, and
10788 the length is reduced by the amount of overshoot. Thus, for example,
10789 .code
10790 ${substr{-5}{2}{12}}
10791 .endd
10792 yields an empty string, but
10793 .code
10794 ${substr{-3}{2}{12}}
10795 .endd
10796 yields &"1"&.
10797
10798 When the second number is omitted from &%substr%&, the remainder of the string
10799 is taken if the offset is positive. If it is negative, all bytes (characters) in the
10800 string preceding the offset point are taken. For example, an offset of -1 and
10801 no length, as in these semantically identical examples:
10802 .code
10803 ${substr_-1:abcde}
10804 ${substr{-1}{abcde}}
10805 .endd
10806 yields all but the last character of the string, that is, &"abcd"&.
10807
10808 All measurement is done in bytes and is not UTF-8 aware.
10809
10810
10811
10812 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
10813         {*&<&'replacements'&>&*}}*&"
10814 .cindex "expansion" "character translation"
10815 .cindex "&%tr%& expansion item"
10816 This item does single-character (in bytes) translation on its subject string. The second
10817 argument is a list of characters to be translated in the subject string. Each
10818 matching character is replaced by the corresponding character from the
10819 replacement list. For example
10820 .code
10821 ${tr{abcdea}{ac}{13}}
10822 .endd
10823 yields &`1b3de1`&. If there are duplicates in the second character string, the
10824 last occurrence is used. If the third string is shorter than the second, its
10825 last character is replicated. However, if it is empty, no translation takes
10826 place.
10827
10828 All character handling is done in bytes and is not UTF-8 aware.
10829
10830 .endlist
10831
10832
10833
10834 .section "Expansion operators" "SECTexpop"
10835 .cindex "expansion" "operators"
10836 For expansion items that perform transformations on a single argument string,
10837 the &"operator"& notation is used because it is simpler and uses fewer braces.
10838 The substring is first expanded before the operation is applied to it. The
10839 following operations can be performed:
10840
10841 .vlist
10842 .vitem &*${address:*&<&'string'&>&*}*&
10843 .cindex "expansion" "RFC 2822 address handling"
10844 .cindex "&%address%& expansion item"
10845 The string is interpreted as an RFC 2822 address, as it might appear in a
10846 header line, and the effective address is extracted from it. If the string does
10847 not parse successfully, the result is empty.
10848
10849 The parsing correctly handles SMTPUTF8 Unicode in the string.
10850
10851
10852 .vitem &*${addresses:*&<&'string'&>&*}*&
10853 .cindex "expansion" "RFC 2822 address handling"
10854 .cindex "&%addresses%& expansion item"
10855 The string (after expansion) is interpreted as a list of addresses in RFC
10856 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
10857 operative address (&'local-part@domain'&) is extracted from each item, and the
10858 result of the expansion is a colon-separated list, with appropriate
10859 doubling of colons should any happen to be present in the email addresses.
10860 Syntactically invalid RFC2822 address items are omitted from the output.
10861
10862 It is possible to specify a character other than colon for the output
10863 separator by starting the string with > followed by the new separator
10864 character. For example:
10865 .code
10866 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
10867 .endd
10868 expands to &`ceo@up.stairs&&sec@base.ment`&. The string is expanded
10869 first, so if the expanded string starts with >, it may change the output
10870 separator unintentionally. This can be avoided by setting the output
10871 separator explicitly:
10872 .code
10873 ${addresses:>:$h_from:}
10874 .endd
10875
10876 Compare the &%address%& (singular)
10877 expansion item, which extracts the working address from a single RFC2822
10878 address. See the &%filter%&, &%map%&, and &%reduce%& items for ways of
10879 processing lists.
10880
10881 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
10882 a strict interpretation of header line formatting.  Exim parses the bare,
10883 unquoted portion of an email address and if it finds a comma, treats it as an
10884 email address separator. For the example header line:
10885 .code
10886 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
10887 .endd
10888 The first example below demonstrates that Q-encoded email addresses are parsed
10889 properly if it is given the raw header (in this example, &`$rheader_from:`&).
10890 It does not see the comma because it's still encoded as "=2C".  The second
10891 example below is passed the contents of &`$header_from:`&, meaning it gets
10892 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
10893 The third example shows that the presence of a comma is skipped when it is
10894 quoted.  The fourth example shows SMTPUTF8 handling.
10895 .code
10896 # exim -be '${addresses:From: \
10897 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
10898 user@example.com
10899 # exim -be '${addresses:From: Last, First <user@example.com>}'
10900 Last:user@example.com
10901 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
10902 user@example.com
10903 # exim -be '${addresses:フィル <フィリップ@example.jp>}'
10904 フィリップ@example.jp
10905 .endd
10906
10907 .vitem &*${base32:*&<&'digits'&>&*}*&
10908 .cindex "&%base32%& expansion item"
10909 .cindex "expansion" "conversion to base 32"
10910 The string must consist entirely of decimal digits. The number is converted to
10911 base 32 and output as a (empty, for zero) string of characters.
10912 Only lowercase letters are used.
10913
10914 .vitem &*${base32d:*&<&'base-32&~digits'&>&*}*&
10915 .cindex "&%base32d%& expansion item"
10916 .cindex "expansion" "conversion to base 32"
10917 The string must consist entirely of base-32 digits.
10918 The number is converted to decimal and output as a string.
10919
10920 .vitem &*${base62:*&<&'digits'&>&*}*&
10921 .cindex "&%base62%& expansion item"
10922 .cindex "expansion" "conversion to base 62"
10923 The string must consist entirely of decimal digits. The number is converted to
10924 base 62 and output as a string of six characters, including leading zeros. In
10925 the few operating environments where Exim uses base 36 instead of base 62 for
10926 its message identifiers (because those systems do not have case-sensitive
10927 filenames), base 36 is used by this operator, despite its name. &*Note*&: Just
10928 to be absolutely clear: this is &'not'& base64 encoding.
10929
10930 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
10931 .cindex "&%base62d%& expansion item"
10932 .cindex "expansion" "conversion to base 62"
10933 The string must consist entirely of base-62 digits, or, in operating
10934 environments where Exim uses base 36 instead of base 62 for its message
10935 identifiers, base-36 digits. The number is converted to decimal and output as a
10936 string.
10937
10938 .vitem &*${base64:*&<&'string'&>&*}*&
10939 .cindex "expansion" "base64 encoding"
10940 .cindex "base64 encoding" "in string expansion"
10941 .cindex "&%base64%& expansion item"
10942 .cindex certificate "base64 of DER"
10943 This operator converts a string into one that is base64 encoded.
10944
10945 If the string is a single variable of type certificate,
10946 returns the base64 encoding of the DER form of the certificate.
10947
10948
10949 .vitem &*${base64d:*&<&'string'&>&*}*&
10950 .cindex "expansion" "base64 decoding"
10951 .cindex "base64 decoding" "in string expansion"
10952 .cindex "&%base64d%& expansion item"
10953 This operator converts a base64-encoded string into the un-coded form.
10954
10955
10956 .vitem &*${domain:*&<&'string'&>&*}*&
10957 .cindex "domain" "extraction"
10958 .cindex "expansion" "domain extraction"
10959 The string is interpreted as an RFC 2822 address and the domain is extracted
10960 from it. If the string does not parse successfully, the result is empty.
10961
10962
10963 .vitem &*${escape:*&<&'string'&>&*}*&
10964 .cindex "expansion" "escaping non-printing characters"
10965 .cindex "&%escape%& expansion item"
10966 If the string contains any non-printing characters, they are converted to
10967 escape sequences starting with a backslash. Whether characters with the most
10968 significant bit set (so-called &"8-bit characters"&) count as printing or not
10969 is controlled by the &%print_topbitchars%& option.
10970
10971 .vitem &*${escape8bit:*&<&'string'&>&*}*&
10972 .cindex "expansion" "escaping 8-bit characters"
10973 .cindex "&%escape8bit%& expansion item"
10974 If the string contains and characters with the most significant bit set,
10975 they are converted to escape sequences starting with a backslash.
10976 Backslashes and DEL characters are also converted.
10977
10978
10979 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
10980 .cindex "expansion" "expression evaluation"
10981 .cindex "expansion" "arithmetic expression"
10982 .cindex "&%eval%& expansion item"
10983 These items supports simple arithmetic and bitwise logical operations in
10984 expansion strings. The string (after expansion) must be a conventional
10985 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
10986 logical operators, and parentheses. All operations are carried out using
10987 integer arithmetic. The operator priorities are as follows (the same as in the
10988 C programming language):
10989 .table2 70pt 300pt
10990 .irow &'highest:'& "not (~), negate (-)"
10991 .irow ""   "multiply (*), divide (/), remainder (%)"
10992 .irow ""   "plus (+), minus (-)"
10993 .irow ""   "shift-left (<<), shift-right (>>)"
10994 .irow ""   "and (&&)"
10995 .irow ""   "xor (^)"
10996 .irow &'lowest:'&  "or (|)"
10997 .endtable
10998 Binary operators with the same priority are evaluated from left to right. White
10999 space is permitted before or after operators.
11000
11001 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
11002 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
11003 decimal, even if they start with a leading zero; hexadecimal numbers are not
11004 permitted. This can be useful when processing numbers extracted from dates or
11005 times, which often do have leading zeros.
11006
11007 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
11008 or 1024*1024*1024,
11009 respectively. Negative numbers are supported. The result of the computation is
11010 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
11011
11012 .display
11013 &`${eval:1+1}            `&  yields 2
11014 &`${eval:1+2*3}          `&  yields 7
11015 &`${eval:(1+2)*3}        `&  yields 9
11016 &`${eval:2+42%5}         `&  yields 4
11017 &`${eval:0xc&amp;5}          `&  yields 4
11018 &`${eval:0xc|5}          `&  yields 13
11019 &`${eval:0xc^5}          `&  yields 9
11020 &`${eval:0xc>>1}         `&  yields 6
11021 &`${eval:0xc<<1}         `&  yields 24
11022 &`${eval:~255&amp;0x1234}    `&  yields 4608
11023 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
11024 .endd
11025
11026 As a more realistic example, in an ACL you might have
11027 .code
11028 deny   condition =                    \
11029          ${if and {                   \
11030            {>{$rcpt_count}{10}}       \
11031            {                          \
11032            <                          \
11033              {$recipients_count}      \
11034              {${eval:$rcpt_count/2}}  \
11035            }                          \
11036          }{yes}{no}}
11037        message = Too many bad recipients
11038 .endd
11039 The condition is true if there have been more than 10 RCPT commands and
11040 fewer than half of them have resulted in a valid recipient.
11041
11042
11043 .vitem &*${expand:*&<&'string'&>&*}*&
11044 .cindex "expansion" "re-expansion of substring"
11045 The &%expand%& operator causes a string to be expanded for a second time. For
11046 example,
11047 .code
11048 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
11049 .endd
11050 first looks up a string in a file while expanding the operand for &%expand%&,
11051 and then re-expands what it has found.
11052
11053
11054 .vitem &*${from_utf8:*&<&'string'&>&*}*&
11055 .cindex "Unicode"
11056 .cindex "UTF-8" "conversion from"
11057 .cindex "expansion" "UTF-8 conversion"
11058 .cindex "&%from_utf8%& expansion item"
11059 The world is slowly moving towards Unicode, although there are no standards for
11060 email yet. However, other applications (including some databases) are starting
11061 to store data in Unicode, using UTF-8 encoding. This operator converts from a
11062 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
11063 converted to underscores. The input must be a valid UTF-8 string. If it is not,
11064 the result is an undefined sequence of bytes.
11065
11066 Unicode code points with values less than 256 are compatible with ASCII and
11067 ISO-8859-1 (also known as Latin-1).
11068 For example, character 169 is the copyright symbol in both cases, though the
11069 way it is encoded is different. In UTF-8, more than one byte is needed for
11070 characters with code values greater than 127, whereas ISO-8859-1 is a
11071 single-byte encoding (but thereby limited to 256 characters). This makes
11072 translation from UTF-8 to ISO-8859-1 straightforward.
11073
11074
11075 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
11076 .cindex "hash function" "textual"
11077 .cindex "expansion" "textual hash"
11078 The &%hash%& operator is a simpler interface to the hashing function that can
11079 be used when the two parameters are fixed numbers (as opposed to strings that
11080 change when expanded). The effect is the same as
11081 .code
11082 ${hash{<n>}{<m>}{<string>}}
11083 .endd
11084 See the description of the general &%hash%& item above for details. The
11085 abbreviation &%h%& can be used when &%hash%& is used as an operator.
11086
11087
11088
11089 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
11090 .cindex "base64 encoding" "conversion from hex"
11091 .cindex "expansion" "hex to base64"
11092 .cindex "&%hex2b64%& expansion item"
11093 This operator converts a hex string into one that is base64 encoded. This can
11094 be useful for processing the output of the various hashing functions.
11095
11096
11097
11098 .vitem &*${hexquote:*&<&'string'&>&*}*&
11099 .cindex "quoting" "hex-encoded unprintable characters"
11100 .cindex "&%hexquote%& expansion item"
11101 This operator converts non-printable characters in a string into a hex
11102 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
11103 as is, and other byte values are converted to &`\xNN`&, for example, a
11104 byte value 127 is converted to &`\x7f`&.
11105
11106
11107 .vitem &*${ipv6denorm:*&<&'string'&>&*}*&
11108 .cindex "&%ipv6denorm%& expansion item"
11109 .cindex "IP address" normalisation
11110 This expands an IPv6 address to a full eight-element colon-separated set
11111 of hex digits including leading zeroes.
11112 A trailing ipv4-style dotted-decimal set is converted to hex.
11113 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
11114
11115 .vitem &*${ipv6norm:*&<&'string'&>&*}*&
11116 .cindex "&%ipv6norm%& expansion item"
11117 .cindex "IP address" normalisation
11118 .cindex "IP address" "canonical form"
11119 This converts an IPv6 address to canonical form.
11120 Leading zeroes of groups are omitted, and the longest
11121 set of zero-valued groups is replaced with a double colon.
11122 A trailing ipv4-style dotted-decimal set is converted to hex.
11123 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
11124
11125
11126 .vitem &*${lc:*&<&'string'&>&*}*&
11127 .cindex "case forcing in strings"
11128 .cindex "string" "case forcing"
11129 .cindex "lower casing"
11130 .cindex "expansion" "case forcing"
11131 .cindex "&%lc%& expansion item"
11132 This forces the letters in the string into lower-case, for example:
11133 .code
11134 ${lc:$local_part}
11135 .endd
11136 Case is defined per the system C locale.
11137
11138 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
11139 .cindex "expansion" "string truncation"
11140 .cindex "&%length%& expansion item"
11141 The &%length%& operator is a simpler interface to the &%length%& function that
11142 can be used when the parameter is a fixed number (as opposed to a string that
11143 changes when expanded). The effect is the same as
11144 .code
11145 ${length{<number>}{<string>}}
11146 .endd
11147 See the description of the general &%length%& item above for details. Note that
11148 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
11149 when &%length%& is used as an operator.
11150 All measurement is done in bytes and is not UTF-8 aware.
11151
11152
11153 .vitem &*${listcount:*&<&'string'&>&*}*&
11154 .cindex "expansion" "list item count"
11155 .cindex "list" "item count"
11156 .cindex "list" "count of items"
11157 .cindex "&%listcount%& expansion item"
11158 The string is interpreted as a list and the number of items is returned.
11159
11160
11161 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
11162 .cindex "expansion" "named list"
11163 .cindex "&%listnamed%& expansion item"
11164 The name is interpreted as a named list and the content of the list is returned,
11165 expanding any referenced lists, re-quoting as needed for colon-separation.
11166 If the optional type is given it must be one of "a", "d", "h" or "l"
11167 and selects address-, domain-, host- or localpart- lists to search among respectively.
11168 Otherwise all types are searched in an undefined order and the first
11169 matching list is returned.
11170
11171
11172 .vitem &*${local_part:*&<&'string'&>&*}*&
11173 .cindex "expansion" "local part extraction"
11174 .cindex "&%local_part%& expansion item"
11175 The string is interpreted as an RFC 2822 address and the local part is
11176 extracted from it. If the string does not parse successfully, the result is
11177 empty.
11178 The parsing correctly handles SMTPUTF8 Unicode in the string.
11179
11180
11181 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
11182 .cindex "masked IP address"
11183 .cindex "IP address" "masking"
11184 .cindex "CIDR notation"
11185 .cindex "expansion" "IP address masking"
11186 .cindex "&%mask%& expansion item"
11187 If the form of the string to be operated on is not an IP address followed by a
11188 slash and an integer (that is, a network address in CIDR notation), the
11189 expansion fails. Otherwise, this operator converts the IP address to binary,
11190 masks off the least significant bits according to the bit count, and converts
11191 the result back to text, with mask appended. For example,
11192 .code
11193 ${mask:10.111.131.206/28}
11194 .endd
11195 returns the string &"10.111.131.192/28"&. Since this operation is expected to
11196 be mostly used for looking up masked addresses in files, the result for an IPv6
11197 address uses dots to separate components instead of colons, because colon
11198 terminates a key string in lsearch files. So, for example,
11199 .code
11200 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
11201 .endd
11202 returns the string
11203 .code
11204 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
11205 .endd
11206 Letters in IPv6 addresses are always output in lower case.
11207
11208
11209 .vitem &*${md5:*&<&'string'&>&*}*&
11210 .cindex "MD5 hash"
11211 .cindex "expansion" "MD5 hash"
11212 .cindex certificate fingerprint
11213 .cindex "&%md5%& expansion item"
11214 The &%md5%& operator computes the MD5 hash value of the string, and returns it
11215 as a 32-digit hexadecimal number, in which any letters are in lower case.
11216
11217 If the string is a single variable of type certificate,
11218 returns the MD5 hash fingerprint of the certificate.
11219
11220
11221 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
11222 .cindex "expansion" "numeric hash"
11223 .cindex "hash function" "numeric"
11224 The &%nhash%& operator is a simpler interface to the numeric hashing function
11225 that can be used when the two parameters are fixed numbers (as opposed to
11226 strings that change when expanded). The effect is the same as
11227 .code
11228 ${nhash{<n>}{<m>}{<string>}}
11229 .endd
11230 See the description of the general &%nhash%& item above for details.
11231
11232
11233 .vitem &*${quote:*&<&'string'&>&*}*&
11234 .cindex "quoting" "in string expansions"
11235 .cindex "expansion" "quoting"
11236 .cindex "&%quote%& expansion item"
11237 The &%quote%& operator puts its argument into double quotes if it
11238 is an empty string or
11239 contains anything other than letters, digits, underscores, dots, and hyphens.
11240 Any occurrences of double quotes and backslashes are escaped with a backslash.
11241 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
11242 respectively For example,
11243 .code
11244 ${quote:ab"*"cd}
11245 .endd
11246 becomes
11247 .code
11248 "ab\"*\"cd"
11249 .endd
11250 The place where this is useful is when the argument is a substitution from a
11251 variable or a message header.
11252
11253 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
11254 .cindex "&%quote_local_part%& expansion item"
11255 This operator is like &%quote%&, except that it quotes the string only if
11256 required to do so by the rules of RFC 2822 for quoting local parts. For
11257 example, a plus sign would not cause quoting (but it would for &%quote%&).
11258 If you are creating a new email address from the contents of &$local_part$&
11259 (or any other unknown data), you should always use this operator.
11260
11261 This quoting determination is not SMTPUTF8-aware, thus quoting non-ASCII data
11262 will likely use the quoting form.
11263 Thus &'${quote_local_part:フィル}'& will always become &'"フィル"'&.
11264
11265
11266 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
11267 .cindex "quoting" "lookup-specific"
11268 This operator applies lookup-specific quoting rules to the string. Each
11269 query-style lookup type has its own quoting rules which are described with
11270 the lookups in chapter &<<CHAPfdlookup>>&. For example,
11271 .code
11272 ${quote_ldap:two * two}
11273 .endd
11274 returns
11275 .code
11276 two%20%5C2A%20two
11277 .endd
11278 For single-key lookup types, no quoting is ever necessary and this operator
11279 yields an unchanged string.
11280
11281
11282 .vitem &*${randint:*&<&'n'&>&*}*&
11283 .cindex "random number"
11284 This operator returns a somewhat random number which is less than the
11285 supplied number and is at least 0.  The quality of this randomness depends
11286 on how Exim was built; the values are not suitable for keying material.
11287 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
11288 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
11289 for versions of GnuTLS with that function.
11290 Otherwise, the implementation may be arc4random(), random() seeded by
11291 srandomdev() or srandom(), or a custom implementation even weaker than
11292 random().
11293
11294
11295 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
11296 .cindex "expansion" "IP address"
11297 This operator reverses an IP address; for IPv4 addresses, the result is in
11298 dotted-quad decimal form, while for IPv6 addresses the result is in
11299 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
11300 for DNS.  For example,
11301 .code
11302 ${reverse_ip:192.0.2.4}
11303 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
11304 .endd
11305 returns
11306 .code
11307 4.2.0.192
11308 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
11309 .endd
11310
11311
11312 .vitem &*${rfc2047:*&<&'string'&>&*}*&
11313 .cindex "expansion" "RFC 2047"
11314 .cindex "RFC 2047" "expansion operator"
11315 .cindex "&%rfc2047%& expansion item"
11316 This operator encodes text according to the rules of RFC 2047. This is an
11317 encoding that is used in header lines to encode non-ASCII characters. It is
11318 assumed that the input string is in the encoding specified by the
11319 &%headers_charset%& option, which gets its default at build time. If the string
11320 contains only characters in the range 33&--126, and no instances of the
11321 characters
11322 .code
11323 ? = ( ) < > @ , ; : \ " . [ ] _
11324 .endd
11325 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
11326 string, using as many &"encoded words"& as necessary to encode all the
11327 characters.
11328
11329
11330 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
11331 .cindex "expansion" "RFC 2047"
11332 .cindex "RFC 2047" "decoding"
11333 .cindex "&%rfc2047d%& expansion item"
11334 This operator decodes strings that are encoded as per RFC 2047. Binary zero
11335 bytes are replaced by question marks. Characters are converted into the
11336 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
11337 not recognized unless &%check_rfc2047_length%& is set false.
11338
11339 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
11340 access a header line, RFC 2047 decoding is done automatically. You do not need
11341 to use this operator as well.
11342
11343
11344
11345 .vitem &*${rxquote:*&<&'string'&>&*}*&
11346 .cindex "quoting" "in regular expressions"
11347 .cindex "regular expressions" "quoting"
11348 .cindex "&%rxquote%& expansion item"
11349 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
11350 characters in its argument. This is useful when substituting the values of
11351 variables or headers inside regular expressions.
11352
11353
11354 .vitem &*${sha1:*&<&'string'&>&*}*&
11355 .cindex "SHA-1 hash"
11356 .cindex "expansion" "SHA-1 hashing"
11357 .cindex certificate fingerprint
11358 .cindex "&%sha1%& expansion item"
11359 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
11360 it as a 40-digit hexadecimal number, in which any letters are in upper case.
11361
11362 If the string is a single variable of type certificate,
11363 returns the SHA-1 hash fingerprint of the certificate.
11364
11365
11366 .vitem &*${sha256:*&<&'string'&>&*}*& &&&
11367        &*${sha2:*&<&'string'&>&*}*& &&&
11368        &*${sha2_<n>:*&<&'string'&>&*}*&
11369 .cindex "SHA-256 hash"
11370 .cindex "SHA-2 hash"
11371 .cindex certificate fingerprint
11372 .cindex "expansion" "SHA-256 hashing"
11373 .cindex "&%sha256%& expansion item"
11374 .cindex "&%sha2%& expansion item"
11375 The &%sha256%& operator computes the SHA-256 hash value of the string
11376 and returns
11377 it as a 64-digit hexadecimal number, in which any letters are in upper case.
11378
11379 If the string is a single variable of type certificate,
11380 returns the SHA-256 hash fingerprint of the certificate.
11381
11382 The operator can also be spelled &%sha2%& and does the same as &%sha256%&
11383 (except for certificates, which are not supported).
11384 Finally, if an underbar
11385 and a number is appended it specifies the output length, selecting a
11386 member of the SHA-2 family of hash functions.
11387 Values of 256, 384 and 512 are accepted, with 256 being the default.
11388
11389
11390 .vitem &*${sha3:*&<&'string'&>&*}*& &&&
11391        &*${sha3_<n>:*&<&'string'&>&*}*&
11392 .cindex "SHA3 hash"
11393 .cindex "expansion" "SHA3 hashing"
11394 .cindex "&%sha3%& expansion item"
11395 The &%sha3%& operator computes the SHA3-256 hash value of the string
11396 and returns
11397 it as a 64-digit hexadecimal number, in which any letters are in upper case.
11398
11399 If a number is appended, separated by an underbar, it specifies
11400 the output length.  Values of 224, 256, 384 and 512 are accepted;
11401 with 256 being the default.
11402
11403 The &%sha3%& expansion item is only supported if Exim has been
11404 compiled with GnuTLS 3.5.0 or later,
11405 or OpenSSL 1.1.1 or later.
11406 The macro "_CRYPTO_HASH_SHA3" will be defined if it is supported.
11407
11408
11409 .vitem &*${stat:*&<&'string'&>&*}*&
11410 .cindex "expansion" "statting a file"
11411 .cindex "file" "extracting characteristics"
11412 .cindex "&%stat%& expansion item"
11413 The string, after expansion, must be a file path. A call to the &[stat()]&
11414 function is made for this path. If &[stat()]& fails, an error occurs and the
11415 expansion fails. If it succeeds, the data from the stat replaces the item, as a
11416 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
11417 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
11418 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
11419 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
11420 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
11421 can extract individual fields using the &%extract%& expansion item.
11422
11423 The use of the &%stat%& expansion in users' filter files can be locked out by
11424 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
11425 systems for files larger than 2GB.
11426
11427 .vitem &*${str2b64:*&<&'string'&>&*}*&
11428 .cindex "&%str2b64%& expansion item"
11429 Now deprecated, a synonym for the &%base64%& expansion operator.
11430
11431
11432
11433 .vitem &*${strlen:*&<&'string'&>&*}*&
11434 .cindex "expansion" "string length"
11435 .cindex "string" "length in expansion"
11436 .cindex "&%strlen%& expansion item"
11437 The item is replace by the length of the expanded string, expressed as a
11438 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
11439 All measurement is done in bytes and is not UTF-8 aware.
11440
11441
11442 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
11443 .cindex "&%substr%& expansion item"
11444 .cindex "substring extraction"
11445 .cindex "expansion" "substring expansion"
11446 The &%substr%& operator is a simpler interface to the &%substr%& function that
11447 can be used when the two parameters are fixed numbers (as opposed to strings
11448 that change when expanded). The effect is the same as
11449 .code
11450 ${substr{<start>}{<length>}{<string>}}
11451 .endd
11452 See the description of the general &%substr%& item above for details. The
11453 abbreviation &%s%& can be used when &%substr%& is used as an operator.
11454 All measurement is done in bytes and is not UTF-8 aware.
11455
11456 .vitem &*${time_eval:*&<&'string'&>&*}*&
11457 .cindex "&%time_eval%& expansion item"
11458 .cindex "time interval" "decoding"
11459 This item converts an Exim time interval such as &`2d4h5m`& into a number of
11460 seconds.
11461
11462 .vitem &*${time_interval:*&<&'string'&>&*}*&
11463 .cindex "&%time_interval%& expansion item"
11464 .cindex "time interval" "formatting"
11465 The argument (after sub-expansion) must be a sequence of decimal digits that
11466 represents an interval of time as a number of seconds. It is converted into a
11467 number of larger units and output in Exim's normal time format, for example,
11468 &`1w3d4h2m6s`&.
11469
11470 .vitem &*${uc:*&<&'string'&>&*}*&
11471 .cindex "case forcing in strings"
11472 .cindex "string" "case forcing"
11473 .cindex "upper casing"
11474 .cindex "expansion" "case forcing"
11475 .cindex "&%uc%& expansion item"
11476 This forces the letters in the string into upper-case.
11477 Case is defined per the system C locale.
11478
11479 .vitem &*${utf8clean:*&<&'string'&>&*}*&
11480 .cindex "correction of invalid utf-8 sequences in strings"
11481 .cindex "utf-8" "utf-8 sequences"
11482 .cindex "incorrect utf-8"
11483 .cindex "expansion" "utf-8 forcing"
11484 .cindex "&%utf8clean%& expansion item"
11485 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
11486 In versions of Exim before 4.92, this did not correctly do so for a truncated
11487 final codepoint's encoding, and the character would be silently dropped.
11488 If you must handle detection of this scenario across both sets of Exim behavior,
11489 the complexity will depend upon the task.
11490 For instance, to detect if the first character is multibyte and a 1-byte
11491 extraction can be successfully used as a path component (as is common for
11492 dividing up delivery folders), you might use:
11493 .code
11494 condition = ${if inlist{${utf8clean:${length_1:$local_part}}}{:?}{yes}{no}}
11495 .endd
11496 (which will false-positive if the first character of the local part is a
11497 literal question mark).
11498
11499 .vitem "&*${utf8_domain_to_alabel:*&<&'string'&>&*}*&" &&&
11500        "&*${utf8_domain_from_alabel:*&<&'string'&>&*}*&" &&&
11501        "&*${utf8_localpart_to_alabel:*&<&'string'&>&*}*&" &&&
11502        "&*${utf8_localpart_from_alabel:*&<&'string'&>&*}*&"
11503 .cindex expansion UTF-8
11504 .cindex UTF-8 expansion
11505 .cindex EAI
11506 .cindex internationalisation
11507 .cindex "&%utf8_domain_to_alabel%& expansion item"
11508 .cindex "&%utf8_domain_from_alabel%& expansion item"
11509 .cindex "&%utf8_localpart_to_alabel%& expansion item"
11510 .cindex "&%utf8_localpart_from_alabel%& expansion item"
11511 These convert EAI mail name components between UTF-8 and a-label forms.
11512 For information on internationalisation support see &<<SECTi18nMTA>>&.
11513 .endlist
11514
11515
11516
11517
11518
11519
11520 .section "Expansion conditions" "SECTexpcond"
11521 .scindex IIDexpcond "expansion" "conditions"
11522 The following conditions are available for testing by the &%${if%& construct
11523 while expanding strings:
11524
11525 .vlist
11526 .vitem &*!*&<&'condition'&>
11527 .cindex "expansion" "negating a condition"
11528 .cindex "negation" "in expansion condition"
11529 Preceding any condition with an exclamation mark negates the result of the
11530 condition.
11531
11532 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11533 .cindex "numeric comparison"
11534 .cindex "expansion" "numeric comparison"
11535 There are a number of symbolic operators for doing numeric comparisons. They
11536 are:
11537 .display
11538 &`=   `&   equal
11539 &`==  `&   equal
11540 &`>   `&   greater
11541 &`>=  `&   greater or equal
11542 &`<   `&   less
11543 &`<=  `&   less or equal
11544 .endd
11545 For example:
11546 .code
11547 ${if >{$message_size}{10M} ...
11548 .endd
11549 Note that the general negation operator provides for inequality testing. The
11550 two strings must take the form of optionally signed decimal integers,
11551 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
11552 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
11553 As a special case, the numerical value of an empty string is taken as
11554 zero.
11555
11556 In all cases, a relative comparator OP is testing if <&'string1'&> OP
11557 <&'string2'&>; the above example is checking if &$message_size$& is larger than
11558 10M, not if 10M is larger than &$message_size$&.
11559
11560
11561 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
11562         {*&<&'arg2'&>&*}...}*&
11563 .cindex "expansion" "calling an acl"
11564 .cindex "&%acl%&" "expansion condition"
11565 The name and zero to nine argument strings are first expanded separately.  The expanded
11566 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
11567 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
11568 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
11569 and may use the variables; if another acl expansion is used the values
11570 are restored after it returns.  If the ACL sets
11571 a value using a "message =" modifier the variable $value becomes
11572 the result of the expansion, otherwise it is empty.
11573 If the ACL returns accept the condition is true; if deny, false.
11574 If the ACL returns defer the result is a forced-fail.
11575
11576 .vitem &*bool&~{*&<&'string'&>&*}*&
11577 .cindex "expansion" "boolean parsing"
11578 .cindex "&%bool%& expansion condition"
11579 This condition turns a string holding a true or false representation into
11580 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
11581 (case-insensitively); also integer numbers map to true if non-zero,
11582 false if zero.
11583 An empty string is treated as false.
11584 Leading and trailing whitespace is ignored;
11585 thus a string consisting only of whitespace is false.
11586 All other string values will result in expansion failure.
11587
11588 When combined with ACL variables, this expansion condition will let you
11589 make decisions in one place and act on those decisions in another place.
11590 For example:
11591 .code
11592 ${if bool{$acl_m_privileged_sender} ...
11593 .endd
11594
11595
11596 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
11597 .cindex "expansion" "boolean parsing"
11598 .cindex "&%bool_lax%& expansion condition"
11599 Like &%bool%&, this condition turns a string into a boolean state.  But
11600 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
11601 loose definition that the Router &%condition%& option uses.  The empty string
11602 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
11603 true.  Leading and trailing whitespace is ignored.
11604
11605 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
11606
11607 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11608 .cindex "expansion" "encrypted comparison"
11609 .cindex "encrypted strings, comparing"
11610 .cindex "&%crypteq%& expansion condition"
11611 This condition is included in the Exim binary if it is built to support any
11612 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
11613 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
11614 included in the binary.
11615
11616 The &%crypteq%& condition has two arguments. The first is encrypted and
11617 compared against the second, which is already encrypted. The second string may
11618 be in the LDAP form for storing encrypted strings, which starts with the
11619 encryption type in curly brackets, followed by the data. If the second string
11620 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
11621 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
11622 Typically this will be a field from a password file. An example of an encrypted
11623 string in LDAP form is:
11624 .code
11625 {md5}CY9rzUYh03PK3k6DJie09g==
11626 .endd
11627 If such a string appears directly in an expansion, the curly brackets have to
11628 be quoted, because they are part of the expansion syntax. For example:
11629 .code
11630 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
11631 .endd
11632 The following encryption types (whose names are matched case-independently) are
11633 supported:
11634
11635 .ilist
11636 .cindex "MD5 hash"
11637 .cindex "base64 encoding" "in encrypted password"
11638 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
11639 printable characters to compare with the remainder of the second string. If the
11640 length of the comparison string is 24, Exim assumes that it is base64 encoded
11641 (as in the above example). If the length is 32, Exim assumes that it is a
11642 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
11643 comparison fails.
11644
11645 .next
11646 .cindex "SHA-1 hash"
11647 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
11648 printable characters to compare with the remainder of the second string. If the
11649 length of the comparison string is 28, Exim assumes that it is base64 encoded.
11650 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
11651 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
11652
11653 .next
11654 .cindex "&[crypt()]&"
11655 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
11656 only the first eight characters of the password. However, in modern operating
11657 systems this is no longer true, and in many cases the entire password is used,
11658 whatever its length.
11659
11660 .next
11661 .cindex "&[crypt16()]&"
11662 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
11663 use up to 16 characters of the password in some operating systems. Again, in
11664 modern operating systems, more characters may be used.
11665 .endlist
11666 Exim has its own version of &[crypt16()]&, which is just a double call to
11667 &[crypt()]&. For operating systems that have their own version, setting
11668 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
11669 operating system version instead of its own. This option is set by default in
11670 the OS-dependent &_Makefile_& for those operating systems that are known to
11671 support &[crypt16()]&.
11672
11673 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
11674 it was not using the same algorithm as some operating systems' versions. It
11675 turns out that as well as &[crypt16()]& there is a function called
11676 &[bigcrypt()]& in some operating systems. This may or may not use the same
11677 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
11678
11679 However, since there is now a move away from the traditional &[crypt()]&
11680 functions towards using SHA1 and other algorithms, tidying up this area of
11681 Exim is seen as very low priority.
11682
11683 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
11684 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
11685 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
11686 default is &`{crypt}`&. Whatever the default, you can always use either
11687 function by specifying it explicitly in curly brackets.
11688
11689 .vitem &*def:*&<&'variable&~name'&>
11690 .cindex "expansion" "checking for empty variable"
11691 .cindex "&%def%& expansion condition"
11692 The &%def%& condition must be followed by the name of one of the expansion
11693 variables defined in section &<<SECTexpvar>>&. The condition is true if the
11694 variable does not contain the empty string. For example:
11695 .code
11696 ${if def:sender_ident {from $sender_ident}}
11697 .endd
11698 Note that the variable name is given without a leading &%$%& character. If the
11699 variable does not exist, the expansion fails.
11700
11701 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
11702         &~&*def:h_*&<&'header&~name'&>&*:*&"
11703 .cindex "expansion" "checking header line existence"
11704 This condition is true if a message is being processed and the named header
11705 exists in the message. For example,
11706 .code
11707 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
11708 .endd
11709 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
11710 the header name must be terminated by a colon if white space does not follow.
11711
11712 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11713        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11714 .cindex "string" "comparison"
11715 .cindex "expansion" "string comparison"
11716 .cindex "&%eq%& expansion condition"
11717 .cindex "&%eqi%& expansion condition"
11718 The two substrings are first expanded. The condition is true if the two
11719 resulting strings are identical. For &%eq%& the comparison includes the case of
11720 letters, whereas for &%eqi%& the comparison is case-independent, where
11721 case is defined per the system C locale.
11722
11723 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
11724 .cindex "expansion" "file existence test"
11725 .cindex "file" "existence test"
11726 .cindex "&%exists%&, expansion condition"
11727 The substring is first expanded and then interpreted as an absolute path. The
11728 condition is true if the named file (or directory) exists. The existence test
11729 is done by calling the &[stat()]& function. The use of the &%exists%& test in
11730 users' filter files may be locked out by the system administrator.
11731
11732 .new
11733 &*Note:*& Testing a path using this condition is not a sufficient way of
11734 de-tainting it.
11735 .wen
11736
11737 .vitem &*first_delivery*&
11738 .cindex "delivery" "first"
11739 .cindex "first delivery"
11740 .cindex "expansion" "first delivery test"
11741 .cindex "&%first_delivery%& expansion condition"
11742 This condition, which has no data, is true during a message's first delivery
11743 attempt. It is false during any subsequent delivery attempts.
11744
11745
11746 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
11747        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
11748 .cindex "list" "iterative conditions"
11749 .cindex "expansion" "&*forall*& condition"
11750 .cindex "expansion" "&*forany*& condition"
11751 .vindex "&$item$&"
11752 These conditions iterate over a list. The first argument is expanded to form
11753 the list. By default, the list separator is a colon, but it can be changed by
11754 the normal method (&<<SECTlistsepchange>>&).
11755 The second argument is interpreted as a condition that is to
11756 be applied to each item in the list in turn. During the interpretation of the
11757 condition, the current list item is placed in a variable called &$item$&.
11758 .ilist
11759 For &*forany*&, interpretation stops if the condition is true for any item, and
11760 the result of the whole condition is true. If the condition is false for all
11761 items in the list, the overall condition is false.
11762 .next
11763 For &*forall*&, interpretation stops if the condition is false for any item,
11764 and the result of the whole condition is false. If the condition is true for
11765 all items in the list, the overall condition is true.
11766 .endlist
11767 Note that negation of &*forany*& means that the condition must be false for all
11768 items for the overall condition to succeed, and negation of &*forall*& means
11769 that the condition must be false for at least one item. In this example, the
11770 list separator is changed to a comma:
11771 .code
11772 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
11773 .endd
11774 The value of &$item$& is saved and restored while &%forany%& or &%forall%& is
11775 being processed, to enable these expansion items to be nested.
11776
11777 To scan a named list, expand it with the &*listnamed*& operator.
11778
11779 .vitem "&*forall_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11780        "&*forany_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11781        "&*forall_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11782        "&*forany_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&"
11783 .cindex JSON "iterative conditions"
11784 .cindex JSON expansions
11785 .cindex expansion "&*forall_json*& condition"
11786 .cindex expansion "&*forany_json*& condition"
11787 .cindex expansion "&*forall_jsons*& condition"
11788 .cindex expansion "&*forany_jsons*& condition"
11789 As for the above, except that the first argument must, after expansion,
11790 be a JSON array.
11791 The array separator is not changeable.
11792 For the &"jsons"& variants the elements are expected to be JSON strings
11793 and have their quotes removed before the evaluation of the condition.
11794
11795
11796
11797 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11798        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11799 .cindex "string" "comparison"
11800 .cindex "expansion" "string comparison"
11801 .cindex "&%ge%& expansion condition"
11802 .cindex "&%gei%& expansion condition"
11803 The two substrings are first expanded. The condition is true if the first
11804 string is lexically greater than or equal to the second string. For &%ge%& the
11805 comparison includes the case of letters, whereas for &%gei%& the comparison is
11806 case-independent.
11807 Case and collation order are defined per the system C locale.
11808
11809 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11810        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11811 .cindex "string" "comparison"
11812 .cindex "expansion" "string comparison"
11813 .cindex "&%gt%& expansion condition"
11814 .cindex "&%gti%& expansion condition"
11815 The two substrings are first expanded. The condition is true if the first
11816 string is lexically greater than the second string. For &%gt%& the comparison
11817 includes the case of letters, whereas for &%gti%& the comparison is
11818 case-independent.
11819 Case and collation order are defined per the system C locale.
11820
11821
11822 .new
11823 .vitem &*inbound_srs&~{*&<&'local&~part'&>&*}{*&<&'secret'&>&*}*&
11824 SRS decode.  See SECT &<<SECTSRS>>& for details.
11825 .wen
11826
11827
11828 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11829        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11830 .cindex "string" "comparison"
11831 .cindex "list" "iterative conditions"
11832 Both strings are expanded; the second string is treated as a list of simple
11833 strings; if the first string is a member of the second, then the condition
11834 is true.
11835 For the case-independent &%inlisti%& condition, case is defined per the system C locale.
11836
11837 These are simpler to use versions of the more powerful &*forany*& condition.
11838 Examples, and the &*forany*& equivalents:
11839 .code
11840 ${if inlist{needle}{foo:needle:bar}}
11841   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
11842 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
11843   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
11844 .endd
11845
11846 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
11847        &*isip4&~{*&<&'string'&>&*}*& &&&
11848        &*isip6&~{*&<&'string'&>&*}*&
11849 .cindex "IP address" "testing string format"
11850 .cindex "string" "testing for IP address"
11851 .cindex "&%isip%& expansion condition"
11852 .cindex "&%isip4%& expansion condition"
11853 .cindex "&%isip6%& expansion condition"
11854 The substring is first expanded, and then tested to see if it has the form of
11855 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
11856 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
11857
11858 For an IPv4 address, the test is for four dot-separated components, each of
11859 which consists of from one to three digits. For an IPv6 address, up to eight
11860 colon-separated components are permitted, each containing from one to four
11861 hexadecimal digits. There may be fewer than eight components if an empty
11862 component (adjacent colons) is present. Only one empty component is permitted.
11863
11864 &*Note*&: The checks used to be just on the form of the address; actual numerical
11865 values were not considered. Thus, for example, 999.999.999.999 passed the IPv4
11866 check.
11867 This is no longer the case.
11868
11869 The main use of these tests is to distinguish between IP addresses and
11870 host names, or between IPv4 and IPv6 addresses. For example, you could use
11871 .code
11872 ${if isip4{$sender_host_address}...
11873 .endd
11874 to test which IP version an incoming SMTP connection is using.
11875
11876 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
11877 .cindex "LDAP" "use for authentication"
11878 .cindex "expansion" "LDAP authentication test"
11879 .cindex "&%ldapauth%& expansion condition"
11880 This condition supports user authentication using LDAP. See section
11881 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
11882 queries. For this use, the query must contain a user name and password. The
11883 query itself is not used, and can be empty. The condition is true if the
11884 password is not empty, and the user name and password are accepted by the LDAP
11885 server. An empty password is rejected without calling LDAP because LDAP binds
11886 with an empty password are considered anonymous regardless of the username, and
11887 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
11888 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
11889 this can be used.
11890
11891
11892 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11893        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11894 .cindex "string" "comparison"
11895 .cindex "expansion" "string comparison"
11896 .cindex "&%le%& expansion condition"
11897 .cindex "&%lei%& expansion condition"
11898 The two substrings are first expanded. The condition is true if the first
11899 string is lexically less than or equal to the second string. For &%le%& the
11900 comparison includes the case of letters, whereas for &%lei%& the comparison is
11901 case-independent.
11902 Case and collation order are defined per the system C locale.
11903
11904 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11905        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11906 .cindex "string" "comparison"
11907 .cindex "expansion" "string comparison"
11908 .cindex "&%lt%& expansion condition"
11909 .cindex "&%lti%& expansion condition"
11910 The two substrings are first expanded. The condition is true if the first
11911 string is lexically less than the second string. For &%lt%& the comparison
11912 includes the case of letters, whereas for &%lti%& the comparison is
11913 case-independent.
11914 Case and collation order are defined per the system C locale.
11915
11916
11917 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11918 .cindex "expansion" "regular expression comparison"
11919 .cindex "regular expressions" "match in expanded string"
11920 .cindex "&%match%& expansion condition"
11921 The two substrings are first expanded. The second is then treated as a regular
11922 expression and applied to the first. Because of the pre-expansion, if the
11923 regular expression contains dollar, or backslash characters, they must be
11924 escaped. Care must also be taken if the regular expression contains braces
11925 (curly brackets). A closing brace must be escaped so that it is not taken as a
11926 premature termination of <&'string2'&>. The easiest approach is to use the
11927 &`\N`& feature to disable expansion of the regular expression.
11928 For example,
11929 .code
11930 ${if match {$local_part}{\N^\d{3}\N} ...
11931 .endd
11932 If the whole expansion string is in double quotes, further escaping of
11933 backslashes is also required.
11934
11935 The condition is true if the regular expression match succeeds.
11936 The regular expression is not required to begin with a circumflex
11937 metacharacter, but if there is no circumflex, the expression is not anchored,
11938 and it may match anywhere in the subject, not just at the start. If you want
11939 the pattern to match at the end of the subject, you must include the &`$`&
11940 metacharacter at an appropriate point.
11941 All character handling is done in bytes and is not UTF-8 aware,
11942 but we might change this in a future Exim release.
11943
11944 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
11945 At the start of an &%if%& expansion the values of the numeric variable
11946 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
11947 succeeds causes them to be reset to the substrings of that condition and they
11948 will have these values during the expansion of the success string. At the end
11949 of the &%if%& expansion, the previous values are restored. After testing a
11950 combination of conditions using &%or%&, the subsequent values of the numeric
11951 variables are those of the condition that succeeded.
11952
11953 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11954 .cindex "&%match_address%& expansion condition"
11955 See &*match_local_part*&.
11956
11957 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11958 .cindex "&%match_domain%& expansion condition"
11959 See &*match_local_part*&.
11960
11961 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11962 .cindex "&%match_ip%& expansion condition"
11963 This condition matches an IP address to a list of IP address patterns. It must
11964 be followed by two argument strings. The first (after expansion) must be an IP
11965 address or an empty string. The second (not expanded) is a restricted host
11966 list that can match only an IP address, not a host name. For example:
11967 .code
11968 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
11969 .endd
11970 The specific types of host list item that are permitted in the list are:
11971
11972 .ilist
11973 An IP address, optionally with a CIDR mask.
11974 .next
11975 A single asterisk, which matches any IP address.
11976 .next
11977 An empty item, which matches only if the IP address is empty. This could be
11978 useful for testing for a locally submitted message or one from specific hosts
11979 in a single test such as
11980 . ==== As this is a nested list, any displays it contains must be indented
11981 . ==== as otherwise they are too far to the left. This comment applies to
11982 . ==== the use of xmlto plus fop. There's no problem when formatting with
11983 . ==== sdop, with or without the extra indent.
11984 .code
11985   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
11986 .endd
11987 where the first item in the list is the empty string.
11988 .next
11989 The item @[] matches any of the local host's interface addresses.
11990 .next
11991 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
11992 even if &`net-`& is not specified. There is never any attempt to turn the IP
11993 address into a host name. The most common type of linear search for
11994 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
11995 masks. For example:
11996 .code
11997   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
11998 .endd
11999 It is of course possible to use other kinds of lookup, and in such a case, you
12000 do need to specify the &`net-`& prefix if you want to specify a specific
12001 address mask, for example:
12002 .code
12003   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
12004 .endd
12005 However, unless you are combining a &%match_ip%& condition with others, it is
12006 just as easy to use the fact that a lookup is itself a condition, and write:
12007 .code
12008   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
12009 .endd
12010 .endlist ilist
12011
12012 Note that <&'string2'&> is not itself subject to string expansion, unless
12013 Exim was built with the EXPAND_LISTMATCH_RHS option.
12014
12015 Consult section &<<SECThoslispatip>>& for further details of these patterns.
12016
12017 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
12018 .cindex "domain list" "in expansion condition"
12019 .cindex "address list" "in expansion condition"
12020 .cindex "local part" "list, in expansion condition"
12021 .cindex "&%match_local_part%& expansion condition"
12022 This condition, together with &%match_address%& and &%match_domain%&, make it
12023 possible to test domain, address, and local part lists within expansions. Each
12024 condition requires two arguments: an item and a list to match. A trivial
12025 example is:
12026 .code
12027 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
12028 .endd
12029 In each case, the second argument may contain any of the allowable items for a
12030 list of the appropriate type. Also, because the second argument
12031 is a standard form of list, it is possible to refer to a named list.
12032 Thus, you can use conditions like this:
12033 .code
12034 ${if match_domain{$domain}{+local_domains}{...
12035 .endd
12036 .cindex "&`+caseful`&"
12037 For address lists, the matching starts off caselessly, but the &`+caseful`&
12038 item can be used, as in all address lists, to cause subsequent items to
12039 have their local parts matched casefully. Domains are always matched
12040 caselessly.
12041
12042 Note that <&'string2'&> is not itself subject to string expansion, unless
12043 Exim was built with the EXPAND_LISTMATCH_RHS option.
12044
12045 &*Note*&: Host lists are &'not'& supported in this way. This is because
12046 hosts have two identities: a name and an IP address, and it is not clear
12047 how to specify cleanly how such a test would work. However, IP addresses can be
12048 matched using &%match_ip%&.
12049
12050 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
12051 .cindex "PAM authentication"
12052 .cindex "AUTH" "with PAM"
12053 .cindex "Solaris" "PAM support"
12054 .cindex "expansion" "PAM authentication test"
12055 .cindex "&%pam%& expansion condition"
12056 &'Pluggable Authentication Modules'&
12057 (&url(https://mirrors.edge.kernel.org/pub/linux/libs/pam/)) are a facility that is
12058 available in the latest releases of Solaris and in some GNU/Linux
12059 distributions. The Exim support, which is intended for use in conjunction with
12060 the SMTP AUTH command, is available only if Exim is compiled with
12061 .code
12062 SUPPORT_PAM=yes
12063 .endd
12064 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
12065 in some releases of GNU/Linux &%-ldl%& is also needed.
12066
12067 The argument string is first expanded, and the result must be a
12068 colon-separated list of strings. Leading and trailing white space is ignored.
12069 The PAM module is initialized with the service name &"exim"& and the user name
12070 taken from the first item in the colon-separated data string (<&'string1'&>).
12071 The remaining items in the data string are passed over in response to requests
12072 from the authentication function. In the simple case there will only be one
12073 request, for a password, so the data consists of just two strings.
12074
12075 There can be problems if any of the strings are permitted to contain colon
12076 characters. In the usual way, these have to be doubled to avoid being taken as
12077 separators.
12078 The &%listquote%& expansion item can be used for this.
12079 For example, the configuration
12080 of a LOGIN authenticator might contain this setting:
12081 .code
12082 server_condition = ${if pam{$auth1:${listquote{:}{$auth2}}}}
12083 .endd
12084 In some operating systems, PAM authentication can be done only from a process
12085 running as root. Since Exim is running as the Exim user when receiving
12086 messages, this means that PAM cannot be used directly in those systems.
12087 . --- 2018-09-07: the pam_exim modified variant has gone, removed claims re using Exim via that
12088
12089
12090 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
12091 .cindex "&'pwcheck'& daemon"
12092 .cindex "Cyrus"
12093 .cindex "expansion" "&'pwcheck'& authentication test"
12094 .cindex "&%pwcheck%& expansion condition"
12095 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
12096 This is one way of making it possible for passwords to be checked by a process
12097 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
12098 deprecated. Its replacement is &'saslauthd'& (see below).
12099
12100 The pwcheck support is not included in Exim by default. You need to specify
12101 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
12102 building Exim. For example:
12103 .code
12104 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
12105 .endd
12106 You do not need to install the full Cyrus software suite in order to use
12107 the pwcheck daemon. You can compile and install just the daemon alone
12108 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
12109 access to the &_/var/pwcheck_& directory.
12110
12111 The &%pwcheck%& condition takes one argument, which must be the user name and
12112 password, separated by a colon. For example, in a LOGIN authenticator
12113 configuration, you might have this:
12114 .code
12115 server_condition = ${if pwcheck{$auth1:$auth2}}
12116 .endd
12117 Again, for a PLAIN authenticator configuration, this would be:
12118 .code
12119 server_condition = ${if pwcheck{$auth2:$auth3}}
12120 .endd
12121 .vitem &*queue_running*&
12122 .cindex "queue runner" "detecting when delivering from"
12123 .cindex "expansion" "queue runner test"
12124 .cindex "&%queue_running%& expansion condition"
12125 This condition, which has no data, is true during delivery attempts that are
12126 initiated by queue runner processes, and false otherwise.
12127
12128
12129 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
12130 .cindex "Radius"
12131 .cindex "expansion" "Radius authentication"
12132 .cindex "&%radius%& expansion condition"
12133 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
12134 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
12135 the Radius client configuration file in order to build Exim with Radius
12136 support.
12137
12138 With just that one setting, Exim expects to be linked with the &%radiusclient%&
12139 library, using the original API. If you are using release 0.4.0 or later of
12140 this library, you need to set
12141 .code
12142 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
12143 .endd
12144 in &_Local/Makefile_& when building Exim. You can also link Exim with the
12145 &%libradius%& library that comes with FreeBSD. To do this, set
12146 .code
12147 RADIUS_LIB_TYPE=RADLIB
12148 .endd
12149 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
12150 You may also have to supply a suitable setting in EXTRALIBS so that the
12151 Radius library can be found when Exim is linked.
12152
12153 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
12154 Radius client library, which calls the Radius server. The condition is true if
12155 the authentication is successful. For example:
12156 .code
12157 server_condition = ${if radius{<arguments>}}
12158 .endd
12159
12160
12161 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
12162         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
12163 .cindex "&'saslauthd'& daemon"
12164 .cindex "Cyrus"
12165 .cindex "expansion" "&'saslauthd'& authentication test"
12166 .cindex "&%saslauthd%& expansion condition"
12167 This condition supports user authentication using the Cyrus &'saslauthd'&
12168 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
12169 Using this daemon is one way of making it possible for passwords to be checked
12170 by a process that is not running as root.
12171
12172 The saslauthd support is not included in Exim by default. You need to specify
12173 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
12174 building Exim. For example:
12175 .code
12176 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
12177 .endd
12178 You do not need to install the full Cyrus software suite in order to use
12179 the saslauthd daemon. You can compile and install just the daemon alone
12180 from the Cyrus SASL library.
12181
12182 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
12183 two are mandatory. For example:
12184 .code
12185 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
12186 .endd
12187 The service and the realm are optional (which is why the arguments are enclosed
12188 in their own set of braces). For details of the meaning of the service and
12189 realm, and how to run the daemon, consult the Cyrus documentation.
12190 .endlist vlist
12191
12192
12193
12194 .section "Combining expansion conditions" "SECID84"
12195 .cindex "expansion" "combining conditions"
12196 Several conditions can be tested at once by combining them using the &%and%&
12197 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
12198 conditions on their own, and precede their lists of sub-conditions. Each
12199 sub-condition must be enclosed in braces within the overall braces that contain
12200 the list. No repetition of &%if%& is used.
12201
12202
12203 .vlist
12204 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
12205 .cindex "&""or""& expansion condition"
12206 .cindex "expansion" "&""or""& of conditions"
12207 The sub-conditions are evaluated from left to right. The condition is true if
12208 any one of the sub-conditions is true.
12209 For example,
12210 .code
12211 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
12212 .endd
12213 When a true sub-condition is found, the following ones are parsed but not
12214 evaluated. If there are several &"match"& sub-conditions the values of the
12215 numeric variables afterwards are taken from the first one that succeeds.
12216
12217 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
12218 .cindex "&""and""& expansion condition"
12219 .cindex "expansion" "&""and""& of conditions"
12220 The sub-conditions are evaluated from left to right. The condition is true if
12221 all of the sub-conditions are true. If there are several &"match"&
12222 sub-conditions, the values of the numeric variables afterwards are taken from
12223 the last one. When a false sub-condition is found, the following ones are
12224 parsed but not evaluated.
12225 .endlist
12226 .ecindex IIDexpcond
12227
12228
12229
12230
12231 .section "Expansion variables" "SECTexpvar"
12232 .cindex "expansion" "variables, list of"
12233 This section contains an alphabetical list of all the expansion variables. Some
12234 of them are available only when Exim is compiled with specific options such as
12235 support for TLS or the content scanning extension.
12236
12237 .vlist
12238 .vitem "&$0$&, &$1$&, etc"
12239 .cindex "numerical variables (&$1$& &$2$& etc)"
12240 When a &%match%& expansion condition succeeds, these variables contain the
12241 captured substrings identified by the regular expression during subsequent
12242 processing of the success string of the containing &%if%& expansion item.
12243 In the expansion condition case
12244 they do not retain their values afterwards; in fact, their previous
12245 values are restored at the end of processing an &%if%& item. The numerical
12246 variables may also be set externally by some other matching process which
12247 precedes the expansion of the string. For example, the commands available in
12248 Exim filter files include an &%if%& command with its own regular expression
12249 matching condition.
12250
12251 .vitem "&$acl_arg1$&, &$acl_arg2$&, etc"
12252 Within an acl condition, expansion condition or expansion item
12253 any arguments are copied to these variables,
12254 any unused variables being made empty.
12255
12256 .vitem "&$acl_c...$&"
12257 Values can be placed in these variables by the &%set%& modifier in an ACL. They
12258 can be given any name that starts with &$acl_c$& and is at least six characters
12259 long, but the sixth character must be either a digit or an underscore. For
12260 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
12261 variables persist throughout the lifetime of an SMTP connection. They can be
12262 used to pass information between ACLs and between different invocations of the
12263 same ACL. When a message is received, the values of these variables are saved
12264 with the message, and can be accessed by filters, routers, and transports
12265 during subsequent delivery.
12266
12267 .vitem "&$acl_m...$&"
12268 These variables are like the &$acl_c...$& variables, except that their values
12269 are reset after a message has been received. Thus, if several messages are
12270 received in one SMTP connection, &$acl_m...$& values are not passed on from one
12271 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
12272 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
12273 message is received, the values of these variables are saved with the message,
12274 and can be accessed by filters, routers, and transports during subsequent
12275 delivery.
12276
12277 .vitem &$acl_narg$&
12278 Within an acl condition, expansion condition or expansion item
12279 this variable has the number of arguments.
12280
12281 .vitem &$acl_verify_message$&
12282 .vindex "&$acl_verify_message$&"
12283 After an address verification has failed, this variable contains the failure
12284 message. It retains its value for use in subsequent modifiers. The message can
12285 be preserved by coding like this:
12286 .code
12287 warn !verify = sender
12288      set acl_m0 = $acl_verify_message
12289 .endd
12290 You can use &$acl_verify_message$& during the expansion of the &%message%& or
12291 &%log_message%& modifiers, to include information about the verification
12292 failure.
12293
12294 .vitem &$address_data$&
12295 .vindex "&$address_data$&"
12296 This variable is set by means of the &%address_data%& option in routers. The
12297 value then remains with the address while it is processed by subsequent routers
12298 and eventually a transport. If the transport is handling multiple addresses,
12299 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
12300 for more details. &*Note*&: The contents of &$address_data$& are visible in
12301 user filter files.
12302
12303 If &$address_data$& is set when the routers are called from an ACL to verify
12304 a recipient address, the final value is still in the variable for subsequent
12305 conditions and modifiers of the ACL statement. If routing the address caused it
12306 to be redirected to just one address, the child address is also routed as part
12307 of the verification, and in this case the final value of &$address_data$& is
12308 from the child's routing.
12309
12310 If &$address_data$& is set when the routers are called from an ACL to verify a
12311 sender address, the final value is also preserved, but this time in
12312 &$sender_address_data$&, to distinguish it from data from a recipient
12313 address.
12314
12315 In both cases (recipient and sender verification), the value does not persist
12316 after the end of the current ACL statement. If you want to preserve
12317 these values for longer, you can save them in ACL variables.
12318
12319 .vitem &$address_file$&
12320 .vindex "&$address_file$&"
12321 When, as a result of aliasing, forwarding, or filtering, a message is directed
12322 to a specific file, this variable holds the name of the file when the transport
12323 is running. At other times, the variable is empty. For example, using the
12324 default configuration, if user &%r2d2%& has a &_.forward_& file containing
12325 .code
12326 /home/r2d2/savemail
12327 .endd
12328 then when the &(address_file)& transport is running, &$address_file$&
12329 contains the text string &`/home/r2d2/savemail`&.
12330 .cindex "Sieve filter" "value of &$address_file$&"
12331 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
12332 then up to the transport configuration to generate an appropriate absolute path
12333 to the relevant file.
12334
12335 .vitem &$address_pipe$&
12336 .vindex "&$address_pipe$&"
12337 When, as a result of aliasing or forwarding, a message is directed to a pipe,
12338 this variable holds the pipe command when the transport is running.
12339
12340 .vitem "&$auth1$& &-- &$auth3$&"
12341 .vindex "&$auth1$&, &$auth2$&, etc"
12342 These variables are used in SMTP authenticators (see chapters
12343 &<<CHAPplaintext>>&&--&<<CHAPtlsauth>>&). Elsewhere, they are empty.
12344
12345 .vitem &$authenticated_id$&
12346 .cindex "authentication" "id"
12347 .vindex "&$authenticated_id$&"
12348 When a server successfully authenticates a client it may be configured to
12349 preserve some of the authentication information in the variable
12350 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
12351 user/password authenticator configuration might preserve the user name for use
12352 in the routers. Note that this is not the same information that is saved in
12353 &$sender_host_authenticated$&.
12354
12355 When a message is submitted locally (that is, not over a TCP connection)
12356 the value of &$authenticated_id$& is normally the login name of the calling
12357 process. However, a trusted user can override this by means of the &%-oMai%&
12358 command line option.
12359 This second case also sets up information used by the
12360 &$authresults$& expansion item.
12361
12362 .vitem &$authenticated_fail_id$&
12363 .cindex "authentication" "fail" "id"
12364 .vindex "&$authenticated_fail_id$&"
12365 When an authentication attempt fails, the variable &$authenticated_fail_id$&
12366 will contain the failed authentication id. If more than one authentication
12367 id is attempted, it will contain only the last one. The variable is
12368 available for processing in the ACL's, generally the quit or notquit ACL.
12369 A message to a local recipient could still be accepted without requiring
12370 authentication, which means this variable could also be visible in all of
12371 the ACL's as well.
12372
12373
12374 .vitem &$authenticated_sender$&
12375 .cindex "sender" "authenticated"
12376 .cindex "authentication" "sender"
12377 .cindex "AUTH" "on MAIL command"
12378 .vindex "&$authenticated_sender$&"
12379 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
12380 SMTP MAIL command if it believes the sender is sufficiently trusted, as
12381 described in section &<<SECTauthparamail>>&. Unless the data is the string
12382 &"<>"&, it is set as the authenticated sender of the message, and the value is
12383 available during delivery in the &$authenticated_sender$& variable. If the
12384 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
12385
12386 .vindex "&$qualify_domain$&"
12387 When a message is submitted locally (that is, not over a TCP connection), the
12388 value of &$authenticated_sender$& is an address constructed from the login
12389 name of the calling process and &$qualify_domain$&, except that a trusted user
12390 can override this by means of the &%-oMas%& command line option.
12391
12392
12393 .vitem &$authentication_failed$&
12394 .cindex "authentication" "failure"
12395 .vindex "&$authentication_failed$&"
12396 This variable is set to &"1"& in an Exim server if a client issues an AUTH
12397 command that does not succeed. Otherwise it is set to &"0"&. This makes it
12398 possible to distinguish between &"did not try to authenticate"&
12399 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
12400 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
12401 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
12402 negative response to an AUTH command, including (for example) an attempt to use
12403 an undefined mechanism.
12404
12405 .vitem &$av_failed$&
12406 .cindex "content scanning" "AV scanner failure"
12407 This variable is available when Exim is compiled with the content-scanning
12408 extension. It is set to &"0"& by default, but will be set to &"1"& if any
12409 problem occurs with the virus scanner (specified by &%av_scanner%&) during
12410 the ACL malware condition.
12411
12412 .vitem &$body_linecount$&
12413 .cindex "message body" "line count"
12414 .cindex "body of message" "line count"
12415 .vindex "&$body_linecount$&"
12416 When a message is being received or delivered, this variable contains the
12417 number of lines in the message's body. See also &$message_linecount$&.
12418
12419 .vitem &$body_zerocount$&
12420 .cindex "message body" "binary zero count"
12421 .cindex "body of message" "binary zero count"
12422 .cindex "binary zero" "in message body"
12423 .vindex "&$body_zerocount$&"
12424 When a message is being received or delivered, this variable contains the
12425 number of binary zero bytes (ASCII NULs) in the message's body.
12426
12427 .vitem &$bounce_recipient$&
12428 .vindex "&$bounce_recipient$&"
12429 This is set to the recipient address of a bounce message while Exim is creating
12430 it. It is useful if a customized bounce message text file is in use (see
12431 chapter &<<CHAPemsgcust>>&).
12432
12433 .vitem &$bounce_return_size_limit$&
12434 .vindex "&$bounce_return_size_limit$&"
12435 This contains the value set in the &%bounce_return_size_limit%& option, rounded
12436 up to a multiple of 1000. It is useful when a customized error message text
12437 file is in use (see chapter &<<CHAPemsgcust>>&).
12438
12439 .vitem &$caller_gid$&
12440 .cindex "gid (group id)" "caller"
12441 .vindex "&$caller_gid$&"
12442 The real group id under which the process that called Exim was running. This is
12443 not the same as the group id of the originator of a message (see
12444 &$originator_gid$&). If Exim re-execs itself, this variable in the new
12445 incarnation normally contains the Exim gid.
12446
12447 .vitem &$caller_uid$&
12448 .cindex "uid (user id)" "caller"
12449 .vindex "&$caller_uid$&"
12450 The real user id under which the process that called Exim was running. This is
12451 not the same as the user id of the originator of a message (see
12452 &$originator_uid$&). If Exim re-execs itself, this variable in the new
12453 incarnation normally contains the Exim uid.
12454
12455 .vitem &$callout_address$&
12456 .vindex "&$callout_address$&"
12457 After a callout for verification, spamd or malware daemon service, the
12458 address that was connected to.
12459
12460 .vitem &$compile_number$&
12461 .vindex "&$compile_number$&"
12462 The building process for Exim keeps a count of the number
12463 of times it has been compiled. This serves to distinguish different
12464 compilations of the same version of Exim.
12465
12466 .vitem &$config_dir$&
12467 .vindex "&$config_dir$&"
12468 The directory name of the main configuration file. That is, the content of
12469 &$config_file$& with the last component stripped. The value does not
12470 contain the trailing slash. If &$config_file$& does not contain a slash,
12471 &$config_dir$& is ".".
12472
12473 .vitem &$config_file$&
12474 .vindex "&$config_file$&"
12475 The name of the main configuration file Exim is using.
12476
12477 .vitem &$dkim_verify_status$&
12478 Results of DKIM verification.
12479 For details see section &<<SECDKIMVFY>>&.
12480
12481 .vitem &$dkim_cur_signer$& &&&
12482        &$dkim_verify_reason$& &&&
12483        &$dkim_domain$& &&&
12484        &$dkim_identity$& &&&
12485        &$dkim_selector$& &&&
12486        &$dkim_algo$& &&&
12487        &$dkim_canon_body$& &&&
12488        &$dkim_canon_headers$& &&&
12489        &$dkim_copiedheaders$& &&&
12490        &$dkim_bodylength$& &&&
12491        &$dkim_created$& &&&
12492        &$dkim_expires$& &&&
12493        &$dkim_headernames$& &&&
12494        &$dkim_key_testing$& &&&
12495        &$dkim_key_nosubdomains$& &&&
12496        &$dkim_key_srvtype$& &&&
12497        &$dkim_key_granularity$& &&&
12498        &$dkim_key_notes$& &&&
12499        &$dkim_key_length$&
12500 These variables are only available within the DKIM ACL.
12501 For details see section &<<SECDKIMVFY>>&.
12502
12503 .vitem &$dkim_signers$&
12504 .vindex &$dkim_signers$&
12505 When a message has been received this variable contains
12506 a colon-separated list of signer domains and identities for the message.
12507 For details see section &<<SECDKIMVFY>>&.
12508
12509 .vitem &$dmarc_domain_policy$& &&&
12510        &$dmarc_status$& &&&
12511        &$dmarc_status_text$& &&&
12512        &$dmarc_used_domains$&
12513 Results of DMARC verification.
12514 For details see section &<<SECDMARC>>&.
12515
12516 .vitem &$dnslist_domain$& &&&
12517        &$dnslist_matched$& &&&
12518        &$dnslist_text$& &&&
12519        &$dnslist_value$&
12520 .vindex "&$dnslist_domain$&"
12521 .vindex "&$dnslist_matched$&"
12522 .vindex "&$dnslist_text$&"
12523 .vindex "&$dnslist_value$&"
12524 .cindex "black list (DNS)"
12525 When a DNS (black) list lookup succeeds, these variables are set to contain
12526 the following data from the lookup: the list's domain name, the key that was
12527 looked up, the contents of any associated TXT record, and the value from the
12528 main A record. See section &<<SECID204>>& for more details.
12529
12530 .vitem &$domain$&
12531 .vindex "&$domain$&"
12532 When an address is being routed, or delivered on its own, this variable
12533 contains the domain. Uppercase letters in the domain are converted into lower
12534 case for &$domain$&.
12535
12536 Global address rewriting happens when a message is received, so the value of
12537 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
12538 is set during user filtering, but not during system filtering, because a
12539 message may have many recipients and the system filter is called just once.
12540
12541 When more than one address is being delivered at once (for example, several
12542 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
12543 have the same domain. Transports can be restricted to handling only one domain
12544 at a time if the value of &$domain$& is required at transport time &-- this is
12545 the default for local transports. For further details of the environment in
12546 which local transports are run, see chapter &<<CHAPenvironment>>&.
12547
12548 .oindex "&%delay_warning_condition%&"
12549 At the end of a delivery, if all deferred addresses have the same domain, it is
12550 set in &$domain$& during the expansion of &%delay_warning_condition%&.
12551
12552 The &$domain$& variable is also used in some other circumstances:
12553
12554 .ilist
12555 When an ACL is running for a RCPT command, &$domain$& contains the domain of
12556 the recipient address. The domain of the &'sender'& address is in
12557 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
12558 normally set during the running of the MAIL ACL. However, if the sender address
12559 is verified with a callout during the MAIL ACL, the sender domain is placed in
12560 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
12561 the &(smtp)& transport.
12562
12563 .next
12564 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12565 &$domain$& contains the domain portion of the address that is being rewritten;
12566 it can be used in the expansion of the replacement address, for example, to
12567 rewrite domains by file lookup.
12568
12569 .next
12570 With one important exception, whenever a domain list is being scanned,
12571 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
12572 a &%sender_domains%& condition in an ACL is being processed, the subject domain
12573 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
12574 that, in a RCPT ACL, the sender domain list can be dependent on the
12575 recipient domain (which is what is in &$domain$& at this time).
12576
12577 .next
12578 .cindex "ETRN" "value of &$domain$&"
12579 .oindex "&%smtp_etrn_command%&"
12580 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
12581 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
12582 .endlist
12583
12584 .cindex "tainted data"
12585 If the origin of the data is an incoming message,
12586 the result of expanding this variable is tainted and may not
12587 be further expanded or used as a filename.
12588 When an untainted version is needed, one should be obtained from
12589 looking up the value in a local (therefore trusted) database.
12590 Often &$domain_data$& is usable in this role.
12591
12592
12593 .vitem &$domain_data$&
12594 .vindex "&$domain_data$&"
12595 When the &%domains%& condition on a router
12596 .new
12597 or an ACL
12598 matches a domain
12599 against a list, the match value is copied to &$domain_data$&.
12600 This is an enhancement over previous versions of Exim, when it only
12601 applied to the data read by a lookup.
12602 For details on match values see section &<<SECTlistresults>>& et. al.
12603 .wen
12604
12605 If the router routes the
12606 address to a transport, the value is available in that transport. If the
12607 transport is handling multiple addresses, the value from the first address is
12608 used.
12609
12610 &$domain_data$& set in an ACL is available during
12611 the rest of the ACL statement.
12612
12613 .vitem &$exim_gid$&
12614 .vindex "&$exim_gid$&"
12615 This variable contains the numerical value of the Exim group id.
12616
12617 .vitem &$exim_path$&
12618 .vindex "&$exim_path$&"
12619 This variable contains the path to the Exim binary.
12620
12621 .vitem &$exim_uid$&
12622 .vindex "&$exim_uid$&"
12623 This variable contains the numerical value of the Exim user id.
12624
12625 .vitem &$exim_version$&
12626 .vindex "&$exim_version$&"
12627 This variable contains the version string of the Exim build.
12628 The first character is a major version number, currently 4.
12629 Then after a dot, the next group of digits is a minor version number.
12630 There may be other characters following the minor version.
12631 This value may be overridden by the &%exim_version%& main config option.
12632
12633 .vitem &$header_$&<&'name'&>
12634 This is not strictly an expansion variable. It is expansion syntax for
12635 inserting the message header line with the given name. Note that the name must
12636 be terminated by colon or white space, because it may contain a wide variety of
12637 characters. Note also that braces must &'not'& be used.
12638 See the full description in section &<<SECTexpansionitems>>& above.
12639
12640 .vitem &$headers_added$&
12641 .vindex "&$headers_added$&"
12642 Within an ACL this variable contains the headers added so far by
12643 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
12644 The headers are a newline-separated list.
12645
12646 .vitem &$home$&
12647 .vindex "&$home$&"
12648 When the &%check_local_user%& option is set for a router, the user's home
12649 directory is placed in &$home$& when the check succeeds. In particular, this
12650 means it is set during the running of users' filter files. A router may also
12651 explicitly set a home directory for use by a transport; this can be overridden
12652 by a setting on the transport itself.
12653
12654 When running a filter test via the &%-bf%& option, &$home$& is set to the value
12655 of the environment variable HOME, which is subject to the
12656 &%keep_environment%& and &%add_environment%& main config options.
12657
12658 .vitem &$host$&
12659 .vindex "&$host$&"
12660 If a router assigns an address to a transport (any transport), and passes a
12661 list of hosts with the address, the value of &$host$& when the transport starts
12662 to run is the name of the first host on the list. Note that this applies both
12663 to local and remote transports.
12664
12665 .cindex "transport" "filter"
12666 .cindex "filter" "transport filter"
12667 For the &(smtp)& transport, if there is more than one host, the value of
12668 &$host$& changes as the transport works its way through the list. In
12669 particular, when the &(smtp)& transport is expanding its options for encryption
12670 using TLS, or for specifying a transport filter (see chapter
12671 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
12672 is connected.
12673
12674 When used in the client part of an authenticator configuration (see chapter
12675 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
12676 client is connected.
12677
12678
12679 .vitem &$host_address$&
12680 .vindex "&$host_address$&"
12681 This variable is set to the remote host's IP address whenever &$host$& is set
12682 for a remote connection. It is also set to the IP address that is being checked
12683 when the &%ignore_target_hosts%& option is being processed.
12684
12685 .vitem &$host_data$&
12686 .vindex "&$host_data$&"
12687 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
12688 result of the lookup is made available in the &$host_data$& variable. This
12689 allows you, for example, to do things like this:
12690 .code
12691 deny  hosts = net-lsearch;/some/file
12692       message = $host_data
12693 .endd
12694 .vitem &$host_lookup_deferred$&
12695 .cindex "host name" "lookup, failure of"
12696 .vindex "&$host_lookup_deferred$&"
12697 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
12698 message comes from a remote host and there is an attempt to look up the host's
12699 name from its IP address, and the attempt is not successful, one of these
12700 variables is set to &"1"&.
12701
12702 .ilist
12703 If the lookup receives a definite negative response (for example, a DNS lookup
12704 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
12705
12706 .next
12707 If there is any kind of problem during the lookup, such that Exim cannot
12708 tell whether or not the host name is defined (for example, a timeout for a DNS
12709 lookup), &$host_lookup_deferred$& is set to &"1"&.
12710 .endlist ilist
12711
12712 Looking up a host's name from its IP address consists of more than just a
12713 single reverse lookup. Exim checks that a forward lookup of at least one of the
12714 names it receives from a reverse lookup yields the original IP address. If this
12715 is not the case, Exim does not accept the looked up name(s), and
12716 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
12717 IP address (for example, the existence of a PTR record in the DNS) is not
12718 sufficient on its own for the success of a host name lookup. If the reverse
12719 lookup succeeds, but there is a lookup problem such as a timeout when checking
12720 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
12721 &"1"&. See also &$sender_host_name$&.
12722
12723 .cindex authentication "expansion item"
12724 Performing these checks sets up information used by the
12725 &%authresults%& expansion item.
12726
12727
12728 .vitem &$host_lookup_failed$&
12729 .vindex "&$host_lookup_failed$&"
12730 See &$host_lookup_deferred$&.
12731
12732 .vitem &$host_port$&
12733 .vindex "&$host_port$&"
12734 This variable is set to the remote host's TCP port whenever &$host$& is set
12735 for an outbound connection.
12736
12737 .vitem &$initial_cwd$&
12738 .vindex "&$initial_cwd$&
12739 This variable contains the full path name of the initial working
12740 directory of the current Exim process. This may differ from the current
12741 working directory, as Exim changes this to "/" during early startup, and
12742 to &$spool_directory$& later.
12743
12744 .vitem &$inode$&
12745 .vindex "&$inode$&"
12746 The only time this variable is set is while expanding the &%directory_file%&
12747 option in the &(appendfile)& transport. The variable contains the inode number
12748 of the temporary file which is about to be renamed. It can be used to construct
12749 a unique name for the file.
12750
12751 .vitem &$interface_address$&
12752 .vindex "&$interface_address$&"
12753 This is an obsolete name for &$received_ip_address$&.
12754
12755 .vitem &$interface_port$&
12756 .vindex "&$interface_port$&"
12757 This is an obsolete name for &$received_port$&.
12758
12759 .vitem &$item$&
12760 .vindex "&$item$&"
12761 This variable is used during the expansion of &*forall*& and &*forany*&
12762 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
12763 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
12764 empty.
12765
12766 .vitem &$ldap_dn$&
12767 .vindex "&$ldap_dn$&"
12768 This variable, which is available only when Exim is compiled with LDAP support,
12769 contains the DN from the last entry in the most recently successful LDAP
12770 lookup.
12771
12772 .vitem &$load_average$&
12773 .vindex "&$load_average$&"
12774 This variable contains the system load average, multiplied by 1000 so that it
12775 is an integer. For example, if the load average is 0.21, the value of the
12776 variable is 210. The value is recomputed every time the variable is referenced.
12777
12778 .vitem &$local_part$&
12779 .vindex "&$local_part$&"
12780 When an address is being routed, or delivered on its own, this
12781 variable contains the local part. When a number of addresses are being
12782 delivered together (for example, multiple RCPT commands in an SMTP
12783 session), &$local_part$& is not set.
12784
12785 Global address rewriting happens when a message is received, so the value of
12786 &$local_part$& during routing and delivery is the value after rewriting.
12787 &$local_part$& is set during user filtering, but not during system filtering,
12788 because a message may have many recipients and the system filter is called just
12789 once.
12790
12791 .cindex "tainted data"
12792 If the origin of the data is an incoming message,
12793 the result of expanding this variable is tainted and
12794 may not be further expanded or used as a filename.
12795
12796 &*Warning*&: the content of this variable is usually provided by a potential
12797 attacker.
12798 Consider carefully the implications of using it unvalidated as a name
12799 for file access.
12800 This presents issues for users' &_.forward_& and filter files.
12801 For traditional full user accounts, use &%check_local_users%& and the
12802 &$local_part_data$& variable rather than this one.
12803 For virtual users, store a suitable pathname component in the database
12804 which is used for account name validation, and use that retrieved value
12805 rather than this variable.
12806 Often &$local_part_data$& is usable in this role.
12807 If needed, use a router &%address_data%& or &%set%& option for
12808 the retrieved data.
12809
12810 When a message is being delivered to a file, pipe, or autoreply transport as a
12811 result of aliasing or forwarding, &$local_part$& is set to the local part of
12812 the parent address, not to the filename or command (see &$address_file$& and
12813 &$address_pipe$&).
12814
12815 When an ACL is running for a RCPT command, &$local_part$& contains the
12816 local part of the recipient address.
12817
12818 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12819 &$local_part$& contains the local part of the address that is being rewritten;
12820 it can be used in the expansion of the replacement address, for example.
12821
12822 In all cases, all quoting is removed from the local part. For example, for both
12823 the addresses
12824 .code
12825 "abc:xyz"@test.example
12826 abc\:xyz@test.example
12827 .endd
12828 the value of &$local_part$& is
12829 .code
12830 abc:xyz
12831 .endd
12832 If you use &$local_part$& to create another address, you should always wrap it
12833 inside a quoting operator. For example, in a &(redirect)& router you could
12834 have:
12835 .code
12836 data = ${quote_local_part:$local_part}@new.domain.example
12837 .endd
12838 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
12839 to process local parts in a case-dependent manner in a router, you can set the
12840 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
12841
12842 .vitem &$local_part_data$&
12843 .vindex "&$local_part_data$&"
12844 When the &%local_parts%& condition on a router or ACL
12845 matches a local part list
12846 .new
12847 the match value is copied to &$local_part_data$&.
12848 This is an enhancement over previous versions of Exim, when it only
12849 applied to the data read by a lookup.
12850 For details on match values see section &<<SECTlistresults>>& et. al.
12851 .wen
12852
12853 The &%check_local_user%& router option also sets this variable.
12854
12855 .vindex &$local_part_prefix$& &&&
12856         &$local_part_prefix_v$& &&&
12857         &$local_part_suffix$& &&&
12858         &$local_part_suffix_v$&
12859 .cindex affix variables
12860 If a local part prefix or suffix has been recognized, it is not included in the
12861 value of &$local_part$& during routing and subsequent delivery. The values of
12862 any prefix or suffix are in &$local_part_prefix$& and
12863 &$local_part_suffix$&, respectively.
12864 .cindex "tainted data"
12865 If the specification did not include a wildcard then
12866 the affix variable value is not tainted.
12867
12868 If the affix specification included a wildcard then the portion of
12869 the affix matched by the wildcard is in
12870 &$local_part_prefix_v$& or &$local_part_suffix_v$& as appropriate,
12871 and both the whole and varying values are tainted.
12872
12873 .vitem &$local_scan_data$&
12874 .vindex "&$local_scan_data$&"
12875 This variable contains the text returned by the &[local_scan()]& function when
12876 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
12877
12878 .vitem &$local_user_gid$&
12879 .vindex "&$local_user_gid$&"
12880 See &$local_user_uid$&.
12881
12882 .vitem &$local_user_uid$&
12883 .vindex "&$local_user_uid$&"
12884 This variable and &$local_user_gid$& are set to the uid and gid after the
12885 &%check_local_user%& router precondition succeeds. This means that their values
12886 are available for the remaining preconditions (&%senders%&, &%require_files%&,
12887 and &%condition%&), for the &%address_data%& expansion, and for any
12888 router-specific expansions. At all other times, the values in these variables
12889 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
12890
12891 .vitem &$localhost_number$&
12892 .vindex "&$localhost_number$&"
12893 This contains the expanded value of the
12894 &%localhost_number%& option. The expansion happens after the main options have
12895 been read.
12896
12897 .vitem &$log_inodes$&
12898 .vindex "&$log_inodes$&"
12899 The number of free inodes in the disk partition where Exim's
12900 log files are being written. The value is recalculated whenever the variable is
12901 referenced. If the relevant file system does not have the concept of inodes,
12902 the value of is -1. See also the &%check_log_inodes%& option.
12903
12904 .vitem &$log_space$&
12905 .vindex "&$log_space$&"
12906 The amount of free space (as a number of kilobytes) in the disk
12907 partition where Exim's log files are being written. The value is recalculated
12908 whenever the variable is referenced. If the operating system does not have the
12909 ability to find the amount of free space (only true for experimental systems),
12910 the space value is -1. See also the &%check_log_space%& option.
12911
12912
12913 .vitem &$lookup_dnssec_authenticated$&
12914 .vindex "&$lookup_dnssec_authenticated$&"
12915 This variable is set after a DNS lookup done by
12916 a dnsdb lookup expansion, dnslookup router or smtp transport.
12917 .cindex "DNS" "DNSSEC"
12918 It will be empty if &(DNSSEC)& was not requested,
12919 &"no"& if the result was not labelled as authenticated data
12920 and &"yes"& if it was.
12921 Results that are labelled as authoritative answer that match
12922 the &%dns_trust_aa%& configuration variable count also
12923 as authenticated data.
12924
12925 .vitem &$mailstore_basename$&
12926 .vindex "&$mailstore_basename$&"
12927 This variable is set only when doing deliveries in &"mailstore"& format in the
12928 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
12929 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
12930 contains the basename of the files that are being written, that is, the name
12931 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
12932 variable is empty.
12933
12934 .vitem &$malware_name$&
12935 .vindex "&$malware_name$&"
12936 This variable is available when Exim is compiled with the
12937 content-scanning extension. It is set to the name of the virus that was found
12938 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
12939
12940 .vitem &$max_received_linelength$&
12941 .vindex "&$max_received_linelength$&"
12942 .cindex "maximum" "line length"
12943 .cindex "line length" "maximum"
12944 This variable contains the number of bytes in the longest line that was
12945 received as part of the message, not counting the line termination
12946 character(s).
12947 It is not valid if the &%spool_files_wireformat%& option is used.
12948
12949 .vitem &$message_age$&
12950 .cindex "message" "age of"
12951 .vindex "&$message_age$&"
12952 This variable is set at the start of a delivery attempt to contain the number
12953 of seconds since the message was received. It does not change during a single
12954 delivery attempt.
12955
12956 .vitem &$message_body$&
12957 .cindex "body of message" "expansion variable"
12958 .cindex "message body" "in expansion"
12959 .cindex "binary zero" "in message body"
12960 .vindex "&$message_body$&"
12961 .oindex "&%message_body_visible%&"
12962 This variable contains the initial portion of a message's body while it is
12963 being delivered, and is intended mainly for use in filter files. The maximum
12964 number of characters of the body that are put into the variable is set by the
12965 &%message_body_visible%& configuration option; the default is 500.
12966
12967 .oindex "&%message_body_newlines%&"
12968 By default, newlines are converted into spaces in &$message_body$&, to make it
12969 easier to search for phrases that might be split over a line break. However,
12970 this can be disabled by setting &%message_body_newlines%& to be true. Binary
12971 zeros are always converted into spaces.
12972
12973 .vitem &$message_body_end$&
12974 .cindex "body of message" "expansion variable"
12975 .cindex "message body" "in expansion"
12976 .vindex "&$message_body_end$&"
12977 This variable contains the final portion of a message's
12978 body while it is being delivered. The format and maximum size are as for
12979 &$message_body$&.
12980
12981 .vitem &$message_body_size$&
12982 .cindex "body of message" "size"
12983 .cindex "message body" "size"
12984 .vindex "&$message_body_size$&"
12985 When a message is being delivered, this variable contains the size of the body
12986 in bytes. The count starts from the character after the blank line that
12987 separates the body from the header. Newlines are included in the count. See
12988 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
12989
12990 If the spool file is wireformat
12991 (see the &%spool_files_wireformat%& main option)
12992 the CRLF line-terminators are included in the count.
12993
12994 .vitem &$message_exim_id$&
12995 .vindex "&$message_exim_id$&"
12996 When a message is being received or delivered, this variable contains the
12997 unique message id that is generated and used by Exim to identify the message.
12998 An id is not created for a message until after its header has been successfully
12999 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
13000 line; it is the local id that Exim assigns to the message, for example:
13001 &`1BXTIK-0001yO-VA`&.
13002
13003 .vitem &$message_headers$&
13004 .vindex &$message_headers$&
13005 This variable contains a concatenation of all the header lines when a message
13006 is being processed, except for lines added by routers or transports. The header
13007 lines are separated by newline characters. Their contents are decoded in the
13008 same way as a header line that is inserted by &%bheader%&.
13009
13010 .vitem &$message_headers_raw$&
13011 .vindex &$message_headers_raw$&
13012 This variable is like &$message_headers$& except that no processing of the
13013 contents of header lines is done.
13014
13015 .vitem &$message_id$&
13016 This is an old name for &$message_exim_id$&. It is now deprecated.
13017
13018 .vitem &$message_linecount$&
13019 .vindex "&$message_linecount$&"
13020 This variable contains the total number of lines in the header and body of the
13021 message. Compare &$body_linecount$&, which is the count for the body only.
13022 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
13023 number of lines received. Before delivery happens (that is, before filters,
13024 routers, and transports run) the count is increased to include the
13025 &'Received:'& header line that Exim standardly adds, and also any other header
13026 lines that are added by ACLs. The blank line that separates the message header
13027 from the body is not counted.
13028
13029 As with the special case of &$message_size$&, during the expansion of the
13030 appendfile transport's maildir_tag option in maildir format, the value of
13031 &$message_linecount$& is the precise size of the number of newlines in the
13032 file that has been written (minus one for the blank line between the
13033 header and the body).
13034
13035 Here is an example of the use of this variable in a DATA ACL:
13036 .code
13037 deny condition = \
13038       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
13039      message   = Too many lines in message header
13040 .endd
13041 In the MAIL and RCPT ACLs, the value is zero because at that stage the
13042 message has not yet been received.
13043
13044 This variable is not valid if the &%spool_files_wireformat%& option is used.
13045
13046 .vitem &$message_size$&
13047 .cindex "size" "of message"
13048 .cindex "message" "size"
13049 .vindex "&$message_size$&"
13050 When a message is being processed, this variable contains its size in bytes. In
13051 most cases, the size includes those headers that were received with the
13052 message, but not those (such as &'Envelope-to:'&) that are added to individual
13053 deliveries as they are written. However, there is one special case: during the
13054 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
13055 doing a delivery in maildir format, the value of &$message_size$& is the
13056 precise size of the file that has been written. See also
13057 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
13058
13059 .cindex "RCPT" "value of &$message_size$&"
13060 While running a per message ACL (mail/rcpt/predata), &$message_size$&
13061 contains the size supplied on the MAIL command, or -1 if no size was given. The
13062 value may not, of course, be truthful.
13063
13064 .vitem &$mime_$&&'xxx'&
13065 A number of variables whose names start with &$mime$& are
13066 available when Exim is compiled with the content-scanning extension. For
13067 details, see section &<<SECTscanmimepart>>&.
13068
13069 .vitem "&$n0$& &-- &$n9$&"
13070 These variables are counters that can be incremented by means
13071 of the &%add%& command in filter files.
13072
13073 .vitem &$original_domain$&
13074 .vindex "&$domain$&"
13075 .vindex "&$original_domain$&"
13076 When a top-level address is being processed for delivery, this contains the
13077 same value as &$domain$&. However, if a &"child"& address (for example,
13078 generated by an alias, forward, or filter file) is being processed, this
13079 variable contains the domain of the original address (lower cased). This
13080 differs from &$parent_domain$& only when there is more than one level of
13081 aliasing or forwarding. When more than one address is being delivered in a
13082 single transport run, &$original_domain$& is not set.
13083
13084 If a new address is created by means of a &%deliver%& command in a system
13085 filter, it is set up with an artificial &"parent"& address. This has the local
13086 part &'system-filter'& and the default qualify domain.
13087
13088 .vitem &$original_local_part$&
13089 .vindex "&$local_part$&"
13090 .vindex "&$original_local_part$&"
13091 When a top-level address is being processed for delivery, this contains the
13092 same value as &$local_part$&, unless a prefix or suffix was removed from the
13093 local part, because &$original_local_part$& always contains the full local
13094 part. When a &"child"& address (for example, generated by an alias, forward, or
13095 filter file) is being processed, this variable contains the full local part of
13096 the original address.
13097
13098 If the router that did the redirection processed the local part
13099 case-insensitively, the value in &$original_local_part$& is in lower case.
13100 This variable differs from &$parent_local_part$& only when there is more than
13101 one level of aliasing or forwarding. When more than one address is being
13102 delivered in a single transport run, &$original_local_part$& is not set.
13103
13104 If a new address is created by means of a &%deliver%& command in a system
13105 filter, it is set up with an artificial &"parent"& address. This has the local
13106 part &'system-filter'& and the default qualify domain.
13107
13108 .vitem &$originator_gid$&
13109 .cindex "gid (group id)" "of originating user"
13110 .cindex "sender" "gid"
13111 .vindex "&$caller_gid$&"
13112 .vindex "&$originator_gid$&"
13113 This variable contains the value of &$caller_gid$& that was set when the
13114 message was received. For messages received via the command line, this is the
13115 gid of the sending user. For messages received by SMTP over TCP/IP, this is
13116 normally the gid of the Exim user.
13117
13118 .vitem &$originator_uid$&
13119 .cindex "uid (user id)" "of originating user"
13120 .cindex "sender" "uid"
13121 .vindex "&$caller_uid$&"
13122 .vindex "&$originator_uid$&"
13123 The value of &$caller_uid$& that was set when the message was received. For
13124 messages received via the command line, this is the uid of the sending user.
13125 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
13126 user.
13127
13128 .vitem &$parent_domain$&
13129 .vindex "&$parent_domain$&"
13130 This variable is similar to &$original_domain$& (see
13131 above), except that it refers to the immediately preceding parent address.
13132
13133 .vitem &$parent_local_part$&
13134 .vindex "&$parent_local_part$&"
13135 This variable is similar to &$original_local_part$&
13136 (see above), except that it refers to the immediately preceding parent address.
13137
13138 .vitem &$pid$&
13139 .cindex "pid (process id)" "of current process"
13140 .vindex "&$pid$&"
13141 This variable contains the current process id.
13142
13143 .vitem &$pipe_addresses$&
13144 .cindex "filter" "transport filter"
13145 .cindex "transport" "filter"
13146 .vindex "&$pipe_addresses$&"
13147 This is not an expansion variable, but is mentioned here because the string
13148 &`$pipe_addresses`& is handled specially in the command specification for the
13149 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
13150 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
13151 It cannot be used in general expansion strings, and provokes an &"unknown
13152 variable"& error if encountered.
13153
13154 .vitem &$primary_hostname$&
13155 .vindex "&$primary_hostname$&"
13156 This variable contains the value set by &%primary_hostname%& in the
13157 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
13158 a single-component name, Exim calls &[gethostbyname()]& (or
13159 &[getipnodebyname()]& where available) in an attempt to acquire a fully
13160 qualified host name. See also &$smtp_active_hostname$&.
13161
13162
13163 .vitem &$proxy_external_address$& &&&
13164        &$proxy_external_port$& &&&
13165        &$proxy_local_address$& &&&
13166        &$proxy_local_port$& &&&
13167        &$proxy_session$&
13168 These variables are only available when built with Proxy Protocol
13169 or SOCKS5 support.
13170 For details see chapter &<<SECTproxyInbound>>&.
13171
13172 .vitem &$prdr_requested$&
13173 .cindex "PRDR" "variable for"
13174 This variable is set to &"yes"& if PRDR was requested by the client for the
13175 current message, otherwise &"no"&.
13176
13177 .vitem &$prvscheck_address$&
13178 This variable is used in conjunction with the &%prvscheck%& expansion item,
13179 which is described in sections &<<SECTexpansionitems>>& and
13180 &<<SECTverifyPRVS>>&.
13181
13182 .vitem &$prvscheck_keynum$&
13183 This variable is used in conjunction with the &%prvscheck%& expansion item,
13184 which is described in sections &<<SECTexpansionitems>>& and
13185 &<<SECTverifyPRVS>>&.
13186
13187 .vitem &$prvscheck_result$&
13188 This variable is used in conjunction with the &%prvscheck%& expansion item,
13189 which is described in sections &<<SECTexpansionitems>>& and
13190 &<<SECTverifyPRVS>>&.
13191
13192 .vitem &$qualify_domain$&
13193 .vindex "&$qualify_domain$&"
13194 The value set for the &%qualify_domain%& option in the configuration file.
13195
13196 .vitem &$qualify_recipient$&
13197 .vindex "&$qualify_recipient$&"
13198 The value set for the &%qualify_recipient%& option in the configuration file,
13199 or if not set, the value of &$qualify_domain$&.
13200
13201 .vitem &$queue_name$&
13202 .vindex &$queue_name$&
13203 .cindex "named queues" variable
13204 .cindex queues named
13205 The name of the spool queue in use; empty for the default queue.
13206
13207 .vitem &$queue_size$&
13208 .vindex "&$queue_size$&"
13209 .cindex "queue" "size of"
13210 .cindex "spool" "number of messages"
13211 This variable contains the number of messages queued.
13212 It is evaluated on demand, but no more often than once every minute.
13213 If there is no daemon notifier socket open, the value will be
13214 an empty string.
13215
13216 .vitem &$r_...$&
13217 .vindex &$r_...$&
13218 .cindex router variables
13219 Values can be placed in these variables by the &%set%& option of a router.
13220 They can be given any name that starts with &$r_$&.
13221 The values persist for the address being handled through subsequent routers
13222 and the eventual transport.
13223
13224 .vitem &$rcpt_count$&
13225 .vindex "&$rcpt_count$&"
13226 When a message is being received by SMTP, this variable contains the number of
13227 RCPT commands received for the current message. If this variable is used in a
13228 RCPT ACL, its value includes the current command.
13229
13230 .vitem &$rcpt_defer_count$&
13231 .vindex "&$rcpt_defer_count$&"
13232 .cindex "4&'xx'& responses" "count of"
13233 When a message is being received by SMTP, this variable contains the number of
13234 RCPT commands in the current message that have previously been rejected with a
13235 temporary (4&'xx'&) response.
13236
13237 .vitem &$rcpt_fail_count$&
13238 .vindex "&$rcpt_fail_count$&"
13239 When a message is being received by SMTP, this variable contains the number of
13240 RCPT commands in the current message that have previously been rejected with a
13241 permanent (5&'xx'&) response.
13242
13243 .vitem &$received_count$&
13244 .vindex "&$received_count$&"
13245 This variable contains the number of &'Received:'& header lines in the message,
13246 including the one added by Exim (so its value is always greater than zero). It
13247 is available in the DATA ACL, the non-SMTP ACL, and while routing and
13248 delivering.
13249
13250 .vitem &$received_for$&
13251 .vindex "&$received_for$&"
13252 If there is only a single recipient address in an incoming message, this
13253 variable contains that address when the &'Received:'& header line is being
13254 built. The value is copied after recipient rewriting has happened, but before
13255 the &[local_scan()]& function is run.
13256
13257 .vitem &$received_ip_address$&
13258 .vindex "&$received_ip_address$&"
13259 As soon as an Exim server starts processing an incoming TCP/IP connection, this
13260 variable is set to the address of the local IP interface, and &$received_port$&
13261 is set to the local port number. (The remote IP address and port are in
13262 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
13263 the port value is -1 unless it has been set using the &%-oMi%& command line
13264 option.
13265
13266 As well as being useful in ACLs (including the &"connect"& ACL), these variable
13267 could be used, for example, to make the filename for a TLS certificate depend
13268 on which interface and/or port is being used for the incoming connection. The
13269 values of &$received_ip_address$& and &$received_port$& are saved with any
13270 messages that are received, thus making these variables available at delivery
13271 time.
13272 For outbound connections see &$sending_ip_address$&.
13273
13274 .vitem &$received_port$&
13275 .vindex "&$received_port$&"
13276 See &$received_ip_address$&.
13277
13278 .vitem &$received_protocol$&
13279 .vindex "&$received_protocol$&"
13280 When a message is being processed, this variable contains the name of the
13281 protocol by which it was received. Most of the names used by Exim are defined
13282 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
13283 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
13284 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
13285 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
13286 connection and the client was successfully authenticated.
13287
13288 Exim uses the protocol name &"smtps"& for the case when encryption is
13289 automatically set up on connection without the use of STARTTLS (see
13290 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
13291 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
13292 where the client initially uses EHLO, sets up an encrypted connection using
13293 STARTTLS, and then uses HELO afterwards.
13294
13295 The &%-oMr%& option provides a way of specifying a custom protocol name for
13296 messages that are injected locally by trusted callers. This is commonly used to
13297 identify messages that are being re-injected after some kind of scanning.
13298
13299 .vitem &$received_time$&
13300 .vindex "&$received_time$&"
13301 This variable contains the date and time when the current message was received,
13302 as a number of seconds since the start of the Unix epoch.
13303
13304 .vitem &$recipient_data$&
13305 .vindex "&$recipient_data$&"
13306 This variable is set after an indexing lookup success in an ACL &%recipients%&
13307 condition. It contains the data from the lookup, and the value remains set
13308 until the next &%recipients%& test. Thus, you can do things like this:
13309 .display
13310 &`require recipients  = cdb*@;/some/file`&
13311 &`deny    `&&'some further test involving'& &`$recipient_data`&
13312 .endd
13313 &*Warning*&: This variable is set only when a lookup is used as an indexing
13314 method in the address list, using the semicolon syntax as in the example above.
13315 The variable is not set for a lookup that is used as part of the string
13316 expansion that all such lists undergo before being interpreted.
13317
13318 .vitem &$recipient_verify_failure$&
13319 .vindex "&$recipient_verify_failure$&"
13320 In an ACL, when a recipient verification fails, this variable contains
13321 information about the failure. It is set to one of the following words:
13322
13323 .ilist
13324 &"qualify"&: The address was unqualified (no domain), and the message
13325 was neither local nor came from an exempted host.
13326
13327 .next
13328 &"route"&: Routing failed.
13329
13330 .next
13331 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
13332 or before the MAIL command (that is, on initial connection, HELO, or
13333 MAIL).
13334
13335 .next
13336 &"recipient"&: The RCPT command in a callout was rejected.
13337 .next
13338
13339 &"postmaster"&: The postmaster check in a callout was rejected.
13340 .endlist
13341
13342 The main use of this variable is expected to be to distinguish between
13343 rejections of MAIL and rejections of RCPT.
13344
13345 .vitem &$recipients$&
13346 .vindex "&$recipients$&"
13347 This variable contains a list of envelope recipients for a message. A comma and
13348 a space separate the addresses in the replacement text. However, the variable
13349 is not generally available, to prevent exposure of Bcc recipients in
13350 unprivileged users' filter files. You can use &$recipients$& only in these
13351 cases:
13352
13353 .olist
13354 In a system filter file.
13355 .next
13356 In the ACLs associated with the DATA command and with non-SMTP messages, that
13357 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
13358 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
13359 &%acl_not_smtp_mime%&.
13360 .next
13361 From within a &[local_scan()]& function.
13362 .endlist
13363
13364
13365 .vitem &$recipients_count$&
13366 .vindex "&$recipients_count$&"
13367 When a message is being processed, this variable contains the number of
13368 envelope recipients that came with the message. Duplicates are not excluded
13369 from the count. While a message is being received over SMTP, the number
13370 increases for each accepted recipient. It can be referenced in an ACL.
13371
13372
13373 .vitem &$regex_match_string$&
13374 .vindex "&$regex_match_string$&"
13375 This variable is set to contain the matching regular expression after a
13376 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
13377
13378 .vitem "&$regex1$&, &$regex2$&, etc"
13379 .cindex "regex submatch variables (&$1regex$& &$2regex$& etc)"
13380 When a &%regex%& or &%mime_regex%& ACL condition succeeds,
13381 these variables contain the
13382 captured substrings identified by the regular expression.
13383
13384
13385 .vitem &$reply_address$&
13386 .vindex "&$reply_address$&"
13387 When a message is being processed, this variable contains the contents of the
13388 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
13389 contents of the &'From:'& header line. Apart from the removal of leading
13390 white space, the value is not processed in any way. In particular, no RFC 2047
13391 decoding or character code translation takes place.
13392
13393 .vitem &$return_path$&
13394 .vindex "&$return_path$&"
13395 When a message is being delivered, this variable contains the return path &--
13396 the sender field that will be sent as part of the envelope. It is not enclosed
13397 in <> characters. At the start of routing an address, &$return_path$& has the
13398 same value as &$sender_address$&, but if, for example, an incoming message to a
13399 mailing list has been expanded by a router which specifies a different address
13400 for bounce messages, &$return_path$& subsequently contains the new bounce
13401 address, whereas &$sender_address$& always contains the original sender address
13402 that was received with the message. In other words, &$sender_address$& contains
13403 the incoming envelope sender, and &$return_path$& contains the outgoing
13404 envelope sender.
13405
13406 .vitem &$return_size_limit$&
13407 .vindex "&$return_size_limit$&"
13408 This is an obsolete name for &$bounce_return_size_limit$&.
13409
13410 .vitem &$router_name$&
13411 .cindex "router" "name"
13412 .cindex "name" "of router"
13413 .vindex "&$router_name$&"
13414 During the running of a router this variable contains its name.
13415
13416 .vitem &$runrc$&
13417 .cindex "return code" "from &%run%& expansion"
13418 .vindex "&$runrc$&"
13419 This variable contains the return code from a command that is run by the
13420 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
13421 assume the order in which option values are expanded, except for those
13422 preconditions whose order of testing is documented. Therefore, you cannot
13423 reliably expect to set &$runrc$& by the expansion of one option, and use it in
13424 another.
13425
13426 .vitem &$self_hostname$&
13427 .oindex "&%self%&" "value of host name"
13428 .vindex "&$self_hostname$&"
13429 When an address is routed to a supposedly remote host that turns out to be the
13430 local host, what happens is controlled by the &%self%& generic router option.
13431 One of its values causes the address to be passed to another router. When this
13432 happens, &$self_hostname$& is set to the name of the local host that the
13433 original router encountered. In other circumstances its contents are null.
13434
13435 .vitem &$sender_address$&
13436 .vindex "&$sender_address$&"
13437 When a message is being processed, this variable contains the sender's address
13438 that was received in the message's envelope. The case of letters in the address
13439 is retained, in both the local part and the domain. For bounce messages, the
13440 value of this variable is the empty string. See also &$return_path$&.
13441
13442 .vitem &$sender_address_data$&
13443 .vindex "&$address_data$&"
13444 .vindex "&$sender_address_data$&"
13445 If &$address_data$& is set when the routers are called from an ACL to verify a
13446 sender address, the final value is preserved in &$sender_address_data$&, to
13447 distinguish it from data from a recipient address. The value does not persist
13448 after the end of the current ACL statement. If you want to preserve it for
13449 longer, you can save it in an ACL variable.
13450
13451 .vitem &$sender_address_domain$&
13452 .vindex "&$sender_address_domain$&"
13453 The domain portion of &$sender_address$&.
13454
13455 .vitem &$sender_address_local_part$&
13456 .vindex "&$sender_address_local_part$&"
13457 The local part portion of &$sender_address$&.
13458
13459 .vitem &$sender_data$&
13460 .vindex "&$sender_data$&"
13461 This variable is set after a lookup success in an ACL &%senders%& condition or
13462 in a router &%senders%& option. It contains the data from the lookup, and the
13463 value remains set until the next &%senders%& test. Thus, you can do things like
13464 this:
13465 .display
13466 &`require senders      = cdb*@;/some/file`&
13467 &`deny    `&&'some further test involving'& &`$sender_data`&
13468 .endd
13469 &*Warning*&: This variable is set only when a lookup is used as an indexing
13470 method in the address list, using the semicolon syntax as in the example above.
13471 The variable is not set for a lookup that is used as part of the string
13472 expansion that all such lists undergo before being interpreted.
13473
13474 .vitem &$sender_fullhost$&
13475 .vindex "&$sender_fullhost$&"
13476 When a message is received from a remote host, this variable contains the host
13477 name and IP address in a single string. It ends with the IP address in square
13478 brackets, followed by a colon and a port number if the logging of ports is
13479 enabled. The format of the rest of the string depends on whether the host
13480 issued a HELO or EHLO SMTP command, and whether the host name was verified by
13481 looking up its IP address. (Looking up the IP address can be forced by the
13482 &%host_lookup%& option, independent of verification.) A plain host name at the
13483 start of the string is a verified host name; if this is not present,
13484 verification either failed or was not requested. A host name in parentheses is
13485 the argument of a HELO or EHLO command. This is omitted if it is identical to
13486 the verified host name or to the host's IP address in square brackets.
13487
13488 .vitem &$sender_helo_dnssec$&
13489 .vindex "&$sender_helo_dnssec$&"
13490 This boolean variable is true if a successful HELO verification was
13491 .cindex "DNS" "DNSSEC"
13492 done using DNS information the resolver library stated was authenticated data.
13493
13494 .vitem &$sender_helo_name$&
13495 .vindex "&$sender_helo_name$&"
13496 When a message is received from a remote host that has issued a HELO or EHLO
13497 command, the argument of that command is placed in this variable. It is also
13498 set if HELO or EHLO is used when a message is received using SMTP locally via
13499 the &%-bs%& or &%-bS%& options.
13500
13501 .vitem &$sender_host_address$&
13502 .vindex "&$sender_host_address$&"
13503 When a message is received from a remote host using SMTP,
13504 this variable contains that
13505 host's IP address. For locally non-SMTP submitted messages, it is empty.
13506
13507 .vitem &$sender_host_authenticated$&
13508 .vindex "&$sender_host_authenticated$&"
13509 This variable contains the name (not the public name) of the authenticator
13510 driver that successfully authenticated the client from which the message was
13511 received. It is empty if there was no successful authentication. See also
13512 &$authenticated_id$&.
13513
13514 .vitem &$sender_host_dnssec$&
13515 .vindex "&$sender_host_dnssec$&"
13516 If an attempt to populate &$sender_host_name$& has been made
13517 (by reference, &%hosts_lookup%& or
13518 otherwise) then this boolean will have been set true if, and only if, the
13519 resolver library states that both
13520 the reverse and forward DNS were authenticated data.  At all
13521 other times, this variable is false.
13522
13523 .cindex "DNS" "DNSSEC"
13524 It is likely that you will need to coerce DNSSEC support on in the resolver
13525 library, by setting:
13526 .code
13527 dns_dnssec_ok = 1
13528 .endd
13529
13530 In addition, on Linux with glibc 2.31 or newer the resolver library will
13531 default to stripping out a successful validation status.
13532 This will break a previously working Exim installation.
13533 Provided that you do trust the resolver (ie, is on localhost) you can tell
13534 glibc to pass through any successful validation with a new option in
13535 &_/etc/resolv.conf_&:
13536 .code
13537 options trust-ad
13538 .endd
13539
13540 Exim does not perform DNSSEC validation itself, instead leaving that to a
13541 validating resolver (e.g. unbound, or bind with suitable configuration).
13542
13543 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
13544 mechanism in the list, then this variable will be false.
13545
13546 This requires that your system resolver library support EDNS0 (and that
13547 DNSSEC flags exist in the system headers).  If the resolver silently drops
13548 all EDNS0 options, then this will have no effect.  OpenBSD's asr resolver
13549 is known to currently ignore EDNS0, documented in CAVEATS of asr_run(3).
13550
13551
13552 .vitem &$sender_host_name$&
13553 .vindex "&$sender_host_name$&"
13554 When a message is received from a remote host, this variable contains the
13555 host's name as obtained by looking up its IP address. For messages received by
13556 other means, this variable is empty.
13557
13558 .vindex "&$host_lookup_failed$&"
13559 If the host name has not previously been looked up, a reference to
13560 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
13561 A looked up name is accepted only if it leads back to the original IP address
13562 via a forward lookup. If either the reverse or the forward lookup fails to find
13563 any data, or if the forward lookup does not yield the original IP address,
13564 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
13565
13566 .vindex "&$host_lookup_deferred$&"
13567 However, if either of the lookups cannot be completed (for example, there is a
13568 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
13569 &$host_lookup_failed$& remains set to &"0"&.
13570
13571 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
13572 host name again if there is a subsequent reference to &$sender_host_name$&
13573 in the same Exim process, but it does try again if &$host_lookup_deferred$&
13574 is set to &"1"&.
13575
13576 Exim does not automatically look up every calling host's name. If you want
13577 maximum efficiency, you should arrange your configuration so that it avoids
13578 these lookups altogether. The lookup happens only if one or more of the
13579 following are true:
13580
13581 .ilist
13582 A string containing &$sender_host_name$& is expanded.
13583 .next
13584 The calling host matches the list in &%host_lookup%&. In the default
13585 configuration, this option is set to *, so it must be changed if lookups are
13586 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
13587 .next
13588 Exim needs the host name in order to test an item in a host list. The items
13589 that require this are described in sections &<<SECThoslispatnam>>& and
13590 &<<SECThoslispatnamsk>>&.
13591 .next
13592 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
13593 In this case, the host name is required to compare with the name quoted in any
13594 EHLO or HELO commands that the client issues.
13595 .next
13596 The remote host issues a EHLO or HELO command that quotes one of the
13597 domains in &%helo_lookup_domains%&. The default value of this option is
13598 . ==== As this is a nested list, any displays it contains must be indented
13599 . ==== as otherwise they are too far to the left.
13600 .code
13601   helo_lookup_domains = @ : @[]
13602 .endd
13603 which causes a lookup if a remote host (incorrectly) gives the server's name or
13604 IP address in an EHLO or HELO command.
13605 .endlist
13606
13607
13608 .vitem &$sender_host_port$&
13609 .vindex "&$sender_host_port$&"
13610 When a message is received from a remote host, this variable contains the port
13611 number that was used on the remote host.
13612
13613 .vitem &$sender_ident$&
13614 .vindex "&$sender_ident$&"
13615 When a message is received from a remote host, this variable contains the
13616 identification received in response to an RFC 1413 request. When a message has
13617 been received locally, this variable contains the login name of the user that
13618 called Exim.
13619
13620 .vitem &$sender_rate_$&&'xxx'&
13621 A number of variables whose names begin &$sender_rate_$& are set as part of the
13622 &%ratelimit%& ACL condition. Details are given in section
13623 &<<SECTratelimiting>>&.
13624
13625 .vitem &$sender_rcvhost$&
13626 .cindex "DNS" "reverse lookup"
13627 .cindex "reverse DNS lookup"
13628 .vindex "&$sender_rcvhost$&"
13629 This is provided specifically for use in &'Received:'& headers. It starts with
13630 either the verified host name (as obtained from a reverse DNS lookup) or, if
13631 there is no verified host name, the IP address in square brackets. After that
13632 there may be text in parentheses. When the first item is a verified host name,
13633 the first thing in the parentheses is the IP address in square brackets,
13634 followed by a colon and a port number if port logging is enabled. When the
13635 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
13636 the parentheses.
13637
13638 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
13639 was used and its argument was not identical to the real host name or IP
13640 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
13641 all three items are present in the parentheses, a newline and tab are inserted
13642 into the string, to improve the formatting of the &'Received:'& header.
13643
13644 .vitem &$sender_verify_failure$&
13645 .vindex "&$sender_verify_failure$&"
13646 In an ACL, when a sender verification fails, this variable contains information
13647 about the failure. The details are the same as for
13648 &$recipient_verify_failure$&.
13649
13650 .vitem &$sending_ip_address$&
13651 .vindex "&$sending_ip_address$&"
13652 This variable is set whenever an outgoing SMTP connection to another host has
13653 been set up. It contains the IP address of the local interface that is being
13654 used. This is useful if a host that has more than one IP address wants to take
13655 on different personalities depending on which one is being used. For incoming
13656 connections, see &$received_ip_address$&.
13657
13658 .vitem &$sending_port$&
13659 .vindex "&$sending_port$&"
13660 This variable is set whenever an outgoing SMTP connection to another host has
13661 been set up. It contains the local port that is being used. For incoming
13662 connections, see &$received_port$&.
13663
13664 .vitem &$smtp_active_hostname$&
13665 .vindex "&$smtp_active_hostname$&"
13666 During an incoming SMTP session, this variable contains the value of the active
13667 host name, as specified by the &%smtp_active_hostname%& option. The value of
13668 &$smtp_active_hostname$& is saved with any message that is received, so its
13669 value can be consulted during routing and delivery.
13670
13671 .vitem &$smtp_command$&
13672 .vindex "&$smtp_command$&"
13673 During the processing of an incoming SMTP command, this variable contains the
13674 entire command. This makes it possible to distinguish between HELO and EHLO in
13675 the HELO ACL, and also to distinguish between commands such as these:
13676 .code
13677 MAIL FROM:<>
13678 MAIL FROM: <>
13679 .endd
13680 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
13681 command, the address in &$smtp_command$& is the original address before any
13682 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
13683 the address after SMTP-time rewriting.
13684
13685 .vitem &$smtp_command_argument$&
13686 .cindex "SMTP" "command, argument for"
13687 .vindex "&$smtp_command_argument$&"
13688 While an ACL is running to check an SMTP command, this variable contains the
13689 argument, that is, the text that follows the command name, with leading white
13690 space removed. Following the introduction of &$smtp_command$&, this variable is
13691 somewhat redundant, but is retained for backwards compatibility.
13692
13693 .vitem &$smtp_command_history$&
13694 .cindex SMTP "command history"
13695 .vindex "&$smtp_command_history$&"
13696 A comma-separated list (with no whitespace) of the most-recent SMTP commands
13697 received, in time-order left to right.  Only a limited number of commands
13698 are remembered.
13699
13700 .vitem &$smtp_count_at_connection_start$&
13701 .vindex "&$smtp_count_at_connection_start$&"
13702 This variable is set greater than zero only in processes spawned by the Exim
13703 daemon for handling incoming SMTP connections. The name is deliberately long,
13704 in order to emphasize what the contents are. When the daemon accepts a new
13705 connection, it increments this variable. A copy of the variable is passed to
13706 the child process that handles the connection, but its value is fixed, and
13707 never changes. It is only an approximation of how many incoming connections
13708 there actually are, because many other connections may come and go while a
13709 single connection is being processed. When a child process terminates, the
13710 daemon decrements its copy of the variable.
13711
13712 .vitem "&$sn0$& &-- &$sn9$&"
13713 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
13714 that were current at the end of the system filter file. This allows a system
13715 filter file to set values that can be tested in users' filter files. For
13716 example, a system filter could set a value indicating how likely it is that a
13717 message is junk mail.
13718
13719 .vitem &$spam_score$& &&&
13720        &$spam_score_int$& &&&
13721        &$spam_bar$& &&&
13722        &$spam_report$& &&&
13723        &$spam_action$&
13724 A number of variables whose names start with &$spam$& are available when Exim
13725 is compiled with the content-scanning extension. For details, see section
13726 &<<SECTscanspamass>>&.
13727
13728 .vitem &$spf_header_comment$& &&&
13729        &$spf_received$& &&&
13730        &$spf_result$& &&&
13731        &$spf_result_guessed$& &&&
13732        &$spf_smtp_comment$&
13733 These variables are only available if Exim is built with SPF support.
13734 For details see section &<<SECSPF>>&.
13735
13736 .vitem &$spool_directory$&
13737 .vindex "&$spool_directory$&"
13738 The name of Exim's spool directory.
13739
13740 .vitem &$spool_inodes$&
13741 .vindex "&$spool_inodes$&"
13742 The number of free inodes in the disk partition where Exim's spool files are
13743 being written. The value is recalculated whenever the variable is referenced.
13744 If the relevant file system does not have the concept of inodes, the value of
13745 is -1. See also the &%check_spool_inodes%& option.
13746
13747 .vitem &$spool_space$&
13748 .vindex "&$spool_space$&"
13749 The amount of free space (as a number of kilobytes) in the disk partition where
13750 Exim's spool files are being written. The value is recalculated whenever the
13751 variable is referenced. If the operating system does not have the ability to
13752 find the amount of free space (only true for experimental systems), the space
13753 value is -1. For example, to check in an ACL that there is at least 50
13754 megabytes free on the spool, you could write:
13755 .code
13756 condition = ${if > {$spool_space}{50000}}
13757 .endd
13758 See also the &%check_spool_space%& option.
13759
13760
13761 .vitem &$thisaddress$&
13762 .vindex "&$thisaddress$&"
13763 This variable is set only during the processing of the &%foranyaddress%&
13764 command in a filter file. Its use is explained in the description of that
13765 command, which can be found in the separate document entitled &'Exim's
13766 interfaces to mail filtering'&.
13767
13768 .vitem &$tls_in_bits$&
13769 .vindex "&$tls_in_bits$&"
13770 Contains an approximation of the TLS cipher's bit-strength
13771 on the inbound connection; the meaning of
13772 this depends upon the TLS implementation used.
13773 If TLS has not been negotiated, the value will be 0.
13774 The value of this is automatically fed into the Cyrus SASL authenticator
13775 when acting as a server, to specify the "external SSF" (a SASL term).
13776
13777 The deprecated &$tls_bits$& variable refers to the inbound side
13778 except when used in the context of an outbound SMTP delivery, when it refers to
13779 the outbound.
13780
13781 .vitem &$tls_out_bits$&
13782 .vindex "&$tls_out_bits$&"
13783 Contains an approximation of the TLS cipher's bit-strength
13784 on an outbound SMTP connection; the meaning of
13785 this depends upon the TLS implementation used.
13786 If TLS has not been negotiated, the value will be 0.
13787
13788 .vitem &$tls_in_ourcert$&
13789 .vindex "&$tls_in_ourcert$&"
13790 .cindex certificate variables
13791 This variable refers to the certificate presented to the peer of an
13792 inbound connection when the message was received.
13793 It is only useful as the argument of a
13794 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13795 or a &%def%& condition.
13796
13797 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
13798 when a list of more than one
13799 file is used for &%tls_certificate%&, this variable is not reliable.
13800 The macro "_TLS_BAD_MULTICERT_IN_OURCERT" will be defined for those versions.
13801
13802 .vitem &$tls_in_peercert$&
13803 .vindex "&$tls_in_peercert$&"
13804 This variable refers to the certificate presented by the peer of an
13805 inbound connection when the message was received.
13806 It is only useful as the argument of a
13807 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13808 or a &%def%& condition.
13809 If certificate verification fails it may refer to a failing chain element
13810 which is not the leaf.
13811
13812 .vitem &$tls_out_ourcert$&
13813 .vindex "&$tls_out_ourcert$&"
13814 This variable refers to the certificate presented to the peer of an
13815 outbound connection.  It is only useful as the argument of a
13816 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13817 or a &%def%& condition.
13818
13819 .vitem &$tls_out_peercert$&
13820 .vindex "&$tls_out_peercert$&"
13821 This variable refers to the certificate presented by the peer of an
13822 outbound connection.  It is only useful as the argument of a
13823 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13824 or a &%def%& condition.
13825 If certificate verification fails it may refer to a failing chain element
13826 which is not the leaf.
13827
13828 .vitem &$tls_in_certificate_verified$&
13829 .vindex "&$tls_in_certificate_verified$&"
13830 This variable is set to &"1"& if a TLS certificate was verified when the
13831 message was received, and &"0"& otherwise.
13832
13833 The deprecated &$tls_certificate_verified$& variable refers to the inbound side
13834 except when used in the context of an outbound SMTP delivery, when it refers to
13835 the outbound.
13836
13837 .vitem &$tls_out_certificate_verified$&
13838 .vindex "&$tls_out_certificate_verified$&"
13839 This variable is set to &"1"& if a TLS certificate was verified when an
13840 outbound SMTP connection was made,
13841 and &"0"& otherwise.
13842
13843 .vitem &$tls_in_cipher$&
13844 .vindex "&$tls_in_cipher$&"
13845 .vindex "&$tls_cipher$&"
13846 When a message is received from a remote host over an encrypted SMTP
13847 connection, this variable is set to the cipher suite that was negotiated, for
13848 example DES-CBC3-SHA. In other circumstances, in particular, for message
13849 received over unencrypted connections, the variable is empty. Testing
13850 &$tls_in_cipher$& for emptiness is one way of distinguishing between encrypted and
13851 non-encrypted connections during ACL processing.
13852
13853 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
13854 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
13855 becomes the same as &$tls_out_cipher$&.
13856
13857 .vitem &$tls_in_cipher_std$&
13858 .vindex "&$tls_in_cipher_std$&"
13859 As above, but returning the RFC standard name for the cipher suite.
13860
13861 .vitem &$tls_out_cipher$&
13862 .vindex "&$tls_out_cipher$&"
13863 This variable is
13864 cleared before any outgoing SMTP connection is made,
13865 and then set to the outgoing cipher suite if one is negotiated. See chapter
13866 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
13867 details of the &(smtp)& transport.
13868
13869 .vitem &$tls_out_cipher_std$&
13870 .vindex "&$tls_out_cipher_std$&"
13871 As above, but returning the RFC standard name for the cipher suite.
13872
13873 .vitem &$tls_out_dane$&
13874 .vindex &$tls_out_dane$&
13875 DANE active status.  See section &<<SECDANE>>&.
13876
13877 .vitem &$tls_in_ocsp$&
13878 .vindex "&$tls_in_ocsp$&"
13879 When a message is received from a remote client connection
13880 the result of any OCSP request from the client is encoded in this variable:
13881 .code
13882 0 OCSP proof was not requested (default value)
13883 1 No response to request
13884 2 Response not verified
13885 3 Verification failed
13886 4 Verification succeeded
13887 .endd
13888
13889 .vitem &$tls_out_ocsp$&
13890 .vindex "&$tls_out_ocsp$&"
13891 When a message is sent to a remote host connection
13892 the result of any OCSP request made is encoded in this variable.
13893 See &$tls_in_ocsp$& for values.
13894
13895 .vitem &$tls_in_peerdn$&
13896 .vindex "&$tls_in_peerdn$&"
13897 .vindex "&$tls_peerdn$&"
13898 .cindex certificate "extracting fields"
13899 When a message is received from a remote host over an encrypted SMTP
13900 connection, and Exim is configured to request a certificate from the client,
13901 the value of the Distinguished Name of the certificate is made available in the
13902 &$tls_in_peerdn$& during subsequent processing.
13903 If certificate verification fails it may refer to a failing chain element
13904 which is not the leaf.
13905
13906 The deprecated &$tls_peerdn$& variable refers to the inbound side
13907 except when used in the context of an outbound SMTP delivery, when it refers to
13908 the outbound.
13909
13910 .vitem &$tls_out_peerdn$&
13911 .vindex "&$tls_out_peerdn$&"
13912 When a message is being delivered to a remote host over an encrypted SMTP
13913 connection, and Exim is configured to request a certificate from the server,
13914 the value of the Distinguished Name of the certificate is made available in the
13915 &$tls_out_peerdn$& during subsequent processing.
13916 If certificate verification fails it may refer to a failing chain element
13917 which is not the leaf.
13918
13919
13920 .new
13921 .vitem &$tls_in_resumption$& &&&
13922        &$tls_out_resumption$&
13923 .vindex &$tls_in_resumption$&
13924 .vindex &$tls_out_resumption$&
13925 .cindex TLS resumption
13926 Observability for TLS session resumption.  See &<<SECTresumption>>& for details.
13927 .wen
13928
13929
13930 .vitem &$tls_in_sni$&
13931 .vindex "&$tls_in_sni$&"
13932 .vindex "&$tls_sni$&"
13933 .cindex "TLS" "Server Name Indication"
13934 .cindex "TLS" SNI
13935 .cindex SNI "observability on server"
13936 When a TLS session is being established, if the client sends the Server
13937 Name Indication extension, the value will be placed in this variable.
13938 If the variable appears in &%tls_certificate%& then this option and
13939 some others, described in &<<SECTtlssni>>&,
13940 will be re-expanded early in the TLS session, to permit
13941 a different certificate to be presented (and optionally a different key to be
13942 used) to the client, based upon the value of the SNI extension.
13943
13944 The deprecated &$tls_sni$& variable refers to the inbound side
13945 except when used in the context of an outbound SMTP delivery, when it refers to
13946 the outbound.
13947
13948 .vitem &$tls_out_sni$&
13949 .vindex "&$tls_out_sni$&"
13950 .cindex "TLS" "Server Name Indication"
13951 .cindex "TLS" SNI
13952 .cindex SNI "observability in client"
13953 During outbound
13954 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
13955 the transport.
13956
13957 .vitem &$tls_out_tlsa_usage$&
13958 .vindex &$tls_out_tlsa_usage$&
13959 Bitfield of TLSA record types found.  See section &<<SECDANE>>&.
13960
13961 .vitem &$tls_in_ver$&
13962 .vindex "&$tls_in_ver$&"
13963 When a message is received from a remote host over an encrypted SMTP connection
13964 this variable is set to the protocol version, eg &'TLS1.2'&.
13965
13966 .vitem &$tls_out_ver$&
13967 .vindex "&$tls_out_ver$&"
13968 When a message is being delivered to a remote host over an encrypted SMTP connection
13969 this variable is set to the protocol version.
13970
13971
13972 .vitem &$tod_bsdinbox$&
13973 .vindex "&$tod_bsdinbox$&"
13974 The time of day and the date, in the format required for BSD-style mailbox
13975 files, for example: Thu Oct 17 17:14:09 1995.
13976
13977 .vitem &$tod_epoch$&
13978 .vindex "&$tod_epoch$&"
13979 The time and date as a number of seconds since the start of the Unix epoch.
13980
13981 .vitem &$tod_epoch_l$&
13982 .vindex "&$tod_epoch_l$&"
13983 The time and date as a number of microseconds since the start of the Unix epoch.
13984
13985 .vitem &$tod_full$&
13986 .vindex "&$tod_full$&"
13987 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
13988 +0100. The timezone is always given as a numerical offset from UTC, with
13989 positive values used for timezones that are ahead (east) of UTC, and negative
13990 values for those that are behind (west).
13991
13992 .vitem &$tod_log$&
13993 .vindex "&$tod_log$&"
13994 The time and date in the format used for writing Exim's log files, for example:
13995 1995-10-12 15:32:29, but without a timezone.
13996
13997 .vitem &$tod_logfile$&
13998 .vindex "&$tod_logfile$&"
13999 This variable contains the date in the format yyyymmdd. This is the format that
14000 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
14001 flag.
14002
14003 .vitem &$tod_zone$&
14004 .vindex "&$tod_zone$&"
14005 This variable contains the numerical value of the local timezone, for example:
14006 -0500.
14007
14008 .vitem &$tod_zulu$&
14009 .vindex "&$tod_zulu$&"
14010 This variable contains the UTC date and time in &"Zulu"& format, as specified
14011 by ISO 8601, for example: 20030221154023Z.
14012
14013 .vitem &$transport_name$&
14014 .cindex "transport" "name"
14015 .cindex "name" "of transport"
14016 .vindex "&$transport_name$&"
14017 During the running of a transport, this variable contains its name.
14018
14019 .vitem &$value$&
14020 .vindex "&$value$&"
14021 This variable contains the result of an expansion lookup, extraction operation,
14022 or external command, as described above. It is also used during a
14023 &*reduce*& expansion.
14024
14025 .vitem &$verify_mode$&
14026 .vindex "&$verify_mode$&"
14027 While a router or transport is being run in verify mode or for cutthrough delivery,
14028 contains "S" for sender-verification or "R" for recipient-verification.
14029 Otherwise, empty.
14030
14031 .vitem &$version_number$&
14032 .vindex "&$version_number$&"
14033 The version number of Exim. Same as &$exim_version$&, may be overridden
14034 by the &%exim_version%& main config option.
14035
14036 .vitem &$warn_message_delay$&
14037 .vindex "&$warn_message_delay$&"
14038 This variable is set only during the creation of a message warning about a
14039 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
14040
14041 .vitem &$warn_message_recipients$&
14042 .vindex "&$warn_message_recipients$&"
14043 This variable is set only during the creation of a message warning about a
14044 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
14045 .endlist
14046 .ecindex IIDstrexp
14047
14048
14049
14050 . ////////////////////////////////////////////////////////////////////////////
14051 . ////////////////////////////////////////////////////////////////////////////
14052
14053 .chapter "Embedded Perl" "CHAPperl"
14054 .scindex IIDperl "Perl" "calling from Exim"
14055 Exim can be built to include an embedded Perl interpreter. When this is done,
14056 Perl subroutines can be called as part of the string expansion process. To make
14057 use of the Perl support, you need version 5.004 or later of Perl installed on
14058 your system. To include the embedded interpreter in the Exim binary, include
14059 the line
14060 .code
14061 EXIM_PERL = perl.o
14062 .endd
14063 in your &_Local/Makefile_& and then build Exim in the normal way.
14064
14065
14066 .section "Setting up so Perl can be used" "SECID85"
14067 .oindex "&%perl_startup%&"
14068 Access to Perl subroutines is via a global configuration option called
14069 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
14070 no &%perl_startup%& option in the Exim configuration file then no Perl
14071 interpreter is started and there is almost no overhead for Exim (since none of
14072 the Perl library will be paged in unless used). If there is a &%perl_startup%&
14073 option then the associated value is taken to be Perl code which is executed in
14074 a newly created Perl interpreter.
14075
14076 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
14077 need backslashes before any characters to escape special meanings. The option
14078 should usually be something like
14079 .code
14080 perl_startup = do '/etc/exim.pl'
14081 .endd
14082 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
14083 use from Exim. Exim can be configured either to start up a Perl interpreter as
14084 soon as it is entered, or to wait until the first time it is needed. Starting
14085 the interpreter at the beginning ensures that it is done while Exim still has
14086 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
14087 fact used in a particular run. Also, note that this does not mean that Exim is
14088 necessarily running as root when Perl is called at a later time. By default,
14089 the interpreter is started only when it is needed, but this can be changed in
14090 two ways:
14091
14092 .ilist
14093 .oindex "&%perl_at_start%&"
14094 Setting &%perl_at_start%& (a boolean option) in the configuration requests
14095 a startup when Exim is entered.
14096 .next
14097 The command line option &%-ps%& also requests a startup when Exim is entered,
14098 overriding the setting of &%perl_at_start%&.
14099 .endlist
14100
14101 There is also a command line option &%-pd%& (for delay) which suppresses the
14102 initial startup, even if &%perl_at_start%& is set.
14103
14104 .ilist
14105 .oindex "&%perl_taintmode%&"
14106 .cindex "Perl" "taintmode"
14107 To provide more security executing Perl code via the embedded Perl
14108 interpreter, the &%perl_taintmode%& option can be set. This enables the
14109 taint mode of the Perl interpreter. You are encouraged to set this
14110 option to a true value. To avoid breaking existing installations, it
14111 defaults to false.
14112
14113 .new
14114 &*Note*&: This is entirely separate from Exim's tainted-data tracking.
14115 .wen
14116
14117
14118 .section "Calling Perl subroutines" "SECID86"
14119 When the configuration file includes a &%perl_startup%& option you can make use
14120 of the string expansion item to call the Perl subroutines that are defined
14121 by the &%perl_startup%& code. The operator is used in any of the following
14122 forms:
14123 .code
14124 ${perl{foo}}
14125 ${perl{foo}{argument}}
14126 ${perl{foo}{argument1}{argument2} ... }
14127 .endd
14128 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
14129 arguments may be passed. Passing more than this results in an expansion failure
14130 with an error message of the form
14131 .code
14132 Too many arguments passed to Perl subroutine "foo" (max is 8)
14133 .endd
14134 The return value of the Perl subroutine is evaluated in a scalar context before
14135 it is passed back to Exim to be inserted into the expanded string. If the
14136 return value is &'undef'&, the expansion is forced to fail in the same way as
14137 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
14138 by obeying Perl's &%die%& function, the expansion fails with the error message
14139 that was passed to &%die%&.
14140
14141
14142 .section "Calling Exim functions from Perl" "SECID87"
14143 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
14144 is available to call back into Exim's string expansion function. For example,
14145 the Perl code
14146 .code
14147 my $lp = Exim::expand_string('$local_part');
14148 .endd
14149 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
14150 Note those are single quotes and not double quotes to protect against
14151 &$local_part$& being interpolated as a Perl variable.
14152
14153 If the string expansion is forced to fail by a &"fail"& item, the result of
14154 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
14155 expansion string, the Perl call from the original expansion string fails with
14156 an appropriate error message, in the same way as if &%die%& were used.
14157
14158 .cindex "debugging" "from embedded Perl"
14159 .cindex "log" "writing from embedded Perl"
14160 Two other Exim functions are available for use from within Perl code.
14161 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
14162 debugging is enabled. If you want a newline at the end, you must supply it.
14163 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
14164 timestamp. In this case, you should not supply a terminating newline.
14165
14166
14167 .section "Use of standard output and error by Perl" "SECID88"
14168 .cindex "Perl" "standard output and error"
14169 You should not write to the standard error or output streams from within your
14170 Perl code, as it is not defined how these are set up. In versions of Exim
14171 before 4.50, it is possible for the standard output or error to refer to the
14172 SMTP connection during message reception via the daemon. Writing to this stream
14173 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
14174 error streams are connected to &_/dev/null_& in the daemon. The chaos is
14175 avoided, but the output is lost.
14176
14177 .cindex "Perl" "use of &%warn%&"
14178 The Perl &%warn%& statement writes to the standard error stream by default.
14179 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
14180 you have no control. When Exim starts up the Perl interpreter, it arranges for
14181 output from the &%warn%& statement to be written to the Exim main log. You can
14182 change this by including appropriate Perl magic somewhere in your Perl code.
14183 For example, to discard &%warn%& output completely, you need this:
14184 .code
14185 $SIG{__WARN__} = sub { };
14186 .endd
14187 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
14188 example, the code for the subroutine is empty, so it does nothing, but you can
14189 include any Perl code that you like. The text of the &%warn%& message is passed
14190 as the first subroutine argument.
14191 .ecindex IIDperl
14192
14193
14194 . ////////////////////////////////////////////////////////////////////////////
14195 . ////////////////////////////////////////////////////////////////////////////
14196
14197 .chapter "Starting the daemon and the use of network interfaces" &&&
14198          "CHAPinterfaces" &&&
14199          "Starting the daemon"
14200 .cindex "daemon" "starting"
14201 .cindex "interface" "listening"
14202 .cindex "network interface"
14203 .cindex "interface" "network"
14204 .cindex "IP address" "for listening"
14205 .cindex "daemon" "listening IP addresses"
14206 .cindex "TCP/IP" "setting listening interfaces"
14207 .cindex "TCP/IP" "setting listening ports"
14208 A host that is connected to a TCP/IP network may have one or more physical
14209 hardware network interfaces. Each of these interfaces may be configured as one
14210 or more &"logical"& interfaces, which are the entities that a program actually
14211 works with. Each of these logical interfaces is associated with an IP address.
14212 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
14213 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
14214 knowledge about the host's interfaces for use in three different circumstances:
14215
14216 .olist
14217 When a listening daemon is started, Exim needs to know which interfaces
14218 and ports to listen on.
14219 .next
14220 When Exim is routing an address, it needs to know which IP addresses
14221 are associated with local interfaces. This is required for the correct
14222 processing of MX lists by removing the local host and others with the
14223 same or higher priority values. Also, Exim needs to detect cases
14224 when an address is routed to an IP address that in fact belongs to the
14225 local host. Unless the &%self%& router option or the &%allow_localhost%&
14226 option of the smtp transport is set (as appropriate), this is treated
14227 as an error situation.
14228 .next
14229 When Exim connects to a remote host, it may need to know which interface to use
14230 for the outgoing connection.
14231 .endlist
14232
14233
14234 Exim's default behaviour is likely to be appropriate in the vast majority
14235 of cases. If your host has only one interface, and you want all its IP
14236 addresses to be treated in the same way, and you are using only the
14237 standard SMTP port, you should not need to take any special action. The
14238 rest of this chapter does not apply to you.
14239
14240 In a more complicated situation you may want to listen only on certain
14241 interfaces, or on different ports, and for this reason there are a number of
14242 options that can be used to influence Exim's behaviour. The rest of this
14243 chapter describes how they operate.
14244
14245 When a message is received over TCP/IP, the interface and port that were
14246 actually used are set in &$received_ip_address$& and &$received_port$&.
14247
14248
14249
14250 .section "Starting a listening daemon" "SECID89"
14251 When a listening daemon is started (by means of the &%-bd%& command line
14252 option), the interfaces and ports on which it listens are controlled by the
14253 following options:
14254
14255 .ilist
14256 &%daemon_smtp_ports%& contains a list of default ports
14257 or service names.
14258 (For backward compatibility, this option can also be specified in the singular.)
14259 .next
14260 &%local_interfaces%& contains list of interface IP addresses on which to
14261 listen. Each item may optionally also specify a port.
14262 .endlist
14263
14264 The default list separator in both cases is a colon, but this can be changed as
14265 described in section &<<SECTlistsepchange>>&. When IPv6 addresses are involved,
14266 it is usually best to change the separator to avoid having to double all the
14267 colons. For example:
14268 .code
14269 local_interfaces = <; 127.0.0.1 ; \
14270                       192.168.23.65 ; \
14271                       ::1 ; \
14272                       3ffe:ffff:836f::fe86:a061
14273 .endd
14274 There are two different formats for specifying a port along with an IP address
14275 in &%local_interfaces%&:
14276
14277 .olist
14278 The port is added onto the address with a dot separator. For example, to listen
14279 on port 1234 on two different IP addresses:
14280 .code
14281 local_interfaces = <; 192.168.23.65.1234 ; \
14282                       3ffe:ffff:836f::fe86:a061.1234
14283 .endd
14284 .next
14285 The IP address is enclosed in square brackets, and the port is added
14286 with a colon separator, for example:
14287 .code
14288 local_interfaces = <; [192.168.23.65]:1234 ; \
14289                       [3ffe:ffff:836f::fe86:a061]:1234
14290 .endd
14291 .endlist
14292
14293 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
14294 default setting contains just one port:
14295 .code
14296 daemon_smtp_ports = smtp
14297 .endd
14298 If more than one port is listed, each interface that does not have its own port
14299 specified listens on all of them. Ports that are listed in
14300 &%daemon_smtp_ports%& can be identified either by name (defined in
14301 &_/etc/services_&) or by number. However, when ports are given with individual
14302 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
14303
14304
14305
14306 .section "Special IP listening addresses" "SECID90"
14307 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
14308 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
14309 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
14310 instead of setting up separate listening sockets for each interface. The
14311 default value of &%local_interfaces%& is
14312 .code
14313 local_interfaces = 0.0.0.0
14314 .endd
14315 when Exim is built without IPv6 support; otherwise it is:
14316 .code
14317 local_interfaces = <; ::0 ; 0.0.0.0
14318 .endd
14319 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
14320
14321
14322
14323 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
14324 The &%-oX%& command line option can be used to override the values of
14325 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
14326 instance. Another way of doing this would be to use macros and the &%-D%&
14327 option. However, &%-oX%& can be used by any admin user, whereas modification of
14328 the runtime configuration by &%-D%& is allowed only when the caller is root or
14329 exim.
14330
14331 The value of &%-oX%& is a list of items. The default colon separator can be
14332 changed in the usual way (&<<SECTlistsepchange>>&) if required.
14333 If there are any items that do not
14334 contain dots or colons (that is, are not IP addresses), the value of
14335 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
14336 items that do contain dots or colons, the value of &%local_interfaces%& is
14337 replaced by those items. Thus, for example,
14338 .code
14339 -oX 1225
14340 .endd
14341 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
14342 whereas
14343 .code
14344 -oX 192.168.34.5.1125
14345 .endd
14346 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
14347 (However, since &%local_interfaces%& now contains no items without ports, the
14348 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
14349
14350
14351
14352 .section "Support for the submissions (aka SSMTP or SMTPS) protocol" "SECTsupobssmt"
14353 .cindex "submissions protocol"
14354 .cindex "ssmtp protocol"
14355 .cindex "smtps protocol"
14356 .cindex "SMTP" "ssmtp protocol"
14357 .cindex "SMTP" "smtps protocol"
14358 Exim supports the use of TLS-on-connect, used by mail clients in the
14359 &"submissions"& protocol, historically also known as SMTPS or SSMTP.
14360 For some years, IETF Standards Track documents only blessed the
14361 STARTTLS-based Submission service (port 587) while common practice was to support
14362 the same feature set on port 465, but using TLS-on-connect.
14363 If your installation needs to provide service to mail clients
14364 (Mail User Agents, MUAs) then you should provide service on both the 587 and
14365 the 465 TCP ports.
14366
14367 If the &%tls_on_connect_ports%& option is set to a list of port numbers or
14368 service names, connections to those ports must first establish TLS, before
14369 proceeding to the application layer use of the SMTP protocol.
14370
14371 The common use of this option is expected to be
14372 .code
14373 tls_on_connect_ports = 465
14374 .endd
14375 per RFC 8314.
14376 There is also a command line option &%-tls-on-connect%&, which forces all ports
14377 to behave in this way when a daemon is started.
14378
14379 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
14380 daemon to listen on those ports. You must still specify them in
14381 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
14382 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
14383 connections via the daemon.)
14384
14385
14386
14387
14388 .section "IPv6 address scopes" "SECID92"
14389 .cindex "IPv6" "address scopes"
14390 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
14391 can, in principle, have the same link-local IPv6 address on different
14392 interfaces. Thus, additional information is needed, over and above the IP
14393 address, to distinguish individual interfaces. A convention of using a
14394 percent sign followed by something (often the interface name) has been
14395 adopted in some cases, leading to addresses like this:
14396 .code
14397 fe80::202:b3ff:fe03:45c1%eth0
14398 .endd
14399 To accommodate this usage, a percent sign followed by an arbitrary string is
14400 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
14401 to convert a textual IPv6 address for actual use. This function recognizes the
14402 percent convention in operating systems that support it, and it processes the
14403 address appropriately. Unfortunately, some older libraries have problems with
14404 &[getaddrinfo()]&. If
14405 .code
14406 IPV6_USE_INET_PTON=yes
14407 .endd
14408 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
14409 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
14410 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
14411 function.) Of course, this means that the additional functionality of
14412 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
14413
14414 .section "Disabling IPv6" "SECID93"
14415 .cindex "IPv6" "disabling"
14416 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
14417 run on a host whose kernel does not support IPv6. The binary will fall back to
14418 using IPv4, but it may waste resources looking up AAAA records, and trying to
14419 connect to IPv6 addresses, causing delays to mail delivery. If you set the
14420 .oindex "&%disable_ipv6%&"
14421 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
14422 activities take place. AAAA records are never looked up, and any IPv6 addresses
14423 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
14424 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
14425 to handle IPv6 literal addresses.
14426
14427 On the other hand, when IPv6 is in use, there may be times when you want to
14428 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
14429 option to globally suppress the lookup of AAAA records for specified domains,
14430 and you can use the &%ignore_target_hosts%& generic router option to ignore
14431 IPv6 addresses in an individual router.
14432
14433
14434
14435 .section "Examples of starting a listening daemon" "SECID94"
14436 The default case in an IPv6 environment is
14437 .code
14438 daemon_smtp_ports = smtp
14439 local_interfaces = <; ::0 ; 0.0.0.0
14440 .endd
14441 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
14442 Either one or two sockets may be used, depending on the characteristics of
14443 the TCP/IP stack. (This is complicated and messy; for more information,
14444 read the comments in the &_daemon.c_& source file.)
14445
14446 To specify listening on ports 25 and 26 on all interfaces:
14447 .code
14448 daemon_smtp_ports = 25 : 26
14449 .endd
14450 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
14451 .code
14452 local_interfaces = <; ::0.25     ; ::0.26 \
14453                       0.0.0.0.25 ; 0.0.0.0.26
14454 .endd
14455 To listen on the default port on all IPv4 interfaces, and on port 26 on the
14456 IPv4 loopback address only:
14457 .code
14458 local_interfaces = 0.0.0.0 : 127.0.0.1.26
14459 .endd
14460 To specify listening on the default port on specific interfaces only:
14461 .code
14462 local_interfaces = 10.0.0.67 : 192.168.34.67
14463 .endd
14464 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
14465
14466
14467
14468 .section "Recognizing the local host" "SECTreclocipadd"
14469 The &%local_interfaces%& option is also used when Exim needs to determine
14470 whether or not an IP address refers to the local host. That is, the IP
14471 addresses of all the interfaces on which a daemon is listening are always
14472 treated as local.
14473
14474 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
14475 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
14476 available interfaces from the operating system, and extracts the relevant
14477 (that is, IPv4 or IPv6) addresses to use for checking.
14478
14479 Some systems set up large numbers of virtual interfaces in order to provide
14480 many virtual web servers. In this situation, you may want to listen for
14481 email on only a few of the available interfaces, but nevertheless treat all
14482 interfaces as local when routing. You can do this by setting
14483 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
14484 &"all"& wildcard values. These addresses are recognized as local, but are not
14485 used for listening. Consider this example:
14486 .code
14487 local_interfaces = <; 127.0.0.1 ; ::1 ; \
14488                       192.168.53.235 ; \
14489                       3ffe:2101:12:1:a00:20ff:fe86:a061
14490
14491 extra_local_interfaces = <; ::0 ; 0.0.0.0
14492 .endd
14493 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
14494 address, but all available interface addresses are treated as local when
14495 Exim is routing.
14496
14497 In some environments the local host name may be in an MX list, but with an IP
14498 address that is not assigned to any local interface. In other cases it may be
14499 desirable to treat other host names as if they referred to the local host. Both
14500 these cases can be handled by setting the &%hosts_treat_as_local%& option.
14501 This contains host names rather than IP addresses. When a host is referenced
14502 during routing, either via an MX record or directly, it is treated as the local
14503 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
14504 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
14505
14506
14507
14508 .section "Delivering to a remote host" "SECID95"
14509 Delivery to a remote host is handled by the smtp transport. By default, it
14510 allows the system's TCP/IP functions to choose which interface to use (if
14511 there is more than one) when connecting to a remote host. However, the
14512 &%interface%& option can be set to specify which interface is used. See the
14513 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
14514 details.
14515
14516
14517
14518
14519 . ////////////////////////////////////////////////////////////////////////////
14520 . ////////////////////////////////////////////////////////////////////////////
14521
14522 .chapter "Main configuration" "CHAPmainconfig"
14523 .scindex IIDconfima "configuration file" "main section"
14524 .scindex IIDmaiconf "main configuration"
14525 The first part of the runtime configuration file contains three types of item:
14526
14527 .ilist
14528 Macro definitions: These lines start with an upper case letter. See section
14529 &<<SECTmacrodefs>>& for details of macro processing.
14530 .next
14531 Named list definitions: These lines start with one of the words &"domainlist"&,
14532 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
14533 section &<<SECTnamedlists>>&.
14534 .next
14535 Main configuration settings: Each setting occupies one line of the file
14536 (with possible continuations). If any setting is preceded by the word
14537 &"hide"&, the &%-bP%& command line option displays its value to admin users
14538 only. See section &<<SECTcos>>& for a description of the syntax of these option
14539 settings.
14540 .endlist
14541
14542 This chapter specifies all the main configuration options, along with their
14543 types and default values. For ease of finding a particular option, they appear
14544 in alphabetical order in section &<<SECTalomo>>& below. However, because there
14545 are now so many options, they are first listed briefly in functional groups, as
14546 an aid to finding the name of the option you are looking for. Some options are
14547 listed in more than one group.
14548
14549 .section "Miscellaneous" "SECID96"
14550 .table2
14551 .row &%bi_command%&                  "to run for &%-bi%& command line option"
14552 .row &%debug_store%&                 "do extra internal checks"
14553 .row &%disable_ipv6%&                "do no IPv6 processing"
14554 .row &%keep_malformed%&              "for broken files &-- should not happen"
14555 .row &%localhost_number%&            "for unique message ids in clusters"
14556 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
14557 .row &%message_body_visible%&        "how much to show in &$message_body$&"
14558 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
14559 .row &%print_topbitchars%&           "top-bit characters are printing"
14560 .row &%spool_wireformat%&            "use wire-format spool data files when possible"
14561 .row &%timezone%&                    "force time zone"
14562 .endtable
14563
14564
14565 .section "Exim parameters" "SECID97"
14566 .table2
14567 .row &%exim_group%&                  "override compiled-in value"
14568 .row &%exim_path%&                   "override compiled-in value"
14569 .row &%exim_user%&                   "override compiled-in value"
14570 .row &%primary_hostname%&            "default from &[uname()]&"
14571 .row &%split_spool_directory%&       "use multiple directories"
14572 .row &%spool_directory%&             "override compiled-in value"
14573 .endtable
14574
14575
14576
14577 .section "Privilege controls" "SECID98"
14578 .table2
14579 .row &%admin_groups%&                "groups that are Exim admin users"
14580 .row &%commandline_checks_require_admin%& "require admin for various checks"
14581 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
14582 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
14583 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
14584 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
14585 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
14586 .row &%never_users%&                 "do not run deliveries as these"
14587 .row &%prod_requires_admin%&         "forced delivery requires admin user"
14588 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
14589 .row &%trusted_groups%&              "groups that are trusted"
14590 .row &%trusted_users%&               "users that are trusted"
14591 .endtable
14592
14593
14594
14595 .section "Logging" "SECID99"
14596 .table2
14597 .row &%event_action%&                "custom logging"
14598 .row &%hosts_connection_nolog%&      "exemption from connect logging"
14599 .row &%log_file_path%&               "override compiled-in value"
14600 .row &%log_selector%&                "set/unset optional logging"
14601 .row &%log_timezone%&                "add timezone to log lines"
14602 .row &%message_logs%&                "create per-message logs"
14603 .row &%preserve_message_logs%&       "after message completion"
14604 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
14605 .row &%slow_lookup_log%&             "control logging of slow DNS lookups"
14606 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
14607 .row &%syslog_facility%&             "set syslog &""facility""& field"
14608 .row &%syslog_pid%&                  "pid in syslog lines"
14609 .row &%syslog_processname%&          "set syslog &""ident""& field"
14610 .row &%syslog_timestamp%&            "timestamp syslog lines"
14611 .row &%write_rejectlog%&             "control use of message log"
14612 .endtable
14613
14614
14615
14616 .section "Frozen messages" "SECID100"
14617 .table2
14618 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
14619 .row &%freeze_tell%&                 "send message when freezing"
14620 .row &%move_frozen_messages%&        "to another directory"
14621 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
14622 .endtable
14623
14624
14625
14626 .section "Data lookups" "SECID101"
14627 .table2
14628 .row &%ibase_servers%&               "InterBase servers"
14629 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
14630 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
14631 .row &%ldap_cert_file%&              "client cert file for LDAP"
14632 .row &%ldap_cert_key%&               "client key file for LDAP"
14633 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
14634 .row &%ldap_default_servers%&        "used if no server in query"
14635 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
14636 .row &%ldap_start_tls%&              "require TLS within LDAP"
14637 .row &%ldap_version%&                "set protocol version"
14638 .row &%lookup_open_max%&             "lookup files held open"
14639 .row &%mysql_servers%&               "default MySQL servers"
14640 .row &%oracle_servers%&              "Oracle servers"
14641 .row &%pgsql_servers%&               "default PostgreSQL servers"
14642 .row &%sqlite_lock_timeout%&         "as it says"
14643 .endtable
14644
14645
14646
14647 .section "Message ids" "SECID102"
14648 .table2
14649 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
14650 .row &%message_id_header_text%&      "ditto"
14651 .endtable
14652
14653
14654
14655 .section "Embedded Perl Startup" "SECID103"
14656 .table2
14657 .row &%perl_at_start%&               "always start the interpreter"
14658 .row &%perl_startup%&                "code to obey when starting Perl"
14659 .row &%perl_taintmode%&              "enable taint mode in Perl"
14660 .endtable
14661
14662
14663
14664 .section "Daemon" "SECID104"
14665 .table2
14666 .row &%daemon_smtp_ports%&           "default ports"
14667 .row &%daemon_startup_retries%&      "number of times to retry"
14668 .row &%daemon_startup_sleep%&        "time to sleep between tries"
14669 .row &%extra_local_interfaces%&      "not necessarily listened on"
14670 .row &%local_interfaces%&            "on which to listen, with optional ports"
14671 .row &%notifier_socket%&             "override compiled-in value"
14672 .row &%pid_file_path%&               "override compiled-in value"
14673 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14674 .endtable
14675
14676
14677
14678 .section "Resource control" "SECID105"
14679 .table2
14680 .row &%check_log_inodes%&            "before accepting a message"
14681 .row &%check_log_space%&             "before accepting a message"
14682 .row &%check_spool_inodes%&          "before accepting a message"
14683 .row &%check_spool_space%&           "before accepting a message"
14684 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
14685 .row &%queue_only_load%&             "queue incoming if load high"
14686 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
14687 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14688 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
14689 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14690 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14691 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14692 .row &%smtp_accept_max_per_connection%& "messages per connection"
14693 .row &%smtp_accept_max_per_host%&    "connections from one host"
14694 .row &%smtp_accept_queue%&           "queue mail if more connections"
14695 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14696                                            connection"
14697 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14698 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14699 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14700 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
14701 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14702 .endtable
14703
14704
14705
14706 .section "Policy controls" "SECID106"
14707 .table2
14708 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
14709 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
14710 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
14711 .row &%acl_smtp_auth%&               "ACL for AUTH"
14712 .row &%acl_smtp_connect%&            "ACL for connection"
14713 .row &%acl_smtp_data%&               "ACL for DATA"
14714 .row &%acl_smtp_data_prdr%&          "ACL for DATA, per-recipient"
14715 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
14716 .row &%acl_smtp_etrn%&               "ACL for ETRN"
14717 .row &%acl_smtp_expn%&               "ACL for EXPN"
14718 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
14719 .row &%acl_smtp_mail%&               "ACL for MAIL"
14720 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
14721 .row &%acl_smtp_mime%&               "ACL for MIME parts"
14722 .row &%acl_smtp_notquit%&            "ACL for non-QUIT terminations"
14723 .row &%acl_smtp_predata%&            "ACL for start of data"
14724 .row &%acl_smtp_quit%&               "ACL for QUIT"
14725 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
14726 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
14727 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
14728 .row &%av_scanner%&                  "specify virus scanner"
14729 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14730                                       words""&"
14731 .row &%dns_cname_loops%&             "follow CNAMEs returned by resolver"
14732 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
14733 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
14734 .row &%header_maxsize%&              "total size of message header"
14735 .row &%header_line_maxsize%&         "individual header line limit"
14736 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
14737 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
14738 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
14739 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
14740 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
14741 .row &%host_lookup%&                 "host name looked up for these hosts"
14742 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14743 .row &%hosts_proxy%&                 "use proxy protocol for these hosts"
14744 .row &%host_reject_connection%&      "reject connection from these hosts"
14745 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
14746 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
14747 .row &%message_size_limit%&          "for all messages"
14748 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14749 .row &%proxy_protocol_timeout%&      "timeout for proxy protocol negotiation"
14750 .row &%spamd_address%&               "set interface to SpamAssassin"
14751 .row &%strict_acl_vars%&             "object to unset ACL variables"
14752 .row &%spf_smtp_comment_template%&   "template for &$spf_smtp_comment$&"
14753 .endtable
14754
14755
14756
14757 .section "Callout cache" "SECID107"
14758 .table2
14759 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
14760                                          item"
14761 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
14762                                          item"
14763 .row &%callout_negative_expire%&     "timeout for negative address cache item"
14764 .row &%callout_positive_expire%&     "timeout for positive address cache item"
14765 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
14766 .endtable
14767
14768
14769
14770 .section "TLS" "SECID108"
14771 .table2
14772 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
14773 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
14774 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
14775 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14776 .row &%tls_certificate%&             "location of server certificate"
14777 .row &%tls_crl%&                     "certificate revocation list"
14778 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
14779 .row &%tls_dhparam%&                 "DH parameters for server"
14780 .row &%tls_eccurve%&                 "EC curve selection for server"
14781 .row &%tls_ocsp_file%&               "location of server certificate status proof"
14782 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
14783 .row &%tls_privatekey%&              "location of server private key"
14784 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
14785 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
14786 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
14787 .row &%tls_verify_certificates%&     "expected client certificates"
14788 .row &%tls_verify_hosts%&            "insist on client certificate verify"
14789 .endtable
14790
14791
14792
14793 .section "Local user handling" "SECID109"
14794 .table2
14795 .row &%finduser_retries%&            "useful in NIS environments"
14796 .row &%gecos_name%&                  "used when creating &'Sender:'&"
14797 .row &%gecos_pattern%&               "ditto"
14798 .row &%max_username_length%&         "for systems that truncate"
14799 .row &%unknown_login%&               "used when no login name found"
14800 .row &%unknown_username%&            "ditto"
14801 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
14802 .row &%uucp_from_sender%&            "ditto"
14803 .endtable
14804
14805
14806
14807 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
14808 .table2
14809 .row &%header_maxsize%&              "total size of message header"
14810 .row &%header_line_maxsize%&         "individual header line limit"
14811 .row &%message_size_limit%&          "applies to all messages"
14812 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14813 .row &%received_header_text%&        "expanded to make &'Received:'&"
14814 .row &%received_headers_max%&        "for mail loop detection"
14815 .row &%recipients_max%&              "limit per message"
14816 .row &%recipients_max_reject%&       "permanently reject excess recipients"
14817 .endtable
14818
14819
14820
14821
14822 .section "Non-SMTP incoming messages" "SECID111"
14823 .table2
14824 .row &%receive_timeout%&             "for non-SMTP messages"
14825 .endtable
14826
14827
14828
14829
14830
14831 .section "Incoming SMTP messages" "SECID112"
14832 See also the &'Policy controls'& section above.
14833
14834 .table2
14835 .row &%dkim_verify_hashes%&          "DKIM hash methods accepted for signatures"
14836 .row &%dkim_verify_keytypes%&        "DKIM key types accepted for signatures"
14837 .row &%dkim_verify_min_keysizes%&    "DKIM key sizes accepted for signatures"
14838 .row &%dkim_verify_signers%&         "DKIM domains for which DKIM ACL is run"
14839 .row &%dmarc_forensic_sender%&       "DMARC sender for report messages"
14840 .row &%dmarc_history_file%&          "DMARC results log"
14841 .row &%dmarc_tld_file%&              "DMARC toplevel domains file"
14842 .row &%host_lookup%&                 "host name looked up for these hosts"
14843 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14844 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
14845 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
14846 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
14847 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
14848 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
14849 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14850 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14851 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14852 .row &%smtp_accept_max_per_connection%& "messages per connection"
14853 .row &%smtp_accept_max_per_host%&    "connections from one host"
14854 .row &%smtp_accept_queue%&           "queue mail if more connections"
14855 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14856                                            connection"
14857 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14858 .row &%smtp_active_hostname%&        "host name to use in messages"
14859 .row &%smtp_banner%&                 "text for welcome banner"
14860 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14861 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14862 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
14863 .row &%smtp_etrn_command%&           "what to run for ETRN"
14864 .row &%smtp_etrn_serialize%&         "only one at once"
14865 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
14866 .row &%smtp_max_unknown_commands%&   "before dropping connection"
14867 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
14868 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
14869 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
14870 .row &%smtp_receive_timeout%&        "per command or data line"
14871 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14872 .row &%smtp_return_error_details%&   "give detail on rejections"
14873 .endtable
14874
14875
14876
14877 .section "SMTP extensions" "SECID113"
14878 .table2
14879 .row &%accept_8bitmime%&             "advertise 8BITMIME"
14880 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
14881 .row &%chunking_advertise_hosts%&    "advertise CHUNKING to these hosts"
14882 .row &%dsn_advertise_hosts%&         "advertise DSN extensions to these hosts"
14883 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
14884 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
14885 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
14886 .row &%pipelining_connect_advertise_hosts%& "advertise pipelining to these hosts"
14887 .row &%prdr_enable%&                 "advertise PRDR to all hosts"
14888 .row &%smtputf8_advertise_hosts%&    "advertise SMTPUTF8 to these hosts"
14889 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14890 .endtable
14891
14892
14893
14894 .section "Processing messages" "SECID114"
14895 .table2
14896 .row &%allow_domain_literals%&       "recognize domain literal syntax"
14897 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
14898 .row &%allow_utf8_domains%&          "in addresses"
14899 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14900                                       words""&"
14901 .row &%delivery_date_remove%&        "from incoming messages"
14902 .row &%envelope_to_remove%&          "from incoming messages"
14903 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
14904 .row &%headers_charset%&             "default for translations"
14905 .row &%qualify_domain%&              "default for senders"
14906 .row &%qualify_recipient%&           "default for recipients"
14907 .row &%return_path_remove%&          "from incoming messages"
14908 .row &%strip_excess_angle_brackets%& "in addresses"
14909 .row &%strip_trailing_dot%&          "at end of addresses"
14910 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
14911 .endtable
14912
14913
14914
14915 .section "System filter" "SECID115"
14916 .table2
14917 .row &%system_filter%&               "locate system filter"
14918 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
14919                                             directory"
14920 .row &%system_filter_file_transport%& "transport for delivery to a file"
14921 .row &%system_filter_group%&         "group for filter running"
14922 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
14923 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
14924 .row &%system_filter_user%&          "user for filter running"
14925 .endtable
14926
14927
14928
14929 .section "Routing and delivery" "SECID116"
14930 .table2
14931 .row &%disable_ipv6%&                "do no IPv6 processing"
14932 .row &%dns_again_means_nonexist%&    "for broken domains"
14933 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
14934 .row &%dns_dnssec_ok%&               "parameter for resolver"
14935 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
14936 .row &%dns_retrans%&                 "parameter for resolver"
14937 .row &%dns_retry%&                   "parameter for resolver"
14938 .row &%dns_trust_aa%&                "DNS zones trusted as authentic"
14939 .row &%dns_use_edns0%&               "parameter for resolver"
14940 .row &%hold_domains%&                "hold delivery for these domains"
14941 .row &%local_interfaces%&            "for routing checks"
14942 .row &%queue_domains%&               "no immediate delivery for these"
14943 .row &%queue_fast_ramp%&             "parallel delivery with 2-phase queue run"
14944 .row &%queue_only%&                  "no immediate delivery at all"
14945 .row &%queue_only_file%&             "no immediate delivery if file exists"
14946 .row &%queue_only_load%&             "no immediate delivery if load is high"
14947 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
14948 .row &%queue_only_override%&         "allow command line to override"
14949 .row &%queue_run_in_order%&          "order of arrival"
14950 .row &%queue_run_max%&               "of simultaneous queue runners"
14951 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
14952 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
14953 .row &%remote_sort_domains%&         "order of remote deliveries"
14954 .row &%retry_data_expire%&           "timeout for retry data"
14955 .row &%retry_interval_max%&          "safety net for retry rules"
14956 .endtable
14957
14958
14959
14960 .section "Bounce and warning messages" "SECID117"
14961 .table2
14962 .row &%bounce_message_file%&         "content of bounce"
14963 .row &%bounce_message_text%&         "content of bounce"
14964 .row &%bounce_return_body%&          "include body if returning message"
14965 .row &%bounce_return_linesize_limit%& "limit on returned message line length"
14966 .row &%bounce_return_message%&       "include original message in bounce"
14967 .row &%bounce_return_size_limit%&    "limit on returned message"
14968 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
14969 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
14970 .row &%errors_copy%&                 "copy bounce messages"
14971 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
14972 .row &%delay_warning%&               "time schedule"
14973 .row &%delay_warning_condition%&     "condition for warning messages"
14974 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
14975 .row &%smtp_return_error_details%&   "give detail on rejections"
14976 .row &%warn_message_file%&           "content of warning message"
14977 .endtable
14978
14979
14980
14981 .section "Alphabetical list of main options" "SECTalomo"
14982 Those options that undergo string expansion before use are marked with
14983 &dagger;.
14984
14985 .option accept_8bitmime main boolean true
14986 .cindex "8BITMIME"
14987 .cindex "8-bit characters"
14988 .cindex "log" "selectors"
14989 .cindex "log" "8BITMIME"
14990 .cindex "ESMTP extensions" 8BITMIME
14991 This option causes Exim to send 8BITMIME in its response to an SMTP
14992 EHLO command, and to accept the BODY= parameter on MAIL commands.
14993 However, though Exim is 8-bit clean, it is not a protocol converter, and it
14994 takes no steps to do anything special with messages received by this route.
14995
14996 Historically Exim kept this option off by default, but the maintainers
14997 feel that in today's Internet, this causes more problems than it solves.
14998 It now defaults to true.
14999 A more detailed analysis of the issues is provided by Dan Bernstein:
15000 .display
15001 &url(https://cr.yp.to/smtp/8bitmime.html)
15002 .endd
15003
15004 To log received 8BITMIME status use
15005 .code
15006 log_selector = +8bitmime
15007 .endd
15008
15009 .option acl_not_smtp main string&!! unset
15010 .cindex "&ACL;" "for non-SMTP messages"
15011 .cindex "non-SMTP messages" "ACLs for"
15012 This option defines the ACL that is run when a non-SMTP message has been
15013 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
15014 further details.
15015
15016 .option acl_not_smtp_mime main string&!! unset
15017 This option defines the ACL that is run for individual MIME parts of non-SMTP
15018 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
15019 SMTP messages.
15020
15021 .option acl_not_smtp_start main string&!! unset
15022 .cindex "&ACL;" "at start of non-SMTP message"
15023 .cindex "non-SMTP messages" "ACLs for"
15024 This option defines the ACL that is run before Exim starts reading a
15025 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
15026
15027 .option acl_smtp_auth main string&!! unset
15028 .cindex "&ACL;" "setting up for SMTP commands"
15029 .cindex "AUTH" "ACL for"
15030 This option defines the ACL that is run when an SMTP AUTH command is
15031 received. See chapter &<<CHAPACL>>& for further details.
15032
15033 .option acl_smtp_connect main string&!! unset
15034 .cindex "&ACL;" "on SMTP connection"
15035 This option defines the ACL that is run when an SMTP connection is received.
15036 See chapter &<<CHAPACL>>& for further details.
15037
15038 .option acl_smtp_data main string&!! unset
15039 .cindex "DATA" "ACL for"
15040 This option defines the ACL that is run after an SMTP DATA command has been
15041 processed and the message itself has been received, but before the final
15042 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
15043
15044 .option acl_smtp_data_prdr main string&!! accept
15045 .cindex "PRDR" "ACL for"
15046 .cindex "DATA" "PRDR ACL for"
15047 .cindex "&ACL;" "PRDR-related"
15048 .cindex "&ACL;" "per-user data processing"
15049 This option defines the ACL that,
15050 if the PRDR feature has been negotiated,
15051 is run for each recipient after an SMTP DATA command has been
15052 processed and the message itself has been received, but before the
15053 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
15054
15055 .option acl_smtp_dkim main string&!! unset
15056 .cindex DKIM "ACL for"
15057 This option defines the ACL that is run for each DKIM signature
15058 (by default, or as specified in the dkim_verify_signers option)
15059 of a received message.
15060 See section &<<SECDKIMVFY>>& for further details.
15061
15062 .option acl_smtp_etrn main string&!! unset
15063 .cindex "ETRN" "ACL for"
15064 This option defines the ACL that is run when an SMTP ETRN command is
15065 received. See chapter &<<CHAPACL>>& for further details.
15066
15067 .option acl_smtp_expn main string&!! unset
15068 .cindex "EXPN" "ACL for"
15069 This option defines the ACL that is run when an SMTP EXPN command is
15070 received. See chapter &<<CHAPACL>>& for further details.
15071
15072 .option acl_smtp_helo main string&!! unset
15073 .cindex "EHLO" "ACL for"
15074 .cindex "HELO" "ACL for"
15075 This option defines the ACL that is run when an SMTP EHLO or HELO
15076 command is received. See chapter &<<CHAPACL>>& for further details.
15077
15078
15079 .option acl_smtp_mail main string&!! unset
15080 .cindex "MAIL" "ACL for"
15081 This option defines the ACL that is run when an SMTP MAIL command is
15082 received. See chapter &<<CHAPACL>>& for further details.
15083
15084 .option acl_smtp_mailauth main string&!! unset
15085 .cindex "AUTH" "on MAIL command"
15086 This option defines the ACL that is run when there is an AUTH parameter on
15087 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
15088 &<<CHAPSMTPAUTH>>& for details of authentication.
15089
15090 .option acl_smtp_mime main string&!! unset
15091 .cindex "MIME content scanning" "ACL for"
15092 This option is available when Exim is built with the content-scanning
15093 extension. It defines the ACL that is run for each MIME part in a message. See
15094 section &<<SECTscanmimepart>>& for details.
15095
15096 .option acl_smtp_notquit main string&!! unset
15097 .cindex "not-QUIT, ACL for"
15098 This option defines the ACL that is run when an SMTP session
15099 ends without a QUIT command being received.
15100 See chapter &<<CHAPACL>>& for further details.
15101
15102 .option acl_smtp_predata main string&!! unset
15103 This option defines the ACL that is run when an SMTP DATA command is
15104 received, before the message itself is received. See chapter &<<CHAPACL>>& for
15105 further details.
15106
15107 .option acl_smtp_quit main string&!! unset
15108 .cindex "QUIT, ACL for"
15109 This option defines the ACL that is run when an SMTP QUIT command is
15110 received. See chapter &<<CHAPACL>>& for further details.
15111
15112 .option acl_smtp_rcpt main string&!! unset
15113 .cindex "RCPT" "ACL for"
15114 This option defines the ACL that is run when an SMTP RCPT command is
15115 received. See chapter &<<CHAPACL>>& for further details.
15116
15117 .option acl_smtp_starttls main string&!! unset
15118 .cindex "STARTTLS, ACL for"
15119 This option defines the ACL that is run when an SMTP STARTTLS command is
15120 received. See chapter &<<CHAPACL>>& for further details.
15121
15122 .option acl_smtp_vrfy main string&!! unset
15123 .cindex "VRFY" "ACL for"
15124 This option defines the ACL that is run when an SMTP VRFY command is
15125 received. See chapter &<<CHAPACL>>& for further details.
15126
15127 .option add_environment main "string list" empty
15128 .cindex "environment" "set values"
15129 This option adds individual environment variables that the
15130 currently linked libraries and programs in child processes may use.
15131 Each list element should be of the form &"name=value"&.
15132
15133 See &<<SECTpipeenv>>& for the environment of &(pipe)& transports.
15134
15135 .option admin_groups main "string list&!!" unset
15136 .cindex "admin user"
15137 This option is expanded just once, at the start of Exim's processing. If the
15138 current group or any of the supplementary groups of an Exim caller is in this
15139 colon-separated list, the caller has admin privileges. If all your system
15140 programmers are in a specific group, for example, you can give them all Exim
15141 admin privileges by putting that group in &%admin_groups%&. However, this does
15142 not permit them to read Exim's spool files (whose group owner is the Exim gid).
15143 To permit this, you have to add individuals to the Exim group.
15144
15145 .option allow_domain_literals main boolean false
15146 .cindex "domain literal"
15147 If this option is set, the RFC 2822 domain literal format is permitted in
15148 email addresses. The option is not set by default, because the domain literal
15149 format is not normally required these days, and few people know about it. It
15150 has, however, been exploited by mail abusers.
15151
15152 Unfortunately, it seems that some DNS black list maintainers are using this
15153 format to report black listing to postmasters. If you want to accept messages
15154 addressed to your hosts by IP address, you need to set
15155 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
15156 domains (defined in the named domain list &%local_domains%& in the default
15157 configuration). This &"magic string"& matches the domain literal form of all
15158 the local host's IP addresses.
15159
15160
15161 .option allow_mx_to_ip main boolean false
15162 .cindex "MX record" "pointing to IP address"
15163 It appears that more and more DNS zone administrators are breaking the rules
15164 and putting domain names that look like IP addresses on the right hand side of
15165 MX records. Exim follows the rules and rejects this, giving an error message
15166 that explains the misconfiguration. However, some other MTAs support this
15167 practice, so to avoid &"Why can't Exim do this?"& complaints,
15168 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
15169 recommended, except when you have no other choice.
15170
15171 .option allow_utf8_domains main boolean false
15172 .cindex "domain" "UTF-8 characters in"
15173 .cindex "UTF-8" "in domain name"
15174 Lots of discussion is going on about internationalized domain names. One
15175 camp is strongly in favour of just using UTF-8 characters, and it seems
15176 that at least two other MTAs permit this.
15177 This option allows Exim users to experiment if they wish.
15178
15179 If it is set true, Exim's domain parsing function allows valid
15180 UTF-8 multicharacters to appear in domain name components, in addition to
15181 letters, digits, and hyphens.
15182
15183 If Exim is built with internationalization support
15184 and the SMTPUTF8 ESMTP option is in use (see chapter &<<CHAPi18n>>&)
15185 this option can be left as default.
15186 Without that,
15187 if you want to look up such domain names in the DNS, you must also
15188 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
15189 suitable setting is:
15190 .code
15191 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
15192   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
15193 .endd
15194 Alternatively, you can just disable this feature by setting
15195 .code
15196 dns_check_names_pattern =
15197 .endd
15198 That is, set the option to an empty string so that no check is done.
15199
15200
15201 .option auth_advertise_hosts main "host list&!!" *
15202 .cindex "authentication" "advertising"
15203 .cindex "AUTH" "advertising"
15204 .cindex "ESMTP extensions" AUTH
15205 If any server authentication mechanisms are configured, Exim advertises them in
15206 response to an EHLO command only if the calling host matches this list.
15207 Otherwise, Exim does not advertise AUTH.
15208 Exim does not accept AUTH commands from clients to which it has not
15209 advertised the availability of AUTH. The advertising of individual
15210 authentication mechanisms can be controlled by the use of the
15211 &%server_advertise_condition%& generic authenticator option on the individual
15212 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
15213
15214 Certain mail clients (for example, Netscape) require the user to provide a name
15215 and password for authentication if AUTH is advertised, even though it may
15216 not be needed (the host may accept messages from hosts on its local LAN without
15217 authentication, for example). The &%auth_advertise_hosts%& option can be used
15218 to make these clients more friendly by excluding them from the set of hosts to
15219 which Exim advertises AUTH.
15220
15221 .cindex "AUTH" "advertising when encrypted"
15222 If you want to advertise the availability of AUTH only when the connection
15223 is encrypted using TLS, you can make use of the fact that the value of this
15224 option is expanded, with a setting like this:
15225 .code
15226 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
15227 .endd
15228 .vindex "&$tls_in_cipher$&"
15229 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
15230 the expansion is empty, thus matching no hosts. Otherwise, the result of the
15231 expansion is *, which matches all hosts.
15232
15233
15234 .option auto_thaw main time 0s
15235 .cindex "thawing messages"
15236 .cindex "unfreezing messages"
15237 If this option is set to a time greater than zero, a queue runner will try a
15238 new delivery attempt on any frozen message, other than a bounce message, if
15239 this much time has passed since it was frozen. This may result in the message
15240 being re-frozen if nothing has changed since the last attempt. It is a way of
15241 saying &"keep on trying, even though there are big problems"&.
15242
15243 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
15244 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
15245 thought to be very useful any more, and its use should probably be avoided.
15246
15247
15248 .option av_scanner main string "see below"
15249 This option is available if Exim is built with the content-scanning extension.
15250 It specifies which anti-virus scanner to use. The default value is:
15251 .code
15252 sophie:/var/run/sophie
15253 .endd
15254 If the value of &%av_scanner%& starts with a dollar character, it is expanded
15255 before use. See section &<<SECTscanvirus>>& for further details.
15256
15257
15258 .option bi_command main string unset
15259 .oindex "&%-bi%&"
15260 This option supplies the name of a command that is run when Exim is called with
15261 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
15262 just the command name, it is not a complete command line. If an argument is
15263 required, it must come from the &%-oA%& command line option.
15264
15265
15266 .option bounce_message_file main string&!! unset
15267 .cindex "bounce message" "customizing"
15268 .cindex "customizing" "bounce message"
15269 This option defines a template file containing paragraphs of text to be used
15270 for constructing bounce messages.  Details of the file's contents are given in
15271 chapter &<<CHAPemsgcust>>&.
15272 .cindex bounce_message_file "tainted data"
15273 The option is expanded to give the file path, which must be
15274 absolute and untainted.
15275 See also &%warn_message_file%&.
15276
15277
15278 .option bounce_message_text main string unset
15279 When this option is set, its contents are included in the default bounce
15280 message immediately after &"This message was created automatically by mail
15281 delivery software."& It is not used if &%bounce_message_file%& is set.
15282
15283 .option bounce_return_body main boolean true
15284 .cindex "bounce message" "including body"
15285 This option controls whether the body of an incoming message is included in a
15286 bounce message when &%bounce_return_message%& is true. The default setting
15287 causes the entire message, both header and body, to be returned (subject to the
15288 value of &%bounce_return_size_limit%&). If this option is false, only the
15289 message header is included. In the case of a non-SMTP message containing an
15290 error that is detected during reception, only those header lines preceding the
15291 point at which the error was detected are returned.
15292 .cindex "bounce message" "including original"
15293
15294 .option bounce_return_linesize_limit main integer 998
15295 .cindex "size" "of bounce lines, limit"
15296 .cindex "bounce message" "line length limit"
15297 .cindex "limit" "bounce message line length"
15298 This option sets a limit in bytes on the line length of messages
15299 that are returned to senders due to delivery problems,
15300 when &%bounce_return_message%& is true.
15301 The default value corresponds to RFC limits.
15302 If the message being returned has lines longer than this value it is
15303 treated as if the &%bounce_return_size_limit%& (below) restriction was exceeded.
15304
15305 The option also applies to bounces returned when an error is detected
15306 during reception of a message.
15307 In this case lines from the original are truncated.
15308
15309 The option does not apply to messages generated by an &(autoreply)& transport.
15310
15311
15312 .option bounce_return_message main boolean true
15313 If this option is set false, none of the original message is included in
15314 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
15315 &%bounce_return_body%&.
15316
15317
15318 .option bounce_return_size_limit main integer 100K
15319 .cindex "size" "of bounce, limit"
15320 .cindex "bounce message" "size limit"
15321 .cindex "limit" "bounce message size"
15322 This option sets a limit in bytes on the size of messages that are returned to
15323 senders as part of bounce messages when &%bounce_return_message%& is true. The
15324 limit should be less than the value of the global &%message_size_limit%& and of
15325 any &%message_size_limit%& settings on transports, to allow for the bounce text
15326 that Exim generates. If this option is set to zero there is no limit.
15327
15328 When the body of any message that is to be included in a bounce message is
15329 greater than the limit, it is truncated, and a comment pointing this out is
15330 added at the top. The actual cutoff may be greater than the value given, owing
15331 to the use of buffering for transferring the message in chunks (typically 8K in
15332 size). The idea is to save bandwidth on those undeliverable 15-megabyte
15333 messages.
15334
15335 .option bounce_sender_authentication main string unset
15336 .cindex "bounce message" "sender authentication"
15337 .cindex "authentication" "bounce message"
15338 .cindex "AUTH" "on bounce message"
15339 This option provides an authenticated sender address that is sent with any
15340 bounce messages generated by Exim that are sent over an authenticated SMTP
15341 connection. A typical setting might be:
15342 .code
15343 bounce_sender_authentication = mailer-daemon@my.domain.example
15344 .endd
15345 which would cause bounce messages to be sent using the SMTP command:
15346 .code
15347 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
15348 .endd
15349 The value of &%bounce_sender_authentication%& must always be a complete email
15350 address.
15351
15352 .option callout_domain_negative_expire main time 3h
15353 .cindex "caching" "callout timeouts"
15354 .cindex "callout" "caching timeouts"
15355 This option specifies the expiry time for negative callout cache data for a
15356 domain. See section &<<SECTcallver>>& for details of callout verification, and
15357 section &<<SECTcallvercache>>& for details of the caching.
15358
15359
15360 .option callout_domain_positive_expire main time 7d
15361 This option specifies the expiry time for positive callout cache data for a
15362 domain. See section &<<SECTcallver>>& for details of callout verification, and
15363 section &<<SECTcallvercache>>& for details of the caching.
15364
15365
15366 .option callout_negative_expire main time 2h
15367 This option specifies the expiry time for negative callout cache data for an
15368 address. See section &<<SECTcallver>>& for details of callout verification, and
15369 section &<<SECTcallvercache>>& for details of the caching.
15370
15371
15372 .option callout_positive_expire main time 24h
15373 This option specifies the expiry time for positive callout cache data for an
15374 address. See section &<<SECTcallver>>& for details of callout verification, and
15375 section &<<SECTcallvercache>>& for details of the caching.
15376
15377
15378 .option callout_random_local_part main string&!! "see below"
15379 This option defines the &"random"& local part that can be used as part of
15380 callout verification. The default value is
15381 .code
15382 $primary_hostname-$tod_epoch-testing
15383 .endd
15384 See section &<<CALLaddparcall>>& for details of how this value is used.
15385
15386
15387 .option check_log_inodes main integer 100
15388 See &%check_spool_space%& below.
15389
15390
15391 .option check_log_space main integer 10M
15392 See &%check_spool_space%& below.
15393
15394 .oindex "&%check_rfc2047_length%&"
15395 .cindex "RFC 2047" "disabling length check"
15396 .option check_rfc2047_length main boolean true
15397 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
15398 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
15399 word; strings to be encoded that exceed this length are supposed to use
15400 multiple encoded words. By default, Exim does not recognize encoded words that
15401 exceed the maximum length. However, it seems that some software, in violation
15402 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
15403 set false, Exim recognizes encoded words of any length.
15404
15405
15406 .option check_spool_inodes main integer 100
15407 See &%check_spool_space%& below.
15408
15409
15410 .option check_spool_space main integer 10M
15411 .cindex "checking disk space"
15412 .cindex "disk space, checking"
15413 .cindex "spool directory" "checking space"
15414 The four &%check_...%& options allow for checking of disk resources before a
15415 message is accepted.
15416
15417 .vindex "&$log_inodes$&"
15418 .vindex "&$log_space$&"
15419 .vindex "&$spool_inodes$&"
15420 .vindex "&$spool_space$&"
15421 When any of these options are nonzero, they apply to all incoming messages. If you
15422 want to apply different checks to different kinds of message, you can do so by
15423 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
15424 &$spool_space$& in an ACL with appropriate additional conditions.
15425
15426
15427 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
15428 either value is greater than zero, for example:
15429 .code
15430 check_spool_space = 100M
15431 check_spool_inodes = 100
15432 .endd
15433 The spool partition is the one that contains the directory defined by
15434 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
15435 transit.
15436
15437 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
15438 files are written if either is greater than zero. These should be set only if
15439 &%log_file_path%& and &%spool_directory%& refer to different partitions.
15440
15441 If there is less space or fewer inodes than requested, Exim refuses to accept
15442 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
15443 error response to the MAIL command. If ESMTP is in use and there was a
15444 SIZE parameter on the MAIL command, its value is added to the
15445 &%check_spool_space%& value, and the check is performed even if
15446 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
15447
15448 The values for &%check_spool_space%& and &%check_log_space%& are held as a
15449 number of kilobytes (though specified in bytes).
15450 If a non-multiple of 1024 is specified, it is rounded up.
15451
15452 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
15453 failure a message is written to stderr and Exim exits with a non-zero code, as
15454 it obviously cannot send an error message of any kind.
15455
15456 There is a slight performance penalty for these checks.
15457 Versions of Exim preceding 4.88 had these disabled by default;
15458 high-rate installations confident they will never run out of resources
15459 may wish to deliberately disable them.
15460
15461 .option chunking_advertise_hosts main "host list&!!" *
15462 .cindex CHUNKING advertisement
15463 .cindex "RFC 3030" "CHUNKING"
15464 .cindex "ESMTP extensions" CHUNKING
15465 The CHUNKING extension (RFC3030) will be advertised in the EHLO message to
15466 these hosts.
15467 Hosts may use the BDAT command as an alternate to DATA.
15468
15469 .option commandline_checks_require_admin main boolean &`false`&
15470 .cindex "restricting access to features"
15471 This option restricts various basic checking features to require an
15472 administrative user.
15473 This affects most of the &%-b*%& options, such as &%-be%&.
15474
15475 .option debug_store main boolean &`false`&
15476 .cindex debugging "memory corruption"
15477 .cindex memory debugging
15478 This option, when true, enables extra checking in Exim's internal memory
15479 management.  For use when a memory corruption issue is being investigated,
15480 it should normally be left as default.
15481
15482 .option daemon_smtp_ports main string &`smtp`&
15483 .cindex "port" "for daemon"
15484 .cindex "TCP/IP" "setting listening ports"
15485 This option specifies one or more default SMTP ports on which the Exim daemon
15486 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
15487 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
15488
15489 .option daemon_startup_retries main integer 9
15490 .cindex "daemon startup, retrying"
15491 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
15492 the daemon at startup when it cannot immediately bind a listening socket
15493 (typically because the socket is already in use): &%daemon_startup_retries%&
15494 defines the number of retries after the first failure, and
15495 &%daemon_startup_sleep%& defines the length of time to wait between retries.
15496
15497 .option daemon_startup_sleep main time 30s
15498 See &%daemon_startup_retries%&.
15499
15500 .option delay_warning main "time list" 24h
15501 .cindex "warning of delay"
15502 .cindex "delay warning, specifying"
15503 .cindex "queue" "delay warning"
15504 When a message is delayed, Exim sends a warning message to the sender at
15505 intervals specified by this option. The data is a colon-separated list of times
15506 after which to send warning messages. If the value of the option is an empty
15507 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
15508 message has been in the queue for longer than the last time, the last interval
15509 between the times is used to compute subsequent warning times. For example,
15510 with
15511 .code
15512 delay_warning = 4h:8h:24h
15513 .endd
15514 the first message is sent after 4 hours, the second after 8 hours, and
15515 the third one after 24 hours. After that, messages are sent every 16 hours,
15516 because that is the interval between the last two times on the list. If you set
15517 just one time, it specifies the repeat interval. For example, with:
15518 .code
15519 delay_warning = 6h
15520 .endd
15521 messages are repeated every six hours. To stop warnings after a given time, set
15522 a very large time at the end of the list. For example:
15523 .code
15524 delay_warning = 2h:12h:99d
15525 .endd
15526 Note that the option is only evaluated at the time a delivery attempt fails,
15527 which depends on retry and queue-runner configuration.
15528 Typically retries will be configured more frequently than warning messages.
15529
15530 .option delay_warning_condition main string&!! "see below"
15531 .vindex "&$domain$&"
15532 The string is expanded at the time a warning message might be sent. If all the
15533 deferred addresses have the same domain, it is set in &$domain$& during the
15534 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
15535 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
15536 &"false"& (the comparison being done caselessly) then the warning message is
15537 not sent. The default is:
15538 .code
15539 delay_warning_condition = ${if or {\
15540   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
15541   { match{$h_precedence:}{(?i)bulk|list|junk} }\
15542   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
15543   } {no}{yes}}
15544 .endd
15545 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
15546 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
15547 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
15548 &"auto-replied"& in an &'Auto-Submitted:'& header.
15549
15550 .option deliver_drop_privilege main boolean false
15551 .cindex "unprivileged delivery"
15552 .cindex "delivery" "unprivileged"
15553 If this option is set true, Exim drops its root privilege at the start of a
15554 delivery process, and runs as the Exim user throughout. This severely restricts
15555 the kinds of local delivery that are possible, but is viable in certain types
15556 of configuration. There is a discussion about the use of root privilege in
15557 chapter &<<CHAPsecurity>>&.
15558
15559 .option deliver_queue_load_max main fixed-point unset
15560 .cindex "load average"
15561 .cindex "queue runner" "abandoning"
15562 When this option is set, a queue run is abandoned if the system load average
15563 becomes greater than the value of the option. The option has no effect on
15564 ancient operating systems on which Exim cannot determine the load average.
15565 See also &%queue_only_load%& and &%smtp_load_reserve%&.
15566
15567
15568 .option delivery_date_remove main boolean true
15569 .cindex "&'Delivery-date:'& header line"
15570 Exim's transports have an option for adding a &'Delivery-date:'& header to a
15571 message when it is delivered, in exactly the same way as &'Return-path:'& is
15572 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
15573 should not be present in incoming messages, and this option causes them to be
15574 removed at the time the message is received, to avoid any problems that might
15575 occur when a delivered message is subsequently sent on to some other recipient.
15576
15577 .option disable_fsync main boolean false
15578 .cindex "&[fsync()]&, disabling"
15579 This option is available only if Exim was built with the compile-time option
15580 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
15581 a runtime configuration generates an &"unknown option"& error. You should not
15582 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
15583 really, really, really understand what you are doing. &'No pre-compiled
15584 distributions of Exim should ever make this option available.'&
15585
15586 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
15587 updated files' data to be written to disc before continuing. Unexpected events
15588 such as crashes and power outages may cause data to be lost or scrambled.
15589 Here be Dragons. &*Beware.*&
15590
15591
15592 .option disable_ipv6 main boolean false
15593 .cindex "IPv6" "disabling"
15594 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
15595 activities take place. AAAA records are never looked up, and any IPv6 addresses
15596 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
15597 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
15598 to handle IPv6 literal addresses.
15599
15600
15601 .option dkim_verify_hashes main "string list" "sha256 : sha512"
15602 .cindex DKIM "selecting signature algorithms"
15603 This option gives a list of hash types which are acceptable in signatures,
15604 and an order of processing.
15605 Signatures with algorithms not in the list will be ignored.
15606
15607 Acceptable values include:
15608 .code
15609 sha1
15610 sha256
15611 sha512
15612 .endd
15613
15614 Note that the acceptance of sha1 violates RFC 8301.
15615
15616 .option dkim_verify_keytypes main "string list" "ed25519 : rsa"
15617 This option gives a list of key types which are acceptable in signatures,
15618 and an order of processing.
15619 Signatures with algorithms not in the list will be ignored.
15620
15621
15622 .option dkim_verify_min_keysizes main "string list" "rsa=1024 ed25519=250"
15623 This option gives a list of key sizes which are acceptable in signatures.
15624 The list is keyed by the algorithm type for the key; the values are in bits.
15625 Signatures with keys smaller than given by this option will fail verification.
15626
15627 The default enforces the RFC 8301 minimum key size for RSA signatures.
15628
15629 .option dkim_verify_minimal main boolean false
15630 If set to true, verification of signatures will terminate after the
15631 first success.
15632
15633 .option dkim_verify_signers main "domain list&!!" $dkim_signers
15634 .cindex DKIM "controlling calls to the ACL"
15635 This option gives a list of DKIM domains for which the DKIM ACL is run.
15636 It is expanded after the message is received; by default it runs
15637 the ACL once for each signature in the message.
15638 See section &<<SECDKIMVFY>>&.
15639
15640
15641 .option dmarc_forensic_sender main string&!! unset
15642 .option dmarc_history_file main string unset
15643 .option dmarc_tld_file main string unset
15644 .cindex DMARC "main section options"
15645 These options control DMARC processing.
15646 See section &<<SECDMARC>>& for details.
15647
15648
15649 .option dns_again_means_nonexist main "domain list&!!" unset
15650 .cindex "DNS" "&""try again""& response; overriding"
15651 DNS lookups give a &"try again"& response for the DNS errors
15652 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
15653 keep trying to deliver a message, or to give repeated temporary errors to
15654 incoming mail. Sometimes the effect is caused by a badly set up name server and
15655 may persist for a long time. If a domain which exhibits this problem matches
15656 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
15657 This option should be used with care. You can make it apply to reverse lookups
15658 by a setting such as this:
15659 .code
15660 dns_again_means_nonexist = *.in-addr.arpa
15661 .endd
15662 This option applies to all DNS lookups that Exim does. It also applies when the
15663 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
15664 since these are most likely to be caused by DNS lookup problems. The
15665 &(dnslookup)& router has some options of its own for controlling what happens
15666 when lookups for MX or SRV records give temporary errors. These more specific
15667 options are applied after this global option.
15668
15669 .option dns_check_names_pattern main string "see below"
15670 .cindex "DNS" "pre-check of name syntax"
15671 When this option is set to a non-empty string, it causes Exim to check domain
15672 names for characters that are not allowed in host names before handing them to
15673 the DNS resolver, because some resolvers give temporary errors for names that
15674 contain unusual characters. If a domain name contains any unwanted characters,
15675 a &"not found"& result is forced, and the resolver is not called. The check is
15676 done by matching the domain name against a regular expression, which is the
15677 value of this option. The default pattern is
15678 .code
15679 dns_check_names_pattern = \
15680   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
15681 .endd
15682 which permits only letters, digits, slashes, and hyphens in components, but
15683 they must start and end with a letter or digit. Slashes are not, in fact,
15684 permitted in host names, but they are found in certain NS records (which can be
15685 accessed in Exim by using a &%dnsdb%& lookup). If you set
15686 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
15687 empty string.
15688
15689 .option dns_csa_search_limit main integer 5
15690 This option controls the depth of parental searching for CSA SRV records in the
15691 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
15692
15693 .option dns_csa_use_reverse main boolean true
15694 This option controls whether or not an IP address, given as a CSA domain, is
15695 reversed and looked up in the reverse DNS, as described in more detail in
15696 section &<<SECTverifyCSA>>&.
15697
15698 .option dns_cname_loops main integer 1
15699 .cindex DNS "CNAME following"
15700 This option controls the following of CNAME chains, needed if the resolver does
15701 not do it internally.
15702 As of 2018 most should, and the default can be left.
15703 If you have an ancient one, a value of 10 is likely needed.
15704
15705 The default value of one CNAME-follow is needed
15706 thanks to the observed return for an MX request,
15707 given no MX presence but a CNAME to an A, of the CNAME.
15708
15709
15710 .option dns_dnssec_ok main integer -1
15711 .cindex "DNS" "resolver options"
15712 .cindex "DNS" "DNSSEC"
15713 If this option is set to a non-negative number then Exim will initialise the
15714 DNS resolver library to either use or not use DNSSEC, overriding the system
15715 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
15716
15717 If the resolver library does not support DNSSEC then this option has no effect.
15718
15719 On Linux with glibc 2.31 or newer this is insufficient, the resolver library
15720 will default to stripping out a successful validation status.
15721 This will break a previously working Exim installation.
15722 Provided that you do trust the resolver (ie, is on localhost) you can tell
15723 glibc to pass through any successful validation with a new option in
15724 &_/etc/resolv.conf_&:
15725 .code
15726 options trust-ad
15727 .endd
15728
15729
15730 .option dns_ipv4_lookup main "domain list&!!" unset
15731 .cindex "IPv6" "DNS lookup for AAAA records"
15732 .cindex "DNS" "IPv6 lookup for AAAA records"
15733 .cindex DNS "IPv6 disabling"
15734 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
15735 looks for IPv6 address records (AAAA records) as well as IPv4 address records
15736 (A records) when trying to find IP addresses for hosts, unless the host's
15737 domain matches this list.
15738
15739 This is a fudge to help with name servers that give big delays or otherwise do
15740 not work for the AAAA record type. In due course, when the world's name
15741 servers have all been upgraded, there should be no need for this option.
15742 Note that all lookups, including those done for verification, are affected;
15743 this will result in verify failure for IPv6 connections or ones using names
15744 only valid for IPv6 addresses.
15745
15746
15747 .option dns_retrans main time 0s
15748 .cindex "DNS" "resolver options"
15749 .cindex timeout "dns lookup"
15750 .cindex "DNS" timeout
15751 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
15752 retransmission and retry parameters for DNS lookups. Values of zero (the
15753 defaults) leave the system default settings unchanged. The first value is the
15754 time between retries, and the second is the number of retries. It isn't
15755 totally clear exactly how these settings affect the total time a DNS lookup may
15756 take. I haven't found any documentation about timeouts on DNS lookups; these
15757 parameter values are available in the external resolver interface structure,
15758 but nowhere does it seem to describe how they are used or what you might want
15759 to set in them.
15760 See also the &%slow_lookup_log%& option.
15761
15762
15763 .option dns_retry main integer 0
15764 See &%dns_retrans%& above.
15765
15766
15767 .option dns_trust_aa main "domain list&!!" unset
15768 .cindex "DNS" "resolver options"
15769 .cindex "DNS" "DNSSEC"
15770 If this option is set then lookup results marked with the AA bit
15771 (Authoritative Answer) are trusted the same way as if they were
15772 DNSSEC-verified. The authority section's name of the answer must
15773 match with this expanded domain list.
15774
15775 Use this option only if you talk directly to a resolver that is
15776 authoritative for some zones and does not set the AD (Authentic Data)
15777 bit in the answer. Some DNS servers may have an configuration option to
15778 mark the answers from their own zones as verified (they set the AD bit).
15779 Others do not have this option. It is considered as poor practice using
15780 a resolver that is an authoritative server for some zones.
15781
15782 Use this option only if you really have to (e.g. if you want
15783 to use DANE for remote delivery to a server that is listed in the DNS
15784 zones that your resolver is authoritative for).
15785
15786 If the DNS answer packet has the AA bit set and contains resource record
15787 in the answer section, the name of the first NS record appearing in the
15788 authority section is compared against the list. If the answer packet is
15789 authoritative but the answer section is empty, the name of the first SOA
15790 record in the authoritative section is used instead.
15791
15792 .cindex "DNS" "resolver options"
15793 .option dns_use_edns0 main integer -1
15794 .cindex "DNS" "resolver options"
15795 .cindex "DNS" "EDNS0"
15796 .cindex "DNS" "OpenBSD
15797 If this option is set to a non-negative number then Exim will initialise the
15798 DNS resolver library to either use or not use EDNS0 extensions, overriding
15799 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
15800 on.
15801
15802 If the resolver library does not support EDNS0 then this option has no effect.
15803
15804 OpenBSD's asr resolver routines are known to ignore the EDNS0 option; this
15805 means that DNSSEC will not work with Exim on that platform either, unless Exim
15806 is linked against an alternative DNS client library.
15807
15808
15809 .option drop_cr main boolean false
15810 This is an obsolete option that is now a no-op. It used to affect the way Exim
15811 handled CR and LF characters in incoming messages. What happens now is
15812 described in section &<<SECTlineendings>>&.
15813
15814 .option dsn_advertise_hosts main "host list&!!" unset
15815 .cindex "bounce messages" "success"
15816 .cindex "DSN" "success"
15817 .cindex "Delivery Status Notification" "success"
15818 .cindex "ESMTP extensions" DSN
15819 DSN extensions (RFC3461) will be advertised in the EHLO message to,
15820 and accepted from, these hosts.
15821 Hosts may use the NOTIFY and ENVID options on RCPT TO commands,
15822 and RET and ORCPT options on MAIL FROM commands.
15823 A NOTIFY=SUCCESS option requests success-DSN messages.
15824 A NOTIFY= option with no argument requests that no delay or failure DSNs
15825 are sent.
15826 &*Note*&: Supplying success-DSN messages has been criticised
15827 on privacy grounds; it can leak details of internal forwarding.
15828
15829 .option dsn_from main "string&!!" "see below"
15830 .cindex "&'From:'& header line" "in bounces"
15831 .cindex "bounce messages" "&'From:'& line, specifying"
15832 This option can be used to vary the contents of &'From:'& header lines in
15833 bounces and other automatically generated messages (&"Delivery Status
15834 Notifications"& &-- hence the name of the option). The default setting is:
15835 .code
15836 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
15837 .endd
15838 The value is expanded every time it is needed. If the expansion fails, a
15839 panic is logged, and the default value is used.
15840
15841 .option envelope_to_remove main boolean true
15842 .cindex "&'Envelope-to:'& header line"
15843 Exim's transports have an option for adding an &'Envelope-to:'& header to a
15844 message when it is delivered, in exactly the same way as &'Return-path:'& is
15845 handled. &'Envelope-to:'& records the original recipient address from the
15846 message's envelope that caused the delivery to happen. Such headers should not
15847 be present in incoming messages, and this option causes them to be removed at
15848 the time the message is received, to avoid any problems that might occur when a
15849 delivered message is subsequently sent on to some other recipient.
15850
15851
15852 .option errors_copy main "string list&!!" unset
15853 .cindex "bounce message" "copy to other address"
15854 .cindex "copy of bounce message"
15855 Setting this option causes Exim to send bcc copies of bounce messages that it
15856 generates to other addresses. &*Note*&: This does not apply to bounce messages
15857 coming from elsewhere. The value of the option is a colon-separated list of
15858 items. Each item consists of a pattern, terminated by white space, followed by
15859 a comma-separated list of email addresses. If a pattern contains spaces, it
15860 must be enclosed in double quotes.
15861
15862 Each pattern is processed in the same way as a single item in an address list
15863 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
15864 the bounce message, the message is copied to the addresses on the list. The
15865 items are scanned in order, and once a matching one is found, no further items
15866 are examined. For example:
15867 .code
15868 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
15869               rqps@mydomain   hostmaster@mydomain.example,\
15870                               postmaster@mydomain.example
15871 .endd
15872 .vindex "&$domain$&"
15873 .vindex "&$local_part$&"
15874 The address list is expanded before use. The expansion variables &$local_part$&
15875 and &$domain$& are set from the original recipient of the error message, and if
15876 there was any wildcard matching in the pattern, the expansion
15877 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
15878 variables &$0$&, &$1$&, etc. are set in the normal way.
15879
15880
15881 .option errors_reply_to main string unset
15882 .cindex "bounce message" "&'Reply-to:'& in"
15883 By default, Exim's bounce and delivery warning messages contain the header line
15884 .display
15885 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
15886 .endd
15887 .oindex &%quota_warn_message%&
15888 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
15889 A warning message that is generated by the &%quota_warn_message%& option in an
15890 &(appendfile)& transport may contain its own &'From:'& header line that
15891 overrides the default.
15892
15893 Experience shows that people reply to bounce messages. If the
15894 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
15895 and warning messages. For example:
15896 .code
15897 errors_reply_to = postmaster@my.domain.example
15898 .endd
15899 The value of the option is not expanded. It must specify a valid RFC 2822
15900 address. However, if a warning message that is generated by the
15901 &%quota_warn_message%& option in an &(appendfile)& transport contain its
15902 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
15903 not used.
15904
15905
15906 .option event_action main string&!! unset
15907 .cindex events
15908 This option declares a string to be expanded for Exim's events mechanism.
15909 For details see chapter &<<CHAPevents>>&.
15910
15911
15912 .option exim_group main string "compile-time configured"
15913 .cindex "gid (group id)" "Exim's own"
15914 .cindex "Exim group"
15915 This option changes the gid under which Exim runs when it gives up root
15916 privilege. The default value is compiled into the binary. The value of this
15917 option is used only when &%exim_user%& is also set. Unless it consists entirely
15918 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
15919 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
15920 security issues.
15921
15922
15923 .option exim_path main string "see below"
15924 .cindex "Exim binary, path name"
15925 This option specifies the path name of the Exim binary, which is used when Exim
15926 needs to re-exec itself. The default is set up to point to the file &'exim'& in
15927 the directory configured at compile time by the BIN_DIRECTORY setting. It
15928 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
15929 other place.
15930 &*Warning*&: Do not use a macro to define the value of this option, because
15931 you will break those Exim utilities that scan the configuration file to find
15932 where the binary is. (They then use the &%-bP%& option to extract option
15933 settings such as the value of &%spool_directory%&.)
15934
15935
15936 .option exim_user main string "compile-time configured"
15937 .cindex "uid (user id)" "Exim's own"
15938 .cindex "Exim user"
15939 This option changes the uid under which Exim runs when it gives up root
15940 privilege. The default value is compiled into the binary. Ownership of the run
15941 time configuration file and the use of the &%-C%& and &%-D%& command line
15942 options is checked against the values in the binary, not what is set here.
15943
15944 Unless it consists entirely of digits, the string is looked up using
15945 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
15946 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
15947 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
15948
15949
15950 .option exim_version main string "current version"
15951 .cindex "Exim version"
15952 .cindex customizing "version number"
15953 .cindex "version number of Exim" override
15954 This option overrides the &$version_number$&/&$exim_version$& that Exim reports in
15955 various places.  Use with care; this may fool stupid security scanners.
15956
15957
15958 .option extra_local_interfaces main "string list" unset
15959 This option defines network interfaces that are to be considered local when
15960 routing, but which are not used for listening by the daemon. See section
15961 &<<SECTreclocipadd>>& for details.
15962
15963
15964 . Allow this long option name to split; give it unsplit as a fifth argument
15965 . for the automatic .oindex that is generated by .option.
15966
15967 .option "extract_addresses_remove_arguments" main boolean true &&&
15968          extract_addresses_remove_arguments
15969 .oindex "&%-t%&"
15970 .cindex "command line" "addresses with &%-t%&"
15971 .cindex "Sendmail compatibility" "&%-t%& option"
15972 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
15973 are present on the command line when the &%-t%& option is used to build an
15974 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
15975 line addresses are removed from the recipients list. This is also how Smail
15976 behaves. However, other Sendmail documentation (the O'Reilly book) states that
15977 command line addresses are added to those obtained from the header lines. When
15978 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
15979 argument headers. If it is set false, Exim adds rather than removes argument
15980 addresses.
15981
15982
15983 .option finduser_retries main integer 0
15984 .cindex "NIS, retrying user lookups"
15985 On systems running NIS or other schemes in which user and group information is
15986 distributed from a remote system, there can be times when &[getpwnam()]& and
15987 related functions fail, even when given valid data, because things time out.
15988 Unfortunately these failures cannot be distinguished from genuine &"not found"&
15989 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
15990 many extra times to find a user or a group, waiting for one second between
15991 retries.
15992
15993 .cindex "&_/etc/passwd_&" "multiple reading of"
15994 You should not set this option greater than zero if your user information is in
15995 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
15996 search the file multiple times for non-existent users, and also cause delay.
15997
15998
15999
16000 .option freeze_tell main "string list, comma separated" unset
16001 .cindex "freezing messages" "sending a message when freezing"
16002 On encountering certain errors, or when configured to do so in a system filter,
16003 ACL, or special router, Exim freezes a message. This means that no further
16004 delivery attempts take place until an administrator thaws the message, or the
16005 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
16006 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
16007 warning message whenever it freezes something, unless the message it is
16008 freezing is a locally-generated bounce message. (Without this exception there
16009 is the possibility of looping.) The warning message is sent to the addresses
16010 supplied as the comma-separated value of this option. If several of the
16011 message's addresses cause freezing, only a single message is sent. If the
16012 freezing was automatic, the reason(s) for freezing can be found in the message
16013 log. If you configure freezing in a filter or ACL, you must arrange for any
16014 logging that you require.
16015
16016
16017 .option gecos_name main string&!! unset
16018 .cindex "HP-UX"
16019 .cindex "&""gecos""& field, parsing"
16020 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
16021 password file to hold other information in addition to users' real names. Exim
16022 looks up this field for use when it is creating &'Sender:'& or &'From:'&
16023 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
16024 of the field are used unchanged, except that, if an ampersand is encountered,
16025 it is replaced by the user's login name with the first character forced to
16026 upper case, since this is a convention that is observed on many systems.
16027
16028 When these options are set, &%gecos_pattern%& is treated as a regular
16029 expression that is to be applied to the field (again with && replaced by the
16030 login name), and if it matches, &%gecos_name%& is expanded and used as the
16031 user's name.
16032
16033 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
16034 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
16035 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
16036 name terminates at the first comma, the following can be used:
16037 .code
16038 gecos_pattern = ([^,]*)
16039 gecos_name = $1
16040 .endd
16041
16042 .option gecos_pattern main string unset
16043 See &%gecos_name%& above.
16044
16045
16046 .option gnutls_compat_mode main boolean unset
16047 This option controls whether GnuTLS is used in compatibility mode in an Exim
16048 server. This reduces security slightly, but improves interworking with older
16049 implementations of TLS.
16050
16051
16052 .option gnutls_allow_auto_pkcs11 main boolean unset
16053 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
16054 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
16055
16056 See
16057 &url(https://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
16058 for documentation.
16059
16060
16061
16062 .option headers_charset main string "see below"
16063 This option sets a default character set for translating from encoded MIME
16064 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
16065 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
16066 ultimate default is ISO-8859-1. For more details see the description of header
16067 insertions in section &<<SECTexpansionitems>>&.
16068
16069
16070
16071 .option header_maxsize main integer "see below"
16072 .cindex "header section" "maximum size of"
16073 .cindex "limit" "size of message header section"
16074 This option controls the overall maximum size of a message's header
16075 section. The default is the value of HEADER_MAXSIZE in
16076 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
16077 sections are rejected.
16078
16079
16080 .option header_line_maxsize main integer 0
16081 .cindex "header lines" "maximum size of"
16082 .cindex "limit" "size of one header line"
16083 This option limits the length of any individual header line in a message, after
16084 all the continuations have been joined together. Messages with individual
16085 header lines that are longer than the limit are rejected. The default value of
16086 zero means &"no limit"&.
16087
16088
16089
16090
16091 .option helo_accept_junk_hosts main "host list&!!" unset
16092 .cindex "HELO" "accepting junk data"
16093 .cindex "EHLO" "accepting junk data"
16094 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
16095 mail, and gives an error response for invalid data. Unfortunately, there are
16096 some SMTP clients that send syntactic junk. They can be accommodated by setting
16097 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
16098 if you want to do semantic checking.
16099 See also &%helo_allow_chars%& for a way of extending the permitted character
16100 set.
16101
16102
16103 .option helo_allow_chars main string unset
16104 .cindex "HELO" "underscores in"
16105 .cindex "EHLO" "underscores in"
16106 .cindex "underscore in EHLO/HELO"
16107 This option can be set to a string of rogue characters that are permitted in
16108 all EHLO and HELO names in addition to the standard letters, digits,
16109 hyphens, and dots. If you really must allow underscores, you can set
16110 .code
16111 helo_allow_chars = _
16112 .endd
16113 Note that the value is one string, not a list.
16114
16115
16116 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
16117 .cindex "HELO" "forcing reverse lookup"
16118 .cindex "EHLO" "forcing reverse lookup"
16119 If the domain given by a client in a HELO or EHLO command matches this
16120 list, a reverse lookup is done in order to establish the host's true name. The
16121 default forces a lookup if the client host gives the server's name or any of
16122 its IP addresses (in brackets), something that broken clients have been seen to
16123 do.
16124
16125
16126 .option helo_try_verify_hosts main "host list&!!" unset
16127 .cindex "HELO verifying" "optional"
16128 .cindex "EHLO" "verifying, optional"
16129 By default, Exim just checks the syntax of HELO and EHLO commands (see
16130 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
16131 to do more extensive checking of the data supplied by these commands. The ACL
16132 condition &`verify = helo`& is provided to make this possible.
16133 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
16134 to force the check to occur. From release 4.53 onwards, this is no longer
16135 necessary. If the check has not been done before &`verify = helo`& is
16136 encountered, it is done at that time. Consequently, this option is obsolete.
16137 Its specification is retained here for backwards compatibility.
16138
16139 When an EHLO or HELO command is received, if the calling host matches
16140 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
16141 EHLO command either:
16142
16143 .ilist
16144 is an IP literal matching the calling address of the host, or
16145 .next
16146 .cindex "DNS" "reverse lookup"
16147 .cindex "reverse DNS lookup"
16148 matches the host name that Exim obtains by doing a reverse lookup of the
16149 calling host address, or
16150 .next
16151 when looked up in DNS yields the calling host address.
16152 .endlist
16153
16154 However, the EHLO or HELO command is not rejected if any of the checks
16155 fail. Processing continues, but the result of the check is remembered, and can
16156 be detected later in an ACL by the &`verify = helo`& condition.
16157
16158 If DNS was used for successful verification, the variable
16159 .cindex "DNS" "DNSSEC"
16160 &$helo_verify_dnssec$& records the DNSSEC status of the lookups.
16161
16162 .option helo_verify_hosts main "host list&!!" unset
16163 .cindex "HELO verifying" "mandatory"
16164 .cindex "EHLO" "verifying, mandatory"
16165 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
16166 backwards compatibility. For hosts that match this option, Exim checks the host
16167 name given in the HELO or EHLO in the same way as for
16168 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
16169 rejected with a 550 error, and entries are written to the main and reject logs.
16170 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
16171 error.
16172
16173 .option hold_domains main "domain list&!!" unset
16174 .cindex "domain" "delaying delivery"
16175 .cindex "delivery" "delaying certain domains"
16176 This option allows mail for particular domains to be held in the queue
16177 manually. The option is overridden if a message delivery is forced with the
16178 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
16179 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
16180 item in &%hold_domains%&, no routing or delivery for that address is done, and
16181 it is deferred every time the message is looked at.
16182
16183 This option is intended as a temporary operational measure for delaying the
16184 delivery of mail while some problem is being sorted out, or some new
16185 configuration tested. If you just want to delay the processing of some
16186 domains until a queue run occurs, you should use &%queue_domains%& or
16187 &%queue_smtp_domains%&, not &%hold_domains%&.
16188
16189 A setting of &%hold_domains%& does not override Exim's code for removing
16190 messages from the queue if they have been there longer than the longest retry
16191 time in any retry rule. If you want to hold messages for longer than the normal
16192 retry times, insert a dummy retry rule with a long retry time.
16193
16194
16195 .option host_lookup main "host list&!!" unset
16196 .cindex "host name" "lookup, forcing"
16197 Exim does not look up the name of a calling host from its IP address unless it
16198 is required to compare against some host list, or the host matches
16199 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
16200 option (which normally contains IP addresses rather than host names). The
16201 default configuration file contains
16202 .code
16203 host_lookup = *
16204 .endd
16205 which causes a lookup to happen for all hosts. If the expense of these lookups
16206 is felt to be too great, the setting can be changed or removed.
16207
16208 After a successful reverse lookup, Exim does a forward lookup on the name it
16209 has obtained, to verify that it yields the IP address that it started with. If
16210 this check fails, Exim behaves as if the name lookup failed.
16211
16212 .vindex "&$host_lookup_failed$&"
16213 .vindex "&$sender_host_name$&"
16214 After any kind of failure, the host name (in &$sender_host_name$&) remains
16215 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
16216 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
16217 &`verify = reverse_host_lookup`& in ACLs.
16218
16219
16220 .option host_lookup_order main "string list" &`bydns:byaddr`&
16221 This option specifies the order of different lookup methods when Exim is trying
16222 to find a host name from an IP address. The default is to do a DNS lookup
16223 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
16224 if that fails. You can change the order of these lookups, or omit one entirely,
16225 if you want.
16226
16227 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
16228 multiple PTR records in the DNS and the IP address is not listed in
16229 &_/etc/hosts_&. Different operating systems give different results in this
16230 case. That is why the default tries a DNS lookup first.
16231
16232
16233
16234 .option host_reject_connection main "host list&!!" unset
16235 .cindex "host" "rejecting connections from"
16236 If this option is set, incoming SMTP calls from the hosts listed are rejected
16237 as soon as the connection is made.
16238 This option is obsolete, and retained only for backward compatibility, because
16239 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
16240 connections immediately.
16241
16242 The ability to give an immediate rejection (either by this option or using an
16243 ACL) is provided for use in unusual cases. Many hosts will just try again,
16244 sometimes without much delay. Normally, it is better to use an ACL to reject
16245 incoming messages at a later stage, such as after RCPT commands. See
16246 chapter &<<CHAPACL>>&.
16247
16248
16249 .option hosts_connection_nolog main "host list&!!" unset
16250 .cindex "host" "not logging connections from"
16251 This option defines a list of hosts for which connection logging does not
16252 happen, even though the &%smtp_connection%& log selector is set. For example,
16253 you might want not to log SMTP connections from local processes, or from
16254 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
16255 the daemon; you should therefore strive to restrict its value to a short inline
16256 list of IP addresses and networks. To disable logging SMTP connections from
16257 local processes, you must create a host list with an empty item. For example:
16258 .code
16259 hosts_connection_nolog = :
16260 .endd
16261 If the &%smtp_connection%& log selector is not set, this option has no effect.
16262
16263
16264
16265 .option hosts_proxy main "host list&!!" unset
16266 .cindex proxy "proxy protocol"
16267 This option enables use of Proxy Protocol proxies for incoming
16268 connections.  For details see section &<<SECTproxyInbound>>&.
16269
16270
16271 .option hosts_treat_as_local main "domain list&!!" unset
16272 .cindex "local host" "domains treated as"
16273 .cindex "host" "treated as local"
16274 If this option is set, any host names that match the domain list are treated as
16275 if they were the local host when Exim is scanning host lists obtained from MX
16276 records
16277 or other sources. Note that the value of this option is a domain list, not a
16278 host list, because it is always used to check host names, not IP addresses.
16279
16280 This option also applies when Exim is matching the special items
16281 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
16282 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
16283 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
16284 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
16285 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
16286 interfaces and recognizing the local host.
16287
16288
16289 .option ibase_servers main "string list" unset
16290 .cindex "InterBase" "server list"
16291 This option provides a list of InterBase servers and associated connection data,
16292 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
16293 The option is available only if Exim has been built with InterBase support.
16294
16295
16296
16297 .option ignore_bounce_errors_after main time 10w
16298 .cindex "bounce message" "discarding"
16299 .cindex "discarding bounce message"
16300 This option affects the processing of bounce messages that cannot be delivered,
16301 that is, those that suffer a permanent delivery failure. (Bounce messages that
16302 suffer temporary delivery failures are of course retried in the usual way.)
16303
16304 After a permanent delivery failure, bounce messages are frozen,
16305 because there is no sender to whom they can be returned. When a frozen bounce
16306 message has been in the queue for more than the given time, it is unfrozen at
16307 the next queue run, and a further delivery is attempted. If delivery fails
16308 again, the bounce message is discarded. This makes it possible to keep failed
16309 bounce messages around for a shorter time than the normal maximum retry time
16310 for frozen messages. For example,
16311 .code
16312 ignore_bounce_errors_after = 12h
16313 .endd
16314 retries failed bounce message deliveries after 12 hours, discarding any further
16315 failures. If the value of this option is set to a zero time period, bounce
16316 failures are discarded immediately. Setting a very long time (as in the default
16317 value) has the effect of disabling this option. For ways of automatically
16318 dealing with other kinds of frozen message, see &%auto_thaw%& and
16319 &%timeout_frozen_after%&.
16320
16321
16322 .option ignore_fromline_hosts main "host list&!!" unset
16323 .cindex "&""From""& line"
16324 .cindex "UUCP" "&""From""& line"
16325 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
16326 the headers of a message. By default this is treated as the start of the
16327 message's body, which means that any following headers are not recognized as
16328 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
16329 match those hosts that insist on sending it. If the sender is actually a local
16330 process rather than a remote host, and is using &%-bs%& to inject the messages,
16331 &%ignore_fromline_local%& must be set to achieve this effect.
16332
16333
16334 .option ignore_fromline_local main boolean false
16335 See &%ignore_fromline_hosts%& above.
16336
16337 .option keep_environment main "string list" unset
16338 .cindex "environment" "values from"
16339 This option contains a string list of environment variables to keep.
16340 You have to trust these variables or you have to be sure that
16341 these variables do not impose any security risk. Keep in mind that
16342 during the startup phase Exim is running with an effective UID 0 in most
16343 installations. As the default value is an empty list, the default
16344 environment for using libraries, running embedded Perl code, or running
16345 external binaries is empty, and does not not even contain PATH or HOME.
16346
16347 Actually the list is interpreted as a list of patterns
16348 (&<<SECTlistexpand>>&), except that it is not expanded first.
16349
16350 WARNING: Macro substitution is still done first, so having a macro
16351 FOO and having FOO_HOME in your &%keep_environment%& option may have
16352 unexpected results. You may work around this using a regular expression
16353 that does not match the macro name: ^[F]OO_HOME$.
16354
16355 Current versions of Exim issue a warning during startup if you do not mention
16356 &%keep_environment%& in your runtime configuration file and if your
16357 current environment is not empty. Future versions may not issue that warning
16358 anymore.
16359
16360 See the &%add_environment%& main config option for a way to set
16361 environment variables to a fixed value.  The environment for &(pipe)&
16362 transports is handled separately, see section &<<SECTpipeenv>>& for
16363 details.
16364
16365
16366 .option keep_malformed main time 4d
16367 This option specifies the length of time to keep messages whose spool files
16368 have been corrupted in some way. This should, of course, never happen. At the
16369 next attempt to deliver such a message, it gets removed. The incident is
16370 logged.
16371
16372
16373 .option ldap_ca_cert_dir main string unset
16374 .cindex "LDAP", "TLS CA certificate directory"
16375 .cindex certificate "directory for LDAP"
16376 This option indicates which directory contains CA certificates for verifying
16377 a TLS certificate presented by an LDAP server.
16378 While Exim does not provide a default value, your SSL library may.
16379 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
16380 and constrained to be a directory.
16381
16382
16383 .option ldap_ca_cert_file main string unset
16384 .cindex "LDAP", "TLS CA certificate file"
16385 .cindex certificate "file for LDAP"
16386 This option indicates which file contains CA certificates for verifying
16387 a TLS certificate presented by an LDAP server.
16388 While Exim does not provide a default value, your SSL library may.
16389 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
16390 and constrained to be a file.
16391
16392
16393 .option ldap_cert_file main string unset
16394 .cindex "LDAP" "TLS client certificate file"
16395 .cindex certificate "file for LDAP"
16396 This option indicates which file contains an TLS client certificate which
16397 Exim should present to the LDAP server during TLS negotiation.
16398 Should be used together with &%ldap_cert_key%&.
16399
16400
16401 .option ldap_cert_key main string unset
16402 .cindex "LDAP" "TLS client key file"
16403 .cindex certificate "key for LDAP"
16404 This option indicates which file contains the secret/private key to use
16405 to prove identity to the LDAP server during TLS negotiation.
16406 Should be used together with &%ldap_cert_file%&, which contains the
16407 identity to be proven.
16408
16409
16410 .option ldap_cipher_suite main string unset
16411 .cindex "LDAP" "TLS cipher suite"
16412 This controls the TLS cipher-suite negotiation during TLS negotiation with
16413 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
16414 cipher-suite options with OpenSSL (as used by LDAP client libraries).
16415
16416
16417 .option ldap_default_servers main "string list" unset
16418 .cindex "LDAP" "default servers"
16419 This option provides a list of LDAP servers which are tried in turn when an
16420 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
16421 details of LDAP queries. This option is available only when Exim has been built
16422 with LDAP support.
16423
16424
16425 .option ldap_require_cert main string unset.
16426 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
16427 This should be one of the values "hard", "demand", "allow", "try" or "never".
16428 A value other than one of these is interpreted as "never".
16429 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
16430 Although Exim does not set a default, the LDAP library probably defaults
16431 to hard/demand.
16432
16433
16434 .option ldap_start_tls main boolean false
16435 .cindex "LDAP" "whether or not to negotiate TLS"
16436 If set, Exim will attempt to negotiate TLS with the LDAP server when
16437 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
16438 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
16439 of SSL-on-connect.
16440 In the event of failure to negotiate TLS, the action taken is controlled
16441 by &%ldap_require_cert%&.
16442 This option is ignored for &`ldapi`& connections.
16443
16444
16445 .option ldap_version main integer unset
16446 .cindex "LDAP" "protocol version, forcing"
16447 This option can be used to force Exim to set a specific protocol version for
16448 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
16449 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
16450 the LDAP headers; otherwise it is 2. This option is available only when Exim
16451 has been built with LDAP support.
16452
16453
16454
16455 .option local_from_check main boolean true
16456 .cindex "&'Sender:'& header line" "disabling addition of"
16457 .cindex "&'From:'& header line" "disabling checking of"
16458 When a message is submitted locally (that is, not over a TCP/IP connection) by
16459 an untrusted user, Exim removes any existing &'Sender:'& header line, and
16460 checks that the &'From:'& header line matches the login of the calling user and
16461 the domain specified by &%qualify_domain%&.
16462
16463 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
16464 locally submitted message is automatically qualified by Exim, unless the
16465 &%-bnq%& command line option is used.
16466
16467 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
16468 on the local part. If the &'From:'& header line does not match, Exim adds a
16469 &'Sender:'& header with an address constructed from the calling user's login
16470 and the default qualify domain.
16471
16472 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
16473 and no &'Sender:'& header is ever added. If, in addition, you want to retain
16474 &'Sender:'& header lines supplied by untrusted users, you must also set
16475 &%local_sender_retain%& to be true.
16476
16477 .cindex "envelope from"
16478 .cindex "envelope sender"
16479 These options affect only the header lines in the message. The envelope sender
16480 is still forced to be the login id at the qualify domain unless
16481 &%untrusted_set_sender%& permits the user to supply an envelope sender.
16482
16483 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
16484 request similar header line checking. See section &<<SECTthesenhea>>&, which
16485 has more details about &'Sender:'& processing.
16486
16487
16488
16489
16490 .option local_from_prefix main string unset
16491 When Exim checks the &'From:'& header line of locally submitted messages for
16492 matching the login id (see &%local_from_check%& above), it can be configured to
16493 ignore certain prefixes and suffixes in the local part of the address. This is
16494 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
16495 appropriate lists, in the same form as the &%local_part_prefix%& and
16496 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
16497 example, if
16498 .code
16499 local_from_prefix = *-
16500 .endd
16501 is set, a &'From:'& line containing
16502 .code
16503 From: anything-user@your.domain.example
16504 .endd
16505 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
16506 matches the actual sender address that is constructed from the login name and
16507 qualify domain.
16508
16509
16510 .option local_from_suffix main string unset
16511 See &%local_from_prefix%& above.
16512
16513
16514 .option local_interfaces main "string list" "see below"
16515 This option controls which network interfaces are used by the daemon for
16516 listening; they are also used to identify the local host when routing. Chapter
16517 &<<CHAPinterfaces>>& contains a full description of this option and the related
16518 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
16519 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
16520 &%local_interfaces%& is
16521 .code
16522 local_interfaces = 0.0.0.0
16523 .endd
16524 when Exim is built without IPv6 support; otherwise it is
16525 .code
16526 local_interfaces = <; ::0 ; 0.0.0.0
16527 .endd
16528
16529 .option local_scan_timeout main time 5m
16530 .cindex "timeout" "for &[local_scan()]& function"
16531 .cindex "&[local_scan()]& function" "timeout"
16532 This timeout applies to the &[local_scan()]& function (see chapter
16533 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
16534 the incoming message is rejected with a temporary error if it is an SMTP
16535 message. For a non-SMTP message, the message is dropped and Exim ends with a
16536 non-zero code. The incident is logged on the main and reject logs.
16537
16538
16539
16540 .option local_sender_retain main boolean false
16541 .cindex "&'Sender:'& header line" "retaining from local submission"
16542 When a message is submitted locally (that is, not over a TCP/IP connection) by
16543 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
16544 do not want this to happen, you must set &%local_sender_retain%&, and you must
16545 also set &%local_from_check%& to be false (Exim will complain if you do not).
16546 See also the ACL modifier &`control = suppress_local_fixups`&. Section
16547 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
16548
16549
16550
16551
16552 .option localhost_number main string&!! unset
16553 .cindex "host" "locally unique number for"
16554 .cindex "message ids" "with multiple hosts"
16555 .vindex "&$localhost_number$&"
16556 Exim's message ids are normally unique only within the local host. If
16557 uniqueness among a set of hosts is required, each host must set a different
16558 value for the &%localhost_number%& option. The string is expanded immediately
16559 after reading the configuration file (so that a number can be computed from the
16560 host name, for example) and the result of the expansion must be a number in the
16561 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
16562 systems). This is available in subsequent string expansions via the variable
16563 &$localhost_number$&. When &%localhost_number is set%&, the final two
16564 characters of the message id, instead of just being a fractional part of the
16565 time, are computed from the time and the local host number as described in
16566 section &<<SECTmessiden>>&.
16567
16568
16569
16570 .option log_file_path main "string list&!!" "set at compile time"
16571 .cindex "log" "file path for"
16572 This option sets the path which is used to determine the names of Exim's log
16573 files, or indicates that logging is to be to syslog, or both. It is expanded
16574 when Exim is entered, so it can, for example, contain a reference to the host
16575 name. If no specific path is set for the log files at compile or runtime,
16576 or if the option is unset at runtime (i.e.  &`log_file_path = `&)
16577 they are written in a sub-directory called &_log_& in Exim's spool directory.
16578 A path must start with a slash.
16579 To send to syslog, use the word &"syslog"&.
16580 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
16581 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
16582 used. If this string is fixed at your installation (contains no expansion
16583 variables) it is recommended that you do not set this option in the
16584 configuration file, but instead supply the path using LOG_FILE_PATH in
16585 &_Local/Makefile_& so that it is available to Exim for logging errors detected
16586 early on &-- in particular, failure to read the configuration file.
16587
16588
16589 .option log_selector main string unset
16590 .cindex "log" "selectors"
16591 This option can be used to reduce or increase the number of things that Exim
16592 writes to its log files. Its argument is made up of names preceded by plus or
16593 minus characters. For example:
16594 .code
16595 log_selector = +arguments -retry_defer
16596 .endd
16597 A list of possible names and what they control is given in the chapter on
16598 logging, in section &<<SECTlogselector>>&.
16599
16600
16601 .option log_timezone main boolean false
16602 .cindex "log" "timezone for entries"
16603 .vindex "&$tod_log$&"
16604 .vindex "&$tod_zone$&"
16605 By default, the timestamps on log lines are in local time without the
16606 timezone. This means that if your timezone changes twice a year, the timestamps
16607 in log lines are ambiguous for an hour when the clocks go back. One way of
16608 avoiding this problem is to set the timezone to UTC. An alternative is to set
16609 &%log_timezone%& true. This turns on the addition of the timezone offset to
16610 timestamps in log lines. Turning on this option can add quite a lot to the size
16611 of log files because each line is extended by 6 characters. Note that the
16612 &$tod_log$& variable contains the log timestamp without the zone, but there is
16613 another variable called &$tod_zone$& that contains just the timezone offset.
16614
16615
16616 .option lookup_open_max main integer 25
16617 .cindex "too many open files"
16618 .cindex "open files, too many"
16619 .cindex "file" "too many open"
16620 .cindex "lookup" "maximum open files"
16621 .cindex "limit" "open files for lookups"
16622 This option limits the number of simultaneously open files for single-key
16623 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
16624 Exim normally keeps these files open during routing, because often the same
16625 file is required several times. If the limit is reached, Exim closes the least
16626 recently used file. Note that if you are using the &'ndbm'& library, it
16627 actually opens two files for each logical DBM database, though it still counts
16628 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
16629 open files"& errors with NDBM, you need to reduce the value of
16630 &%lookup_open_max%&.
16631
16632
16633 .option max_username_length main integer 0
16634 .cindex "length of login name"
16635 .cindex "user name" "maximum length"
16636 .cindex "limit" "user name length"
16637 Some operating systems are broken in that they truncate long arguments to
16638 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
16639 this option is set greater than zero, any attempt to call &[getpwnam()]& with
16640 an argument that is longer behaves as if &[getpwnam()]& failed.
16641
16642
16643 .option message_body_newlines main bool false
16644 .cindex "message body" "newlines in variables"
16645 .cindex "newline" "in message body variables"
16646 .vindex "&$message_body$&"
16647 .vindex "&$message_body_end$&"
16648 By default, newlines in the message body are replaced by spaces when setting
16649 the &$message_body$& and &$message_body_end$& expansion variables. If this
16650 option is set true, this no longer happens.
16651
16652
16653 .option message_body_visible main integer 500
16654 .cindex "body of message" "visible size"
16655 .cindex "message body" "visible size"
16656 .vindex "&$message_body$&"
16657 .vindex "&$message_body_end$&"
16658 This option specifies how much of a message's body is to be included in the
16659 &$message_body$& and &$message_body_end$& expansion variables.
16660
16661
16662 .option message_id_header_domain main string&!! unset
16663 .cindex "&'Message-ID:'& header line"
16664 If this option is set, the string is expanded and used as the right hand side
16665 (domain) of the &'Message-ID:'& header that Exim creates if a
16666 locally-originated incoming message does not have one. &"Locally-originated"&
16667 means &"not received over TCP/IP."&
16668 Otherwise, the primary host name is used.
16669 Only letters, digits, dot and hyphen are accepted; any other characters are
16670 replaced by hyphens. If the expansion is forced to fail, or if the result is an
16671 empty string, the option is ignored.
16672
16673
16674 .option message_id_header_text main string&!! unset
16675 If this variable is set, the string is expanded and used to augment the text of
16676 the &'Message-id:'& header that Exim creates if a locally-originated incoming
16677 message does not have one. The text of this header is required by RFC 2822 to
16678 take the form of an address. By default, Exim uses its internal message id as
16679 the local part, and the primary host name as the domain. If this option is set,
16680 it is expanded, and provided the expansion is not forced to fail, and does not
16681 yield an empty string, the result is inserted into the header immediately
16682 before the @, separated from the internal message id by a dot. Any characters
16683 that are illegal in an address are automatically converted into hyphens. This
16684 means that variables such as &$tod_log$& can be used, because the spaces and
16685 colons will become hyphens.
16686
16687
16688 .option message_logs main boolean true
16689 .cindex "message logs" "disabling"
16690 .cindex "log" "message log; disabling"
16691 If this option is turned off, per-message log files are not created in the
16692 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
16693 Exim, by reducing the number of files involved in handling a message from a
16694 minimum of four (header spool file, body spool file, delivery journal, and
16695 per-message log) to three. The other major I/O activity is Exim's main log,
16696 which is not affected by this option.
16697
16698
16699 .option message_size_limit main string&!! 50M
16700 .cindex "message" "size limit"
16701 .cindex "limit" "message size"
16702 .cindex "size" "of message, limit"
16703 This option limits the maximum size of message that Exim will process. The
16704 value is expanded for each incoming connection so, for example, it can be made
16705 to depend on the IP address of the remote host for messages arriving via
16706 TCP/IP. After expansion, the value must be a sequence of decimal digits,
16707 optionally followed by K or M.
16708
16709 .cindex "SIZE" "ESMTP extension, advertising"
16710 .cindex "ESMTP extensions" SIZE
16711 If nonzero the value will be advertised as a parameter to the ESMTP SIZE
16712 service extension keyword.
16713
16714 &*Note*&: This limit cannot be made to depend on a message's sender or any
16715 other properties of an individual message, because it has to be advertised in
16716 the server's response to EHLO. String expansion failure causes a temporary
16717 error. A value of zero means no limit, but its use is not recommended. See also
16718 &%bounce_return_size_limit%&.
16719
16720 Incoming SMTP messages are failed with a 552 error if the limit is
16721 exceeded; locally-generated messages either get a stderr message or a delivery
16722 failure message to the sender, depending on the &%-oe%& setting. Rejection of
16723 an oversized message is logged in both the main and the reject logs. See also
16724 the generic transport option &%message_size_limit%&, which limits the size of
16725 message that an individual transport can process.
16726
16727 If you use a virus-scanner and set this option to to a value larger than the
16728 maximum size that your virus-scanner is configured to support, you may get
16729 failures triggered by large mails.  The right size to configure for the
16730 virus-scanner depends upon what data is passed and the options in use but it's
16731 probably safest to just set it to a little larger than this value.  E.g., with a
16732 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
16733 some problems may result.
16734
16735 A value of 0 will disable size limit checking; Exim will still advertise the
16736 SIZE extension in an EHLO response, but without a limit, so as to permit
16737 SMTP clients to still indicate the message size along with the MAIL verb.
16738
16739
16740 .option move_frozen_messages main boolean false
16741 .cindex "frozen messages" "moving"
16742 This option, which is available only if Exim has been built with the setting
16743 .code
16744 SUPPORT_MOVE_FROZEN_MESSAGES=yes
16745 .endd
16746 in &_Local/Makefile_&, causes frozen messages and their message logs to be
16747 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
16748 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
16749 standard utilities for handling such moved messages, and they do not show up in
16750 lists generated by &%-bp%& or by the Exim monitor.
16751
16752
16753 .option mua_wrapper main boolean false
16754 Setting this option true causes Exim to run in a very restrictive mode in which
16755 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
16756 contains a full description of this facility.
16757
16758
16759
16760 .option mysql_servers main "string list" unset
16761 .cindex "MySQL" "server list"
16762 This option provides a list of MySQL servers and associated connection data, to
16763 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
16764 option is available only if Exim has been built with MySQL support.
16765
16766
16767 .option never_users main "string list&!!" unset
16768 This option is expanded just once, at the start of Exim's processing. Local
16769 message deliveries are normally run in processes that are setuid to the
16770 recipient, and remote deliveries are normally run under Exim's own uid and gid.
16771 It is usually desirable to prevent any deliveries from running as root, as a
16772 safety precaution.
16773
16774 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
16775 list of users that must not be used for local deliveries. This list is fixed in
16776 the binary and cannot be overridden by the configuration file. By default, it
16777 contains just the single user name &"root"&. The &%never_users%& runtime option
16778 can be used to add more users to the fixed list.
16779
16780 If a message is to be delivered as one of the users on the fixed list or the
16781 &%never_users%& list, an error occurs, and delivery is deferred. A common
16782 example is
16783 .code
16784 never_users = root:daemon:bin
16785 .endd
16786 Including root is redundant if it is also on the fixed list, but it does no
16787 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
16788 transport driver.
16789
16790
16791 .option notifier_socket main string "$spool_directory/exim_daemon_notify"
16792 This option gives the name for a unix-domain socket on which the daemon
16793 listens for work and information-requests.
16794 Only installations running multiple daemons sharing a spool directory
16795 should need to modify the default.
16796
16797 The option is expanded before use.
16798 If the platform supports Linux-style abstract socket names, the result
16799 is used with a nul byte prefixed.
16800 Otherwise,
16801 .new "if nonempty,"
16802 it should be a full path name and use a directory accessible
16803 to Exim.
16804
16805 .new
16806 If this option is set as empty,
16807 or the command line &%-oY%& option is used, or
16808 .wen
16809 the command line uses a &%-oX%& option and does not use &%-oP%&,
16810 then a notifier socket is not created.
16811
16812
16813 .option openssl_options main "string list" "+no_sslv2 +no_sslv3 +single_dh_use +no_ticket +no_renegotiation"
16814 .cindex "OpenSSL "compatibility options"
16815 This option allows an administrator to adjust the SSL options applied
16816 by OpenSSL to connections.  It is given as a space-separated list of items,
16817 each one to be +added or -subtracted from the current value.
16818
16819 This option is only available if Exim is built against OpenSSL.  The values
16820 available for this option vary according to the age of your OpenSSL install.
16821 The &"all"& value controls a subset of flags which are available, typically
16822 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
16823 list the values known on your system and Exim should support all the
16824 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
16825 names lose the leading &"SSL_OP_"& and are lower-cased.
16826
16827 Note that adjusting the options can have severe impact upon the security of
16828 SSL as used by Exim.  It is possible to disable safety checks and shoot
16829 yourself in the foot in various unpleasant ways.  This option should not be
16830 adjusted lightly.  An unrecognised item will be detected at startup, by
16831 invoking Exim with the &%-bV%& flag.
16832
16833 The option affects Exim operating both as a server and as a client.
16834
16835 Historical note: prior to release 4.80, Exim defaulted this value to
16836 "+dont_insert_empty_fragments", which may still be needed for compatibility
16837 with some clients, but which lowers security by increasing exposure to
16838 some now infamous attacks.
16839
16840 Examples:
16841 .code
16842 # Make both old MS and old Eudora happy:
16843 openssl_options = -all +microsoft_big_sslv3_buffer \
16844                        +dont_insert_empty_fragments
16845
16846 # Disable older protocol versions:
16847 openssl_options = +no_sslv2 +no_sslv3
16848 .endd
16849
16850 Possible options may include:
16851 .ilist
16852 &`all`&
16853 .next
16854 &`allow_unsafe_legacy_renegotiation`&
16855 .next
16856 &`cipher_server_preference`&
16857 .next
16858 &`dont_insert_empty_fragments`&
16859 .next
16860 &`ephemeral_rsa`&
16861 .next
16862 &`legacy_server_connect`&
16863 .next
16864 &`microsoft_big_sslv3_buffer`&
16865 .next
16866 &`microsoft_sess_id_bug`&
16867 .next
16868 &`msie_sslv2_rsa_padding`&
16869 .next
16870 &`netscape_challenge_bug`&
16871 .next
16872 &`netscape_reuse_cipher_change_bug`&
16873 .next
16874 &`no_compression`&
16875 .next
16876 &`no_session_resumption_on_renegotiation`&
16877 .next
16878 &`no_sslv2`&
16879 .next
16880 &`no_sslv3`&
16881 .next
16882 &`no_ticket`&
16883 .next
16884 &`no_tlsv1`&
16885 .next
16886 &`no_tlsv1_1`&
16887 .next
16888 &`no_tlsv1_2`&
16889 .next
16890 &`safari_ecdhe_ecdsa_bug`&
16891 .next
16892 &`single_dh_use`&
16893 .next
16894 &`single_ecdh_use`&
16895 .next
16896 &`ssleay_080_client_dh_bug`&
16897 .next
16898 &`sslref2_reuse_cert_type_bug`&
16899 .next
16900 &`tls_block_padding_bug`&
16901 .next
16902 &`tls_d5_bug`&
16903 .next
16904 &`tls_rollback_bug`&
16905 .endlist
16906
16907 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
16908 all clients connecting using the MacOS SecureTransport TLS facility prior
16909 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
16910 to negotiate TLS then this option value might help, provided that your OpenSSL
16911 release is new enough to contain this work-around.  This may be a situation
16912 where you have to upgrade OpenSSL to get buggy clients working.
16913
16914
16915 .option oracle_servers main "string list" unset
16916 .cindex "Oracle" "server list"
16917 This option provides a list of Oracle servers and associated connection data,
16918 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
16919 The option is available only if Exim has been built with Oracle support.
16920
16921
16922 .option percent_hack_domains main "domain list&!!" unset
16923 .cindex "&""percent hack""&"
16924 .cindex "source routing" "in email address"
16925 .cindex "address" "source-routed"
16926 The &"percent hack"& is the convention whereby a local part containing a
16927 percent sign is re-interpreted as a new email address, with the percent
16928 replaced by @. This is sometimes called &"source routing"&, though that term is
16929 also applied to RFC 2822 addresses that begin with an @ character. If this
16930 option is set, Exim implements the percent facility for those domains listed,
16931 but no others. This happens before an incoming SMTP address is tested against
16932 an ACL.
16933
16934 &*Warning*&: The &"percent hack"& has often been abused by people who are
16935 trying to get round relaying restrictions. For this reason, it is best avoided
16936 if at all possible. Unfortunately, a number of less security-conscious MTAs
16937 implement it unconditionally. If you are running Exim on a gateway host, and
16938 routing mail through to internal MTAs without processing the local parts, it is
16939 a good idea to reject recipient addresses with percent characters in their
16940 local parts. Exim's default configuration does this.
16941
16942
16943 .option perl_at_start main boolean false
16944 .cindex "Perl"
16945 This option is available only when Exim is built with an embedded Perl
16946 interpreter. See chapter &<<CHAPperl>>& for details of its use.
16947
16948
16949 .option perl_startup main string unset
16950 .cindex "Perl"
16951 This option is available only when Exim is built with an embedded Perl
16952 interpreter. See chapter &<<CHAPperl>>& for details of its use.
16953
16954 .option perl_taintmode main boolean false
16955 .cindex "Perl"
16956 This option enables the taint mode of the embedded Perl interpreter.
16957
16958
16959 .option pgsql_servers main "string list" unset
16960 .cindex "PostgreSQL lookup type" "server list"
16961 This option provides a list of PostgreSQL servers and associated connection
16962 data, to be used in conjunction with &(pgsql)& lookups (see section
16963 &<<SECID72>>&). The option is available only if Exim has been built with
16964 PostgreSQL support.
16965
16966
16967 .option pid_file_path main string&!! "set at compile time"
16968 .cindex "daemon" "pid file path"
16969 .cindex "pid file, path for"
16970 This option sets the name of the file to which the Exim daemon writes its
16971 process id. The string is expanded, so it can contain, for example, references
16972 to the host name:
16973 .code
16974 pid_file_path = /var/log/$primary_hostname/exim.pid
16975 .endd
16976 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
16977 spool directory.
16978 The value set by the option can be overridden by the &%-oP%& command line
16979 option. A pid file is not written if a &"non-standard"& daemon is run by means
16980 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
16981
16982
16983 .option pipelining_advertise_hosts main "host list&!!" *
16984 .cindex "PIPELINING" "suppressing advertising"
16985 .cindex "ESMTP extensions" PIPELINING
16986 This option can be used to suppress the advertisement of the SMTP
16987 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
16988 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
16989 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
16990 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
16991 that clients will use it; &"out of order"& commands that are &"expected"& do
16992 not count as protocol errors (see &%smtp_max_synprot_errors%&).
16993
16994 .option pipelining_connect_advertise_hosts main "host list&!!" *
16995 .cindex "pipelining" "early connection"
16996 .cindex "pipelining" PIPE_CONNECT
16997 .cindex "ESMTP extensions" PIPE_CONNECT
16998 If Exim is built with the SUPPORT_PIPE_CONNECT build option
16999 this option controls which hosts the facility is advertised to
17000 and from which pipeline early-connection (before MAIL) SMTP
17001 commands are acceptable.
17002 When used, the pipelining saves on roundtrip times.
17003
17004 See also the &%hosts_pipe_connect%& smtp transport option.
17005
17006 .new
17007 The SMTP service extension keyword advertised is &"PIPE_CONNECT"&.
17008 .wen
17009
17010
17011 .option prdr_enable main boolean false
17012 .cindex "PRDR" "enabling on server"
17013 .cindex "ESMTP extensions" PRDR
17014 This option can be used to enable the Per-Recipient Data Response extension
17015 to SMTP, defined by Eric Hall.
17016 If the option is set, PRDR is advertised by Exim when operating as a server.
17017 If the client requests PRDR, and more than one recipient, for a message
17018 an additional ACL is called for each recipient after the message content
17019 is received.  See section &<<SECTPRDRACL>>&.
17020
17021 .option preserve_message_logs main boolean false
17022 .cindex "message logs" "preserving"
17023 If this option is set, message log files are not deleted when messages are
17024 completed. Instead, they are moved to a sub-directory of the spool directory
17025 called &_msglog.OLD_&, where they remain available for statistical or debugging
17026 purposes. This is a dangerous option to set on systems with any appreciable
17027 volume of mail. Use with care!
17028
17029
17030 .option primary_hostname main string "see below"
17031 .cindex "name" "of local host"
17032 .cindex "host" "name of local"
17033 .cindex "local host" "name of"
17034 .vindex "&$primary_hostname$&"
17035 This specifies the name of the current host. It is used in the default EHLO or
17036 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
17037 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
17038 The value is also used by default in some SMTP response messages from an Exim
17039 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
17040
17041 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
17042 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
17043 contains only one component, Exim passes it to &[gethostbyname()]& (or
17044 &[getipnodebyname()]& when available) in order to obtain the fully qualified
17045 version. The variable &$primary_hostname$& contains the host name, whether set
17046 explicitly by this option, or defaulted.
17047
17048
17049 .option print_topbitchars main boolean false
17050 .cindex "printing characters"
17051 .cindex "8-bit characters"
17052 By default, Exim considers only those characters whose codes lie in the range
17053 32&--126 to be printing characters. In a number of circumstances (for example,
17054 when writing log entries) non-printing characters are converted into escape
17055 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
17056 is set, code values of 128 and above are also considered to be printing
17057 characters.
17058
17059 This option also affects the header syntax checks performed by the
17060 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
17061 the user's full name when constructing From: and Sender: addresses (as
17062 described in section &<<SECTconstr>>&). Setting this option can cause
17063 Exim to generate eight bit message headers that do not conform to the
17064 standards.
17065
17066
17067 .option process_log_path main string unset
17068 .cindex "process log path"
17069 .cindex "log" "process log"
17070 .cindex "&'exiwhat'&"
17071 This option sets the name of the file to which an Exim process writes its
17072 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
17073 utility script. If this option is unset, the file called &_exim-process.info_&
17074 in Exim's spool directory is used. The ability to specify the name explicitly
17075 can be useful in environments where two different Exims are running, using
17076 different spool directories.
17077
17078
17079 .option prod_requires_admin main boolean true
17080 .cindex "restricting access to features"
17081 .oindex "&%-M%&"
17082 .oindex "&%-R%&"
17083 .oindex "&%-q%&"
17084 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
17085 admin user unless &%prod_requires_admin%& is set false. See also
17086 &%queue_list_requires_admin%& and &%commandline_checks_require_admin%&.
17087
17088
17089 .new
17090 .option proxy_protocol_timeout main time 3s
17091 .cindex proxy "proxy protocol"
17092 This option sets the timeout for proxy protocol negotiation.
17093 For details see section &<<SECTproxyInbound>>&.
17094 .wen
17095
17096
17097 .option qualify_domain main string "see below"
17098 .cindex "domain" "for qualifying addresses"
17099 .cindex "address" "qualification"
17100 This option specifies the domain name that is added to any envelope sender
17101 addresses that do not have a domain qualification. It also applies to
17102 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
17103 are accepted by default only for locally-generated messages. Qualification is
17104 also applied to addresses in header lines such as &'From:'& and &'To:'& for
17105 locally-generated messages, unless the &%-bnq%& command line option is used.
17106
17107 Messages from external sources must always contain fully qualified addresses,
17108 unless the sending host matches &%sender_unqualified_hosts%& or
17109 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
17110 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
17111 necessary. Internally, Exim always works with fully qualified envelope
17112 addresses. If &%qualify_domain%& is not set, it defaults to the
17113 &%primary_hostname%& value.
17114
17115
17116 .option qualify_recipient main string "see below"
17117 This option allows you to specify a different domain for qualifying recipient
17118 addresses to the one that is used for senders. See &%qualify_domain%& above.
17119
17120
17121
17122 .option queue_domains main "domain list&!!" unset
17123 .cindex "domain" "specifying non-immediate delivery"
17124 .cindex "queueing incoming messages"
17125 .cindex "message" "queueing certain domains"
17126 This option lists domains for which immediate delivery is not required.
17127 A delivery process is started whenever a message is received, but only those
17128 domains that do not match are processed. All other deliveries wait until the
17129 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
17130
17131
17132 .new
17133 .option queue_fast_ramp main boolean false
17134 .cindex "queue runner" "two phase"
17135 .cindex "queue" "double scanning"
17136 If set to true, two-phase queue runs, initiated using &%-qq%& on the
17137 command line, may start parallel delivery processes during their first
17138 phase.  This will be done when a threshold number of messages have been
17139 routed for a single host.
17140 .wen
17141
17142
17143 .option queue_list_requires_admin main boolean true
17144 .cindex "restricting access to features"
17145 .oindex "&%-bp%&"
17146 The &%-bp%& command-line option, which lists the messages that are on the
17147 queue, requires the caller to be an admin user unless
17148 &%queue_list_requires_admin%& is set false.
17149 See also &%prod_requires_admin%& and &%commandline_checks_require_admin%&.
17150
17151
17152 .option queue_only main boolean false
17153 .cindex "queueing incoming messages"
17154 .cindex "message" "queueing unconditionally"
17155 If &%queue_only%& is set, a delivery process is not automatically started
17156 whenever a message is received. Instead, the message waits in the queue for the
17157 next queue run. Even if &%queue_only%& is false, incoming messages may not get
17158 delivered immediately when certain conditions (such as heavy load) occur.
17159
17160 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
17161 and &%-odi%& command line options override &%queue_only%& unless
17162 &%queue_only_override%& is set false. See also &%queue_only_file%&,
17163 &%queue_only_load%&, and &%smtp_accept_queue%&.
17164
17165
17166 .option queue_only_file main string unset
17167 .cindex "queueing incoming messages"
17168 .cindex "message" "queueing by file existence"
17169 This option can be set to a colon-separated list of absolute path names, each
17170 one optionally preceded by &"smtp"&. When Exim is receiving a message,
17171 it tests for the existence of each listed path using a call to &[stat()]&. For
17172 each path that exists, the corresponding queueing option is set.
17173 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
17174 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
17175 .code
17176 queue_only_file = smtp/some/file
17177 .endd
17178 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
17179 &_/some/file_& exists.
17180
17181
17182 .option queue_only_load main fixed-point unset
17183 .cindex "load average"
17184 .cindex "queueing incoming messages"
17185 .cindex "message" "queueing by load"
17186 If the system load average is higher than this value, incoming messages from
17187 all sources are queued, and no automatic deliveries are started. If this
17188 happens during local or remote SMTP input, all subsequent messages received on
17189 the same SMTP connection are queued by default, whatever happens to the load in
17190 the meantime, but this can be changed by setting &%queue_only_load_latch%&
17191 false.
17192
17193 Deliveries will subsequently be performed by queue runner processes. This
17194 option has no effect on ancient operating systems on which Exim cannot
17195 determine the load average. See also &%deliver_queue_load_max%& and
17196 &%smtp_load_reserve%&.
17197
17198
17199 .option queue_only_load_latch main boolean true
17200 .cindex "load average" "re-evaluating per message"
17201 When this option is true (the default), once one message has been queued
17202 because the load average is higher than the value set by &%queue_only_load%&,
17203 all subsequent messages received on the same SMTP connection are also queued.
17204 This is a deliberate choice; even though the load average may fall below the
17205 threshold, it doesn't seem right to deliver later messages on the same
17206 connection when not delivering earlier ones. However, there are special
17207 circumstances such as very long-lived connections from scanning appliances
17208 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
17209 should be set false. This causes the value of the load average to be
17210 re-evaluated for each message.
17211
17212
17213 .option queue_only_override main boolean true
17214 .cindex "queueing incoming messages"
17215 When this option is true, the &%-od%&&'x'& command line options override the
17216 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
17217 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
17218 to override; they are accepted, but ignored.
17219
17220
17221 .option queue_run_in_order main boolean false
17222 .cindex "queue runner" "processing messages in order"
17223 If this option is set, queue runs happen in order of message arrival instead of
17224 in an arbitrary order. For this to happen, a complete list of the entire queue
17225 must be set up before the deliveries start. When the queue is all held in a
17226 single directory (the default), a single list is created for both the ordered
17227 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
17228 single list is not created when &%queue_run_in_order%& is false. In this case,
17229 the sub-directories are processed one at a time (in a random order), and this
17230 avoids setting up one huge list for the whole queue. Thus, setting
17231 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
17232 when the queue is large, because of the extra work in setting up the single,
17233 large list. In most situations, &%queue_run_in_order%& should not be set.
17234
17235
17236
17237 .option queue_run_max main integer&!! 5
17238 .cindex "queue runner" "maximum number of"
17239 This controls the maximum number of queue runner processes that an Exim daemon
17240 can run simultaneously. This does not mean that it starts them all at once,
17241 but rather that if the maximum number are still running when the time comes to
17242 start another one, it refrains from starting another one. This can happen with
17243 very large queues and/or very sluggish deliveries. This option does not,
17244 however, interlock with other processes, so additional queue runners can be
17245 started by other means, or by killing and restarting the daemon.
17246
17247 Setting this option to zero does not suppress queue runs; rather, it disables
17248 the limit, allowing any number of simultaneous queue runner processes to be
17249 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
17250 the daemon's command line.
17251
17252 .cindex queues named
17253 .cindex "named queues" "resource limit"
17254 To set limits for different named queues use
17255 an expansion depending on the &$queue_name$& variable.
17256
17257 .option queue_smtp_domains main "domain list&!!" unset
17258 .cindex "queueing incoming messages"
17259 .cindex "message" "queueing remote deliveries"
17260 .cindex "first pass routing"
17261 When this option is set, a delivery process is started whenever a message is
17262 received, routing is performed, and local deliveries take place.
17263 However, if any SMTP deliveries are required for domains that match
17264 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
17265 message waits in the queue for the next queue run. Since routing of the message
17266 has taken place, Exim knows to which remote hosts it must be delivered, and so
17267 when the queue run happens, multiple messages for the same host are delivered
17268 over a single SMTP connection. The &%-odqs%& command line option causes all
17269 SMTP deliveries to be queued in this way, and is equivalent to setting
17270 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
17271 &%queue_domains%&.
17272
17273
17274 .option receive_timeout main time 0s
17275 .cindex "timeout" "for non-SMTP input"
17276 This option sets the timeout for accepting a non-SMTP message, that is, the
17277 maximum time that Exim waits when reading a message on the standard input. If
17278 the value is zero, it will wait forever. This setting is overridden by the
17279 &%-or%& command line option. The timeout for incoming SMTP messages is
17280 controlled by &%smtp_receive_timeout%&.
17281
17282 .option received_header_text main string&!! "see below"
17283 .cindex "customizing" "&'Received:'& header"
17284 .cindex "&'Received:'& header line" "customizing"
17285 This string defines the contents of the &'Received:'& message header that is
17286 added to each message, except for the timestamp, which is automatically added
17287 on at the end (preceded by a semicolon). The string is expanded each time it is
17288 used. If the expansion yields an empty string, no &'Received:'& header line is
17289 added to the message. Otherwise, the string should start with the text
17290 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
17291 header lines.
17292 The default setting is:
17293
17294 .code
17295 received_header_text = Received: \
17296   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
17297     {${if def:sender_ident \
17298       {from ${quote_local_part:$sender_ident} }}\
17299         ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
17300   by $primary_hostname \
17301   ${if def:received_protocol {with $received_protocol }}\
17302   ${if def:tls_in_ver        { ($tls_in_ver)}}\
17303   ${if def:tls_in_cipher_std { tls $tls_in_cipher_std\n\t}}\
17304   (Exim $version_number)\n\t\
17305   ${if def:sender_address \
17306   {(envelope-from <$sender_address>)\n\t}}\
17307   id $message_exim_id\
17308   ${if def:received_for {\n\tfor $received_for}}
17309 .endd
17310
17311 The references to the TLS version and cipher are
17312 omitted when Exim is built without TLS
17313 support. The use of conditional expansions ensures that this works for both
17314 locally generated messages and messages received from remote hosts, giving
17315 header lines such as the following:
17316 .code
17317 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
17318 by marley.carol.example with esmtp (Exim 4.00)
17319 (envelope-from <bob@carol.example>)
17320 id 16IOWa-00019l-00
17321 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
17322 Received: by scrooge.carol.example with local (Exim 4.00)
17323 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
17324 .endd
17325 Until the body of the message has been received, the timestamp is the time when
17326 the message started to be received. Once the body has arrived, and all policy
17327 checks have taken place, the timestamp is updated to the time at which the
17328 message was accepted.
17329
17330
17331 .option received_headers_max main integer 30
17332 .cindex "loop" "prevention"
17333 .cindex "mail loop prevention"
17334 .cindex "&'Received:'& header line" "counting"
17335 When a message is to be delivered, the number of &'Received:'& headers is
17336 counted, and if it is greater than this parameter, a mail loop is assumed to
17337 have occurred, the delivery is abandoned, and an error message is generated.
17338 This applies to both local and remote deliveries.
17339
17340
17341 .option recipient_unqualified_hosts main "host list&!!" unset
17342 .cindex "unqualified addresses"
17343 .cindex "host" "unqualified addresses from"
17344 This option lists those hosts from which Exim is prepared to accept unqualified
17345 recipient addresses in message envelopes. The addresses are made fully
17346 qualified by the addition of the &%qualify_recipient%& value. This option also
17347 affects message header lines. Exim does not reject unqualified recipient
17348 addresses in headers, but it qualifies them only if the message came from a
17349 host that matches &%recipient_unqualified_hosts%&,
17350 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
17351 option was not set.
17352
17353
17354 .option recipients_max main integer 0
17355 .cindex "limit" "number of recipients"
17356 .cindex "recipient" "maximum number"
17357 If this option is set greater than zero, it specifies the maximum number of
17358 original recipients for any message. Additional recipients that are generated
17359 by aliasing or forwarding do not count. SMTP messages get a 452 response for
17360 all recipients over the limit; earlier recipients are delivered as normal.
17361 Non-SMTP messages with too many recipients are failed, and no deliveries are
17362 done.
17363
17364 .cindex "RCPT" "maximum number of incoming"
17365 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
17366 RCPT commands in a single message.
17367
17368
17369 .option recipients_max_reject main boolean false
17370 If this option is set true, Exim rejects SMTP messages containing too many
17371 recipients by giving 552 errors to the surplus RCPT commands, and a 554
17372 error to the eventual DATA command. Otherwise (the default) it gives a 452
17373 error to the surplus RCPT commands and accepts the message on behalf of the
17374 initial set of recipients. The remote server should then re-send the message
17375 for the remaining recipients at a later time.
17376
17377
17378 .option remote_max_parallel main integer 2
17379 .cindex "delivery" "parallelism for remote"
17380 This option controls parallel delivery of one message to a number of remote
17381 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
17382 does all the remote deliveries for a message one by one. Otherwise, if a single
17383 message has to be delivered to more than one remote host, or if several copies
17384 have to be sent to the same remote host, up to &%remote_max_parallel%&
17385 deliveries are done simultaneously. If more than &%remote_max_parallel%&
17386 deliveries are required, the maximum number of processes are started, and as
17387 each one finishes, another is begun. The order of starting processes is the
17388 same as if sequential delivery were being done, and can be controlled by the
17389 &%remote_sort_domains%& option. If parallel delivery takes place while running
17390 with debugging turned on, the debugging output from each delivery process is
17391 tagged with its process id.
17392
17393 This option controls only the maximum number of parallel deliveries for one
17394 message in one Exim delivery process. Because Exim has no central queue
17395 manager, there is no way of controlling the total number of simultaneous
17396 deliveries if the configuration allows a delivery attempt as soon as a message
17397 is received.
17398
17399 See also the &%max_parallel%& generic transport option,
17400 and the &%serialize_hosts%& smtp transport option.
17401
17402 .cindex "number of deliveries"
17403 .cindex "delivery" "maximum number of"
17404 If you want to control the total number of deliveries on the system, you
17405 need to set the &%queue_only%& option. This ensures that all incoming messages
17406 are added to the queue without starting a delivery process. Then set up an Exim
17407 daemon to start queue runner processes at appropriate intervals (probably
17408 fairly often, for example, every minute), and limit the total number of queue
17409 runners by setting the &%queue_run_max%& parameter. Because each queue runner
17410 delivers only one message at a time, the maximum number of deliveries that can
17411 then take place at once is &%queue_run_max%& multiplied by
17412 &%remote_max_parallel%&.
17413
17414 If it is purely remote deliveries you want to control, use
17415 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
17416 doing the SMTP routing before queueing, so that several messages for the same
17417 host will eventually get delivered down the same connection.
17418
17419
17420 .option remote_sort_domains main "domain list&!!" unset
17421 .cindex "sorting remote deliveries"
17422 .cindex "delivery" "sorting remote"
17423 When there are a number of remote deliveries for a message, they are sorted by
17424 domain into the order given by this list. For example,
17425 .code
17426 remote_sort_domains = *.cam.ac.uk:*.uk
17427 .endd
17428 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
17429 then to those in the &%uk%& domain, then to any others.
17430
17431
17432 .option retry_data_expire main time 7d
17433 .cindex "hints database" "data expiry"
17434 This option sets a &"use before"& time on retry information in Exim's hints
17435 database. Any older retry data is ignored. This means that, for example, once a
17436 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
17437 past failures.
17438
17439
17440 .option retry_interval_max main time 24h
17441 .cindex "retry" "limit on interval"
17442 .cindex "limit" "on retry interval"
17443 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
17444 intervals between delivery attempts for messages that cannot be delivered
17445 straight away. This option sets an overall limit to the length of time between
17446 retries. It cannot be set greater than 24 hours; any attempt to do so forces
17447 the default value.
17448
17449
17450 .option return_path_remove main boolean true
17451 .cindex "&'Return-path:'& header line" "removing"
17452 RFC 2821, section 4.4, states that an SMTP server must insert a
17453 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
17454 The &'Return-path:'& header preserves the sender address as received in the
17455 MAIL command. This description implies that this header should not be present
17456 in an incoming message. If &%return_path_remove%& is true, any existing
17457 &'Return-path:'& headers are removed from messages at the time they are
17458 received. Exim's transports have options for adding &'Return-path:'& headers at
17459 the time of delivery. They are normally used only for final local deliveries.
17460
17461
17462 .option return_size_limit main integer 100K
17463 This option is an obsolete synonym for &%bounce_return_size_limit%&.
17464
17465
17466 .option rfc1413_hosts main "host list&!!" @[]
17467 .cindex "RFC 1413"
17468 .cindex "host" "for RFC 1413 calls"
17469 RFC 1413 identification calls are made to any client host which matches
17470 an item in the list.
17471 The default value specifies just this host, being any local interface
17472 for the system.
17473
17474 .option rfc1413_query_timeout main time 0s
17475 .cindex "RFC 1413" "query timeout"
17476 .cindex "timeout" "for RFC 1413 call"
17477 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
17478 no RFC 1413 calls are ever made.
17479
17480
17481 .option sender_unqualified_hosts main "host list&!!" unset
17482 .cindex "unqualified addresses"
17483 .cindex "host" "unqualified addresses from"
17484 This option lists those hosts from which Exim is prepared to accept unqualified
17485 sender addresses. The addresses are made fully qualified by the addition of
17486 &%qualify_domain%&. This option also affects message header lines. Exim does
17487 not reject unqualified addresses in headers that contain sender addresses, but
17488 it qualifies them only if the message came from a host that matches
17489 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
17490 using TCP/IP), and the &%-bnq%& option was not set.
17491
17492
17493 .option slow_lookup_log main integer 0
17494 .cindex "logging" "slow lookups"
17495 .cindex "dns" "logging slow lookups"
17496 This option controls logging of slow lookups.
17497 If the value is nonzero it is taken as a number of milliseconds
17498 and lookups taking longer than this are logged.
17499 Currently this applies only to DNS lookups.
17500
17501
17502
17503 .option smtp_accept_keepalive main boolean true
17504 .cindex "keepalive" "on incoming connection"
17505 This option controls the setting of the SO_KEEPALIVE option on incoming
17506 TCP/IP socket connections. When set, it causes the kernel to probe idle
17507 connections periodically, by sending packets with &"old"& sequence numbers. The
17508 other end of the connection should send an acknowledgment if the connection is
17509 still okay or a reset if the connection has been aborted. The reason for doing
17510 this is that it has the beneficial effect of freeing up certain types of
17511 connection that can get stuck when the remote host is disconnected without
17512 tidying up the TCP/IP call properly. The keepalive mechanism takes several
17513 hours to detect unreachable hosts.
17514
17515
17516
17517 .option smtp_accept_max main integer 20
17518 .cindex "limit" "incoming SMTP connections"
17519 .cindex "SMTP" "incoming connection count"
17520 .cindex "inetd"
17521 This option specifies the maximum number of simultaneous incoming SMTP calls
17522 that Exim will accept. It applies only to the listening daemon; there is no
17523 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
17524 value is set to zero, no limit is applied. However, it is required to be
17525 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
17526 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
17527
17528 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
17529 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
17530 that limit has not been reached for the client host, &%smtp_accept_reserve%&
17531 and &%smtp_load_reserve%& are then checked before accepting the connection.
17532
17533
17534 .option smtp_accept_max_nonmail main integer 10
17535 .cindex "limit" "non-mail SMTP commands"
17536 .cindex "SMTP" "limiting non-mail commands"
17537 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
17538 the connection if there are too many. This option defines &"too many"&. The
17539 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
17540 client looping sending EHLO, for example. The check is applied only if the
17541 client host matches &%smtp_accept_max_nonmail_hosts%&.
17542
17543 When a new message is expected, one occurrence of RSET is not counted. This
17544 allows a client to send one RSET between messages (this is not necessary,
17545 but some clients do it). Exim also allows one uncounted occurrence of HELO
17546 or EHLO, and one occurrence of STARTTLS between messages. After
17547 starting up a TLS session, another EHLO is expected, and so it too is not
17548 counted. The first occurrence of AUTH in a connection, or immediately
17549 following STARTTLS is not counted. Otherwise, all commands other than
17550 MAIL, RCPT, DATA, and QUIT are counted.
17551
17552
17553 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
17554 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
17555 check by setting this option. The default value makes it apply to all hosts. By
17556 changing the value, you can exclude any badly-behaved hosts that you have to
17557 live with.
17558
17559
17560 . Allow this long option name to split; give it unsplit as a fifth argument
17561 . for the automatic .oindex that is generated by .option.
17562 . We insert " &~&~" which is both pretty nasty visually and results in
17563 . non-searchable text.  HowItWorks.txt mentions an option for inserting
17564 . zero-width-space, which would be nicer visually and results in (at least)
17565 . html that Firefox will split on when it's forced to reflow (rather than
17566 . inserting a horizontal scrollbar).  However, the text is still not
17567 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
17568 . the option name to split.
17569
17570 .option "smtp_accept_max_per_connection" main integer 1000 &&&
17571          smtp_accept_max_per_connection
17572 .cindex "SMTP" "limiting incoming message count"
17573 .cindex "limit" "messages per SMTP connection"
17574 The value of this option limits the number of MAIL commands that Exim is
17575 prepared to accept over a single SMTP connection, whether or not each command
17576 results in the transfer of a message. After the limit is reached, a 421
17577 response is given to subsequent MAIL commands. This limit is a safety
17578 precaution against a client that goes mad (incidents of this type have been
17579 seen).
17580
17581
17582 .option smtp_accept_max_per_host main string&!! unset
17583 .cindex "limit" "SMTP connections from one host"
17584 .cindex "host" "limiting SMTP connections from"
17585 This option restricts the number of simultaneous IP connections from a single
17586 host (strictly, from a single IP address) to the Exim daemon. The option is
17587 expanded, to enable different limits to be applied to different hosts by
17588 reference to &$sender_host_address$&. Once the limit is reached, additional
17589 connection attempts from the same host are rejected with error code 421. This
17590 is entirely independent of &%smtp_accept_reserve%&. The option's default value
17591 of zero imposes no limit. If this option is set greater than zero, it is
17592 required that &%smtp_accept_max%& be non-zero.
17593
17594 &*Warning*&: When setting this option you should not use any expansion
17595 constructions that take an appreciable amount of time. The expansion and test
17596 happen in the main daemon loop, in order to reject additional connections
17597 without forking additional processes (otherwise a denial-of-service attack
17598 could cause a vast number or processes to be created). While the daemon is
17599 doing this processing, it cannot accept any other incoming connections.
17600
17601
17602
17603 .option smtp_accept_queue main integer 0
17604 .cindex "SMTP" "incoming connection count"
17605 .cindex "queueing incoming messages"
17606 .cindex "message" "queueing by SMTP connection count"
17607 If the number of simultaneous incoming SMTP connections being handled via the
17608 listening daemon exceeds this value, messages received by SMTP are just placed
17609 in the queue; no delivery processes are started automatically. The count is
17610 fixed at the start of an SMTP connection. It cannot be updated in the
17611 subprocess that receives messages, and so the queueing or not queueing applies
17612 to all messages received in the same connection.
17613
17614 A value of zero implies no limit, and clearly any non-zero value is useful only
17615 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
17616 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
17617 various &%-od%&&'x'& command line options.
17618
17619
17620 . See the comment on smtp_accept_max_per_connection
17621
17622 .option "smtp_accept_queue_per_connection" main integer 10 &&&
17623          smtp_accept_queue_per_connection
17624 .cindex "queueing incoming messages"
17625 .cindex "message" "queueing by message count"
17626 This option limits the number of delivery processes that Exim starts
17627 automatically when receiving messages via SMTP, whether via the daemon or by
17628 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
17629 and the number of messages received in a single SMTP session exceeds this
17630 number, subsequent messages are placed in the queue, but no delivery processes
17631 are started. This helps to limit the number of Exim processes when a server
17632 restarts after downtime and there is a lot of mail waiting for it on other
17633 systems. On large systems, the default should probably be increased, and on
17634 dial-in client systems it should probably be set to zero (that is, disabled).
17635
17636
17637 .option smtp_accept_reserve main integer 0
17638 .cindex "SMTP" "incoming call count"
17639 .cindex "host" "reserved"
17640 When &%smtp_accept_max%& is set greater than zero, this option specifies a
17641 number of SMTP connections that are reserved for connections from the hosts
17642 that are specified in &%smtp_reserve_hosts%&. The value set in
17643 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
17644 restricted to this number of connections; the option specifies a minimum number
17645 of connection slots for them, not a maximum. It is a guarantee that this group
17646 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
17647 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
17648 individual host.
17649
17650 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
17651 set to 5, once there are 45 active connections (from any hosts), new
17652 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
17653 provided the other criteria for acceptance are met.
17654
17655
17656 .option smtp_active_hostname main string&!! unset
17657 .cindex "host" "name in SMTP responses"
17658 .cindex "SMTP" "host name in responses"
17659 .vindex "&$primary_hostname$&"
17660 This option is provided for multi-homed servers that want to masquerade as
17661 several different hosts. At the start of an incoming SMTP connection, its value
17662 is expanded and used instead of the value of &$primary_hostname$& in SMTP
17663 responses. For example, it is used as domain name in the response to an
17664 incoming HELO or EHLO command.
17665
17666 .vindex "&$smtp_active_hostname$&"
17667 The active hostname is placed in the &$smtp_active_hostname$& variable, which
17668 is saved with any messages that are received. It is therefore available for use
17669 in routers and transports when the message is later delivered.
17670
17671 If this option is unset, or if its expansion is forced to fail, or if the
17672 expansion results in an empty string, the value of &$primary_hostname$& is
17673 used. Other expansion failures cause a message to be written to the main and
17674 panic logs, and the SMTP command receives a temporary error. Typically, the
17675 value of &%smtp_active_hostname%& depends on the incoming interface address.
17676 For example:
17677 .code
17678 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
17679   {cox.mydomain}{box.mydomain}}
17680 .endd
17681
17682 Although &$smtp_active_hostname$& is primarily concerned with incoming
17683 messages, it is also used as the default for HELO commands in callout
17684 verification if there is no remote transport from which to obtain a
17685 &%helo_data%& value.
17686
17687 .option smtp_banner main string&!! "see below"
17688 .cindex "SMTP" "welcome banner"
17689 .cindex "banner for SMTP"
17690 .cindex "welcome banner for SMTP"
17691 .cindex "customizing" "SMTP banner"
17692 This string, which is expanded every time it is used, is output as the initial
17693 positive response to an SMTP connection. The default setting is:
17694 .code
17695 smtp_banner = $smtp_active_hostname ESMTP Exim \
17696   $version_number $tod_full
17697 .endd
17698 Failure to expand the string causes a panic error. If you want to create a
17699 multiline response to the initial SMTP connection, use &"\n"& in the string at
17700 appropriate points, but not at the end. Note that the 220 code is not included
17701 in this string. Exim adds it automatically (several times in the case of a
17702 multiline response).
17703
17704
17705 .option smtp_check_spool_space main boolean true
17706 .cindex "checking disk space"
17707 .cindex "disk space, checking"
17708 .cindex "spool directory" "checking space"
17709 When this option is set, if an incoming SMTP session encounters the SIZE
17710 option on a MAIL command, it checks that there is enough space in the
17711 spool directory's partition to accept a message of that size, while still
17712 leaving free the amount specified by &%check_spool_space%& (even if that value
17713 is zero). If there isn't enough space, a temporary error code is returned.
17714
17715
17716 .option smtp_connect_backlog main integer 20
17717 .cindex "connection backlog"
17718 .cindex "SMTP" "connection backlog"
17719 .cindex "backlog of connections"
17720 This option specifies a maximum number of waiting SMTP connections. Exim passes
17721 this value to the TCP/IP system when it sets up its listener. Once this number
17722 of connections are waiting for the daemon's attention, subsequent connection
17723 attempts are refused at the TCP/IP level. At least, that is what the manuals
17724 say; in some circumstances such connection attempts have been observed to time
17725 out instead. For large systems it is probably a good idea to increase the
17726 value (to 50, say). It also gives some protection against denial-of-service
17727 attacks by SYN flooding.
17728
17729
17730 .option smtp_enforce_sync main boolean true
17731 .cindex "SMTP" "synchronization checking"
17732 .cindex "synchronization checking in SMTP"
17733 The SMTP protocol specification requires the client to wait for a response from
17734 the server at certain points in the dialogue. Without PIPELINING these
17735 synchronization points are after every command; with PIPELINING they are
17736 fewer, but they still exist.
17737
17738 Some spamming sites send out a complete set of SMTP commands without waiting
17739 for any response. Exim protects against this by rejecting a message if the
17740 client has sent further input when it should not have. The error response &"554
17741 SMTP synchronization error"& is sent, and the connection is dropped. Testing
17742 for this error cannot be perfect because of transmission delays (unexpected
17743 input may be on its way but not yet received when Exim checks). However, it
17744 does detect many instances.
17745
17746 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
17747 If you want to disable the check selectively (for example, only for certain
17748 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
17749 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
17750
17751
17752
17753 .option smtp_etrn_command main string&!! unset
17754 .cindex "ETRN" "command to be run"
17755 .cindex "ESMTP extensions" ETRN
17756 .vindex "&$domain$&"
17757 If this option is set, the given command is run whenever an SMTP ETRN
17758 command is received from a host that is permitted to issue such commands (see
17759 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
17760 are independently expanded. The expansion variable &$domain$& is set to the
17761 argument of the ETRN command, and no syntax checking is done on it. For
17762 example:
17763 .code
17764 smtp_etrn_command = /etc/etrn_command $domain \
17765                     $sender_host_address
17766 .endd
17767 If the option is not set, the argument for the ETRN command must
17768 be a &'#'& followed by an address string.
17769 In this case an &'exim -R <string>'& command is used;
17770 if the ETRN ACL has set up a named-queue then &'-MCG <queue>'& is appended.
17771
17772 A new process is created to run the command, but Exim does not wait for it to
17773 complete. Consequently, its status cannot be checked. If the command cannot be
17774 run, a line is written to the panic log, but the ETRN caller still receives
17775 a 250 success response. Exim is normally running under its own uid when
17776 receiving SMTP, so it is not possible for it to change the uid before running
17777 the command.
17778
17779
17780 .option smtp_etrn_serialize main boolean true
17781 .cindex "ETRN" "serializing"
17782 When this option is set, it prevents the simultaneous execution of more than
17783 one identical command as a result of ETRN in an SMTP connection. See
17784 section &<<SECTETRN>>& for details.
17785
17786
17787 .option smtp_load_reserve main fixed-point unset
17788 .cindex "load average"
17789 If the system load average ever gets higher than this, incoming SMTP calls are
17790 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
17791 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
17792 the load is over the limit. The option has no effect on ancient operating
17793 systems on which Exim cannot determine the load average. See also
17794 &%deliver_queue_load_max%& and &%queue_only_load%&.
17795
17796
17797
17798 .option smtp_max_synprot_errors main integer 3
17799 .cindex "SMTP" "limiting syntax and protocol errors"
17800 .cindex "limit" "SMTP syntax and protocol errors"
17801 Exim rejects SMTP commands that contain syntax or protocol errors. In
17802 particular, a syntactically invalid email address, as in this command:
17803 .code
17804 RCPT TO:<abc xyz@a.b.c>
17805 .endd
17806 causes immediate rejection of the command, before any other tests are done.
17807 (The ACL cannot be run if there is no valid address to set up for it.) An
17808 example of a protocol error is receiving RCPT before MAIL. If there are
17809 too many syntax or protocol errors in one SMTP session, the connection is
17810 dropped. The limit is set by this option.
17811
17812 .cindex "PIPELINING" "expected errors"
17813 When the PIPELINING extension to SMTP is in use, some protocol errors are
17814 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
17815 Exim assumes that PIPELINING will be used if it advertises it (see
17816 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
17817 not count towards the limit.
17818
17819
17820
17821 .option smtp_max_unknown_commands main integer 3
17822 .cindex "SMTP" "limiting unknown commands"
17823 .cindex "limit" "unknown SMTP commands"
17824 If there are too many unrecognized commands in an incoming SMTP session, an
17825 Exim server drops the connection. This is a defence against some kinds of abuse
17826 that subvert web
17827 clients
17828 into making connections to SMTP ports; in these circumstances, a number of
17829 non-SMTP command lines are sent first.
17830
17831
17832
17833 .option smtp_ratelimit_hosts main "host list&!!" unset
17834 .cindex "SMTP" "rate limiting"
17835 .cindex "limit" "rate of message arrival"
17836 .cindex "RCPT" "rate limiting"
17837 Some sites find it helpful to be able to limit the rate at which certain hosts
17838 can send them messages, and the rate at which an individual message can specify
17839 recipients.
17840
17841 Exim has two rate-limiting facilities. This section describes the older
17842 facility, which can limit rates within a single connection. The newer
17843 &%ratelimit%& ACL condition can limit rates across all connections. See section
17844 &<<SECTratelimiting>>& for details of the newer facility.
17845
17846 When a host matches &%smtp_ratelimit_hosts%&, the values of
17847 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
17848 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
17849 respectively. Each option, if set, must contain a set of four comma-separated
17850 values:
17851
17852 .ilist
17853 A threshold, before which there is no rate limiting.
17854 .next
17855 An initial time delay. Unlike other times in Exim, numbers with decimal
17856 fractional parts are allowed here.
17857 .next
17858 A factor by which to increase the delay each time.
17859 .next
17860 A maximum value for the delay. This should normally be less than 5 minutes,
17861 because after that time, the client is liable to timeout the SMTP command.
17862 .endlist
17863
17864 For example, these settings have been used successfully at the site which
17865 first suggested this feature, for controlling mail from their customers:
17866 .code
17867 smtp_ratelimit_mail = 2,0.5s,1.05,4m
17868 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
17869 .endd
17870 The first setting specifies delays that are applied to MAIL commands after
17871 two have been received over a single connection. The initial delay is 0.5
17872 seconds, increasing by a factor of 1.05 each time. The second setting applies
17873 delays to RCPT commands when more than four occur in a single message.
17874
17875
17876 .option smtp_ratelimit_mail main string unset
17877 See &%smtp_ratelimit_hosts%& above.
17878
17879
17880 .option smtp_ratelimit_rcpt main string unset
17881 See &%smtp_ratelimit_hosts%& above.
17882
17883
17884 .option smtp_receive_timeout main time&!! 5m
17885 .cindex "timeout" "for SMTP input"
17886 .cindex "SMTP" "input timeout"
17887 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
17888 input, including batch SMTP. If a line of input (either an SMTP command or a
17889 data line) is not received within this time, the SMTP connection is dropped and
17890 the message is abandoned.
17891 A line is written to the log containing one of the following messages:
17892 .code
17893 SMTP command timeout on connection from...
17894 SMTP data timeout on connection from...
17895 .endd
17896 The former means that Exim was expecting to read an SMTP command; the latter
17897 means that it was in the DATA phase, reading the contents of a message.
17898
17899 If the first character of the option is a &"$"& the option is
17900 expanded before use and may depend on
17901 &$sender_host_name$&, &$sender_host_address$& and &$sender_host_port$&.
17902
17903
17904 .oindex "&%-os%&"
17905 The value set by this option can be overridden by the
17906 &%-os%& command-line option. A setting of zero time disables the timeout, but
17907 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
17908 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
17909 timeout is controlled by &%receive_timeout%& and &%-or%&.
17910
17911
17912 .option smtp_reserve_hosts main "host list&!!" unset
17913 This option defines hosts for which SMTP connections are reserved; see
17914 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
17915
17916
17917 .option smtp_return_error_details main boolean false
17918 .cindex "SMTP" "details policy failures"
17919 .cindex "policy control" "rejection, returning details"
17920 In the default state, Exim uses bland messages such as
17921 &"Administrative prohibition"& when it rejects SMTP commands for policy
17922 reasons. Many sysadmins like this because it gives away little information
17923 to spammers. However, some other sysadmins who are applying strict checking
17924 policies want to give out much fuller information about failures. Setting
17925 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
17926 example, instead of &"Administrative prohibition"&, it might give:
17927 .code
17928 550-Rejected after DATA: '>' missing at end of address:
17929 550 failing address in "From" header is: <user@dom.ain
17930 .endd
17931
17932
17933 .option smtputf8_advertise_hosts main "host list&!!" *
17934 .cindex "SMTPUTF8" "ESMTP extension, advertising"
17935 .cindex "ESMTP extensions" SMTPUTF8
17936 When Exim is built with support for internationalised mail names,
17937 the availability thereof is advertised in
17938 response to EHLO only to those client hosts that match this option. See
17939 chapter &<<CHAPi18n>>& for details of Exim's support for internationalisation.
17940
17941
17942 .option spamd_address main string "127.0.0.1 783"
17943 This option is available when Exim is compiled with the content-scanning
17944 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
17945 See section &<<SECTscanspamass>>& for more details.
17946
17947
17948
17949 .option spf_guess main string "v=spf1 a/24 mx/24 ptr ?all"
17950 This option is available when Exim is compiled with SPF support.
17951 See section &<<SECSPF>>& for more details.
17952
17953 .option spf_smtp_comment_template main string&!! "Please%_see%_http://www.open-spf.org/Why"
17954 This option is available when Exim is compiled with SPF support.  It
17955 allows the customisation of the SMTP comment that the SPF library
17956 generates.  You are strongly encouraged to link to your own explanative
17957 site. The template must not contain spaces. If you need spaces in the
17958 output, use the proper placeholder. If libspf2 can not parse the
17959 template, it uses a built-in default broken link. The following placeholders
17960 (along with Exim variables (but see below)) are allowed in the template:
17961 .ilist
17962 &*%_*&: A space.
17963 .next
17964 &*%{L}*&: Envelope sender's local part.
17965 .next
17966 &*%{S}*&: Envelope sender.
17967 .next
17968 &*%{O}*&: Envelope sender's domain.
17969 .next
17970 &*%{D}*&: Current(?) domain.
17971 .next
17972 &*%{I}*&: SMTP client Ip.
17973 .next
17974 &*%{C}*&: SMTP client pretty IP.
17975 .next
17976 &*%{T}*&: Epoch time (UTC).
17977 .next
17978 &*%{P}*&: SMTP client domain name.
17979 .next
17980 &*%{V}*&: IP version.
17981 .next
17982 &*%{H}*&: EHLO/HELO domain.
17983 .next
17984 &*%{R}*&: Receiving domain.
17985 .endlist
17986 The capitalized placeholders do proper URL encoding, if you use them
17987 lowercased, no encoding takes place.  This list was compiled from the
17988 libspf2 sources.
17989
17990 A note on using Exim variables: As
17991 currently the SPF library is initialized before the SMTP EHLO phase,
17992 the variables useful for expansion are quite limited.
17993
17994
17995 .option split_spool_directory main boolean false
17996 .cindex "multiple spool directories"
17997 .cindex "spool directory" "split"
17998 .cindex "directories, multiple"
17999 If this option is set, it causes Exim to split its input directory into 62
18000 subdirectories, each with a single alphanumeric character as its name. The
18001 sixth character of the message id is used to allocate messages to
18002 subdirectories; this is the least significant base-62 digit of the time of
18003 arrival of the message.
18004
18005 Splitting up the spool in this way may provide better performance on systems
18006 where there are long mail queues, by reducing the number of files in any one
18007 directory. The msglog directory is also split up in a similar way to the input
18008 directory; however, if &%preserve_message_logs%& is set, all old msglog files
18009 are still placed in the single directory &_msglog.OLD_&.
18010
18011 It is not necessary to take any special action for existing messages when
18012 changing &%split_spool_directory%&. Exim notices messages that are in the
18013 &"wrong"& place, and continues to process them. If the option is turned off
18014 after a period of being on, the subdirectories will eventually empty and be
18015 automatically deleted.
18016
18017 When &%split_spool_directory%& is set, the behaviour of queue runner processes
18018 changes. Instead of creating a list of all messages in the queue, and then
18019 trying to deliver each one, in turn, it constructs a list of those in one
18020 sub-directory and tries to deliver them, before moving on to the next
18021 sub-directory. The sub-directories are processed in a random order. This
18022 spreads out the scanning of the input directories, and uses less memory. It is
18023 particularly beneficial when there are lots of messages in the queue. However,
18024 if &%queue_run_in_order%& is set, none of this new processing happens. The
18025 entire queue has to be scanned and sorted before any deliveries can start.
18026
18027
18028 .option spool_directory main string&!! "set at compile time"
18029 .cindex "spool directory" "path to"
18030 This defines the directory in which Exim keeps its spool, that is, the messages
18031 it is waiting to deliver. The default value is taken from the compile-time
18032 configuration setting, if there is one. If not, this option must be set. The
18033 string is expanded, so it can contain, for example, a reference to
18034 &$primary_hostname$&.
18035
18036 If the spool directory name is fixed on your installation, it is recommended
18037 that you set it at build time rather than from this option, particularly if the
18038 log files are being written to the spool directory (see &%log_file_path%&).
18039 Otherwise log files cannot be used for errors that are detected early on, such
18040 as failures in the configuration file.
18041
18042 By using this option to override the compiled-in path, it is possible to run
18043 tests of Exim without using the standard spool.
18044
18045 .option spool_wireformat main boolean false
18046 .cindex "spool directory" "file formats"
18047 If this option is set, Exim may for some messages use an alternative format
18048 for data-files in the spool which matches the wire format.
18049 Doing this permits more efficient message reception and transmission.
18050 Currently it is only done for messages received using the ESMTP CHUNKING
18051 option.
18052
18053 The following variables will not have useful values:
18054 .code
18055 $max_received_linelength
18056 $body_linecount
18057 $body_zerocount
18058 .endd
18059
18060 Users of the local_scan() API (see &<<CHAPlocalscan>>&),
18061 and any external programs which are passed a reference to a message data file
18062 (except via the &"regex"&, &"malware"& or &"spam"&) ACL conditions)
18063 will need to be aware of the different formats potentially available.
18064
18065 Using any of the ACL conditions noted will negate the reception benefit
18066 (as a Unix-mbox-format file is constructed for them).
18067 The transmission benefit is maintained.
18068
18069 .option sqlite_lock_timeout main time 5s
18070 .cindex "sqlite lookup type" "lock timeout"
18071 This option controls the timeout that the &(sqlite)& lookup uses when trying to
18072 access an SQLite database. See section &<<SECTsqlite>>& for more details.
18073
18074 .option strict_acl_vars main boolean false
18075 .cindex "&ACL;" "variables, handling unset"
18076 This option controls what happens if a syntactically valid but undefined ACL
18077 variable is referenced. If it is false (the default), an empty string
18078 is substituted; if it is true, an error is generated. See section
18079 &<<SECTaclvariables>>& for details of ACL variables.
18080
18081 .option strip_excess_angle_brackets main boolean false
18082 .cindex "angle brackets, excess"
18083 If this option is set, redundant pairs of angle brackets round &"route-addr"&
18084 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
18085 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
18086 passed on to another MTA, the excess angle brackets are not passed on. If this
18087 option is not set, multiple pairs of angle brackets cause a syntax error.
18088
18089
18090 .option strip_trailing_dot main boolean false
18091 .cindex "trailing dot on domain"
18092 .cindex "dot" "trailing on domain"
18093 If this option is set, a trailing dot at the end of a domain in an address is
18094 ignored. If this is in the envelope and the message is passed on to another
18095 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
18096 domain causes a syntax error.
18097 However, addresses in header lines are checked only when an ACL requests header
18098 syntax checking.
18099
18100
18101 .option syslog_duplication main boolean true
18102 .cindex "syslog" "duplicate log lines; suppressing"
18103 When Exim is logging to syslog, it writes the log lines for its three
18104 separate logs at different syslog priorities so that they can in principle
18105 be separated on the logging hosts. Some installations do not require this
18106 separation, and in those cases, the duplication of certain log lines is a
18107 nuisance. If &%syslog_duplication%& is set false, only one copy of any
18108 particular log line is written to syslog. For lines that normally go to
18109 both the main log and the reject log, the reject log version (possibly
18110 containing message header lines) is written, at LOG_NOTICE priority.
18111 Lines that normally go to both the main and the panic log are written at
18112 the LOG_ALERT priority.
18113
18114
18115 .option syslog_facility main string unset
18116 .cindex "syslog" "facility; setting"
18117 This option sets the syslog &"facility"& name, used when Exim is logging to
18118 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
18119 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
18120 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
18121 details of Exim's logging.
18122
18123
18124 .option syslog_pid main boolean true
18125 .cindex "syslog" "pid"
18126 If &%syslog_pid%& is set false, the PID on Exim's log lines are
18127 omitted when these lines are sent to syslog. (Syslog normally prefixes
18128 the log lines with the PID of the logging process automatically.) You need
18129 to enable the &`+pid`& log selector item, if you want Exim to write it's PID
18130 into the logs.) See chapter &<<CHAPlog>>& for details of Exim's logging.
18131
18132
18133
18134 .option syslog_processname main string &`exim`&
18135 .cindex "syslog" "process name; setting"
18136 This option sets the syslog &"ident"& name, used when Exim is logging to
18137 syslog. The value must be no longer than 32 characters. See chapter
18138 &<<CHAPlog>>& for details of Exim's logging.
18139
18140
18141
18142 .option syslog_timestamp main boolean true
18143 .cindex "syslog" "timestamps"
18144 .cindex timestamps syslog
18145 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
18146 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
18147 details of Exim's logging.
18148
18149
18150 .option system_filter main string&!! unset
18151 .cindex "filter" "system filter"
18152 .cindex "system filter" "specifying"
18153 .cindex "Sieve filter" "not available for system filter"
18154 This option specifies an Exim filter file that is applied to all messages at
18155 the start of each delivery attempt, before any routing is done. System filters
18156 must be Exim filters; they cannot be Sieve filters. If the system filter
18157 generates any deliveries to files or pipes, or any new mail messages, the
18158 appropriate &%system_filter_..._transport%& option(s) must be set, to define
18159 which transports are to be used. Details of this facility are given in chapter
18160 &<<CHAPsystemfilter>>&.
18161 A forced expansion failure results in no filter operation.
18162
18163
18164 .option system_filter_directory_transport main string&!! unset
18165 .vindex "&$address_file$&"
18166 This sets the name of the transport driver that is to be used when the
18167 &%save%& command in a system message filter specifies a path ending in &"/"&,
18168 implying delivery of each message into a separate file in some directory.
18169 During the delivery, the variable &$address_file$& contains the path name.
18170
18171
18172 .option system_filter_file_transport main string&!! unset
18173 .cindex "file" "transport for system filter"
18174 This sets the name of the transport driver that is to be used when the &%save%&
18175 command in a system message filter specifies a path not ending in &"/"&. During
18176 the delivery, the variable &$address_file$& contains the path name.
18177
18178 .option system_filter_group main string unset
18179 .cindex "gid (group id)" "system filter"
18180 This option is used only when &%system_filter_user%& is also set. It sets the
18181 gid under which the system filter is run, overriding any gid that is associated
18182 with the user. The value may be numerical or symbolic.
18183
18184 .option system_filter_pipe_transport main string&!! unset
18185 .cindex "&(pipe)& transport" "for system filter"
18186 .vindex "&$address_pipe$&"
18187 This specifies the transport driver that is to be used when a &%pipe%& command
18188 is used in a system filter. During the delivery, the variable &$address_pipe$&
18189 contains the pipe command.
18190
18191
18192 .option system_filter_reply_transport main string&!! unset
18193 .cindex "&(autoreply)& transport" "for system filter"
18194 This specifies the transport driver that is to be used when a &%mail%& command
18195 is used in a system filter.
18196
18197
18198 .option system_filter_user main string unset
18199 .cindex "uid (user id)" "system filter"
18200 If this option is set to root, the system filter is run in the main Exim
18201 delivery process, as root.  Otherwise, the system filter runs in a separate
18202 process, as the given user, defaulting to the Exim run-time user.
18203 Unless the string consists entirely of digits, it
18204 is looked up in the password data. Failure to find the named user causes a
18205 configuration error. The gid is either taken from the password data, or
18206 specified by &%system_filter_group%&. When the uid is specified numerically,
18207 &%system_filter_group%& is required to be set.
18208
18209 If the system filter generates any pipe, file, or reply deliveries, the uid
18210 under which the filter is run is used when transporting them, unless a
18211 transport option overrides.
18212
18213
18214 .option tcp_nodelay main boolean true
18215 .cindex "daemon" "TCP_NODELAY on sockets"
18216 .cindex "Nagle algorithm"
18217 .cindex "TCP_NODELAY on listening sockets"
18218 If this option is set false, it stops the Exim daemon setting the
18219 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
18220 turns off the &"Nagle algorithm"&, which is a way of improving network
18221 performance in interactive (character-by-character) situations. Turning it off
18222 should improve Exim's performance a bit, so that is what happens by default.
18223 However, it appears that some broken clients cannot cope, and time out. Hence
18224 this option. It affects only those sockets that are set up for listening by the
18225 daemon. Sockets created by the smtp transport for delivering mail always set
18226 TCP_NODELAY.
18227
18228
18229 .option timeout_frozen_after main time 0s
18230 .cindex "frozen messages" "timing out"
18231 .cindex "timeout" "frozen messages"
18232 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
18233 message of any kind that has been in the queue for longer than the given time
18234 is automatically cancelled at the next queue run. If the frozen message is a
18235 bounce message, it is just discarded; otherwise, a bounce is sent to the
18236 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
18237 If you want to timeout frozen bounce messages earlier than other kinds of
18238 frozen message, see &%ignore_bounce_errors_after%&.
18239
18240 &*Note:*& the default value of zero means no timeouts; with this setting,
18241 frozen messages remain in the queue forever (except for any frozen bounce
18242 messages that are released by &%ignore_bounce_errors_after%&).
18243
18244
18245 .option timezone main string unset
18246 .cindex "timezone, setting"
18247 .cindex "environment" "values from"
18248 The value of &%timezone%& is used to set the environment variable TZ while
18249 running Exim (if it is different on entry). This ensures that all timestamps
18250 created by Exim are in the required timezone. If you want all your timestamps
18251 to be in UTC (aka GMT) you should set
18252 .code
18253 timezone = UTC
18254 .endd
18255 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
18256 or, if that is not set, from the value of the TZ environment variable when Exim
18257 is built. If &%timezone%& is set to the empty string, either at build or run
18258 time, any existing TZ variable is removed from the environment when Exim
18259 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
18260 unfortunately not all, operating systems.
18261
18262
18263 .option tls_advertise_hosts main "host list&!!" *
18264 .cindex "TLS" "advertising"
18265 .cindex "encryption" "on SMTP connection"
18266 .cindex "SMTP" "encrypted connection"
18267 .cindex "ESMTP extensions" STARTTLS
18268 When Exim is built with support for TLS encrypted connections, the availability
18269 of the STARTTLS command to set up an encrypted session is advertised in
18270 response to EHLO only to those client hosts that match this option. See
18271 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
18272 Note that the default value requires that a certificate be supplied
18273 using the &%tls_certificate%& option.  If TLS support for incoming connections
18274 is not required the &%tls_advertise_hosts%& option should be set empty.
18275
18276
18277 .option tls_certificate main string list&!! unset
18278 .cindex "TLS" "server certificate; location of"
18279 .cindex "certificate" "server, location of"
18280 The value of this option is expanded, and must then be a list of absolute paths to
18281 files which contain the server's certificates (in PEM format).
18282 Commonly only one file is needed.
18283 The server's private key is also
18284 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
18285 &<<CHAPTLS>>& for further details.
18286
18287 &*Note*&: The certificates defined by this option are used only when Exim is
18288 receiving incoming messages as a server. If you want to supply certificates for
18289 use when sending messages as a client, you must set the &%tls_certificate%&
18290 option in the relevant &(smtp)& transport.
18291
18292 &*Note*&: If you use filenames based on IP addresses, change the list
18293 separator in the usual way (&<<SECTlistsepchange>>&) to avoid confusion under IPv6.
18294
18295 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
18296 when a list of more than one
18297 file is used, the &$tls_in_ourcert$& variable is unreliable.
18298 The macro "_TLS_BAD_MULTICERT_IN_OURCERT" will be defined for those versions.
18299
18300 .cindex SNI "selecting server certificate based on"
18301 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
18302 if the OpenSSL build supports TLS extensions and the TLS client sends the
18303 Server Name Indication extension, then this option and others documented in
18304 &<<SECTtlssni>>& will be re-expanded.
18305
18306 If this option is unset or empty a fresh self-signed certificate will be
18307 generated for every connection.
18308
18309 .option tls_crl main string&!! unset
18310 .cindex "TLS" "server certificate revocation list"
18311 .cindex "certificate" "revocation list for server"
18312 This option specifies a certificate revocation list. The expanded value must
18313 be the name of a file that contains CRLs in PEM format.
18314
18315 Under OpenSSL the option can specify a directory with CRL files.
18316
18317 &*Note:*& Under OpenSSL the option must, if given, supply a CRL
18318 for each signing element of the certificate chain (i.e. all but the leaf).
18319 For the file variant this can be multiple PEM blocks in the one file.
18320
18321 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18322
18323
18324 .option tls_dh_max_bits main integer 2236
18325 .cindex "TLS" "D-H bit count"
18326 The number of bits used for Diffie-Hellman key-exchange may be suggested by
18327 the chosen TLS library.  That value might prove to be too high for
18328 interoperability.  This option provides a maximum clamp on the value
18329 suggested, trading off security for interoperability.
18330
18331 The value must be at least 1024.
18332
18333 The value 2236 was chosen because, at time of adding the option, it was the
18334 hard-coded maximum value supported by the NSS cryptographic library, as used
18335 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
18336
18337 If you prefer more security and are willing to break some clients, raise this
18338 number.
18339
18340 Note that the value passed to GnuTLS for *generating* a new prime may be a
18341 little less than this figure, because GnuTLS is inexact and may produce a
18342 larger prime than requested.
18343
18344
18345 .option tls_dhparam main string&!! unset
18346 .cindex "TLS" "D-H parameters for server"
18347 The value of this option is expanded and indicates the source of DH parameters
18348 to be used by Exim.
18349
18350 This option is ignored for GnuTLS version 3.6.0 and later.
18351 The library manages parameter negotiation internally.
18352
18353 &*Note: The Exim Maintainers strongly recommend,
18354 for other TLS library versions,
18355 using a filename with site-generated
18356 local DH parameters*&, which has been supported across all versions of Exim.  The
18357 other specific constants available are a fallback so that even when
18358 "unconfigured", Exim can offer Perfect Forward Secrecy in older ciphersuites in TLS.
18359
18360 If &%tls_dhparam%& is a filename starting with a &`/`&,
18361 then it names a file from which DH
18362 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
18363 PKCS#3 representation of the DH prime.  If the file does not exist, for
18364 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
18365 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
18366 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
18367 and treated as though the &%tls_dhparam%& were set to "none".
18368
18369 If this option expands to the string "none", then no DH parameters will be
18370 loaded by Exim.
18371
18372 If this option expands to the string "historic" and Exim is using GnuTLS, then
18373 Exim will attempt to load a file from inside the spool directory.  If the file
18374 does not exist, Exim will attempt to create it.
18375 See section &<<SECTgnutlsparam>>& for further details.
18376
18377 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
18378 a default DH prime; the default is Exim-specific but lacks verifiable provenance.
18379
18380 In older versions of Exim the default was the 2048 bit prime described in section
18381 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
18382 in IKE is assigned number 23.
18383
18384 Otherwise, the option must expand to the name used by Exim for any of a number
18385 of DH primes specified in RFC 2409, RFC 3526, RFC 5114, RFC 7919, or from other
18386 sources.  As names, Exim uses a standard specified name, else "ike" followed by
18387 the number used by IKE, or "default" which corresponds to
18388 &`exim.dev.20160529.3`&.
18389
18390 The available standard primes are:
18391 &`ffdhe2048`&, &`ffdhe3072`&, &`ffdhe4096`&, &`ffdhe6144`&, &`ffdhe8192`&,
18392 &`ike1`&, &`ike2`&, &`ike5`&,
18393 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
18394 &`ike22`&, &`ike23`& and &`ike24`&.
18395
18396 The available additional primes are:
18397 &`exim.dev.20160529.1`&, &`exim.dev.20160529.2`& and &`exim.dev.20160529.3`&.
18398
18399 Some of these will be too small to be accepted by clients.
18400 Some may be too large to be accepted by clients.
18401 The open cryptographic community has suspicions about the integrity of some
18402 of the later IKE values, which led into RFC7919 providing new fixed constants
18403 (the "ffdhe" identifiers).
18404
18405 At this point, all of the "ike" values should be considered obsolete;
18406 they're still in Exim to avoid breaking unusual configurations, but are
18407 candidates for removal the next time we have backwards-incompatible changes.
18408
18409 The TLS protocol does not negotiate an acceptable size for this; clients tend
18410 to hard-drop connections if what is offered by the server is unacceptable,
18411 whether too large or too small, and there's no provision for the client to
18412 tell the server what these constraints are.  Thus, as a server operator, you
18413 need to make an educated guess as to what is most likely to work for your
18414 userbase.
18415
18416 Some known size constraints suggest that a bit-size in the range 2048 to 2236
18417 is most likely to maximise interoperability.  The upper bound comes from
18418 applications using the Mozilla Network Security Services (NSS) library, which
18419 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
18420 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
18421 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
18422 acceptable bound from 1024 to 2048.
18423
18424
18425 .option tls_eccurve main string&!! &`auto`&
18426 .cindex TLS "EC cryptography"
18427 This option selects a EC curve for use by Exim when used with OpenSSL.
18428 It has no effect when Exim is used with GnuTLS.
18429
18430 After expansion it must contain a valid EC curve parameter, such as
18431 &`prime256v1`&, &`secp384r1`&, or &`P-512`&. Consult your OpenSSL manual
18432 for valid selections.
18433
18434 For OpenSSL versions before (and not including) 1.0.2, the string
18435 &`auto`& selects &`prime256v1`&. For more recent OpenSSL versions
18436 &`auto`& tells the library to choose.
18437
18438 If the option expands to an empty string, no EC curves will be enabled.
18439
18440
18441 .option tls_ocsp_file main string&!! unset
18442 .cindex TLS "certificate status"
18443 .cindex TLS "OCSP proof file"
18444 This option
18445 must if set expand to the absolute path to a file which contains a current
18446 status proof for the server's certificate, as obtained from the
18447 Certificate Authority.
18448
18449 Usable for GnuTLS 3.4.4 or 3.3.17 or OpenSSL 1.1.0 (or later).
18450 The macro "_HAVE_TLS_OCSP" will be defined for those versions.
18451
18452 For OpenSSL 1.1.0 or later, and
18453 for GnuTLS 3.5.6 or later the expanded value of this option can be a list
18454 of files, to match a list given for the &%tls_certificate%& option.
18455 The ordering of the two lists must match.
18456 The macro "_HAVE_TLS_OCSP_LIST" will be defined for those versions.
18457
18458 The file(s) should be in DER format,
18459 except for GnuTLS 3.6.3 or later
18460 or for OpenSSL,
18461 when an optional filetype prefix can be used.
18462 The prefix must be one of "DER" or "PEM", followed by
18463 a single space.  If one is used it sets the format for subsequent
18464 files in the list; the initial format is DER.
18465 If multiple proofs are wanted, for multiple chain elements
18466 (this only works under TLS1.3)
18467 they must be coded as a combined OCSP response.
18468
18469 Although GnuTLS will accept PEM files with multiple separate
18470 PEM blobs (ie. separate OCSP responses), it sends them in the
18471 TLS Certificate record interleaved with the certificates of the chain;
18472 although a GnuTLS client is happy with that, an OpenSSL client is not.
18473
18474 .option tls_on_connect_ports main "string list" unset
18475 .cindex SSMTP
18476 .cindex SMTPS
18477 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
18478 operate the SSMTP (SMTPS) protocol, where a TLS session is immediately
18479 set up without waiting for the client to issue a STARTTLS command. For
18480 further details, see section &<<SECTsupobssmt>>&.
18481
18482
18483
18484 .option tls_privatekey main string list&!! unset
18485 .cindex "TLS" "server private key; location of"
18486 The value of this option is expanded, and must then be a list of absolute paths to
18487 files which contains the server's private keys.
18488 If this option is unset, or if
18489 the expansion is forced to fail, or the result is an empty string, the private
18490 key is assumed to be in the same file as the server's certificates. See chapter
18491 &<<CHAPTLS>>& for further details.
18492
18493 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18494
18495
18496 .option tls_remember_esmtp main boolean false
18497 .cindex "TLS" "esmtp state; remembering"
18498 .cindex "TLS" "broken clients"
18499 If this option is set true, Exim violates the RFCs by remembering that it is in
18500 &"esmtp"& state after successfully negotiating a TLS session. This provides
18501 support for broken clients that fail to send a new EHLO after starting a
18502 TLS session.
18503
18504
18505 .option tls_require_ciphers main string&!! unset
18506 .cindex "TLS" "requiring specific ciphers"
18507 .cindex "cipher" "requiring specific"
18508 This option controls which ciphers can be used for incoming TLS connections.
18509 The &(smtp)& transport has an option of the same name for controlling outgoing
18510 connections. This option is expanded for each connection, so can be varied for
18511 different clients if required. The value of this option must be a list of
18512 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
18513 in somewhat different ways. If GnuTLS is being used, the client controls the
18514 preference order of the available ciphers. Details are given in sections
18515 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
18516
18517
18518 .new
18519 .option tls_resumption_hosts main "host list&!!" unset
18520 .cindex TLS resumption
18521 This option controls which connections to offer the TLS resumption feature.
18522 See &<<SECTresumption>>& for details.
18523 .wen
18524
18525
18526 .option tls_try_verify_hosts main "host list&!!" unset
18527 .cindex "TLS" "client certificate verification"
18528 .cindex "certificate" "verification of client"
18529 See &%tls_verify_hosts%& below.
18530
18531
18532 .option tls_verify_certificates main string&!! system
18533 .cindex "TLS" "client certificate verification"
18534 .cindex "certificate" "verification of client"
18535 The value of this option is expanded, and must then be either the
18536 word "system"
18537 or the absolute path to
18538 a file or directory containing permitted certificates for clients that
18539 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&.
18540
18541 The "system" value for the option will use a
18542 system default location compiled into the SSL library.
18543 This is not available for GnuTLS versions preceding 3.0.20,
18544 and will be taken as empty; an explicit location
18545 must be specified.
18546
18547 The use of a directory for the option value is not available for GnuTLS versions
18548 preceding 3.3.6 and a single file must be used.
18549
18550 With OpenSSL the certificates specified
18551 explicitly
18552 either by file or directory
18553 are added to those given by the system default location.
18554
18555 These certificates should be for the certificate authorities trusted, rather
18556 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
18557 the value is a file then the certificates are sent by Exim as a server to
18558 connecting clients, defining the list of accepted certificate authorities.
18559 Thus the values defined should be considered public data.  To avoid this,
18560 use the explicit directory version. (If your peer is Exim up to 4.85,
18561 using GnuTLS, you may need to send the CAs (thus using the file
18562 variant). Otherwise the peer doesn't send its certificate.)
18563
18564 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18565
18566 A forced expansion failure or setting to an empty string is equivalent to
18567 being unset.
18568
18569
18570 .option tls_verify_hosts main "host list&!!" unset
18571 .cindex "TLS" "client certificate verification"
18572 .cindex "certificate" "verification of client"
18573 This option, along with &%tls_try_verify_hosts%&, controls the checking of
18574 certificates from clients. The expected certificates are defined by
18575 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
18576 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
18577 &%tls_verify_certificates%& is not set.
18578
18579 Any client that matches &%tls_verify_hosts%& is constrained by
18580 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
18581 present one of the listed certificates. If it does not, the connection is
18582 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
18583 the host to use TLS. It can still send SMTP commands through unencrypted
18584 connections. Forcing a client to use TLS has to be done separately using an
18585 ACL to reject inappropriate commands when the connection is not encrypted.
18586
18587 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
18588 matches this option (but not &%tls_verify_hosts%&), Exim requests a
18589 certificate and checks it against &%tls_verify_certificates%&, but does not
18590 abort the connection if there is no certificate or if it does not match. This
18591 state can be detected in an ACL, which makes it possible to implement policies
18592 such as &"accept for relay only if a verified certificate has been received,
18593 but accept for local delivery if encrypted, even without a verified
18594 certificate"&.
18595
18596 Client hosts that match neither of these lists are not asked to present
18597 certificates.
18598
18599
18600 .option trusted_groups main "string list&!!" unset
18601 .cindex "trusted groups"
18602 .cindex "groups" "trusted"
18603 This option is expanded just once, at the start of Exim's processing. If this
18604 option is set, any process that is running in one of the listed groups, or
18605 which has one of them as a supplementary group, is trusted. The groups can be
18606 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
18607 details of what trusted callers are permitted to do. If neither
18608 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
18609 are trusted.
18610
18611 .option trusted_users main "string list&!!" unset
18612 .cindex "trusted users"
18613 .cindex "user" "trusted"
18614 This option is expanded just once, at the start of Exim's processing. If this
18615 option is set, any process that is running as one of the listed users is
18616 trusted. The users can be specified numerically or by name. See section
18617 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
18618 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
18619 Exim user are trusted.
18620
18621 .option unknown_login main string&!! unset
18622 .cindex "uid (user id)" "unknown caller"
18623 .vindex "&$caller_uid$&"
18624 This is a specialized feature for use in unusual configurations. By default, if
18625 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
18626 gives up. The &%unknown_login%& option can be used to set a login name to be
18627 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
18628 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
18629 is used for the user's real name (gecos field), unless this has been set by the
18630 &%-F%& option.
18631
18632 .option unknown_username main string unset
18633 See &%unknown_login%&.
18634
18635 .option untrusted_set_sender main "address list&!!" unset
18636 .cindex "trusted users"
18637 .cindex "sender" "setting by untrusted user"
18638 .cindex "untrusted user setting sender"
18639 .cindex "user" "untrusted setting sender"
18640 .cindex "envelope from"
18641 .cindex "envelope sender"
18642 When an untrusted user submits a message to Exim using the standard input, Exim
18643 normally creates an envelope sender address from the user's login and the
18644 default qualification domain. Data from the &%-f%& option (for setting envelope
18645 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
18646 is used) is ignored.
18647
18648 However, untrusted users are permitted to set an empty envelope sender address,
18649 to declare that a message should never generate any bounces. For example:
18650 .code
18651 exim -f '<>' user@domain.example
18652 .endd
18653 .vindex "&$sender_ident$&"
18654 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
18655 other envelope sender addresses in a controlled way. When it is set, untrusted
18656 users are allowed to set envelope sender addresses that match any of the
18657 patterns in the list. Like all address lists, the string is expanded. The
18658 identity of the user is in &$sender_ident$&, so you can, for example, restrict
18659 users to setting senders that start with their login ids
18660 followed by a hyphen
18661 by a setting like this:
18662 .code
18663 untrusted_set_sender = ^$sender_ident-
18664 .endd
18665 If you want to allow untrusted users to set envelope sender addresses without
18666 restriction, you can use
18667 .code
18668 untrusted_set_sender = *
18669 .endd
18670 The &%untrusted_set_sender%& option applies to all forms of local input, but
18671 only to the setting of the envelope sender. It does not permit untrusted users
18672 to use the other options which trusted user can use to override message
18673 parameters. Furthermore, it does not stop Exim from removing an existing
18674 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
18675 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
18676 overriding these actions. The handling of the &'Sender:'& header is also
18677 described in section &<<SECTthesenhea>>&.
18678
18679 The log line for a message's arrival shows the envelope sender following
18680 &"<="&. For local messages, the user's login always follows, after &"U="&. In
18681 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
18682 envelope sender address, the user's login is shown in parentheses after the
18683 sender address.
18684
18685
18686 .option uucp_from_pattern main string "see below"
18687 .cindex "&""From""& line"
18688 .cindex "UUCP" "&""From""& line"
18689 Some applications that pass messages to an MTA via a command line interface use
18690 an initial line starting with &"From&~"& to pass the envelope sender. In
18691 particular, this is used by UUCP software. Exim recognizes such a line by means
18692 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
18693 matches, the sender address is constructed by expanding the contents of
18694 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
18695 default pattern recognizes lines in the following two forms:
18696 .code
18697 From ph10 Fri Jan  5 12:35 GMT 1996
18698 From ph10 Fri, 7 Jan 97 14:00:00 GMT
18699 .endd
18700 The pattern can be seen by running
18701 .code
18702 exim -bP uucp_from_pattern
18703 .endd
18704 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
18705 year in the second case. The first word after &"From&~"& is matched in the
18706 regular expression by a parenthesized subpattern. The default value for
18707 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
18708 (&"ph10"& in the example above) as the message's sender. See also
18709 &%ignore_fromline_hosts%&.
18710
18711
18712 .option uucp_from_sender main string&!! &`$1`&
18713 See &%uucp_from_pattern%& above.
18714
18715
18716 .option warn_message_file main string&!! unset
18717 .cindex "warning of delay" "customizing the message"
18718 .cindex "customizing" "warning message"
18719 This option defines a template file containing paragraphs of text to be used
18720 for constructing the warning message which is sent by Exim when a message has
18721 been in the queue for a specified amount of time, as specified by
18722 &%delay_warning%&. Details of the file's contents are given in chapter
18723 &<<CHAPemsgcust>>&.
18724 .cindex warn_message_file "tainted data"
18725 The option is expanded to give the file path, which must be
18726 absolute and untainted.
18727 See also &%bounce_message_file%&.
18728
18729
18730 .option write_rejectlog main boolean true
18731 .cindex "reject log" "disabling"
18732 If this option is set false, Exim no longer writes anything to the reject log.
18733 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
18734 .ecindex IIDconfima
18735 .ecindex IIDmaiconf
18736
18737
18738
18739
18740 . ////////////////////////////////////////////////////////////////////////////
18741 . ////////////////////////////////////////////////////////////////////////////
18742
18743 .chapter "Generic options for routers" "CHAProutergeneric"
18744 .scindex IIDgenoprou1 "options" "generic; for routers"
18745 .scindex IIDgenoprou2 "generic options" "router"
18746 This chapter describes the generic options that apply to all routers.
18747 Those that are preconditions are marked with &Dagger; in the &"use"& field.
18748
18749 For a general description of how a router operates, see sections
18750 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
18751 which the preconditions are tested. The order of expansion of the options that
18752 provide data for a transport is: &%errors_to%&, &%headers_add%&,
18753 &%headers_remove%&, &%transport%&.
18754
18755
18756
18757 .option address_data routers string&!! unset
18758 .cindex "router" "data attached to address"
18759 The string is expanded just before the router is run, that is, after all the
18760 precondition tests have succeeded. If the expansion is forced to fail, the
18761 router declines, the value of &%address_data%& remains unchanged, and the
18762 &%more%& option controls what happens next. Other expansion failures cause
18763 delivery of the address to be deferred.
18764
18765 .vindex "&$address_data$&"
18766 When the expansion succeeds, the value is retained with the address, and can be
18767 accessed using the variable &$address_data$& in the current router, subsequent
18768 routers, and the eventual transport.
18769
18770 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
18771 that runs a user's filter file, the contents of &$address_data$& are accessible
18772 in the filter. This is not normally a problem, because such data is usually
18773 either not confidential or it &"belongs"& to the current user, but if you do
18774 put confidential data into &$address_data$& you need to remember this point.
18775
18776 Even if the router declines or passes, the value of &$address_data$& remains
18777 with the address, though it can be changed by another &%address_data%& setting
18778 on a subsequent router. If a router generates child addresses, the value of
18779 &$address_data$& propagates to them. This also applies to the special kind of
18780 &"child"& that is generated by a router with the &%unseen%& option.
18781
18782 The idea of &%address_data%& is that you can use it to look up a lot of data
18783 for the address once, and then pick out parts of the data later. For example,
18784 you could use a single LDAP lookup to return a string of the form
18785 .code
18786 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
18787 .endd
18788 In the transport you could pick out the mailbox by a setting such as
18789 .code
18790 file = ${extract{mailbox}{$address_data}}
18791 .endd
18792 This makes the configuration file less messy, and also reduces the number of
18793 lookups (though Exim does cache lookups).
18794
18795 See also the &%set%& option below.
18796
18797 .vindex "&$sender_address_data$&"
18798 .vindex "&$address_data$&"
18799 The &%address_data%& facility is also useful as a means of passing information
18800 from one router to another, and from a router to a transport. In addition, if
18801 &$address_data$& is set by a router when verifying a recipient address from an
18802 ACL, it remains available for use in the rest of the ACL statement. After
18803 verifying a sender, the value is transferred to &$sender_address_data$&.
18804
18805
18806
18807 .option address_test routers&!? boolean true
18808 .oindex "&%-bt%&"
18809 .cindex "router" "skipping when address testing"
18810 If this option is set false, the router is skipped when routing is being tested
18811 by means of the &%-bt%& command line option. This can be a convenience when
18812 your first router sends messages to an external scanner, because it saves you
18813 having to set the &"already scanned"& indicator when testing real address
18814 routing.
18815
18816
18817
18818 .option cannot_route_message routers string&!! unset
18819 .cindex "router" "customizing &""cannot route""& message"
18820 .cindex "customizing" "&""cannot route""& message"
18821 This option specifies a text message that is used when an address cannot be
18822 routed because Exim has run out of routers. The default message is
18823 &"Unrouteable address"&. This option is useful only on routers that have
18824 &%more%& set false, or on the very last router in a configuration, because the
18825 value that is used is taken from the last router that is considered. This
18826 includes a router that is skipped because its preconditions are not met, as
18827 well as a router that declines. For example, using the default configuration,
18828 you could put:
18829 .code
18830 cannot_route_message = Remote domain not found in DNS
18831 .endd
18832 on the first router, which is a &(dnslookup)& router with &%more%& set false,
18833 and
18834 .code
18835 cannot_route_message = Unknown local user
18836 .endd
18837 on the final router that checks for local users. If string expansion fails for
18838 this option, the default message is used. Unless the expansion failure was
18839 explicitly forced, a message about the failure is written to the main and panic
18840 logs, in addition to the normal message about the routing failure.
18841
18842
18843 .option caseful_local_part routers boolean false
18844 .cindex "case of local parts"
18845 .cindex "router" "case of local parts"
18846 By default, routers handle the local parts of addresses in a case-insensitive
18847 manner, though the actual case is preserved for transmission with the message.
18848 If you want the case of letters to be significant in a router, you must set
18849 this option true. For individual router options that contain address or local
18850 part lists (for example, &%local_parts%&), case-sensitive matching can be
18851 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
18852 more details.
18853
18854 .vindex "&$local_part$&"
18855 .vindex "&$original_local_part$&"
18856 .vindex "&$parent_local_part$&"
18857 The value of the &$local_part$& variable is forced to lower case while a
18858 router is running unless &%caseful_local_part%& is set. When a router assigns
18859 an address to a transport, the value of &$local_part$& when the transport runs
18860 is the same as it was in the router. Similarly, when a router generates child
18861 addresses by aliasing or forwarding, the values of &$original_local_part$&
18862 and &$parent_local_part$& are those that were used by the redirecting router.
18863
18864 This option applies to the processing of an address by a router. When a
18865 recipient address is being processed in an ACL, there is a separate &%control%&
18866 modifier that can be used to specify case-sensitive processing within the ACL
18867 (see section &<<SECTcontrols>>&).
18868
18869
18870
18871 .option check_local_user routers&!? boolean false
18872 .cindex "local user, checking in router"
18873 .cindex "router" "checking for local user"
18874 .cindex "&_/etc/passwd_&"
18875 .vindex "&$home$&"
18876 When this option is true, Exim checks that the local part of the recipient
18877 address (with affixes removed if relevant) is the name of an account on the
18878 local system. The check is done by calling the &[getpwnam()]& function rather
18879 than trying to read &_/etc/passwd_& directly. This means that other methods of
18880 holding password data (such as NIS) are supported. If the local part is a local
18881 user,
18882 .cindex "tainted data" "de-tainting"
18883 &$local_part_data$& is set to an untainted version of the local part and
18884 &$home$& is set from the password data. The latter can be tested in other
18885 preconditions that are evaluated after this one (the order of evaluation is
18886 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
18887 overridden by &%router_home_directory%&. If the local part is not a local user,
18888 the router is skipped.
18889
18890 If you want to check that the local part is either the name of a local user
18891 or matches something else, you cannot combine &%check_local_user%& with a
18892 setting of &%local_parts%&, because that specifies the logical &'and'& of the
18893 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
18894 setting to achieve this. For example:
18895 .code
18896 local_parts = passwd;$local_part : lsearch;/etc/other/users
18897 .endd
18898 Note, however, that the side effects of &%check_local_user%& (such as setting
18899 up a home directory) do not occur when a &(passwd)& lookup is used in a
18900 &%local_parts%& (or any other) precondition.
18901
18902
18903
18904 .option condition routers&!? string&!! unset
18905 .cindex "router" "customized precondition"
18906 This option specifies a general precondition test that has to succeed for the
18907 router to be called. The &%condition%& option is the last precondition to be
18908 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
18909 result is a forced failure, or an empty string, or one of the strings &"0"& or
18910 &"no"& or &"false"& (checked without regard to the case of the letters), the
18911 router is skipped, and the address is offered to the next one.
18912
18913 If the result is any other value, the router is run (as this is the last
18914 precondition to be evaluated, all the other preconditions must be true).
18915
18916 This option is unusual in that multiple &%condition%& options may be present.
18917 All &%condition%& options must succeed.
18918
18919 The &%condition%& option provides a means of applying custom conditions to the
18920 running of routers. Note that in the case of a simple conditional expansion,
18921 the default expansion values are exactly what is wanted. For example:
18922 .code
18923 condition = ${if >{$message_age}{600}}
18924 .endd
18925 Because of the default behaviour of the string expansion, this is equivalent to
18926 .code
18927 condition = ${if >{$message_age}{600}{true}{}}
18928 .endd
18929
18930 A multiple condition example, which succeeds:
18931 .code
18932 condition = ${if >{$message_age}{600}}
18933 condition = ${if !eq{${lc:$local_part}}{postmaster}}
18934 condition = foobar
18935 .endd
18936
18937 If the expansion fails (other than forced failure) delivery is deferred. Some
18938 of the other precondition options are common special cases that could in fact
18939 be specified using &%condition%&.
18940
18941 Historical note: We have &%condition%& on ACLs and on Routers.  Routers
18942 are far older, and use one set of semantics.  ACLs are newer and when
18943 they were created, the ACL &%condition%& process was given far stricter
18944 parse semantics.  The &%bool{}%& expansion condition uses the same rules as
18945 ACLs.  The &%bool_lax{}%& expansion condition uses the same rules as
18946 Routers.  More pointedly, the &%bool_lax{}%& was written to match the existing
18947 Router rules processing behavior.
18948
18949 This is best illustrated in an example:
18950 .code
18951 # If used in an ACL condition will fail with a syntax error, but
18952 # in a router condition any extra characters are treated as a string
18953
18954 $ exim -be '${if eq {${lc:GOOGLE.com}} {google.com}} {yes} {no}}'
18955 true {yes} {no}}
18956
18957 $ exim -be '${if eq {${lc:WHOIS.com}} {google.com}} {yes} {no}}'
18958  {yes} {no}}
18959 .endd
18960 In each example above, the &%if%& statement actually ends after
18961 &"{google.com}}"&.  Since no true or false braces were defined, the
18962 default &%if%& behavior is to return a boolean true or a null answer
18963 (which evaluates to false). The rest of the line is then treated as a
18964 string. So the first example resulted in the boolean answer &"true"&
18965 with the string &" {yes} {no}}"& appended to it. The second example
18966 resulted in the null output (indicating false) with the string
18967 &" {yes} {no}}"& appended to it.
18968
18969 In fact you can put excess forward braces in too.  In the router
18970 &%condition%&, Exim's parser only looks for &"{"& symbols when they
18971 mean something, like after a &"$"& or when required as part of a
18972 conditional.  But otherwise &"{"& and &"}"& are treated as ordinary
18973 string characters.
18974
18975 Thus, in a Router, the above expansion strings will both always evaluate
18976 true, as the result of expansion is a non-empty string which doesn't
18977 match an explicit false value.  This can be tricky to debug.  By
18978 contrast, in an ACL either of those strings will always result in an
18979 expansion error because the result doesn't look sufficiently boolean.
18980
18981
18982 .option debug_print routers string&!! unset
18983 .cindex "testing" "variables in drivers"
18984 If this option is set and debugging is enabled (see the &%-d%& command line
18985 option) or in address-testing mode (see the &%-bt%& command line option),
18986 the string is expanded and included in the debugging output.
18987 If expansion of the string fails, the error message is written to the debugging
18988 output, and Exim carries on processing.
18989 This option is provided to help with checking out the values of variables and
18990 so on when debugging router configurations. For example, if a &%condition%&
18991 option appears not to be working, &%debug_print%& can be used to output the
18992 variables it references. The output happens after checks for &%domains%&,
18993 &%local_parts%&, and &%check_local_user%& but before any other preconditions
18994 are tested. A newline is added to the text if it does not end with one.
18995 The variable &$router_name$& contains the name of the router.
18996
18997
18998
18999 .option disable_logging routers boolean false
19000 If this option is set true, nothing is logged for any routing errors
19001 or for any deliveries caused by this router. You should not set this option
19002 unless you really, really know what you are doing. See also the generic
19003 transport option of the same name.
19004
19005 .option dnssec_request_domains routers "domain list&!!" *
19006 .cindex "MX record" "security"
19007 .cindex "DNSSEC" "MX lookup"
19008 .cindex "security" "MX lookup"
19009 .cindex "DNS" "DNSSEC"
19010 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
19011 the dnssec request bit set.
19012 This applies to all of the SRV, MX, AAAA, A lookup sequence.
19013
19014 .option dnssec_require_domains routers "domain list&!!" unset
19015 .cindex "MX record" "security"
19016 .cindex "DNSSEC" "MX lookup"
19017 .cindex "security" "MX lookup"
19018 .cindex "DNS" "DNSSEC"
19019 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
19020 the dnssec request bit set.  Any returns not having the Authenticated Data bit
19021 (AD bit) set will be ignored and logged as a host-lookup failure.
19022 This applies to all of the SRV, MX, AAAA, A lookup sequence.
19023
19024
19025 .option domains routers&!? "domain list&!!" unset
19026 .cindex "router" "restricting to specific domains"
19027 .vindex "&$domain_data$&"
19028 If this option is set, the router is skipped unless the current domain matches
19029 the list. If the match is achieved by means of a file lookup, the data that the
19030 lookup returned for the domain is placed in &$domain_data$& for use in string
19031 expansions of the driver's private options and in the transport.
19032 See section &<<SECTrouprecon>>& for
19033 a list of the order in which preconditions are evaluated.
19034
19035
19036
19037 .option driver routers string unset
19038 This option must always be set. It specifies which of the available routers is
19039 to be used.
19040
19041
19042 .option dsn_lasthop routers boolean false
19043 .cindex "DSN" "success"
19044 .cindex "Delivery Status Notification" "success"
19045 If this option is set true, and extended DSN (RFC3461) processing is in effect,
19046 Exim will not pass on DSN requests to downstream DSN-aware hosts but will
19047 instead send a success DSN as if the next hop does not support DSN.
19048 Not effective on redirect routers.
19049
19050
19051
19052 .option errors_to routers string&!! unset
19053 .cindex "envelope from"
19054 .cindex "envelope sender"
19055 .cindex "router" "changing address for errors"
19056 If a router successfully handles an address, it may assign the address to a
19057 transport for delivery or it may generate child addresses. In both cases, if
19058 there is a delivery problem during later processing, the resulting bounce
19059 message is sent to the address that results from expanding this string,
19060 provided that the address verifies successfully. The &%errors_to%& option is
19061 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
19062
19063 The &%errors_to%& setting associated with an address can be overridden if it
19064 subsequently passes through other routers that have their own &%errors_to%&
19065 settings, or if the message is delivered by a transport with a &%return_path%&
19066 setting.
19067
19068 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
19069 the expansion fails to verify, the errors address associated with the incoming
19070 address is used. At top level, this is the envelope sender. A non-forced
19071 expansion failure causes delivery to be deferred.
19072
19073 If an address for which &%errors_to%& has been set ends up being delivered over
19074 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
19075 any bounces that are generated by other MTAs on the delivery route are also
19076 sent there. You can set &%errors_to%& to the empty string by either of these
19077 settings:
19078 .code
19079 errors_to =
19080 errors_to = ""
19081 .endd
19082 An expansion item that yields an empty string has the same effect. If you do
19083 this, a locally detected delivery error for addresses processed by this router
19084 no longer gives rise to a bounce message; the error is discarded. If the
19085 address is delivered to a remote host, the return path is set to &`<>`&, unless
19086 overridden by the &%return_path%& option on the transport.
19087
19088 .vindex "&$address_data$&"
19089 If for some reason you want to discard local errors, but use a non-empty
19090 MAIL command for remote delivery, you can preserve the original return
19091 path in &$address_data$& in the router, and reinstate it in the transport by
19092 setting &%return_path%&.
19093
19094 The most common use of &%errors_to%& is to direct mailing list bounces to the
19095 manager of the list, as described in section &<<SECTmailinglists>>&, or to
19096 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
19097
19098
19099
19100 .option expn routers&!? boolean true
19101 .cindex "address" "testing"
19102 .cindex "testing" "addresses"
19103 .cindex "EXPN" "router skipping"
19104 .cindex "router" "skipping for EXPN"
19105 If this option is turned off, the router is skipped when testing an address
19106 as a result of processing an SMTP EXPN command. You might, for example,
19107 want to turn it off on a router for users' &_.forward_& files, while leaving it
19108 on for the system alias file.
19109 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19110 are evaluated.
19111
19112 The use of the SMTP EXPN command is controlled by an ACL (see chapter
19113 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
19114 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
19115
19116
19117
19118 .option fail_verify routers boolean false
19119 .cindex "router" "forcing verification failure"
19120 Setting this option has the effect of setting both &%fail_verify_sender%& and
19121 &%fail_verify_recipient%& to the same value.
19122
19123
19124
19125 .option fail_verify_recipient routers boolean false
19126 If this option is true and an address is accepted by this router when
19127 verifying a recipient, verification fails.
19128
19129
19130
19131 .option fail_verify_sender routers boolean false
19132 If this option is true and an address is accepted by this router when
19133 verifying a sender, verification fails.
19134
19135
19136
19137 .option fallback_hosts routers "string list" unset
19138 .cindex "router" "fallback hosts"
19139 .cindex "fallback" "hosts specified on router"
19140 String expansion is not applied to this option. The argument must be a
19141 colon-separated list of host names or IP addresses. The list separator can be
19142 changed (see section &<<SECTlistsepchange>>&), and a port can be specified with
19143 each name or address. In fact, the format of each item is exactly the same as
19144 defined for the list of hosts in a &(manualroute)& router (see section
19145 &<<SECTformatonehostitem>>&).
19146
19147 If a router queues an address for a remote transport, this host list is
19148 associated with the address, and used instead of the transport's fallback host
19149 list. If &%hosts_randomize%& is set on the transport, the order of the list is
19150 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
19151 transport for further details.
19152
19153
19154 .option group routers string&!! "see below"
19155 .cindex "gid (group id)" "local delivery"
19156 .cindex "local transports" "uid and gid"
19157 .cindex "transport" "local"
19158 .cindex "router" "setting group"
19159 When a router queues an address for a transport, and the transport does not
19160 specify a group, the group given here is used when running the delivery
19161 process.
19162 The group may be specified numerically or by name. If expansion fails, the
19163 error is logged and delivery is deferred.
19164 The default is unset, unless &%check_local_user%& is set, when the default
19165 is taken from the password information. See also &%initgroups%& and &%user%&
19166 and the discussion in chapter &<<CHAPenvironment>>&.
19167
19168
19169
19170 .option headers_add routers list&!! unset
19171 .cindex "header lines" "adding"
19172 .cindex "router" "adding header lines"
19173 This option specifies a list of text headers,
19174 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
19175 that is associated with any addresses that are accepted by the router.
19176 Each item is separately expanded, at routing time.  However, this
19177 option has no effect when an address is just being verified. The way in which
19178 the text is used to add header lines at transport time is described in section
19179 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
19180 message is in the process of being transported. This means that references to
19181 header lines in string expansions in the transport's configuration do not
19182 &"see"& the added header lines.
19183
19184 The &%headers_add%& option is expanded after &%errors_to%&, but before
19185 &%headers_remove%& and &%transport%&. If an item is empty, or if
19186 an item expansion is forced to fail, the item has no effect. Other expansion
19187 failures are treated as configuration errors.
19188
19189 Unlike most options, &%headers_add%& can be specified multiple times
19190 for a router; all listed headers are added.
19191
19192 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
19193 router that has the &%one_time%& option set.
19194
19195 .cindex "duplicate addresses"
19196 .oindex "&%unseen%&"
19197 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
19198 additions are deleted when the address is passed on to subsequent routers.
19199 For a &%redirect%& router, if a generated address is the same as the incoming
19200 address, this can lead to duplicate addresses with different header
19201 modifications. Exim does not do duplicate deliveries (except, in certain
19202 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
19203 which of the duplicates is discarded, so this ambiguous situation should be
19204 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
19205
19206
19207
19208 .option headers_remove routers list&!! unset
19209 .cindex "header lines" "removing"
19210 .cindex "router" "removing header lines"
19211 This option specifies a list of text headers,
19212 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
19213 that is associated with any addresses that are accepted by the router.
19214 However, the option has no effect when an address is just being verified.
19215 Each list item is separately expanded, at transport time.
19216 If an item ends in *, it will match any header with the given prefix.
19217 The way in which
19218 the text is used to remove header lines at transport time is described in
19219 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
19220 the message is in the process of being transported. This means that references
19221 to header lines in string expansions in the transport's configuration still
19222 &"see"& the original header lines.
19223
19224 The &%headers_remove%& option is handled after &%errors_to%& and
19225 &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail,
19226 the item has no effect. Other expansion failures are treated as configuration
19227 errors.
19228
19229 Unlike most options, &%headers_remove%& can be specified multiple times
19230 for a router; all listed headers are removed.
19231
19232 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
19233 router that has the &%one_time%& option set.
19234
19235 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
19236 removal requests are deleted when the address is passed on to subsequent
19237 routers, and this can lead to problems with duplicates -- see the similar
19238 warning for &%headers_add%& above.
19239
19240 &*Warning 3*&: Because of the separate expansion of the list items,
19241 items that contain a list separator must have it doubled.
19242 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
19243
19244
19245
19246 .option ignore_target_hosts routers "host list&!!" unset
19247 .cindex "IP address" "discarding"
19248 .cindex "router" "discarding IP addresses"
19249 Although this option is a host list, it should normally contain IP address
19250 entries rather than names. If any host that is looked up by the router has an
19251 IP address that matches an item in this list, Exim behaves as if that IP
19252 address did not exist. This option allows you to cope with rogue DNS entries
19253 like
19254 .code
19255 remote.domain.example.  A  127.0.0.1
19256 .endd
19257 by setting
19258 .code
19259 ignore_target_hosts = 127.0.0.1
19260 .endd
19261 on the relevant router. If all the hosts found by a &(dnslookup)& router are
19262 discarded in this way, the router declines. In a conventional configuration, an
19263 attempt to mail to such a domain would normally provoke the &"unrouteable
19264 domain"& error, and an attempt to verify an address in the domain would fail.
19265 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
19266 router declines if presented with one of the listed addresses.
19267
19268 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
19269 means of the first or the second of the following settings, respectively:
19270 .code
19271 ignore_target_hosts = 0.0.0.0/0
19272 ignore_target_hosts = <; 0::0/0
19273 .endd
19274 The pattern in the first line matches all IPv4 addresses, whereas the pattern
19275 in the second line matches all IPv6 addresses.
19276
19277 This option may also be useful for ignoring link-local and site-local IPv6
19278 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
19279 is expanded before use as a list, it is possible to make it dependent on the
19280 domain that is being routed.
19281
19282 .vindex "&$host_address$&"
19283 During its expansion, &$host_address$& is set to the IP address that is being
19284 checked.
19285
19286 .option initgroups routers boolean false
19287 .cindex "additional groups"
19288 .cindex "groups" "additional"
19289 .cindex "local transports" "uid and gid"
19290 .cindex "transport" "local"
19291 If the router queues an address for a transport, and this option is true, and
19292 the uid supplied by the router is not overridden by the transport, the
19293 &[initgroups()]& function is called when running the transport to ensure that
19294 any additional groups associated with the uid are set up. See also &%group%&
19295 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
19296
19297
19298
19299 .option local_part_prefix routers&!? "string list" unset
19300 .cindex affix "router precondition"
19301 .cindex "router" "prefix for local part"
19302 .cindex "prefix" "for local part, used in router"
19303 If this option is set, the router is skipped unless the local part starts with
19304 one of the given strings, or &%local_part_prefix_optional%& is true. See
19305 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
19306 evaluated.
19307
19308 The list is scanned from left to right, and the first prefix that matches is
19309 used. A limited form of wildcard is available; if the prefix begins with an
19310 asterisk, it matches the longest possible sequence of arbitrary characters at
19311 the start of the local part. An asterisk should therefore always be followed by
19312 some character that does not occur in normal local parts.
19313 .cindex "multiple mailboxes"
19314 .cindex "mailbox" "multiple"
19315 Wildcarding can be used to set up multiple user mailboxes, as described in
19316 section &<<SECTmulbox>>&.
19317
19318 .vindex "&$local_part$&"
19319 .vindex "&$local_part_prefix$&"
19320 During the testing of the &%local_parts%& option, and while the router is
19321 running, the prefix is removed from the local part, and is available in the
19322 expansion variable &$local_part_prefix$&. When a message is being delivered, if
19323 the router accepts the address, this remains true during subsequent delivery by
19324 a transport. In particular, the local part that is transmitted in the RCPT
19325 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
19326 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
19327 the relevant transport.
19328
19329 .vindex &$local_part_prefix_v$&
19330 If wildcarding (above) was used then the part of the prefix matching the
19331 wildcard is available in &$local_part_prefix_v$&.
19332
19333 When an address is being verified, &%local_part_prefix%& affects only the
19334 behaviour of the router. If the callout feature of verification is in use, this
19335 means that the full address, including the prefix, will be used during the
19336 callout.
19337
19338 The prefix facility is commonly used to handle local parts of the form
19339 &%owner-something%&. Another common use is to support local parts of the form
19340 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
19341 to tell a user their forwarding is broken &-- by placing a router like this one
19342 immediately before the router that handles &_.forward_& files:
19343 .code
19344 real_localuser:
19345   driver = accept
19346   local_part_prefix = real-
19347   check_local_user
19348   transport = local_delivery
19349 .endd
19350 For security, it would probably be a good idea to restrict the use of this
19351 router to locally-generated messages, using a condition such as this:
19352 .code
19353   condition = ${if match {$sender_host_address}\
19354                          {\N^(|127\.0\.0\.1)$\N}}
19355 .endd
19356
19357 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
19358 both conditions must be met if not optional. Care must be taken if wildcards
19359 are used in both a prefix and a suffix on the same router. Different
19360 separator characters must be used to avoid ambiguity.
19361
19362
19363 .option local_part_prefix_optional routers boolean false
19364 See &%local_part_prefix%& above.
19365
19366
19367
19368 .option local_part_suffix routers&!? "string list" unset
19369 .cindex "router" "suffix for local part"
19370 .cindex "suffix for local part" "used in router"
19371 This option operates in the same way as &%local_part_prefix%&, except that the
19372 local part must end (rather than start) with the given string, the
19373 &%local_part_suffix_optional%& option determines whether the suffix is
19374 mandatory, and the wildcard * character, if present, must be the last
19375 character of the suffix. This option facility is commonly used to handle local
19376 parts of the form &%something-request%& and multiple user mailboxes of the form
19377 &%username-foo%&.
19378
19379
19380 .option local_part_suffix_optional routers boolean false
19381 See &%local_part_suffix%& above.
19382
19383
19384
19385 .option local_parts routers&!? "local part list&!!" unset
19386 .cindex "router" "restricting to specific local parts"
19387 .cindex "local part" "checking in router"
19388 The router is run only if the local part of the address matches the list.
19389 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19390 are evaluated, and
19391 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
19392 string is expanded, it is possible to make it depend on the domain, for
19393 example:
19394 .code
19395 local_parts = dbm;/usr/local/specials/$domain_data
19396 .endd
19397 .vindex "&$local_part_data$&"
19398 If the match is achieved by a lookup, the data that the lookup returned
19399 for the local part is placed in the variable &$local_part_data$& for use in
19400 expansions of the router's private options or in the transport.
19401 You might use this option, for
19402 example, if you have a large number of local virtual domains, and you want to
19403 send all postmaster mail to the same place without having to set up an alias in
19404 each virtual domain:
19405 .code
19406 postmaster:
19407   driver = redirect
19408   local_parts = postmaster
19409   data = postmaster@real.domain.example
19410 .endd
19411
19412
19413 .option log_as_local routers boolean "see below"
19414 .cindex "log" "delivery line"
19415 .cindex "delivery" "log line format"
19416 Exim has two logging styles for delivery, the idea being to make local
19417 deliveries stand out more visibly from remote ones. In the &"local"& style, the
19418 recipient address is given just as the local part, without a domain. The use of
19419 this style is controlled by this option. It defaults to true for the &(accept)&
19420 router, and false for all the others. This option applies only when a
19421 router assigns an address to a transport. It has no effect on routers that
19422 redirect addresses.
19423
19424
19425
19426 .option more routers boolean&!! true
19427 The result of string expansion for this option must be a valid boolean value,
19428 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
19429 result causes an error, and delivery is deferred. If the expansion is forced to
19430 fail, the default value for the option (true) is used. Other failures cause
19431 delivery to be deferred.
19432
19433 If this option is set false, and the router declines to handle the address, no
19434 further routers are tried, routing fails, and the address is bounced.
19435 .oindex "&%self%&"
19436 However, if the router explicitly passes an address to the following router by
19437 means of the setting
19438 .code
19439 self = pass
19440 .endd
19441 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
19442 does not affect the behaviour if one of the precondition tests fails. In that
19443 case, the address is always passed to the next router.
19444
19445 Note that &%address_data%& is not considered to be a precondition. If its
19446 expansion is forced to fail, the router declines, and the value of &%more%&
19447 controls what happens next.
19448
19449
19450 .option pass_on_timeout routers boolean false
19451 .cindex "timeout" "of router"
19452 .cindex "router" "timeout"
19453 If a router times out during a host lookup, it normally causes deferral of the
19454 address. If &%pass_on_timeout%& is set, the address is passed on to the next
19455 router, overriding &%no_more%&. This may be helpful for systems that are
19456 intermittently connected to the Internet, or those that want to pass to a smart
19457 host any messages that cannot immediately be delivered.
19458
19459 There are occasional other temporary errors that can occur while doing DNS
19460 lookups. They are treated in the same way as a timeout, and this option
19461 applies to all of them.
19462
19463
19464
19465 .option pass_router routers string unset
19466 .cindex "router" "go to after &""pass""&"
19467 Routers that recognize the generic &%self%& option (&(dnslookup)&,
19468 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
19469 routing to continue, and overriding a false setting of &%more%&. When one of
19470 these routers returns &"pass"&, the address is normally handed on to the next
19471 router in sequence. This can be changed by setting &%pass_router%& to the name
19472 of another router. However (unlike &%redirect_router%&) the named router must
19473 be below the current router, to avoid loops. Note that this option applies only
19474 to the special case of &"pass"&. It does not apply when a router returns
19475 &"decline"& because it cannot handle an address.
19476
19477
19478
19479 .option redirect_router routers string unset
19480 .cindex "router" "start at after redirection"
19481 Sometimes an administrator knows that it is pointless to reprocess addresses
19482 generated from alias or forward files with the same router again. For
19483 example, if an alias file translates real names into login ids there is no
19484 point searching the alias file a second time, especially if it is a large file.
19485
19486 The &%redirect_router%& option can be set to the name of any router instance.
19487 It causes the routing of any generated addresses to start at the named router
19488 instead of at the first router. This option has no effect if the router in
19489 which it is set does not generate new addresses.
19490
19491
19492
19493 .option require_files routers&!? "string list&!!" unset
19494 .cindex "file" "requiring for router"
19495 .cindex "router" "requiring file existence"
19496 This option provides a general mechanism for predicating the running of a
19497 router on the existence or non-existence of certain files or directories.
19498 Before running a router, as one of its precondition tests, Exim works its way
19499 through the &%require_files%& list, expanding each item separately.
19500
19501 Because the list is split before expansion, any colons in expansion items must
19502 be doubled, or the facility for using a different list separator must be used
19503 (&<<SECTlistsepchange>>&).
19504 If any expansion is forced to fail, the item is ignored. Other expansion
19505 failures cause routing of the address to be deferred.
19506
19507 If any expanded string is empty, it is ignored. Otherwise, except as described
19508 below, each string must be a fully qualified file path, optionally preceded by
19509 &"!"&. The paths are passed to the &[stat()]& function to test for the
19510 existence of the files or directories. The router is skipped if any paths not
19511 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
19512
19513 .cindex "NFS"
19514 If &[stat()]& cannot determine whether a file exists or not, delivery of
19515 the message is deferred. This can happen when NFS-mounted filesystems are
19516 unavailable.
19517
19518 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
19519 options, so you cannot use it to check for the existence of a file in which to
19520 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
19521 full list of the order in which preconditions are evaluated.) However, as
19522 these options are all expanded, you can use the &%exists%& expansion condition
19523 to make such tests. The &%require_files%& option is intended for checking files
19524 that the router may be going to use internally, or which are needed by a
19525 transport (e.g., &_.procmailrc_&).
19526
19527 During delivery, the &[stat()]& function is run as root, but there is a
19528 facility for some checking of the accessibility of a file by another user.
19529 This is not a proper permissions check, but just a &"rough"& check that
19530 operates as follows:
19531
19532 If an item in a &%require_files%& list does not contain any forward slash
19533 characters, it is taken to be the user (and optional group, separated by a
19534 comma) to be checked for subsequent files in the list. If no group is specified
19535 but the user is specified symbolically, the gid associated with the uid is
19536 used. For example:
19537 .code
19538 require_files = mail:/some/file
19539 require_files = $local_part_data:$home/.procmailrc
19540 .endd
19541 If a user or group name in a &%require_files%& list does not exist, the
19542 &%require_files%& condition fails.
19543
19544 Exim performs the check by scanning along the components of the file path, and
19545 checking the access for the given uid and gid. It checks for &"x"& access on
19546 directories, and &"r"& access on the final file. Note that this means that file
19547 access control lists, if the operating system has them, are ignored.
19548
19549 &*Warning 1*&: When the router is being run to verify addresses for an
19550 incoming SMTP message, Exim is not running as root, but under its own uid. This
19551 may affect the result of a &%require_files%& check. In particular, &[stat()]&
19552 may yield the error EACCES (&"Permission denied"&). This means that the Exim
19553 user is not permitted to read one of the directories on the file's path.
19554
19555 &*Warning 2*&: Even when Exim is running as root while delivering a message,
19556 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
19557 without root access. In this case, if a check for access by a particular user
19558 is requested, Exim creates a subprocess that runs as that user, and tries the
19559 check again in that process.
19560
19561 The default action for handling an unresolved EACCES is to consider it to
19562 be caused by a configuration error, and routing is deferred because the
19563 existence or non-existence of the file cannot be determined. However, in some
19564 circumstances it may be desirable to treat this condition as if the file did
19565 not exist. If the filename (or the exclamation mark that precedes the filename
19566 for non-existence) is preceded by a plus sign, the EACCES error is treated
19567 as if the file did not exist. For example:
19568 .code
19569 require_files = +/some/file
19570 .endd
19571 If the router is not an essential part of verification (for example, it
19572 handles users' &_.forward_& files), another solution is to set the &%verify%&
19573 option false so that the router is skipped when verifying.
19574
19575
19576
19577 .option retry_use_local_part routers boolean "see below"
19578 .cindex "hints database" "retry keys"
19579 .cindex "local part" "in retry keys"
19580 When a delivery suffers a temporary routing failure, a retry record is created
19581 in Exim's hints database. For addresses whose routing depends only on the
19582 domain, the key for the retry record should not involve the local part, but for
19583 other addresses, both the domain and the local part should be included.
19584 Usually, remote routing is of the former kind, and local routing is of the
19585 latter kind.
19586
19587 This option controls whether the local part is used to form the key for retry
19588 hints for addresses that suffer temporary errors while being handled by this
19589 router. The default value is true for any router that has any of
19590 &%check_local_user%&,
19591 &%local_parts%&,
19592 &%condition%&,
19593 &%local_part_prefix%&,
19594 &%local_part_suffix%&,
19595 &%senders%& or
19596 &%require_files%&
19597 set, and false otherwise. Note that this option does not apply to hints keys
19598 for transport delays; they are controlled by a generic transport option of the
19599 same name.
19600
19601 Failing to set this option when it is needed
19602 (because a remote router handles only some of the local-parts for a domain)
19603 can result in incorrect error messages being generated.
19604
19605 The setting of &%retry_use_local_part%& applies only to the router on which it
19606 appears. If the router generates child addresses, they are routed
19607 independently; this setting does not become attached to them.
19608
19609
19610
19611 .option router_home_directory routers string&!! unset
19612 .cindex "router" "home directory for"
19613 .cindex "home directory" "for router"
19614 .vindex "&$home$&"
19615 This option sets a home directory for use while the router is running. (Compare
19616 &%transport_home_directory%&, which sets a home directory for later
19617 transporting.) In particular, if used on a &(redirect)& router, this option
19618 sets a value for &$home$& while a filter is running. The value is expanded;
19619 forced expansion failure causes the option to be ignored &-- other failures
19620 cause the router to defer.
19621
19622 Expansion of &%router_home_directory%& happens immediately after the
19623 &%check_local_user%& test (if configured), before any further expansions take
19624 place.
19625 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19626 are evaluated.)
19627 While the router is running, &%router_home_directory%& overrides the value of
19628 &$home$& that came from &%check_local_user%&.
19629
19630 When a router accepts an address and assigns it to a local transport (including
19631 the cases when a &(redirect)& router generates a pipe, file, or autoreply
19632 delivery), the home directory setting for the transport is taken from the first
19633 of these values that is set:
19634
19635 .ilist
19636 The &%home_directory%& option on the transport;
19637 .next
19638 The &%transport_home_directory%& option on the router;
19639 .next
19640 The password data if &%check_local_user%& is set on the router;
19641 .next
19642 The &%router_home_directory%& option on the router.
19643 .endlist
19644
19645 In other words, &%router_home_directory%& overrides the password data for the
19646 router, but not for the transport.
19647
19648
19649
19650 .option self routers string freeze
19651 .cindex "MX record" "pointing to local host"
19652 .cindex "local host" "MX pointing to"
19653 This option applies to those routers that use a recipient address to find a
19654 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
19655 and &(manualroute)& routers.
19656 Certain configurations of the &(queryprogram)& router can also specify a list
19657 of remote hosts.
19658 Usually such routers are configured to send the message to a remote host via an
19659 &(smtp)& transport. The &%self%& option specifies what happens when the first
19660 host on the list turns out to be the local host.
19661 The way in which Exim checks for the local host is described in section
19662 &<<SECTreclocipadd>>&.
19663
19664 Normally this situation indicates either an error in Exim's configuration (for
19665 example, the router should be configured not to process this domain), or an
19666 error in the DNS (for example, the MX should not point to this host). For this
19667 reason, the default action is to log the incident, defer the address, and
19668 freeze the message. The following alternatives are provided for use in special
19669 cases:
19670
19671 .vlist
19672 .vitem &%defer%&
19673 Delivery of the message is tried again later, but the message is not frozen.
19674
19675 .vitem "&%reroute%&: <&'domain'&>"
19676 The domain is changed to the given domain, and the address is passed back to
19677 be reprocessed by the routers. No rewriting of headers takes place. This
19678 behaviour is essentially a redirection.
19679
19680 .vitem "&%reroute: rewrite:%& <&'domain'&>"
19681 The domain is changed to the given domain, and the address is passed back to be
19682 reprocessed by the routers. Any headers that contain the original domain are
19683 rewritten.
19684
19685 .vitem &%pass%&
19686 .oindex "&%more%&"
19687 .vindex "&$self_hostname$&"
19688 The router passes the address to the next router, or to the router named in the
19689 &%pass_router%& option if it is set. This overrides &%no_more%&. During
19690 subsequent routing and delivery, the variable &$self_hostname$& contains the
19691 name of the local host that the router encountered. This can be used to
19692 distinguish between different cases for hosts with multiple names. The
19693 combination
19694 .code
19695 self = pass
19696 no_more
19697 .endd
19698 ensures that only those addresses that routed to the local host are passed on.
19699 Without &%no_more%&, addresses that were declined for other reasons would also
19700 be passed to the next router.
19701
19702 .vitem &%fail%&
19703 Delivery fails and an error report is generated.
19704
19705 .vitem &%send%&
19706 .cindex "local host" "sending to"
19707 The anomaly is ignored and the address is queued for the transport. This
19708 setting should be used with extreme caution. For an &(smtp)& transport, it
19709 makes sense only in cases where the program that is listening on the SMTP port
19710 is not this version of Exim. That is, it must be some other MTA, or Exim with a
19711 different configuration file that handles the domain in another way.
19712 .endlist
19713
19714
19715
19716 .option senders routers&!? "address list&!!" unset
19717 .cindex "router" "checking senders"
19718 If this option is set, the router is skipped unless the message's sender
19719 address matches something on the list.
19720 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19721 are evaluated.
19722
19723 There are issues concerning verification when the running of routers is
19724 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
19725 setting, it sets the sender to the null string. When using the &%-bt%& option
19726 to check a configuration file, it is necessary also to use the &%-f%& option to
19727 set an appropriate sender. For incoming mail, the sender is unset when
19728 verifying the sender, but is available when verifying any recipients. If the
19729 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
19730 matters.
19731
19732
19733 .option set routers "string list" unset
19734 .cindex router variables
19735 This option may be used multiple times on a router;
19736 because of this the list aspect is mostly irrelevant.
19737 The list separator is a semicolon but can be changed in the
19738 usual way.
19739
19740 Each list-element given must be of the form &"name = value"&
19741 and the names used must start with the string &"r_"&.
19742 Values containing a list-separator should have them doubled.
19743 When a router runs, the strings are evaluated in order,
19744 to create variables which are added to the set associated with
19745 the address.
19746 .new
19747 This is done immediately after all the preconditions, before the
19748 evaluation of the &%address_data%& option.
19749 .wen
19750 The variable is set with the expansion of the value.
19751 The variables can be used by the router options
19752 (not including any preconditions)
19753 and by the transport.
19754 Later definitions of a given named variable will override former ones.
19755 Variable use is via the usual &$r_...$& syntax.
19756
19757 This is similar to the &%address_data%& option, except that
19758 many independent variables can be used, with choice of naming.
19759
19760
19761 .option translate_ip_address routers string&!! unset
19762 .cindex "IP address" "translating"
19763 .cindex "packet radio"
19764 .cindex "router" "IP address translation"
19765 There exist some rare networking situations (for example, packet radio) where
19766 it is helpful to be able to translate IP addresses generated by normal routing
19767 mechanisms into other IP addresses, thus performing a kind of manual IP
19768 routing. This should be done only if the normal IP routing of the TCP/IP stack
19769 is inadequate or broken. Because this is an extremely uncommon requirement, the
19770 code to support this option is not included in the Exim binary unless
19771 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
19772
19773 .vindex "&$host_address$&"
19774 The &%translate_ip_address%& string is expanded for every IP address generated
19775 by the router, with the generated address set in &$host_address$&. If the
19776 expansion is forced to fail, no action is taken.
19777 For any other expansion error, delivery of the message is deferred.
19778 If the result of the expansion is an IP address, that replaces the original
19779 address; otherwise the result is assumed to be a host name &-- this is looked
19780 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
19781 produce one or more replacement IP addresses. For example, to subvert all IP
19782 addresses in some specific networks, this could be added to a router:
19783 .code
19784 translate_ip_address = \
19785   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
19786     {$value}fail}}
19787 .endd
19788 The file would contain lines like
19789 .code
19790 10.2.3.128/26    some.host
19791 10.8.4.34/26     10.44.8.15
19792 .endd
19793 You should not make use of this facility unless you really understand what you
19794 are doing.
19795
19796
19797
19798 .option transport routers string&!! unset
19799 This option specifies the transport to be used when a router accepts an address
19800 and sets it up for delivery. A transport is never needed if a router is used
19801 only for verification. The value of the option is expanded at routing time,
19802 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
19803 and result must be the name of one of the configured transports. If it is not,
19804 delivery is deferred.
19805
19806 The &%transport%& option is not used by the &(redirect)& router, but it does
19807 have some private options that set up transports for pipe and file deliveries
19808 (see chapter &<<CHAPredirect>>&).
19809
19810
19811
19812 .option transport_current_directory routers string&!! unset
19813 .cindex "current directory for local transport"
19814 This option associates a current directory with any address that is routed
19815 to a local transport. This can happen either because a transport is
19816 explicitly configured for the router, or because it generates a delivery to a
19817 file or a pipe. During the delivery process (that is, at transport time), this
19818 option string is expanded and is set as the current directory, unless
19819 overridden by a setting on the transport.
19820 If the expansion fails for any reason, including forced failure, an error is
19821 logged, and delivery is deferred.
19822 See chapter &<<CHAPenvironment>>& for details of the local delivery
19823 environment.
19824
19825
19826
19827
19828 .option transport_home_directory routers string&!! "see below"
19829 .cindex "home directory" "for local transport"
19830 This option associates a home directory with any address that is routed to a
19831 local transport. This can happen either because a transport is explicitly
19832 configured for the router, or because it generates a delivery to a file or a
19833 pipe. During the delivery process (that is, at transport time), the option
19834 string is expanded and is set as the home directory, unless overridden by a
19835 setting of &%home_directory%& on the transport.
19836 If the expansion fails for any reason, including forced failure, an error is
19837 logged, and delivery is deferred.
19838
19839 If the transport does not specify a home directory, and
19840 &%transport_home_directory%& is not set for the router, the home directory for
19841 the transport is taken from the password data if &%check_local_user%& is set for
19842 the router. Otherwise it is taken from &%router_home_directory%& if that option
19843 is set; if not, no home directory is set for the transport.
19844
19845 See chapter &<<CHAPenvironment>>& for further details of the local delivery
19846 environment.
19847
19848
19849
19850
19851 .option unseen routers boolean&!! false
19852 .cindex "router" "carrying on after success"
19853 The result of string expansion for this option must be a valid boolean value,
19854 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
19855 result causes an error, and delivery is deferred. If the expansion is forced to
19856 fail, the default value for the option (false) is used. Other failures cause
19857 delivery to be deferred.
19858
19859 When this option is set true, routing does not cease if the router accepts the
19860 address. Instead, a copy of the incoming address is passed to the next router,
19861 overriding a false setting of &%more%&. There is little point in setting
19862 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
19863 the value of &%unseen%& contains expansion items (and therefore, presumably, is
19864 sometimes true and sometimes false).
19865
19866 .cindex "copy of message (&%unseen%& option)"
19867 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
19868 qualifier in filter files. It can be used to cause copies of messages to be
19869 delivered to some other destination, while also carrying out a normal delivery.
19870 In effect, the current address is made into a &"parent"& that has two children
19871 &-- one that is delivered as specified by this router, and a clone that goes on
19872 to be routed further. For this reason, &%unseen%& may not be combined with the
19873 &%one_time%& option in a &(redirect)& router.
19874
19875 &*Warning*&: Header lines added to the address (or specified for removal) by
19876 this router or by previous routers affect the &"unseen"& copy of the message
19877 only. The clone that continues to be processed by further routers starts with
19878 no added headers and none specified for removal. For a &%redirect%& router, if
19879 a generated address is the same as the incoming address, this can lead to
19880 duplicate addresses with different header modifications. Exim does not do
19881 duplicate deliveries (except, in certain circumstances, to pipes -- see section
19882 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
19883 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
19884 &%redirect%& router may be of help.
19885
19886 Unlike the handling of header modifications, any data that was set by the
19887 &%address_data%& option in the current or previous routers &'is'& passed on to
19888 subsequent routers.
19889
19890
19891 .option user routers string&!! "see below"
19892 .cindex "uid (user id)" "local delivery"
19893 .cindex "local transports" "uid and gid"
19894 .cindex "transport" "local"
19895 .cindex "router" "user for filter processing"
19896 .cindex "filter" "user for processing"
19897 When a router queues an address for a transport, and the transport does not
19898 specify a user, the user given here is used when running the delivery process.
19899 The user may be specified numerically or by name. If expansion fails, the
19900 error is logged and delivery is deferred.
19901 This user is also used by the &(redirect)& router when running a filter file.
19902 The default is unset, except when &%check_local_user%& is set. In this case,
19903 the default is taken from the password information. If the user is specified as
19904 a name, and &%group%& is not set, the group associated with the user is used.
19905 See also &%initgroups%& and &%group%& and the discussion in chapter
19906 &<<CHAPenvironment>>&.
19907
19908
19909
19910 .option verify routers&!? boolean true
19911 Setting this option has the effect of setting &%verify_sender%& and
19912 &%verify_recipient%& to the same value.
19913
19914
19915 .option verify_only routers&!? boolean false
19916 .cindex "EXPN" "with &%verify_only%&"
19917 .oindex "&%-bv%&"
19918 .cindex "router" "used only when verifying"
19919 If this option is set, the router is used only when verifying an address,
19920 delivering in cutthrough mode or
19921 testing with the &%-bv%& option, not when actually doing a delivery, testing
19922 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
19923 restricted to verifying only senders or recipients by means of
19924 &%verify_sender%& and &%verify_recipient%&.
19925
19926 &*Warning*&: When the router is being run to verify addresses for an incoming
19927 SMTP message, Exim is not running as root, but under its own uid. If the router
19928 accesses any files, you need to make sure that they are accessible to the Exim
19929 user or group.
19930
19931
19932 .option verify_recipient routers&!? boolean true
19933 If this option is false, the router is skipped when verifying recipient
19934 addresses,
19935 delivering in cutthrough mode
19936 or testing recipient verification using &%-bv%&.
19937 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19938 are evaluated.
19939 See also the &$verify_mode$& variable.
19940
19941
19942 .option verify_sender routers&!? boolean true
19943 If this option is false, the router is skipped when verifying sender addresses
19944 or testing sender verification using &%-bvs%&.
19945 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19946 are evaluated.
19947 See also the &$verify_mode$& variable.
19948 .ecindex IIDgenoprou1
19949 .ecindex IIDgenoprou2
19950
19951
19952
19953
19954
19955
19956 . ////////////////////////////////////////////////////////////////////////////
19957 . ////////////////////////////////////////////////////////////////////////////
19958
19959 .chapter "The accept router" "CHID4"
19960 .cindex "&(accept)& router"
19961 .cindex "routers" "&(accept)&"
19962 The &(accept)& router has no private options of its own. Unless it is being
19963 used purely for verification (see &%verify_only%&) a transport is required to
19964 be defined by the generic &%transport%& option. If the preconditions that are
19965 specified by generic options are met, the router accepts the address and queues
19966 it for the given transport. The most common use of this router is for setting
19967 up deliveries to local mailboxes. For example:
19968 .code
19969 localusers:
19970   driver = accept
19971   domains = mydomain.example
19972   check_local_user
19973   transport = local_delivery
19974 .endd
19975 The &%domains%& condition in this example checks the domain of the address, and
19976 &%check_local_user%& checks that the local part is the login of a local user.
19977 When both preconditions are met, the &(accept)& router runs, and queues the
19978 address for the &(local_delivery)& transport.
19979
19980
19981
19982
19983
19984
19985 . ////////////////////////////////////////////////////////////////////////////
19986 . ////////////////////////////////////////////////////////////////////////////
19987
19988 .chapter "The dnslookup router" "CHAPdnslookup"
19989 .scindex IIDdnsrou1 "&(dnslookup)& router"
19990 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
19991 The &(dnslookup)& router looks up the hosts that handle mail for the
19992 recipient's domain in the DNS. A transport must always be set for this router,
19993 unless &%verify_only%& is set.
19994
19995 If SRV support is configured (see &%check_srv%& below), Exim first searches for
19996 SRV records. If none are found, or if SRV support is not configured,
19997 MX records are looked up. If no MX records exist, address records are sought.
19998 However, &%mx_domains%& can be set to disable the direct use of address
19999 records.
20000
20001 MX records of equal priority are sorted by Exim into a random order. Exim then
20002 looks for address records for the host names obtained from MX or SRV records.
20003 When a host has more than one IP address, they are sorted into a random order,
20004 except that IPv6 addresses are sorted before IPv4 addresses. If all the
20005 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
20006 generic option, the router declines.
20007
20008 Unless they have the highest priority (lowest MX value), MX records that point
20009 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
20010 are discarded, together with any other MX records of equal or lower priority.
20011
20012 .cindex "MX record" "pointing to local host"
20013 .cindex "local host" "MX pointing to"
20014 .oindex "&%self%&" "in &(dnslookup)& router"
20015 If the host pointed to by the highest priority MX record, or looked up as an
20016 address record, is the local host, or matches &%hosts_treat_as_local%&, what
20017 happens is controlled by the generic &%self%& option.
20018
20019
20020 .section "Problems with DNS lookups" "SECTprowitdnsloo"
20021 There have been problems with DNS servers when SRV records are looked up.
20022 Some misbehaving servers return a DNS error or timeout when a non-existent
20023 SRV record is sought. Similar problems have in the past been reported for
20024 MX records. The global &%dns_again_means_nonexist%& option can help with this
20025 problem, but it is heavy-handed because it is a global option.
20026
20027 For this reason, there are two options, &%srv_fail_domains%& and
20028 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
20029 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
20030 an attempt to look up an SRV or MX record causes one of these results, and the
20031 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
20032 such record"&. In the case of an SRV lookup, this means that the router
20033 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
20034 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
20035 case routing fails.
20036
20037
20038 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
20039 .cindex "&(dnslookup)& router" "declines"
20040 There are a few cases where a &(dnslookup)& router will decline to accept
20041 an address; if such a router is expected to handle "all remaining non-local
20042 domains", then it is important to set &%no_more%&.
20043
20044 The router will defer rather than decline if the domain
20045 is found in the &%fail_defer_domains%& router option.
20046
20047 Reasons for a &(dnslookup)& router to decline currently include:
20048 .ilist
20049 The domain does not exist in DNS
20050 .next
20051 The domain exists but the MX record's host part is just "."; this is a common
20052 convention (borrowed from SRV) used to indicate that there is no such service
20053 for this domain and to not fall back to trying A/AAAA records.
20054 .next
20055 Ditto, but for SRV records, when &%check_srv%& is set on this router.
20056 .next
20057 MX record points to a non-existent host.
20058 .next
20059 MX record points to an IP address and the main section option
20060 &%allow_mx_to_ip%& is not set.
20061 .next
20062 MX records exist and point to valid hosts, but all hosts resolve only to
20063 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
20064 .next
20065 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
20066 &%dns_check_names_pattern%& for handling one variant of this)
20067 .next
20068 &%check_secondary_mx%& is set on this router but the local host can
20069 not be found in the MX records (see below)
20070 .endlist
20071
20072
20073
20074
20075 .section "Private options for dnslookup" "SECID118"
20076 .cindex "options" "&(dnslookup)& router"
20077 The private options for the &(dnslookup)& router are as follows:
20078
20079 .option check_secondary_mx dnslookup boolean false
20080 .cindex "MX record" "checking for secondary"
20081 If this option is set, the router declines unless the local host is found in
20082 (and removed from) the list of hosts obtained by MX lookup. This can be used to
20083 process domains for which the local host is a secondary mail exchanger
20084 differently to other domains. The way in which Exim decides whether a host is
20085 the local host is described in section &<<SECTreclocipadd>>&.
20086
20087
20088 .option check_srv dnslookup string&!! unset
20089 .cindex "SRV record" "enabling use of"
20090 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
20091 addition to MX and address records. The support is disabled by default. To
20092 enable SRV support, set the &%check_srv%& option to the name of the service
20093 required. For example,
20094 .code
20095 check_srv = smtp
20096 .endd
20097 looks for SRV records that refer to the normal smtp service. The option is
20098 expanded, so the service name can vary from message to message or address
20099 to address. This might be helpful if SRV records are being used for a
20100 submission service. If the expansion is forced to fail, the &%check_srv%&
20101 option is ignored, and the router proceeds to look for MX records in the
20102 normal way.
20103
20104 When the expansion succeeds, the router searches first for SRV records for
20105 the given service (it assumes TCP protocol). A single SRV record with a
20106 host name that consists of just a single dot indicates &"no such service for
20107 this domain"&; if this is encountered, the router declines. If other kinds of
20108 SRV record are found, they are used to construct a host list for delivery
20109 according to the rules of RFC 2782. MX records are not sought in this case.
20110
20111 When no SRV records are found, MX records (and address records) are sought in
20112 the traditional way. In other words, SRV records take precedence over MX
20113 records, just as MX records take precedence over address records. Note that
20114 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
20115 defined it. It is apparently believed that MX records are sufficient for email
20116 and that SRV records should not be used for this purpose. However, SRV records
20117 have an additional &"weight"& feature which some people might find useful when
20118 trying to split an SMTP load between hosts of different power.
20119
20120 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
20121 when there is a DNS lookup error.
20122
20123
20124
20125
20126 .option fail_defer_domains dnslookup "domain list&!!" unset
20127 .cindex "MX record" "not found"
20128 DNS lookups for domains matching &%fail_defer_domains%&
20129 which find no matching record will cause the router to defer
20130 rather than the default behaviour of decline.
20131 This maybe be useful for queueing messages for a newly created
20132 domain while the DNS configuration is not ready.
20133 However, it will result in any message with mistyped domains
20134 also being queued.
20135
20136
20137 .option ipv4_only "string&!!" unset
20138 .cindex IPv6 disabling
20139 .cindex DNS "IPv6 disabling"
20140 The string is expanded, and if the result is anything but a forced failure,
20141 or an empty string, or one of the strings “0” or “no” or “false”
20142 (checked without regard to the case of the letters),
20143 only A records are used.
20144
20145 .option ipv4_prefer "string&!!" unset
20146 .cindex IPv4 preference
20147 .cindex DNS "IPv4 preference"
20148 The string is expanded, and if the result is anything but a forced failure,
20149 or an empty string, or one of the strings “0” or “no” or “false”
20150 (checked without regard to the case of the letters),
20151 A records are sorted before AAAA records (inverting the default).
20152
20153 .option mx_domains dnslookup "domain list&!!" unset
20154 .cindex "MX record" "required to exist"
20155 .cindex "SRV record" "required to exist"
20156 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
20157 record in order to be recognized. (The name of this option could be improved.)
20158 For example, if all the mail hosts in &'fict.example'& are known to have MX
20159 records, except for those in &'discworld.fict.example'&, you could use this
20160 setting:
20161 .code
20162 mx_domains = ! *.discworld.fict.example : *.fict.example
20163 .endd
20164 This specifies that messages addressed to a domain that matches the list but
20165 has no MX record should be bounced immediately instead of being routed using
20166 the address record.
20167
20168
20169 .option mx_fail_domains dnslookup "domain list&!!" unset
20170 If the DNS lookup for MX records for one of the domains in this list causes a
20171 DNS lookup error, Exim behaves as if no MX records were found. See section
20172 &<<SECTprowitdnsloo>>& for more discussion.
20173
20174
20175
20176
20177 .option qualify_single dnslookup boolean true
20178 .cindex "DNS" "resolver options"
20179 .cindex "DNS" "qualifying single-component names"
20180 When this option is true, the resolver option RES_DEFNAMES is set for DNS
20181 lookups. Typically, but not standardly, this causes the resolver to qualify
20182 single-component names with the default domain. For example, on a machine
20183 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
20184 &'thesaurus.ref.example'& inside the resolver. For details of what your
20185 resolver actually does, consult your man pages for &'resolver'& and
20186 &'resolv.conf'&.
20187
20188
20189
20190 .option rewrite_headers dnslookup boolean true
20191 .cindex "rewriting" "header lines"
20192 .cindex "header lines" "rewriting"
20193 If the domain name in the address that is being processed is not fully
20194 qualified, it may be expanded to its full form by a DNS lookup. For example, if
20195 an address is specified as &'dormouse@teaparty'&, the domain might be
20196 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
20197 occur as a result of setting the &%widen_domains%& option. If
20198 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
20199 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
20200 header lines of the message are rewritten with the full domain name.
20201
20202 This option should be turned off only when it is known that no message is
20203 ever going to be sent outside an environment where the abbreviation makes
20204 sense.
20205
20206 When an MX record is looked up in the DNS and matches a wildcard record, name
20207 servers normally return a record containing the name that has been looked up,
20208 making it impossible to detect whether a wildcard was present or not. However,
20209 some name servers have recently been seen to return the wildcard entry. If the
20210 name returned by a DNS lookup begins with an asterisk, it is not used for
20211 header rewriting.
20212
20213
20214 .option same_domain_copy_routing dnslookup boolean false
20215 .cindex "address" "copying routing"
20216 Addresses with the same domain are normally routed by the &(dnslookup)& router
20217 to the same list of hosts. However, this cannot be presumed, because the router
20218 options and preconditions may refer to the local part of the address. By
20219 default, therefore, Exim routes each address in a message independently. DNS
20220 servers run caches, so repeated DNS lookups are not normally expensive, and in
20221 any case, personal messages rarely have more than a few recipients.
20222
20223 If you are running mailing lists with large numbers of subscribers at the same
20224 domain, and you are using a &(dnslookup)& router which is independent of the
20225 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
20226 lookups for identical domains in one message. In this case, when &(dnslookup)&
20227 routes an address to a remote transport, any other unrouted addresses in the
20228 message that have the same domain are automatically given the same routing
20229 without processing them independently,
20230 provided the following conditions are met:
20231
20232 .ilist
20233 No router that processed the address specified &%headers_add%& or
20234 &%headers_remove%&.
20235 .next
20236 The router did not change the address in any way, for example, by &"widening"&
20237 the domain.
20238 .endlist
20239
20240
20241
20242
20243 .option search_parents dnslookup boolean false
20244 .cindex "DNS" "resolver options"
20245 When this option is true, the resolver option RES_DNSRCH is set for DNS
20246 lookups. This is different from the &%qualify_single%& option in that it
20247 applies to domains containing dots. Typically, but not standardly, it causes
20248 the resolver to search for the name in the current domain and in parent
20249 domains. For example, on a machine in the &'fict.example'& domain, if looking
20250 up &'teaparty.wonderland'& failed, the resolver would try
20251 &'teaparty.wonderland.fict.example'&. For details of what your resolver
20252 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
20253
20254 Setting this option true can cause problems in domains that have a wildcard MX
20255 record, because any domain that does not have its own MX record matches the
20256 local wildcard.
20257
20258
20259
20260 .option srv_fail_domains dnslookup "domain list&!!" unset
20261 If the DNS lookup for SRV records for one of the domains in this list causes a
20262 DNS lookup error, Exim behaves as if no SRV records were found. See section
20263 &<<SECTprowitdnsloo>>& for more discussion.
20264
20265
20266
20267
20268 .option widen_domains dnslookup "string list" unset
20269 .cindex "domain" "partial; widening"
20270 If a DNS lookup fails and this option is set, each of its strings in turn is
20271 added onto the end of the domain, and the lookup is tried again. For example,
20272 if
20273 .code
20274 widen_domains = fict.example:ref.example
20275 .endd
20276 is set and a lookup of &'klingon.dictionary'& fails,
20277 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
20278 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
20279 and &%search_parents%& options can cause some widening to be undertaken inside
20280 the DNS resolver. &%widen_domains%& is not applied to sender addresses
20281 when verifying, unless &%rewrite_headers%& is false (not the default).
20282
20283
20284 .section "Effect of qualify_single and search_parents" "SECID119"
20285 When a domain from an envelope recipient is changed by the resolver as a result
20286 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
20287 corresponding address in the message's header lines unless &%rewrite_headers%&
20288 is set false. Exim then re-routes the address, using the full domain.
20289
20290 These two options affect only the DNS lookup that takes place inside the router
20291 for the domain of the address that is being routed. They do not affect lookups
20292 such as that implied by
20293 .code
20294 domains = @mx_any
20295 .endd
20296 that may happen while processing a router precondition before the router is
20297 entered. No widening ever takes place for these lookups.
20298 .ecindex IIDdnsrou1
20299 .ecindex IIDdnsrou2
20300
20301
20302
20303
20304
20305
20306
20307
20308
20309 . ////////////////////////////////////////////////////////////////////////////
20310 . ////////////////////////////////////////////////////////////////////////////
20311
20312 .chapter "The ipliteral router" "CHID5"
20313 .cindex "&(ipliteral)& router"
20314 .cindex "domain literal" "routing"
20315 .cindex "routers" "&(ipliteral)&"
20316 This router has no private options. Unless it is being used purely for
20317 verification (see &%verify_only%&) a transport is required to be defined by the
20318 generic &%transport%& option. The router accepts the address if its domain part
20319 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
20320 router handles the address
20321 .code
20322 root@[192.168.1.1]
20323 .endd
20324 by setting up delivery to the host with that IP address. IPv4 domain literals
20325 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
20326 are similar, but the address is preceded by &`ipv6:`&. For example:
20327 .code
20328 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
20329 .endd
20330 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
20331 grounds that sooner or later somebody will try it.
20332
20333 .oindex "&%self%&" "in &(ipliteral)& router"
20334 If the IP address matches something in &%ignore_target_hosts%&, the router
20335 declines. If an IP literal turns out to refer to the local host, the generic
20336 &%self%& option determines what happens.
20337
20338 The RFCs require support for domain literals; however, their use is
20339 controversial in today's Internet. If you want to use this router, you must
20340 also set the main configuration option &%allow_domain_literals%&. Otherwise,
20341 Exim will not recognize the domain literal syntax in addresses.
20342
20343
20344
20345 . ////////////////////////////////////////////////////////////////////////////
20346 . ////////////////////////////////////////////////////////////////////////////
20347
20348 .chapter "The iplookup router" "CHID6"
20349 .cindex "&(iplookup)& router"
20350 .cindex "routers" "&(iplookup)&"
20351 The &(iplookup)& router was written to fulfil a specific requirement in
20352 Cambridge University (which in fact no longer exists). For this reason, it is
20353 not included in the binary of Exim by default. If you want to include it, you
20354 must set
20355 .code
20356 ROUTER_IPLOOKUP=yes
20357 .endd
20358 in your &_Local/Makefile_& configuration file.
20359
20360 The &(iplookup)& router routes an address by sending it over a TCP or UDP
20361 connection to one or more specific hosts. The host can then return the same or
20362 a different address &-- in effect rewriting the recipient address in the
20363 message's envelope. The new address is then passed on to subsequent routers. If
20364 this process fails, the address can be passed on to other routers, or delivery
20365 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
20366 must not be specified for it.
20367
20368 .cindex "options" "&(iplookup)& router"
20369 .option hosts iplookup string unset
20370 This option must be supplied. Its value is a colon-separated list of host
20371 names. The hosts are looked up using &[gethostbyname()]&
20372 (or &[getipnodebyname()]& when available)
20373 and are tried in order until one responds to the query. If none respond, what
20374 happens is controlled by &%optional%&.
20375
20376
20377 .option optional iplookup boolean false
20378 If &%optional%& is true, if no response is obtained from any host, the address
20379 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
20380 delivery to the address is deferred.
20381
20382
20383 .option port iplookup integer 0
20384 .cindex "port" "&(iplookup)& router"
20385 This option must be supplied. It specifies the port number for the TCP or UDP
20386 call.
20387
20388
20389 .option protocol iplookup string udp
20390 This option can be set to &"udp"& or &"tcp"& to specify which of the two
20391 protocols is to be used.
20392
20393
20394 .option query iplookup string&!! "see below"
20395 This defines the content of the query that is sent to the remote hosts. The
20396 default value is:
20397 .code
20398 $local_part@$domain $local_part@$domain
20399 .endd
20400 The repetition serves as a way of checking that a response is to the correct
20401 query in the default case (see &%response_pattern%& below).
20402
20403
20404 .option reroute iplookup string&!! unset
20405 If this option is not set, the rerouted address is precisely the byte string
20406 returned by the remote host, up to the first white space, if any. If set, the
20407 string is expanded to form the rerouted address. It can include parts matched
20408 in the response by &%response_pattern%& by means of numeric variables such as
20409 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
20410 whether or not a pattern is in use. In all cases, the rerouted address must end
20411 up in the form &'local_part@domain'&.
20412
20413
20414 .option response_pattern iplookup string unset
20415 This option can be set to a regular expression that is applied to the string
20416 returned from the remote host. If the pattern does not match the response, the
20417 router declines. If &%response_pattern%& is not set, no checking of the
20418 response is done, unless the query was defaulted, in which case there is a
20419 check that the text returned after the first white space is the original
20420 address. This checks that the answer that has been received is in response to
20421 the correct question. For example, if the response is just a new domain, the
20422 following could be used:
20423 .code
20424 response_pattern = ^([^@]+)$
20425 reroute = $local_part@$1
20426 .endd
20427
20428 .option timeout iplookup time 5s
20429 This specifies the amount of time to wait for a response from the remote
20430 machine. The same timeout is used for the &[connect()]& function for a TCP
20431 call. It does not apply to UDP.
20432
20433
20434
20435
20436 . ////////////////////////////////////////////////////////////////////////////
20437 . ////////////////////////////////////////////////////////////////////////////
20438
20439 .chapter "The manualroute router" "CHID7"
20440 .scindex IIDmanrou1 "&(manualroute)& router"
20441 .scindex IIDmanrou2 "routers" "&(manualroute)&"
20442 .cindex "domain" "manually routing"
20443 The &(manualroute)& router is so-called because it provides a way of manually
20444 routing an address according to its domain. It is mainly used when you want to
20445 route addresses to remote hosts according to your own rules, bypassing the
20446 normal DNS routing that looks up MX records. However, &(manualroute)& can also
20447 route to local transports, a facility that may be useful if you want to save
20448 messages for dial-in hosts in local files.
20449
20450 The &(manualroute)& router compares a list of domain patterns with the domain
20451 it is trying to route. If there is no match, the router declines. Each pattern
20452 has associated with it a list of hosts and some other optional data, which may
20453 include a transport. The combination of a pattern and its data is called a
20454 &"routing rule"&. For patterns that do not have an associated transport, the
20455 generic &%transport%& option must specify a transport, unless the router is
20456 being used purely for verification (see &%verify_only%&).
20457
20458 .vindex "&$host$&"
20459 In the case of verification, matching the domain pattern is sufficient for the
20460 router to accept the address. When actually routing an address for delivery,
20461 an address that matches a domain pattern is queued for the associated
20462 transport. If the transport is not a local one, a host list must be associated
20463 with the pattern; IP addresses are looked up for the hosts, and these are
20464 passed to the transport along with the mail address. For local transports, a
20465 host list is optional. If it is present, it is passed in &$host$& as a single
20466 text string.
20467
20468 The list of routing rules can be provided as an inline string in
20469 &%route_list%&, or the data can be obtained by looking up the domain in a file
20470 or database by setting &%route_data%&. Only one of these settings may appear in
20471 any one instance of &(manualroute)&. The format of routing rules is described
20472 below, following the list of private options.
20473
20474
20475 .section "Private options for manualroute" "SECTprioptman"
20476
20477 .cindex "options" "&(manualroute)& router"
20478 The private options for the &(manualroute)& router are as follows:
20479
20480 .option host_all_ignored manualroute string defer
20481 See &%host_find_failed%&.
20482
20483 .option host_find_failed manualroute string freeze
20484 This option controls what happens when &(manualroute)& tries to find an IP
20485 address for a host, and the host does not exist. The option can be set to one
20486 of the following values:
20487 .code
20488 decline
20489 defer
20490 fail
20491 freeze
20492 ignore
20493 pass
20494 .endd
20495 The default (&"freeze"&) assumes that this state is a serious configuration
20496 error. The difference between &"pass"& and &"decline"& is that the former
20497 forces the address to be passed to the next router (or the router defined by
20498 &%pass_router%&),
20499 .oindex "&%more%&"
20500 overriding &%no_more%&, whereas the latter passes the address to the next
20501 router only if &%more%& is true.
20502
20503 The value &"ignore"& causes Exim to completely ignore a host whose IP address
20504 cannot be found. If all the hosts in the list are ignored, the behaviour is
20505 controlled by the &%host_all_ignored%& option. This takes the same values
20506 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
20507
20508 The &%host_find_failed%& option applies only to a definite &"does not exist"&
20509 state; if a host lookup gets a temporary error, delivery is deferred unless the
20510 generic &%pass_on_timeout%& option is set.
20511
20512
20513 .option hosts_randomize manualroute boolean false
20514 .cindex "randomized host list"
20515 .cindex "host" "list of; randomized"
20516 If this option is set, the order of the items in a host list in a routing rule
20517 is randomized each time the list is used, unless an option in the routing rule
20518 overrides (see below). Randomizing the order of a host list can be used to do
20519 crude load sharing. However, if more than one mail address is routed by the
20520 same router to the same host list, the host lists are considered to be the same
20521 (even though they may be randomized into different orders) for the purpose of
20522 deciding whether to batch the deliveries into a single SMTP transaction.
20523
20524 When &%hosts_randomize%& is true, a host list may be split
20525 into groups whose order is separately randomized. This makes it possible to
20526 set up MX-like behaviour. The boundaries between groups are indicated by an
20527 item that is just &`+`& in the host list. For example:
20528 .code
20529 route_list = * host1:host2:host3:+:host4:host5
20530 .endd
20531 The order of the first three hosts and the order of the last two hosts is
20532 randomized for each use, but the first three always end up before the last two.
20533 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
20534 randomized host list is passed to an &(smtp)& transport that also has
20535 &%hosts_randomize set%&, the list is not re-randomized.
20536
20537
20538 .option route_data manualroute string&!! unset
20539 If this option is set, it must expand to yield the data part of a routing rule.
20540 Typically, the expansion string includes a lookup based on the domain. For
20541 example:
20542 .code
20543 route_data = ${lookup{$domain}dbm{/etc/routes}}
20544 .endd
20545 If the expansion is forced to fail, or the result is an empty string, the
20546 router declines. Other kinds of expansion failure cause delivery to be
20547 deferred.
20548
20549
20550 .option route_list manualroute "string list" unset
20551 This string is a list of routing rules, in the form defined below. Note that,
20552 unlike most string lists, the items are separated by semicolons. This is so
20553 that they may contain colon-separated host lists.
20554
20555
20556 .option same_domain_copy_routing manualroute boolean false
20557 .cindex "address" "copying routing"
20558 Addresses with the same domain are normally routed by the &(manualroute)&
20559 router to the same list of hosts. However, this cannot be presumed, because the
20560 router options and preconditions may refer to the local part of the address. By
20561 default, therefore, Exim routes each address in a message independently. DNS
20562 servers run caches, so repeated DNS lookups are not normally expensive, and in
20563 any case, personal messages rarely have more than a few recipients.
20564
20565 If you are running mailing lists with large numbers of subscribers at the same
20566 domain, and you are using a &(manualroute)& router which is independent of the
20567 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
20568 lookups for identical domains in one message. In this case, when
20569 &(manualroute)& routes an address to a remote transport, any other unrouted
20570 addresses in the message that have the same domain are automatically given the
20571 same routing without processing them independently. However, this is only done
20572 if &%headers_add%& and &%headers_remove%& are unset.
20573
20574
20575
20576
20577 .section "Routing rules in route_list" "SECID120"
20578 The value of &%route_list%& is a string consisting of a sequence of routing
20579 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
20580 entered as two semicolons. Alternatively, the list separator can be changed as
20581 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
20582 Empty rules are ignored. The format of each rule is
20583 .display
20584 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
20585 .endd
20586 The following example contains two rules, each with a simple domain pattern and
20587 no options:
20588 .code
20589 route_list = \
20590   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
20591   thes.ref.example  mail-3.ref.example:mail-4.ref.example
20592 .endd
20593 The three parts of a rule are separated by white space. The pattern and the
20594 list of hosts can be enclosed in quotes if necessary, and if they are, the
20595 usual quoting rules apply. Each rule in a &%route_list%& must start with a
20596 single domain pattern, which is the only mandatory item in the rule. The
20597 pattern is in the same format as one item in a domain list (see section
20598 &<<SECTdomainlist>>&),
20599 except that it may not be the name of an interpolated file.
20600 That is, it may be wildcarded, or a regular expression, or a file or database
20601 lookup (with semicolons doubled, because of the use of semicolon as a separator
20602 in a &%route_list%&).
20603
20604 The rules in &%route_list%& are searched in order until one of the patterns
20605 matches the domain that is being routed. The list of hosts and then options are
20606 then used as described below. If there is no match, the router declines. When
20607 &%route_list%& is set, &%route_data%& must not be set.
20608
20609
20610
20611 .section "Routing rules in route_data" "SECID121"
20612 The use of &%route_list%& is convenient when there are only a small number of
20613 routing rules. For larger numbers, it is easier to use a file or database to
20614 hold the routing information, and use the &%route_data%& option instead.
20615 The value of &%route_data%& is a list of hosts, followed by (optional) options.
20616 Most commonly, &%route_data%& is set as a string that contains an
20617 expansion lookup. For example, suppose we place two routing rules in a file
20618 like this:
20619 .code
20620 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
20621 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
20622 .endd
20623 This data can be accessed by setting
20624 .code
20625 route_data = ${lookup{$domain}lsearch{/the/file/name}}
20626 .endd
20627 Failure of the lookup results in an empty string, causing the router to
20628 decline. However, you do not have to use a lookup in &%route_data%&. The only
20629 requirement is that the result of expanding the string is a list of hosts,
20630 possibly followed by options, separated by white space. The list of hosts must
20631 be enclosed in quotes if it contains white space.
20632
20633
20634
20635
20636 .section "Format of the list of hosts" "SECID122"
20637 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
20638 always separately expanded before use. If the expansion fails, the router
20639 declines. The result of the expansion must be a colon-separated list of names
20640 and/or IP addresses, optionally also including ports.
20641 If the list is written with spaces, it must be protected with quotes.
20642 The format of each item
20643 in the list is described in the next section. The list separator can be changed
20644 as described in section &<<SECTlistsepchange>>&.
20645
20646 If the list of hosts was obtained from a &%route_list%& item, the following
20647 variables are set during its expansion:
20648
20649 .ilist
20650 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
20651 If the domain was matched against a regular expression, the numeric variables
20652 &$1$&, &$2$&, etc. may be set. For example:
20653 .code
20654 route_list = ^domain(\d+)   host-$1.text.example
20655 .endd
20656 .next
20657 &$0$& is always set to the entire domain.
20658 .next
20659 &$1$& is also set when partial matching is done in a file lookup.
20660
20661 .next
20662 .vindex "&$value$&"
20663 If the pattern that matched the domain was a lookup item, the data that was
20664 looked up is available in the expansion variable &$value$&. For example:
20665 .code
20666 route_list = lsearch;;/some/file.routes  $value
20667 .endd
20668 .endlist
20669
20670 Note the doubling of the semicolon in the pattern that is necessary because
20671 semicolon is the default route list separator.
20672
20673
20674
20675 .section "Format of one host item" "SECTformatonehostitem"
20676 Each item in the list of hosts can be either a host name or an IP address,
20677 optionally with an attached port number, or it can be a single "+"
20678 (see &%hosts_randomize%&).
20679 When no port is given, an IP address
20680 is not enclosed in brackets. When a port is specified, it overrides the port
20681 specification on the transport. The port is separated from the name or address
20682 by a colon. This leads to some complications:
20683
20684 .ilist
20685 Because colon is the default separator for the list of hosts, either
20686 the colon that specifies a port must be doubled, or the list separator must
20687 be changed. The following two examples have the same effect:
20688 .code
20689 route_list = * "host1.tld::1225 : host2.tld::1226"
20690 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
20691 .endd
20692 .next
20693 When IPv6 addresses are involved, it gets worse, because they contain
20694 colons of their own. To make this case easier, it is permitted to
20695 enclose an IP address (either v4 or v6) in square brackets if a port
20696 number follows. For example:
20697 .code
20698 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
20699 .endd
20700 .endlist
20701
20702 .section "How the list of hosts is used" "SECThostshowused"
20703 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
20704 the hosts is tried, in the order specified, when carrying out the SMTP
20705 delivery. However, the order can be changed by setting the &%hosts_randomize%&
20706 option, either on the router (see section &<<SECTprioptman>>& above), or on the
20707 transport.
20708
20709 Hosts may be listed by name or by IP address. An unadorned name in the list of
20710 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
20711 interpreted as an indirection to a sublist of hosts obtained by looking up MX
20712 records in the DNS. For example:
20713 .code
20714 route_list = *  x.y.z:p.q.r/MX:e.f.g
20715 .endd
20716 If this feature is used with a port specifier, the port must come last. For
20717 example:
20718 .code
20719 route_list = *  dom1.tld/mx::1225
20720 .endd
20721 If the &%hosts_randomize%& option is set, the order of the items in the list is
20722 randomized before any lookups are done. Exim then scans the list; for any name
20723 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
20724 be an interface on the local host and the item is not the first in the list,
20725 Exim discards it and any subsequent items. If it is the first item, what
20726 happens is controlled by the
20727 .oindex "&%self%&" "in &(manualroute)& router"
20728 &%self%& option of the router.
20729
20730 A name on the list that is followed by &`/MX`& is replaced with the list of
20731 hosts obtained by looking up MX records for the name. This is always a DNS
20732 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
20733 below) are not relevant here. The order of these hosts is determined by the
20734 preference values in the MX records, according to the usual rules. Because
20735 randomizing happens before the MX lookup, it does not affect the order that is
20736 defined by MX preferences.
20737
20738 If the local host is present in the sublist obtained from MX records, but is
20739 not the most preferred host in that list, it and any equally or less
20740 preferred hosts are removed before the sublist is inserted into the main list.
20741
20742 If the local host is the most preferred host in the MX list, what happens
20743 depends on where in the original list of hosts the &`/MX`& item appears. If it
20744 is not the first item (that is, there are previous hosts in the main list),
20745 Exim discards this name and any subsequent items in the main list.
20746
20747 If the MX item is first in the list of hosts, and the local host is the
20748 most preferred host, what happens is controlled by the &%self%& option of the
20749 router.
20750
20751 DNS failures when lookup up the MX records are treated in the same way as DNS
20752 failures when looking up IP addresses: &%pass_on_timeout%& and
20753 &%host_find_failed%& are used when relevant.
20754
20755 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
20756 whether obtained from an MX lookup or not.
20757
20758
20759
20760 .section "How the options are used" "SECThowoptused"
20761 The options are a sequence of words, space-separated.
20762 One of the words can be the name of a transport; this overrides the
20763 &%transport%& option on the router for this particular routing rule only. The
20764 other words (if present) control randomization of the list of hosts on a
20765 per-rule basis, and how the IP addresses of the hosts are to be found when
20766 routing to a remote transport. These options are as follows:
20767
20768 .ilist
20769 &%randomize%&: randomize the order of the hosts in this list, overriding the
20770 setting of &%hosts_randomize%& for this routing rule only.
20771 .next
20772 &%no_randomize%&: do not randomize the order of the hosts in this list,
20773 overriding the setting of &%hosts_randomize%& for this routing rule only.
20774 .next
20775 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
20776 find IP addresses. This function may ultimately cause a DNS lookup, but it may
20777 also look in &_/etc/hosts_& or other sources of information.
20778 .next
20779 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
20780 no address records are found. If there is a temporary DNS error (such as a
20781 timeout), delivery is deferred.
20782 .next
20783 &%ipv4_only%&: in direct DNS lookups, look up only A records.
20784 .next
20785 &%ipv4_prefer%&: in direct DNS lookups, sort A records before AAAA records.
20786 .endlist
20787
20788 For example:
20789 .code
20790 route_list = domain1  host1:host2:host3  randomize bydns;\
20791              domain2  host4:host5
20792 .endd
20793 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
20794 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
20795 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
20796 or &[gethostbyname()]&, and the result of the lookup is the result of that
20797 call.
20798
20799 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
20800 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
20801 instead of TRY_AGAIN. That is why the default action is to try a DNS
20802 lookup first. Only if that gives a definite &"no such host"& is the local
20803 function called.
20804
20805 &*Compatibility*&: From Exim 4.85 until fixed for 4.90, there was an
20806 inadvertent constraint that a transport name as an option had to be the last
20807 option specified.
20808
20809
20810
20811 If no IP address for a host can be found, what happens is controlled by the
20812 &%host_find_failed%& option.
20813
20814 .vindex "&$host$&"
20815 When an address is routed to a local transport, IP addresses are not looked up.
20816 The host list is passed to the transport in the &$host$& variable.
20817
20818
20819
20820 .section "Manualroute examples" "SECID123"
20821 In some of the examples that follow, the presence of the &%remote_smtp%&
20822 transport, as defined in the default configuration file, is assumed:
20823
20824 .ilist
20825 .cindex "smart host" "example router"
20826 The &(manualroute)& router can be used to forward all external mail to a
20827 &'smart host'&. If you have set up, in the main part of the configuration, a
20828 named domain list that contains your local domains, for example:
20829 .code
20830 domainlist local_domains = my.domain.example
20831 .endd
20832 You can arrange for all other domains to be routed to a smart host by making
20833 your first router something like this:
20834 .code
20835 smart_route:
20836   driver = manualroute
20837   domains = !+local_domains
20838   transport = remote_smtp
20839   route_list = * smarthost.ref.example
20840 .endd
20841 This causes all non-local addresses to be sent to the single host
20842 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
20843 they are tried in order
20844 (but you can use &%hosts_randomize%& to vary the order each time).
20845 Another way of configuring the same thing is this:
20846 .code
20847 smart_route:
20848   driver = manualroute
20849   transport = remote_smtp
20850   route_list = !+local_domains  smarthost.ref.example
20851 .endd
20852 There is no difference in behaviour between these two routers as they stand.
20853 However, they behave differently if &%no_more%& is added to them. In the first
20854 example, the router is skipped if the domain does not match the &%domains%&
20855 precondition; the following router is always tried. If the router runs, it
20856 always matches the domain and so can never decline. Therefore, &%no_more%&
20857 would have no effect. In the second case, the router is never skipped; it
20858 always runs. However, if it doesn't match the domain, it declines. In this case
20859 &%no_more%& would prevent subsequent routers from running.
20860
20861 .next
20862 .cindex "mail hub example"
20863 A &'mail hub'& is a host which receives mail for a number of domains via MX
20864 records in the DNS and delivers it via its own private routing mechanism. Often
20865 the final destinations are behind a firewall, with the mail hub being the one
20866 machine that can connect to machines both inside and outside the firewall. The
20867 &(manualroute)& router is usually used on a mail hub to route incoming messages
20868 to the correct hosts. For a small number of domains, the routing can be inline,
20869 using the &%route_list%& option, but for a larger number a file or database
20870 lookup is easier to manage.
20871
20872 If the domain names are in fact the names of the machines to which the mail is
20873 to be sent by the mail hub, the configuration can be quite simple. For
20874 example:
20875 .code
20876 hub_route:
20877   driver = manualroute
20878   transport = remote_smtp
20879   route_list = *.rhodes.tvs.example  $domain
20880 .endd
20881 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
20882 whose names are the same as the mail domains. A similar approach can be taken
20883 if the host name can be obtained from the domain name by a string manipulation
20884 that the expansion facilities can handle. Otherwise, a lookup based on the
20885 domain can be used to find the host:
20886 .code
20887 through_firewall:
20888   driver = manualroute
20889   transport = remote_smtp
20890   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
20891 .endd
20892 The result of the lookup must be the name or IP address of the host (or
20893 hosts) to which the address is to be routed. If the lookup fails, the route
20894 data is empty, causing the router to decline. The address then passes to the
20895 next router.
20896
20897 .next
20898 .cindex "batched SMTP output example"
20899 .cindex "SMTP" "batched outgoing; example"
20900 You can use &(manualroute)& to deliver messages to pipes or files in batched
20901 SMTP format for onward transportation by some other means. This is one way of
20902 storing mail for a dial-up host when it is not connected. The route list entry
20903 can be as simple as a single domain name in a configuration like this:
20904 .code
20905 save_in_file:
20906   driver = manualroute
20907   transport = batchsmtp_appendfile
20908   route_list = saved.domain.example
20909 .endd
20910 though often a pattern is used to pick up more than one domain. If there are
20911 several domains or groups of domains with different transport requirements,
20912 different transports can be listed in the routing information:
20913 .code
20914 save_in_file:
20915   driver = manualroute
20916   route_list = \
20917     *.saved.domain1.example  $domain  batch_appendfile; \
20918     *.saved.domain2.example  \
20919       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
20920       batch_pipe
20921 .endd
20922 .vindex "&$domain$&"
20923 .vindex "&$host$&"
20924 The first of these just passes the domain in the &$host$& variable, which
20925 doesn't achieve much (since it is also in &$domain$&), but the second does a
20926 file lookup to find a value to pass, causing the router to decline to handle
20927 the address if the lookup fails.
20928
20929 .next
20930 .cindex "UUCP" "example of router for"
20931 Routing mail directly to UUCP software is a specific case of the use of
20932 &(manualroute)& in a gateway to another mail environment. This is an example of
20933 one way it can be done:
20934 .code
20935 # Transport
20936 uucp:
20937   driver = pipe
20938   user = nobody
20939   command = /usr/local/bin/uux -r - \
20940     ${substr_-5:$host}!rmail ${local_part}
20941   return_fail_output = true
20942
20943 # Router
20944 uucphost:
20945   transport = uucp
20946   driver = manualroute
20947   route_data = \
20948     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
20949 .endd
20950 The file &_/usr/local/exim/uucphosts_& contains entries like
20951 .code
20952 darksite.ethereal.example:           darksite.UUCP
20953 .endd
20954 It can be set up more simply without adding and removing &".UUCP"& but this way
20955 makes clear the distinction between the domain name
20956 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
20957 .endlist
20958 .ecindex IIDmanrou1
20959 .ecindex IIDmanrou2
20960
20961
20962
20963
20964
20965
20966
20967
20968 . ////////////////////////////////////////////////////////////////////////////
20969 . ////////////////////////////////////////////////////////////////////////////
20970
20971 .chapter "The queryprogram router" "CHAPdriverlast"
20972 .scindex IIDquerou1 "&(queryprogram)& router"
20973 .scindex IIDquerou2 "routers" "&(queryprogram)&"
20974 .cindex "routing" "by external program"
20975 The &(queryprogram)& router routes an address by running an external command
20976 and acting on its output. This is an expensive way to route, and is intended
20977 mainly for use in lightly-loaded systems, or for performing experiments.
20978 However, if it is possible to use the precondition options (&%domains%&,
20979 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
20980 be used in special cases, even on a busy host. There are the following private
20981 options:
20982 .cindex "options" "&(queryprogram)& router"
20983
20984 .option command queryprogram string&!! unset
20985 This option must be set. It specifies the command that is to be run. The
20986 command is split up into a command name and arguments, and then each is
20987 expanded separately (exactly as for a &(pipe)& transport, described in chapter
20988 &<<CHAPpipetransport>>&).
20989
20990
20991 .option command_group queryprogram string unset
20992 .cindex "gid (group id)" "in &(queryprogram)& router"
20993 This option specifies a gid to be set when running the command while routing an
20994 address for deliver. It must be set if &%command_user%& specifies a numerical
20995 uid. If it begins with a digit, it is interpreted as the numerical value of the
20996 gid. Otherwise it is looked up using &[getgrnam()]&.
20997
20998
20999 .option command_user queryprogram string unset
21000 .cindex "uid (user id)" "for &(queryprogram)&"
21001 This option must be set. It specifies the uid which is set when running the
21002 command while routing an address for delivery. If the value begins with a digit,
21003 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
21004 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
21005 not set, a value for the gid also.
21006
21007 &*Warning:*& Changing uid and gid is possible only when Exim is running as
21008 root, which it does during a normal delivery in a conventional configuration.
21009 However, when an address is being verified during message reception, Exim is
21010 usually running as the Exim user, not as root. If the &(queryprogram)& router
21011 is called from a non-root process, Exim cannot change uid or gid before running
21012 the command. In this circumstance the command runs under the current uid and
21013 gid.
21014
21015
21016 .option current_directory queryprogram string /
21017 This option specifies an absolute path which is made the current directory
21018 before running the command.
21019
21020
21021 .option timeout queryprogram time 1h
21022 If the command does not complete within the timeout period, its process group
21023 is killed and the message is frozen. A value of zero time specifies no
21024 timeout.
21025
21026
21027 The standard output of the command is connected to a pipe, which is read when
21028 the command terminates. It should consist of a single line of output,
21029 containing up to five fields, separated by white space. The maximum length of
21030 the line is 1023 characters. Longer lines are silently truncated. The first
21031 field is one of the following words (case-insensitive):
21032
21033 .ilist
21034 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
21035 below).
21036 .next
21037 &'Decline'&: the router declines; pass the address to the next router, unless
21038 &%no_more%& is set.
21039 .next
21040 &'Fail'&: routing failed; do not pass the address to any more routers. Any
21041 subsequent text on the line is an error message. If the router is run as part
21042 of address verification during an incoming SMTP message, the message is
21043 included in the SMTP response.
21044 .next
21045 &'Defer'&: routing could not be completed at this time; try again later. Any
21046 subsequent text on the line is an error message which is logged. It is not
21047 included in any SMTP response.
21048 .next
21049 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
21050 .next
21051 &'Pass'&: pass the address to the next router (or the router specified by
21052 &%pass_router%&), overriding &%no_more%&.
21053 .next
21054 &'Redirect'&: the message is redirected. The remainder of the line is a list of
21055 new addresses, which are routed independently, starting with the first router,
21056 or the router specified by &%redirect_router%&, if set.
21057 .endlist
21058
21059 When the first word is &'accept'&, the remainder of the line consists of a
21060 number of keyed data values, as follows (split into two lines here, to fit on
21061 the page):
21062 .code
21063 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
21064 LOOKUP=byname|bydns DATA=<text>
21065 .endd
21066 The data items can be given in any order, and all are optional. If no transport
21067 is included, the transport specified by the generic &%transport%& option is
21068 used. The list of hosts and the lookup type are needed only if the transport is
21069 an &(smtp)& transport that does not itself supply a list of hosts.
21070
21071 The format of the list of hosts is the same as for the &(manualroute)& router.
21072 As well as host names and IP addresses with optional port numbers, as described
21073 in section &<<SECTformatonehostitem>>&, it may contain names followed by
21074 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
21075 (see section &<<SECThostshowused>>&).
21076
21077 If the lookup type is not specified, Exim behaves as follows when trying to
21078 find an IP address for each host: First, a DNS lookup is done. If this yields
21079 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
21080 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
21081 result of the lookup is the result of that call.
21082
21083 .vindex "&$address_data$&"
21084 If the DATA field is set, its value is placed in the &$address_data$&
21085 variable. For example, this return line
21086 .code
21087 accept hosts=x1.y.example:x2.y.example data="rule1"
21088 .endd
21089 routes the address to the default transport, passing a list of two hosts. When
21090 the transport runs, the string &"rule1"& is in &$address_data$&.
21091 .ecindex IIDquerou1
21092 .ecindex IIDquerou2
21093
21094
21095
21096
21097 . ////////////////////////////////////////////////////////////////////////////
21098 . ////////////////////////////////////////////////////////////////////////////
21099
21100 .chapter "The redirect router" "CHAPredirect"
21101 .scindex IIDredrou1 "&(redirect)& router"
21102 .scindex IIDredrou2 "routers" "&(redirect)&"
21103 .cindex "alias file" "in a &(redirect)& router"
21104 .cindex "address redirection" "&(redirect)& router"
21105 The &(redirect)& router handles several kinds of address redirection. Its most
21106 common uses are for resolving local part aliases from a central alias file
21107 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
21108 files, but it has many other potential uses. The incoming address can be
21109 redirected in several different ways:
21110
21111 .ilist
21112 It can be replaced by one or more new addresses which are themselves routed
21113 independently.
21114 .next
21115 It can be routed to be delivered to a given file or directory.
21116 .next
21117 It can be routed to be delivered to a specified pipe command.
21118 .next
21119 It can cause an automatic reply to be generated.
21120 .next
21121 It can be forced to fail, optionally with a custom error message.
21122 .next
21123 It can be temporarily deferred, optionally with a custom message.
21124 .next
21125 It can be discarded.
21126 .endlist
21127
21128 The generic &%transport%& option must not be set for &(redirect)& routers.
21129 However, there are some private options which define transports for delivery to
21130 files and pipes, and for generating autoreplies. See the &%file_transport%&,
21131 &%pipe_transport%& and &%reply_transport%& descriptions below.
21132
21133 If success DSNs have been requested
21134 .cindex "DSN" "success"
21135 .cindex "Delivery Status Notification" "success"
21136 redirection triggers one and the DSN options are not passed any further.
21137
21138
21139
21140 .section "Redirection data" "SECID124"
21141 The router operates by interpreting a text string which it obtains either by
21142 expanding the contents of the &%data%& option, or by reading the entire
21143 contents of a file whose name is given in the &%file%& option. These two
21144 options are mutually exclusive. The first is commonly used for handling system
21145 aliases, in a configuration like this:
21146 .code
21147 system_aliases:
21148   driver = redirect
21149   data = ${lookup{$local_part}lsearch{/etc/aliases}}
21150 .endd
21151 If the lookup fails, the expanded string in this example is empty. When the
21152 expansion of &%data%& results in an empty string, the router declines. A forced
21153 expansion failure also causes the router to decline; other expansion failures
21154 cause delivery to be deferred.
21155
21156 A configuration using &%file%& is commonly used for handling users'
21157 &_.forward_& files, like this:
21158 .code
21159 userforward:
21160   driver = redirect
21161   check_local_user
21162   file = $home/.forward
21163   no_verify
21164 .endd
21165 If the file does not exist, or causes no action to be taken (for example, it is
21166 empty or consists only of comments), the router declines. &*Warning*&: This
21167 is not the case when the file contains syntactically valid items that happen to
21168 yield empty addresses, for example, items containing only RFC 2822 address
21169 comments.
21170
21171 .cindex "tainted data" "in filenames"
21172 .cindex redirect "tainted data"
21173 Tainted data may not be used for a filename.
21174
21175 &*Warning*&: It is unwise to use &$local_part$& or &$domain$&
21176 directly for redirection,
21177 as they are provided by a potential attacker.
21178 In the examples above, &$local_part$& is used for looking up data held locally
21179 on the system, and not used directly (the second example derives &$home$& via
21180 the passsword file or database, using &$local_part$&).
21181
21182
21183
21184 .section "Forward files and address verification" "SECID125"
21185 .cindex "address redirection" "while verifying"
21186 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
21187 &_.forward_& files, as in the example above. There are two reasons for this:
21188
21189 .ilist
21190 When Exim is receiving an incoming SMTP message from a remote host, it is
21191 running under the Exim uid, not as root. Exim is unable to change uid to read
21192 the file as the user, and it may not be able to read it as the Exim user. So in
21193 practice the router may not be able to operate.
21194 .next
21195 However, even when the router can operate, the existence of a &_.forward_& file
21196 is unimportant when verifying an address. What should be checked is whether the
21197 local part is a valid user name or not. Cutting out the redirection processing
21198 saves some resources.
21199 .endlist
21200
21201
21202
21203
21204
21205
21206 .section "Interpreting redirection data" "SECID126"
21207 .cindex "Sieve filter" "specifying in redirection data"
21208 .cindex "filter" "specifying in redirection data"
21209 The contents of the data string, whether obtained from &%data%& or &%file%&,
21210 can be interpreted in two different ways:
21211
21212 .ilist
21213 If the &%allow_filter%& option is set true, and the data begins with the text
21214 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
21215 &'filtering'& instructions in the form of an Exim or Sieve filter file,
21216 respectively. Details of the syntax and semantics of filter files are described
21217 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
21218 document is intended for use by end users.
21219 .next
21220 Otherwise, the data must be a comma-separated list of redirection items, as
21221 described in the next section.
21222 .endlist
21223
21224 When a message is redirected to a file (a &"mail folder"&), the filename given
21225 in a non-filter redirection list must always be an absolute path. A filter may
21226 generate a relative path &-- how this is handled depends on the transport's
21227 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
21228 for the &(appendfile)& transport.
21229
21230
21231
21232 .section "Items in a non-filter redirection list" "SECTitenonfilred"
21233 .cindex "address redirection" "non-filter list items"
21234 When the redirection data is not an Exim or Sieve filter, for example, if it
21235 comes from a conventional alias or forward file, it consists of a list of
21236 addresses, filenames, pipe commands, or certain special items (see section
21237 &<<SECTspecitredli>>& below). The special items can be individually enabled or
21238 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
21239 depending on their default values. The items in the list are separated by
21240 commas or newlines.
21241 If a comma is required in an item, the entire item must be enclosed in double
21242 quotes.
21243
21244 Lines starting with a # character are comments, and are ignored, and # may
21245 also appear following a comma, in which case everything between the # and the
21246 next newline character is ignored.
21247
21248 If an item is entirely enclosed in double quotes, these are removed. Otherwise
21249 double quotes are retained because some forms of mail address require their use
21250 (but never to enclose the entire address). In the following description,
21251 &"item"& refers to what remains after any surrounding double quotes have been
21252 removed.
21253
21254 .vindex "&$local_part$&"
21255 &*Warning*&: If you use an Exim expansion to construct a redirection address,
21256 and the expansion contains a reference to &$local_part$&, you should make use
21257 of the &%quote_local_part%& expansion operator, in case the local part contains
21258 special characters. For example, to redirect all mail for the domain
21259 &'obsolete.example'&, retaining the existing local part, you could use this
21260 setting:
21261 .code
21262 data = ${quote_local_part:$local_part}@newdomain.example
21263 .endd
21264
21265
21266 .section "Redirecting to a local mailbox" "SECTredlocmai"
21267 .cindex "routing" "loops in"
21268 .cindex "loop" "while routing, avoidance of"
21269 .cindex "address redirection" "to local mailbox"
21270 A redirection item may safely be the same as the address currently under
21271 consideration. This does not cause a routing loop, because a router is
21272 automatically skipped if any ancestor of the address that is being processed
21273 is the same as the current address and was processed by the current router.
21274 Such an address is therefore passed to the following routers, so it is handled
21275 as if there were no redirection. When making this loop-avoidance test, the
21276 complete local part, including any prefix or suffix, is used.
21277
21278 .cindex "address redirection" "local part without domain"
21279 Specifying the same local part without a domain is a common usage in personal
21280 filter files when the user wants to have messages delivered to the local
21281 mailbox and also forwarded elsewhere. For example, the user whose login is
21282 &'cleo'& might have a &_.forward_& file containing this:
21283 .code
21284 cleo, cleopatra@egypt.example
21285 .endd
21286 .cindex "backslash in alias file"
21287 .cindex "alias file" "backslash in"
21288 For compatibility with other MTAs, such unqualified local parts may be
21289 preceded by &"\"&, but this is not a requirement for loop prevention. However,
21290 it does make a difference if more than one domain is being handled
21291 synonymously.
21292
21293 If an item begins with &"\"& and the rest of the item parses as a valid RFC
21294 2822 address that does not include a domain, the item is qualified using the
21295 domain of the incoming address. In the absence of a leading &"\"&, unqualified
21296 addresses are qualified using the value in &%qualify_recipient%&, but you can
21297 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
21298
21299 Care must be taken if there are alias names for local users.
21300 Consider an MTA handling a single local domain where the system alias file
21301 contains:
21302 .code
21303 Sam.Reman: spqr
21304 .endd
21305 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
21306 messages in the local mailbox, and also forward copies elsewhere. He creates
21307 this forward file:
21308 .code
21309 Sam.Reman, spqr@reme.elsewhere.example
21310 .endd
21311 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
21312 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
21313 second time round, because it has previously routed it,
21314 and the following routers presumably cannot handle the alias. The forward file
21315 should really contain
21316 .code
21317 spqr, spqr@reme.elsewhere.example
21318 .endd
21319 but because this is such a common error, the &%check_ancestor%& option (see
21320 below) exists to provide a way to get round it. This is normally set on a
21321 &(redirect)& router that is handling users' &_.forward_& files.
21322
21323
21324
21325 .section "Special items in redirection lists" "SECTspecitredli"
21326 In addition to addresses, the following types of item may appear in redirection
21327 lists (that is, in non-filter redirection data):
21328
21329 .ilist
21330 .cindex "pipe" "in redirection list"
21331 .cindex "address redirection" "to pipe"
21332 An item is treated as a pipe command if it begins with &"|"& and does not parse
21333 as a valid RFC 2822 address that includes a domain. A transport for running the
21334 command must be specified by the &%pipe_transport%& option.
21335 Normally, either the router or the transport specifies a user and a group under
21336 which to run the delivery. The default is to use the Exim user and group.
21337
21338 Single or double quotes can be used for enclosing the individual arguments of
21339 the pipe command; no interpretation of escapes is done for single quotes. If
21340 the command contains a comma character, it is necessary to put the whole item
21341 in double quotes, for example:
21342 .code
21343 "|/some/command ready,steady,go"
21344 .endd
21345 since items in redirection lists are terminated by commas. Do not, however,
21346 quote just the command. An item such as
21347 .code
21348 |"/some/command ready,steady,go"
21349 .endd
21350 is interpreted as a pipe with a rather strange command name, and no arguments.
21351
21352 Note that the above example assumes that the text comes from a lookup source
21353 of some sort, so that the quotes are part of the data.  If composing a
21354 redirect router with a &%data%& option directly specifying this command, the
21355 quotes will be used by the configuration parser to define the extent of one
21356 string, but will not be passed down into the redirect router itself.  There
21357 are two main approaches to get around this: escape quotes to be part of the
21358 data itself, or avoid using this mechanism and instead create a custom
21359 transport with the &%command%& option set and reference that transport from
21360 an &%accept%& router.
21361
21362 .next
21363 .cindex "file" "in redirection list"
21364 .cindex "address redirection" "to file"
21365 An item is interpreted as a path name if it begins with &"/"& and does not
21366 parse as a valid RFC 2822 address that includes a domain. For example,
21367 .code
21368 /home/world/minbari
21369 .endd
21370 is treated as a filename, but
21371 .code
21372 /s=molari/o=babylon/@x400gate.way
21373 .endd
21374 is treated as an address. For a filename, a transport must be specified using
21375 the &%file_transport%& option. However, if the generated path name ends with a
21376 forward slash character, it is interpreted as a directory name rather than a
21377 filename, and &%directory_transport%& is used instead.
21378
21379 Normally, either the router or the transport specifies a user and a group under
21380 which to run the delivery. The default is to use the Exim user and group.
21381
21382 .cindex "&_/dev/null_&"
21383 However, if a redirection item is the path &_/dev/null_&, delivery to it is
21384 bypassed at a high level, and the log entry shows &"**bypassed**"&
21385 instead of a transport name. In this case the user and group are not used.
21386
21387 .next
21388 .cindex "included address list"
21389 .cindex "address redirection" "included external list"
21390 If an item is of the form
21391 .code
21392 :include:<path name>
21393 .endd
21394 a list of further items is taken from the given file and included at that
21395 point. &*Note*&: Such a file can not be a filter file; it is just an
21396 out-of-line addition to the list. The items in the included list are separated
21397 by commas or newlines and are not subject to expansion. If this is the first
21398 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
21399 the alias name. This example is incorrect:
21400 .code
21401 list1    :include:/opt/lists/list1
21402 .endd
21403 It must be given as
21404 .code
21405 list1:   :include:/opt/lists/list1
21406 .endd
21407 .cindex "tainted data" "in filenames"
21408 .cindex redirect "tainted data"
21409 Tainted data may not be used for a filename.
21410 .next
21411 .cindex "address redirection" "to black hole"
21412 .cindex "delivery" "discard"
21413 .cindex "delivery" "blackhole"
21414 .cindex "black hole"
21415 .cindex "abandoning mail"
21416 Sometimes you want to throw away mail to a particular local part.  Making the
21417 &%data%& option expand to an empty string does not work, because that causes
21418 the router to decline. Instead, the alias item
21419 .code
21420 :blackhole:
21421 .endd
21422 can be used. It does what its name implies. No delivery is
21423 done, and no error message is generated. This has the same effect as specifying
21424 &_/dev/null_& as a destination, but it can be independently disabled.
21425
21426 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
21427 delivery is done for the original local part, even if other redirection items
21428 are present. If you are generating a multi-item list (for example, by reading a
21429 database) and need the ability to provide a no-op item, you must use
21430 &_/dev/null_&.
21431
21432 .next
21433 .cindex "delivery" "forcing failure"
21434 .cindex "delivery" "forcing deferral"
21435 .cindex "failing delivery" "forcing"
21436 .cindex "deferred delivery, forcing"
21437 .cindex "customizing" "failure message"
21438 An attempt to deliver a particular address can be deferred or forced to fail by
21439 redirection items of the form
21440 .code
21441 :defer:
21442 :fail:
21443 .endd
21444 respectively. When a redirection list contains such an item, it applies
21445 to the entire redirection; any other items in the list are ignored. Any
21446 text following &':fail:'& or &':defer:'& is placed in the error text
21447 associated with the failure. For example, an alias file might contain:
21448 .code
21449 X.Employee:  :fail: Gone away, no forwarding address
21450 .endd
21451 In the case of an address that is being verified from an ACL or as the subject
21452 of a
21453 .cindex "VRFY" "error text, display of"
21454 VRFY command, the text is included in the SMTP error response by
21455 default.
21456 .cindex "EXPN" "error text, display of"
21457 The text is not included in the response to an EXPN command. In non-SMTP cases
21458 the text is included in the error message that Exim generates.
21459
21460 .cindex "SMTP" "error codes"
21461 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
21462 &':fail:'&. However, if the message starts with three digits followed by a
21463 space, optionally followed by an extended code of the form &'n.n.n'&, also
21464 followed by a space, and the very first digit is the same as the default error
21465 code, the code from the message is used instead. If the very first digit is
21466 incorrect, a panic error is logged, and the default code is used. You can
21467 suppress the use of the supplied code in a redirect router by setting the
21468 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
21469 ignored.
21470
21471 .vindex "&$acl_verify_message$&"
21472 In an ACL, an explicitly provided message overrides the default, but the
21473 default message is available in the variable &$acl_verify_message$& and can
21474 therefore be included in a custom message if this is desired.
21475
21476 Normally the error text is the rest of the redirection list &-- a comma does
21477 not terminate it &-- but a newline does act as a terminator. Newlines are not
21478 normally present in alias expansions. In &(lsearch)& lookups they are removed
21479 as part of the continuation process, but they may exist in other kinds of
21480 lookup and in &':include:'& files.
21481
21482 During routing for message delivery (as opposed to verification), a redirection
21483 containing &':fail:'& causes an immediate failure of the incoming address,
21484 whereas &':defer:'& causes the message to remain in the queue so that a
21485 subsequent delivery attempt can happen at a later time. If an address is
21486 deferred for too long, it will ultimately fail, because the normal retry
21487 rules still apply.
21488
21489 .next
21490 .cindex "alias file" "exception to default"
21491 Sometimes it is useful to use a single-key search type with a default (see
21492 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
21493 for exceptions to the default. These can be handled by aliasing them to
21494 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
21495 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
21496 results in an empty redirection list has the same effect.
21497 .endlist
21498
21499
21500 .section "Duplicate addresses" "SECTdupaddr"
21501 .cindex "duplicate addresses"
21502 .cindex "address duplicate, discarding"
21503 .cindex "pipe" "duplicated"
21504 Exim removes duplicate addresses from the list to which it is delivering, so as
21505 to deliver just one copy to each address. This does not apply to deliveries
21506 routed to pipes by different immediate parent addresses, but an indirect
21507 aliasing scheme of the type
21508 .code
21509 pipe:       |/some/command $local_part
21510 localpart1: pipe
21511 localpart2: pipe
21512 .endd
21513 does not work with a message that is addressed to both local parts, because
21514 when the second is aliased to the intermediate local part &"pipe"& it gets
21515 discarded as being the same as a previously handled address. However, a scheme
21516 such as
21517 .code
21518 localpart1: |/some/command $local_part
21519 localpart2: |/some/command $local_part
21520 .endd
21521 does result in two different pipe deliveries, because the immediate parents of
21522 the pipes are distinct.
21523
21524
21525
21526 .section "Repeated redirection expansion" "SECID128"
21527 .cindex "repeated redirection expansion"
21528 .cindex "address redirection" "repeated for each delivery attempt"
21529 When a message cannot be delivered to all of its recipients immediately,
21530 leading to two or more delivery attempts, redirection expansion is carried out
21531 afresh each time for those addresses whose children were not all previously
21532 delivered. If redirection is being used as a mailing list, this can lead to new
21533 members of the list receiving copies of old messages. The &%one_time%& option
21534 can be used to avoid this.
21535
21536
21537 .section "Errors in redirection lists" "SECID129"
21538 .cindex "address redirection" "errors"
21539 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
21540 error is skipped, and an entry is written to the main log. This may be useful
21541 for mailing lists that are automatically managed. Otherwise, if an error is
21542 detected while generating the list of new addresses, the original address is
21543 deferred. See also &%syntax_errors_to%&.
21544
21545
21546
21547 .section "Private options for the redirect router" "SECID130"
21548
21549 .cindex "options" "&(redirect)& router"
21550 The private options for the &(redirect)& router are as follows:
21551
21552
21553 .option allow_defer redirect boolean false
21554 Setting this option allows the use of &':defer:'& in non-filter redirection
21555 data, or the &%defer%& command in an Exim filter file.
21556
21557
21558 .option allow_fail redirect boolean false
21559 .cindex "failing delivery" "from filter"
21560 If this option is true, the &':fail:'& item can be used in a redirection list,
21561 and the &%fail%& command may be used in an Exim filter file.
21562
21563
21564 .option allow_filter redirect boolean false
21565 .cindex "filter" "enabling use of"
21566 .cindex "Sieve filter" "enabling use of"
21567 Setting this option allows Exim to interpret redirection data that starts with
21568 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
21569 are some features of Exim filter files that some administrators may wish to
21570 lock out; see the &%forbid_filter_%&&'xxx'& options below.
21571
21572 It is also possible to lock out Exim filters or Sieve filters while allowing
21573 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
21574
21575
21576 The filter is run using the uid and gid set by the generic &%user%& and
21577 &%group%& options. These take their defaults from the password data if
21578 &%check_local_user%& is set, so in the normal case of users' personal filter
21579 files, the filter is run as the relevant user. When &%allow_filter%& is set
21580 true, Exim insists that either &%check_local_user%& or &%user%& is set.
21581
21582
21583
21584 .option allow_freeze redirect boolean false
21585 .cindex "freezing messages" "allowing in filter"
21586 Setting this option allows the use of the &%freeze%& command in an Exim filter.
21587 This command is more normally encountered in system filters, and is disabled by
21588 default for redirection filters because it isn't something you usually want to
21589 let ordinary users do.
21590
21591
21592
21593 .option check_ancestor redirect boolean false
21594 This option is concerned with handling generated addresses that are the same
21595 as some address in the list of redirection ancestors of the current address.
21596 Although it is turned off by default in the code, it is set in the default
21597 configuration file for handling users' &_.forward_& files. It is recommended
21598 for this use of the &(redirect)& router.
21599
21600 When &%check_ancestor%& is set, if a generated address (including the domain)
21601 is the same as any ancestor of the current address, it is replaced by a copy of
21602 the current address. This helps in the case where local part A is aliased to B,
21603 and B has a &_.forward_& file pointing back to A. For example, within a single
21604 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
21605 &_&~jb/.forward_& contains:
21606 .code
21607 \Joe.Bloggs, <other item(s)>
21608 .endd
21609 Without the &%check_ancestor%& setting, either local part (&"jb"& or
21610 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
21611 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
21612 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
21613 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
21614 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
21615 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
21616 original address. See also the &%repeat_use%& option below.
21617
21618
21619 .option check_group redirect boolean "see below"
21620 When the &%file%& option is used, the group owner of the file is checked only
21621 when this option is set. The permitted groups are those listed in the
21622 &%owngroups%& option, together with the user's default group if
21623 &%check_local_user%& is set. If the file has the wrong group, routing is
21624 deferred. The default setting for this option is true if &%check_local_user%&
21625 is set and the &%modemask%& option permits the group write bit, or if the
21626 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
21627
21628
21629
21630 .option check_owner redirect boolean "see below"
21631 When the &%file%& option is used, the owner of the file is checked only when
21632 this option is set. If &%check_local_user%& is set, the local user is
21633 permitted; otherwise the owner must be one of those listed in the &%owners%&
21634 option. The default value for this option is true if &%check_local_user%& or
21635 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
21636
21637
21638 .option data redirect string&!! unset
21639 This option is mutually exclusive with &%file%&. One or other of them must be
21640 set, but not both. The contents of &%data%& are expanded, and then used as the
21641 list of forwarding items, or as a set of filtering instructions. If the
21642 expansion is forced to fail, or the result is an empty string or a string that
21643 has no effect (consists entirely of comments), the router declines.
21644
21645 When filtering instructions are used, the string must begin with &"#Exim
21646 filter"&, and all comments in the string, including this initial one, must be
21647 terminated with newline characters. For example:
21648 .code
21649 data = #Exim filter\n\
21650        if $h_to: contains Exim then save $home/mail/exim endif
21651 .endd
21652 If you are reading the data from a database where newlines cannot be included,
21653 you can use the &${sg}$& expansion item to turn the escape string of your
21654 choice into a newline.
21655
21656
21657 .option directory_transport redirect string&!! unset
21658 A &(redirect)& router sets up a direct delivery to a directory when a path name
21659 ending with a slash is specified as a new &"address"&. The transport used is
21660 specified by this option, which, after expansion, must be the name of a
21661 configured transport. This should normally be an &(appendfile)& transport.
21662
21663
21664 .option file redirect string&!! unset
21665 This option specifies the name of a file that contains the redirection data. It
21666 is mutually exclusive with the &%data%& option. The string is expanded before
21667 use; if the expansion is forced to fail, the router declines. Other expansion
21668 failures cause delivery to be deferred. The result of a successful expansion
21669 must be an absolute path. The entire file is read and used as the redirection
21670 data. If the data is an empty string or a string that has no effect (consists
21671 entirely of comments), the router declines.
21672
21673 .cindex "NFS" "checking for file existence"
21674 If the attempt to open the file fails with a &"does not exist"& error, Exim
21675 runs a check on the containing directory,
21676 unless &%ignore_enotdir%& is true (see below).
21677 If the directory does not appear to exist, delivery is deferred. This can
21678 happen when users' &_.forward_& files are in NFS-mounted directories, and there
21679 is a mount problem. If the containing directory does exist, but the file does
21680 not, the router declines.
21681
21682
21683 .option file_transport redirect string&!! unset
21684 .vindex "&$address_file$&"
21685 A &(redirect)& router sets up a direct delivery to a file when a path name not
21686 ending in a slash is specified as a new &"address"&. The transport used is
21687 specified by this option, which, after expansion, must be the name of a
21688 configured transport. This should normally be an &(appendfile)& transport. When
21689 it is running, the filename is in &$address_file$&.
21690
21691
21692 .option filter_prepend_home redirect boolean true
21693 When this option is true, if a &(save)& command in an Exim filter specifies a
21694 relative path, and &$home$& is defined, it is automatically prepended to the
21695 relative path. If this option is set false, this action does not happen. The
21696 relative path is then passed to the transport unmodified.
21697
21698
21699 .option forbid_blackhole redirect boolean false
21700 .cindex "restricting access to features"
21701 .cindex "filter" "locking out certain features"
21702 If this option is true, the &':blackhole:'& item may not appear in a
21703 redirection list.
21704
21705
21706 .option forbid_exim_filter redirect boolean false
21707 .cindex "restricting access to features"
21708 .cindex "filter" "locking out certain features"
21709 If this option is set true, only Sieve filters are permitted when
21710 &%allow_filter%& is true.
21711
21712
21713
21714
21715 .option forbid_file redirect boolean false
21716 .cindex "restricting access to features"
21717 .cindex "delivery" "to file; forbidding"
21718 .cindex "filter" "locking out certain features"
21719 .cindex "Sieve filter" "forbidding delivery to a file"
21720 .cindex "Sieve filter" "&""keep""& facility; disabling"
21721 If this option is true, this router may not generate a new address that
21722 specifies delivery to a local file or directory, either from a filter or from a
21723 conventional forward file. This option is forced to be true if &%one_time%& is
21724 set. It applies to Sieve filters as well as to Exim filters, but if true, it
21725 locks out the Sieve's &"keep"& facility.
21726
21727
21728 .option forbid_filter_dlfunc redirect boolean false
21729 .cindex "restricting access to features"
21730 .cindex "filter" "locking out certain features"
21731 If this option is true, string expansions in Exim filters are not allowed to
21732 make use of the &%dlfunc%& expansion facility to run dynamically loaded
21733 functions.
21734
21735 .option forbid_filter_existstest redirect boolean false
21736 .cindex "restricting access to features"
21737 .cindex "filter" "locking out certain features"
21738 .cindex "expansion" "statting a file"
21739 If this option is true, string expansions in Exim filters are not allowed to
21740 make use of the &%exists%& condition or the &%stat%& expansion item.
21741
21742 .option forbid_filter_logwrite redirect boolean false
21743 .cindex "restricting access to features"
21744 .cindex "filter" "locking out certain features"
21745 If this option is true, use of the logging facility in Exim filters is not
21746 permitted. Logging is in any case available only if the filter is being run
21747 under some unprivileged uid (which is normally the case for ordinary users'
21748 &_.forward_& files).
21749
21750
21751 .option forbid_filter_lookup redirect boolean false
21752 .cindex "restricting access to features"
21753 .cindex "filter" "locking out certain features"
21754 If this option is true, string expansions in Exim filter files are not allowed
21755 to make use of &%lookup%& items.
21756
21757
21758 .option forbid_filter_perl redirect boolean false
21759 .cindex "restricting access to features"
21760 .cindex "filter" "locking out certain features"
21761 This option has an effect only if Exim is built with embedded Perl support. If
21762 it is true, string expansions in Exim filter files are not allowed to make use
21763 of the embedded Perl support.
21764
21765
21766 .option forbid_filter_readfile redirect boolean false
21767 .cindex "restricting access to features"
21768 .cindex "filter" "locking out certain features"
21769 If this option is true, string expansions in Exim filter files are not allowed
21770 to make use of &%readfile%& items.
21771
21772
21773 .option forbid_filter_readsocket redirect boolean false
21774 .cindex "restricting access to features"
21775 .cindex "filter" "locking out certain features"
21776 If this option is true, string expansions in Exim filter files are not allowed
21777 to make use of &%readsocket%& items.
21778
21779
21780 .option forbid_filter_reply redirect boolean false
21781 .cindex "restricting access to features"
21782 .cindex "filter" "locking out certain features"
21783 If this option is true, this router may not generate an automatic reply
21784 message. Automatic replies can be generated only from Exim or Sieve filter
21785 files, not from traditional forward files. This option is forced to be true if
21786 &%one_time%& is set.
21787
21788
21789 .option forbid_filter_run redirect boolean false
21790 .cindex "restricting access to features"
21791 .cindex "filter" "locking out certain features"
21792 If this option is true, string expansions in Exim filter files are not allowed
21793 to make use of &%run%& items.
21794
21795
21796 .option forbid_include redirect boolean false
21797 .cindex "restricting access to features"
21798 .cindex "filter" "locking out certain features"
21799 If this option is true, items of the form
21800 .code
21801 :include:<path name>
21802 .endd
21803 are not permitted in non-filter redirection lists.
21804
21805
21806 .option forbid_pipe redirect boolean false
21807 .cindex "restricting access to features"
21808 .cindex "filter" "locking out certain features"
21809 .cindex "delivery" "to pipe; forbidding"
21810 If this option is true, this router may not generate a new address which
21811 specifies delivery to a pipe, either from an Exim filter or from a conventional
21812 forward file. This option is forced to be true if &%one_time%& is set.
21813
21814
21815 .option forbid_sieve_filter redirect boolean false
21816 .cindex "restricting access to features"
21817 .cindex "filter" "locking out certain features"
21818 If this option is set true, only Exim filters are permitted when
21819 &%allow_filter%& is true.
21820
21821
21822 .cindex "SMTP" "error codes"
21823 .option forbid_smtp_code redirect boolean false
21824 If this option is set true, any SMTP error codes that are present at the start
21825 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
21826 the default codes (451 and 550, respectively) are always used.
21827
21828
21829
21830
21831 .option hide_child_in_errmsg redirect boolean false
21832 .cindex "bounce message" "redirection details; suppressing"
21833 If this option is true, it prevents Exim from quoting a child address if it
21834 generates a bounce or delay message for it. Instead it says &"an address
21835 generated from <&'the top level address'&>"&. Of course, this applies only to
21836 bounces generated locally. If a message is forwarded to another host, &'its'&
21837 bounce may well quote the generated address.
21838
21839
21840 .option ignore_eacces redirect boolean false
21841 .cindex "EACCES"
21842 If this option is set and an attempt to open a redirection file yields the
21843 EACCES error (permission denied), the &(redirect)& router behaves as if the
21844 file did not exist.
21845
21846
21847 .option ignore_enotdir redirect boolean false
21848 .cindex "ENOTDIR"
21849 If this option is set and an attempt to open a redirection file yields the
21850 ENOTDIR error (something on the path is not a directory), the &(redirect)&
21851 router behaves as if the file did not exist.
21852
21853 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
21854 router that has the &%file%& option set discovers that the file does not exist
21855 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
21856 against unmounted NFS directories. If the parent can not be statted, delivery
21857 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
21858 is set, because that option tells Exim to ignore &"something on the path is not
21859 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
21860 that some operating systems give ENOENT where others give ENOTDIR.
21861
21862
21863
21864 .option include_directory redirect string unset
21865 If this option is set, the path names of any &':include:'& items in a
21866 redirection list must start with this directory.
21867
21868
21869 .option modemask redirect "octal integer" 022
21870 This specifies mode bits which must not be set for a file specified by the
21871 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
21872
21873
21874 .option one_time redirect boolean false
21875 .cindex "one-time aliasing/forwarding expansion"
21876 .cindex "alias file" "one-time expansion"
21877 .cindex "forward file" "one-time expansion"
21878 .cindex "mailing lists" "one-time expansion"
21879 .cindex "address redirection" "one-time expansion"
21880 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
21881 files each time it tries to deliver a message causes a problem when one or more
21882 of the generated addresses fails be delivered at the first attempt. The problem
21883 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
21884 but of what happens when the redirection list changes during the time that the
21885 message is on Exim's queue. This is particularly true in the case of mailing
21886 lists, where new subscribers might receive copies of messages that were posted
21887 before they subscribed.
21888
21889 If &%one_time%& is set and any addresses generated by the router fail to
21890 deliver at the first attempt, the failing addresses are added to the message as
21891 &"top level"& addresses, and the parent address that generated them is marked
21892 &"delivered"&. Thus, redirection does not happen again at the next delivery
21893 attempt.
21894
21895 &*Warning 1*&: Any header line addition or removal that is specified by this
21896 router would be lost if delivery did not succeed at the first attempt. For this
21897 reason, the &%headers_add%& and &%headers_remove%& generic options are not
21898 permitted when &%one_time%& is set.
21899
21900 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
21901 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
21902 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
21903
21904 &*Warning 3*&: The &%unseen%& generic router option may not be set with
21905 &%one_time%&.
21906
21907 The original top-level address is remembered with each of the generated
21908 addresses, and is output in any log messages. However, any intermediate parent
21909 addresses are not recorded. This makes a difference to the log only if
21910 &%all_parents%& log selector is set. It is expected that &%one_time%& will
21911 typically be used for mailing lists, where there is normally just one level of
21912 expansion.
21913
21914
21915 .option owners redirect "string list" unset
21916 .cindex "ownership" "alias file"
21917 .cindex "ownership" "forward file"
21918 .cindex "alias file" "ownership"
21919 .cindex "forward file" "ownership"
21920 This specifies a list of permitted owners for the file specified by &%file%&.
21921 This list is in addition to the local user when &%check_local_user%& is set.
21922 See &%check_owner%& above.
21923
21924
21925 .option owngroups redirect "string list" unset
21926 This specifies a list of permitted groups for the file specified by &%file%&.
21927 The list is in addition to the local user's primary group when
21928 &%check_local_user%& is set. See &%check_group%& above.
21929
21930
21931 .option pipe_transport redirect string&!! unset
21932 .vindex "&$address_pipe$&"
21933 A &(redirect)& router sets up a direct delivery to a pipe when a string
21934 starting with a vertical bar character is specified as a new &"address"&. The
21935 transport used is specified by this option, which, after expansion, must be the
21936 name of a configured transport. This should normally be a &(pipe)& transport.
21937 When the transport is run, the pipe command is in &$address_pipe$&.
21938
21939
21940 .option qualify_domain redirect string&!! unset
21941 .vindex "&$qualify_recipient$&"
21942 If this option is set, and an unqualified address (one without a domain) is
21943 generated, and that address would normally be qualified by the global setting
21944 in &%qualify_recipient%&, it is instead qualified with the domain specified by
21945 expanding this string. If the expansion fails, the router declines. If you want
21946 to revert to the default, you can have the expansion generate
21947 &$qualify_recipient$&.
21948
21949 This option applies to all unqualified addresses generated by Exim filters,
21950 but for traditional &_.forward_& files, it applies only to addresses that are
21951 not preceded by a backslash. Sieve filters cannot generate unqualified
21952 addresses.
21953
21954 .option qualify_preserve_domain redirect boolean false
21955 .cindex "domain" "in redirection; preserving"
21956 .cindex "preserving domain in redirection"
21957 .cindex "address redirection" "domain; preserving"
21958 If this option is set, the router's local &%qualify_domain%& option must not be
21959 set (a configuration error occurs if it is). If an unqualified address (one
21960 without a domain) is generated, it is qualified with the domain of the parent
21961 address (the immediately preceding ancestor) instead of the global
21962 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
21963 this applies whether or not the address is preceded by a backslash.
21964
21965
21966 .option repeat_use redirect boolean true
21967 If this option is set false, the router is skipped for a child address that has
21968 any ancestor that was routed by this router. This test happens before any of
21969 the other preconditions are tested. Exim's default anti-looping rules skip
21970 only when the ancestor is the same as the current address. See also
21971 &%check_ancestor%& above and the generic &%redirect_router%& option.
21972
21973
21974 .option reply_transport redirect string&!! unset
21975 A &(redirect)& router sets up an automatic reply when a &%mail%& or
21976 &%vacation%& command is used in a filter file. The transport used is specified
21977 by this option, which, after expansion, must be the name of a configured
21978 transport. This should normally be an &(autoreply)& transport. Other transports
21979 are unlikely to do anything sensible or useful.
21980
21981
21982 .option rewrite redirect boolean true
21983 .cindex "address redirection" "disabling rewriting"
21984 If this option is set false, addresses generated by the router are not
21985 subject to address rewriting. Otherwise, they are treated like new addresses
21986 and are rewritten according to the global rewriting rules.
21987
21988
21989 .option sieve_subaddress redirect string&!! unset
21990 The value of this option is passed to a Sieve filter to specify the
21991 :subaddress part of an address.
21992
21993 .option sieve_useraddress redirect string&!! unset
21994 The value of this option is passed to a Sieve filter to specify the :user part
21995 of an address. However, if it is unset, the entire original local part
21996 (including any prefix or suffix) is used for :user.
21997
21998
21999 .option sieve_vacation_directory redirect string&!! unset
22000 .cindex "Sieve filter" "vacation directory"
22001 To enable the &"vacation"& extension for Sieve filters, you must set
22002 &%sieve_vacation_directory%& to the directory where vacation databases are held
22003 (do not put anything else in that directory), and ensure that the
22004 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
22005 needs their own directory; Exim will create it if necessary.
22006
22007
22008
22009 .option skip_syntax_errors redirect boolean false
22010 .cindex "forward file" "broken"
22011 .cindex "address redirection" "broken files"
22012 .cindex "alias file" "broken"
22013 .cindex "broken alias or forward files"
22014 .cindex "ignoring faulty addresses"
22015 .cindex "skipping faulty addresses"
22016 .cindex "error" "skipping bad syntax"
22017 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
22018 non-filter redirection data are skipped, and each failing address is logged. If
22019 &%syntax_errors_to%& is set, a message is sent to the address it defines,
22020 giving details of the failures. If &%syntax_errors_text%& is set, its contents
22021 are expanded and placed at the head of the error message generated by
22022 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
22023 be the same address as the generic &%errors_to%& option. The
22024 &%skip_syntax_errors%& option is often used when handling mailing lists.
22025
22026 If all the addresses in a redirection list are skipped because of syntax
22027 errors, the router declines to handle the original address, and it is passed to
22028 the following routers.
22029
22030 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
22031 error in the filter causes filtering to be abandoned without any action being
22032 taken. The incident is logged, and the router declines to handle the address,
22033 so it is passed to the following routers.
22034
22035 .cindex "Sieve filter" "syntax errors in"
22036 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
22037 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
22038 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
22039
22040 &%skip_syntax_errors%& can be used to specify that errors in users' forward
22041 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
22042 option, used with an address that does not get redirected, can be used to
22043 notify users of these errors, by means of a router like this:
22044 .code
22045 userforward:
22046   driver = redirect
22047   allow_filter
22048   check_local_user
22049   file = $home/.forward
22050   file_transport = address_file
22051   pipe_transport = address_pipe
22052   reply_transport = address_reply
22053   no_verify
22054   skip_syntax_errors
22055   syntax_errors_to = real-$local_part@$domain
22056   syntax_errors_text = \
22057    This is an automatically generated message. An error has\n\
22058    been found in your .forward file. Details of the error are\n\
22059    reported below. While this error persists, you will receive\n\
22060    a copy of this message for every message that is addressed\n\
22061    to you. If your .forward file is a filter file, or if it is\n\
22062    a non-filter file containing no valid forwarding addresses,\n\
22063    a copy of each incoming message will be put in your normal\n\
22064    mailbox. If a non-filter file contains at least one valid\n\
22065    forwarding address, forwarding to the valid addresses will\n\
22066    happen, and those will be the only deliveries that occur.
22067 .endd
22068 You also need a router to ensure that local addresses that are prefixed by
22069 &`real-`& are recognized, but not forwarded or filtered. For example, you could
22070 put this immediately before the &(userforward)& router:
22071 .code
22072 real_localuser:
22073   driver = accept
22074   check_local_user
22075   local_part_prefix = real-
22076   transport = local_delivery
22077 .endd
22078 For security, it would probably be a good idea to restrict the use of this
22079 router to locally-generated messages, using a condition such as this:
22080 .code
22081   condition = ${if match {$sender_host_address}\
22082                          {\N^(|127\.0\.0\.1)$\N}}
22083 .endd
22084
22085
22086 .option syntax_errors_text redirect string&!! unset
22087 See &%skip_syntax_errors%& above.
22088
22089
22090 .option syntax_errors_to redirect string unset
22091 See &%skip_syntax_errors%& above.
22092 .ecindex IIDredrou1
22093 .ecindex IIDredrou2
22094
22095
22096
22097
22098
22099
22100 . ////////////////////////////////////////////////////////////////////////////
22101 . ////////////////////////////////////////////////////////////////////////////
22102
22103 .chapter "Environment for running local transports" "CHAPenvironment" &&&
22104          "Environment for local transports"
22105 .scindex IIDenvlotra1 "local transports" "environment for"
22106 .scindex IIDenvlotra2 "environment" "local transports"
22107 .scindex IIDenvlotra3 "transport" "local; environment for"
22108 Local transports handle deliveries to files and pipes. (The &(autoreply)&
22109 transport can be thought of as similar to a pipe.) Exim always runs transports
22110 in subprocesses, under specified uids and gids. Typical deliveries to local
22111 mailboxes run under the uid and gid of the local user.
22112
22113 Exim also sets a specific current directory while running the transport; for
22114 some transports a home directory setting is also relevant. The &(pipe)&
22115 transport is the only one that sets up environment variables; see section
22116 &<<SECTpipeenv>>& for details.
22117
22118 The values used for the uid, gid, and the directories may come from several
22119 different places. In many cases, the router that handles the address associates
22120 settings with that address as a result of its &%check_local_user%&, &%group%&,
22121 or &%user%& options. However, values may also be given in the transport's own
22122 configuration, and these override anything that comes from the router.
22123
22124
22125
22126 .section "Concurrent deliveries" "SECID131"
22127 .cindex "concurrent deliveries"
22128 .cindex "simultaneous deliveries"
22129 If two different messages for the same local recipient arrive more or less
22130 simultaneously, the two delivery processes are likely to run concurrently. When
22131 the &(appendfile)& transport is used to write to a file, Exim applies locking
22132 rules to stop concurrent processes from writing to the same file at the same
22133 time.
22134
22135 However, when you use a &(pipe)& transport, it is up to you to arrange any
22136 locking that is needed. Here is a silly example:
22137 .code
22138 my_transport:
22139   driver = pipe
22140   command = /bin/sh -c 'cat >>/some/file'
22141 .endd
22142 This is supposed to write the message at the end of the file. However, if two
22143 messages arrive at the same time, the file will be scrambled. You can use the
22144 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
22145 file using the same algorithm that Exim itself uses.
22146
22147
22148
22149
22150 .section "Uids and gids" "SECTenvuidgid"
22151 .cindex "local transports" "uid and gid"
22152 .cindex "transport" "local; uid and gid"
22153 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
22154 overrides any group that the router set in the address, even if &%user%& is not
22155 set for the transport. This makes it possible, for example, to run local mail
22156 delivery under the uid of the recipient (set by the router), but in a special
22157 group (set by the transport). For example:
22158 .code
22159 # Routers ...
22160 # User/group are set by check_local_user in this router
22161 local_users:
22162   driver = accept
22163   check_local_user
22164   transport = group_delivery
22165
22166 # Transports ...
22167 # This transport overrides the group
22168 group_delivery:
22169   driver = appendfile
22170   file = /var/spool/mail/$local_part_data
22171   group = mail
22172 .endd
22173 If &%user%& is set for a transport, its value overrides what is set in the
22174 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
22175 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
22176 set.
22177
22178 .oindex "&%initgroups%&"
22179 When the uid is taken from the transport's configuration, the &[initgroups()]&
22180 function is called for the groups associated with that uid if the
22181 &%initgroups%& option is set for the transport. When the uid is not specified
22182 by the transport, but is associated with the address by a router, the option
22183 for calling &[initgroups()]& is taken from the router configuration.
22184
22185 .cindex "&(pipe)& transport" "uid for"
22186 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
22187 is set and &%user%& is not set, the uid of the process that called Exim to
22188 receive the message is used, and if &%group%& is not set, the corresponding
22189 original gid is also used.
22190
22191 This is the detailed preference order for obtaining a gid; the first of the
22192 following that is set is used:
22193
22194 .ilist
22195 A &%group%& setting of the transport;
22196 .next
22197 A &%group%& setting of the router;
22198 .next
22199 A gid associated with a user setting of the router, either as a result of
22200 &%check_local_user%& or an explicit non-numeric &%user%& setting;
22201 .next
22202 The group associated with a non-numeric &%user%& setting of the transport;
22203 .next
22204 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
22205 the uid is the creator's uid;
22206 .next
22207 The Exim gid if the Exim uid is being used as a default.
22208 .endlist
22209
22210 If, for example, the user is specified numerically on the router and there are
22211 no group settings, no gid is available. In this situation, an error occurs.
22212 This is different for the uid, for which there always is an ultimate default.
22213 The first of the following that is set is used:
22214
22215 .ilist
22216 A &%user%& setting of the transport;
22217 .next
22218 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
22219 .next
22220 A &%user%& setting of the router;
22221 .next
22222 A &%check_local_user%& setting of the router;
22223 .next
22224 The Exim uid.
22225 .endlist
22226
22227 Of course, an error will still occur if the uid that is chosen is on the
22228 &%never_users%& list.
22229
22230
22231
22232
22233
22234 .section "Current and home directories" "SECID132"
22235 .cindex "current directory for local transport"
22236 .cindex "home directory" "for local transport"
22237 .cindex "transport" "local; home directory for"
22238 .cindex "transport" "local; current directory for"
22239 Routers may set current and home directories for local transports by means of
22240 the &%transport_current_directory%& and &%transport_home_directory%& options.
22241 However, if the transport's &%current_directory%& or &%home_directory%& options
22242 are set, they override the router's values. In detail, the home directory
22243 for a local transport is taken from the first of these values that is set:
22244
22245 .ilist
22246 The &%home_directory%& option on the transport;
22247 .next
22248 The &%transport_home_directory%& option on the router;
22249 .next
22250 The password data if &%check_local_user%& is set on the router;
22251 .next
22252 The &%router_home_directory%& option on the router.
22253 .endlist
22254
22255 The current directory is taken from the first of these values that is set:
22256
22257 .ilist
22258 The &%current_directory%& option on the transport;
22259 .next
22260 The &%transport_current_directory%& option on the router.
22261 .endlist
22262
22263
22264 If neither the router nor the transport sets a current directory, Exim uses the
22265 value of the home directory, if it is set. Otherwise it sets the current
22266 directory to &_/_& before running a local transport.
22267
22268
22269
22270 .section "Expansion variables derived from the address" "SECID133"
22271 .vindex "&$domain$&"
22272 .vindex "&$local_part$&"
22273 .vindex "&$original_domain$&"
22274 Normally a local delivery is handling a single address, and in that case the
22275 variables such as &$domain$& and &$local_part$& are set during local
22276 deliveries. However, in some circumstances more than one address may be handled
22277 at once (for example, while writing batch SMTP for onward transmission by some
22278 other means). In this case, the variables associated with the local part are
22279 never set, &$domain$& is set only if all the addresses have the same domain,
22280 and &$original_domain$& is never set.
22281 .ecindex IIDenvlotra1
22282 .ecindex IIDenvlotra2
22283 .ecindex IIDenvlotra3
22284
22285
22286
22287
22288
22289
22290
22291 . ////////////////////////////////////////////////////////////////////////////
22292 . ////////////////////////////////////////////////////////////////////////////
22293
22294 .chapter "Generic options for transports" "CHAPtransportgeneric"
22295 .scindex IIDgenoptra1 "generic options" "transport"
22296 .scindex IIDgenoptra2 "options" "generic; for transports"
22297 .scindex IIDgenoptra3 "transport" "generic options for"
22298 The following generic options apply to all transports:
22299
22300
22301 .option body_only transports boolean false
22302 .cindex "transport" "body only"
22303 .cindex "message" "transporting body only"
22304 .cindex "body of message" "transporting"
22305 If this option is set, the message's headers are not transported. It is
22306 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
22307 or &(pipe)& transports, the settings of &%message_prefix%& and
22308 &%message_suffix%& should be checked, because this option does not
22309 automatically suppress them.
22310
22311
22312 .option current_directory transports string&!! unset
22313 .cindex "transport" "current directory for"
22314 This specifies the current directory that is to be set while running the
22315 transport, overriding any value that may have been set by the router.
22316 If the expansion fails for any reason, including forced failure, an error is
22317 logged, and delivery is deferred.
22318
22319
22320 .option disable_logging transports boolean false
22321 If this option is set true, nothing is logged for any
22322 deliveries by the transport or for any
22323 transport errors. You should not set this option unless you really, really know
22324 what you are doing.
22325
22326
22327 .option debug_print transports string&!! unset
22328 .cindex "testing" "variables in drivers"
22329 If this option is set and debugging is enabled (see the &%-d%& command line
22330 option), the string is expanded and included in the debugging output when the
22331 transport is run.
22332 If expansion of the string fails, the error message is written to the debugging
22333 output, and Exim carries on processing.
22334 This facility is provided to help with checking out the values of variables and
22335 so on when debugging driver configurations. For example, if a &%headers_add%&
22336 option is not working properly, &%debug_print%& could be used to output the
22337 variables it references. A newline is added to the text if it does not end with
22338 one.
22339 The variables &$transport_name$& and &$router_name$& contain the name of the
22340 transport and the router that called it.
22341
22342 .option delivery_date_add transports boolean false
22343 .cindex "&'Delivery-date:'& header line"
22344 If this option is true, a &'Delivery-date:'& header is added to the message.
22345 This gives the actual time the delivery was made. As this is not a standard
22346 header, Exim has a configuration option (&%delivery_date_remove%&) which
22347 requests its removal from incoming messages, so that delivered messages can
22348 safely be resent to other recipients.
22349
22350
22351 .option driver transports string unset
22352 This specifies which of the available transport drivers is to be used.
22353 There is no default, and this option must be set for every transport.
22354
22355
22356 .option envelope_to_add transports boolean false
22357 .cindex "&'Envelope-to:'& header line"
22358 If this option is true, an &'Envelope-to:'& header is added to the message.
22359 This gives the original address(es) in the incoming envelope that caused this
22360 delivery to happen. More than one address may be present if the transport is
22361 configured to handle several addresses at once, or if more than one original
22362 address was redirected to the same final address. As this is not a standard
22363 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
22364 its removal from incoming messages, so that delivered messages can safely be
22365 resent to other recipients.
22366
22367
22368 .option event_action transports string&!! unset
22369 .cindex events
22370 This option declares a string to be expanded for Exim's events mechanism.
22371 For details see chapter &<<CHAPevents>>&.
22372
22373
22374 .option group transports string&!! "Exim group"
22375 .cindex "transport" "group; specifying"
22376 This option specifies a gid for running the transport process, overriding any
22377 value that the router supplies, and also overriding any value associated with
22378 &%user%& (see below).
22379
22380
22381 .option headers_add transports list&!! unset
22382 .cindex "header lines" "adding in transport"
22383 .cindex "transport" "header lines; adding"
22384 This option specifies a list of text headers,
22385 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
22386 which are (separately) expanded and added to the header
22387 portion of a message as it is transported, as described in section
22388 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
22389 routers. If the result of the expansion is an empty string, or if the expansion
22390 is forced to fail, no action is taken. Other expansion failures are treated as
22391 errors and cause the delivery to be deferred.
22392
22393 Unlike most options, &%headers_add%& can be specified multiple times
22394 for a transport; all listed headers are added.
22395
22396
22397 .option headers_only transports boolean false
22398 .cindex "transport" "header lines only"
22399 .cindex "message" "transporting headers only"
22400 .cindex "header lines" "transporting"
22401 If this option is set, the message's body is not transported. It is mutually
22402 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
22403 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
22404 checked, since this option does not automatically suppress them.
22405
22406
22407 .option headers_remove transports list&!! unset
22408 .cindex "header lines" "removing"
22409 .cindex "transport" "header lines; removing"
22410 This option specifies a list of text headers,
22411 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
22412 to be removed from the message.
22413 However, the option has no effect when an address is just being verified.
22414 Each list item is separately expanded.
22415 If the result of the expansion is an empty string, or if the expansion
22416 is forced to fail, no action is taken. Other expansion failures are treated as
22417 errors and cause the delivery to be deferred.
22418 If an item ends in *, it will match any header with the given prefix.
22419
22420 Matching headers are omitted from the message as it is transported, as described
22421 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
22422 routers.
22423
22424 Unlike most options, &%headers_remove%& can be specified multiple times
22425 for a transport; all listed headers are removed.
22426
22427 &*Warning*&: Because of the separate expansion of the list items,
22428 items that contain a list separator must have it doubled.
22429 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
22430
22431
22432
22433 .option headers_rewrite transports string unset
22434 .cindex "transport" "header lines; rewriting"
22435 .cindex "rewriting" "at transport time"
22436 This option allows addresses in header lines to be rewritten at transport time,
22437 that is, as the message is being copied to its destination. The contents of the
22438 option are a colon-separated list of rewriting rules. Each rule is in exactly
22439 the same form as one of the general rewriting rules that are applied when a
22440 message is received. These are described in chapter &<<CHAPrewrite>>&. For
22441 example,
22442 .code
22443 headers_rewrite = a@b c@d f : \
22444                   x@y w@z
22445 .endd
22446 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
22447 &'w@z'& in all address-bearing header lines. The rules are applied to the
22448 header lines just before they are written out at transport time, so they affect
22449 only those copies of the message that pass through the transport. However, only
22450 the message's original header lines, and any that were added by a system
22451 filter, are rewritten. If a router or transport adds header lines, they are not
22452 affected by this option. These rewriting rules are &'not'& applied to the
22453 envelope. You can change the return path using &%return_path%&, but you cannot
22454 change envelope recipients at this time.
22455
22456
22457 .option home_directory transports string&!! unset
22458 .cindex "transport" "home directory for"
22459 .vindex "&$home$&"
22460 This option specifies a home directory setting for a local transport,
22461 overriding any value that may be set by the router. The home directory is
22462 placed in &$home$& while expanding the transport's private options. It is also
22463 used as the current directory if no current directory is set by the
22464 &%current_directory%& option on the transport or the
22465 &%transport_current_directory%& option on the router. If the expansion fails
22466 for any reason, including forced failure, an error is logged, and delivery is
22467 deferred.
22468
22469
22470 .option initgroups transports boolean false
22471 .cindex "additional groups"
22472 .cindex "groups" "additional"
22473 .cindex "transport" "group; additional"
22474 If this option is true and the uid for the delivery process is provided by the
22475 transport, the &[initgroups()]& function is called when running the transport
22476 to ensure that any additional groups associated with the uid are set up.
22477
22478
22479 .option max_parallel transports integer&!! unset
22480 .cindex limit "transport parallelism"
22481 .cindex transport "parallel processes"
22482 .cindex transport "concurrency limit"
22483 .cindex "delivery" "parallelism for transport"
22484 If this option is set and expands to an integer greater than zero
22485 it limits the number of concurrent runs of the transport.
22486 The control does not apply to shadow transports.
22487
22488 .cindex "hints database" "transport concurrency control"
22489 Exim implements this control by means of a hints database in which a record is
22490 incremented whenever a transport process is being created. The record
22491 is decremented and possibly removed when the process terminates.
22492 Obviously there is scope for
22493 records to get left lying around if there is a system or program crash. To
22494 guard against this, Exim ignores any records that are more than six hours old.
22495
22496 If you use this option, you should also arrange to delete the
22497 relevant hints database whenever your system reboots. The names of the files
22498 start with &_misc_& and they are kept in the &_spool/db_& directory. There
22499 may be one or two files, depending on the type of DBM in use. The same files
22500 are used for ETRN and smtp transport serialization.
22501
22502
22503 .option message_size_limit transports string&!! 0
22504 .cindex "limit" "message size per transport"
22505 .cindex "size" "of message, limit"
22506 .cindex "transport" "message size; limiting"
22507 This option controls the size of messages passed through the transport. It is
22508 expanded before use; the result of the expansion must be a sequence of decimal
22509 digits, optionally followed by K or M. If the expansion fails for any reason,
22510 including forced failure, or if the result is not of the required form,
22511 delivery is deferred. If the value is greater than zero and the size of a
22512 message exceeds this limit, the address is failed. If there is any chance that
22513 the resulting bounce message could be routed to the same transport, you should
22514 ensure that &%return_size_limit%& is less than the transport's
22515 &%message_size_limit%&, as otherwise the bounce message will fail to get
22516 delivered.
22517
22518
22519
22520 .option rcpt_include_affixes transports boolean false
22521 .cindex "prefix" "for local part, including in envelope"
22522 .cindex "suffix for local part" "including in envelope"
22523 .cindex "local part" "prefix"
22524 .cindex "local part" "suffix"
22525 When this option is false (the default), and an address that has had any
22526 affixes (prefixes or suffixes) removed from the local part is delivered by any
22527 form of SMTP or LMTP, the affixes are not included. For example, if a router
22528 that contains
22529 .code
22530 local_part_prefix = *-
22531 .endd
22532 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
22533 is delivered with
22534 .code
22535 RCPT TO:<xyz@some.domain>
22536 .endd
22537 This is also the case when an ACL-time callout is being used to verify a
22538 recipient address. However, if &%rcpt_include_affixes%& is set true, the
22539 whole local part is included in the RCPT command. This option applies to BSMTP
22540 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
22541 &(lmtp)& and &(smtp)& transports.
22542
22543
22544 .option retry_use_local_part transports boolean "see below"
22545 .cindex "hints database" "retry keys"
22546 When a delivery suffers a temporary failure, a retry record is created
22547 in Exim's hints database. For remote deliveries, the key for the retry record
22548 is based on the name and/or IP address of the failing remote host. For local
22549 deliveries, the key is normally the entire address, including both the local
22550 part and the domain. This is suitable for most common cases of local delivery
22551 temporary failure &-- for example, exceeding a mailbox quota should delay only
22552 deliveries to that mailbox, not to the whole domain.
22553
22554 However, in some special cases you may want to treat a temporary local delivery
22555 as a failure associated with the domain, and not with a particular local part.
22556 (For example, if you are storing all mail for some domain in files.) You can do
22557 this by setting &%retry_use_local_part%& false.
22558
22559 For all the local transports, its default value is true. For remote transports,
22560 the default value is false for tidiness, but changing the value has no effect
22561 on a remote transport in the current implementation.
22562
22563
22564 .option return_path transports string&!! unset
22565 .cindex "envelope sender"
22566 .cindex "envelope from"
22567 .cindex "transport" "return path; changing"
22568 .cindex "return path" "changing in transport"
22569 If this option is set, the string is expanded at transport time and replaces
22570 the existing return path (envelope sender) value in the copy of the message
22571 that is being delivered. An empty return path is permitted. This feature is
22572 designed for remote deliveries, where the value of this option is used in the
22573 SMTP MAIL command. If you set &%return_path%& for a local transport, the
22574 only effect is to change the address that is placed in the &'Return-path:'&
22575 header line, if one is added to the message (see the next option).
22576
22577 &*Note:*& A changed return path is not logged unless you add
22578 &%return_path_on_delivery%& to the log selector.
22579
22580 .vindex "&$return_path$&"
22581 The expansion can refer to the existing value via &$return_path$&. This is
22582 either the message's envelope sender, or an address set by the
22583 &%errors_to%& option on a router. If the expansion is forced to fail, no
22584 replacement occurs; if it fails for another reason, delivery is deferred. This
22585 option can be used to support VERP (Variable Envelope Return Paths) &-- see
22586 section &<<SECTverp>>&.
22587
22588 &*Note*&: If a delivery error is detected locally, including the case when a
22589 remote server rejects a message at SMTP time, the bounce message is not sent to
22590 the value of this option. It is sent to the previously set errors address.
22591 This defaults to the incoming sender address, but can be changed by setting
22592 &%errors_to%& in a router.
22593
22594
22595
22596 .option return_path_add transports boolean false
22597 .chindex Return-path:
22598 If this option is true, a &'Return-path:'& header is added to the message.
22599 Although the return path is normally available in the prefix line of BSD
22600 mailboxes, this is commonly not displayed by MUAs, and so the user does not
22601 have easy access to it.
22602
22603 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
22604 the delivery SMTP server makes the final delivery"&. This implies that this
22605 header should not be present in incoming messages. Exim has a configuration
22606 option, &%return_path_remove%&, which requests removal of this header from
22607 incoming messages, so that delivered messages can safely be resent to other
22608 recipients.
22609
22610
22611 .option shadow_condition transports string&!! unset
22612 See &%shadow_transport%& below.
22613
22614
22615 .option shadow_transport transports string unset
22616 .cindex "shadow transport"
22617 .cindex "transport" "shadow"
22618 A local transport may set the &%shadow_transport%& option to the name of
22619 another local transport. Shadow remote transports are not supported.
22620
22621 Whenever a delivery to the main transport succeeds, and either
22622 &%shadow_condition%& is unset, or its expansion does not result in the empty
22623 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
22624 passed to the shadow transport, with the same delivery address or addresses. If
22625 expansion fails, no action is taken except that non-forced expansion failures
22626 cause a log line to be written.
22627
22628 The result of the shadow transport is discarded and does not affect the
22629 subsequent processing of the message. Only a single level of shadowing is
22630 provided; the &%shadow_transport%& option is ignored on any transport when it
22631 is running as a shadow. Options concerned with output from pipes are also
22632 ignored. The log line for the successful delivery has an item added on the end,
22633 of the form
22634 .code
22635 ST=<shadow transport name>
22636 .endd
22637 If the shadow transport did not succeed, the error message is put in
22638 parentheses afterwards. Shadow transports can be used for a number of different
22639 purposes, including keeping more detailed log information than Exim normally
22640 provides, and implementing automatic acknowledgment policies based on message
22641 headers that some sites insist on.
22642
22643
22644 .option transport_filter transports string&!! unset
22645 .cindex "transport" "filter"
22646 .cindex "filter" "transport filter"
22647 This option sets up a filtering (in the Unix shell sense) process for messages
22648 at transport time. It should not be confused with mail filtering as set up by
22649 individual users or via a system filter.
22650 If unset, or expanding to an empty string, no filtering is done.
22651
22652 When the message is about to be written out, the command specified by
22653 &%transport_filter%& is started up in a separate, parallel process, and
22654 the entire message, including the header lines, is passed to it on its standard
22655 input (this in fact is done from a third process, to avoid deadlock). The
22656 command must be specified as an absolute path.
22657
22658 The lines of the message that are written to the transport filter are
22659 terminated by newline (&"\n"&). The message is passed to the filter before any
22660 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
22661 lines beginning with a dot, and also before any processing implied by the
22662 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
22663 &(pipe)& transports.
22664
22665 The standard error for the filter process is set to the same destination as its
22666 standard output; this is read and written to the message's ultimate
22667 destination. The process that writes the message to the filter, the
22668 filter itself, and the original process that reads the result and delivers it
22669 are all run in parallel, like a shell pipeline.
22670
22671 The filter can perform any transformations it likes, but of course should take
22672 care not to break RFC 2822 syntax. Exim does not check the result, except to
22673 test for a final newline when SMTP is in use. All messages transmitted over
22674 SMTP must end with a newline, so Exim supplies one if it is missing.
22675
22676 .cindex "content scanning" "per user"
22677 A transport filter can be used to provide content-scanning on a per-user basis
22678 at delivery time if the only required effect of the scan is to modify the
22679 message. For example, a content scan could insert a new header line containing
22680 a spam score. This could be interpreted by a filter in the user's MUA. It is
22681 not possible to discard a message at this stage.
22682
22683 .cindex "SIZE" "ESMTP extension"
22684 A problem might arise if the filter increases the size of a message that is
22685 being sent down an SMTP connection. If the receiving SMTP server has indicated
22686 support for the SIZE parameter, Exim will have sent the size of the message
22687 at the start of the SMTP session. If what is actually sent is substantially
22688 more, the server might reject the message. This can be worked round by setting
22689 the &%size_addition%& option on the &(smtp)& transport, either to allow for
22690 additions to the message, or to disable the use of SIZE altogether.
22691
22692 .vindex "&$pipe_addresses$&"
22693 The value of the &%transport_filter%& option is the command string for starting
22694 the filter, which is run directly from Exim, not under a shell. The string is
22695 parsed by Exim in the same way as a command string for the &(pipe)& transport:
22696 Exim breaks it up into arguments and then expands each argument separately (see
22697 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
22698 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
22699 of arguments, one for each address that applies to this delivery. (This isn't
22700 an ideal name for this feature here, but as it was already implemented for the
22701 &(pipe)& transport, it seemed sensible not to change it.)
22702
22703 .vindex "&$host$&"
22704 .vindex "&$host_address$&"
22705 The expansion variables &$host$& and &$host_address$& are available when the
22706 transport is a remote one. They contain the name and IP address of the host to
22707 which the message is being sent. For example:
22708 .code
22709 transport_filter = /some/directory/transport-filter.pl \
22710   $host $host_address $sender_address $pipe_addresses
22711 .endd
22712
22713 Two problems arise if you want to use more complicated expansion items to
22714 generate transport filter commands, both of which due to the fact that the
22715 command is split up &'before'& expansion.
22716 .ilist
22717 If an expansion item contains white space, you must quote it, so that it is all
22718 part of the same command item. If the entire option setting is one such
22719 expansion item, you have to take care what kind of quoting you use. For
22720 example:
22721 .code
22722 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
22723 .endd
22724 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
22725 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
22726 stripped by Exim when it read the option's value. When the value is used, if
22727 the single quotes were missing, the line would be split into two items,
22728 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
22729 Exim tried to expand the first one.
22730 .next
22731 Except for the special case of &$pipe_addresses$& that is mentioned above, an
22732 expansion cannot generate multiple arguments, or a command name followed by
22733 arguments. Consider this example:
22734 .code
22735 transport_filter = ${lookup{$host}lsearch{/a/file}\
22736                     {$value}{/bin/cat}}
22737 .endd
22738 The result of the lookup is interpreted as the name of the command, even
22739 if it contains white space. The simplest way round this is to use a shell:
22740 .code
22741 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
22742                                {$value}{/bin/cat}}
22743 .endd
22744 .endlist
22745
22746 The filter process is run under the same uid and gid as the normal delivery.
22747 For remote deliveries this is the Exim uid/gid by default. The command should
22748 normally yield a zero return code. Transport filters are not supposed to fail.
22749 A non-zero code is taken to mean that the transport filter encountered some
22750 serious problem. Delivery of the message is deferred; the message remains on
22751 the queue and is tried again later. It is not possible to cause a message to be
22752 bounced from a transport filter.
22753
22754 If a transport filter is set on an autoreply transport, the original message is
22755 passed through the filter as it is being copied into the newly generated
22756 message, which happens if the &%return_message%& option is set.
22757
22758
22759 .option transport_filter_timeout transports time 5m
22760 .cindex "transport" "filter, timeout"
22761 When Exim is reading the output of a transport filter, it applies a timeout
22762 that can be set by this option. Exceeding the timeout is normally treated as a
22763 temporary delivery failure. However, if a transport filter is used with a
22764 &(pipe)& transport, a timeout in the transport filter is treated in the same
22765 way as a timeout in the pipe command itself. By default, a timeout is a hard
22766 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
22767 becomes a temporary error.
22768
22769
22770 .option user transports string&!! "Exim user"
22771 .cindex "uid (user id)" "local delivery"
22772 .cindex "transport" "user, specifying"
22773 This option specifies the user under whose uid the delivery process is to be
22774 run, overriding any uid that may have been set by the router. If the user is
22775 given as a name, the uid is looked up from the password data, and the
22776 associated group is taken as the value of the gid to be used if the &%group%&
22777 option is not set.
22778
22779 For deliveries that use local transports, a user and group are normally
22780 specified explicitly or implicitly (for example, as a result of
22781 &%check_local_user%&) by the router or transport.
22782
22783 .cindex "hints database" "access by remote transport"
22784 For remote transports, you should leave this option unset unless you really are
22785 sure you know what you are doing. When a remote transport is running, it needs
22786 to be able to access Exim's hints databases, because each host may have its own
22787 retry data.
22788 .ecindex IIDgenoptra1
22789 .ecindex IIDgenoptra2
22790 .ecindex IIDgenoptra3
22791
22792
22793
22794
22795
22796
22797 . ////////////////////////////////////////////////////////////////////////////
22798 . ////////////////////////////////////////////////////////////////////////////
22799
22800 .chapter "Address batching in local transports" "CHAPbatching" &&&
22801          "Address batching"
22802 .cindex "transport" "local; address batching in"
22803 The only remote transport (&(smtp)&) is normally configured to handle more than
22804 one address at a time, so that when several addresses are routed to the same
22805 remote host, just one copy of the message is sent. Local transports, however,
22806 normally handle one address at a time. That is, a separate instance of the
22807 transport is run for each address that is routed to the transport. A separate
22808 copy of the message is delivered each time.
22809
22810 .cindex "batched local delivery"
22811 .oindex "&%batch_max%&"
22812 .oindex "&%batch_id%&"
22813 In special cases, it may be desirable to handle several addresses at once in a
22814 local transport, for example:
22815
22816 .ilist
22817 In an &(appendfile)& transport, when storing messages in files for later
22818 delivery by some other means, a single copy of the message with multiple
22819 recipients saves space.
22820 .next
22821 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
22822 a single copy saves time, and is the normal way LMTP is expected to work.
22823 .next
22824 In a &(pipe)& transport, when passing the message
22825 to a scanner program or
22826 to some other delivery mechanism such as UUCP, multiple recipients may be
22827 acceptable.
22828 .endlist
22829
22830 These three local transports all have the same options for controlling multiple
22831 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
22832 repeating the information for each transport, these options are described here.
22833
22834 The &%batch_max%& option specifies the maximum number of addresses that can be
22835 delivered together in a single run of the transport. Its default value is one
22836 (no batching). When more than one address is routed to a transport that has a
22837 &%batch_max%& value greater than one, the addresses are delivered in a batch
22838 (that is, in a single run of the transport with multiple recipients), subject
22839 to certain conditions:
22840
22841 .ilist
22842 .vindex "&$local_part$&"
22843 If any of the transport's options contain a reference to &$local_part$&, no
22844 batching is possible.
22845 .next
22846 .vindex "&$domain$&"
22847 If any of the transport's options contain a reference to &$domain$&, only
22848 addresses with the same domain are batched.
22849 .next
22850 .cindex "customizing" "batching condition"
22851 If &%batch_id%& is set, it is expanded for each address, and only those
22852 addresses with the same expanded value are batched. This allows you to specify
22853 customized batching conditions. Failure of the expansion for any reason,
22854 including forced failure, disables batching, but it does not stop the delivery
22855 from taking place.
22856 .next
22857 Batched addresses must also have the same errors address (where to send
22858 delivery errors), the same header additions and removals, the same user and
22859 group for the transport, and if a host list is present, the first host must
22860 be the same.
22861 .endlist
22862
22863 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
22864 both when the file or pipe command is specified in the transport, and when it
22865 is specified by a &(redirect)& router, but all the batched addresses must of
22866 course be routed to the same file or pipe command. These two transports have an
22867 option called &%use_bsmtp%&, which causes them to deliver the message in
22868 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
22869 &%check_string%& and &%escape_string%& options are forced to the values
22870 .code
22871 check_string = "."
22872 escape_string = ".."
22873 .endd
22874 when batched SMTP is in use. A full description of the batch SMTP mechanism is
22875 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
22876 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
22877
22878 .cindex "&'Envelope-to:'& header line"
22879 If the generic &%envelope_to_add%& option is set for a batching transport, the
22880 &'Envelope-to:'& header that is added to the message contains all the addresses
22881 that are being processed together. If you are using a batching &(appendfile)&
22882 transport without &%use_bsmtp%&, the only way to preserve the recipient
22883 addresses is to set the &%envelope_to_add%& option.
22884
22885 .cindex "&(pipe)& transport" "with multiple addresses"
22886 .vindex "&$pipe_addresses$&"
22887 If you are using a &(pipe)& transport without BSMTP, and setting the
22888 transport's &%command%& option, you can include &$pipe_addresses$& as part of
22889 the command. This is not a true variable; it is a bit of magic that causes each
22890 of the recipient addresses to be inserted into the command as a separate
22891 argument. This provides a way of accessing all the addresses that are being
22892 delivered in the batch. &*Note:*& This is not possible for pipe commands that
22893 are specified by a &(redirect)& router.
22894
22895
22896
22897
22898 . ////////////////////////////////////////////////////////////////////////////
22899 . ////////////////////////////////////////////////////////////////////////////
22900
22901 .chapter "The appendfile transport" "CHAPappendfile"
22902 .scindex IIDapptra1 "&(appendfile)& transport"
22903 .scindex IIDapptra2 "transports" "&(appendfile)&"
22904 .cindex "directory creation"
22905 .cindex "creating directories"
22906 The &(appendfile)& transport delivers a message by appending it to an existing
22907 file, or by creating an entirely new file in a specified directory. Single
22908 files to which messages are appended can be in the traditional Unix mailbox
22909 format, or optionally in the MBX format supported by the Pine MUA and
22910 University of Washington IMAP daemon, &'inter alia'&. When each message is
22911 being delivered as a separate file, &"maildir"& format can optionally be used
22912 to give added protection against failures that happen part-way through the
22913 delivery. A third form of separate-file delivery known as &"mailstore"& is also
22914 supported. For all file formats, Exim attempts to create as many levels of
22915 directory as necessary, provided that &%create_directory%& is set.
22916
22917 The code for the optional formats is not included in the Exim binary by
22918 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
22919 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
22920 included.
22921
22922 .cindex "quota" "system"
22923 Exim recognizes system quota errors, and generates an appropriate message. Exim
22924 also supports its own quota control within the transport, for use when the
22925 system facility is unavailable or cannot be used for some reason.
22926
22927 If there is an error while appending to a file (for example, quota exceeded or
22928 partition filled), Exim attempts to reset the file's length and last
22929 modification time back to what they were before. If there is an error while
22930 creating an entirely new file, the new file is removed.
22931
22932 Before appending to a file, a number of security checks are made, and the
22933 file is locked. A detailed description is given below, after the list of
22934 private options.
22935
22936 The &(appendfile)& transport is most commonly used for local deliveries to
22937 users' mailboxes. However, it can also be used as a pseudo-remote transport for
22938 putting messages into files for remote delivery by some means other than Exim.
22939 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
22940 option).
22941
22942
22943
22944 .section "The file and directory options" "SECTfildiropt"
22945 The &%file%& option specifies a single file, to which the message is appended;
22946 the &%directory%& option specifies a directory, in which a new file containing
22947 the message is created. Only one of these two options can be set, and for
22948 normal deliveries to mailboxes, one of them &'must'& be set.
22949
22950 .vindex "&$address_file$&"
22951 .vindex "&$local_part$&"
22952 However, &(appendfile)& is also used for delivering messages to files or
22953 directories whose names (or parts of names) are obtained from alias,
22954 forwarding, or filtering operations (for example, a &%save%& command in a
22955 user's Exim filter). When such a transport is running, &$local_part$& contains
22956 the local part that was aliased or forwarded, and &$address_file$& contains the
22957 name (or partial name) of the file or directory generated by the redirection
22958 operation. There are two cases:
22959
22960 .ilist
22961 If neither &%file%& nor &%directory%& is set, the redirection operation
22962 must specify an absolute path (one that begins with &`/`&). This is the most
22963 common case when users with local accounts use filtering to sort mail into
22964 different folders. See for example, the &(address_file)& transport in the
22965 default configuration. If the path ends with a slash, it is assumed to be the
22966 name of a directory. A delivery to a directory can also be forced by setting
22967 &%maildir_format%& or &%mailstore_format%&.
22968 .next
22969 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
22970 used to determine the file or directory name for the delivery. Normally, the
22971 contents of &$address_file$& are used in some way in the string expansion.
22972 .endlist
22973 .cindex "tainted data" "in filenames"
22974 .cindex appendfile "tainted data"
22975 Tainted data may not be used for a file or directory name.
22976 This means that, for instance, &$local_part$& cannot be used directly
22977 as a component of a path.  It can however be used as the key for a lookup
22978 which returns a path (or component).
22979
22980
22981 .cindex "Sieve filter" "configuring &(appendfile)&"
22982 .cindex "Sieve filter" "relative mailbox path handling"
22983 As an example of the second case, consider an environment where users do not
22984 have home directories. They may be permitted to use Exim filter commands of the
22985 form:
22986 .code
22987 save folder23
22988 .endd
22989 or Sieve filter commands of the form:
22990 .code
22991 require "fileinto";
22992 fileinto "folder23";
22993 .endd
22994 In this situation, the expansion of &%file%& or &%directory%& in the transport
22995 must transform the relative path into an appropriate absolute filename. In the
22996 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
22997 is used as a result of a &"keep"& action in the filter. This example shows one
22998 way of handling this requirement:
22999 .code
23000 file = ${if eq{$address_file}{inbox} \
23001             {/var/mail/$local_part_data} \
23002             {${if eq{${substr_0_1:$address_file}}{/} \
23003                   {$address_file} \
23004                   {$home/mail/$address_file} \
23005             }} \
23006        }
23007 .endd
23008 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
23009 location, absolute paths are used without change, and other folders are in the
23010 &_mail_& directory within the home directory.
23011
23012 &*Note 1*&: While processing an Exim filter, a relative path such as
23013 &_folder23_& is turned into an absolute path if a home directory is known to
23014 the router. In particular, this is the case if &%check_local_user%& is set. If
23015 you want to prevent this happening at routing time, you can set
23016 &%router_home_directory%& empty. This forces the router to pass the relative
23017 path to the transport.
23018
23019 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
23020 the &%file%& or &%directory%& option is still used if it is set.
23021
23022
23023
23024
23025 .section "Private options for appendfile" "SECID134"
23026 .cindex "options" "&(appendfile)& transport"
23027
23028
23029
23030 .option allow_fifo appendfile boolean false
23031 .cindex "fifo (named pipe)"
23032 .cindex "named pipe (fifo)"
23033 .cindex "pipe" "named (fifo)"
23034 Setting this option permits delivery to named pipes (FIFOs) as well as to
23035 regular files. If no process is reading the named pipe at delivery time, the
23036 delivery is deferred.
23037
23038
23039 .option allow_symlink appendfile boolean false
23040 .cindex "symbolic link" "to mailbox"
23041 .cindex "mailbox" "symbolic link"
23042 By default, &(appendfile)& will not deliver if the path name for the file is
23043 that of a symbolic link. Setting this option relaxes that constraint, but there
23044 are security issues involved in the use of symbolic links. Be sure you know
23045 what you are doing if you set this. Details of exactly what this option affects
23046 are included in the discussion which follows this list of options.
23047
23048
23049 .option batch_id appendfile string&!! unset
23050 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23051 However, batching is automatically disabled for &(appendfile)& deliveries that
23052 happen as a result of forwarding or aliasing or other redirection directly to a
23053 file.
23054
23055
23056 .option batch_max appendfile integer 1
23057 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23058
23059
23060 .option check_group appendfile boolean false
23061 When this option is set, the group owner of the file defined by the &%file%&
23062 option is checked to see that it is the same as the group under which the
23063 delivery process is running. The default setting is false because the default
23064 file mode is 0600, which means that the group is irrelevant.
23065
23066
23067 .option check_owner appendfile boolean true
23068 When this option is set, the owner of the file defined by the &%file%& option
23069 is checked to ensure that it is the same as the user under which the delivery
23070 process is running.
23071
23072
23073 .option check_string appendfile string "see below"
23074 .cindex "&""From""& line"
23075 As &(appendfile)& writes the message, the start of each line is tested for
23076 matching &%check_string%&, and if it does, the initial matching characters are
23077 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
23078 a literal string, not a regular expression, and the case of any letters it
23079 contains is significant.
23080
23081 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
23082 are forced to &"."& and &".."& respectively, and any settings in the
23083 configuration are ignored. Otherwise, they default to &"From&~"& and
23084 &">From&~"& when the &%file%& option is set, and unset when any of the
23085 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
23086
23087 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
23088 suitable for traditional &"BSD"& mailboxes, where a line beginning with
23089 &"From&~"& indicates the start of a new message. All four options need changing
23090 if another format is used. For example, to deliver to mailboxes in MMDF format:
23091 .cindex "MMDF format mailbox"
23092 .cindex "mailbox" "MMDF format"
23093 .code
23094 check_string = "\1\1\1\1\n"
23095 escape_string = "\1\1\1\1 \n"
23096 message_prefix = "\1\1\1\1\n"
23097 message_suffix = "\1\1\1\1\n"
23098 .endd
23099 .option create_directory appendfile boolean true
23100 .cindex "directory creation"
23101 When this option is true, Exim attempts to create any missing superior
23102 directories for the file that it is about to write. A created directory's mode
23103 is given by the &%directory_mode%& option.
23104
23105 The group ownership of a newly created directory is highly dependent on the
23106 operating system (and possibly the file system) that is being used. For
23107 example, in Solaris, if the parent directory has the setgid bit set, its group
23108 is propagated to the child; if not, the currently set group is used. However,
23109 in FreeBSD, the parent's group is always used.
23110
23111
23112
23113 .option create_file appendfile string anywhere
23114 This option constrains the location of files and directories that are created
23115 by this transport. It applies to files defined by the &%file%& option and
23116 directories defined by the &%directory%& option. In the case of maildir
23117 delivery, it applies to the top level directory, not the maildir directories
23118 beneath.
23119
23120 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
23121 &"belowhome"&. In the second and third cases, a home directory must have been
23122 set for the transport. This option is not useful when an explicit filename is
23123 given for normal mailbox deliveries. It is intended for the case when filenames
23124 are generated from users' &_.forward_& files. These are usually handled
23125 by an &(appendfile)& transport called &%address_file%&. See also
23126 &%file_must_exist%&.
23127
23128
23129 .option directory appendfile string&!! unset
23130 This option is mutually exclusive with the &%file%& option, but one of &%file%&
23131 or &%directory%& must be set, unless the delivery is the direct result of a
23132 redirection (see section &<<SECTfildiropt>>&).
23133
23134 When &%directory%& is set, the string is expanded, and the message is delivered
23135 into a new file or files in or below the given directory, instead of being
23136 appended to a single mailbox file. A number of different formats are provided
23137 (see &%maildir_format%& and &%mailstore_format%&), and see section
23138 &<<SECTopdir>>& for further details of this form of delivery.
23139
23140
23141 .option directory_file appendfile string&!! "see below"
23142 .cindex "base62"
23143 .vindex "&$inode$&"
23144 When &%directory%& is set, but neither &%maildir_format%& nor
23145 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
23146 whose name is obtained by expanding this string. The default value is:
23147 .code
23148 q${base62:$tod_epoch}-$inode
23149 .endd
23150 This generates a unique name from the current time, in base 62 form, and the
23151 inode of the file. The variable &$inode$& is available only when expanding this
23152 option.
23153
23154
23155 .option directory_mode appendfile "octal integer" 0700
23156 If &(appendfile)& creates any directories as a result of the
23157 &%create_directory%& option, their mode is specified by this option.
23158
23159
23160 .option escape_string appendfile string "see description"
23161 See &%check_string%& above.
23162
23163
23164 .option file appendfile string&!! unset
23165 This option is mutually exclusive with the &%directory%& option, but one of
23166 &%file%& or &%directory%& must be set, unless the delivery is the direct result
23167 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
23168 specifies a single file, to which the message is appended. One or more of
23169 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
23170 &%file%&.
23171
23172 .cindex "NFS" "lock file"
23173 .cindex "locking files"
23174 .cindex "lock files"
23175 If you are using more than one host to deliver over NFS into the same
23176 mailboxes, you should always use lock files.
23177
23178 The string value is expanded for each delivery, and must yield an absolute
23179 path. The most common settings of this option are variations on one of these
23180 examples:
23181 .code
23182 file = /var/spool/mail/$local_part_data
23183 file = /home/$local_part_data/inbox
23184 file = $home/inbox
23185 .endd
23186 .cindex "&""sticky""& bit"
23187 In the first example, all deliveries are done into the same directory. If Exim
23188 is configured to use lock files (see &%use_lockfile%& below) it must be able to
23189 create a file in the directory, so the &"sticky"& bit must be turned on for
23190 deliveries to be possible, or alternatively the &%group%& option can be used to
23191 run the delivery under a group id which has write access to the directory.
23192
23193
23194
23195 .option file_format appendfile string unset
23196 .cindex "file" "mailbox; checking existing format"
23197 This option requests the transport to check the format of an existing file
23198 before adding to it. The check consists of matching a specific string at the
23199 start of the file. The value of the option consists of an even number of
23200 colon-separated strings. The first of each pair is the test string, and the
23201 second is the name of a transport. If the transport associated with a matched
23202 string is not the current transport, control is passed over to the other
23203 transport. For example, suppose the standard &(local_delivery)& transport has
23204 this added to it:
23205 .code
23206 file_format = "From       : local_delivery :\
23207                \1\1\1\1\n : local_mmdf_delivery"
23208 .endd
23209 Mailboxes that begin with &"From"& are still handled by this transport, but if
23210 a mailbox begins with four binary ones followed by a newline, control is passed
23211 to a transport called &%local_mmdf_delivery%&, which presumably is configured
23212 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
23213 is assumed to match the current transport. If the start of a mailbox doesn't
23214 match any string, or if the transport named for a given string is not defined,
23215 delivery is deferred.
23216
23217
23218 .option file_must_exist appendfile boolean false
23219 If this option is true, the file specified by the &%file%& option must exist.
23220 A temporary error occurs if it does not, causing delivery to be deferred.
23221 If this option is false, the file is created if it does not exist.
23222
23223
23224 .option lock_fcntl_timeout appendfile time 0s
23225 .cindex "timeout" "mailbox locking"
23226 .cindex "mailbox" "locking, blocking and non-blocking"
23227 .cindex "locking files"
23228 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
23229 when locking an open mailbox file. If the call fails, the delivery process
23230 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
23231 Non-blocking calls are used so that the file is not kept open during the wait
23232 for the lock; the reason for this is to make it as safe as possible for
23233 deliveries over NFS in the case when processes might be accessing an NFS
23234 mailbox without using a lock file. This should not be done, but
23235 misunderstandings and hence misconfigurations are not unknown.
23236
23237 On a busy system, however, the performance of a non-blocking lock approach is
23238 not as good as using a blocking lock with a timeout. In this case, the waiting
23239 is done inside the system call, and Exim's delivery process acquires the lock
23240 and can proceed as soon as the previous lock holder releases it.
23241
23242 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
23243 timeout, are used. There may still be some retrying: the maximum number of
23244 retries is
23245 .code
23246 (lock_retries * lock_interval) / lock_fcntl_timeout
23247 .endd
23248 rounded up to the next whole number. In other words, the total time during
23249 which &(appendfile)& is trying to get a lock is roughly the same, unless
23250 &%lock_fcntl_timeout%& is set very large.
23251
23252 You should consider setting this option if you are getting a lot of delayed
23253 local deliveries because of errors of the form
23254 .code
23255 failed to lock mailbox /some/file (fcntl)
23256 .endd
23257
23258 .option lock_flock_timeout appendfile time 0s
23259 This timeout applies to file locking when using &[flock()]& (see
23260 &%use_flock%&); the timeout operates in a similar manner to
23261 &%lock_fcntl_timeout%&.
23262
23263
23264 .option lock_interval appendfile time 3s
23265 This specifies the time to wait between attempts to lock the file. See below
23266 for details of locking.
23267
23268
23269 .option lock_retries appendfile integer 10
23270 This specifies the maximum number of attempts to lock the file. A value of zero
23271 is treated as 1. See below for details of locking.
23272
23273
23274 .option lockfile_mode appendfile "octal integer" 0600
23275 This specifies the mode of the created lock file, when a lock file is being
23276 used (see &%use_lockfile%& and &%use_mbx_lock%&).
23277
23278
23279 .option lockfile_timeout appendfile time 30m
23280 .cindex "timeout" "mailbox locking"
23281 When a lock file is being used (see &%use_lockfile%&), if a lock file already
23282 exists and is older than this value, it is assumed to have been left behind by
23283 accident, and Exim attempts to remove it.
23284
23285
23286 .option mailbox_filecount appendfile string&!! unset
23287 .cindex "mailbox" "specifying size of"
23288 .cindex "size" "of mailbox"
23289 If this option is set, it is expanded, and the result is taken as the current
23290 number of files in the mailbox. It must be a decimal number, optionally
23291 followed by K or M. This provides a way of obtaining this information from an
23292 external source that maintains the data.
23293
23294
23295 .option mailbox_size appendfile string&!! unset
23296 .cindex "mailbox" "specifying size of"
23297 .cindex "size" "of mailbox"
23298 If this option is set, it is expanded, and the result is taken as the current
23299 size the mailbox. It must be a decimal number, optionally followed by K or M.
23300 This provides a way of obtaining this information from an external source that
23301 maintains the data. This is likely to be helpful for maildir deliveries where
23302 it is computationally expensive to compute the size of a mailbox.
23303
23304
23305
23306 .option maildir_format appendfile boolean false
23307 .cindex "maildir format" "specifying"
23308 If this option is set with the &%directory%& option, the delivery is into a new
23309 file, in the &"maildir"& format that is used by other mail software. When the
23310 transport is activated directly from a &(redirect)& router (for example, the
23311 &(address_file)& transport in the default configuration), setting
23312 &%maildir_format%& causes the path received from the router to be treated as a
23313 directory, whether or not it ends with &`/`&. This option is available only if
23314 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
23315 &<<SECTmaildirdelivery>>& below for further details.
23316
23317
23318 .option maildir_quota_directory_regex appendfile string "See below"
23319 .cindex "maildir format" "quota; directories included in"
23320 .cindex "quota" "maildir; directories included in"
23321 This option is relevant only when &%maildir_use_size_file%& is set. It defines
23322 a regular expression for specifying directories, relative to the quota
23323 directory (see &%quota_directory%&), that should be included in the quota
23324 calculation. The default value is:
23325 .code
23326 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
23327 .endd
23328 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
23329 (directories whose names begin with a dot). If you want to exclude the
23330 &_Trash_&
23331 folder from the count (as some sites do), you need to change this setting to
23332 .code
23333 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
23334 .endd
23335 This uses a negative lookahead in the regular expression to exclude the
23336 directory whose name is &_.Trash_&. When a directory is excluded from quota
23337 calculations, quota processing is bypassed for any messages that are delivered
23338 directly into that directory.
23339
23340
23341 .option maildir_retries appendfile integer 10
23342 This option specifies the number of times to retry when writing a file in
23343 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
23344
23345
23346 .option maildir_tag appendfile string&!! unset
23347 This option applies only to deliveries in maildir format, and is described in
23348 section &<<SECTmaildirdelivery>>& below.
23349
23350
23351 .option maildir_use_size_file appendfile&!! boolean false
23352 .cindex "maildir format" "&_maildirsize_& file"
23353 The result of string expansion for this option must be a valid boolean value.
23354 If it is true, it enables support for &_maildirsize_& files. Exim
23355 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
23356 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
23357 value is zero. See &%maildir_quota_directory_regex%& above and section
23358 &<<SECTmaildirdelivery>>& below for further details.
23359
23360 .option maildirfolder_create_regex appendfile string unset
23361 .cindex "maildir format" "&_maildirfolder_& file"
23362 .cindex "&_maildirfolder_&, creating"
23363 The value of this option is a regular expression. If it is unset, it has no
23364 effect. Otherwise, before a maildir delivery takes place, the pattern is
23365 matched against the name of the maildir directory, that is, the directory
23366 containing the &_new_& and &_tmp_& subdirectories that will be used for the
23367 delivery. If there is a match, Exim checks for the existence of a file called
23368 &_maildirfolder_& in the directory, and creates it if it does not exist.
23369 See section &<<SECTmaildirdelivery>>& for more details.
23370
23371
23372 .option mailstore_format appendfile boolean false
23373 .cindex "mailstore format" "specifying"
23374 If this option is set with the &%directory%& option, the delivery is into two
23375 new files in  &"mailstore"& format. The option is available only if
23376 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
23377 below for further details.
23378
23379
23380 .option mailstore_prefix appendfile string&!! unset
23381 This option applies only to deliveries in mailstore format, and is described in
23382 section &<<SECTopdir>>& below.
23383
23384
23385 .option mailstore_suffix appendfile string&!! unset
23386 This option applies only to deliveries in mailstore format, and is described in
23387 section &<<SECTopdir>>& below.
23388
23389
23390 .option mbx_format appendfile boolean false
23391 .cindex "locking files"
23392 .cindex "file" "locking"
23393 .cindex "file" "MBX format"
23394 .cindex "MBX format, specifying"
23395 This option is available only if Exim has been compiled with SUPPORT_MBX
23396 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
23397 the message is appended to the mailbox file in MBX format instead of
23398 traditional Unix format. This format is supported by Pine4 and its associated
23399 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
23400
23401 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
23402 automatically changed by the use of &%mbx_format%&. They should normally be set
23403 empty when using MBX format, so this option almost always appears in this
23404 combination:
23405 .code
23406 mbx_format = true
23407 message_prefix =
23408 message_suffix =
23409 .endd
23410 If none of the locking options are mentioned in the configuration,
23411 &%use_mbx_lock%& is assumed and the other locking options default to false. It
23412 is possible to specify the other kinds of locking with &%mbx_format%&, but
23413 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
23414 interworks with &'c-client'&, providing for shared access to the mailbox. It
23415 should not be used if any program that does not use this form of locking is
23416 going to access the mailbox, nor should it be used if the mailbox file is NFS
23417 mounted, because it works only when the mailbox is accessed from a single host.
23418
23419 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
23420 the standard version of &'c-client'&, because as long as it has a mailbox open
23421 (this means for the whole of a Pine or IMAP session), Exim will not be able to
23422 append messages to it.
23423
23424
23425 .option message_prefix appendfile string&!! "see below"
23426 .cindex "&""From""& line"
23427 The string specified here is expanded and output at the start of every message.
23428 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
23429 in which case it is:
23430 .code
23431 message_prefix = "From ${if def:return_path{$return_path}\
23432   {MAILER-DAEMON}} $tod_bsdinbox\n"
23433 .endd
23434 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23435 &`\n`& to &`\r\n`& in &%message_prefix%&.
23436
23437 .option message_suffix appendfile string&!! "see below"
23438 The string specified here is expanded and output at the end of every message.
23439 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
23440 in which case it is a single newline character. The suffix can be suppressed by
23441 setting
23442 .code
23443 message_suffix =
23444 .endd
23445 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23446 &`\n`& to &`\r\n`& in &%message_suffix%&.
23447
23448 .option mode appendfile "octal integer" 0600
23449 If the output file is created, it is given this mode. If it already exists and
23450 has wider permissions, they are reduced to this mode. If it has narrower
23451 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
23452 if the delivery is the result of a &%save%& command in a filter file specifying
23453 a particular mode, the mode of the output file is always forced to take that
23454 value, and this option is ignored.
23455
23456
23457 .option mode_fail_narrower appendfile boolean true
23458 This option applies in the case when an existing mailbox file has a narrower
23459 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
23460 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
23461 continues with the delivery attempt, using the existing mode of the file.
23462
23463
23464 .option notify_comsat appendfile boolean false
23465 If this option is true, the &'comsat'& daemon is notified after every
23466 successful delivery to a user mailbox. This is the daemon that notifies logged
23467 on users about incoming mail.
23468
23469
23470 .option quota appendfile string&!! unset
23471 .cindex "quota" "imposed by Exim"
23472 This option imposes a limit on the size of the file to which Exim is appending,
23473 or to the total space used in the directory tree when the &%directory%& option
23474 is set. In the latter case, computation of the space used is expensive, because
23475 all the files in the directory (and any sub-directories) have to be
23476 individually inspected and their sizes summed. (See &%quota_size_regex%& and
23477 &%maildir_use_size_file%& for ways to avoid this in environments where users
23478 have no shell access to their mailboxes).
23479
23480 As there is no interlock against two simultaneous deliveries into a
23481 multi-file mailbox, it is possible for the quota to be overrun in this case.
23482 For single-file mailboxes, of course, an interlock is a necessity.
23483
23484 A file's size is taken as its &'used'& value. Because of blocking effects, this
23485 may be a lot less than the actual amount of disk space allocated to the file.
23486 If the sizes of a number of files are being added up, the rounding effect can
23487 become quite noticeable, especially on systems that have large block sizes.
23488 Nevertheless, it seems best to stick to the &'used'& figure, because this is
23489 the obvious value which users understand most easily.
23490
23491 The value of the option is expanded, and must then be a numerical value
23492 (decimal point allowed), optionally followed by one of the letters K, M, or G,
23493 for kilobytes, megabytes, or gigabytes, optionally followed by a slash
23494 and further option modifiers. If Exim is running on a system with
23495 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
23496 be handled.
23497
23498 The option modifier &%no_check%& can be used to force delivery even if the over
23499 quota condition is met. The quota gets updated as usual.
23500
23501 &*Note*&: A value of zero is interpreted as &"no quota"&.
23502
23503 The expansion happens while Exim is running as root, before it changes uid for
23504 the delivery. This means that files that are inaccessible to the end user can
23505 be used to hold quota values that are looked up in the expansion. When delivery
23506 fails because this quota is exceeded, the handling of the error is as for
23507 system quota failures.
23508
23509 By default, Exim's quota checking mimics system quotas, and restricts the
23510 mailbox to the specified maximum size, though the value is not accurate to the
23511 last byte, owing to separator lines and additional headers that may get added
23512 during message delivery. When a mailbox is nearly full, large messages may get
23513 refused even though small ones are accepted, because the size of the current
23514 message is added to the quota when the check is made. This behaviour can be
23515 changed by setting &%quota_is_inclusive%& false. When this is done, the check
23516 for exceeding the quota does not include the current message. Thus, deliveries
23517 continue until the quota has been exceeded; thereafter, no further messages are
23518 delivered. See also &%quota_warn_threshold%&.
23519
23520
23521 .option quota_directory appendfile string&!! unset
23522 This option defines the directory to check for quota purposes when delivering
23523 into individual files. The default is the delivery directory, or, if a file
23524 called &_maildirfolder_& exists in a maildir directory, the parent of the
23525 delivery directory.
23526
23527
23528 .option quota_filecount appendfile string&!! 0
23529 This option applies when the &%directory%& option is set. It limits the total
23530 number of files in the directory (compare the inode limit in system quotas). It
23531 can only be used if &%quota%& is also set. The value is expanded; an expansion
23532 failure causes delivery to be deferred. A value of zero is interpreted as
23533 &"no quota"&.
23534
23535 The option modifier &%no_check%& can be used to force delivery even if the over
23536 quota condition is met. The quota gets updated as usual.
23537
23538 .option quota_is_inclusive appendfile boolean true
23539 See &%quota%& above.
23540
23541
23542 .option quota_size_regex appendfile string unset
23543 This option applies when one of the delivery modes that writes a separate file
23544 for each message is being used. When Exim wants to find the size of one of
23545 these files in order to test the quota, it first checks &%quota_size_regex%&.
23546 If this is set to a regular expression that matches the filename, and it
23547 captures one string, that string is interpreted as a representation of the
23548 file's size. The value of &%quota_size_regex%& is not expanded.
23549
23550 This feature is useful only when users have no shell access to their mailboxes
23551 &-- otherwise they could defeat the quota simply by renaming the files. This
23552 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
23553 the file length to the filename. For example:
23554 .code
23555 maildir_tag = ,S=$message_size
23556 quota_size_regex = ,S=(\d+)
23557 .endd
23558 An alternative to &$message_size$& is &$message_linecount$&, which contains the
23559 number of lines in the message.
23560
23561 The regular expression should not assume that the length is at the end of the
23562 filename (even though &%maildir_tag%& puts it there) because maildir MUAs
23563 sometimes add other information onto the ends of message filenames.
23564
23565 Section &<<SECID136>>& contains further information.
23566
23567 This option should not be used when other message-handling software
23568 may duplicate messages by making hardlinks to the files.  When that is done Exim
23569 will count the message size once for each filename, in contrast with the actual
23570 disk usage.  When the option is not set, calculating total usage requires
23571 a system-call per file to get the size; the number of links is then available also
23572 as is used to adjust the effective size.
23573
23574
23575 .option quota_warn_message appendfile string&!! "see below"
23576 See below for the use of this option. If it is not set when
23577 &%quota_warn_threshold%& is set, it defaults to
23578 .code
23579 quota_warn_message = "\
23580   To: $local_part@$domain\n\
23581   Subject: Your mailbox\n\n\
23582   This message is automatically created \
23583   by mail delivery software.\n\n\
23584   The size of your mailbox has exceeded \
23585   a warning threshold that is\n\
23586   set by the system administrator.\n"
23587 .endd
23588
23589
23590 .option quota_warn_threshold appendfile string&!! 0
23591 .cindex "quota" "warning threshold"
23592 .cindex "mailbox" "size warning"
23593 .cindex "size" "of mailbox"
23594 This option is expanded in the same way as &%quota%& (see above). If the
23595 resulting value is greater than zero, and delivery of the message causes the
23596 size of the file or total space in the directory tree to cross the given
23597 threshold, a warning message is sent. If &%quota%& is also set, the threshold
23598 may be specified as a percentage of it by following the value with a percent
23599 sign. For example:
23600 .code
23601 quota = 10M
23602 quota_warn_threshold = 75%
23603 .endd
23604 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
23605 percent sign is ignored.
23606
23607 The warning message itself is specified by the &%quota_warn_message%& option,
23608 and it must start with a &'To:'& header line containing the recipient(s) of the
23609 warning message. These do not necessarily have to include the recipient(s) of
23610 the original message. A &'Subject:'& line should also normally be supplied. You
23611 can include any other header lines that you want. If you do not include a
23612 &'From:'& line, the default is:
23613 .code
23614 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
23615 .endd
23616 .oindex &%errors_reply_to%&
23617 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
23618 option.
23619
23620 The &%quota%& option does not have to be set in order to use this option; they
23621 are independent of one another except when the threshold is specified as a
23622 percentage.
23623
23624
23625 .option use_bsmtp appendfile boolean false
23626 .cindex "envelope from"
23627 .cindex "envelope sender"
23628 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
23629 format, with the envelope sender and recipient(s) included as SMTP commands. If
23630 you want to include a leading HELO command with such messages, you can do
23631 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
23632 for details of batch SMTP.
23633
23634
23635 .option use_crlf appendfile boolean false
23636 .cindex "carriage return"
23637 .cindex "linefeed"
23638 This option causes lines to be terminated with the two-character CRLF sequence
23639 (carriage return, linefeed) instead of just a linefeed character. In the case
23640 of batched SMTP, the byte sequence written to the file is then an exact image
23641 of what would be sent down a real SMTP connection.
23642
23643 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
23644 (which are used to supply the traditional &"From&~"& and blank line separators
23645 in Berkeley-style mailboxes) are written verbatim, so must contain their own
23646 carriage return characters if these are needed. In cases where these options
23647 have non-empty defaults, the values end with a single linefeed, so they must be
23648 changed to end with &`\r\n`& if &%use_crlf%& is set.
23649
23650
23651 .option use_fcntl_lock appendfile boolean "see below"
23652 This option controls the use of the &[fcntl()]& function to lock a file for
23653 exclusive use when a message is being appended. It is set by default unless
23654 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
23655 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
23656 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
23657
23658
23659 .option use_flock_lock appendfile boolean false
23660 This option is provided to support the use of &[flock()]& for file locking, for
23661 the few situations where it is needed. Most modern operating systems support
23662 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
23663 each other. Exim uses &[fcntl()]& locking by default.
23664
23665 This option is required only if you are using an operating system where
23666 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
23667 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
23668 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
23669
23670 .cindex "Solaris" "&[flock()]& support"
23671 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
23672 have it (and some, I think, provide a not quite right version built on top of
23673 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
23674 the ability to use it, and any attempt to do so will cause a configuration
23675 error.
23676
23677 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
23678 is just being mapped onto &[fcntl()]& by the OS).
23679
23680
23681 .option use_lockfile appendfile boolean "see below"
23682 If this option is turned off, Exim does not attempt to create a lock file when
23683 appending to a mailbox file. In this situation, the only locking is by
23684 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
23685 sure that every MUA that is ever going to look at your users' mailboxes uses
23686 &[fcntl()]& rather than a lock file, and even then only when you are not
23687 delivering over NFS from more than one host.
23688
23689 .cindex "NFS" "lock file"
23690 In order to append to an NFS file safely from more than one host, it is
23691 necessary to take out a lock &'before'& opening the file, and the lock file
23692 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
23693 file corruption.
23694
23695 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
23696 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
23697 except when &%mbx_format%& is set.
23698
23699
23700 .option use_mbx_lock appendfile boolean "see below"
23701 This option is available only if Exim has been compiled with SUPPORT_MBX
23702 set in &_Local/Makefile_&. Setting the option specifies that special MBX
23703 locking rules be used. It is set by default if &%mbx_format%& is set and none
23704 of the locking options are mentioned in the configuration. The locking rules
23705 are the same as are used by the &'c-client'& library that underlies Pine and
23706 the IMAP4 and POP daemons that come with it (see the discussion below). The
23707 rules allow for shared access to the mailbox. However, this kind of locking
23708 does not work when the mailbox is NFS mounted.
23709
23710 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
23711 &%use_flock_lock%& to control what kind of locking is used in implementing the
23712 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
23713 without &%use_fcntl_lock%& or &%use_flock_lock%&.
23714
23715
23716
23717
23718 .section "Operational details for appending" "SECTopappend"
23719 .cindex "appending to a file"
23720 .cindex "file" "appending"
23721 Before appending to a file, the following preparations are made:
23722
23723 .ilist
23724 If the name of the file is &_/dev/null_&, no action is taken, and a success
23725 return is given.
23726
23727 .next
23728 .cindex "directory creation"
23729 If any directories on the file's path are missing, Exim creates them if the
23730 &%create_directory%& option is set. A created directory's mode is given by the
23731 &%directory_mode%& option.
23732
23733 .next
23734 If &%file_format%& is set, the format of an existing file is checked. If this
23735 indicates that a different transport should be used, control is passed to that
23736 transport.
23737
23738 .next
23739 .cindex "file" "locking"
23740 .cindex "locking files"
23741 .cindex "NFS" "lock file"
23742 If &%use_lockfile%& is set, a lock file is built in a way that will work
23743 reliably over NFS, as follows:
23744
23745 .olist
23746 Create a &"hitching post"& file whose name is that of the lock file with the
23747 current time, primary host name, and process id added, by opening for writing
23748 as a new file. If this fails with an access error, delivery is deferred.
23749 .next
23750 Close the hitching post file, and hard link it to the lock filename.
23751 .next
23752 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
23753 Unlink the hitching post name.
23754 .next
23755 Otherwise, use &[stat()]& to get information about the hitching post file, and
23756 then unlink hitching post name. If the number of links is exactly two, creation
23757 of the lock file succeeded but something (for example, an NFS server crash and
23758 restart) caused this fact not to be communicated to the &[link()]& call.
23759 .next
23760 If creation of the lock file failed, wait for &%lock_interval%& and try again,
23761 up to &%lock_retries%& times. However, since any program that writes to a
23762 mailbox should complete its task very quickly, it is reasonable to time out old
23763 lock files that are normally the result of user agent and system crashes. If an
23764 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
23765 it before trying again.
23766 .endlist olist
23767
23768 .next
23769 A call is made to &[lstat()]& to discover whether the main file exists, and if
23770 so, what its characteristics are. If &[lstat()]& fails for any reason other
23771 than non-existence, delivery is deferred.
23772
23773 .next
23774 .cindex "symbolic link" "to mailbox"
23775 .cindex "mailbox" "symbolic link"
23776 If the file does exist and is a symbolic link, delivery is deferred, unless the
23777 &%allow_symlink%& option is set, in which case the ownership of the link is
23778 checked, and then &[stat()]& is called to find out about the real file, which
23779 is then subjected to the checks below. The check on the top-level link
23780 ownership prevents one user creating a link for another's mailbox in a sticky
23781 directory, though allowing symbolic links in this case is definitely not a good
23782 idea. If there is a chain of symbolic links, the intermediate ones are not
23783 checked.
23784
23785 .next
23786 If the file already exists but is not a regular file, or if the file's owner
23787 and group (if the group is being checked &-- see &%check_group%& above) are
23788 different from the user and group under which the delivery is running,
23789 delivery is deferred.
23790
23791 .next
23792 If the file's permissions are more generous than specified, they are reduced.
23793 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
23794 is set false, in which case the delivery is tried using the existing
23795 permissions.
23796
23797 .next
23798 The file's inode number is saved, and the file is then opened for appending.
23799 If this fails because the file has vanished, &(appendfile)& behaves as if it
23800 hadn't existed (see below). For any other failures, delivery is deferred.
23801
23802 .next
23803 If the file is opened successfully, check that the inode number hasn't
23804 changed, that it is still a regular file, and that the owner and permissions
23805 have not changed. If anything is wrong, defer delivery and freeze the message.
23806
23807 .next
23808 If the file did not exist originally, defer delivery if the &%file_must_exist%&
23809 option is set. Otherwise, check that the file is being created in a permitted
23810 directory if the &%create_file%& option is set (deferring on failure), and then
23811 open for writing as a new file, with the O_EXCL and O_CREAT options,
23812 except when dealing with a symbolic link (the &%allow_symlink%& option must be
23813 set). In this case, which can happen if the link points to a non-existent file,
23814 the file is opened for writing using O_CREAT but not O_EXCL, because
23815 that prevents link following.
23816
23817 .next
23818 .cindex "loop" "while file testing"
23819 If opening fails because the file exists, obey the tests given above for
23820 existing files. However, to avoid looping in a situation where the file is
23821 being continuously created and destroyed, the exists/not-exists loop is broken
23822 after 10 repetitions, and the message is then frozen.
23823
23824 .next
23825 If opening fails with any other error, defer delivery.
23826
23827 .next
23828 .cindex "file" "locking"
23829 .cindex "locking files"
23830 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
23831 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
23832 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
23833 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
23834 file, and an exclusive lock on the file whose name is
23835 .code
23836 /tmp/.<device-number>.<inode-number>
23837 .endd
23838 using the device and inode numbers of the open mailbox file, in accordance with
23839 the MBX locking rules. This file is created with a mode that is specified by
23840 the &%lockfile_mode%& option.
23841
23842 If Exim fails to lock the file, there are two possible courses of action,
23843 depending on the value of the locking timeout. This is obtained from
23844 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
23845
23846 If the timeout value is zero, the file is closed, Exim waits for
23847 &%lock_interval%&, and then goes back and re-opens the file as above and tries
23848 to lock it again. This happens up to &%lock_retries%& times, after which the
23849 delivery is deferred.
23850
23851 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
23852 &[flock()]& are used (with the given timeout), so there has already been some
23853 waiting involved by the time locking fails. Nevertheless, Exim does not give up
23854 immediately. It retries up to
23855 .code
23856 (lock_retries * lock_interval) / <timeout>
23857 .endd
23858 times (rounded up).
23859 .endlist
23860
23861 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
23862 and/or &[flock()]& locks) and then deletes the lock file if one was created.
23863
23864
23865 .section "Operational details for delivery to a new file" "SECTopdir"
23866 .cindex "delivery" "to single file"
23867 .cindex "&""From""& line"
23868 When the &%directory%& option is set instead of &%file%&, each message is
23869 delivered into a newly-created file or set of files. When &(appendfile)& is
23870 activated directly from a &(redirect)& router, neither &%file%& nor
23871 &%directory%& is normally set, because the path for delivery is supplied by the
23872 router. (See for example, the &(address_file)& transport in the default
23873 configuration.) In this case, delivery is to a new file if either the path name
23874 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
23875
23876 No locking is required while writing the message to a new file, so the various
23877 locking options of the transport are ignored. The &"From"& line that by default
23878 separates messages in a single file is not normally needed, nor is the escaping
23879 of message lines that start with &"From"&, and there is no need to ensure a
23880 newline at the end of each message. Consequently, the default values for
23881 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
23882 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
23883
23884 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
23885 the files in the delivery directory by default. However, you can specify a
23886 different directory by setting &%quota_directory%&. Also, for maildir
23887 deliveries (see below) the &_maildirfolder_& convention is honoured.
23888
23889
23890 .cindex "maildir format"
23891 .cindex "mailstore format"
23892 There are three different ways in which delivery to individual files can be
23893 done, controlled by the settings of the &%maildir_format%& and
23894 &%mailstore_format%& options. Note that code to support maildir or mailstore
23895 formats is not included in the binary unless SUPPORT_MAILDIR or
23896 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
23897
23898 .cindex "directory creation"
23899 In all three cases an attempt is made to create the directory and any necessary
23900 sub-directories if they do not exist, provided that the &%create_directory%&
23901 option is set (the default). The location of a created directory can be
23902 constrained by setting &%create_file%&. A created directory's mode is given by
23903 the &%directory_mode%& option. If creation fails, or if the
23904 &%create_directory%& option is not set when creation is required, delivery is
23905 deferred.
23906
23907
23908
23909 .section "Maildir delivery" "SECTmaildirdelivery"
23910 .cindex "maildir format" "description of"
23911 If the &%maildir_format%& option is true, Exim delivers each message by writing
23912 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
23913 directory that is defined by the &%directory%& option (the &"delivery
23914 directory"&). If the delivery is successful, the file is renamed into the
23915 &_new_& subdirectory.
23916
23917 In the filename, <&'stime'&> is the current time of day in seconds, and
23918 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
23919 Exim checks that the time-of-day clock has moved on by at least one microsecond
23920 before terminating the delivery process. This guarantees uniqueness for the
23921 filename. However, as a precaution, Exim calls &[stat()]& for the file before
23922 opening it. If any response other than ENOENT (does not exist) is given,
23923 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
23924
23925 Before Exim carries out a maildir delivery, it ensures that subdirectories
23926 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
23927 do not exist, Exim tries to create them and any superior directories in their
23928 path, subject to the &%create_directory%& and &%create_file%& options. If the
23929 &%maildirfolder_create_regex%& option is set, and the regular expression it
23930 contains matches the delivery directory, Exim also ensures that a file called
23931 &_maildirfolder_& exists in the delivery directory. If a missing directory or
23932 &_maildirfolder_& file cannot be created, delivery is deferred.
23933
23934 These features make it possible to use Exim to create all the necessary files
23935 and directories in a maildir mailbox, including subdirectories for maildir++
23936 folders. Consider this example:
23937 .code
23938 maildir_format = true
23939 directory = /var/mail/$local_part_data\
23940            ${if eq{$local_part_suffix}{}{}\
23941            {/.${substr_1:$local_part_suffix}}}
23942 maildirfolder_create_regex = /\.[^/]+$
23943 .endd
23944 If &$local_part_suffix$& is empty (there was no suffix for the local part),
23945 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
23946 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
23947 not match this name, so Exim will not look for or create the file
23948 &_/var/mail/pimbo/maildirfolder_&, though it will create
23949 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
23950
23951 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
23952 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
23953 does match &%maildirfolder_create_regex%&. In this case, Exim will create
23954 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
23955 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
23956
23957 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
23958 not inadvertently match the toplevel maildir directory, because a
23959 &_maildirfolder_& file at top level would completely break quota calculations.
23960
23961 .cindex "quota" "in maildir delivery"
23962 .cindex "maildir++"
23963 If Exim is required to check a &%quota%& setting before a maildir delivery, and
23964 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
23965 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
23966 Exim assumes the directory is a maildir++ folder directory, which is one level
23967 down from the user's top level mailbox directory. This causes it to start at
23968 the parent directory instead of the current directory when calculating the
23969 amount of space used.
23970
23971 One problem with delivering into a multi-file mailbox is that it is
23972 computationally expensive to compute the size of the mailbox for quota
23973 checking. Various approaches have been taken to reduce the amount of work
23974 needed. The next two sections describe two of them. A third alternative is to
23975 use some external process for maintaining the size data, and use the expansion
23976 of the &%mailbox_size%& option as a way of importing it into Exim.
23977
23978
23979
23980
23981 .section "Using tags to record message sizes" "SECID135"
23982 If &%maildir_tag%& is set, the string is expanded for each delivery.
23983 When the maildir file is renamed into the &_new_& sub-directory, the
23984 tag is added to its name. However, if adding the tag takes the length of the
23985 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
23986 the tag is dropped and the maildir file is created with no tag.
23987
23988
23989 .vindex "&$message_size$&"
23990 Tags can be used to encode the size of files in their names; see
23991 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
23992 happens after the message has been written. The value of the &$message_size$&
23993 variable is set to the number of bytes actually written. If the expansion is
23994 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
23995 be deferred. The expanded tag may contain any printing characters except &"/"&.
23996 Non-printing characters in the string are ignored; if the resulting string is
23997 empty, it is ignored. If it starts with an alphanumeric character, a leading
23998 colon is inserted; this default has not proven to be the path that popular
23999 maildir implementations have chosen (but changing it in Exim would break
24000 backwards compatibility).
24001
24002 For one common implementation, you might set:
24003 .code
24004 maildir_tag = ,S=${message_size}
24005 .endd
24006 but you should check the documentation of the other software to be sure.
24007
24008 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
24009 as this allows Exim to extract the size from your tag, instead of having to
24010 &[stat()]& each message file.
24011
24012
24013 .section "Using a maildirsize file" "SECID136"
24014 .cindex "quota" "in maildir delivery"
24015 .cindex "maildir format" "&_maildirsize_& file"
24016 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
24017 storing quota and message size information in a file called &_maildirsize_&
24018 within the toplevel maildir directory. If this file does not exist, Exim
24019 creates it, setting the quota from the &%quota%& option of the transport. If
24020 the maildir directory itself does not exist, it is created before any attempt
24021 to write a &_maildirsize_& file.
24022
24023 The &_maildirsize_& file is used to hold information about the sizes of
24024 messages in the maildir, thus speeding up quota calculations. The quota value
24025 in the file is just a cache; if the quota is changed in the transport, the new
24026 value overrides the cached value when the next message is delivered. The cache
24027 is maintained for the benefit of other programs that access the maildir and
24028 need to know the quota.
24029
24030 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
24031 file is maintained (with a zero quota setting), but no quota is imposed.
24032
24033 A regular expression is available for controlling which directories in the
24034 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
24035 See the description of the &%maildir_quota_directory_regex%& option above for
24036 details.
24037
24038
24039 .section "Mailstore delivery" "SECID137"
24040 .cindex "mailstore format" "description of"
24041 If the &%mailstore_format%& option is true, each message is written as two
24042 files in the given directory. A unique base name is constructed from the
24043 message id and the current delivery process, and the files that are written use
24044 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
24045 contains the message's envelope, and the &_.msg_& file contains the message
24046 itself. The base name is placed in the variable &$mailstore_basename$&.
24047
24048 During delivery, the envelope is first written to a file with the suffix
24049 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
24050 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
24051 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
24052 file before accessing either of them. An alternative approach is to wait for
24053 the absence of a &_.tmp_& file.
24054
24055 The envelope file starts with any text defined by the &%mailstore_prefix%&
24056 option, expanded and terminated by a newline if there isn't one. Then follows
24057 the sender address on one line, then all the recipient addresses, one per line.
24058 There can be more than one recipient only if the &%batch_max%& option is set
24059 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
24060 appended to the file, followed by a newline if it does not end with one.
24061
24062 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
24063 failure, it is ignored. Other expansion errors are treated as serious
24064 configuration errors, and delivery is deferred. The variable
24065 &$mailstore_basename$& is available for use during these expansions.
24066
24067
24068 .section "Non-special new file delivery" "SECID138"
24069 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
24070 file is created directly in the named directory. For example, when delivering
24071 messages into files in batched SMTP format for later delivery to some host (see
24072 section &<<SECTbatchSMTP>>&), a setting such as
24073 .code
24074 directory = /var/bsmtp/$host
24075 .endd
24076 might be used. A message is written to a file with a temporary name, which is
24077 then renamed when the delivery is complete. The final name is obtained by
24078 expanding the contents of the &%directory_file%& option.
24079 .ecindex IIDapptra1
24080 .ecindex IIDapptra2
24081
24082
24083
24084
24085
24086
24087 . ////////////////////////////////////////////////////////////////////////////
24088 . ////////////////////////////////////////////////////////////////////////////
24089
24090 .chapter "The autoreply transport" "CHID8"
24091 .scindex IIDauttra1 "transports" "&(autoreply)&"
24092 .scindex IIDauttra2 "&(autoreply)& transport"
24093 The &(autoreply)& transport is not a true transport in that it does not cause
24094 the message to be transmitted. Instead, it generates a new mail message as an
24095 automatic reply to the incoming message. &'References:'& and
24096 &'Auto-Submitted:'& header lines are included. These are constructed according
24097 to the rules in RFCs 2822 and 3834, respectively.
24098
24099 If the router that passes the message to this transport does not have the
24100 &%unseen%& option set, the original message (for the current recipient) is not
24101 delivered anywhere. However, when the &%unseen%& option is set on the router
24102 that passes the message to this transport, routing of the address continues, so
24103 another router can set up a normal message delivery.
24104
24105
24106 The &(autoreply)& transport is usually run as the result of mail filtering, a
24107 &"vacation"& message being the standard example. However, it can also be run
24108 directly from a router like any other transport. To reduce the possibility of
24109 message cascades, messages created by the &(autoreply)& transport always have
24110 empty envelope sender addresses, like bounce messages.
24111
24112 The parameters of the message to be sent can be specified in the configuration
24113 by options described below. However, these are used only when the address
24114 passed to the transport does not contain its own reply information. When the
24115 transport is run as a consequence of a
24116 &%mail%&
24117 or &%vacation%& command in a filter file, the parameters of the message are
24118 supplied by the filter, and passed with the address. The transport's options
24119 that define the message are then ignored (so they are not usually set in this
24120 case). The message is specified entirely by the filter or by the transport; it
24121 is never built from a mixture of options. However, the &%file_optional%&,
24122 &%mode%&, and &%return_message%& options apply in all cases.
24123
24124 &(Autoreply)& is implemented as a local transport. When used as a result of a
24125 command in a user's filter file, &(autoreply)& normally runs under the uid and
24126 gid of the user, and with appropriate current and home directories (see chapter
24127 &<<CHAPenvironment>>&).
24128
24129 There is a subtle difference between routing a message to a &(pipe)& transport
24130 that generates some text to be returned to the sender, and routing it to an
24131 &(autoreply)& transport. This difference is noticeable only if more than one
24132 address from the same message is so handled. In the case of a pipe, the
24133 separate outputs from the different addresses are gathered up and returned to
24134 the sender in a single message, whereas if &(autoreply)& is used, a separate
24135 message is generated for each address that is passed to it.
24136
24137 Non-printing characters are not permitted in the header lines generated for the
24138 message that &(autoreply)& creates, with the exception of newlines that are
24139 immediately followed by white space. If any non-printing characters are found,
24140 the transport defers.
24141 Whether characters with the top bit set count as printing characters or not is
24142 controlled by the &%print_topbitchars%& global option.
24143
24144 If any of the generic options for manipulating headers (for example,
24145 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
24146 of the original message that is included in the generated message when
24147 &%return_message%& is set. They do not apply to the generated message itself.
24148
24149 .vindex "&$sender_address$&"
24150 If the &(autoreply)& transport receives return code 2 from Exim when it submits
24151 the message, indicating that there were no recipients, it does not treat this
24152 as an error. This means that autoreplies sent to &$sender_address$& when this
24153 is empty (because the incoming message is a bounce message) do not cause
24154 problems. They are just discarded.
24155
24156
24157
24158 .section "Private options for autoreply" "SECID139"
24159 .cindex "options" "&(autoreply)& transport"
24160
24161 .option bcc autoreply string&!! unset
24162 This specifies the addresses that are to receive &"blind carbon copies"& of the
24163 message when the message is specified by the transport.
24164
24165
24166 .option cc autoreply string&!! unset
24167 This specifies recipients of the message and the contents of the &'Cc:'& header
24168 when the message is specified by the transport.
24169
24170
24171 .option file autoreply string&!! unset
24172 The contents of the file are sent as the body of the message when the message
24173 is specified by the transport. If both &%file%& and &%text%& are set, the text
24174 string comes first.
24175
24176
24177 .option file_expand autoreply boolean false
24178 If this is set, the contents of the file named by the &%file%& option are
24179 subjected to string expansion as they are added to the message.
24180
24181
24182 .option file_optional autoreply boolean false
24183 If this option is true, no error is generated if the file named by the &%file%&
24184 option or passed with the address does not exist or cannot be read.
24185
24186
24187 .option from autoreply string&!! unset
24188 This specifies the contents of the &'From:'& header when the message is
24189 specified by the transport.
24190
24191
24192 .option headers autoreply string&!! unset
24193 This specifies additional RFC 2822 headers that are to be added to the message
24194 when the message is specified by the transport. Several can be given by using
24195 &"\n"& to separate them. There is no check on the format.
24196
24197
24198 .option log autoreply string&!! unset
24199 This option names a file in which a record of every message sent is logged when
24200 the message is specified by the transport.
24201
24202
24203 .option mode autoreply "octal integer" 0600
24204 If either the log file or the &"once"& file has to be created, this mode is
24205 used.
24206
24207
24208 .option never_mail autoreply "address list&!!" unset
24209 If any run of the transport creates a message with a recipient that matches any
24210 item in the list, that recipient is quietly discarded. If all recipients are
24211 discarded, no message is created. This applies both when the recipients are
24212 generated by a filter and when they are specified in the transport.
24213
24214
24215
24216 .option once autoreply string&!! unset
24217 This option names a file or DBM database in which a record of each &'To:'&
24218 recipient is kept when the message is specified by the transport. &*Note*&:
24219 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
24220
24221 If &%once%& is unset, or is set to an empty string, the message is always sent.
24222 By default, if &%once%& is set to a non-empty filename, the message
24223 is not sent if a potential recipient is already listed in the database.
24224 However, if the &%once_repeat%& option specifies a time greater than zero, the
24225 message is sent if that much time has elapsed since a message was last sent to
24226 this recipient. A setting of zero time for &%once_repeat%& (the default)
24227 prevents a message from being sent a second time &-- in this case, zero means
24228 infinity.
24229
24230 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
24231 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
24232 greater than zero, it changes the way Exim implements the &%once%& option.
24233 Instead of using a DBM file to record every recipient it sends to, it uses a
24234 regular file, whose size will never get larger than the given value.
24235
24236 In the file, Exim keeps a linear list of recipient addresses and the times at
24237 which they were sent messages. If the file is full when a new address needs to
24238 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
24239 means that a given recipient may receive multiple messages, but at
24240 unpredictable intervals that depend on the rate of turnover of addresses in the
24241 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
24242
24243
24244 .option once_file_size autoreply integer 0
24245 See &%once%& above.
24246
24247
24248 .option once_repeat autoreply time&!! 0s
24249 See &%once%& above.
24250 After expansion, the value of this option must be a valid time value.
24251
24252
24253 .option reply_to autoreply string&!! unset
24254 This specifies the contents of the &'Reply-To:'& header when the message is
24255 specified by the transport.
24256
24257
24258 .option return_message autoreply boolean false
24259 If this is set, a copy of the original message is returned with the new
24260 message, subject to the maximum size set in the &%return_size_limit%& global
24261 configuration option.
24262
24263
24264 .option subject autoreply string&!! unset
24265 This specifies the contents of the &'Subject:'& header when the message is
24266 specified by the transport. It is tempting to quote the original subject in
24267 automatic responses. For example:
24268 .code
24269 subject = Re: $h_subject:
24270 .endd
24271 There is a danger in doing this, however. It may allow a third party to
24272 subscribe your users to an opt-in mailing list, provided that the list accepts
24273 bounce messages as subscription confirmations. Well-managed lists require a
24274 non-bounce message to confirm a subscription, so the danger is relatively
24275 small.
24276
24277
24278
24279 .option text autoreply string&!! unset
24280 This specifies a single string to be used as the body of the message when the
24281 message is specified by the transport. If both &%text%& and &%file%& are set,
24282 the text comes first.
24283
24284
24285 .option to autoreply string&!! unset
24286 This specifies recipients of the message and the contents of the &'To:'& header
24287 when the message is specified by the transport.
24288 .ecindex IIDauttra1
24289 .ecindex IIDauttra2
24290
24291
24292
24293
24294 . ////////////////////////////////////////////////////////////////////////////
24295 . ////////////////////////////////////////////////////////////////////////////
24296
24297 .chapter "The lmtp transport" "CHAPLMTP"
24298 .cindex "transports" "&(lmtp)&"
24299 .cindex "&(lmtp)& transport"
24300 .cindex "LMTP" "over a pipe"
24301 .cindex "LMTP" "over a socket"
24302 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
24303 specified command
24304 or by interacting with a Unix domain socket.
24305 This transport is something of a cross between the &(pipe)& and &(smtp)&
24306 transports. Exim also has support for using LMTP over TCP/IP; this is
24307 implemented as an option for the &(smtp)& transport. Because LMTP is expected
24308 to be of minority interest, the default build-time configure in &_src/EDITME_&
24309 has it commented out. You need to ensure that
24310 .code
24311 TRANSPORT_LMTP=yes
24312 .endd
24313 .cindex "options" "&(lmtp)& transport"
24314 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
24315 included in the Exim binary. The private options of the &(lmtp)& transport are
24316 as follows:
24317
24318 .option batch_id lmtp string&!! unset
24319 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24320
24321
24322 .option batch_max lmtp integer 1
24323 This limits the number of addresses that can be handled in a single delivery.
24324 Most LMTP servers can handle several addresses at once, so it is normally a
24325 good idea to increase this value. See the description of local delivery
24326 batching in chapter &<<CHAPbatching>>&.
24327
24328
24329 .option command lmtp string&!! unset
24330 This option must be set if &%socket%& is not set. The string is a command which
24331 is run in a separate process. It is split up into a command name and list of
24332 arguments, each of which is separately expanded (so expansion cannot change the
24333 number of arguments). The command is run directly, not via a shell. The message
24334 is passed to the new process using the standard input and output to operate the
24335 LMTP protocol.
24336
24337 .option ignore_quota lmtp boolean false
24338 .cindex "LMTP" "ignoring quota errors"
24339 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
24340 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
24341 in its response to the LHLO command.
24342
24343 .option socket lmtp string&!! unset
24344 This option must be set if &%command%& is not set. The result of expansion must
24345 be the name of a Unix domain socket. The transport connects to the socket and
24346 delivers the message to it using the LMTP protocol.
24347
24348
24349 .option timeout lmtp time 5m
24350 The transport is aborted if the created process or Unix domain socket does not
24351 respond to LMTP commands or message input within this timeout. Delivery
24352 is deferred, and will be tried again later. Here is an example of a typical
24353 LMTP transport:
24354 .code
24355 lmtp:
24356   driver = lmtp
24357   command = /some/local/lmtp/delivery/program
24358   batch_max = 20
24359   user = exim
24360 .endd
24361 This delivers up to 20 addresses at a time, in a mixture of domains if
24362 necessary, running as the user &'exim'&.
24363
24364
24365
24366 . ////////////////////////////////////////////////////////////////////////////
24367 . ////////////////////////////////////////////////////////////////////////////
24368
24369 .chapter "The pipe transport" "CHAPpipetransport"
24370 .scindex IIDpiptra1 "transports" "&(pipe)&"
24371 .scindex IIDpiptra2 "&(pipe)& transport"
24372 The &(pipe)& transport is used to deliver messages via a pipe to a command
24373 running in another process. One example is the use of &(pipe)& as a
24374 pseudo-remote transport for passing messages to some other delivery mechanism
24375 (such as UUCP). Another is the use by individual users to automatically process
24376 their incoming messages. The &(pipe)& transport can be used in one of the
24377 following ways:
24378
24379 .ilist
24380 .vindex "&$local_part$&"
24381 A router routes one address to a transport in the normal way, and the
24382 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
24383 contains the local part of the address (as usual), and the command that is run
24384 is specified by the &%command%& option on the transport.
24385 .next
24386 .vindex "&$pipe_addresses$&"
24387 If the &%batch_max%& option is set greater than 1 (the default is 1), the
24388 transport can handle more than one address in a single run. In this case, when
24389 more than one address is routed to the transport, &$local_part$& is not set
24390 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
24391 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
24392 that are routed to the transport.
24393 .next
24394 .vindex "&$address_pipe$&"
24395 A router redirects an address directly to a pipe command (for example, from an
24396 alias or forward file). In this case, &$address_pipe$& contains the text of the
24397 pipe command, and the &%command%& option on the transport is ignored unless
24398 &%force_command%& is set. If only one address is being transported
24399 (&%batch_max%& is not greater than one, or only one address was redirected to
24400 this pipe command), &$local_part$& contains the local part that was redirected.
24401 .endlist
24402
24403
24404 The &(pipe)& transport is a non-interactive delivery method. Exim can also
24405 deliver messages over pipes using the LMTP interactive protocol. This is
24406 implemented by the &(lmtp)& transport.
24407
24408 In the case when &(pipe)& is run as a consequence of an entry in a local user's
24409 &_.forward_& file, the command runs under the uid and gid of that user. In
24410 other cases, the uid and gid have to be specified explicitly, either on the
24411 transport or on the router that handles the address. Current and &"home"&
24412 directories are also controllable. See chapter &<<CHAPenvironment>>& for
24413 details of the local delivery environment and chapter &<<CHAPbatching>>&
24414 for a discussion of local delivery batching.
24415
24416 .cindex "tainted data" "in pipe command"
24417 .cindex pipe "tainted data"
24418 Tainted data may not be used for the command name.
24419
24420
24421 .section "Concurrent delivery" "SECID140"
24422 If two messages arrive at almost the same time, and both are routed to a pipe
24423 delivery, the two pipe transports may be run concurrently. You must ensure that
24424 any pipe commands you set up are robust against this happening. If the commands
24425 write to a file, the &%exim_lock%& utility might be of use.
24426 Alternatively the &%max_parallel%& option could be used with a value
24427 of "1" to enforce serialization.
24428
24429
24430
24431
24432 .section "Returned status and data" "SECID141"
24433 .cindex "&(pipe)& transport" "returned data"
24434 If the command exits with a non-zero return code, the delivery is deemed to
24435 have failed, unless either the &%ignore_status%& option is set (in which case
24436 the return code is treated as zero), or the return code is one of those listed
24437 in the &%temp_errors%& option, which are interpreted as meaning &"try again
24438 later"&. In this case, delivery is deferred. Details of a permanent failure are
24439 logged, but are not included in the bounce message, which merely contains
24440 &"local delivery failed"&.
24441
24442 If the command exits on a signal and the &%freeze_signal%& option is set then
24443 the message will be frozen in the queue. If that option is not set, a bounce
24444 will be sent as normal.
24445
24446 If the return code is greater than 128 and the command being run is a shell
24447 script, it normally means that the script was terminated by a signal whose
24448 value is the return code minus 128. The &%freeze_signal%& option does not
24449 apply in this case.
24450
24451 If Exim is unable to run the command (that is, if &[execve()]& fails), the
24452 return code is set to 127. This is the value that a shell returns if it is
24453 asked to run a non-existent command. The wording for the log line suggests that
24454 a non-existent command may be the problem.
24455
24456 The &%return_output%& option can affect the result of a pipe delivery. If it is
24457 set and the command produces any output on its standard output or standard
24458 error streams, the command is considered to have failed, even if it gave a zero
24459 return code or if &%ignore_status%& is set. The output from the command is
24460 included as part of the bounce message. The &%return_fail_output%& option is
24461 similar, except that output is returned only when the command exits with a
24462 failure return code, that is, a value other than zero or a code that matches
24463 &%temp_errors%&.
24464
24465
24466
24467 .section "How the command is run" "SECThowcommandrun"
24468 .cindex "&(pipe)& transport" "path for command"
24469 The command line is (by default) broken down into a command name and arguments
24470 by the &(pipe)& transport itself. The &%allow_commands%& and
24471 &%restrict_to_path%& options can be used to restrict the commands that may be
24472 run.
24473
24474 .cindex "quoting" "in pipe command"
24475 Unquoted arguments are delimited by white space. If an argument appears in
24476 double quotes, backslash is interpreted as an escape character in the usual
24477 way. If an argument appears in single quotes, no escaping is done.
24478
24479 String expansion is applied to the command line except when it comes from a
24480 traditional &_.forward_& file (commands from a filter file are expanded). The
24481 expansion is applied to each argument in turn rather than to the whole line.
24482 For this reason, any string expansion item that contains white space must be
24483 quoted so as to be contained within a single argument. A setting such as
24484 .code
24485 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
24486 .endd
24487 will not work, because the expansion item gets split between several
24488 arguments. You have to write
24489 .code
24490 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
24491 .endd
24492 to ensure that it is all in one argument. The expansion is done in this way,
24493 argument by argument, so that the number of arguments cannot be changed as a
24494 result of expansion, and quotes or backslashes in inserted variables do not
24495 interact with external quoting. However, this leads to problems if you want to
24496 generate multiple arguments (or the command name plus arguments) from a single
24497 expansion. In this situation, the simplest solution is to use a shell. For
24498 example:
24499 .code
24500 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
24501 .endd
24502
24503 .cindex "transport" "filter"
24504 .cindex "filter" "transport filter"
24505 .vindex "&$pipe_addresses$&"
24506 Special handling takes place when an argument consists of precisely the text
24507 &`$pipe_addresses`& (no quotes).
24508 This is not a general expansion variable; the only
24509 place this string is recognized is when it appears as an argument for a pipe or
24510 transport filter command. It causes each address that is being handled to be
24511 inserted in the argument list at that point &'as a separate argument'&. This
24512 avoids any problems with spaces or shell metacharacters, and is of use when a
24513 &(pipe)& transport is handling groups of addresses in a batch.
24514
24515 If &%force_command%& is enabled on the transport, special handling takes place
24516 for an argument that consists of precisely the text &`$address_pipe`&.  It
24517 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
24518 argument is inserted in the argument list at that point
24519 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
24520 the only item in the argument; in fact, if it were then &%force_command%&
24521 should behave as a no-op.  Rather, it should be used to adjust the command
24522 run while preserving the argument vector separation.
24523
24524 After splitting up into arguments and expansion, the resulting command is run
24525 in a subprocess directly from the transport, &'not'& under a shell. The
24526 message that is being delivered is supplied on the standard input, and the
24527 standard output and standard error are both connected to a single pipe that is
24528 read by Exim. The &%max_output%& option controls how much output the command
24529 may produce, and the &%return_output%& and &%return_fail_output%& options
24530 control what is done with it.
24531
24532 Not running the command under a shell (by default) lessens the security risks
24533 in cases when a command from a user's filter file is built out of data that was
24534 taken from an incoming message. If a shell is required, it can of course be
24535 explicitly specified as the command to be run. However, there are circumstances
24536 where existing commands (for example, in &_.forward_& files) expect to be run
24537 under a shell and cannot easily be modified. To allow for these cases, there is
24538 an option called &%use_shell%&, which changes the way the &(pipe)& transport
24539 works. Instead of breaking up the command line as just described, it expands it
24540 as a single string and passes the result to &_/bin/sh_&. The
24541 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
24542 with &%use_shell%&, and the whole mechanism is inherently less secure.
24543
24544
24545
24546 .section "Environment variables" "SECTpipeenv"
24547 .cindex "&(pipe)& transport" "environment for command"
24548 .cindex "environment" "&(pipe)& transport"
24549 The environment variables listed below are set up when the command is invoked.
24550 This list is a compromise for maximum compatibility with other MTAs. Note that
24551 the &%environment%& option can be used to add additional variables to this
24552 environment. The environment for the &(pipe)& transport is not subject
24553 to the &%add_environment%& and &%keep_environment%& main config options.
24554 .display
24555 &`DOMAIN            `&   the domain of the address
24556 &`HOME              `&   the home directory, if set
24557 &`HOST              `&   the host name when called from a router (see below)
24558 &`LOCAL_PART        `&   see below
24559 &`LOCAL_PART_PREFIX `&   see below
24560 &`LOCAL_PART_SUFFIX `&   see below
24561 &`LOGNAME           `&   see below
24562 &`MESSAGE_ID        `&   Exim's local ID for the message
24563 &`PATH              `&   as specified by the &%path%& option below
24564 &`QUALIFY_DOMAIN    `&   the sender qualification domain
24565 &`RECIPIENT         `&   the complete recipient address
24566 &`SENDER            `&   the sender of the message (empty if a bounce)
24567 &`SHELL             `&   &`/bin/sh`&
24568 &`TZ                `&   the value of the &%timezone%& option, if set
24569 &`USER              `&   see below
24570 .endd
24571 When a &(pipe)& transport is called directly from (for example) an &(accept)&
24572 router, LOCAL_PART is set to the local part of the address. When it is
24573 called as a result of a forward or alias expansion, LOCAL_PART is set to
24574 the local part of the address that was expanded. In both cases, any affixes are
24575 removed from the local part, and made available in LOCAL_PART_PREFIX and
24576 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
24577 same value as LOCAL_PART for compatibility with other MTAs.
24578
24579 .cindex "HOST"
24580 HOST is set only when a &(pipe)& transport is called from a router that
24581 associates hosts with an address, typically when using &(pipe)& as a
24582 pseudo-remote transport. HOST is set to the first host name specified by
24583 the router.
24584
24585 .cindex "HOME"
24586 If the transport's generic &%home_directory%& option is set, its value is used
24587 for the HOME environment variable. Otherwise, a home directory may be set
24588 by the router's &%transport_home_directory%& option, which defaults to the
24589 user's home directory if &%check_local_user%& is set.
24590
24591
24592 .section "Private options for pipe" "SECID142"
24593 .cindex "options" "&(pipe)& transport"
24594
24595
24596
24597 .option allow_commands pipe "string list&!!" unset
24598 .cindex "&(pipe)& transport" "permitted commands"
24599 The string is expanded, and is then interpreted as a colon-separated list of
24600 permitted commands. If &%restrict_to_path%& is not set, the only commands
24601 permitted are those in the &%allow_commands%& list. They need not be absolute
24602 paths; the &%path%& option is still used for relative paths. If
24603 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
24604 in the &%allow_commands%& list, or a name without any slashes that is found on
24605 the path. In other words, if neither &%allow_commands%& nor
24606 &%restrict_to_path%& is set, there is no restriction on the command, but
24607 otherwise only commands that are permitted by one or the other are allowed. For
24608 example, if
24609 .code
24610 allow_commands = /usr/bin/vacation
24611 .endd
24612 and &%restrict_to_path%& is not set, the only permitted command is
24613 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
24614 &%use_shell%& is set.
24615
24616
24617 .option batch_id pipe string&!! unset
24618 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24619
24620
24621 .option batch_max pipe integer 1
24622 This limits the number of addresses that can be handled in a single delivery.
24623 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24624
24625
24626 .option check_string pipe string unset
24627 As &(pipe)& writes the message, the start of each line is tested for matching
24628 &%check_string%&, and if it does, the initial matching characters are replaced
24629 by the contents of &%escape_string%&, provided both are set. The value of
24630 &%check_string%& is a literal string, not a regular expression, and the case of
24631 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
24632 of &%check_string%& and &%escape_string%& are forced to values that implement
24633 the SMTP escaping protocol. Any settings made in the configuration file are
24634 ignored.
24635
24636
24637 .option command pipe string&!! unset
24638 This option need not be set when &(pipe)& is being used to deliver to pipes
24639 obtained directly from address redirections. In other cases, the option must be
24640 set, to provide a command to be run. It need not yield an absolute path (see
24641 the &%path%& option below). The command is split up into separate arguments by
24642 Exim, and each argument is separately expanded, as described in section
24643 &<<SECThowcommandrun>>& above.
24644
24645
24646 .option environment pipe string&!! unset
24647 .cindex "&(pipe)& transport" "environment for command"
24648 .cindex "environment" "&(pipe)& transport"
24649 This option is used to add additional variables to the environment in which the
24650 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
24651 a string which is expanded, and then interpreted as a colon-separated list of
24652 environment settings of the form <&'name'&>=<&'value'&>.
24653
24654
24655 .option escape_string pipe string unset
24656 See &%check_string%& above.
24657
24658
24659 .option freeze_exec_fail pipe boolean false
24660 .cindex "exec failure"
24661 .cindex "failure of exec"
24662 .cindex "&(pipe)& transport" "failure of exec"
24663 Failure to exec the command in a pipe transport is by default treated like
24664 any other failure while running the command. However, if &%freeze_exec_fail%&
24665 is set, failure to exec is treated specially, and causes the message to be
24666 frozen, whatever the setting of &%ignore_status%&.
24667
24668
24669 .option freeze_signal pipe boolean false
24670 .cindex "signal exit"
24671 .cindex "&(pipe)& transport", "signal exit"
24672 Normally if the process run by a command in a pipe transport exits on a signal,
24673 a bounce message is sent. If &%freeze_signal%& is set, the message will be
24674 frozen in Exim's queue instead.
24675
24676
24677 .option force_command pipe boolean false
24678 .cindex "force command"
24679 .cindex "&(pipe)& transport", "force command"
24680 Normally when a router redirects an address directly to a pipe command
24681 the &%command%& option on the transport is ignored.  If &%force_command%&
24682 is set, the &%command%& option will used. This is especially
24683 useful for forcing a wrapper or additional argument to be added to the
24684 command. For example:
24685 .code
24686 command = /usr/bin/remote_exec myhost -- $address_pipe
24687 force_command
24688 .endd
24689
24690 Note that &$address_pipe$& is handled specially in &%command%& when
24691 &%force_command%& is set, expanding out to the original argument vector as
24692 separate items, similarly to a Unix shell &`"$@"`& construct.
24693
24694
24695 .option ignore_status pipe boolean false
24696 If this option is true, the status returned by the subprocess that is set up to
24697 run the command is ignored, and Exim behaves as if zero had been returned.
24698 Otherwise, a non-zero status or termination by signal causes an error return
24699 from the transport unless the status value is one of those listed in
24700 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
24701
24702 &*Note*&: This option does not apply to timeouts, which do not return a status.
24703 See the &%timeout_defer%& option for how timeouts are handled.
24704
24705
24706 .option log_defer_output pipe boolean false
24707 .cindex "&(pipe)& transport" "logging output"
24708 If this option is set, and the status returned by the command is
24709 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
24710 and any output was produced on stdout or stderr, the first line of it is
24711 written to the main log.
24712
24713
24714 .option log_fail_output pipe boolean false
24715 If this option is set, and the command returns any output on stdout or
24716 stderr, and also ends with a return code that is neither zero nor one of
24717 the return codes listed in &%temp_errors%& (that is, the delivery
24718 failed), the first line of output is written to the main log. This
24719 option and &%log_output%& are mutually exclusive.  Only one of them may
24720 be set.
24721
24722
24723 .option log_output pipe boolean false
24724 If this option is set and the command returns any output on stdout or
24725 stderr, the first line of output is written to the main log, whatever
24726 the return code. This option and &%log_fail_output%& are mutually
24727 exclusive. Only one of them may be set.
24728
24729
24730 .option max_output pipe integer 20K
24731 This specifies the maximum amount of output that the command may produce on its
24732 standard output and standard error file combined. If the limit is exceeded, the
24733 process running the command is killed. This is intended as a safety measure to
24734 catch runaway processes. The limit is applied independently of the settings of
24735 the options that control what is done with such output (for example,
24736 &%return_output%&). Because of buffering effects, the amount of output may
24737 exceed the limit by a small amount before Exim notices.
24738
24739
24740 .option message_prefix pipe string&!! "see below"
24741 The string specified here is expanded and output at the start of every message.
24742 The default is unset if &%use_bsmtp%& is set. Otherwise it is
24743 .code
24744 message_prefix = \
24745   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
24746   ${tod_bsdinbox}\n
24747 .endd
24748 .cindex "Cyrus"
24749 .cindex "&%tmail%&"
24750 .cindex "&""From""& line"
24751 This is required by the commonly used &_/usr/bin/vacation_& program.
24752 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
24753 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
24754 setting
24755 .code
24756 message_prefix =
24757 .endd
24758 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
24759 &`\n`& to &`\r\n`& in &%message_prefix%&.
24760
24761
24762 .option message_suffix pipe string&!! "see below"
24763 The string specified here is expanded and output at the end of every message.
24764 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
24765 The suffix can be suppressed by setting
24766 .code
24767 message_suffix =
24768 .endd
24769 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
24770 &`\n`& to &`\r\n`& in &%message_suffix%&.
24771
24772
24773 .option path pipe string&!! "/bin:/usr/bin"
24774 This option is expanded and
24775 specifies the string that is set up in the PATH environment
24776 variable of the subprocess.
24777 If the &%command%& option does not yield an absolute path name, the command is
24778 sought in the PATH directories, in the usual way. &*Warning*&: This does not
24779 apply to a command specified as a transport filter.
24780
24781
24782 .option permit_coredump pipe boolean false
24783 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
24784 a core-dump of a pipe command, enable this command.  This enables core-dumps
24785 during delivery and affects both the Exim binary and the pipe command run.
24786 It is recommended that this option remain off unless and until you have a need
24787 for it and that this only be enabled when needed, as the risk of excessive
24788 resource consumption can be quite high.  Note also that Exim is typically
24789 installed as a setuid binary and most operating systems will inhibit coredumps
24790 of these by default, so further OS-specific action may be required.
24791
24792
24793 .option pipe_as_creator pipe boolean false
24794 .cindex "uid (user id)" "local delivery"
24795 If the generic &%user%& option is not set and this option is true, the delivery
24796 process is run under the uid that was in force when Exim was originally called
24797 to accept the message. If the group id is not otherwise set (via the generic
24798 &%group%& option), the gid that was in force when Exim was originally called to
24799 accept the message is used.
24800
24801
24802 .option restrict_to_path pipe boolean false
24803 When this option is set, any command name not listed in &%allow_commands%& must
24804 contain no slashes. The command is searched for only in the directories listed
24805 in the &%path%& option. This option is intended for use in the case when a pipe
24806 command has been generated from a user's &_.forward_& file. This is usually
24807 handled by a &(pipe)& transport called &%address_pipe%&.
24808
24809
24810 .option return_fail_output pipe boolean false
24811 If this option is true, and the command produced any output and ended with a
24812 return code other than zero or one of the codes listed in &%temp_errors%& (that
24813 is, the delivery failed), the output is returned in the bounce message.
24814 However, if the message has a null sender (that is, it is itself a bounce
24815 message), output from the command is discarded. This option and
24816 &%return_output%& are mutually exclusive. Only one of them may be set.
24817
24818
24819
24820 .option return_output pipe boolean false
24821 If this option is true, and the command produced any output, the delivery is
24822 deemed to have failed whatever the return code from the command, and the output
24823 is returned in the bounce message. Otherwise, the output is just discarded.
24824 However, if the message has a null sender (that is, it is a bounce message),
24825 output from the command is always discarded, whatever the setting of this
24826 option. This option and &%return_fail_output%& are mutually exclusive. Only one
24827 of them may be set.
24828
24829
24830
24831 .option temp_errors pipe "string list" "see below"
24832 .cindex "&(pipe)& transport" "temporary failure"
24833 This option contains either a colon-separated list of numbers, or a single
24834 asterisk. If &%ignore_status%& is false
24835 and &%return_output%& is not set,
24836 and the command exits with a non-zero return code, the failure is treated as
24837 temporary and the delivery is deferred if the return code matches one of the
24838 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
24839 codes are treated as permanent errors. The default setting contains the codes
24840 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
24841 compiled on a system that does not define these macros, it assumes values of 75
24842 and 73, respectively.
24843
24844
24845 .option timeout pipe time 1h
24846 If the command fails to complete within this time, it is killed. This normally
24847 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
24848 specifies no timeout. In order to ensure that any subprocesses created by the
24849 command are also killed, Exim makes the initial process a process group leader,
24850 and kills the whole process group on a timeout. However, this can be defeated
24851 if one of the processes starts a new process group.
24852
24853 .option timeout_defer pipe boolean false
24854 A timeout in a &(pipe)& transport, either in the command that the transport
24855 runs, or in a transport filter that is associated with it, is by default
24856 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
24857 is set true, both kinds of timeout become temporary errors, causing the
24858 delivery to be deferred.
24859
24860 .option umask pipe "octal integer" 022
24861 This specifies the umask setting for the subprocess that runs the command.
24862
24863
24864 .option use_bsmtp pipe boolean false
24865 .cindex "envelope sender"
24866 If this option is set true, the &(pipe)& transport writes messages in &"batch
24867 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
24868 commands. If you want to include a leading HELO command with such messages,
24869 you can do so by setting the &%message_prefix%& option. See section
24870 &<<SECTbatchSMTP>>& for details of batch SMTP.
24871
24872 .option use_classresources pipe boolean false
24873 .cindex "class resources (BSD)"
24874 This option is available only when Exim is running on FreeBSD, NetBSD, or
24875 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
24876 resource limits when a &(pipe)& transport is run to perform a delivery. The
24877 limits for the uid under which the pipe is to run are obtained from the login
24878 class database.
24879
24880
24881 .option use_crlf pipe boolean false
24882 .cindex "carriage return"
24883 .cindex "linefeed"
24884 This option causes lines to be terminated with the two-character CRLF sequence
24885 (carriage return, linefeed) instead of just a linefeed character. In the case
24886 of batched SMTP, the byte sequence written to the pipe is then an exact image
24887 of what would be sent down a real SMTP connection.
24888
24889 The contents of the &%message_prefix%& and &%message_suffix%& options are
24890 written verbatim, so must contain their own carriage return characters if these
24891 are needed. When &%use_bsmtp%& is not set, the default values for both
24892 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
24893 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
24894
24895
24896 .option use_shell pipe boolean false
24897 .vindex "&$pipe_addresses$&"
24898 If this option is set, it causes the command to be passed to &_/bin/sh_&
24899 instead of being run directly from the transport, as described in section
24900 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
24901 where the command is expected to be run under a shell and cannot easily be
24902 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
24903 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
24904 command is expanded as a single string, and handed to &_/bin/sh_& as data for
24905 its &%-c%& option.
24906
24907
24908
24909 .section "Using an external local delivery agent" "SECID143"
24910 .cindex "local delivery" "using an external agent"
24911 .cindex "&'procmail'&"
24912 .cindex "external local delivery"
24913 .cindex "delivery" "&'procmail'&"
24914 .cindex "delivery" "by external agent"
24915 The &(pipe)& transport can be used to pass all messages that require local
24916 delivery to a separate local delivery agent such as &%procmail%&. When doing
24917 this, care must be taken to ensure that the pipe is run under an appropriate
24918 uid and gid. In some configurations one wants this to be a uid that is trusted
24919 by the delivery agent to supply the correct sender of the message. It may be
24920 necessary to recompile or reconfigure the delivery agent so that it trusts an
24921 appropriate user. The following is an example transport and router
24922 configuration for &%procmail%&:
24923 .code
24924 # transport
24925 procmail_pipe:
24926   driver = pipe
24927   command = /usr/local/bin/procmail -d $local_part_data
24928   return_path_add
24929   delivery_date_add
24930   envelope_to_add
24931   check_string = "From "
24932   escape_string = ">From "
24933   umask = 077
24934   user = $local_part_data
24935   group = mail
24936
24937 # router
24938 procmail:
24939   driver = accept
24940   check_local_user
24941   transport = procmail_pipe
24942 .endd
24943 In this example, the pipe is run as the local user, but with the group set to
24944 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
24945 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
24946 user to supply a correct sender address. If you do not specify either a
24947 &%group%& or a &%user%& option, the pipe command is run as the local user. The
24948 home directory is the user's home directory by default.
24949
24950 &*Note*&: The command that the pipe transport runs does &'not'& begin with
24951 .code
24952 IFS=" "
24953 .endd
24954 as shown in some &%procmail%& documentation, because Exim does not by default
24955 use a shell to run pipe commands.
24956
24957 .cindex "Cyrus"
24958 The next example shows a transport and a router for a system where local
24959 deliveries are handled by the Cyrus IMAP server.
24960 .code
24961 # transport
24962 local_delivery_cyrus:
24963   driver = pipe
24964   command = /usr/cyrus/bin/deliver \
24965             -m ${substr_1:$local_part_suffix} -- $local_part
24966   user = cyrus
24967   group = mail
24968   return_output
24969   log_output
24970   message_prefix =
24971   message_suffix =
24972
24973 # router
24974 local_user_cyrus:
24975   driver = accept
24976   check_local_user
24977   local_part_suffix = .*
24978   transport = local_delivery_cyrus
24979 .endd
24980 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
24981 &%return_output%& to cause any text written by Cyrus to be returned to the
24982 sender.
24983 .ecindex IIDpiptra1
24984 .ecindex IIDpiptra2
24985
24986
24987 . ////////////////////////////////////////////////////////////////////////////
24988 . ////////////////////////////////////////////////////////////////////////////
24989
24990 .chapter "The smtp transport" "CHAPsmtptrans"
24991 .scindex IIDsmttra1 "transports" "&(smtp)&"
24992 .scindex IIDsmttra2 "&(smtp)& transport"
24993 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
24994 or LMTP protocol. The list of hosts to try can either be taken from the address
24995 that is being processed (having been set up by the router), or specified
24996 explicitly for the transport. Timeout and retry processing (see chapter
24997 &<<CHAPretry>>&) is applied to each IP address independently.
24998
24999
25000 .section "Multiple messages on a single connection" "SECID144"
25001 The sending of multiple messages over a single TCP/IP connection can arise in
25002 two ways:
25003
25004 .ilist
25005 If a message contains more than &%max_rcpt%& (see below) addresses that are
25006 routed to the same host, more than one copy of the message has to be sent to
25007 that host. In this situation, multiple copies may be sent in a single run of
25008 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
25009 does when it has too many addresses to send in one message also depends on the
25010 value of the global &%remote_max_parallel%& option. Details are given in
25011 section &<<SECToutSMTPTCP>>&.)
25012 .next
25013 .cindex "hints database" "remembering routing"
25014 When a message has been successfully delivered over a TCP/IP connection, Exim
25015 looks in its hints database to see if there are any other messages awaiting a
25016 connection to the same host. If there are, a new delivery process is started
25017 for one of them, and the current TCP/IP connection is passed on to it. The new
25018 process may in turn send multiple copies and possibly create yet another
25019 process.
25020 .endlist
25021
25022
25023 For each copy sent over the same TCP/IP connection, a sequence counter is
25024 incremented, and if it ever gets to the value of &%connection_max_messages%&,
25025 no further messages are sent over that connection.
25026
25027
25028
25029 .section "Use of the $host and $host_address variables" "SECID145"
25030 .vindex "&$host$&"
25031 .vindex "&$host_address$&"
25032 At the start of a run of the &(smtp)& transport, the values of &$host$& and
25033 &$host_address$& are the name and IP address of the first host on the host list
25034 passed by the router. However, when the transport is about to connect to a
25035 specific host, and while it is connected to that host, &$host$& and
25036 &$host_address$& are set to the values for that host. These are the values
25037 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
25038 &%serialize_hosts%&, and the various TLS options are expanded.
25039
25040
25041 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
25042 .vindex &$tls_bits$&
25043 .vindex &$tls_cipher$&
25044 .vindex &$tls_peerdn$&
25045 .vindex &$tls_sni$&
25046 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
25047 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
25048 are the values that were set when the message was received.
25049 These are the values that are used for options that are expanded before any
25050 SMTP connections are made. Just before each connection is made, these four
25051 variables are emptied. If TLS is subsequently started, they are set to the
25052 appropriate values for the outgoing connection, and these are the values that
25053 are in force when any authenticators are run and when the
25054 &%authenticated_sender%& option is expanded.
25055
25056 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
25057 and will be removed in a future release.
25058
25059
25060 .section "Private options for smtp" "SECID146"
25061 .cindex "options" "&(smtp)& transport"
25062 The private options of the &(smtp)& transport are as follows:
25063
25064
25065 .option address_retry_include_sender smtp boolean true
25066 .cindex "4&'xx'& responses" "retrying after"
25067 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
25068 is the combination of sender and recipient that is delayed in subsequent queue
25069 runs until the retry time is reached. You can delay the recipient without
25070 reference to the sender (which is what earlier versions of Exim did), by
25071 setting &%address_retry_include_sender%& false. However, this can lead to
25072 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
25073
25074 .option allow_localhost smtp boolean false
25075 .cindex "local host" "sending to"
25076 .cindex "fallback" "hosts specified on transport"
25077 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
25078 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
25079 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
25080 the delivery anyway. This should be used only in special cases when the
25081 configuration ensures that no looping will result (for example, a differently
25082 configured Exim is listening on the port to which the message is sent).
25083
25084
25085 .option authenticated_sender smtp string&!! unset
25086 .cindex "Cyrus"
25087 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
25088 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
25089 overriding any existing authenticated sender value. If the string expansion is
25090 forced to fail, the option is ignored. Other expansion failures cause delivery
25091 to be deferred. If the result of expansion is an empty string, that is also
25092 ignored.
25093
25094 The expansion happens after the outgoing connection has been made and TLS
25095 started, if required. This means that the &$host$&, &$host_address$&,
25096 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
25097 particular connection.
25098
25099 If the SMTP session is not authenticated, the expansion of
25100 &%authenticated_sender%& still happens (and can cause the delivery to be
25101 deferred if it fails), but no AUTH= item is added to MAIL commands
25102 unless &%authenticated_sender_force%& is true.
25103
25104 This option allows you to use the &(smtp)& transport in LMTP mode to
25105 deliver mail to Cyrus IMAP and provide the proper local part as the
25106 &"authenticated sender"&, via a setting such as:
25107 .code
25108 authenticated_sender = $local_part
25109 .endd
25110 This removes the need for IMAP subfolders to be assigned special ACLs to
25111 allow direct delivery to those subfolders.
25112
25113 Because of expected uses such as that just described for Cyrus (when no
25114 domain is involved), there is no checking on the syntax of the provided
25115 value.
25116
25117
25118 .option authenticated_sender_force smtp boolean false
25119 If this option is set true, the &%authenticated_sender%& option's value
25120 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
25121 authenticated as a client.
25122
25123
25124 .option command_timeout smtp time 5m
25125 .cindex timeout "smtp transport command"
25126 This sets a timeout for receiving a response to an SMTP command that has been
25127 sent out. It is also used when waiting for the initial banner line from the
25128 remote host. Its value must not be zero.
25129
25130
25131 .option connect_timeout smtp time 5m
25132 .cindex timeout "smtp transport connect"
25133 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
25134 to a remote host. A setting of zero allows the system timeout (typically
25135 several minutes) to act. To have any effect, the value of this option must be
25136 less than the system timeout. However, it has been observed that on some
25137 systems there is no system timeout, which is why the default value for this
25138 option is 5 minutes, a value recommended by RFC 1123.
25139
25140
25141 .option connection_max_messages smtp integer 500
25142 .cindex "SMTP" "passed connection"
25143 .cindex "SMTP" "multiple deliveries"
25144 .cindex "multiple SMTP deliveries"
25145 This controls the maximum number of separate message deliveries that are sent
25146 over a single TCP/IP connection. If the value is zero, there is no limit.
25147 For testing purposes, this value can be overridden by the &%-oB%& command line
25148 option.
25149
25150
25151 .option dane_require_tls_ciphers smtp string&!! unset
25152 .cindex "TLS" "requiring specific ciphers for DANE"
25153 .cindex "cipher" "requiring specific"
25154 .cindex DANE "TLS ciphers"
25155 This option may be used to override &%tls_require_ciphers%& for connections
25156 where DANE has been determined to be in effect.
25157 If not set, then &%tls_require_ciphers%& will be used.
25158 Normal SMTP delivery is not able to make strong demands of TLS cipher
25159 configuration, because delivery will fall back to plaintext.  Once DANE has
25160 been determined to be in effect, there is no plaintext fallback and making the
25161 TLS cipherlist configuration stronger will increase security, rather than
25162 counter-intuitively decreasing it.
25163 If the option expands to be empty or is forced to fail, then it will
25164 be treated as unset and &%tls_require_ciphers%& will be used instead.
25165
25166
25167 .option data_timeout smtp time 5m
25168 .cindex timeout "for transmitted SMTP data blocks"
25169 This sets a timeout for the transmission of each block in the data portion of
25170 the message. As a result, the overall timeout for a message depends on the size
25171 of the message. Its value must not be zero. See also &%final_timeout%&.
25172
25173
25174 .option dkim_canon smtp string&!! unset
25175 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25176 .option dkim_domain smtp string list&!! unset
25177 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25178 .option dkim_hash smtp string&!! sha256
25179 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25180 .option dkim_identity smtp string&!! unset
25181 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25182 .option dkim_private_key smtp string&!! unset
25183 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25184 .option dkim_selector smtp string&!! unset
25185 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25186 .option dkim_strict smtp string&!! unset
25187 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25188 .option dkim_sign_headers smtp string&!! "per RFC"
25189 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25190 .option dkim_timestamps smtp string&!! unset
25191 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25192
25193
25194 .option delay_after_cutoff smtp boolean true
25195 .cindex "final cutoff" "retries, controlling"
25196 .cindex retry "final cutoff"
25197 This option controls what happens when all remote IP addresses for a given
25198 domain have been inaccessible for so long that they have passed their retry
25199 cutoff times.
25200
25201 In the default state, if the next retry time has not been reached for any of
25202 them, the address is bounced without trying any deliveries. In other words,
25203 Exim delays retrying an IP address after the final cutoff time until a new
25204 retry time is reached, and can therefore bounce an address without ever trying
25205 a delivery, when machines have been down for a long time. Some people are
25206 unhappy at this prospect, so...
25207
25208 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
25209 addresses are past their final cutoff time, Exim tries to deliver to those
25210 IP addresses that have not been tried since the message arrived. If there are
25211 none, of if they all fail, the address is bounced. In other words, it does not
25212 delay when a new message arrives, but immediately tries those expired IP
25213 addresses that haven't been tried since the message arrived. If there is a
25214 continuous stream of messages for the dead hosts, unsetting
25215 &%delay_after_cutoff%& means that there will be many more attempts to deliver
25216 to them.
25217
25218
25219 .option dns_qualify_single smtp boolean true
25220 If the &%hosts%& or &%fallback_hosts%& option is being used,
25221 and the &%gethostbyname%& option is false,
25222 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
25223 in chapter &<<CHAPdnslookup>>& for more details.
25224
25225
25226 .option dns_search_parents smtp boolean false
25227 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
25228 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
25229 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
25230 details.
25231
25232
25233 .option dnssec_request_domains smtp "domain list&!!" *
25234 .cindex "MX record" "security"
25235 .cindex "DNSSEC" "MX lookup"
25236 .cindex "security" "MX lookup"
25237 .cindex "DNS" "DNSSEC"
25238 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
25239 the dnssec request bit set. Setting this transport option is only useful if the
25240 transport overrides or sets the host names. See the &%dnssec_request_domains%&
25241 router option.
25242
25243
25244
25245 .option dnssec_require_domains smtp "domain list&!!" unset
25246 .cindex "MX record" "security"
25247 .cindex "DNSSEC" "MX lookup"
25248 .cindex "security" "MX lookup"
25249 .cindex "DNS" "DNSSEC"
25250 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
25251 the dnssec request bit set.  Setting this transport option is only
25252 useful if the transport overrides or sets the host names. See the
25253 &%dnssec_require_domains%& router option.
25254
25255
25256
25257 .option dscp smtp string&!! unset
25258 .cindex "DCSP" "outbound"
25259 This option causes the DSCP value associated with a socket to be set to one
25260 of a number of fixed strings or to numeric value.
25261 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
25262 Common values include &`throughput`&, &`mincost`&, and on newer systems
25263 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
25264
25265 The outbound packets from Exim will be marked with this value in the header
25266 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
25267 that these values will have any effect, not be stripped by networking
25268 equipment, or do much of anything without cooperation with your Network
25269 Engineer and those of all network operators between the source and destination.
25270
25271
25272 .option fallback_hosts smtp "string list" unset
25273 .cindex "fallback" "hosts specified on transport"
25274 String expansion is not applied to this option. The argument must be a
25275 colon-separated list of host names or IP addresses, optionally also including
25276 port numbers, though the separator can be changed, as described in section
25277 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
25278 item in a &%route_list%& setting for the &(manualroute)& router, as described
25279 in section &<<SECTformatonehostitem>>&.
25280
25281 Fallback hosts can also be specified on routers, which associate them with the
25282 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
25283 &%fallback_hosts%& specified on the transport is used only if the address does
25284 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
25285 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
25286 However, &%hosts_randomize%& does apply to fallback host lists.
25287
25288 If Exim is unable to deliver to any of the hosts for a particular address, and
25289 the errors are not permanent rejections, the address is put on a separate
25290 transport queue with its host list replaced by the fallback hosts, unless the
25291 address was routed via MX records and the current host was in the original MX
25292 list. In that situation, the fallback host list is not used.
25293
25294 Once normal deliveries are complete, the fallback queue is delivered by
25295 re-running the same transports with the new host lists. If several failing
25296 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
25297 copy of the message is sent.
25298
25299 The resolution of the host names on the fallback list is controlled by the
25300 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
25301 both to cases when the host list comes with the address and when it is taken
25302 from &%hosts%&. This option provides a &"use a smart host only if delivery
25303 fails"& facility.
25304
25305
25306 .option final_timeout smtp time 10m
25307 .cindex timeout "for transmitted SMTP data accept"
25308 This is the timeout that applies while waiting for the response to the final
25309 line containing just &"."& that terminates a message. Its value must not be
25310 zero.
25311
25312 .option gethostbyname smtp boolean false
25313 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
25314 being used, names are looked up using &[gethostbyname()]&
25315 (or &[getipnodebyname()]& when available)
25316 instead of using the DNS. Of course, that function may in fact use the DNS, but
25317 it may also consult other sources of information such as &_/etc/hosts_&.
25318
25319 .option gnutls_compat_mode smtp boolean unset
25320 This option controls whether GnuTLS is used in compatibility mode in an Exim
25321 server. This reduces security slightly, but improves interworking with older
25322 implementations of TLS.
25323
25324 .option helo_data smtp string&!! "see below"
25325 .cindex "HELO" "argument, setting"
25326 .cindex "EHLO" "argument, setting"
25327 .cindex "LHLO argument setting"
25328 The value of this option is expanded after a connection to a another host has
25329 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
25330 command that starts the outgoing SMTP or LMTP session. The default value of the
25331 option is:
25332 .code
25333 $primary_hostname
25334 .endd
25335 During the expansion, the variables &$host$& and &$host_address$& are set to
25336 the identity of the remote host, and the variables &$sending_ip_address$& and
25337 &$sending_port$& are set to the local IP address and port number that are being
25338 used. These variables can be used to generate different values for different
25339 servers or different local IP addresses. For example, if you want the string
25340 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
25341 interface address, you could use this:
25342 .code
25343 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
25344   {$primary_hostname}}
25345 .endd
25346 The use of &%helo_data%& applies both to sending messages and when doing
25347 callouts.
25348
25349 .option hosts smtp "string list&!!" unset
25350 Hosts are associated with an address by a router such as &(dnslookup)&, which
25351 finds the hosts by looking up the address domain in the DNS, or by
25352 &(manualroute)&, which has lists of hosts in its configuration. However,
25353 email addresses can be passed to the &(smtp)& transport by any router, and not
25354 all of them can provide an associated list of hosts.
25355
25356 The &%hosts%& option specifies a list of hosts to be used if the address being
25357 processed does not have any hosts associated with it. The hosts specified by
25358 &%hosts%& are also used, whether or not the address has its own hosts, if
25359 &%hosts_override%& is set.
25360
25361 The string is first expanded, before being interpreted as a colon-separated
25362 list of host names or IP addresses, possibly including port numbers. The
25363 separator may be changed to something other than colon, as described in section
25364 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
25365 item in a &%route_list%& setting for the &(manualroute)& router, as described
25366 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
25367 of the &(manualroute)& router is not available here.
25368
25369 If the expansion fails, delivery is deferred. Unless the failure was caused by
25370 the inability to complete a lookup, the error is logged to the panic log as
25371 well as the main log. Host names are looked up either by searching directly for
25372 address records in the DNS or by calling &[gethostbyname()]& (or
25373 &[getipnodebyname()]& when available), depending on the setting of the
25374 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
25375 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
25376 address are used.
25377
25378 During delivery, the hosts are tried in order, subject to their retry status,
25379 unless &%hosts_randomize%& is set.
25380
25381
25382 .option hosts_avoid_esmtp smtp "host list&!!" unset
25383 .cindex "ESMTP, avoiding use of"
25384 .cindex "HELO" "forcing use of"
25385 .cindex "EHLO" "avoiding use of"
25386 .cindex "PIPELINING" "avoiding the use of"
25387 This option is for use with broken hosts that announce ESMTP facilities (for
25388 example, PIPELINING) and then fail to implement them properly. When a host
25389 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
25390 start of the SMTP session. This means that it cannot use any of the ESMTP
25391 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
25392
25393
25394 .option hosts_avoid_pipelining smtp "host list&!!" unset
25395 .cindex "PIPELINING" "avoiding the use of"
25396 .cindex "ESMTP extensions" PIPELINING
25397 Exim will not use the ESMTP PIPELINING extension when delivering to any host
25398 that matches this list, even if the server host advertises PIPELINING support.
25399
25400 .option hosts_pipe_connect smtp "host list&!!" unset
25401 .cindex "pipelining" "early connection"
25402 .cindex "pipelining" PIPE_CONNECT
25403 If Exim is built with the SUPPORT_PIPE_CONNECT build option
25404 this option controls which to hosts the facility watched for
25405 and recorded, and used for subsequent connections.
25406
25407 The retry hints database is used for the record,
25408 and records are subject to the &%retry_data_expire%& option.
25409 When used, the pipelining saves on roundtrip times.
25410 It also turns SMTP into a client-first protocol
25411 so combines well with TCP Fast Open.
25412
25413 See also the &%pipelining_connect_advertise_hosts%& main option.
25414
25415 Note:
25416 When the facility is used, the transport &%helo_data%& option
25417 will be expanded before the &$sending_ip_address$& variable
25418 is filled in.
25419 A check is made for the use of that variable, without the
25420 presence of a &"def:"& test on it, but suitably complex coding
25421 can avoid the check and produce unexpected results.
25422 You have been warned.
25423
25424
25425 .option hosts_avoid_tls smtp "host list&!!" unset
25426 .cindex "TLS" "avoiding for certain hosts"
25427 Exim will not try to start a TLS session when delivering to any host that
25428 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
25429
25430 .option hosts_verify_avoid_tls smtp "host list&!!" unset
25431 .cindex "TLS" "avoiding for certain hosts"
25432 Exim will not try to start a TLS session for a verify callout,
25433 or when delivering in cutthrough mode,
25434 to any host that matches this list.
25435
25436
25437 .option hosts_max_try smtp integer 5
25438 .cindex "host" "maximum number to try"
25439 .cindex "limit" "number of hosts tried"
25440 .cindex "limit" "number of MX tried"
25441 .cindex "MX record" "maximum tried"
25442 This option limits the number of IP addresses that are tried for any one
25443 delivery in cases where there are temporary delivery errors. Section
25444 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
25445
25446
25447 .option hosts_max_try_hardlimit smtp integer 50
25448 This is an additional check on the maximum number of IP addresses that Exim
25449 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
25450 why it exists.
25451
25452
25453
25454 .option hosts_nopass_tls smtp "host list&!!" unset
25455 .cindex "TLS" "passing connection"
25456 .cindex "multiple SMTP deliveries"
25457 .cindex "TLS" "multiple message deliveries"
25458 For any host that matches this list, a connection on which a TLS session has
25459 been started will not be passed to a new delivery process for sending another
25460 message on the same connection. See section &<<SECTmulmessam>>& for an
25461 explanation of when this might be needed.
25462
25463 .option hosts_noproxy_tls smtp "host list&!!" unset
25464 .cindex "TLS" "passing connection"
25465 .cindex "multiple SMTP deliveries"
25466 .cindex "TLS" "multiple message deliveries"
25467 For any host that matches this list, a TLS session which has
25468 been started will not be passed to a new delivery process for sending another
25469 message on the same session.
25470
25471 The traditional implementation closes down TLS and re-starts it in the new
25472 process, on the same open TCP connection, for each successive message
25473 sent.  If permitted by this option a pipe to to the new process is set up
25474 instead, and the original process maintains the TLS connection and proxies
25475 the SMTP connection from and to the new process and any subsequents.
25476 The new process has no access to TLS information, so cannot include it in
25477 logging.
25478
25479
25480
25481 .option hosts_override smtp boolean false
25482 If this option is set and the &%hosts%& option is also set, any hosts that are
25483 attached to the address are ignored, and instead the hosts specified by the
25484 &%hosts%& option are always used. This option does not apply to
25485 &%fallback_hosts%&.
25486
25487
25488 .option hosts_randomize smtp boolean false
25489 .cindex "randomized host list"
25490 .cindex "host" "list of; randomized"
25491 .cindex "fallback" "randomized hosts"
25492 If this option is set, and either the list of hosts is taken from the
25493 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
25494 were not obtained from MX records (this includes fallback hosts from the
25495 router), and were not randomized by the router, the order of trying the hosts
25496 is randomized each time the transport runs. Randomizing the order of a host
25497 list can be used to do crude load sharing.
25498
25499 When &%hosts_randomize%& is true, a host list may be split into groups whose
25500 order is separately randomized. This makes it possible to set up MX-like
25501 behaviour. The boundaries between groups are indicated by an item that is just
25502 &`+`& in the host list. For example:
25503 .code
25504 hosts = host1:host2:host3:+:host4:host5
25505 .endd
25506 The order of the first three hosts and the order of the last two hosts is
25507 randomized for each use, but the first three always end up before the last two.
25508 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
25509
25510 .option hosts_require_auth smtp "host list&!!" unset
25511 .cindex "authentication" "required by client"
25512 This option provides a list of servers for which authentication must succeed
25513 before Exim will try to transfer a message. If authentication fails for
25514 servers which are not in this list, Exim tries to send unauthenticated. If
25515 authentication fails for one of these servers, delivery is deferred. This
25516 temporary error is detectable in the retry rules, so it can be turned into a
25517 hard failure if required. See also &%hosts_try_auth%&, and chapter
25518 &<<CHAPSMTPAUTH>>& for details of authentication.
25519
25520
25521 .option hosts_request_ocsp smtp "host list&!!" *
25522 .cindex "TLS" "requiring for certain servers"
25523 Exim will request a Certificate Status on a
25524 TLS session for any host that matches this list.
25525 &%tls_verify_certificates%& should also be set for the transport.
25526
25527 .option hosts_require_dane smtp "host list&!!" unset
25528 .cindex DANE "transport options"
25529 .cindex DANE "requiring for certain servers"
25530 If built with DANE support, Exim  will require that a DNSSEC-validated
25531 TLSA record is present for any host matching the list,
25532 and that a DANE-verified TLS connection is made. See
25533 the &%dnssec_request_domains%& router and transport options.
25534 There will be no fallback to in-clear communication.
25535 See section &<<SECDANE>>&.
25536
25537 .option hosts_require_ocsp smtp "host list&!!" unset
25538 .cindex "TLS" "requiring for certain servers"
25539 Exim will request, and check for a valid Certificate Status being given, on a
25540 TLS session for any host that matches this list.
25541 &%tls_verify_certificates%& should also be set for the transport.
25542
25543 .option hosts_require_tls smtp "host list&!!" unset
25544 .cindex "TLS" "requiring for certain servers"
25545 Exim will insist on using a TLS session when delivering to any host that
25546 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
25547 &*Note*&: This option affects outgoing mail only. To insist on TLS for
25548 incoming messages, use an appropriate ACL.
25549
25550 .option hosts_try_auth smtp "host list&!!" unset
25551 .cindex "authentication" "optional in client"
25552 This option provides a list of servers to which, provided they announce
25553 authentication support, Exim will attempt to authenticate as a client when it
25554 connects. If authentication fails
25555 .new
25556 and &%hosts_require_auth%& permits,
25557 .wen
25558 Exim will try to transfer the message unauthenticated.
25559 See also chapter &<<CHAPSMTPAUTH>>& for details of authentication.
25560
25561 .option hosts_try_chunking smtp "host list&!!" *
25562 .cindex CHUNKING "enabling, in client"
25563 .cindex BDAT "SMTP command"
25564 .cindex "RFC 3030" "CHUNKING"
25565 This option provides a list of servers to which, provided they announce
25566 CHUNKING support, Exim will attempt to use BDAT commands rather than DATA.
25567 Unless DKIM signing is being done,
25568 BDAT will not be used in conjunction with a transport filter.
25569
25570 .option hosts_try_dane smtp "host list&!!" *
25571 .cindex DANE "transport options"
25572 .cindex DANE "attempting for certain servers"
25573 If built with DANE support, Exim  will require that a DNSSEC-validated
25574 TLSA record is present for any host matching the list,
25575 and that a DANE-verified TLS connection is made. See
25576 the &%dnssec_request_domains%& router and transport options.
25577 There will be no fallback to in-clear communication.
25578 See section &<<SECDANE>>&.
25579
25580 .option hosts_try_fastopen smtp "host list&!!" *
25581 .cindex "fast open, TCP" "enabling, in client"
25582 .cindex "TCP Fast Open" "enabling, in client"
25583 .cindex "RFC 7413" "TCP Fast Open"
25584 This option provides a list of servers to which, provided
25585 the facility is supported by this system, Exim will attempt to
25586 perform a TCP Fast Open.
25587 No data is sent on the SYN segment but, if the remote server also
25588 supports the facility, it can send its SMTP banner immediately after
25589 the SYN,ACK segment.  This can save up to one round-trip time.
25590
25591 The facility is only active for previously-contacted servers,
25592 as the initiator must present a cookie in the SYN segment.
25593
25594 On (at least some) current Linux distributions the facility must be enabled
25595 in the kernel by the sysadmin before the support is usable.
25596 There is no option for control of the server side; if the system supports
25597 it it is always enabled.  Note that lengthy operations in the connect ACL,
25598 such as DNSBL lookups, will still delay the emission of the SMTP banner.
25599
25600 .option hosts_try_prdr smtp "host list&!!" *
25601 .cindex "PRDR" "enabling, optional in client"
25602 .cindex "ESMTP extensions" PRDR
25603 This option provides a list of servers to which, provided they announce
25604 PRDR support, Exim will attempt to negotiate PRDR
25605 for multi-recipient messages.
25606 The option can usually be left as default.
25607
25608 .option interface smtp "string list&!!" unset
25609 .cindex "bind IP address"
25610 .cindex "IP address" "binding"
25611 .vindex "&$host$&"
25612 .vindex "&$host_address$&"
25613 This option specifies which interface to bind to when making an outgoing SMTP
25614 call. The value is an IP address, not an interface name such as
25615 &`eth0`&. Do not confuse this with the interface address that was used when a
25616 message was received, which is in &$received_ip_address$&, formerly known as
25617 &$interface_address$&. The name was changed to minimize confusion with the
25618 outgoing interface address. There is no variable that contains an outgoing
25619 interface address because, unless it is set by this option, its value is
25620 unknown.
25621
25622 During the expansion of the &%interface%& option the variables &$host$& and
25623 &$host_address$& refer to the host to which a connection is about to be made
25624 during the expansion of the string. Forced expansion failure, or an empty
25625 string result causes the option to be ignored. Otherwise, after expansion, the
25626 string must be a list of IP addresses, colon-separated by default, but the
25627 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
25628 For example:
25629 .code
25630 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
25631 .endd
25632 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
25633 connection. If none of them are the correct type, the option is ignored. If
25634 &%interface%& is not set, or is ignored, the system's IP functions choose which
25635 interface to use if the host has more than one.
25636
25637
25638 .option keepalive smtp boolean true
25639 .cindex "keepalive" "on outgoing connection"
25640 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
25641 connections. When set, it causes the kernel to probe idle connections
25642 periodically, by sending packets with &"old"& sequence numbers. The other end
25643 of the connection should send a acknowledgment if the connection is still okay
25644 or a reset if the connection has been aborted. The reason for doing this is
25645 that it has the beneficial effect of freeing up certain types of connection
25646 that can get stuck when the remote host is disconnected without tidying up the
25647 TCP/IP call properly. The keepalive mechanism takes several hours to detect
25648 unreachable hosts.
25649
25650
25651 .option lmtp_ignore_quota smtp boolean false
25652 .cindex "LMTP" "ignoring quota errors"
25653 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
25654 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
25655 has advertised support for IGNOREQUOTA in its response to the LHLO command.
25656
25657 .option max_rcpt smtp integer 100
25658 .cindex "RCPT" "maximum number of outgoing"
25659 This option limits the number of RCPT commands that are sent in a single
25660 SMTP message transaction. Each set of addresses is treated independently, and
25661 so can cause parallel connections to the same host if &%remote_max_parallel%&
25662 permits this.
25663
25664
25665 .new
25666 .option message_linelength_limit smtp integer 998
25667 .cindex "line length" limit
25668 This option sets the maximum line length, in bytes, that the transport
25669 will send.  Any messages with lines exceeding the given value
25670 will fail and a failure-DSN ("bounce") message will if possible be returned
25671 to the sender.
25672 The default value is that defined by the SMTP standards.
25673
25674 It is generally wise to also check in the data ACL so that messages
25675 received via SMTP can be refused without producing a bounce.
25676 .wen
25677
25678
25679 .option multi_domain smtp boolean&!! true
25680 .vindex "&$domain$&"
25681 When this option is set, the &(smtp)& transport can handle a number of
25682 addresses containing a mixture of different domains provided they all resolve
25683 to the same list of hosts. Turning the option off restricts the transport to
25684 handling only one domain at a time. This is useful if you want to use
25685 &$domain$& in an expansion for the transport, because it is set only when there
25686 is a single domain involved in a remote delivery.
25687
25688 It is expanded per-address and can depend on any of
25689 &$address_data$&, &$domain_data$&, &$local_part_data$&,
25690 &$host$&, &$host_address$& and &$host_port$&.
25691
25692 .new
25693 If the connection is DANE-enabled then this option is ignored;
25694 only messages having the domain used for the DANE TLSA lookup are
25695 sent on the connection.
25696 .wen
25697
25698 .option port smtp string&!! "see below"
25699 .cindex "port" "sending TCP/IP"
25700 .cindex "TCP/IP" "setting outgoing port"
25701 This option specifies the TCP/IP port on the server to which Exim connects.
25702 &*Note:*& Do not confuse this with the port that was used when a message was
25703 received, which is in &$received_port$&, formerly known as &$interface_port$&.
25704 The name was changed to minimize confusion with the outgoing port. There is no
25705 variable that contains an outgoing port.
25706
25707 If the value of this option begins with a digit it is taken as a port number;
25708 otherwise it is looked up using &[getservbyname()]&. The default value is
25709 normally &"smtp"&,
25710 but if &%protocol%& is set to &"lmtp"& the default is &"lmtp"&
25711 and if &%protocol%& is set to &"smtps"& the default is &"smtps"&.
25712 If the expansion fails, or if a port number cannot be found, delivery
25713 is deferred.
25714
25715 Note that at least one Linux distribution has been seen failing
25716 to put &"smtps"& in its &"/etc/services"& file, resulting is such deferrals.
25717
25718
25719
25720 .option protocol smtp string smtp
25721 .cindex "LMTP" "over TCP/IP"
25722 .cindex "ssmtp protocol" "outbound"
25723 .cindex "TLS" "SSL-on-connect outbound"
25724 .vindex "&$port$&"
25725 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
25726 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
25727 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
25728 deliveries into closed message stores. Exim also has support for running LMTP
25729 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
25730
25731 If this option is set to &"smtps"&, the default value for the &%port%& option
25732 changes to &"smtps"&, and the transport initiates TLS immediately after
25733 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
25734 The Internet standards bodies used to strongly discourage use of this mode,
25735 but as of RFC 8314 it is perferred over STARTTLS for message submission
25736 (as distinct from MTA-MTA communication).
25737
25738
25739 .option retry_include_ip_address smtp boolean&!! true
25740 Exim normally includes both the host name and the IP address in the key it
25741 constructs for indexing retry data after a temporary delivery failure. This
25742 means that when one of several IP addresses for a host is failing, it gets
25743 tried periodically (controlled by the retry rules), but use of the other IP
25744 addresses is not affected.
25745
25746 However, in some dialup environments hosts are assigned a different IP address
25747 each time they connect. In this situation the use of the IP address as part of
25748 the retry key leads to undesirable behaviour. Setting this option false causes
25749 Exim to use only the host name.
25750 Since it is expanded it can be made to depend on the host or domain.
25751
25752
25753 .option serialize_hosts smtp "host list&!!" unset
25754 .cindex "serializing connections"
25755 .cindex "host" "serializing connections"
25756 Because Exim operates in a distributed manner, if several messages for the same
25757 host arrive at around the same time, more than one simultaneous connection to
25758 the remote host can occur. This is not usually a problem except when there is a
25759 slow link between the hosts. In that situation it may be helpful to restrict
25760 Exim to one connection at a time. This can be done by setting
25761 &%serialize_hosts%& to match the relevant hosts.
25762
25763 .cindex "hints database" "serializing deliveries to a host"
25764 Exim implements serialization by means of a hints database in which a record is
25765 written whenever a process connects to one of the restricted hosts. The record
25766 is deleted when the connection is completed. Obviously there is scope for
25767 records to get left lying around if there is a system or program crash. To
25768 guard against this, Exim ignores any records that are more than six hours old.
25769
25770 If you set up this kind of serialization, you should also arrange to delete the
25771 relevant hints database whenever your system reboots. The names of the files
25772 start with &_misc_& and they are kept in the &_spool/db_& directory. There
25773 may be one or two files, depending on the type of DBM in use. The same files
25774 are used for ETRN serialization.
25775
25776 See also the &%max_parallel%& generic transport option.
25777
25778
25779 .option size_addition smtp integer 1024
25780 .cindex "SIZE" "ESMTP extension"
25781 .cindex "message" "size issue for transport filter"
25782 .cindex "size" "of message"
25783 .cindex "transport" "filter"
25784 .cindex "filter" "transport filter"
25785 If a remote SMTP server indicates that it supports the SIZE option of the
25786 MAIL command, Exim uses this to pass over the message size at the start of
25787 an SMTP transaction. It adds the value of &%size_addition%& to the value it
25788 sends, to allow for headers and other text that may be added during delivery by
25789 configuration options or in a transport filter. It may be necessary to increase
25790 this if a lot of text is added to messages.
25791
25792 Alternatively, if the value of &%size_addition%& is set negative, it disables
25793 the use of the SIZE option altogether.
25794
25795
25796 .option socks_proxy smtp string&!! unset
25797 .cindex proxy SOCKS
25798 This option enables use of SOCKS proxies for connections made by the
25799 transport.  For details see section &<<SECTproxySOCKS>>&.
25800
25801
25802 .option tls_certificate smtp string&!! unset
25803 .cindex "TLS" "client certificate, location of"
25804 .cindex "certificate" "client, location of"
25805 .vindex "&$host$&"
25806 .vindex "&$host_address$&"
25807 The value of this option must be the absolute path to a file which contains the
25808 client's certificate, for possible use when sending a message over an encrypted
25809 connection. The values of &$host$& and &$host_address$& are set to the name and
25810 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
25811 details of TLS.
25812
25813 &*Note*&: This option must be set if you want Exim to be able to use a TLS
25814 certificate when sending messages as a client. The global option of the same
25815 name specifies the certificate for Exim as a server; it is not automatically
25816 assumed that the same certificate should be used when Exim is operating as a
25817 client.
25818
25819
25820 .option tls_crl smtp string&!! unset
25821 .cindex "TLS" "client certificate revocation list"
25822 .cindex "certificate" "revocation list for client"
25823 This option specifies a certificate revocation list. The expanded value must
25824 be the name of a file that contains a CRL in PEM format.
25825
25826
25827 .option tls_dh_min_bits smtp integer 1024
25828 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
25829 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
25830 key agreement is negotiated, the server will provide a large prime number
25831 for use.  This option establishes the minimum acceptable size of that number.
25832 If the parameter offered by the server is too small, then the TLS handshake
25833 will fail.
25834
25835 Only supported when using GnuTLS.
25836
25837
25838 .option tls_privatekey smtp string&!! unset
25839 .cindex "TLS" "client private key, location of"
25840 .vindex "&$host$&"
25841 .vindex "&$host_address$&"
25842 The value of this option must be the absolute path to a file which contains the
25843 client's private key. This is used when sending a message over an encrypted
25844 connection using a client certificate. The values of &$host$& and
25845 &$host_address$& are set to the name and address of the server during the
25846 expansion. If this option is unset, or the expansion is forced to fail, or the
25847 result is an empty string, the private key is assumed to be in the same file as
25848 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
25849
25850
25851 .option tls_require_ciphers smtp string&!! unset
25852 .cindex "TLS" "requiring specific ciphers"
25853 .cindex "cipher" "requiring specific"
25854 .vindex "&$host$&"
25855 .vindex "&$host_address$&"
25856 The value of this option must be a list of permitted cipher suites, for use
25857 when setting up an outgoing encrypted connection. (There is a global option of
25858 the same name for controlling incoming connections.) The values of &$host$& and
25859 &$host_address$& are set to the name and address of the server during the
25860 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
25861 is used in different ways by OpenSSL and GnuTLS (see sections
25862 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
25863 ciphers is a preference order.
25864
25865
25866 .new
25867 .option tls_resumption_hosts smtp "host list&!!" unset
25868 .cindex TLS resumption
25869 This option controls which connections to use the TLS resumption feature.
25870 See &<<SECTresumption>>& for details.
25871 .wen
25872
25873
25874
25875 .option tls_sni smtp string&!! unset
25876 .cindex "TLS" "Server Name Indication"
25877 .cindex "TLS" SNI
25878 .cindex SNI "setting in client"
25879 .vindex "&$tls_sni$&"
25880 If this option is set
25881 .new
25882 and the connection is not DANE-validated
25883 .wen
25884 then it sets the $tls_out_sni variable and causes any
25885 TLS session to pass this value as the Server Name Indication extension to
25886 the remote side, which can be used by the remote side to select an appropriate
25887 certificate and private key for the session.
25888
25889 See &<<SECTtlssni>>& for more information.
25890
25891 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
25892 TLS extensions.
25893
25894
25895
25896
25897 .option tls_tempfail_tryclear smtp boolean true
25898 .cindex "4&'xx'& responses" "to STARTTLS"
25899 When the server host is not in &%hosts_require_tls%&, and there is a problem in
25900 setting up a TLS session, this option determines whether or not Exim should try
25901 to deliver the message unencrypted. If it is set false, delivery to the
25902 current host is deferred; if there are other hosts, they are tried. If this
25903 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
25904 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
25905 TLS negotiation fails, Exim closes the current connection (because it is in an
25906 unknown state), opens a new one to the same host, and then tries the delivery
25907 in clear.
25908
25909
25910 .option tls_try_verify_hosts smtp "host list&!!" *
25911 .cindex "TLS" "server certificate verification"
25912 .cindex "certificate" "verification of server"
25913 This option gives a list of hosts for which, on encrypted connections,
25914 certificate verification will be tried but need not succeed.
25915 The &%tls_verify_certificates%& option must also be set.
25916 Note that unless the host is in this list
25917 TLS connections will be denied to hosts using self-signed certificates
25918 when &%tls_verify_certificates%& is matched.
25919 The &$tls_out_certificate_verified$& variable is set when
25920 certificate verification succeeds.
25921
25922
25923 .option tls_verify_cert_hostnames smtp "host list&!!" *
25924 .cindex "TLS" "server certificate hostname verification"
25925 .cindex "certificate" "verification of server"
25926 This option give a list of hosts for which,
25927 while verifying the server certificate,
25928 checks will be included on the host name
25929 (note that this will generally be the result of a DNS MX lookup)
25930 versus Subject and Subject-Alternate-Name fields.  Wildcard names are permitted
25931 limited to being the initial component of a 3-or-more component FQDN.
25932
25933 There is no equivalent checking on client certificates.
25934
25935
25936 .option tls_verify_certificates smtp string&!! system
25937 .cindex "TLS" "server certificate verification"
25938 .cindex "certificate" "verification of server"
25939 .vindex "&$host$&"
25940 .vindex "&$host_address$&"
25941 The value of this option must be either the
25942 word "system"
25943 or the absolute path to
25944 a file or directory containing permitted certificates for servers,
25945 for use when setting up an encrypted connection.
25946
25947 The "system" value for the option will use a location compiled into the SSL library.
25948 This is not available for GnuTLS versions preceding 3.0.20; a value of "system"
25949 is taken as empty and an explicit location
25950 must be specified.
25951
25952 The use of a directory for the option value is not available for GnuTLS versions
25953 preceding 3.3.6 and a single file must be used.
25954
25955 With OpenSSL the certificates specified
25956 explicitly
25957 either by file or directory
25958 are added to those given by the system default location.
25959
25960 The values of &$host$& and
25961 &$host_address$& are set to the name and address of the server during the
25962 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
25963
25964 For back-compatibility,
25965 if neither tls_verify_hosts nor tls_try_verify_hosts are set
25966 (a single-colon empty list counts as being set)
25967 and certificate verification fails the TLS connection is closed.
25968
25969
25970 .option tls_verify_hosts smtp "host list&!!" unset
25971 .cindex "TLS" "server certificate verification"
25972 .cindex "certificate" "verification of server"
25973 This option gives a list of hosts for which, on encrypted connections,
25974 certificate verification must succeed.
25975 The &%tls_verify_certificates%& option must also be set.
25976 If both this option and &%tls_try_verify_hosts%& are unset
25977 operation is as if this option selected all hosts.
25978
25979 .option utf8_downconvert smtp integer&!! -1
25980 .cindex utf8 "address downconversion"
25981 .cindex i18n "utf8 address downconversion"
25982 If built with internationalization support,
25983 this option controls conversion of UTF-8 in message envelope addresses
25984 to a-label form.
25985 If, after expansion, the value is 1, 0, or -1 then this value overrides
25986 any value previously set for the message.  Otherwise, any previously
25987 set value is used.  To permit use of a previous value,
25988 set this option to an empty string.
25989 For details on the values see section &<<SECTi18nMTA>>&.
25990
25991
25992
25993
25994 .section "How the limits for the number of hosts to try are used" &&&
25995          "SECTvalhosmax"
25996 .cindex "host" "maximum number to try"
25997 .cindex "limit" "hosts; maximum number tried"
25998 There are two options that are concerned with the number of hosts that are
25999 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
26000 &%hosts_max_try_hardlimit%&.
26001
26002
26003 The &%hosts_max_try%& option limits the number of hosts that are tried
26004 for a single delivery. However, despite the term &"host"& in its name, the
26005 option actually applies to each IP address independently. In other words, a
26006 multihomed host is treated as several independent hosts, just as it is for
26007 retrying.
26008
26009 Many of the larger ISPs have multiple MX records which often point to
26010 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
26011 created as a result of routing one of these domains.
26012
26013 Trying every single IP address on such a long list does not seem sensible; if
26014 several at the top of the list fail, it is reasonable to assume there is some
26015 problem that is likely to affect all of them. Roughly speaking, the value of
26016 &%hosts_max_try%& is the maximum number that are tried before deferring the
26017 delivery. However, the logic cannot be quite that simple.
26018
26019 Firstly, IP addresses that are skipped because their retry times have not
26020 arrived do not count, and in addition, addresses that are past their retry
26021 limits are also not counted, even when they are tried. This means that when
26022 some IP addresses are past their retry limits, more than the value of
26023 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
26024 that all IP addresses are considered before timing out an email address (but
26025 see below for an exception).
26026
26027 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
26028 list to see if there is a subsequent host with a different (higher valued) MX.
26029 If there is, that host is considered next, and the current IP address is used
26030 but not counted. This behaviour helps in the case of a domain with a retry rule
26031 that hardly ever delays any hosts, as is now explained:
26032
26033 Consider the case of a long list of hosts with one MX value, and a few with a
26034 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
26035 hosts at the top of the list are tried at first. With the default retry rule,
26036 which specifies increasing retry times, the higher MX hosts are eventually
26037 tried when those at the top of the list are skipped because they have not
26038 reached their retry times.
26039
26040 However, it is common practice to put a fixed short retry time on domains for
26041 large ISPs, on the grounds that their servers are rarely down for very long.
26042 Unfortunately, these are exactly the domains that tend to resolve to long lists
26043 of hosts. The short retry time means that the lowest MX hosts are tried every
26044 time. The attempts may be in a different order because of random sorting, but
26045 without the special MX check, the higher MX hosts would never be tried until
26046 all the lower MX hosts had timed out (which might be several days), because
26047 there are always some lower MX hosts that have reached their retry times. With
26048 the special check, Exim considers at least one IP address from each MX value at
26049 every delivery attempt, even if the &%hosts_max_try%& limit has already been
26050 reached.
26051
26052 The above logic means that &%hosts_max_try%& is not a hard limit, and in
26053 particular, Exim normally eventually tries all the IP addresses before timing
26054 out an email address. When &%hosts_max_try%& was implemented, this seemed a
26055 reasonable thing to do. Recently, however, some lunatic DNS configurations have
26056 been set up with hundreds of IP addresses for some domains. It can
26057 take a very long time indeed for an address to time out in these cases.
26058
26059 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
26060 Exim never tries more than this number of IP addresses; if it hits this limit
26061 and they are all timed out, the email address is bounced, even though not all
26062 possible IP addresses have been tried.
26063 .ecindex IIDsmttra1
26064 .ecindex IIDsmttra2
26065
26066
26067
26068
26069
26070 . ////////////////////////////////////////////////////////////////////////////
26071 . ////////////////////////////////////////////////////////////////////////////
26072
26073 .chapter "Address rewriting" "CHAPrewrite"
26074 .scindex IIDaddrew "rewriting" "addresses"
26075 There are some circumstances in which Exim automatically rewrites domains in
26076 addresses. The two most common are when an address is given without a domain
26077 (referred to as an &"unqualified address"&) or when an address contains an
26078 abbreviated domain that is expanded by DNS lookup.
26079
26080 Unqualified envelope addresses are accepted only for locally submitted
26081 messages, or for messages that are received from hosts matching
26082 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
26083 appropriate. Unqualified addresses in header lines are qualified if they are in
26084 locally submitted messages, or messages from hosts that are permitted to send
26085 unqualified envelope addresses. Otherwise, unqualified addresses in header
26086 lines are neither qualified nor rewritten.
26087
26088 One situation in which Exim does &'not'& automatically rewrite a domain is
26089 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
26090 such a domain should be rewritten using the &"canonical"& name, and some MTAs
26091 do this. The new RFCs do not contain this suggestion.
26092
26093
26094 .section "Explicitly configured address rewriting" "SECID147"
26095 This chapter describes the rewriting rules that can be used in the
26096 main rewrite section of the configuration file, and also in the generic
26097 &%headers_rewrite%& option that can be set on any transport.
26098
26099 Some people believe that configured address rewriting is a Mortal Sin.
26100 Others believe that life is not possible without it. Exim provides the
26101 facility; you do not have to use it.
26102
26103 The main rewriting rules that appear in the &"rewrite"& section of the
26104 configuration file are applied to addresses in incoming messages, both envelope
26105 addresses and addresses in header lines. Each rule specifies the types of
26106 address to which it applies.
26107
26108 Whether or not addresses in header lines are rewritten depends on the origin of
26109 the headers and the type of rewriting. Global rewriting, that is, rewriting
26110 rules from the rewrite section of the configuration file, is applied only to
26111 those headers that were received with the message. Header lines that are added
26112 by ACLs or by a system filter or by individual routers or transports (which
26113 are specific to individual recipient addresses) are not rewritten by the global
26114 rules.
26115
26116 Rewriting at transport time, by means of the &%headers_rewrite%& option,
26117 applies all headers except those added by routers and transports. That is, as
26118 well as the headers that were received with the message, it also applies to
26119 headers that were added by an ACL or a system filter.
26120
26121
26122 In general, rewriting addresses from your own system or domain has some
26123 legitimacy. Rewriting other addresses should be done only with great care and
26124 in special circumstances. The author of Exim believes that rewriting should be
26125 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
26126 Although it can sometimes be used as a routing tool, this is very strongly
26127 discouraged.
26128
26129 There are two commonly encountered circumstances where rewriting is used, as
26130 illustrated by these examples:
26131
26132 .ilist
26133 The company whose domain is &'hitch.fict.example'& has a number of hosts that
26134 exchange mail with each other behind a firewall, but there is only a single
26135 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
26136 &'hitch.fict.example'& when sending mail off-site.
26137 .next
26138 A host rewrites the local parts of its own users so that, for example,
26139 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
26140 .endlist
26141
26142
26143
26144 .section "When does rewriting happen?" "SECID148"
26145 .cindex "rewriting" "timing of"
26146 .cindex "&ACL;" "rewriting addresses in"
26147 Configured address rewriting can take place at several different stages of a
26148 message's processing.
26149
26150 .vindex "&$sender_address$&"
26151 At the start of an ACL for MAIL, the sender address may have been rewritten
26152 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
26153 ordinary rewrite rules have yet been applied. If, however, the sender address
26154 is verified in the ACL, it is rewritten before verification, and remains
26155 rewritten thereafter. The subsequent value of &$sender_address$& is the
26156 rewritten address. This also applies if sender verification happens in a
26157 RCPT ACL. Otherwise, when the sender address is not verified, it is
26158 rewritten as soon as a message's header lines have been received.
26159
26160 .vindex "&$domain$&"
26161 .vindex "&$local_part$&"
26162 Similarly, at the start of an ACL for RCPT, the current recipient's address
26163 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
26164 rewrite rules have yet been applied to it. However, the behaviour is different
26165 from the sender address when a recipient is verified. The address is rewritten
26166 for the verification, but the rewriting is not remembered at this stage. The
26167 value of &$local_part$& and &$domain$& after verification are always the same
26168 as they were before (that is, they contain the unrewritten &-- except for
26169 SMTP-time rewriting &-- address).
26170
26171 As soon as a message's header lines have been received, all the envelope
26172 recipient addresses are permanently rewritten, and rewriting is also applied to
26173 the addresses in the header lines (if configured). This happens before adding
26174 any header lines that were specified in MAIL or RCPT ACLs, and
26175 .cindex "&[local_scan()]& function" "address rewriting; timing of"
26176 before the DATA ACL and &[local_scan()]& functions are run.
26177
26178 When an address is being routed, either for delivery or for verification,
26179 rewriting is applied immediately to child addresses that are generated by
26180 redirection, unless &%no_rewrite%& is set on the router.
26181
26182 .cindex "envelope from"
26183 .cindex "envelope sender" "rewriting at transport time"
26184 .cindex "rewriting" "at transport time"
26185 .cindex "header lines" "rewriting at transport time"
26186 At transport time, additional rewriting of addresses in header lines can be
26187 specified by setting the generic &%headers_rewrite%& option on a transport.
26188 This option contains rules that are identical in form to those in the rewrite
26189 section of the configuration file. They are applied to the original message
26190 header lines and any that were added by ACLs or a system filter. They are not
26191 applied to header lines that are added by routers or the transport.
26192
26193 The outgoing envelope sender can be rewritten by means of the &%return_path%&
26194 transport option. However, it is not possible to rewrite envelope recipients at
26195 transport time.
26196
26197
26198
26199
26200 .section "Testing the rewriting rules that apply on input" "SECID149"
26201 .cindex "rewriting" "testing"
26202 .cindex "testing" "rewriting"
26203 Exim's input rewriting configuration appears in a part of the runtime
26204 configuration file headed by &"begin rewrite"&. It can be tested by the
26205 &%-brw%& command line option. This takes an address (which can be a full RFC
26206 2822 address) as its argument. The output is a list of how the address would be
26207 transformed by the rewriting rules for each of the different places it might
26208 appear in an incoming message, that is, for each different header and for the
26209 envelope sender and recipient fields. For example,
26210 .code
26211 exim -brw ph10@exim.workshop.example
26212 .endd
26213 might produce the output
26214 .code
26215 sender: Philip.Hazel@exim.workshop.example
26216 from: Philip.Hazel@exim.workshop.example
26217 to: ph10@exim.workshop.example
26218 cc: ph10@exim.workshop.example
26219 bcc: ph10@exim.workshop.example
26220 reply-to: Philip.Hazel@exim.workshop.example
26221 env-from: Philip.Hazel@exim.workshop.example
26222 env-to: ph10@exim.workshop.example
26223 .endd
26224 which shows that rewriting has been set up for that address when used in any of
26225 the source fields, but not when it appears as a recipient address. At the
26226 present time, there is no equivalent way of testing rewriting rules that are
26227 set for a particular transport.
26228
26229
26230 .section "Rewriting rules" "SECID150"
26231 .cindex "rewriting" "rules"
26232 The rewrite section of the configuration file consists of lines of rewriting
26233 rules in the form
26234 .display
26235 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
26236 .endd
26237 Rewriting rules that are specified for the &%headers_rewrite%& generic
26238 transport option are given as a colon-separated list. Each item in the list
26239 takes the same form as a line in the main rewriting configuration (except that
26240 any colons must be doubled, of course).
26241
26242 The formats of source patterns and replacement strings are described below.
26243 Each is terminated by white space, unless enclosed in double quotes, in which
26244 case normal quoting conventions apply inside the quotes. The flags are single
26245 characters which may appear in any order. Spaces and tabs between them are
26246 ignored.
26247
26248 For each address that could potentially be rewritten, the rules are scanned in
26249 order, and replacements for the address from earlier rules can themselves be
26250 replaced by later rules (but see the &"q"& and &"R"& flags).
26251
26252 The order in which addresses are rewritten is undefined, may change between
26253 releases, and must not be relied on, with one exception: when a message is
26254 received, the envelope sender is always rewritten first, before any header
26255 lines are rewritten. For example, the replacement string for a rewrite of an
26256 address in &'To:'& must not assume that the message's address in &'From:'& has
26257 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
26258 that the envelope sender has already been rewritten.
26259
26260 .vindex "&$domain$&"
26261 .vindex "&$local_part$&"
26262 The variables &$local_part$& and &$domain$& can be used in the replacement
26263 string to refer to the address that is being rewritten. Note that lookup-driven
26264 rewriting can be done by a rule of the form
26265 .code
26266 *@*   ${lookup ...
26267 .endd
26268 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
26269 refer to the address that is being rewritten.
26270
26271
26272 .section "Rewriting patterns" "SECID151"
26273 .cindex "rewriting" "patterns"
26274 .cindex "address list" "in a rewriting pattern"
26275 The source pattern in a rewriting rule is any item which may appear in an
26276 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
26277 single-item address list, which means that it is expanded before being tested
26278 against the address. As always, if you use a regular expression as a pattern,
26279 you must take care to escape dollar and backslash characters, or use the &`\N`&
26280 facility to suppress string expansion within the regular expression.
26281
26282 Domains in patterns should be given in lower case. Local parts in patterns are
26283 case-sensitive. If you want to do case-insensitive matching of local parts, you
26284 can use a regular expression that starts with &`^(?i)`&.
26285
26286 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
26287 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
26288 depending on the type of match which occurred. These can be used in the
26289 replacement string to insert portions of the incoming address. &$0$& always
26290 refers to the complete incoming address. When a regular expression is used, the
26291 numerical variables are set from its capturing subexpressions. For other types
26292 of pattern they are set as follows:
26293
26294 .ilist
26295 If a local part or domain starts with an asterisk, the numerical variables
26296 refer to the character strings matched by asterisks, with &$1$& associated with
26297 the first asterisk, and &$2$& with the second, if present. For example, if the
26298 pattern
26299 .code
26300 *queen@*.fict.example
26301 .endd
26302 is matched against the address &'hearts-queen@wonderland.fict.example'& then
26303 .code
26304 $0 = hearts-queen@wonderland.fict.example
26305 $1 = hearts-
26306 $2 = wonderland
26307 .endd
26308 Note that if the local part does not start with an asterisk, but the domain
26309 does, it is &$1$& that contains the wild part of the domain.
26310
26311 .next
26312 If the domain part of the pattern is a partial lookup, the wild and fixed parts
26313 of the domain are placed in the next available numerical variables. Suppose,
26314 for example, that the address &'foo@bar.baz.example'& is processed by a
26315 rewriting rule of the form
26316 .display
26317 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
26318 .endd
26319 and the key in the file that matches the domain is &`*.baz.example`&. Then
26320 .code
26321 $1 = foo
26322 $2 = bar
26323 $3 = baz.example
26324 .endd
26325 If the address &'foo@baz.example'& is looked up, this matches the same
26326 wildcard file entry, and in this case &$2$& is set to the empty string, but
26327 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
26328 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
26329 whole domain. For non-partial domain lookups, no numerical variables are set.
26330 .endlist
26331
26332
26333 .section "Rewriting replacements" "SECID152"
26334 .cindex "rewriting" "replacements"
26335 If the replacement string for a rule is a single asterisk, addresses that
26336 match the pattern and the flags are &'not'& rewritten, and no subsequent
26337 rewriting rules are scanned. For example,
26338 .code
26339 hatta@lookingglass.fict.example  *  f
26340 .endd
26341 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
26342 &'From:'& headers.
26343
26344 .vindex "&$domain$&"
26345 .vindex "&$local_part$&"
26346 If the replacement string is not a single asterisk, it is expanded, and must
26347 yield a fully qualified address. Within the expansion, the variables
26348 &$local_part$& and &$domain$& refer to the address that is being rewritten.
26349 Any letters they contain retain their original case &-- they are not lower
26350 cased. The numerical variables are set up according to the type of pattern that
26351 matched the address, as described above. If the expansion is forced to fail by
26352 the presence of &"fail"& in a conditional or lookup item, rewriting by the
26353 current rule is abandoned, but subsequent rules may take effect. Any other
26354 expansion failure causes the entire rewriting operation to be abandoned, and an
26355 entry written to the panic log.
26356
26357
26358
26359 .section "Rewriting flags" "SECID153"
26360 There are three different kinds of flag that may appear on rewriting rules:
26361
26362 .ilist
26363 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
26364 c, f, h, r, s, t.
26365 .next
26366 A flag that specifies rewriting at SMTP time: S.
26367 .next
26368 Flags that control the rewriting process: Q, q, R, w.
26369 .endlist
26370
26371 For rules that are part of the &%headers_rewrite%& generic transport option,
26372 E, F, T, and S are not permitted.
26373
26374
26375
26376 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
26377          "SECID154"
26378 .cindex "rewriting" "flags"
26379 If none of the following flag letters, nor the &"S"& flag (see section
26380 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
26381 and to both the sender and recipient fields of the envelope, whereas a
26382 transport-time rewriting rule just applies to all headers. Otherwise, the
26383 rewriting rule is skipped unless the relevant addresses are being processed.
26384 .display
26385 &`E`&       rewrite all envelope fields
26386 &`F`&       rewrite the envelope From field
26387 &`T`&       rewrite the envelope To field
26388 &`b`&       rewrite the &'Bcc:'& header
26389 &`c`&       rewrite the &'Cc:'& header
26390 &`f`&       rewrite the &'From:'& header
26391 &`h`&       rewrite all headers
26392 &`r`&       rewrite the &'Reply-To:'& header
26393 &`s`&       rewrite the &'Sender:'& header
26394 &`t`&       rewrite the &'To:'& header
26395 .endd
26396 "All headers" means all of the headers listed above that can be selected
26397 individually, plus their &'Resent-'& versions. It does not include
26398 other headers such as &'Subject:'& etc.
26399
26400 You should be particularly careful about rewriting &'Sender:'& headers, and
26401 restrict this to special known cases in your own domains.
26402
26403
26404 .section "The SMTP-time rewriting flag" "SECTrewriteS"
26405 .cindex "SMTP" "rewriting malformed addresses"
26406 .cindex "RCPT" "rewriting argument of"
26407 .cindex "MAIL" "rewriting argument of"
26408 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
26409 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
26410 before any other processing; even before syntax checking. The pattern is
26411 required to be a regular expression, and it is matched against the whole of the
26412 data for the command, including any surrounding angle brackets.
26413
26414 .vindex "&$domain$&"
26415 .vindex "&$local_part$&"
26416 This form of rewrite rule allows for the handling of addresses that are not
26417 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
26418 input). Because the input is not required to be a syntactically valid address,
26419 the variables &$local_part$& and &$domain$& are not available during the
26420 expansion of the replacement string. The result of rewriting replaces the
26421 original address in the MAIL or RCPT command.
26422
26423
26424 .section "Flags controlling the rewriting process" "SECID155"
26425 There are four flags which control the way the rewriting process works. These
26426 take effect only when a rule is invoked, that is, when the address is of the
26427 correct type (matches the flags) and matches the pattern:
26428
26429 .ilist
26430 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
26431 unqualified local part. It is qualified with &%qualify_recipient%&. In the
26432 absence of &"Q"& the rewritten address must always include a domain.
26433 .next
26434 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
26435 even if no rewriting actually takes place because of a &"fail"& in the
26436 expansion. The &"q"& flag is not effective if the address is of the wrong type
26437 (does not match the flags) or does not match the pattern.
26438 .next
26439 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
26440 address, up to ten times. It can be combined with the &"q"& flag, to stop
26441 rewriting once it fails to match (after at least one successful rewrite).
26442 .next
26443 .cindex "rewriting" "whole addresses"
26444 When an address in a header is rewritten, the rewriting normally applies only
26445 to the working part of the address, with any comments and RFC 2822 &"phrase"&
26446 left unchanged. For example, rewriting might change
26447 .code
26448 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
26449 .endd
26450 into
26451 .code
26452 From: Ford Prefect <prefectf@hitch.fict.example>
26453 .endd
26454 .cindex "RFC 2047"
26455 Sometimes there is a need to replace the whole address item, and this can be
26456 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
26457 causes an address in a header line to be rewritten, the entire address is
26458 replaced, not just the working part. The replacement must be a complete RFC
26459 2822 address, including the angle brackets if necessary. If text outside angle
26460 brackets contains a character whose value is greater than 126 or less than 32
26461 (except for tab), the text is encoded according to RFC 2047. The character set
26462 is taken from &%headers_charset%&, which gets its default at build time.
26463
26464 When the &"w"& flag is set on a rule that causes an envelope address to be
26465 rewritten, all but the working part of the replacement address is discarded.
26466 .endlist
26467
26468
26469 .section "Rewriting examples" "SECID156"
26470 Here is an example of the two common rewriting paradigms:
26471 .code
26472 *@*.hitch.fict.example  $1@hitch.fict.example
26473 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
26474                      {$value}fail}@hitch.fict.example bctfrF
26475 .endd
26476 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
26477 the string expansion to fail if the lookup does not succeed. In this context it
26478 has the effect of leaving the original address unchanged, but Exim goes on to
26479 consider subsequent rewriting rules, if any, because the &"q"& flag is not
26480 present in that rule. An alternative to &"fail"& would be to supply &$1$&
26481 explicitly, which would cause the rewritten address to be the same as before,
26482 at the cost of a small bit of processing. Not supplying either of these is an
26483 error, since the rewritten address would then contain no local part.
26484
26485 The first example above replaces the domain with a superior, more general
26486 domain. This may not be desirable for certain local parts. If the rule
26487 .code
26488 root@*.hitch.fict.example  *
26489 .endd
26490 were inserted before the first rule, rewriting would be suppressed for the
26491 local part &'root'& at any domain ending in &'hitch.fict.example'&.
26492
26493 Rewriting can be made conditional on a number of tests, by making use of
26494 &${if$& in the expansion item. For example, to apply a rewriting rule only to
26495 messages that originate outside the local host:
26496 .code
26497 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
26498                          {$1@hitch.fict.example}fail}"
26499 .endd
26500 The replacement string is quoted in this example because it contains white
26501 space.
26502
26503 .cindex "rewriting" "bang paths"
26504 .cindex "bang paths" "rewriting"
26505 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
26506 an address it treats it as an unqualified local part which it qualifies with
26507 the local qualification domain (if the source of the message is local or if the
26508 remote host is permitted to send unqualified addresses). Rewriting can
26509 sometimes be used to handle simple bang paths with a fixed number of
26510 components. For example, the rule
26511 .code
26512 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
26513 .endd
26514 rewrites a two-component bang path &'host.name!user'& as the domain address
26515 &'user@host.name'&. However, there is a security implication in using this as
26516 a global rewriting rule for envelope addresses. It can provide a backdoor
26517 method for using your system as a relay, because the incoming addresses appear
26518 to be local. If the bang path addresses are received via SMTP, it is safer to
26519 use the &"S"& flag to rewrite them as they are received, so that relay checking
26520 can be done on the rewritten addresses.
26521 .ecindex IIDaddrew
26522
26523
26524
26525
26526
26527 . ////////////////////////////////////////////////////////////////////////////
26528 . ////////////////////////////////////////////////////////////////////////////
26529
26530 .chapter "Retry configuration" "CHAPretry"
26531 .scindex IIDretconf1 "retry" "configuration, description of"
26532 .scindex IIDregconf2 "configuration file" "retry section"
26533 The &"retry"& section of the runtime configuration file contains a list of
26534 retry rules that control how often Exim tries to deliver messages that cannot
26535 be delivered at the first attempt. If there are no retry rules (the section is
26536 empty or not present), there are no retries. In this situation, temporary
26537 errors are treated as permanent. The default configuration contains a single,
26538 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
26539 line option can be used to test which retry rule will be used for a given
26540 address, domain and error.
26541
26542 The most common cause of retries is temporary failure to deliver to a remote
26543 host because the host is down, or inaccessible because of a network problem.
26544 Exim's retry processing in this case is applied on a per-host (strictly, per IP
26545 address) basis, not on a per-message basis. Thus, if one message has recently
26546 been delayed, delivery of a new message to the same host is not immediately
26547 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
26548 log selector is set, the message
26549 .cindex "retry" "time not reached"
26550 &"retry time not reached"& is written to the main log whenever a delivery is
26551 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
26552 the handling of errors during remote deliveries.
26553
26554 Retry processing applies to routing as well as to delivering, except as covered
26555 in the next paragraph. The retry rules do not distinguish between these
26556 actions. It is not possible, for example, to specify different behaviour for
26557 failures to route the domain &'snark.fict.example'& and failures to deliver to
26558 the host &'snark.fict.example'&. I didn't think anyone would ever need this
26559 added complication, so did not implement it. However, although they share the
26560 same retry rule, the actual retry times for routing and transporting a given
26561 domain are maintained independently.
26562
26563 When a delivery is not part of a queue run (typically an immediate delivery on
26564 receipt of a message), the routers are always run, and local deliveries are
26565 always attempted, even if retry times are set for them. This makes for better
26566 behaviour if one particular message is causing problems (for example, causing
26567 quota overflow, or provoking an error in a filter file). If such a delivery
26568 suffers a temporary failure, the retry data is updated as normal, and
26569 subsequent delivery attempts from queue runs occur only when the retry time for
26570 the local address is reached.
26571
26572 .section "Changing retry rules" "SECID157"
26573 If you change the retry rules in your configuration, you should consider
26574 whether or not to delete the retry data that is stored in Exim's spool area in
26575 files with names like &_db/retry_&. Deleting any of Exim's hints files is
26576 always safe; that is why they are called &"hints"&.
26577
26578 The hints retry data contains suggested retry times based on the previous
26579 rules. In the case of a long-running problem with a remote host, it might
26580 record the fact that the host has timed out. If your new rules increase the
26581 timeout time for such a host, you should definitely remove the old retry data
26582 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
26583 messages that it should now be retaining.
26584
26585
26586
26587 .section "Format of retry rules" "SECID158"
26588 .cindex "retry" "rules"
26589 Each retry rule occupies one line and consists of three or four parts,
26590 separated by white space: a pattern, an error name, an optional list of sender
26591 addresses, and a list of retry parameters. The pattern and sender lists must be
26592 enclosed in double quotes if they contain white space. The rules are searched
26593 in order until one is found where the pattern, error name, and sender list (if
26594 present) match the failing host or address, the error that occurred, and the
26595 message's sender, respectively.
26596
26597
26598 The pattern is any single item that may appear in an address list (see section
26599 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
26600 which means that it is expanded before being tested against the address that
26601 has been delayed. A negated address list item is permitted. Address
26602 list processing treats a plain domain name as if it were preceded by &"*@"&,
26603 which makes it possible for many retry rules to start with just a domain. For
26604 example,
26605 .code
26606 lookingglass.fict.example        *  F,24h,30m;
26607 .endd
26608 provides a rule for any address in the &'lookingglass.fict.example'& domain,
26609 whereas
26610 .code
26611 alice@lookingglass.fict.example  *  F,24h,30m;
26612 .endd
26613 applies only to temporary failures involving the local part &%alice%&.
26614 In practice, almost all rules start with a domain name pattern without a local
26615 part.
26616
26617 .cindex "regular expressions" "in retry rules"
26618 &*Warning*&: If you use a regular expression in a retry rule pattern, it
26619 must match a complete address, not just a domain, because that is how regular
26620 expressions work in address lists.
26621 .display
26622 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
26623 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
26624 .endd
26625
26626
26627 .section "Choosing which retry rule to use for address errors" "SECID159"
26628 When Exim is looking for a retry rule after a routing attempt has failed (for
26629 example, after a DNS timeout), each line in the retry configuration is tested
26630 against the complete address only if &%retry_use_local_part%& is set for the
26631 router. Otherwise, only the domain is used, except when matching against a
26632 regular expression, when the local part of the address is replaced with &"*"&.
26633 A domain on its own can match a domain pattern, or a pattern that starts with
26634 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
26635 &%check_local_user%& is true, and false for other routers.
26636
26637 Similarly, when Exim is looking for a retry rule after a local delivery has
26638 failed (for example, after a mailbox full error), each line in the retry
26639 configuration is tested against the complete address only if
26640 &%retry_use_local_part%& is set for the transport (it defaults true for all
26641 local transports).
26642
26643 .cindex "4&'xx'& responses" "retry rules for"
26644 However, when Exim is looking for a retry rule after a remote delivery attempt
26645 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
26646 whole address is always used as the key when searching the retry rules. The
26647 rule that is found is used to create a retry time for the combination of the
26648 failing address and the message's sender. It is the combination of sender and
26649 recipient that is delayed in subsequent queue runs until its retry time is
26650 reached. You can delay the recipient without regard to the sender by setting
26651 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
26652 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
26653 commands.
26654
26655
26656
26657 .section "Choosing which retry rule to use for host and message errors" &&&
26658          "SECID160"
26659 For a temporary error that is not related to an individual address (for
26660 example, a connection timeout), each line in the retry configuration is checked
26661 twice. First, the name of the remote host is used as a domain name (preceded by
26662 &"*@"& when matching a regular expression). If this does not match the line,
26663 the domain from the email address is tried in a similar fashion. For example,
26664 suppose the MX records for &'a.b.c.example'& are
26665 .code
26666 a.b.c.example  MX  5  x.y.z.example
26667                MX  6  p.q.r.example
26668                MX  7  m.n.o.example
26669 .endd
26670 and the retry rules are
26671 .code
26672 p.q.r.example    *      F,24h,30m;
26673 a.b.c.example    *      F,4d,45m;
26674 .endd
26675 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
26676 first rule matches neither the host nor the domain, so Exim looks at the second
26677 rule. This does not match the host, but it does match the domain, so it is used
26678 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
26679 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
26680 first retry rule is used, because it matches the host.
26681
26682 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
26683 first rule to determine retry times, but for all the other hosts for the domain
26684 &'a.b.c.example'&, the second rule is used. The second rule is also used if
26685 routing to &'a.b.c.example'& suffers a temporary failure.
26686
26687 &*Note*&: The host name is used when matching the patterns, not its IP address.
26688 However, if a message is routed directly to an IP address without the use of a
26689 host name, for example, if a &(manualroute)& router contains a setting such as:
26690 .code
26691 route_list = *.a.example  192.168.34.23
26692 .endd
26693 then the &"host name"& that is used when searching for a retry rule is the
26694 textual form of the IP address.
26695
26696 .section "Retry rules for specific errors" "SECID161"
26697 .cindex "retry" "specific errors; specifying"
26698 The second field in a retry rule is the name of a particular error, or an
26699 asterisk, which matches any error. The errors that can be tested for are:
26700
26701 .vlist
26702 .vitem &%auth_failed%&
26703 Authentication failed when trying to send to a host in the
26704 &%hosts_require_auth%& list in an &(smtp)& transport.
26705
26706 .vitem &%data_4xx%&
26707 A 4&'xx'& error was received for an outgoing DATA command, either immediately
26708 after the command, or after sending the message's data.
26709
26710 .vitem &%mail_4xx%&
26711 A 4&'xx'& error was received for an outgoing MAIL command.
26712
26713 .vitem &%rcpt_4xx%&
26714 A 4&'xx'& error was received for an outgoing RCPT command.
26715 .endlist
26716
26717 For the three 4&'xx'& errors, either the first or both of the x's can be given
26718 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
26719 recognize 452 errors given to RCPT commands for addresses in a certain domain,
26720 and have retries every ten minutes with a one-hour timeout, you could set up a
26721 retry rule of this form:
26722 .code
26723 the.domain.name  rcpt_452   F,1h,10m
26724 .endd
26725 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
26726 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
26727
26728 .vlist
26729 .vitem &%lost_connection%&
26730 A server unexpectedly closed the SMTP connection. There may, of course,
26731 legitimate reasons for this (host died, network died), but if it repeats a lot
26732 for the same host, it indicates something odd.
26733
26734 .vitem &%lookup%&
26735 A DNS lookup for a host failed.
26736 Note that a &%dnslookup%& router will need to have matched
26737 its &%fail_defer_domains%& option for this retry type to be usable.
26738 Also note that a &%manualroute%& router will probably need
26739 its &%host_find_failed%& option set to &%defer%&.
26740
26741 .vitem &%refused_MX%&
26742 A connection to a host obtained from an MX record was refused.
26743
26744 .vitem &%refused_A%&
26745 A connection to a host not obtained from an MX record was refused.
26746
26747 .vitem &%refused%&
26748 A connection was refused.
26749
26750 .vitem &%timeout_connect_MX%&
26751 A connection attempt to a host obtained from an MX record timed out.
26752
26753 .vitem &%timeout_connect_A%&
26754 A connection attempt to a host not obtained from an MX record timed out.
26755
26756 .vitem &%timeout_connect%&
26757 A connection attempt timed out.
26758
26759 .vitem &%timeout_MX%&
26760 There was a timeout while connecting or during an SMTP session with a host
26761 obtained from an MX record.
26762
26763 .vitem &%timeout_A%&
26764 There was a timeout while connecting or during an SMTP session with a host not
26765 obtained from an MX record.
26766
26767 .vitem &%timeout%&
26768 There was a timeout while connecting or during an SMTP session.
26769
26770 .vitem &%tls_required%&
26771 The server was required to use TLS (it matched &%hosts_require_tls%& in the
26772 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
26773 to STARTTLS, or there was a problem setting up the TLS connection.
26774
26775 .vitem &%quota%&
26776 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
26777 transport.
26778
26779 .vitem &%quota_%&<&'time'&>
26780 .cindex "quota" "error testing in retry rule"
26781 .cindex "retry" "quota error testing"
26782 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
26783 transport, and the mailbox has not been accessed for <&'time'&>. For example,
26784 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
26785 for four days.
26786 .endlist
26787
26788 .cindex "mailbox" "time of last read"
26789 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
26790 timeouts when the mailbox is full and is not being read by its owner. Ideally,
26791 it should be based on the last time that the user accessed the mailbox.
26792 However, it is not always possible to determine this. Exim uses the following
26793 heuristic rules:
26794
26795 .ilist
26796 If the mailbox is a single file, the time of last access (the &"atime"&) is
26797 used. As no new messages are being delivered (because the mailbox is over
26798 quota), Exim does not access the file, so this is the time of last user access.
26799 .next
26800 .cindex "maildir format" "time of last read"
26801 For a maildir delivery, the time of last modification of the &_new_&
26802 subdirectory is used. As the mailbox is over quota, no new files are created in
26803 the &_new_& subdirectory, because no new messages are being delivered. Any
26804 change to the &_new_& subdirectory is therefore assumed to be the result of an
26805 MUA moving a new message to the &_cur_& directory when it is first read. The
26806 time that is used is therefore the last time that the user read a new message.
26807 .next
26808 For other kinds of multi-file mailbox, the time of last access cannot be
26809 obtained, so a retry rule that uses this type of error field is never matched.
26810 .endlist
26811
26812 The quota errors apply both to system-enforced quotas and to Exim's own quota
26813 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
26814 when a local delivery is deferred because a partition is full (the ENOSPC
26815 error).
26816
26817
26818
26819 .section "Retry rules for specified senders" "SECID162"
26820 .cindex "retry" "rules; sender-specific"
26821 You can specify retry rules that apply only when the failing message has a
26822 specific sender. In particular, this can be used to define retry rules that
26823 apply only to bounce messages. The third item in a retry rule can be of this
26824 form:
26825 .display
26826 &`senders=`&<&'address list'&>
26827 .endd
26828 The retry timings themselves are then the fourth item. For example:
26829 .code
26830 *   rcpt_4xx   senders=:   F,1h,30m
26831 .endd
26832 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
26833 host. If the address list contains white space, it must be enclosed in quotes.
26834 For example:
26835 .code
26836 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
26837 .endd
26838 &*Warning*&: This facility can be unhelpful if it is used for host errors
26839 (which do not depend on the recipient). The reason is that the sender is used
26840 only to match the retry rule. Once the rule has been found for a host error,
26841 its contents are used to set a retry time for the host, and this will apply to
26842 all messages, not just those with specific senders.
26843
26844 When testing retry rules using &%-brt%&, you can supply a sender using the
26845 &%-f%& command line option, like this:
26846 .code
26847 exim -f "" -brt user@dom.ain
26848 .endd
26849 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
26850 list is never matched.
26851
26852
26853
26854
26855
26856 .section "Retry parameters" "SECID163"
26857 .cindex "retry" "parameters in rules"
26858 The third (or fourth, if a senders list is present) field in a retry rule is a
26859 sequence of retry parameter sets, separated by semicolons. Each set consists of
26860 .display
26861 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
26862 .endd
26863 The letter identifies the algorithm for computing a new retry time; the cutoff
26864 time is the time beyond which this algorithm no longer applies, and the
26865 arguments vary the algorithm's action. The cutoff time is measured from the
26866 time that the first failure for the domain (combined with the local part if
26867 relevant) was detected, not from the time the message was received.
26868
26869 .cindex "retry" "algorithms"
26870 .cindex "retry" "fixed intervals"
26871 .cindex "retry" "increasing intervals"
26872 .cindex "retry" "random intervals"
26873 The available algorithms are:
26874
26875 .ilist
26876 &'F'&: retry at fixed intervals. There is a single time parameter specifying
26877 the interval.
26878 .next
26879 &'G'&: retry at geometrically increasing intervals. The first argument
26880 specifies a starting value for the interval, and the second a multiplier, which
26881 is used to increase the size of the interval at each retry.
26882 .next
26883 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
26884 retry, the previous interval is multiplied by the factor in order to get a
26885 maximum for the next interval. The minimum interval is the first argument of
26886 the parameter, and an actual interval is chosen randomly between them. Such a
26887 rule has been found to be helpful in cluster configurations when all the
26888 members of the cluster restart at once, and may therefore synchronize their
26889 queue processing times.
26890 .endlist
26891
26892 When computing the next retry time, the algorithm definitions are scanned in
26893 order until one whose cutoff time has not yet passed is reached. This is then
26894 used to compute a new retry time that is later than the current time. In the
26895 case of fixed interval retries, this simply means adding the interval to the
26896 current time. For geometrically increasing intervals, retry intervals are
26897 computed from the rule's parameters until one that is greater than the previous
26898 interval is found. The main configuration variable
26899 .cindex "limit" "retry interval"
26900 .cindex "retry" "interval, maximum"
26901 .oindex "&%retry_interval_max%&"
26902 &%retry_interval_max%& limits the maximum interval between retries. It
26903 cannot be set greater than &`24h`&, which is its default value.
26904
26905 A single remote domain may have a number of hosts associated with it, and each
26906 host may have more than one IP address. Retry algorithms are selected on the
26907 basis of the domain name, but are applied to each IP address independently. If,
26908 for example, a host has two IP addresses and one is unusable, Exim will
26909 generate retry times for it and will not try to use it until its next retry
26910 time comes. Thus the good IP address is likely to be tried first most of the
26911 time.
26912
26913 .cindex "hints database" "use for retrying"
26914 Retry times are hints rather than promises. Exim does not make any attempt to
26915 run deliveries exactly at the computed times. Instead, a queue runner process
26916 starts delivery processes for delayed messages periodically, and these attempt
26917 new deliveries only for those addresses that have passed their next retry time.
26918 If a new message arrives for a deferred address, an immediate delivery attempt
26919 occurs only if the address has passed its retry time. In the absence of new
26920 messages, the minimum time between retries is the interval between queue runner
26921 processes. There is not much point in setting retry times of five minutes if
26922 your queue runners happen only once an hour, unless there are a significant
26923 number of incoming messages (which might be the case on a system that is
26924 sending everything to a smart host, for example).
26925
26926 The data in the retry hints database can be inspected by using the
26927 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
26928 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
26929 &'exinext'& utility script can be used to find out what the next retry times
26930 are for the hosts associated with a particular mail domain, and also for local
26931 deliveries that have been deferred.
26932
26933
26934 .section "Retry rule examples" "SECID164"
26935 Here are some example retry rules:
26936 .code
26937 alice@wonderland.fict.example quota_5d  F,7d,3h
26938 wonderland.fict.example       quota_5d
26939 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
26940 lookingglass.fict.example     *         F,24h,30m;
26941 *                 refused_A   F,2h,20m;
26942 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
26943 .endd
26944 The first rule sets up special handling for mail to
26945 &'alice@wonderland.fict.example'& when there is an over-quota error and the
26946 mailbox has not been read for at least 5 days. Retries continue every three
26947 hours for 7 days. The second rule handles over-quota errors for all other local
26948 parts at &'wonderland.fict.example'&; the absence of a local part has the same
26949 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
26950 fail are bounced immediately if the mailbox has not been read for at least 5
26951 days.
26952
26953 The third rule handles all other errors at &'wonderland.fict.example'&; retries
26954 happen every 15 minutes for an hour, then with geometrically increasing
26955 intervals until two days have passed since a delivery first failed. After the
26956 first hour there is a delay of one hour, then two hours, then four hours, and
26957 so on (this is a rather extreme example).
26958
26959 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
26960 They happen every 30 minutes for 24 hours only. The remaining two rules handle
26961 all other domains, with special action for connection refusal from hosts that
26962 were not obtained from an MX record.
26963
26964 The final rule in a retry configuration should always have asterisks in the
26965 first two fields so as to provide a general catch-all for any addresses that do
26966 not have their own special handling. This example tries every 15 minutes for 2
26967 hours, then with intervals starting at one hour and increasing by a factor of
26968 1.5 up to 16 hours, then every 8 hours up to 5 days.
26969
26970
26971
26972 .section "Timeout of retry data" "SECID165"
26973 .cindex "timeout" "of retry data"
26974 .oindex "&%retry_data_expire%&"
26975 .cindex "hints database" "data expiry"
26976 .cindex "retry" "timeout of data"
26977 Exim timestamps the data that it writes to its retry hints database. When it
26978 consults the data during a delivery it ignores any that is older than the value
26979 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
26980 been tried for 7 days, Exim will try to deliver to it immediately a message
26981 arrives, and if that fails, it will calculate a retry time as if it were
26982 failing for the first time.
26983
26984 This improves the behaviour for messages routed to rarely-used hosts such as MX
26985 backups. If such a host was down at one time, and happens to be down again when
26986 Exim tries a month later, using the old retry data would imply that it had been
26987 down all the time, which is not a justified assumption.
26988
26989 If a host really is permanently dead, this behaviour causes a burst of retries
26990 every now and again, but only if messages routed to it are rare. If there is a
26991 message at least once every 7 days the retry data never expires.
26992
26993
26994
26995
26996 .section "Long-term failures" "SECID166"
26997 .cindex "delivery failure, long-term"
26998 .cindex "retry" "after long-term failure"
26999 Special processing happens when an email address has been failing for so long
27000 that the cutoff time for the last algorithm is reached. For example, using the
27001 default retry rule:
27002 .code
27003 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
27004 .endd
27005 the cutoff time is four days. Reaching the retry cutoff is independent of how
27006 long any specific message has been failing; it is the length of continuous
27007 failure for the recipient address that counts.
27008
27009 When the cutoff time is reached for a local delivery, or for all the IP
27010 addresses associated with a remote delivery, a subsequent delivery failure
27011 causes Exim to give up on the address, and a bounce message is generated.
27012 In order to cater for new messages that use the failing address, a next retry
27013 time is still computed from the final algorithm, and is used as follows:
27014
27015 For local deliveries, one delivery attempt is always made for any subsequent
27016 messages. If this delivery fails, the address fails immediately. The
27017 post-cutoff retry time is not used.
27018
27019 .cindex "final cutoff" "retries, controlling"
27020 .cindex retry "final cutoff"
27021 If the delivery is remote, there are two possibilities, controlled by the
27022 .oindex "&%delay_after_cutoff%&"
27023 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
27024 default. Until the post-cutoff retry time for one of the IP addresses,
27025 as set by the &%retry_data_expire%& option, is
27026 reached, the failing email address is bounced immediately, without a delivery
27027 attempt taking place. After that time, one new delivery attempt is made to
27028 those IP addresses that are past their retry times, and if that still fails,
27029 the address is bounced and new retry times are computed.
27030
27031 In other words, when all the hosts for a given email address have been failing
27032 for a long time, Exim bounces rather then defers until one of the hosts' retry
27033 times is reached. Then it tries once, and bounces if that attempt fails. This
27034 behaviour ensures that few resources are wasted in repeatedly trying to deliver
27035 to a broken destination, but if the host does recover, Exim will eventually
27036 notice.
27037
27038 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
27039 addresses are past their final cutoff time, Exim tries to deliver to those IP
27040 addresses that have not been tried since the message arrived. If there are
27041 no suitable IP addresses, or if they all fail, the address is bounced. In other
27042 words, it does not delay when a new message arrives, but tries the expired
27043 addresses immediately, unless they have been tried since the message arrived.
27044 If there is a continuous stream of messages for the failing domains, setting
27045 &%delay_after_cutoff%& false means that there will be many more attempts to
27046 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
27047 true.
27048
27049 .section "Deliveries that work intermittently" "SECID167"
27050 .cindex "retry" "intermittently working deliveries"
27051 Some additional logic is needed to cope with cases where a host is
27052 intermittently available, or when a message has some attribute that prevents
27053 its delivery when others to the same address get through. In this situation,
27054 because some messages are successfully delivered, the &"retry clock"& for the
27055 host or address keeps getting reset by the successful deliveries, and so
27056 failing messages remain in the queue for ever because the cutoff time is never
27057 reached.
27058
27059 Two exceptional actions are applied to prevent this happening. The first
27060 applies to errors that are related to a message rather than a remote host.
27061 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
27062 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
27063 commands, and quota failures. For this type of error, if a message's arrival
27064 time is earlier than the &"first failed"& time for the error, the earlier time
27065 is used when scanning the retry rules to decide when to try next and when to
27066 time out the address.
27067
27068 The exceptional second action applies in all cases. If a message has been on
27069 the queue for longer than the cutoff time of any applicable retry rule for a
27070 given address, a delivery is attempted for that address, even if it is not yet
27071 time, and if this delivery fails, the address is timed out. A new retry time is
27072 not computed in this case, so that other messages for the same address are
27073 considered immediately.
27074 .ecindex IIDretconf1
27075 .ecindex IIDregconf2
27076
27077
27078
27079
27080
27081
27082 . ////////////////////////////////////////////////////////////////////////////
27083 . ////////////////////////////////////////////////////////////////////////////
27084
27085 .chapter "SMTP authentication" "CHAPSMTPAUTH"
27086 .scindex IIDauthconf1 "SMTP" "authentication configuration"
27087 .scindex IIDauthconf2 "authentication"
27088 The &"authenticators"& section of Exim's runtime configuration is concerned
27089 with SMTP authentication. This facility is an extension to the SMTP protocol,
27090 described in RFC 2554, which allows a client SMTP host to authenticate itself
27091 to a server. This is a common way for a server to recognize clients that are
27092 permitted to use it as a relay. SMTP authentication is not of relevance to the
27093 transfer of mail between servers that have no managerial connection with each
27094 other.
27095
27096 .cindex "AUTH" "description of"
27097 .cindex "ESMTP extensions" AUTH
27098 Very briefly, the way SMTP authentication works is as follows:
27099
27100 .ilist
27101 The server advertises a number of authentication &'mechanisms'& in response to
27102 the client's EHLO command.
27103 .next
27104 The client issues an AUTH command, naming a specific mechanism. The command
27105 may, optionally, contain some authentication data.
27106 .next
27107 The server may issue one or more &'challenges'&, to which the client must send
27108 appropriate responses. In simple authentication mechanisms, the challenges are
27109 just prompts for user names and passwords. The server does not have to issue
27110 any challenges &-- in some mechanisms the relevant data may all be transmitted
27111 with the AUTH command.
27112 .next
27113 The server either accepts or denies authentication.
27114 .next
27115 If authentication succeeds, the client may optionally make use of the AUTH
27116 option on the MAIL command to pass an authenticated sender in subsequent
27117 mail transactions. Authentication lasts for the remainder of the SMTP
27118 connection.
27119 .next
27120 If authentication fails, the client may give up, or it may try a different
27121 authentication mechanism, or it may try transferring mail over the
27122 unauthenticated connection.
27123 .endlist
27124
27125 If you are setting up a client, and want to know which authentication
27126 mechanisms the server supports, you can use Telnet to connect to port 25 (the
27127 SMTP port) on the server, and issue an EHLO command. The response to this
27128 includes the list of supported mechanisms. For example:
27129 .display
27130 &`$ `&&*&`telnet server.example 25`&*&
27131 &`Trying 192.168.34.25...`&
27132 &`Connected to server.example.`&
27133 &`Escape character is &#x0027;^]&#x0027;.`&
27134 &`220 server.example ESMTP Exim 4.20 ...`&
27135 &*&`ehlo client.example`&*&
27136 &`250-server.example Hello client.example [10.8.4.5]`&
27137 &`250-SIZE 52428800`&
27138 &`250-PIPELINING`&
27139 &`250-AUTH PLAIN`&
27140 &`250 HELP`&
27141 .endd
27142 The second-last line of this example output shows that the server supports
27143 authentication using the PLAIN mechanism. In Exim, the different authentication
27144 mechanisms are configured by specifying &'authenticator'& drivers. Like the
27145 routers and transports, which authenticators are included in the binary is
27146 controlled by build-time definitions. The following are currently available,
27147 included by setting
27148 .code
27149 AUTH_CRAM_MD5=yes
27150 AUTH_CYRUS_SASL=yes
27151 AUTH_DOVECOT=yes
27152 AUTH_EXTERNAL=yes
27153 AUTH_GSASL=yes
27154 AUTH_HEIMDAL_GSSAPI=yes
27155 AUTH_PLAINTEXT=yes
27156 AUTH_SPA=yes
27157 AUTH_TLS=yes
27158 .endd
27159 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
27160 authentication mechanism (RFC 2195), and the second provides an interface to
27161 the Cyrus SASL authentication library.
27162 The third is an interface to Dovecot's authentication system, delegating the
27163 work via a socket interface.
27164 The fourth provides for negotiation of authentication done via non-SMTP means,
27165 as defined by RFC 4422 Appendix A.
27166 The fifth provides an interface to the GNU SASL authentication library, which
27167 provides mechanisms but typically not data sources.
27168 The sixth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
27169 supporting setting a server keytab.
27170 The seventh can be configured to support
27171 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
27172 not formally documented, but used by several MUAs.
27173 The eighth authenticator
27174 supports Microsoft's &'Secure Password Authentication'& mechanism.
27175 The last is an Exim authenticator but not an SMTP one;
27176 instead it can use information from a TLS negotiation.
27177
27178 The authenticators are configured using the same syntax as other drivers (see
27179 section &<<SECTfordricon>>&). If no authenticators are required, no
27180 authentication section need be present in the configuration file. Each
27181 authenticator can in principle have both server and client functions. When Exim
27182 is receiving SMTP mail, it is acting as a server; when it is sending out
27183 messages over SMTP, it is acting as a client. Authenticator configuration
27184 options are provided for use in both these circumstances.
27185
27186 To make it clear which options apply to which situation, the prefixes
27187 &%server_%& and &%client_%& are used on option names that are specific to
27188 either the server or the client function, respectively. Server and client
27189 functions are disabled if none of their options are set. If an authenticator is
27190 to be used for both server and client functions, a single definition, using
27191 both sets of options, is required. For example:
27192 .code
27193 cram:
27194   driver = cram_md5
27195   public_name = CRAM-MD5
27196   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
27197   client_name = ph10
27198   client_secret = secret2
27199 .endd
27200 The &%server_%& option is used when Exim is acting as a server, and the
27201 &%client_%& options when it is acting as a client.
27202
27203 Descriptions of the individual authenticators are given in subsequent chapters.
27204 The remainder of this chapter covers the generic options for the
27205 authenticators, followed by general discussion of the way authentication works
27206 in Exim.
27207
27208 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
27209 per-mechanism basis.  Please read carefully to determine which variables hold
27210 account labels such as usercodes and which hold passwords or other
27211 authenticating data.
27212
27213 Note that some mechanisms support two different identifiers for accounts: the
27214 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
27215 and &'authz'& are commonly encountered.  The American spelling is standard here.
27216 Conceptually, authentication data such as passwords are tied to the identifier
27217 used to authenticate; servers may have rules to permit one user to act as a
27218 second user, so that after login the session is treated as though that second
27219 user had logged in.  That second user is the &'authorization id'&.  A robust
27220 configuration might confirm that the &'authz'& field is empty or matches the
27221 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
27222 as verified data, the &'authz'& as an unverified request which the server might
27223 choose to honour.
27224
27225 A &'realm'& is a text string, typically a domain name, presented by a server
27226 to a client to help it select an account and credentials to use.  In some
27227 mechanisms, the client and server provably agree on the realm, but clients
27228 typically can not treat the realm as secure data to be blindly trusted.
27229
27230
27231
27232 .section "Generic options for authenticators" "SECID168"
27233 .cindex "authentication" "generic options"
27234 .cindex "options" "generic; for authenticators"
27235
27236 .option client_condition authenticators string&!! unset
27237 When Exim is authenticating as a client, it skips any authenticator whose
27238 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
27239 used, for example, to skip plain text authenticators when the connection is not
27240 encrypted by a setting such as:
27241 .code
27242 client_condition = ${if !eq{$tls_out_cipher}{}}
27243 .endd
27244
27245
27246 .option client_set_id authenticators string&!! unset
27247 When client authentication succeeds, this condition is expanded; the
27248 result is used in the log lines for outbound messages.
27249 Typically it will be the user name used for authentication.
27250
27251
27252 .option driver authenticators string unset
27253 This option must always be set. It specifies which of the available
27254 authenticators is to be used.
27255
27256
27257 .option public_name authenticators string unset
27258 This option specifies the name of the authentication mechanism that the driver
27259 implements, and by which it is known to the outside world. These names should
27260 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
27261 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
27262 defaults to the driver's instance name.
27263
27264
27265 .option server_advertise_condition authenticators string&!! unset
27266 When a server is about to advertise an authentication mechanism, the condition
27267 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
27268 mechanism is not advertised.
27269 If the expansion fails, the mechanism is not advertised. If the failure was not
27270 forced, and was not caused by a lookup defer, the incident is logged.
27271 See section &<<SECTauthexiser>>& below for further discussion.
27272
27273
27274 .option server_condition authenticators string&!! unset
27275 This option must be set for a &%plaintext%& server authenticator, where it
27276 is used directly to control authentication. See section &<<SECTplainserver>>&
27277 for details.
27278
27279 For the &(gsasl)& authenticator, this option is required for various
27280 mechanisms; see chapter &<<CHAPgsasl>>& for details.
27281
27282 For the other authenticators, &%server_condition%& can be used as an additional
27283 authentication or authorization mechanism that is applied after the other
27284 authenticator conditions succeed. If it is set, it is expanded when the
27285 authenticator would otherwise return a success code. If the expansion is forced
27286 to fail, authentication fails. Any other expansion failure causes a temporary
27287 error code to be returned. If the result of a successful expansion is an empty
27288 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
27289 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
27290 other result, a temporary error code is returned, with the expanded string as
27291 the error text.
27292
27293
27294 .option server_debug_print authenticators string&!! unset
27295 If this option is set and authentication debugging is enabled (see the &%-d%&
27296 command line option), the string is expanded and included in the debugging
27297 output when the authenticator is run as a server. This can help with checking
27298 out the values of variables.
27299 If expansion of the string fails, the error message is written to the debugging
27300 output, and Exim carries on processing.
27301
27302
27303 .option server_set_id authenticators string&!! unset
27304 .vindex "&$authenticated_id$&"
27305 .vindex "&$authenticated_fail_id$&"
27306 When an Exim server successfully authenticates a client, this string is
27307 expanded using data from the authentication, and preserved for any incoming
27308 messages in the variable &$authenticated_id$&. It is also included in the log
27309 lines for incoming messages. For example, a user/password authenticator
27310 configuration might preserve the user name that was used to authenticate, and
27311 refer to it subsequently during delivery of the message.
27312 On a failing authentication the expansion result is instead saved in
27313 the &$authenticated_fail_id$& variable.
27314 If expansion fails, the option is ignored.
27315
27316
27317 .option server_mail_auth_condition authenticators string&!! unset
27318 This option allows a server to discard authenticated sender addresses supplied
27319 as part of MAIL commands in SMTP connections that are authenticated by the
27320 driver on which &%server_mail_auth_condition%& is set. The option is not used
27321 as part of the authentication process; instead its (unexpanded) value is
27322 remembered for later use.
27323 How it is used is described in the following section.
27324
27325
27326
27327
27328
27329 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
27330 .cindex "authentication" "sender; authenticated"
27331 .cindex "AUTH" "on MAIL command"
27332 When a client supplied an AUTH= item on a MAIL command, Exim applies
27333 the following checks before accepting it as the authenticated sender of the
27334 message:
27335
27336 .ilist
27337 If the connection is not using extended SMTP (that is, HELO was used rather
27338 than EHLO), the use of AUTH= is a syntax error.
27339 .next
27340 If the value of the AUTH= parameter is &"<>"&, it is ignored.
27341 .next
27342 .vindex "&$authenticated_sender$&"
27343 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
27344 running, the value of &$authenticated_sender$& is set to the value obtained
27345 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
27346 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
27347 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
27348 given for the MAIL command.
27349 .next
27350 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
27351 is accepted and placed in &$authenticated_sender$& only if the client has
27352 authenticated.
27353 .next
27354 If the AUTH= value was accepted by either of the two previous rules, and
27355 the client has authenticated, and the authenticator has a setting for the
27356 &%server_mail_auth_condition%&, the condition is checked at this point. The
27357 valued that was saved from the authenticator is expanded. If the expansion
27358 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
27359 &$authenticated_sender$& is deleted. If the expansion yields any other value,
27360 the value of &$authenticated_sender$& is retained and passed on with the
27361 message.
27362 .endlist
27363
27364
27365 When &$authenticated_sender$& is set for a message, it is passed on to other
27366 hosts to which Exim authenticates as a client. Do not confuse this value with
27367 &$authenticated_id$&, which is a string obtained from the authentication
27368 process, and which is not usually a complete email address.
27369
27370 .vindex "&$sender_address$&"
27371 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
27372 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
27373 therefore make use of &$authenticated_sender$&. The converse is not true: the
27374 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
27375 ACL is run.
27376
27377
27378
27379 .section "Authentication on an Exim server" "SECTauthexiser"
27380 .cindex "authentication" "on an Exim server"
27381 When Exim receives an EHLO command, it advertises the public names of those
27382 authenticators that are configured as servers, subject to the following
27383 conditions:
27384
27385 .ilist
27386 The client host must match &%auth_advertise_hosts%& (default *).
27387 .next
27388 If the &%server_advertise_condition%& option is set, its expansion must not
27389 yield the empty string, &"0"&, &"no"&, or &"false"&.
27390 .endlist
27391
27392 The order in which the authenticators are defined controls the order in which
27393 the mechanisms are advertised.
27394
27395 Some mail clients (for example, some versions of Netscape) require the user to
27396 provide a name and password for authentication whenever AUTH is advertised,
27397 even though authentication may not in fact be needed (for example, Exim may be
27398 set up to allow unconditional relaying from the client by an IP address check).
27399 You can make such clients more friendly by not advertising AUTH to them.
27400 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
27401 that runs for RCPT) to relay without authentication, you should set
27402 .code
27403 auth_advertise_hosts = ! 10.9.8.0/24
27404 .endd
27405 so that no authentication mechanisms are advertised to them.
27406
27407 The &%server_advertise_condition%& controls the advertisement of individual
27408 authentication mechanisms. For example, it can be used to restrict the
27409 advertisement of a particular mechanism to encrypted connections, by a setting
27410 such as:
27411 .code
27412 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
27413 .endd
27414 .vindex "&$tls_in_cipher$&"
27415 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
27416 yields &"yes"&, which allows the advertisement to happen.
27417
27418 When an Exim server receives an AUTH command from a client, it rejects it
27419 immediately if AUTH was not advertised in response to an earlier EHLO
27420 command. This is the case if
27421
27422 .ilist
27423 The client host does not match &%auth_advertise_hosts%&; or
27424 .next
27425 No authenticators are configured with server options; or
27426 .next
27427 Expansion of &%server_advertise_condition%& blocked the advertising of all the
27428 server authenticators.
27429 .endlist
27430
27431
27432 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
27433 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
27434 AUTH is accepted from any client host.
27435
27436 If AUTH is not rejected by the ACL, Exim searches its configuration for a
27437 server authentication mechanism that was advertised in response to EHLO and
27438 that matches the one named in the AUTH command. If it finds one, it runs
27439 the appropriate authentication protocol, and authentication either succeeds or
27440 fails. If there is no matching advertised mechanism, the AUTH command is
27441 rejected with a 504 error.
27442
27443 .vindex "&$received_protocol$&"
27444 .vindex "&$sender_host_authenticated$&"
27445 When a message is received from an authenticated host, the value of
27446 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
27447 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
27448 public name) of the authenticator driver that successfully authenticated the
27449 client from which the message was received. This variable is empty if there was
27450 no successful authentication.
27451
27452 .cindex authentication "expansion item"
27453 Successful authentication sets up information used by the
27454 &%authresults%& expansion item.
27455
27456
27457
27458
27459 .section "Testing server authentication" "SECID169"
27460 .cindex "authentication" "testing a server"
27461 .cindex "AUTH" "testing a server"
27462 .cindex "base64 encoding" "creating authentication test data"
27463 Exim's &%-bh%& option can be useful for testing server authentication
27464 configurations. The data for the AUTH command has to be sent using base64
27465 encoding. A quick way to produce such data for testing is the following Perl
27466 script:
27467 .code
27468 use MIME::Base64;
27469 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
27470 .endd
27471 .cindex "binary zero" "in authentication data"
27472 This interprets its argument as a Perl string, and then encodes it. The
27473 interpretation as a Perl string allows binary zeros, which are required for
27474 some kinds of authentication, to be included in the data. For example, a
27475 command line to run this script on such data might be
27476 .code
27477 encode '\0user\0password'
27478 .endd
27479 Note the use of single quotes to prevent the shell interpreting the
27480 backslashes, so that they can be interpreted by Perl to specify characters
27481 whose code value is zero.
27482
27483 &*Warning 1*&: If either of the user or password strings starts with an octal
27484 digit, you must use three zeros instead of one after the leading backslash. If
27485 you do not, the octal digit that starts your string will be incorrectly
27486 interpreted as part of the code for the first character.
27487
27488 &*Warning 2*&: If there are characters in the strings that Perl interprets
27489 specially, you must use a Perl escape to prevent them being misinterpreted. For
27490 example, a command such as
27491 .code
27492 encode '\0user@domain.com\0pas$$word'
27493 .endd
27494 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
27495
27496 If you have the &%mimencode%& command installed, another way to produce
27497 base64-encoded strings is to run the command
27498 .code
27499 echo -e -n `\0user\0password' | mimencode
27500 .endd
27501 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
27502 in the argument, and the &%-n%& option specifies no newline at the end of its
27503 output. However, not all versions of &%echo%& recognize these options, so you
27504 should check your version before relying on this suggestion.
27505
27506
27507
27508 .section "Authentication by an Exim client" "SECID170"
27509 .cindex "authentication" "on an Exim client"
27510 The &(smtp)& transport has two options called &%hosts_require_auth%& and
27511 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
27512 announces support for authentication, and the host matches an entry in either
27513 of these options, Exim (as a client) tries to authenticate as follows:
27514
27515 .ilist
27516 For each authenticator that is configured as a client, in the order in which
27517 they are defined in the configuration, it searches the authentication
27518 mechanisms announced by the server for one whose name matches the public name
27519 of the authenticator.
27520 .next
27521 .vindex "&$host$&"
27522 .vindex "&$host_address$&"
27523 When it finds one that matches, it runs the authenticator's client code. The
27524 variables &$host$& and &$host_address$& are available for any string expansions
27525 that the client might do. They are set to the server's name and IP address. If
27526 any expansion is forced to fail, the authentication attempt is abandoned, and
27527 Exim moves on to the next authenticator. Otherwise an expansion failure causes
27528 delivery to be deferred.
27529 .next
27530 If the result of the authentication attempt is a temporary error or a timeout,
27531 Exim abandons trying to send the message to the host for the moment. It will
27532 try again later. If there are any backup hosts available, they are tried in the
27533 usual way.
27534 .next
27535 If the response to authentication is a permanent error (5&'xx'& code), Exim
27536 carries on searching the list of authenticators and tries another one if
27537 possible. If all authentication attempts give permanent errors, or if there are
27538 no attempts because no mechanisms match (or option expansions force failure),
27539 what happens depends on whether the host matches &%hosts_require_auth%& or
27540 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
27541 delivery is deferred. The error can be detected in the retry rules, and thereby
27542 turned into a permanent error if you wish. In the second case, Exim tries to
27543 deliver the message unauthenticated.
27544 .endlist
27545
27546 Note that the hostlist test for whether to do authentication can be
27547 confused if name-IP lookups change between the time the peer is decided
27548 upon and the time that the transport runs.  For example, with a manualroute
27549 router given a host name, and with DNS "round-robin" used by that name: if
27550 the local resolver cache times out between the router and the transport
27551 running, the transport may get an IP for the name for its authentication
27552 check which does not match the connection peer IP.
27553 No authentication will then be done, despite the names being identical.
27554
27555 For such cases use a separate transport which always authenticates.
27556
27557 .cindex "AUTH" "on MAIL command"
27558 When Exim has authenticated itself to a remote server, it adds the AUTH
27559 parameter to the MAIL commands it sends, if it has an authenticated sender for
27560 the message. If the message came from a remote host, the authenticated sender
27561 is the one that was receiving on an incoming MAIL command, provided that the
27562 incoming connection was authenticated and the &%server_mail_auth%& condition
27563 allowed the authenticated sender to be retained. If a local process calls Exim
27564 to send a message, the sender address that is built from the login name and
27565 &%qualify_domain%& is treated as authenticated. However, if the
27566 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
27567 the authenticated sender that was received with the message.
27568 .ecindex IIDauthconf1
27569 .ecindex IIDauthconf2
27570
27571
27572
27573
27574
27575
27576 . ////////////////////////////////////////////////////////////////////////////
27577 . ////////////////////////////////////////////////////////////////////////////
27578
27579 .chapter "The plaintext authenticator" "CHAPplaintext"
27580 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
27581 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
27582 The &(plaintext)& authenticator can be configured to support the PLAIN and
27583 LOGIN authentication mechanisms, both of which transfer authentication data as
27584 plain (unencrypted) text (though base64 encoded). The use of plain text is a
27585 security risk; you are strongly advised to insist on the use of SMTP encryption
27586 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
27587 use unencrypted plain text, you should not use the same passwords for SMTP
27588 connections as you do for login accounts.
27589
27590 .section "Avoiding cleartext use" "SECTplain_TLS"
27591 The following generic option settings will disable &(plaintext)& authenticators when
27592 TLS is not being used:
27593 .code
27594   server_advertise_condition = ${if def:tls_in_cipher }
27595   client_condition =           ${if def:tls_out_cipher}
27596 .endd
27597
27598 &*Note*&: a plaintext SMTP AUTH done inside TLS is not vulnerable to casual snooping,
27599 but is still vulnerable to a Man In The Middle attack unless certificates
27600 (including their names) have been properly verified.
27601
27602 .section "Plaintext server options" "SECID171"
27603 .cindex "options" "&(plaintext)& authenticator (server)"
27604 When configured as a server, &(plaintext)& uses the following options:
27605
27606 .option server_condition authenticators string&!! unset
27607 This is actually a global authentication option, but it must be set in order to
27608 configure the &(plaintext)& driver as a server. Its use is described below.
27609
27610 .option server_prompts plaintext "string list&!!" unset
27611 The contents of this option, after expansion, must be a colon-separated list of
27612 prompt strings. If expansion fails, a temporary authentication rejection is
27613 given.
27614
27615 .section "Using plaintext in a server" "SECTplainserver"
27616 .cindex "AUTH" "in &(plaintext)& authenticator"
27617 .cindex "binary zero" "in &(plaintext)& authenticator"
27618 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
27619         "in &(plaintext)& authenticator"
27620 .vindex "&$auth1$&, &$auth2$&, etc"
27621 .cindex "base64 encoding" "in &(plaintext)& authenticator"
27622
27623 When running as a server, &(plaintext)& performs the authentication test by
27624 expanding a string. The data sent by the client with the AUTH command, or in
27625 response to subsequent prompts, is base64 encoded, and so may contain any byte
27626 values when decoded. If any data is supplied with the command, it is treated as
27627 a list of strings, separated by NULs (binary zeros), the first three of which
27628 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
27629 (neither LOGIN nor PLAIN uses more than three strings).
27630
27631 For compatibility with previous releases of Exim, the values are also placed in
27632 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
27633 variables for this purpose is now deprecated, as it can lead to confusion in
27634 string expansions that also use them for other things.
27635
27636 If there are more strings in &%server_prompts%& than the number of strings
27637 supplied with the AUTH command, the remaining prompts are used to obtain more
27638 data. Each response from the client may be a list of NUL-separated strings.
27639
27640 .vindex "&$authenticated_id$&"
27641 Once a sufficient number of data strings have been received,
27642 &%server_condition%& is expanded. If the expansion is forced to fail,
27643 authentication fails. Any other expansion failure causes a temporary error code
27644 to be returned. If the result of a successful expansion is an empty string,
27645 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
27646 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
27647 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
27648 For any other result, a temporary error code is returned, with the expanded
27649 string as the error text.
27650
27651 &*Warning*&: If you use a lookup in the expansion to find the user's
27652 password, be sure to make the authentication fail if the user is unknown.
27653 There are good and bad examples at the end of the next section.
27654
27655
27656
27657 .section "The PLAIN authentication mechanism" "SECID172"
27658 .cindex "PLAIN authentication mechanism"
27659 .cindex authentication PLAIN
27660 .cindex "binary zero" "in &(plaintext)& authenticator"
27661 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
27662 sent as one item of data (that is, one combined string containing two NUL
27663 separators). The data is sent either as part of the AUTH command, or
27664 subsequently in response to an empty prompt from the server.
27665
27666 The second and third strings are a user name and a corresponding password.
27667 Using a single fixed user name and password as an example, this could be
27668 configured as follows:
27669 .code
27670 fixed_plain:
27671   driver = plaintext
27672   public_name = PLAIN
27673   server_prompts = :
27674   server_condition = \
27675     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
27676   server_set_id = $auth2
27677 .endd
27678 Note that the default result strings from &%if%& (&"true"& or an empty string)
27679 are exactly what we want here, so they need not be specified. Obviously, if the
27680 password contains expansion-significant characters such as dollar, backslash,
27681 or closing brace, they have to be escaped.
27682
27683 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
27684 the end of a string list are ignored). If all the data comes as part of the
27685 AUTH command, as is commonly the case, the prompt is not used. This
27686 authenticator is advertised in the response to EHLO as
27687 .code
27688 250-AUTH PLAIN
27689 .endd
27690 and a client host can authenticate itself by sending the command
27691 .code
27692 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
27693 .endd
27694 As this contains three strings (more than the number of prompts), no further
27695 data is required from the client. Alternatively, the client may just send
27696 .code
27697 AUTH PLAIN
27698 .endd
27699 to initiate authentication, in which case the server replies with an empty
27700 prompt. The client must respond with the combined data string.
27701
27702 The data string is base64 encoded, as required by the RFC. This example,
27703 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
27704 represents a zero byte. This is split up into three strings, the first of which
27705 is empty. The &%server_condition%& option in the authenticator checks that the
27706 second two are &`username`& and &`mysecret`& respectively.
27707
27708 Having just one fixed user name and password, as in this example, is not very
27709 realistic, though for a small organization with only a handful of
27710 authenticating clients it could make sense.
27711
27712 A more sophisticated instance of this authenticator could use the user name in
27713 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
27714 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
27715 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
27716 This is an incorrect example:
27717 .code
27718 server_condition = \
27719   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
27720 .endd
27721 The expansion uses the user name (&$auth2$&) as the key to look up a password,
27722 which it then compares to the supplied password (&$auth3$&). Why is this example
27723 incorrect? It works fine for existing users, but consider what happens if a
27724 non-existent user name is given. The lookup fails, but as no success/failure
27725 strings are given for the lookup, it yields an empty string. Thus, to defeat
27726 the authentication, all a client has to do is to supply a non-existent user
27727 name and an empty password. The correct way of writing this test is:
27728 .code
27729 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
27730   {${if eq{$value}{$auth3}}} {false}}
27731 .endd
27732 In this case, if the lookup succeeds, the result is checked; if the lookup
27733 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
27734 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
27735 always fails if its second argument is empty. However, the second way of
27736 writing the test makes the logic clearer.
27737
27738
27739 .section "The LOGIN authentication mechanism" "SECID173"
27740 .cindex "LOGIN authentication mechanism"
27741 .cindex authentication LOGIN
27742 The LOGIN authentication mechanism is not documented in any RFC, but is in use
27743 in a number of programs. No data is sent with the AUTH command. Instead, a
27744 user name and password are supplied separately, in response to prompts. The
27745 plaintext authenticator can be configured to support this as in this example:
27746 .code
27747 fixed_login:
27748   driver = plaintext
27749   public_name = LOGIN
27750   server_prompts = User Name : Password
27751   server_condition = \
27752     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
27753   server_set_id = $auth1
27754 .endd
27755 Because of the way plaintext operates, this authenticator accepts data supplied
27756 with the AUTH command (in contravention of the specification of LOGIN), but
27757 if the client does not supply it (as is the case for LOGIN clients), the prompt
27758 strings are used to obtain two data items.
27759
27760 Some clients are very particular about the precise text of the prompts. For
27761 example, Outlook Express is reported to recognize only &"Username:"& and
27762 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
27763 strings. It uses the &%ldapauth%& expansion condition to check the user
27764 name and password by binding to an LDAP server:
27765 .code
27766 login:
27767   driver = plaintext
27768   public_name = LOGIN
27769   server_prompts = Username:: : Password::
27770   server_condition = ${if and{{ \
27771     !eq{}{$auth1} }{ \
27772     ldapauth{\
27773       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
27774       pass=${quote:$auth2} \
27775       ldap://ldap.example.org/} }} }
27776   server_set_id = uid=$auth1,ou=people,o=example.org
27777 .endd
27778 We have to check that the username is not empty before using it, because LDAP
27779 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
27780 operator to correctly quote the DN for authentication. However, the basic
27781 &%quote%& operator, rather than any of the LDAP quoting operators, is the
27782 correct one to use for the password, because quoting is needed only to make
27783 the password conform to the Exim syntax. At the LDAP level, the password is an
27784 uninterpreted string.
27785
27786
27787 .section "Support for different kinds of authentication" "SECID174"
27788 A number of string expansion features are provided for the purpose of
27789 interfacing to different ways of user authentication. These include checking
27790 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
27791 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
27792 &<<SECTexpcond>>&.
27793
27794
27795
27796
27797 .section "Using plaintext in a client" "SECID175"
27798 .cindex "options" "&(plaintext)& authenticator (client)"
27799 The &(plaintext)& authenticator has two client options:
27800
27801 .option client_ignore_invalid_base64 plaintext boolean false
27802 If the client receives a server prompt that is not a valid base64 string,
27803 authentication is abandoned by default. However, if this option is set true,
27804 the error in the challenge is ignored and the client sends the response as
27805 usual.
27806
27807 .option client_send plaintext string&!! unset
27808 The string is a colon-separated list of authentication data strings. Each
27809 string is independently expanded before being sent to the server. The first
27810 string is sent with the AUTH command; any more strings are sent in response
27811 to prompts from the server. Before each string is expanded, the value of the
27812 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
27813 with &$auth1$& for the first prompt. Up to three prompts are stored in this
27814 way. Thus, the prompt that is received in response to sending the first string
27815 (with the AUTH command) can be used in the expansion of the second string, and
27816 so on. If an invalid base64 string is received when
27817 &%client_ignore_invalid_base64%& is set, an empty string is put in the
27818 &$auth$&<&'n'&> variable.
27819
27820 &*Note*&: You cannot use expansion to create multiple strings, because
27821 splitting takes priority and happens first.
27822
27823 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
27824 the data, further processing is applied to each string before it is sent. If
27825 there are any single circumflex characters in the string, they are converted to
27826 NULs. Should an actual circumflex be required as data, it must be doubled in
27827 the string.
27828
27829 This is an example of a client configuration that implements the PLAIN
27830 authentication mechanism with a fixed user name and password:
27831 .code
27832 fixed_plain:
27833   driver = plaintext
27834   public_name = PLAIN
27835   client_send = ^username^mysecret
27836 .endd
27837 The lack of colons means that the entire text is sent with the AUTH
27838 command, with the circumflex characters converted to NULs.
27839 .new
27840 Note that due to the ambiguity of parsing three consectutive circumflex characters
27841 there is no way to provide a password having a leading circumflex.
27842 .wen
27843
27844
27845 A similar example
27846 that uses the LOGIN mechanism is:
27847 .code
27848 fixed_login:
27849   driver = plaintext
27850   public_name = LOGIN
27851   client_send = : username : mysecret
27852 .endd
27853 The initial colon means that the first string is empty, so no data is sent with
27854 the AUTH command itself. The remaining strings are sent in response to
27855 prompts.
27856 .ecindex IIDplaiauth1
27857 .ecindex IIDplaiauth2
27858
27859
27860
27861
27862 . ////////////////////////////////////////////////////////////////////////////
27863 . ////////////////////////////////////////////////////////////////////////////
27864
27865 .chapter "The cram_md5 authenticator" "CHID9"
27866 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
27867 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
27868 .cindex "CRAM-MD5 authentication mechanism"
27869 .cindex authentication CRAM-MD5
27870 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
27871 sends a challenge string to the client, and the response consists of a user
27872 name and the CRAM-MD5 digest of the challenge string combined with a secret
27873 string (password) which is known to both server and client. Thus, the secret
27874 is not sent over the network as plain text, which makes this authenticator more
27875 secure than &(plaintext)&. However, the downside is that the secret has to be
27876 available in plain text at either end.
27877
27878
27879 .section "Using cram_md5 as a server" "SECID176"
27880 .cindex "options" "&(cram_md5)& authenticator (server)"
27881 This authenticator has one server option, which must be set to configure the
27882 authenticator as a server:
27883
27884 .option server_secret cram_md5 string&!! unset
27885 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
27886 When the server receives the client's response, the user name is placed in
27887 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
27888 obtain the password for that user. The server then computes the CRAM-MD5 digest
27889 that the client should have sent, and checks that it received the correct
27890 string. If the expansion of &%server_secret%& is forced to fail, authentication
27891 fails. If the expansion fails for some other reason, a temporary error code is
27892 returned to the client.
27893
27894 For compatibility with previous releases of Exim, the user name is also placed
27895 in &$1$&. However, the use of this variables for this purpose is now
27896 deprecated, as it can lead to confusion in string expansions that also use
27897 numeric variables for other things.
27898
27899 For example, the following authenticator checks that the user name given by the
27900 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
27901 user name, authentication fails.
27902 .code
27903 fixed_cram:
27904   driver = cram_md5
27905   public_name = CRAM-MD5
27906   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
27907   server_set_id = $auth1
27908 .endd
27909 .vindex "&$authenticated_id$&"
27910 If authentication succeeds, the setting of &%server_set_id%& preserves the user
27911 name in &$authenticated_id$&. A more typical configuration might look up the
27912 secret string in a file, using the user name as the key. For example:
27913 .code
27914 lookup_cram:
27915   driver = cram_md5
27916   public_name = CRAM-MD5
27917   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
27918                   {$value}fail}
27919   server_set_id = $auth1
27920 .endd
27921 Note that this expansion explicitly forces failure if the lookup fails
27922 because &$auth1$& contains an unknown user name.
27923
27924 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
27925 using the relevant libraries, you need to know the realm to specify in the
27926 lookup and then ask for the &"userPassword"& attribute for that user in that
27927 realm, with:
27928 .code
27929 cyrusless_crammd5:
27930   driver = cram_md5
27931   public_name = CRAM-MD5
27932   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
27933                   dbmjz{/etc/sasldb2}{$value}fail}
27934   server_set_id = $auth1
27935 .endd
27936
27937 .section "Using cram_md5 as a client" "SECID177"
27938 .cindex "options" "&(cram_md5)& authenticator (client)"
27939 When used as a client, the &(cram_md5)& authenticator has two options:
27940
27941
27942
27943 .option client_name cram_md5 string&!! "the primary host name"
27944 This string is expanded, and the result used as the user name data when
27945 computing the response to the server's challenge.
27946
27947
27948 .option client_secret cram_md5 string&!! unset
27949 This option must be set for the authenticator to work as a client. Its value is
27950 expanded and the result used as the secret string when computing the response.
27951
27952
27953 .vindex "&$host$&"
27954 .vindex "&$host_address$&"
27955 Different user names and secrets can be used for different servers by referring
27956 to &$host$& or &$host_address$& in the options. Forced failure of either
27957 expansion string is treated as an indication that this authenticator is not
27958 prepared to handle this case. Exim moves on to the next configured client
27959 authenticator. Any other expansion failure causes Exim to give up trying to
27960 send the message to the current server.
27961
27962 A simple example configuration of a &(cram_md5)& authenticator, using fixed
27963 strings, is:
27964 .code
27965 fixed_cram:
27966   driver = cram_md5
27967   public_name = CRAM-MD5
27968   client_name = ph10
27969   client_secret = secret
27970 .endd
27971 .ecindex IIDcramauth1
27972 .ecindex IIDcramauth2
27973
27974
27975
27976 . ////////////////////////////////////////////////////////////////////////////
27977 . ////////////////////////////////////////////////////////////////////////////
27978
27979 .chapter "The cyrus_sasl authenticator" "CHID10"
27980 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
27981 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
27982 .cindex "Cyrus" "SASL library"
27983 .cindex "Kerberos"
27984 The code for this authenticator was provided by Matthew Byng-Maddick while
27985 at A L Digital Ltd.
27986
27987 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
27988 library implementation of the RFC 2222 (&"Simple Authentication and Security
27989 Layer"&). This library supports a number of authentication mechanisms,
27990 including PLAIN and LOGIN, but also several others that Exim does not support
27991 directly. In particular, there is support for Kerberos authentication.
27992
27993 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
27994 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
27995 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
27996 name of the driver to determine which mechanism to support.
27997
27998 Where access to some kind of secret file is required, for example, in GSSAPI
27999 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
28000 user, and that the Cyrus SASL library has no way of escalating privileges
28001 by default. You may also find you need to set environment variables,
28002 depending on the driver you are using.
28003
28004 The application name provided by Exim is &"exim"&, so various SASL options may
28005 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
28006 Kerberos, note that because of limitations in the GSSAPI interface,
28007 changing the server keytab might need to be communicated down to the Kerberos
28008 layer independently. The mechanism for doing so is dependent upon the Kerberos
28009 implementation.
28010
28011 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
28012 may be set to point to an alternative keytab file. Exim will pass this
28013 variable through from its own inherited environment when started as root or the
28014 Exim user. The keytab file needs to be readable by the Exim user.
28015 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
28016 environment variable.  In practice, for those releases, the Cyrus authenticator
28017 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
28018 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
28019
28020
28021 .section "Using cyrus_sasl as a server" "SECID178"
28022 The &(cyrus_sasl)& authenticator has four private options. It puts the username
28023 (on a successful authentication) into &$auth1$&. For compatibility with
28024 previous releases of Exim, the username is also placed in &$1$&. However, the
28025 use of this variable for this purpose is now deprecated, as it can lead to
28026 confusion in string expansions that also use numeric variables for other
28027 things.
28028
28029
28030 .option server_hostname cyrus_sasl string&!! "see below"
28031 This option selects the hostname that is used when communicating with the
28032 library. The default value is &`$primary_hostname`&. It is up to the underlying
28033 SASL plug-in what it does with this data.
28034
28035
28036 .option server_mech cyrus_sasl string "see below"
28037 This option selects the authentication mechanism this driver should use. The
28038 default is the value of the generic &%public_name%& option. This option allows
28039 you to use a different underlying mechanism from the advertised name. For
28040 example:
28041 .code
28042 sasl:
28043   driver = cyrus_sasl
28044   public_name = X-ANYTHING
28045   server_mech = CRAM-MD5
28046   server_set_id = $auth1
28047 .endd
28048
28049 .option server_realm cyrus_sasl string&!! unset
28050 This specifies the SASL realm that the server claims to be in.
28051
28052
28053 .option server_service cyrus_sasl string &`smtp`&
28054 This is the SASL service that the server claims to implement.
28055
28056
28057 For straightforward cases, you do not need to set any of the authenticator's
28058 private options. All you need to do is to specify an appropriate mechanism as
28059 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
28060 PLAIN, you could have two authenticators as follows:
28061 .code
28062 sasl_cram_md5:
28063   driver = cyrus_sasl
28064   public_name = CRAM-MD5
28065   server_set_id = $auth1
28066
28067 sasl_plain:
28068   driver = cyrus_sasl
28069   public_name = PLAIN
28070   server_set_id = $auth2
28071 .endd
28072 Cyrus SASL does implement the LOGIN authentication method, even though it is
28073 not a standard method. It is disabled by default in the source distribution,
28074 but it is present in many binary distributions.
28075 .ecindex IIDcyrauth1
28076 .ecindex IIDcyrauth2
28077
28078
28079
28080
28081 . ////////////////////////////////////////////////////////////////////////////
28082 . ////////////////////////////////////////////////////////////////////////////
28083 .chapter "The dovecot authenticator" "CHAPdovecot"
28084 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
28085 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
28086 This authenticator is an interface to the authentication facility of the
28087 Dovecot 2 POP/IMAP server, which can support a number of authentication methods.
28088 Note that Dovecot must be configured to use auth-client not auth-userdb.
28089 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
28090 to use the same mechanisms for SMTP authentication. This is a server
28091 authenticator only. There is only one option:
28092
28093 .option server_socket dovecot string unset
28094
28095 This option must specify the UNIX socket that is the interface to Dovecot
28096 authentication. The &%public_name%& option must specify an authentication
28097 mechanism that Dovecot is configured to support. You can have several
28098 authenticators for different mechanisms. For example:
28099 .code
28100 dovecot_plain:
28101   driver = dovecot
28102   public_name = PLAIN
28103   server_socket = /var/run/dovecot/auth-client
28104   server_set_id = $auth1
28105
28106 dovecot_ntlm:
28107   driver = dovecot
28108   public_name = NTLM
28109   server_socket = /var/run/dovecot/auth-client
28110   server_set_id = $auth1
28111 .endd
28112 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
28113 &$received_ip_address$& (that is, the connection is local), the &"secured"&
28114 option is passed in the Dovecot authentication command. If, for a TLS
28115 connection, a client certificate has been verified, the &"valid-client-cert"&
28116 option is passed. When authentication succeeds, the identity of the user
28117 who authenticated is placed in &$auth1$&.
28118
28119 The Dovecot configuration to match the above wil look
28120 something like:
28121 .code
28122 conf.d/10-master.conf :-
28123
28124 service auth {
28125 ...
28126 #SASL
28127   unix_listener auth-client {
28128     mode = 0660
28129     user = mail
28130   }
28131 ...
28132 }
28133
28134 conf.d/10-auth.conf :-
28135
28136 auth_mechanisms = plain login ntlm
28137 .endd
28138
28139 .ecindex IIDdcotauth1
28140 .ecindex IIDdcotauth2
28141
28142
28143 . ////////////////////////////////////////////////////////////////////////////
28144 . ////////////////////////////////////////////////////////////////////////////
28145 .chapter "The gsasl authenticator" "CHAPgsasl"
28146 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
28147 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
28148 .cindex "authentication" "GNU SASL"
28149 .cindex "authentication" "SASL"
28150 .cindex "authentication" "EXTERNAL"
28151 .cindex "authentication" "ANONYMOUS"
28152 .cindex "authentication" "PLAIN"
28153 .cindex "authentication" "LOGIN"
28154 .cindex "authentication" "DIGEST-MD5"
28155 .cindex "authentication" "CRAM-MD5"
28156 .cindex "authentication" "SCRAM family"
28157 The &(gsasl)& authenticator provides integration for the GNU SASL
28158 library and the mechanisms it provides.  This is new as of the 4.80 release
28159 and there are a few areas where the library does not let Exim smoothly
28160 scale to handle future authentication mechanisms, so no guarantee can be
28161 made that any particular new authentication mechanism will be supported
28162 without code changes in Exim.
28163
28164 The library is expected to add support in an upcoming
28165 realease for the SCRAM-SHA-256 method.
28166 The macro _HAVE_AUTH_GSASL_SCRAM_SHA_256 will be defined
28167 when this happens.
28168
28169
28170 .option client_authz gsasl string&!! unset
28171 This option can be used to supply an &'authorization id'&
28172 which is different to the &'authentication_id'& provided
28173 by &%client_username%& option.
28174 If unset or (after expansion) empty it is not used,
28175 which is the common case.
28176
28177 .option client_channelbinding gsasl boolean false
28178 See &%server_channelbinding%& below.
28179
28180 .option client_password gsasl string&!! unset
28181 This option is exapanded before use, and should result in
28182 the password to be used, in clear.
28183
28184 .option client_username gsasl string&!! unset
28185 This option is exapanded before use, and should result in
28186 the account name to be used.
28187
28188 .option client_spassword gsasl string&!! unset
28189 If a SCRAM mechanism is being used and this option is set
28190 it is used in preference to &%client_password%&.
28191 The value after expansion should be
28192 a 40 (for SHA-1) or 64 (for SHA-256) character string
28193 with the PBKDF2-prepared password, hex-encoded.
28194 Note that this value will depend on the salt and iteration-count
28195 supplied by the server.
28196
28197
28198
28199 .option server_channelbinding gsasl boolean false
28200 Do not set this true and rely on the properties
28201 without consulting a cryptographic engineer.
28202 . Unsure what that's about.  It might be the "Triple Handshake"
28203 . vulnerability; cf. https://www.mitls.org/pages/attacks/3SHAKE
28204 . If so, we're ok, requiring Extended Master Secret if TLS
28205 . Session Resumption was used.
28206
28207 Some authentication mechanisms are able to use external context at both ends
28208 of the session to bind the authentication to that context, and fail the
28209 authentication process if that context differs.  Specifically, some TLS
28210 ciphersuites can provide identifying information about the cryptographic
28211 context.
28212
28213 This should have meant that certificate identity and verification becomes a
28214 non-issue, as a man-in-the-middle attack will cause the correct client and
28215 server to see different identifiers and authentication will fail.
28216
28217 This is
28218 only usable by mechanisms which support "channel binding"; at time of
28219 writing, that's the SCRAM family.
28220 When using this feature the "-PLUS" variants of the method names need to be used.
28221
28222 This defaults off to ensure smooth upgrade across Exim releases, in case
28223 this option causes some clients to start failing.  Some future release
28224 of Exim might have switched the default to be true.
28225
28226 However, Channel Binding in TLS has proven to be vulnerable in current versions.
28227 Do not plan to rely upon this feature for security, ever, without consulting
28228 with a subject matter expert (a cryptographic engineer).
28229
28230
28231 .option server_hostname gsasl string&!! "see below"
28232 This option selects the hostname that is used when communicating with the
28233 library. The default value is &`$primary_hostname`&.
28234 Some mechanisms will use this data.
28235
28236
28237 .option server_mech gsasl string "see below"
28238 This option selects the authentication mechanism this driver should use. The
28239 default is the value of the generic &%public_name%& option. This option allows
28240 you to use a different underlying mechanism from the advertised name. For
28241 example:
28242 .code
28243 sasl:
28244   driver = gsasl
28245   public_name = X-ANYTHING
28246   server_mech = CRAM-MD5
28247   server_set_id = $auth1
28248 .endd
28249
28250
28251 .option server_password gsasl string&!! unset
28252 Various mechanisms need access to the cleartext password on the server, so
28253 that proof-of-possession can be demonstrated on the wire, without sending
28254 the password itself.
28255
28256 The data available for lookup varies per mechanism.
28257 In all cases, &$auth1$& is set to the &'authentication id'&.
28258 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
28259 if available, else the empty string.
28260 The &$auth3$& variable will always be the &'realm'& if available,
28261 else the empty string.
28262
28263 A forced failure will cause authentication to defer.
28264
28265 If using this option, it may make sense to set the &%server_condition%&
28266 option to be simply "true".
28267
28268
28269 .option server_realm gsasl string&!! unset
28270 This specifies the SASL realm that the server claims to be in.
28271 Some mechanisms will use this data.
28272
28273
28274 .option server_scram_iter gsasl string&!! 4096
28275 This option provides data for the SCRAM family of mechanisms.
28276 The &$auth1$&, &$auth2$& and &$auth3$& variables are available
28277 when this option is expanded.
28278
28279 The result of expansion should be a decimal number,
28280 and represents both a lower-bound on the security, and
28281 a compute cost factor imposed on the client
28282 (if it does not cache results, or the server changes
28283 either the iteration count or the salt).
28284 A minimum value of 4096 is required by the standards
28285 for all current SCRAM mechanism variants.
28286
28287 .option server_scram_salt gsasl string&!! unset
28288 This option provides data for the SCRAM family of mechanisms.
28289 The &$auth1$&, &$auth2$& and &$auth3$& variables are available
28290 when this option is expanded.
28291 The value should be a base64-encoded string,
28292 of random data typically 4-to-16 bytes long.
28293 If unset or empty after expansion the library will provides a value for the
28294 protocol conversation.
28295
28296
28297 .option server_key gsasl string&!! unset
28298 .option server_skey gsasl string&!! unset
28299 These options can be used for the SCRAM family of mechanisms
28300 to provide stored information related to a password,
28301 the storage of which is preferable to plaintext.
28302
28303 &%server_key%& is the value defined in the SCRAM standards as ServerKey;
28304 &%server_skey%& is StoredKey.
28305
28306 They are only available for version 1.9.0 (or later) of the gsasl library.
28307 When this is so, the macros
28308 _OPT_AUTHENTICATOR_GSASL_SERVER_KEY
28309 and _HAVE_AUTH_GSASL_SCRAM_S_KEY
28310 will be defined.
28311
28312 The &$authN$& variables are available when these options are expanded.
28313
28314 If set, the results of expansion should for each
28315 should be a 28 (for SHA-1) or 44 (for SHA-256) character string
28316 of base64-coded data, and will be used in preference to the
28317 &%server_password%& option.
28318 If unset or not of the right length, &%server_password%& will be used.
28319
28320 The libgsasl library release includes a utility &'gsasl'& which can be used
28321 to generate these values.
28322
28323
28324 .option server_service gsasl string &`smtp`&
28325 This is the SASL service that the server claims to implement.
28326 Some mechanisms will use this data.
28327
28328
28329 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
28330 .vindex "&$auth1$&, &$auth2$&, etc"
28331 These may be set when evaluating specific options, as detailed above.
28332 They will also be set when evaluating &%server_condition%&.
28333
28334 Unless otherwise stated below, the &(gsasl)& integration will use the following
28335 meanings for these variables:
28336
28337 .ilist
28338 .vindex "&$auth1$&"
28339 &$auth1$&: the &'authentication id'&
28340 .next
28341 .vindex "&$auth2$&"
28342 &$auth2$&: the &'authorization id'&
28343 .next
28344 .vindex "&$auth3$&"
28345 &$auth3$&: the &'realm'&
28346 .endlist
28347
28348 On a per-mechanism basis:
28349
28350 .ilist
28351 .cindex "authentication" "EXTERNAL"
28352 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
28353 the &%server_condition%& option must be present.
28354 .next
28355 .cindex "authentication" "ANONYMOUS"
28356 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
28357 the &%server_condition%& option must be present.
28358 .next
28359 .cindex "authentication" "GSSAPI"
28360 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
28361 &$auth2$& will be set to the &'authorization id'&,
28362 the &%server_condition%& option must be present.
28363 .endlist
28364
28365 An &'anonymous token'& is something passed along as an unauthenticated
28366 identifier; this is analogous to FTP anonymous authentication passing an
28367 email address, or software-identifier@, as the "password".
28368
28369
28370 An example showing the password having the realm specified in the callback
28371 and demonstrating a Cyrus SASL to GSASL migration approach is:
28372 .code
28373 gsasl_cyrusless_crammd5:
28374   driver = gsasl
28375   public_name = CRAM-MD5
28376   server_realm = imap.example.org
28377   server_password = ${lookup{$auth1:$auth3:userPassword}\
28378                     dbmjz{/etc/sasldb2}{$value}fail}
28379   server_set_id = ${quote:$auth1}
28380   server_condition = yes
28381 .endd
28382
28383
28384 . ////////////////////////////////////////////////////////////////////////////
28385 . ////////////////////////////////////////////////////////////////////////////
28386
28387 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
28388 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
28389 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
28390 .cindex "authentication" "GSSAPI"
28391 .cindex "authentication" "Kerberos"
28392 The &(heimdal_gssapi)& authenticator provides server integration for the
28393 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
28394 reliably.
28395
28396 .option server_hostname heimdal_gssapi string&!! "see below"
28397 This option selects the hostname that is used, with &%server_service%&,
28398 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
28399 identifier.  The default value is &`$primary_hostname`&.
28400
28401 .option server_keytab heimdal_gssapi string&!! unset
28402 If set, then Heimdal will not use the system default keytab (typically
28403 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
28404 The value should be a pathname, with no &"file:"& prefix.
28405
28406 .option server_service heimdal_gssapi string&!! "smtp"
28407 This option specifies the service identifier used, in conjunction with
28408 &%server_hostname%&, for building the identifier for finding credentials
28409 from the keytab.
28410
28411
28412 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
28413 Beware that these variables will typically include a realm, thus will appear
28414 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
28415 not verified, so a malicious client can set it to anything.
28416
28417 The &$auth1$& field should be safely trustable as a value from the Key
28418 Distribution Center.  Note that these are not quite email addresses.
28419 Each identifier is for a role, and so the left-hand-side may include a
28420 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
28421
28422 .vindex "&$auth1$&, &$auth2$&, etc"
28423 .ilist
28424 .vindex "&$auth1$&"
28425 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
28426 .next
28427 .vindex "&$auth2$&"
28428 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
28429 authentication.  If that was empty, this will also be set to the
28430 GSS Display Name.
28431 .endlist
28432
28433
28434 . ////////////////////////////////////////////////////////////////////////////
28435 . ////////////////////////////////////////////////////////////////////////////
28436
28437 .chapter "The spa authenticator" "CHAPspa"
28438 .scindex IIDspaauth1 "&(spa)& authenticator"
28439 .scindex IIDspaauth2 "authenticators" "&(spa)&"
28440 .cindex "authentication" "Microsoft Secure Password"
28441 .cindex "authentication" "NTLM"
28442 .cindex "Microsoft Secure Password Authentication"
28443 .cindex "NTLM authentication"
28444 The &(spa)& authenticator provides client support for Microsoft's &'Secure
28445 Password Authentication'& mechanism,
28446 which is also sometimes known as NTLM (NT LanMan). The code for client side of
28447 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
28448 taken from the Samba project (&url(https://www.samba.org/)). The code for the
28449 server side was subsequently contributed by Tom Kistner. The mechanism works as
28450 follows:
28451
28452 .ilist
28453 After the AUTH command has been accepted, the client sends an SPA
28454 authentication request based on the user name and optional domain.
28455 .next
28456 The server sends back a challenge.
28457 .next
28458 The client builds a challenge response which makes use of the user's password
28459 and sends it to the server, which then accepts or rejects it.
28460 .endlist
28461
28462 Encryption is used to protect the password in transit.
28463
28464
28465
28466 .section "Using spa as a server" "SECID179"
28467 .cindex "options" "&(spa)& authenticator (server)"
28468 The &(spa)& authenticator has just one server option:
28469
28470 .option server_password spa string&!! unset
28471 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
28472 This option is expanded, and the result must be the cleartext password for the
28473 authenticating user, whose name is at this point in &$auth1$&. For
28474 compatibility with previous releases of Exim, the user name is also placed in
28475 &$1$&. However, the use of this variable for this purpose is now deprecated, as
28476 it can lead to confusion in string expansions that also use numeric variables
28477 for other things. For example:
28478 .code
28479 spa:
28480   driver = spa
28481   public_name = NTLM
28482   server_password = \
28483     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
28484 .endd
28485 If the expansion is forced to fail, authentication fails. Any other expansion
28486 failure causes a temporary error code to be returned.
28487
28488
28489
28490
28491
28492 .section "Using spa as a client" "SECID180"
28493 .cindex "options" "&(spa)& authenticator (client)"
28494 The &(spa)& authenticator has the following client options:
28495
28496
28497
28498 .option client_domain spa string&!! unset
28499 This option specifies an optional domain for the authentication.
28500
28501
28502 .option client_password spa string&!! unset
28503 This option specifies the user's password, and must be set.
28504
28505
28506 .option client_username spa string&!! unset
28507 This option specifies the user name, and must be set. Here is an example of a
28508 configuration of this authenticator for use with the mail servers at
28509 &'msn.com'&:
28510 .code
28511 msn:
28512   driver = spa
28513   public_name = MSN
28514   client_username = msn/msn_username
28515   client_password = msn_plaintext_password
28516   client_domain = DOMAIN_OR_UNSET
28517 .endd
28518 .ecindex IIDspaauth1
28519 .ecindex IIDspaauth2
28520
28521
28522
28523
28524
28525 . ////////////////////////////////////////////////////////////////////////////
28526 . ////////////////////////////////////////////////////////////////////////////
28527
28528 .chapter "The external authenticator" "CHAPexternauth"
28529 .scindex IIDexternauth1 "&(external)& authenticator"
28530 .scindex IIDexternauth2 "authenticators" "&(external)&"
28531 .cindex "authentication" "Client Certificate"
28532 .cindex "authentication" "X509"
28533 .cindex "Certificate-based authentication"
28534 The &(external)& authenticator provides support for
28535 authentication based on non-SMTP information.
28536 The specification is in RFC 4422 Appendix A
28537 (&url(https://tools.ietf.org/html/rfc4422)).
28538 It is only a transport and negotiation mechanism;
28539 the process of authentication is entirely controlled
28540 by the server configuration.
28541
28542 The client presents an identity in-clear.
28543 It is probably wise for a server to only advertise,
28544 and for clients to only attempt,
28545 this authentication method on a secure (eg. under TLS) connection.
28546
28547 One possible use, compatible with the
28548 K-9 Mail Andoid client (&url(https://k9mail.github.io/)),
28549 is for using X509 client certificates.
28550
28551 It thus overlaps in function with the TLS authenticator
28552 (see &<<CHAPtlsauth>>&)
28553 but is a full SMTP SASL authenticator
28554 rather than being implicit for TLS-connection carried
28555 client certificates only.
28556
28557 The examples and discussion in this chapter assume that
28558 client-certificate authentication is being done.
28559
28560 The client must present a certificate,
28561 for which it must have been requested via the
28562 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
28563 (see &<<CHAPTLS>>&).
28564 For authentication to be effective the certificate should be
28565 verifiable against a trust-anchor certificate known to the server.
28566
28567 .section "External options" "SECTexternsoptions"
28568 .cindex "options" "&(external)& authenticator (server)"
28569 The &(external)& authenticator has two server options:
28570
28571 .option server_param2 external string&!! unset
28572 .option server_param3 external string&!! unset
28573 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(external)& authenticator"
28574 These options are expanded before the &%server_condition%& option
28575 and the result are placed in &$auth2$& and &$auth3$& resectively.
28576 If the expansion is forced to fail, authentication fails. Any other expansion
28577 failure causes a temporary error code to be returned.
28578
28579 They can be used to clarify the coding of a complex &%server_condition%&.
28580
28581 .section "Using external in a server" "SECTexternserver"
28582 .cindex "AUTH" "in &(external)& authenticator"
28583 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
28584         "in &(external)& authenticator"
28585 .vindex "&$auth1$&, &$auth2$&, etc"
28586 .cindex "base64 encoding" "in &(external)& authenticator"
28587
28588 When running as a server, &(external)& performs the authentication test by
28589 expanding a string. The data sent by the client with the AUTH command, or in
28590 response to subsequent prompts, is base64 encoded, and so may contain any byte
28591 values when decoded. The decoded value is treated as
28592 an identity for authentication and
28593 placed in the expansion variable &$auth1$&.
28594
28595 For compatibility with previous releases of Exim, the value is also placed in
28596 the expansion variable &$1$&. However, the use of this
28597 variable for this purpose is now deprecated, as it can lead to confusion in
28598 string expansions that also use them for other things.
28599
28600 .vindex "&$authenticated_id$&"
28601 Once an identity has been received,
28602 &%server_condition%& is expanded. If the expansion is forced to fail,
28603 authentication fails. Any other expansion failure causes a temporary error code
28604 to be returned. If the result of a successful expansion is an empty string,
28605 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
28606 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
28607 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
28608 For any other result, a temporary error code is returned, with the expanded
28609 string as the error text.
28610
28611 Example:
28612 .code
28613 ext_ccert_san_mail:
28614   driver =            external
28615   public_name =       EXTERNAL
28616
28617   server_advertise_condition = $tls_in_certificate_verified
28618   server_param2 =     ${certextract {subj_altname,mail,>:} \
28619                                     {$tls_in_peercert}}
28620   server_condition =  ${if forany {$auth2} \
28621                             {eq {$item}{$auth1}}}
28622   server_set_id =     $auth1
28623 .endd
28624 This accepts a client certificate that is verifiable against any
28625 of your configured trust-anchors
28626 (which usually means the full set of public CAs)
28627 and which has a mail-SAN matching the claimed identity sent by the client.
28628
28629 &*Note*&: up to TLS1.2, the client cert is on the wire in-clear, including the SAN.
28630 The account name is therefore guessable by an opponent.
28631 TLS 1.3 protects both server and client certificates, and is not vulnerable
28632 in this way.
28633
28634
28635 .section "Using external in a client" "SECTexternclient"
28636 .cindex "options" "&(external)& authenticator (client)"
28637 The &(external)& authenticator has one client option:
28638
28639 .option client_send external string&!! unset
28640 This option is expanded and sent with the AUTH command as the
28641 identity being asserted.
28642
28643 Example:
28644 .code
28645 ext_ccert:
28646   driver =      external
28647   public_name = EXTERNAL
28648
28649   client_condition = ${if !eq{$tls_out_cipher}{}}
28650   client_send = myaccount@smarthost.example.net
28651 .endd
28652
28653
28654 .ecindex IIDexternauth1
28655 .ecindex IIDexternauth2
28656
28657
28658
28659
28660
28661 . ////////////////////////////////////////////////////////////////////////////
28662 . ////////////////////////////////////////////////////////////////////////////
28663
28664 .chapter "The tls authenticator" "CHAPtlsauth"
28665 .scindex IIDtlsauth1 "&(tls)& authenticator"
28666 .scindex IIDtlsauth2 "authenticators" "&(tls)&"
28667 .cindex "authentication" "Client Certificate"
28668 .cindex "authentication" "X509"
28669 .cindex "Certificate-based authentication"
28670 The &(tls)& authenticator provides server support for
28671 authentication based on client certificates.
28672
28673 It is not an SMTP authentication mechanism and is not
28674 advertised by the server as part of the SMTP EHLO response.
28675 It is an Exim authenticator in the sense that it affects
28676 the protocol element of the log line, can be tested for
28677 by the &%authenticated%& ACL condition, and can set
28678 the &$authenticated_id$& variable.
28679
28680 The client must present a verifiable certificate,
28681 for which it must have been requested via the
28682 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
28683 (see &<<CHAPTLS>>&).
28684
28685 If an authenticator of this type is configured it is
28686 run before any SMTP-level communication is done,
28687 and can authenticate the connection.
28688 If it does, SMTP authentication is not offered.
28689
28690 A maximum of one authenticator of this type may be present.
28691
28692
28693 .cindex "options" "&(tls)& authenticator (server)"
28694 The &(tls)& authenticator has three server options:
28695
28696 .option server_param1 tls string&!! unset
28697 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(tls)& authenticator"
28698 This option is expanded after the TLS negotiation and
28699 the result is placed in &$auth1$&.
28700 If the expansion is forced to fail, authentication fails. Any other expansion
28701 failure causes a temporary error code to be returned.
28702
28703 .option server_param2 tls string&!! unset
28704 .option server_param3 tls string&!! unset
28705 As above, for &$auth2$& and &$auth3$&.
28706
28707 &%server_param1%& may also be spelled &%server_param%&.
28708
28709
28710 Example:
28711 .code
28712 tls:
28713   driver = tls
28714   server_param1 =     ${certextract {subj_altname,mail,>:} \
28715                                     {$tls_in_peercert}}
28716   server_condition =  ${if and { {eq{$tls_in_certificate_verified}{1}} \
28717                                  {forany {$auth1} \
28718                             {!= {0} \
28719                                 {${lookup ldap{ldap:///\
28720                          mailname=${quote_ldap_dn:${lc:$item}},\
28721                          ou=users,LDAP_DC?mailid} {$value}{0} \
28722                        }    }  } }}}
28723   server_set_id =     ${if = {1}{${listcount:$auth1}} {$auth1}{}}
28724 .endd
28725 This accepts a client certificate that is verifiable against any
28726 of your configured trust-anchors
28727 (which usually means the full set of public CAs)
28728 and which has a SAN with a good account name.
28729
28730 Note that, up to TLS1.2, the client cert is on the wire in-clear, including the SAN,
28731 The account name is therefore guessable by an opponent.
28732 TLS 1.3 protects both server and client certificates, and is not vulnerable
28733 in this way.
28734 Likewise, a traditional plaintext SMTP AUTH done inside TLS is not.
28735
28736 . An alternative might use
28737 . .code
28738 .   server_param1 = ${sha256:$tls_in_peercert}
28739 . .endd
28740 . to require one of a set of specific certs that define a given account
28741 . (the verification is still required, but mostly irrelevant).
28742 . This would help for per-device use.
28743 .
28744 . However, for the future we really need support for checking a
28745 . user cert in LDAP - which probably wants a base-64 DER.
28746
28747 .ecindex IIDtlsauth1
28748 .ecindex IIDtlsauth2
28749
28750
28751 Note that because authentication is traditionally an SMTP operation,
28752 the &%authenticated%& ACL condition cannot be used in
28753 a connect- or helo-ACL.
28754
28755
28756
28757 . ////////////////////////////////////////////////////////////////////////////
28758 . ////////////////////////////////////////////////////////////////////////////
28759
28760 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
28761          "Encrypted SMTP connections"
28762 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
28763 .scindex IIDencsmtp2 "SMTP" "encryption"
28764 .cindex "TLS" "on SMTP connection"
28765 .cindex "OpenSSL"
28766 .cindex "GnuTLS"
28767 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
28768 Sockets Layer), is implemented by making use of the OpenSSL library or the
28769 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
28770 cryptographic code in the Exim distribution itself for implementing TLS. In
28771 order to use this feature you must install OpenSSL or GnuTLS, and then build a
28772 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
28773 You also need to understand the basic concepts of encryption at a managerial
28774 level, and in particular, the way that public keys, private keys, and
28775 certificates are used.
28776
28777 RFC 3207 defines how SMTP connections can make use of encryption. Once a
28778 connection is established, the client issues a STARTTLS command. If the
28779 server accepts this, the client and the server negotiate an encryption
28780 mechanism. If the negotiation succeeds, the data that subsequently passes
28781 between them is encrypted.
28782
28783 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
28784 and if so, what cipher suite is in use, whether the client supplied a
28785 certificate, and whether or not that certificate was verified. This makes it
28786 possible for an Exim server to deny or accept certain commands based on the
28787 encryption state.
28788
28789 &*Warning*&: Certain types of firewall and certain anti-virus products can
28790 disrupt TLS connections. You need to turn off SMTP scanning for these products
28791 in order to get TLS to work.
28792
28793
28794
28795 .section "Support for the &""submissions""& (aka &""ssmtp""& and &""smtps""&) protocol" &&&
28796          "SECID284"
28797 .cindex "submissions protocol"
28798 .cindex "ssmtp protocol"
28799 .cindex "smtps protocol"
28800 .cindex "SMTP" "submissions protocol"
28801 .cindex "SMTP" "ssmtp protocol"
28802 .cindex "SMTP" "smtps protocol"
28803 The history of port numbers for TLS in SMTP is a little messy and has been
28804 contentious.  As of RFC 8314, the common practice of using the historically
28805 allocated port 465 for "email submission but with TLS immediately upon connect
28806 instead of using STARTTLS" is officially blessed by the IETF, and recommended
28807 by them in preference to STARTTLS.
28808
28809 The name originally assigned to the port was &"ssmtp"& or &"smtps"&, but as
28810 clarity emerged over the dual roles of SMTP, for MX delivery and Email
28811 Submission, nomenclature has shifted.  The modern name is now &"submissions"&.
28812
28813 This approach was, for a while, officially abandoned when encrypted SMTP was
28814 standardized, but many clients kept using it, even as the TCP port number was
28815 reassigned for other use.
28816 Thus you may encounter guidance claiming that you shouldn't enable use of
28817 this port.
28818 In practice, a number of mail-clients have only ever supported submissions,
28819 not submission with STARTTLS upgrade.
28820 Ideally, offer both submission (587) and submissions (465) service.
28821
28822 Exim supports TLS-on-connect by means of the &%tls_on_connect_ports%&
28823 global option. Its value must be a list of port numbers;
28824 the most common use is expected to be:
28825 .code
28826 tls_on_connect_ports = 465
28827 .endd
28828 The port numbers specified by this option apply to all SMTP connections, both
28829 via the daemon and via &'inetd'&. You still need to specify all the ports that
28830 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
28831 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
28832 an extra port &-- rather, it specifies different behaviour on a port that is
28833 defined elsewhere.
28834
28835 There is also a &%-tls-on-connect%& command line option. This overrides
28836 &%tls_on_connect_ports%&; it forces the TLS-only behaviour for all ports.
28837
28838
28839
28840
28841
28842
28843 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
28844 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
28845 TLS is supported in Exim using either the OpenSSL or GnuTLS library.
28846 To build Exim to use OpenSSL you need to set
28847 .code
28848 USE_OPENSSL=yes
28849 .endd
28850 in Local/Makefile.
28851
28852 To build Exim to use GnuTLS, you need to set
28853 .code
28854 USE_GNUTLS=yes
28855 .endd
28856 in Local/Makefile.
28857
28858 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
28859 include files and libraries for GnuTLS can be found.
28860
28861 There are some differences in usage when using GnuTLS instead of OpenSSL:
28862
28863 .ilist
28864 The &%tls_verify_certificates%& option
28865 cannot be the path of a directory
28866 for GnuTLS versions before 3.3.6
28867 (for later versions, or OpenSSL, it can be either).
28868 .next
28869 The default value for &%tls_dhparam%& differs for historical reasons.
28870 .next
28871 .vindex "&$tls_in_peerdn$&"
28872 .vindex "&$tls_out_peerdn$&"
28873 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
28874 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
28875 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
28876 .next
28877 OpenSSL identifies cipher suites using hyphens as separators, for example:
28878 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
28879 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
28880 in a cipher list. To make life simpler, Exim changes underscores to hyphens
28881 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
28882 to handle its own older variants) when processing lists of cipher suites in the
28883 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
28884 option).
28885 .next
28886 The &%tls_require_ciphers%& options operate differently, as described in the
28887 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
28888 .next
28889 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
28890 When using OpenSSL, this option is ignored.
28891 (If an API is found to let OpenSSL be configured in this way,
28892 let the Exim Maintainers know and we'll likely use it).
28893 .next
28894 With GnuTLS, if an explicit list is used for the &%tls_privatekey%& main option
28895 main option, it must be ordered to match the &%tls_certificate%& list.
28896 .next
28897 Some other recently added features may only be available in one or the other.
28898 This should be documented with the feature.  If the documentation does not
28899 explicitly state that the feature is infeasible in the other TLS
28900 implementation, then patches are welcome.
28901 .new
28902 .next
28903 The output from "exim -bV" will show which (if any) support was included
28904 in the build.
28905 Also, the macro "_HAVE_OPENSSL" or "_HAVE_GNUTLS" will be defined.
28906 .wen
28907 .endlist
28908
28909
28910 .section "GnuTLS parameter computation" "SECTgnutlsparam"
28911 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
28912 an explicit path; if the latter, then the text about generation still applies,
28913 but not the chosen filename.
28914 By default, as of Exim 4.80 a hard-coded D-H prime is used.
28915 See the documentation of &%tls_dhparam%& for more information.
28916
28917 GnuTLS uses D-H parameters that may take a substantial amount of time
28918 to compute. It is unreasonable to re-compute them for every TLS session.
28919 Therefore, Exim keeps this data in a file in its spool directory, called
28920 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
28921 of bits requested.
28922 The file is owned by the Exim user and is readable only by
28923 its owner. Every Exim process that start up GnuTLS reads the D-H
28924 parameters from this file. If the file does not exist, the first Exim process
28925 that needs it computes the data and writes it to a temporary file which is
28926 renamed once it is complete. It does not matter if several Exim processes do
28927 this simultaneously (apart from wasting a few resources). Once a file is in
28928 place, new Exim processes immediately start using it.
28929
28930 For maximum security, the parameters that are stored in this file should be
28931 recalculated periodically, the frequency depending on your paranoia level.
28932 If you are avoiding using the fixed D-H primes published in RFCs, then you
28933 are concerned about some advanced attacks and will wish to do this; if you do
28934 not regenerate then you might as well stick to the standard primes.
28935
28936 Arranging this is easy in principle; just delete the file when you want new
28937 values to be computed. However, there may be a problem. The calculation of new
28938 parameters needs random numbers, and these are obtained from &_/dev/random_&.
28939 If the system is not very active, &_/dev/random_& may delay returning data
28940 until enough randomness (entropy) is available. This may cause Exim to hang for
28941 a substantial amount of time, causing timeouts on incoming connections.
28942
28943 The solution is to generate the parameters externally to Exim. They are stored
28944 in &_gnutls-params-N_& in PEM format, which means that they can be
28945 generated externally using the &(certtool)& command that is part of GnuTLS.
28946
28947 To replace the parameters with new ones, instead of deleting the file
28948 and letting Exim re-create it, you can generate new parameters using
28949 &(certtool)& and, when this has been done, replace Exim's cache file by
28950 renaming. The relevant commands are something like this:
28951 .code
28952 # ls
28953 [ look for file; assume gnutls-params-2236 is the most recent ]
28954 # rm -f new-params
28955 # touch new-params
28956 # chown exim:exim new-params
28957 # chmod 0600 new-params
28958 # certtool --generate-dh-params --bits 2236 >>new-params
28959 # openssl dhparam -noout -text -in new-params | head
28960 [ check the first line, make sure it's not more than 2236;
28961   if it is, then go back to the start ("rm") and repeat
28962   until the size generated is at most the size requested ]
28963 # chmod 0400 new-params
28964 # mv new-params gnutls-params-2236
28965 .endd
28966 If Exim never has to generate the parameters itself, the possibility of
28967 stalling is removed.
28968
28969 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
28970 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
28971 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
28972 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
28973 and Exim does so.  This attempt to remove Exim from TLS policy decisions
28974 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
28975 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
28976 which applies to all D-H usage, client or server.  If the value returned by
28977 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
28978 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
28979 limit, which is still much higher than Exim historically used.
28980
28981 The filename and bits used will change as the GnuTLS maintainers change the
28982 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
28983 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
28984 2432 bits, while NSS is limited to 2236 bits.
28985
28986 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
28987 increase the chance of the generated prime actually being within acceptable
28988 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
28989 procedure above.  There is no sane procedure available to Exim to double-check
28990 the size of the generated prime, so it might still be too large.
28991
28992
28993 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
28994 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
28995 .oindex "&%tls_require_ciphers%&" "OpenSSL"
28996 There is a function in the OpenSSL library that can be passed a list of cipher
28997 suites before the cipher negotiation takes place. This specifies which ciphers
28998 are acceptable for TLS versions prior to 1.3.
28999 The list is colon separated and may contain names like
29000 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
29001 directly to this function call.
29002 Many systems will install the OpenSSL manual-pages, so you may have
29003 &'ciphers(1)'& available to you.
29004 The following quotation from the OpenSSL
29005 documentation specifies what forms of item are allowed in the cipher string:
29006
29007 .ilist
29008 It can consist of a single cipher suite such as RC4-SHA.
29009 .next
29010 It can represent a list of cipher suites containing a certain algorithm,
29011 or cipher suites of a certain type. For example SHA1 represents all
29012 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
29013 SSL v3 algorithms.
29014 .next
29015 Lists of cipher suites can be combined in a single cipher string using
29016 the + character. This is used as a logical and operation. For example
29017 SHA1+DES represents all cipher suites containing the SHA1 and the DES
29018 algorithms.
29019 .endlist
29020
29021 Each cipher string can be optionally preceded by one of the characters &`!`&,
29022 &`-`& or &`+`&.
29023 .ilist
29024 If &`!`& is used, the ciphers are permanently deleted from the list. The
29025 ciphers deleted can never reappear in the list even if they are explicitly
29026 stated.
29027 .next
29028 If &`-`& is used, the ciphers are deleted from the list, but some or all
29029 of the ciphers can be added again by later options.
29030 .next
29031 If &`+`& is used, the ciphers are moved to the end of the list. This
29032 option does not add any new ciphers; it just moves matching existing ones.
29033 .endlist
29034
29035 If none of these characters is present, the string is interpreted as
29036 a list of ciphers to be appended to the current preference list. If the list
29037 includes any ciphers already present they will be ignored: that is, they will
29038 not be moved to the end of the list.
29039 .endlist
29040
29041 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
29042 string:
29043 .code
29044 # note single-quotes to get ! past any shell history expansion
29045 $ openssl ciphers 'HIGH:!MD5:!SHA1'
29046 .endd
29047
29048 This example will let the library defaults be permitted on the MX port, where
29049 there's probably no identity verification anyway, but ups the ante on the
29050 submission ports where the administrator might have some influence on the
29051 choice of clients used:
29052 .code
29053 # OpenSSL variant; see man ciphers(1)
29054 tls_require_ciphers = ${if =={$received_port}{25}\
29055                            {DEFAULT}\
29056                            {HIGH:!MD5:!SHA1}}
29057 .endd
29058
29059 This example will prefer ECDSA-authenticated ciphers over RSA ones:
29060 .code
29061 tls_require_ciphers = ECDSA:RSA:!COMPLEMENTOFDEFAULT
29062 .endd
29063
29064 For TLS version 1.3 the control available is less fine-grained
29065 and Exim does not provide access to it at present.
29066 The value of the &%tls_require_ciphers%& option is ignored when
29067 TLS version 1.3 is negotiated.
29068
29069 As of writing the library default cipher suite list for TLSv1.3 is
29070 .code
29071 TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256
29072 .endd
29073
29074
29075 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
29076          "SECTreqciphgnu"
29077 .cindex "GnuTLS" "specifying parameters for"
29078 .cindex "TLS" "specifying ciphers (GnuTLS)"
29079 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
29080 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
29081 .cindex "TLS" "specifying protocols (GnuTLS)"
29082 .cindex "TLS" "specifying priority string (GnuTLS)"
29083 .oindex "&%tls_require_ciphers%&" "GnuTLS"
29084 The GnuTLS library allows the caller to provide a "priority string", documented
29085 as part of the &[gnutls_priority_init]& function.  This is very similar to the
29086 ciphersuite specification in OpenSSL.
29087
29088 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string
29089 and controls both protocols and ciphers.
29090
29091 The &%tls_require_ciphers%& option is available both as an global option,
29092 controlling how Exim behaves as a server, and also as an option of the
29093 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
29094 the value is string expanded.  The resulting string is not an Exim list and
29095 the string is given to the GnuTLS library, so that Exim does not need to be
29096 aware of future feature enhancements of GnuTLS.
29097
29098 Documentation of the strings accepted may be found in the GnuTLS manual, under
29099 "Priority strings".  This is online as
29100 &url(https://www.gnutls.org/manual/html_node/Priority-Strings.html),
29101 but beware that this relates to GnuTLS 3, which may be newer than the version
29102 installed on your system.  If you are using GnuTLS 3,
29103 then the example code
29104 &url(https://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string)
29105 on that site can be used to test a given string.
29106
29107 For example:
29108 .code
29109 # Disable older versions of protocols
29110 tls_require_ciphers = NORMAL:%LATEST_RECORD_VERSION:-VERS-SSL3.0
29111 .endd
29112
29113 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
29114 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
29115 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
29116
29117 This example will let the library defaults be permitted on the MX port, where
29118 there's probably no identity verification anyway, and lowers security further
29119 by increasing compatibility; but this ups the ante on the submission ports
29120 where the administrator might have some influence on the choice of clients
29121 used:
29122 .code
29123 # GnuTLS variant
29124 tls_require_ciphers = ${if =={$received_port}{25}\
29125                            {NORMAL:%COMPAT}\
29126                            {SECURE128}}
29127 .endd
29128
29129
29130 .section "Configuring an Exim server to use TLS" "SECID182"
29131 .cindex "TLS" "configuring an Exim server"
29132 .cindex "ESMTP extensions" STARTTLS
29133 When Exim has been built with TLS support, it advertises the availability of
29134 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
29135 but not to any others. The default value of this option is *, which means
29136 that STARTTLS is always advertised.  Set it to blank to never advertise;
29137 this is reasonable for systems that want to use TLS only as a client.
29138
29139 If STARTTLS is to be used you
29140 need to set some other options in order to make TLS available.
29141
29142 If a client issues a STARTTLS command and there is some configuration
29143 problem in the server, the command is rejected with a 454 error. If the client
29144 persists in trying to issue SMTP commands, all except QUIT are rejected
29145 with the error
29146 .code
29147 554 Security failure
29148 .endd
29149 If a STARTTLS command is issued within an existing TLS session, it is
29150 rejected with a 554 error code.
29151
29152 To enable TLS operations on a server, the &%tls_advertise_hosts%& option
29153 must be set to match some hosts. The default is * which matches all hosts.
29154
29155 If this is all you do, TLS encryption will be enabled but not authentication -
29156 meaning that the peer has no assurance it is actually you he is talking to.
29157 You gain protection from a passive sniffer listening on the wire but not
29158 from someone able to intercept the communication.
29159
29160 Further protection requires some further configuration at the server end.
29161
29162 To make TLS work you need to set, in the server,
29163 .code
29164 tls_certificate = /some/file/name
29165 tls_privatekey = /some/file/name
29166 .endd
29167 These options are, in fact, expanded strings, so you can make them depend on
29168 the identity of the client that is connected if you wish. The first file
29169 contains the server's X509 certificate, and the second contains the private key
29170 that goes with it. These files need to be
29171 PEM format and readable by the Exim user, and must
29172 always be given as full path names.
29173 The key must not be password-protected.
29174 They can be the same file if both the
29175 certificate and the key are contained within it. If &%tls_privatekey%& is not
29176 set, or if its expansion is forced to fail or results in an empty string, this
29177 is assumed to be the case. The certificate file may also contain intermediate
29178 certificates that need to be sent to the client to enable it to authenticate
29179 the server's certificate.
29180
29181 For dual-stack (eg. RSA and ECDSA) configurations, these options can be
29182 colon-separated lists of file paths.  Ciphers using given authentication
29183 algorithms require the presence of a suitable certificate to supply the
29184 public-key.  The server selects among the certificates to present to the
29185 client depending on the selected cipher, hence the priority ordering for
29186 ciphers will affect which certificate is used.
29187
29188 If you do not understand about certificates and keys, please try to find a
29189 source of this background information, which is not Exim-specific. (There are a
29190 few comments below in section &<<SECTcerandall>>&.)
29191
29192 &*Note*&: These options do not apply when Exim is operating as a client &--
29193 they apply only in the case of a server. If you need to use a certificate in an
29194 Exim client, you must set the options of the same names in an &(smtp)&
29195 transport.
29196
29197 With just these options, an Exim server will be able to use TLS. It does not
29198 require the client to have a certificate (but see below for how to insist on
29199 this). There is one other option that may be needed in other situations. If
29200 .code
29201 tls_dhparam = /some/file/name
29202 .endd
29203 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
29204 with the parameters contained in the file.
29205 Set this to &`none`& to disable use of DH entirely, by making no prime
29206 available:
29207 .code
29208 tls_dhparam = none
29209 .endd
29210 This may also be set to a string identifying a standard prime to be used for
29211 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
29212 used is &`ike23`&.  There are a few standard primes available, see the
29213 documentation for &%tls_dhparam%& for the complete list.
29214
29215 See the command
29216 .code
29217 openssl dhparam
29218 .endd
29219 for a way of generating file data.
29220
29221 The strings supplied for these three options are expanded every time a client
29222 host connects. It is therefore possible to use different certificates and keys
29223 for different hosts, if you so wish, by making use of the client's IP address
29224 in &$sender_host_address$& to control the expansion. If a string expansion is
29225 forced to fail, Exim behaves as if the option is not set.
29226
29227 .cindex "cipher" "logging"
29228 .cindex "log" "TLS cipher"
29229 .vindex "&$tls_in_cipher$&"
29230 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
29231 an incoming TLS connection. It is included in the &'Received:'& header of an
29232 incoming message (by default &-- you can, of course, change this), and it is
29233 also included in the log line that records a message's arrival, keyed by
29234 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
29235 condition can be used to test for specific cipher suites in ACLs.
29236
29237 Once TLS has been established, the ACLs that run for subsequent SMTP commands
29238 can check the name of the cipher suite and vary their actions accordingly. The
29239 cipher suite names vary, depending on which TLS library is being used. For
29240 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
29241 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
29242 documentation for more details.
29243
29244 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
29245 (again depending on the &%tls_cipher%& log selector).
29246
29247
29248 .section "Requesting and verifying client certificates" "SECID183"
29249 .cindex "certificate" "verification of client"
29250 .cindex "TLS" "client certificate verification"
29251 If you want an Exim server to request a certificate when negotiating a TLS
29252 session with a client, you must set either &%tls_verify_hosts%& or
29253 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
29254 apply to all TLS connections. For any host that matches one of these options,
29255 Exim requests a certificate as part of the setup of the TLS session. The
29256 contents of the certificate are verified by comparing it with a list of
29257 expected trust-anchors or certificates.
29258 These may be the system default set (depending on library version),
29259 an explicit file or,
29260 depending on library version, a directory, identified by
29261 &%tls_verify_certificates%&.
29262
29263 A file can contain multiple certificates, concatenated end to end. If a
29264 directory is used
29265 (OpenSSL only),
29266 each certificate must be in a separate file, with a name (or a symbolic link)
29267 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
29268 certificate. You can compute the relevant hash by running the command
29269 .code
29270 openssl x509 -hash -noout -in /cert/file
29271 .endd
29272 where &_/cert/file_& contains a single certificate.
29273
29274 There is no checking of names of the client against the certificate
29275 Subject Name or Subject Alternate Names.
29276
29277 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
29278 what happens if the client does not supply a certificate, or if the certificate
29279 does not match any of the certificates in the collection named by
29280 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
29281 attempt to set up a TLS session is aborted, and the incoming connection is
29282 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
29283 session continues. ACLs that run for subsequent SMTP commands can detect the
29284 fact that no certificate was verified, and vary their actions accordingly. For
29285 example, you can insist on a certificate before accepting a message for
29286 relaying, but not when the message is destined for local delivery.
29287
29288 .vindex "&$tls_in_peerdn$&"
29289 When a client supplies a certificate (whether it verifies or not), the value of
29290 the Distinguished Name of the certificate is made available in the variable
29291 &$tls_in_peerdn$& during subsequent processing of the message.
29292
29293 .cindex "log" "distinguished name"
29294 Because it is often a long text string, it is not included in the log line or
29295 &'Received:'& header by default. You can arrange for it to be logged, keyed by
29296 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
29297 &%received_header_text%& to change the &'Received:'& header. When no
29298 certificate is supplied, &$tls_in_peerdn$& is empty.
29299
29300
29301 .section "Revoked certificates" "SECID184"
29302 .cindex "TLS" "revoked certificates"
29303 .cindex "revocation list"
29304 .cindex "certificate" "revocation list"
29305 .cindex "OCSP" "stapling"
29306 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
29307 certificates are revoked. If you have such a list, you can pass it to an Exim
29308 server using the global option called &%tls_crl%& and to an Exim client using
29309 an identically named option for the &(smtp)& transport. In each case, the value
29310 of the option is expanded and must then be the name of a file that contains a
29311 CRL in PEM format.
29312 The downside is that clients have to periodically re-download a potentially huge
29313 file from every certificate authority they know of.
29314
29315 The way with most moving parts at query time is Online Certificate
29316 Status Protocol (OCSP), where the client verifies the certificate
29317 against an OCSP server run by the CA.  This lets the CA track all
29318 usage of the certs.  It requires running software with access to the
29319 private key of the CA, to sign the responses to the OCSP queries.  OCSP
29320 is based on HTTP and can be proxied accordingly.
29321
29322 The only widespread OCSP server implementation (known to this writer)
29323 comes as part of OpenSSL and aborts on an invalid request, such as
29324 connecting to the port and then disconnecting.  This requires
29325 re-entering the passphrase each time some random client does this.
29326
29327 The third way is OCSP Stapling; in this, the server using a certificate
29328 issued by the CA periodically requests an OCSP proof of validity from
29329 the OCSP server, then serves it up inline as part of the TLS
29330 negotiation.   This approach adds no extra round trips, does not let the
29331 CA track users, scales well with number of certs issued by the CA and is
29332 resilient to temporary OCSP server failures, as long as the server
29333 starts retrying to fetch an OCSP proof some time before its current
29334 proof expires.  The downside is that it requires server support.
29335
29336 Unless Exim is built with the support disabled,
29337 or with GnuTLS earlier than version 3.3.16 / 3.4.8
29338 support for OCSP stapling is included.
29339
29340 There is a global option called &%tls_ocsp_file%&.
29341 The file specified therein is expected to be in DER format, and contain
29342 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
29343 option will be re-expanded for SNI, if the &%tls_certificate%& option
29344 contains &`tls_in_sni`&, as per other TLS options.
29345
29346 Exim does not at this time implement any support for fetching a new OCSP
29347 proof.  The burden is on the administrator to handle this, outside of
29348 Exim.  The file specified should be replaced atomically, so that the
29349 contents are always valid.  Exim will expand the &%tls_ocsp_file%& option
29350 on each connection, so a new file will be handled transparently on the
29351 next connection.
29352
29353 When built with OpenSSL Exim will check for a valid next update timestamp
29354 in the OCSP proof; if not present, or if the proof has expired, it will be
29355 ignored.
29356
29357 For the client to be able to verify the stapled OCSP the server must
29358 also supply, in its stapled information, any intermediate
29359 certificates for the chain leading to the OCSP proof from the signer
29360 of the server certificate.  There may be zero or one such. These
29361 intermediate certificates should be added to the server OCSP stapling
29362 file named by &%tls_ocsp_file%&.
29363
29364 Note that the proof only covers the terminal server certificate,
29365 not any of the chain from CA to it.
29366
29367 There is no current way to staple a proof for a client certificate.
29368
29369 .code
29370   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
29371   OCSP server is supplied.  The server URL may be included in the
29372   server certificate, if the CA is helpful.
29373
29374   One failure mode seen was the OCSP Signer cert expiring before the end
29375   of validity of the OCSP proof. The checking done by Exim/OpenSSL
29376   noted this as invalid overall, but the re-fetch script did not.
29377 .endd
29378
29379
29380 .new
29381 .section "Caching of static server configuration items" "SECTserverTLScache"
29382 .cindex certificate caching
29383 .cindex privatekey caching
29384 .cindex crl caching
29385 .cindex ocsp caching
29386 .cindex ciphers caching
29387 .cindex "CA bundle" caching
29388 .cindex "certificate authorities" caching
29389 .cindex tls_certificate caching
29390 .cindex tls_privatekey caching
29391 .cindex tls_crl caching
29392 .cindex tls_ocsp_file caching
29393 .cindex tls_require_ciphers caching
29394 .cindex tls_verify_certificate caching
29395 .cindex caching certificate
29396 .cindex caching privatekey
29397 .cindex caching crl
29398 .cindex caching ocsp
29399 .cindex caching ciphers
29400 .cindex caching "certificate authorities
29401 If any of the main configuration options &%tls_certificate%&, &%tls_privatekey%&,
29402 &%tls_crl%& and &%tls_ocsp_file%& have values with no
29403 expandable elements,
29404 then the associated information is loaded at daemon startup.
29405 It is made available
29406 to child processes forked for handling received SMTP connections.
29407
29408 This caching is currently only supported under Linux and FreeBSD.
29409
29410 If caching is not possible, for example if an item has to be dependent
29411 on the peer host so contains a &$sender_host_name$& expansion, the load
29412 of the associated information is done at the startup of the TLS connection.
29413
29414 The cache is invalidated and reloaded after any changes to the directories
29415 containing files specified by these options.
29416
29417 The information specified by the main option &%tls_verify_certificates%&
29418 is similarly cached so long as it specifies files explicitly
29419 or (under GnuTLS) is the string &"system,cache"&.
29420 The latter case is not automatically invalidated;
29421 it is the operator's responsibility to arrange for a daemon restart
29422 any time the system certificate authority bundle is updated.
29423 A HUP signal is sufficient for this.
29424 The value &"system"& results in no caching under GnuTLS.
29425
29426 The macro _HAVE_TLS_CA_CACHE will be defined if the suffix for "system"
29427 is acceptable in configurations for the Exim executavble.
29428
29429 Caching of the system Certificate Authorities bundle can
29430 save siginificant time and processing on every TLS connection
29431 accepted by Exim.
29432 .wen
29433
29434
29435
29436
29437 .section "Configuring an Exim client to use TLS" "SECTclientTLS"
29438 .cindex "cipher" "logging"
29439 .cindex "log" "TLS cipher"
29440 .cindex "log" "distinguished name"
29441 .cindex "TLS" "configuring an Exim client"
29442 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
29443 deliveries as well as to incoming, the latter one causing logging of the
29444 server certificate's DN. The remaining client configuration for TLS is all
29445 within the &(smtp)& transport.
29446
29447 .cindex "ESMTP extensions" STARTTLS
29448 It is not necessary to set any options to have TLS work in the &(smtp)&
29449 transport. If Exim is built with TLS support, and TLS is advertised by a
29450 server, the &(smtp)& transport always tries to start a TLS session. However,
29451 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
29452 transport) to a list of server hosts for which TLS should not be used.
29453
29454 If you do not want Exim to attempt to send messages unencrypted when an attempt
29455 to set up an encrypted connection fails in any way, you can set
29456 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
29457 those hosts, delivery is always deferred if an encrypted connection cannot be
29458 set up. If there are any other hosts for the address, they are tried in the
29459 usual way.
29460
29461 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
29462 the message unencrypted. It always does this if the response to STARTTLS is
29463 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
29464 session after a success response code, what happens is controlled by the
29465 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
29466 delivery to this host is deferred, and other hosts (if available) are tried. If
29467 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
29468 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
29469 negotiation fails, Exim closes the current connection (because it is in an
29470 unknown state), opens a new one to the same host, and then tries the delivery
29471 unencrypted.
29472
29473 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
29474 transport provide the client with a certificate, which is passed to the server
29475 if it requests it.
29476 This is an optional thing for TLS connections, although either end
29477 may insist on it.
29478 If the server is Exim, it will request a certificate only if
29479 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
29480
29481 &*Note*&: Do not use a certificate which has the OCSP-must-staple extension,
29482 for client use (they are usable for server use).
29483 As the TLS protocol has no means for the client to staple before TLS 1.3 it will result
29484 in failed connections.
29485
29486 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
29487 specifies a collection of expected server certificates.
29488 These may be
29489 the system default set (depending on library version),
29490 a file,
29491 or (depending on library version) a directory.
29492 The client verifies the server's certificate
29493 against this collection, taking into account any revoked certificates that are
29494 in the list defined by &%tls_crl%&.
29495 Failure to verify fails the TLS connection unless either of the
29496 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
29497
29498 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
29499 certificate verification to the listed servers.  Verification either must
29500 or need not succeed respectively.
29501
29502 The &%tls_verify_cert_hostnames%& option lists hosts for which additional
29503 name checks are made on the server certificate.
29504 .new
29505 The match against this list is, as per other Exim usage, the
29506 IP for the host.  That is most closely associated with the
29507 name on the DNS A (or AAAA) record for the host.
29508 However, the name that needs to be in the certificate
29509 is the one at the head of any CNAME chain leading to the A record.
29510 .wen
29511 The option defaults to always checking.
29512
29513 The &(smtp)& transport has two OCSP-related options:
29514 &%hosts_require_ocsp%&; a host-list for which a Certificate Status
29515 is requested and required for the connection to proceed.  The default
29516 value is empty.
29517 &%hosts_request_ocsp%&; a host-list for which (additionally)
29518 a Certificate Status is requested (but not necessarily verified).  The default
29519 value is "*" meaning that requests are made unless configured
29520 otherwise.
29521
29522 The host(s) should also be in &%hosts_require_tls%&, and
29523 &%tls_verify_certificates%& configured for the transport,
29524 for OCSP to be relevant.
29525
29526 If
29527 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
29528 list of permitted cipher suites. If either of these checks fails, delivery to
29529 the current host is abandoned, and the &(smtp)& transport tries to deliver to
29530 alternative hosts, if any.
29531
29532  &*Note*&:
29533 These options must be set in the &(smtp)& transport for Exim to use TLS when it
29534 is operating as a client. Exim does not assume that a server certificate (set
29535 by the global options of the same name) should also be used when operating as a
29536 client.
29537
29538 .vindex "&$host$&"
29539 .vindex "&$host_address$&"
29540 All the TLS options in the &(smtp)& transport are expanded before use, with
29541 &$host$& and &$host_address$& containing the name and address of the server to
29542 which the client is connected. Forced failure of an expansion causes Exim to
29543 behave as if the relevant option were unset.
29544
29545 .vindex &$tls_out_bits$&
29546 .vindex &$tls_out_cipher$&
29547 .vindex &$tls_out_peerdn$&
29548 .vindex &$tls_out_sni$&
29549 Before an SMTP connection is established, the
29550 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
29551 variables are emptied. (Until the first connection, they contain the values
29552 that were set when the message was received.) If STARTTLS is subsequently
29553 successfully obeyed, these variables are set to the relevant values for the
29554 outgoing connection.
29555
29556
29557
29558 .new
29559 .section "Caching of static client configuration items" "SECTclientTLScache"
29560 .cindex certificate caching
29561 .cindex privatekey caching
29562 .cindex crl caching
29563 .cindex ciphers caching
29564 .cindex "CA bundle" caching
29565 .cindex "certificate authorities" caching
29566 .cindex tls_certificate caching
29567 .cindex tls_privatekey caching
29568 .cindex tls_crl caching
29569 .cindex tls_require_ciphers caching
29570 .cindex tls_verify_certificate caching
29571 .cindex caching certificate
29572 .cindex caching privatekey
29573 .cindex caching crl
29574 .cindex caching ciphers
29575 .cindex caching "certificate authorities
29576 If any of the transport configuration options &%tls_certificate%&, &%tls_privatekey%&
29577 and &%tls_crl%& have values with no
29578 expandable elements,
29579 then the associated information is loaded per smtp transport
29580 at daemon startup, at the start of a queue run, or on a
29581 command-line specified message delivery.
29582 It is made available
29583 to child processes forked for handling making SMTP connections.
29584
29585 This caching is currently only supported under Linux.
29586
29587 If caching is not possible, the load
29588 of the associated information is done at the startup of the TLS connection.
29589
29590 The cache is invalidated in the daemon
29591 and reloaded after any changes to the directories
29592 containing files specified by these options.
29593
29594 The information specified by the main option &%tls_verify_certificates%&
29595 is similarly cached so long as it specifies files explicitly
29596 or (under GnuTLS) is the string &"system,cache"&.
29597 The latter case is not automatically invaludated;
29598 it is the operator's responsibility to arrange for a daemon restart
29599 any time the system certificate authority bundle is updated.
29600 A HUP signal is sufficient for this.
29601 The value &"system"& results in no caching under GnuTLS.
29602
29603 The macro _HAVE_TLS_CA_CACHE will be defined if the suffix for "system"
29604 is acceptable in configurations for the Exim executavble.
29605
29606 Caching of the system Certificate Authorities bundle can
29607 save siginificant time and processing on every TLS connection
29608 initiated by Exim.
29609 .wen
29610
29611
29612
29613
29614 .section "Use of TLS Server Name Indication" "SECTtlssni"
29615 .cindex "TLS" "Server Name Indication"
29616 .cindex "TLS" SNI
29617 .cindex SNI
29618 .vindex "&$tls_in_sni$&"
29619 .oindex "&%tls_in_sni%&"
29620 With TLS1.0 or above, there is an extension mechanism by which extra
29621 information can be included at various points in the protocol.  One of these
29622 extensions, documented in RFC 6066 (and before that RFC 4366) is
29623 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
29624 client in the initial handshake, so that the server can examine the servername
29625 within and possibly choose to use different certificates and keys (and more)
29626 for this session.
29627
29628 This is analogous to HTTP's &"Host:"& header, and is the main mechanism by
29629 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
29630 address.
29631
29632 With SMTP to MX, there are the same problems here as in choosing the identity
29633 against which to validate a certificate: you can't rely on insecure DNS to
29634 provide the identity which you then cryptographically verify.  So this will
29635 be of limited use in that environment.
29636
29637 With SMTP to Submission, there is a well-defined hostname which clients are
29638 connecting to and can validate certificates against.  Thus clients &*can*&
29639 choose to include this information in the TLS negotiation.  If this becomes
29640 wide-spread, then hosters can choose to present different certificates to
29641 different clients.  Or even negotiate different cipher suites.
29642
29643 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
29644 if not empty, will be sent on a TLS session as part of the handshake.  There's
29645 nothing more to it.  Choosing a sensible value not derived insecurely is the
29646 only point of caution.  The &$tls_out_sni$& variable will be set to this string
29647 for the lifetime of the client connection (including during authentication).
29648
29649 .new
29650 If DANE validated the connection attempt then the value of the &%tls_sni%& option
29651 is forced to the domain part of the recipient address.
29652 .wen
29653
29654 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
29655 received from a client.
29656 It can be logged with the &%log_selector%& item &`+tls_sni`&.
29657
29658 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
29659 option (prior to expansion) then the following options will be re-expanded
29660 during TLS session handshake, to permit alternative values to be chosen:
29661
29662 .ilist
29663 &%tls_certificate%&
29664 .next
29665 &%tls_crl%&
29666 .next
29667 &%tls_privatekey%&
29668 .next
29669 &%tls_verify_certificates%&
29670 .next
29671 &%tls_ocsp_file%&
29672 .endlist
29673
29674 Great care should be taken to deal with matters of case, various injection
29675 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
29676 can always be referenced; it is important to remember that &$tls_in_sni$& is
29677 arbitrary unverified data provided prior to authentication.
29678 Further, the initial certificate is loaded before SNI has arrived, so
29679 an expansion for &%tls_certificate%& must have a default which is used
29680 when &$tls_in_sni$& is empty.
29681
29682 The Exim developers are proceeding cautiously and so far no other TLS options
29683 are re-expanded.
29684
29685 When Exim is built against OpenSSL, OpenSSL must have been built with support
29686 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
29687 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
29688 see &`-servername`& in the output, then OpenSSL has support.
29689
29690 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
29691 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
29692 built, then you have SNI support).
29693
29694
29695
29696 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
29697          "SECTmulmessam"
29698 .cindex "multiple SMTP deliveries with TLS"
29699 .cindex "TLS" "multiple message deliveries"
29700 Exim sends multiple messages down the same TCP/IP connection by starting up
29701 an entirely new delivery process for each message, passing the socket from
29702 one process to the next. This implementation does not fit well with the use
29703 of TLS, because there is quite a lot of state information associated with a TLS
29704 connection, not just a socket identification. Passing all the state information
29705 to a new process is not feasible. Consequently, for sending using TLS Exim
29706 starts an additional proxy process for handling the encryption, piping the
29707 unencrypted data stream from and to the delivery processes.
29708
29709 An older mode of operation can be enabled on a per-host basis by the
29710 &%hosts_noproxy_tls%& option on the &(smtp)& transport.  If the host matches
29711 this list the proxy process described above is not used; instead Exim
29712 shuts down an existing TLS session being run by the delivery process
29713 before passing the socket to a new process. The new process may then
29714 try to start a new TLS session, and if successful, may try to re-authenticate
29715 if AUTH is in use, before sending the next message.
29716
29717 The RFC is not clear as to whether or not an SMTP session continues in clear
29718 after TLS has been shut down, or whether TLS may be restarted again later, as
29719 just described. However, if the server is Exim, this shutdown and
29720 reinitialization works. It is not known which (if any) other servers operate
29721 successfully if the client closes a TLS session and continues with unencrypted
29722 SMTP, but there are certainly some that do not work. For such servers, Exim
29723 should not pass the socket to another process, because the failure of the
29724 subsequent attempt to use it would cause Exim to record a temporary host error,
29725 and delay other deliveries to that host.
29726
29727 To test for this case, Exim sends an EHLO command to the server after
29728 closing down the TLS session. If this fails in any way, the connection is
29729 closed instead of being passed to a new delivery process, but no retry
29730 information is recorded.
29731
29732 There is also a manual override; you can set &%hosts_nopass_tls%& on the
29733 &(smtp)& transport to match those hosts for which Exim should not pass
29734 connections to new processes if TLS has been used.
29735
29736
29737
29738
29739 .section "Certificates and all that" "SECTcerandall"
29740 .cindex "certificate" "references to discussion"
29741 In order to understand fully how TLS works, you need to know about
29742 certificates, certificate signing, and certificate authorities.
29743 This is a large topic and an introductory guide is unsuitable for the Exim
29744 reference manual, so instead we provide pointers to existing documentation.
29745
29746 The Apache web-server was for a long time the canonical guide, so their
29747 documentation is a good place to start; their SSL module's Introduction
29748 document is currently at
29749 .display
29750 &url(https://httpd.apache.org/docs/current/ssl/ssl_intro.html)
29751 .endd
29752 and their FAQ is at
29753 .display
29754 &url(https://httpd.apache.org/docs/current/ssl/ssl_faq.html)
29755 .endd
29756
29757 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
29758 0-201-61598-3) in 2001, contains both introductory and more in-depth
29759 descriptions.
29760 More recently Ivan Ristić's book &'Bulletproof SSL and TLS'&,
29761 published by Feisty Duck (ISBN 978-1907117046) in 2013 is good.
29762 Ivan is the author of the popular TLS testing tools at
29763 &url(https://www.ssllabs.com/).
29764
29765
29766 .section "Certificate chains" "SECID186"
29767 The file named by &%tls_certificate%& may contain more than one
29768 certificate. This is useful in the case where the certificate that is being
29769 sent is validated by an intermediate certificate which the other end does
29770 not have. Multiple certificates must be in the correct order in the file.
29771 First the host's certificate itself, then the first intermediate
29772 certificate to validate the issuer of the host certificate, then the next
29773 intermediate certificate to validate the issuer of the first intermediate
29774 certificate, and so on, until finally (optionally) the root certificate.
29775 The root certificate must already be trusted by the recipient for
29776 validation to succeed, of course, but if it's not preinstalled, sending the
29777 root certificate along with the rest makes it available for the user to
29778 install if the receiving end is a client MUA that can interact with a user.
29779
29780 Note that certificates using MD5 are unlikely to work on today's Internet;
29781 even if your libraries allow loading them for use in Exim when acting as a
29782 server, increasingly clients will not accept such certificates.  The error
29783 diagnostics in such a case can be frustratingly vague.
29784
29785
29786
29787 .section "Self-signed certificates" "SECID187"
29788 .cindex "certificate" "self-signed"
29789 You can create a self-signed certificate using the &'req'& command provided
29790 with OpenSSL, like this:
29791 . ==== Do not shorten the duration here without reading and considering
29792 . ==== the text below.  Please leave it at 9999 days.
29793 .code
29794 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
29795             -days 9999 -nodes
29796 .endd
29797 &_file1_& and &_file2_& can be the same file; the key and the certificate are
29798 delimited and so can be identified independently. The &%-days%& option
29799 specifies a period for which the certificate is valid. The &%-nodes%& option is
29800 important: if you do not set it, the key is encrypted with a passphrase
29801 that you are prompted for, and any use that is made of the key causes more
29802 prompting for the passphrase. This is not helpful if you are going to use
29803 this certificate and key in an MTA, where prompting is not possible.
29804
29805 . ==== I expect to still be working 26 years from now.  The less technical
29806 . ==== debt I create, in terms of storing up trouble for my later years, the
29807 . ==== happier I will be then.  We really have reached the point where we
29808 . ==== should start, at the very least, provoking thought and making folks
29809 . ==== pause before proceeding, instead of leaving all the fixes until two
29810 . ==== years before 2^31 seconds after the 1970 Unix epoch.
29811 . ==== -pdp, 2012
29812 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
29813 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
29814 the above command might produce a date in the past.  Think carefully about
29815 the lifetime of the systems you're deploying, and either reduce the duration
29816 of the certificate or reconsider your platform deployment.  (At time of
29817 writing, reducing the duration is the most likely choice, but the inexorable
29818 progression of time takes us steadily towards an era where this will not
29819 be a sensible resolution).
29820
29821 A self-signed certificate made in this way is sufficient for testing, and
29822 may be adequate for all your requirements if you are mainly interested in
29823 encrypting transfers, and not in secure identification.
29824
29825 However, many clients require that the certificate presented by the server be a
29826 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
29827 certificate. In this situation, the self-signed certificate described above
29828 must be installed on the client host as a trusted root &'certification
29829 authority'& (CA), and the certificate used by Exim must be a user certificate
29830 signed with that self-signed certificate.
29831
29832 For information on creating self-signed CA certificates and using them to sign
29833 user certificates, see the &'General implementation overview'& chapter of the
29834 Open-source PKI book, available online at
29835 &url(https://sourceforge.net/projects/ospkibook/).
29836 .ecindex IIDencsmtp1
29837 .ecindex IIDencsmtp2
29838
29839
29840 .new
29841 .section "TLS Resumption" "SECTresumption"
29842 .cindex TLS resumption
29843 TLS Session Resumption for TLS 1.2 and TLS 1.3 connections can be used (defined
29844 in RFC 5077 for 1.2).  The support for this requires GnuTLS 3.6.3 or OpenSSL 1.1.1
29845 (or later).
29846
29847 Session resumption (this is the "stateless" variant) involves the server sending
29848 a "session ticket" to the client on one connection, which can be stored by the
29849 client and used for a later session.  The ticket contains sufficient state for
29850 the server to reconstruct the TLS session, avoiding some expensive crypto
29851 calculation and (on TLS1.2) one full packet roundtrip time.
29852
29853 .ilist
29854 Operational cost/benefit:
29855
29856  The extra data being transmitted costs a minor amount, and the client has
29857  extra costs in storing and retrieving the data.
29858
29859  In the Exim/Gnutls implementation the extra cost on an initial connection
29860  which is TLS1.2 over a loopback path is about 6ms on 2017-laptop class hardware.
29861  The saved cost on a subsequent connection is about 4ms; three or more
29862  connections become a net win.  On longer network paths, two or more
29863  connections will have an average lower startup time thanks to the one
29864  saved packet roundtrip.  TLS1.3 will save the crypto cpu costs but not any
29865  packet roundtrips.
29866
29867 .cindex "hints database" tls
29868  Since a new hints DB is used on the TLS client,
29869  the hints DB maintenance should be updated to additionally handle "tls".
29870
29871 .next
29872 Security aspects:
29873
29874  The session ticket is encrypted, but is obviously an additional security
29875  vulnarability surface.  An attacker able to decrypt it would have access
29876  all connections using the resumed session.
29877  The session ticket encryption key is not committed to storage by the server
29878  and is rotated regularly (OpenSSL: 1hr, and one previous key is used for
29879  overlap; GnuTLS 6hr but does not specify any overlap).
29880  Tickets have limited lifetime (2hr, and new ones issued after 1hr under
29881  OpenSSL.  GnuTLS 2hr, appears to not do overlap).
29882
29883  There is a question-mark over the security of the Diffie-Helman parameters
29884  used for session negotiation.
29885
29886 .next
29887 Observability:
29888
29889  The &%log_selector%& "tls_resumption" appends an asterisk to the tls_cipher "X="
29890  element.
29891
29892  The variables &$tls_in_resumption$& and &$tls_out_resumption$&
29893  have bits 0-4 indicating respectively
29894  support built, client requested ticket, client offered session,
29895  server issued ticket, resume used.  A suitable decode list is provided
29896  in the builtin macro _RESUME_DECODE for in &%listextract%& expansions.
29897
29898 .next
29899 Control:
29900
29901 The &%tls_resumption_hosts%& main option specifies a hostlist for which
29902 exim, operating as a server, will offer resumption to clients.
29903 Current best practice is to not offer the feature to MUA connection.
29904 Commonly this can be done like this:
29905 .code
29906 tls_resumption_hosts = ${if inlist {$received_port}{587:465} {:}{*}}
29907 .endd
29908 If the peer host matches the list after expansion then resumption
29909 is offered and/or accepted.
29910
29911 The &%tls_resumption_hosts%& smtp transport option performs the
29912 equivalent function for operation as a client.
29913 If the peer host matches the list after expansion then resumption
29914 is attempted (if a stored session is available) or the information
29915 stored (if supplied by the peer).
29916
29917
29918 .next
29919 Issues:
29920
29921  In a resumed session:
29922 .ilist
29923   The variables &$tls_{in,out}_cipher$& will have values different
29924  to the original (under GnuTLS).
29925 .next
29926   The variables &$tls_{in,out}_ocsp$& will be "not requested" or "no response",
29927  and the &%hosts_require_ocsp%& smtp trasnport option will fail.
29928 . XXX need to do something with that hosts_require_ocsp
29929 .endlist
29930
29931 .endlist
29932 .wen
29933
29934
29935 .section DANE "SECDANE"
29936 .cindex DANE
29937 DNS-based Authentication of Named Entities, as applied to SMTP over TLS, provides assurance to a client that
29938 it is actually talking to the server it wants to rather than some attacker operating a Man In The Middle (MITM)
29939 operation.  The latter can terminate the TLS connection you make, and make another one to the server (so both
29940 you and the server still think you have an encrypted connection) and, if one of the "well known" set of
29941 Certificate Authorities has been suborned - something which *has* been seen already (2014), a verifiable
29942 certificate (if you're using normal root CAs, eg. the Mozilla set, as your trust anchors).
29943
29944 What DANE does is replace the CAs with the DNS as the trust anchor.  The assurance is limited to a) the possibility
29945 that the DNS has been suborned, b) mistakes made by the admins of the target server.   The attack surface presented
29946 by (a) is thought to be smaller than that of the set of root CAs.
29947
29948 It also allows the server to declare (implicitly) that connections to it should use TLS.  An MITM could simply
29949 fail to pass on a server's STARTTLS.
29950
29951 DANE scales better than having to maintain (and communicate via side-channel) copies of server certificates
29952 for every possible target server.  It also scales (slightly) better than having to maintain on an SMTP
29953 client a copy of the standard CAs bundle.  It also means not having to pay a CA for certificates.
29954
29955 DANE requires a server operator to do three things: 1) run DNSSEC.  This provides assurance to clients
29956 that DNS lookups they do for the server have not been tampered with.  The domain MX record applying
29957 to this server, its A record, its TLSA record and any associated CNAME records must all be covered by
29958 DNSSEC.
29959 2) add TLSA DNS records.  These say what the server certificate for a TLS connection should be.
29960 3) offer a server certificate, or certificate chain, in TLS connections which is is anchored by one of the TLSA records.
29961
29962 There are no changes to Exim specific to server-side operation of DANE.
29963 Support for client-side operation of DANE can be included at compile time by defining SUPPORT_DANE=yes
29964 in &_Local/Makefile_&.
29965 If it has been included, the macro "_HAVE_DANE" will be defined.
29966
29967 A TLSA record consist of 4 fields, the "Certificate Usage", the
29968 "Selector", the "Matching type", and the "Certificate Association Data".
29969 For a detailed description of the TLSA record see
29970 &url(https://tools.ietf.org/html/rfc7671#page-5,RFC 7671).
29971
29972 The TLSA record for the server may have "Certificate Usage" (1st) field of DANE-TA(2) or DANE-EE(3).
29973 These are the "Trust Anchor" and "End Entity" variants.
29974 The latter specifies the End Entity directly, i.e. the certificate involved is that of the server
29975 (and if only DANE-EE is used then it should be the sole one transmitted during the TLS handshake);
29976 this is appropriate for a single system, using a self-signed certificate.
29977 DANE-TA usage is effectively declaring a specific CA to be used; this might be a private CA or a public,
29978 well-known one.
29979 A private CA at simplest is just a self-signed certificate (with certain
29980 attributes) which is used to sign server certificates, but running one securely
29981 does require careful arrangement.
29982 With DANE-TA, as implemented in Exim and commonly in other MTAs,
29983 the server TLS handshake must transmit the entire certificate chain from CA to server-certificate.
29984 DANE-TA is commonly used for several services and/or servers, each having a TLSA query-domain CNAME record,
29985 all of which point to a single TLSA record.
29986 DANE-TA and DANE-EE can both be used together.
29987
29988 Our recommendation is to use DANE with a certificate from a public CA,
29989 because this enables a variety of strategies for remote clients to verify
29990 your certificate.
29991 You can then publish information both via DANE and another technology,
29992 "MTA-STS", described below.
29993
29994 When you use DANE-TA to publish trust anchor information, you ask entities
29995 outside your administrative control to trust the Certificate Authority for
29996 connections to you.
29997 If using a private CA then you should expect others to still apply the
29998 technical criteria they'd use for a public CA to your certificates.
29999 In particular, you should probably try to follow current best practices for CA
30000 operation around hash algorithms and key sizes.
30001 Do not expect other organizations to lower their security expectations just
30002 because a particular profile might be reasonable for your own internal use.
30003
30004 When this text was last updated, this in practice means to avoid use of SHA-1
30005 and MD5; if using RSA to use key sizes of at least 2048 bits (and no larger
30006 than 4096, for interoperability); to use keyUsage fields correctly; to use
30007 random serial numbers.
30008 The list of requirements is subject to change as best practices evolve.
30009 If you're not already using a private CA, or it doesn't meet these
30010 requirements, then we encourage you to avoid all these issues and use a public
30011 CA such as &url(https://letsencrypt.org/,Let's Encrypt) instead.
30012
30013 The TLSA record should have a "Selector" (2nd) field of SPKI(1) and
30014 a "Matching Type" (3rd) field of SHA2-512(2).
30015
30016 For the "Certificate Authority Data" (4th) field, commands like
30017
30018 .code
30019   openssl x509 -pubkey -noout <certificate.pem \
30020   | openssl rsa -outform der -pubin 2>/dev/null \
30021   | openssl sha512 \
30022   | awk '{print $2}'
30023 .endd
30024
30025 are workable to create a hash of the certificate's public key.
30026
30027 An example TLSA record for DANE-EE(3), SPKI(1), and SHA-512 (2) looks like
30028
30029 .code
30030   _25._tcp.mail.example.com. TLSA 3 1 2 8BA8A336E...
30031 .endd
30032
30033 At the time of writing, &url(https://www.huque.com/bin/gen_tlsa)
30034 is useful for quickly generating TLSA records.
30035
30036
30037 For use with the DANE-TA model, server certificates must have a correct name (SubjectName or SubjectAltName).
30038
30039 The Certificate issued by the CA published in the DANE-TA model should be
30040 issued using a strong hash algorithm.
30041 Exim, and importantly various other MTAs sending to you, will not
30042 re-enable hash algorithms which have been disabled by default in TLS
30043 libraries.
30044 This means no MD5 and no SHA-1.  SHA2-256 is the minimum for reliable
30045 interoperability (and probably the maximum too, in 2018).
30046
30047 The use of OCSP-stapling should be considered, allowing for fast revocation of certificates (which would otherwise
30048 be limited by the DNS TTL on the TLSA records).  However, this is likely to only be usable with DANE-TA.  NOTE: the
30049 default of requesting OCSP for all hosts is modified iff DANE is in use, to:
30050
30051 .code
30052   hosts_request_ocsp = ${if or { {= {0}{$tls_out_tlsa_usage}} \
30053                                  {= {4}{$tls_out_tlsa_usage}} } \
30054                          {*}{}}
30055 .endd
30056
30057 The (new) variable &$tls_out_tlsa_usage$& is a bitfield with numbered bits set for TLSA record usage codes.
30058 The zero above means DANE was not in use, the four means that only DANE-TA usage TLSA records were
30059 found. If the definition of &%hosts_request_ocsp%& includes the
30060 string "tls_out_tlsa_usage", they are re-expanded in time to
30061 control the OCSP request.
30062
30063 This modification of hosts_request_ocsp is only done if it has the default value of "*".  Admins who change it, and
30064 those who use &%hosts_require_ocsp%&, should consider the interaction with DANE in their OCSP settings.
30065
30066
30067 For client-side DANE there are three new smtp transport options, &%hosts_try_dane%&, &%hosts_require_dane%&
30068 and &%dane_require_tls_ciphers%&.
30069 The &"require"& variant will result in failure if the target host is not
30070 DNSSEC-secured. To get DNSSEC-secured hostname resolution, use
30071 the &%dnssec_request_domains%& router or transport option.
30072
30073 DANE will only be usable if the target host has DNSSEC-secured MX, A and TLSA records.
30074
30075 A TLSA lookup will be done if either of the above options match and the host-lookup succeeded using dnssec.
30076 If a TLSA lookup is done and succeeds, a DANE-verified TLS connection
30077 will be required for the host.  If it does not, the host will not
30078 be used; there is no fallback to non-DANE or non-TLS.
30079
30080 If DANE is requested and usable, then the TLS cipher list configuration
30081 prefers to use the option &%dane_require_tls_ciphers%& and falls
30082 back to &%tls_require_ciphers%& only if that is unset.
30083 This lets you configure "decent crypto" for DANE and "better than nothing
30084 crypto" as the default.  Note though that while GnuTLS lets the string control
30085 which versions of TLS/SSL will be negotiated, OpenSSL does not and you're
30086 limited to ciphersuite constraints.
30087
30088 If DANE is requested and useable (see above) the following transport options are ignored:
30089 .code
30090   hosts_require_tls
30091   tls_verify_hosts
30092   tls_try_verify_hosts
30093   tls_verify_certificates
30094   tls_crl
30095   tls_verify_cert_hostnames
30096   tls_sni
30097 .endd
30098
30099 If DANE is not usable, whether requested or not, and CA-anchored
30100 verification evaluation is wanted, the above variables should be set appropriately.
30101
30102 The router and transport option &%dnssec_request_domains%& must not be
30103 set to &"never"&, and &%dnssec_require_domains%& is ignored.
30104
30105 If verification was successful using DANE then the "CV" item in the delivery log line will show as "CV=dane".
30106
30107 There is a new variable &$tls_out_dane$& which will have "yes" if
30108 verification succeeded using DANE and "no" otherwise (only useful
30109 in combination with events; see &<<CHAPevents>>&),
30110 and a new variable &$tls_out_tlsa_usage$& (detailed above).
30111
30112 .cindex DANE reporting
30113 An event (see &<<CHAPevents>>&) of type "dane:fail" will be raised on failures
30114 to achieve DANE-verified connection, if one was either requested and offered, or
30115 required.  This is intended to support TLS-reporting as defined in
30116 &url(https://tools.ietf.org/html/draft-ietf-uta-smtp-tlsrpt-17).
30117 The &$event_data$& will be one of the Result Types defined in
30118 Section 4.3 of that document.
30119
30120 Under GnuTLS, DANE is only supported from version 3.0.0 onwards.
30121
30122 DANE is specified in published RFCs and decouples certificate authority trust
30123 selection from a "race to the bottom" of "you must trust everything for mail
30124 to get through".  There is an alternative technology called MTA-STS, which
30125 instead publishes MX trust anchor information on an HTTPS website.  At the
30126 time this text was last updated, MTA-STS was still a draft, not yet an RFC.
30127 Exim has no support for MTA-STS as a client, but Exim mail server operators
30128 can choose to publish information describing their TLS configuration using
30129 MTA-STS to let those clients who do use that protocol derive trust
30130 information.
30131
30132 The MTA-STS design requires a certificate from a public Certificate Authority
30133 which is recognized by clients sending to you.
30134 That selection of which CAs are trusted by others is outside your control.
30135
30136 The most interoperable course of action is probably to use
30137 &url(https://letsencrypt.org/,Let's Encrypt), with automated certificate
30138 renewal; to publish the anchor information in DNSSEC-secured DNS via TLSA
30139 records for DANE clients (such as Exim and Postfix) and to publish anchor
30140 information for MTA-STS as well.  This is what is done for the &'exim.org'&
30141 domain itself (with caveats around occasionally broken MTA-STS because of
30142 incompatible specification changes prior to reaching RFC status).
30143
30144
30145
30146 . ////////////////////////////////////////////////////////////////////////////
30147 . ////////////////////////////////////////////////////////////////////////////
30148
30149 .chapter "Access control lists" "CHAPACL"
30150 .scindex IIDacl "&ACL;" "description"
30151 .cindex "control of incoming mail"
30152 .cindex "message" "controlling incoming"
30153 .cindex "policy control" "access control lists"
30154 Access Control Lists (ACLs) are defined in a separate section of the runtime
30155 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
30156 name, terminated by a colon. Here is a complete ACL section that contains just
30157 one very small ACL:
30158 .code
30159 begin acl
30160 small_acl:
30161   accept   hosts = one.host.only
30162 .endd
30163 You can have as many lists as you like in the ACL section, and the order in
30164 which they appear does not matter. The lists are self-terminating.
30165
30166 The majority of ACLs are used to control Exim's behaviour when it receives
30167 certain SMTP commands. This applies both to incoming TCP/IP connections, and
30168 when a local process submits a message using SMTP by specifying the &%-bs%&
30169 option. The most common use is for controlling which recipients are accepted
30170 in incoming messages. In addition, you can define an ACL that is used to check
30171 local non-SMTP messages. The default configuration file contains an example of
30172 a realistic ACL for checking RCPT commands. This is discussed in chapter
30173 &<<CHAPdefconfil>>&.
30174
30175
30176 .section "Testing ACLs" "SECID188"
30177 The &%-bh%& command line option provides a way of testing your ACL
30178 configuration locally by running a fake SMTP session with which you interact.
30179
30180
30181 .section "Specifying when ACLs are used" "SECID189"
30182 .cindex "&ACL;" "options for specifying"
30183 In order to cause an ACL to be used, you have to name it in one of the relevant
30184 options in the main part of the configuration. These options are:
30185 .cindex "AUTH" "ACL for"
30186 .cindex "DATA" "ACLs for"
30187 .cindex "ETRN" "ACL for"
30188 .cindex "EXPN" "ACL for"
30189 .cindex "HELO" "ACL for"
30190 .cindex "EHLO" "ACL for"
30191 .cindex "DKIM" "ACL for"
30192 .cindex "MAIL" "ACL for"
30193 .cindex "QUIT, ACL for"
30194 .cindex "RCPT" "ACL for"
30195 .cindex "STARTTLS, ACL for"
30196 .cindex "VRFY" "ACL for"
30197 .cindex "SMTP" "connection, ACL for"
30198 .cindex "non-SMTP messages" "ACLs for"
30199 .cindex "MIME content scanning" "ACL for"
30200 .cindex "PRDR" "ACL for"
30201
30202 .table2 140pt
30203 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
30204 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
30205 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
30206 .irow &%acl_smtp_auth%&        "ACL for AUTH"
30207 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
30208 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
30209 .irow &%acl_smtp_data_prdr%&   "ACL for each recipient, after DATA is complete"
30210 .irow &%acl_smtp_dkim%&        "ACL for each DKIM signer"
30211 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
30212 .irow &%acl_smtp_expn%&        "ACL for EXPN"
30213 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
30214 .irow &%acl_smtp_mail%&        "ACL for MAIL"
30215 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
30216 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
30217 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
30218 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
30219 .irow &%acl_smtp_quit%&        "ACL for QUIT"
30220 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
30221 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
30222 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
30223 .endtable
30224
30225 For example, if you set
30226 .code
30227 acl_smtp_rcpt = small_acl
30228 .endd
30229 the little ACL defined above is used whenever Exim receives a RCPT command
30230 in an SMTP dialogue. The majority of policy tests on incoming messages can be
30231 done when RCPT commands arrive. A rejection of RCPT should cause the
30232 sending MTA to give up on the recipient address contained in the RCPT
30233 command, whereas rejection at other times may cause the client MTA to keep on
30234 trying to deliver the message. It is therefore recommended that you do as much
30235 testing as possible at RCPT time.
30236
30237
30238 .section "The non-SMTP ACLs" "SECID190"
30239 .cindex "non-SMTP messages" "ACLs for"
30240 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
30241 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
30242 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
30243 the state of the SMTP connection such as encryption and authentication) are not
30244 relevant and are forbidden in these ACLs. However, the sender and recipients
30245 are known, so the &%senders%& and &%sender_domains%& conditions and the
30246 &$sender_address$& and &$recipients$& variables can be used. Variables such as
30247 &$authenticated_sender$& are also available. You can specify added header lines
30248 in any of these ACLs.
30249
30250 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
30251 non-SMTP message, before any of the message has been read. (This is the
30252 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
30253 batched SMTP input, it runs after the DATA command has been reached. The
30254 result of this ACL is ignored; it cannot be used to reject a message. If you
30255 really need to, you could set a value in an ACL variable here and reject based
30256 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
30257 controls, and in particular, it can be used to set
30258 .code
30259 control = suppress_local_fixups
30260 .endd
30261 This cannot be used in the other non-SMTP ACLs because by the time they are
30262 run, it is too late.
30263
30264 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
30265 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
30266
30267 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
30268 kind of rejection is treated as permanent, because there is no way of sending a
30269 temporary error for these kinds of message.
30270
30271
30272 .section "The SMTP connect ACL" "SECID191"
30273 .cindex "SMTP" "connection, ACL for"
30274 .oindex &%smtp_banner%&
30275 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
30276 session, after the test specified by &%host_reject_connection%& (which is now
30277 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
30278 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
30279 the message override the banner message that is otherwise specified by the
30280 &%smtp_banner%& option.
30281
30282
30283 .section "The EHLO/HELO ACL" "SECID192"
30284 .cindex "EHLO" "ACL for"
30285 .cindex "HELO" "ACL for"
30286 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
30287 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
30288 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
30289 Note that a client may issue more than one EHLO or HELO command in an SMTP
30290 session, and indeed is required to issue a new EHLO or HELO after successfully
30291 setting up encryption following a STARTTLS command.
30292
30293 Note also that a deny neither forces the client to go away nor means that
30294 mail will be refused on the connection.  Consider checking for
30295 &$sender_helo_name$& being defined in a MAIL or RCPT ACL to do that.
30296
30297 If the command is accepted by an &%accept%& verb that has a &%message%&
30298 modifier, the message may not contain more than one line (it will be truncated
30299 at the first newline and a panic logged if it does). Such a message cannot
30300 affect the EHLO options that are listed on the second and subsequent lines of
30301 an EHLO response.
30302
30303
30304 .section "The DATA ACLs" "SECID193"
30305 .cindex "DATA" "ACLs for"
30306 Two ACLs are associated with the DATA command, because it is two-stage
30307 command, with two responses being sent to the client.
30308 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
30309 is obeyed. This gives you control after all the RCPT commands, but before
30310 the message itself is received. It offers the opportunity to give a negative
30311 response to the DATA command before the data is transmitted. Header lines
30312 added by MAIL or RCPT ACLs are not visible at this time, but any that
30313 are defined here are visible when the &%acl_smtp_data%& ACL is run.
30314
30315 You cannot test the contents of the message, for example, to verify addresses
30316 in the headers, at RCPT time or when the DATA command is received. Such
30317 tests have to appear in the ACL that is run after the message itself has been
30318 received, before the final response to the DATA command is sent. This is
30319 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
30320 associated with the DATA command.
30321
30322 .cindex CHUNKING "BDAT command"
30323 .cindex BDAT "SMTP command"
30324 .cindex "RFC 3030" CHUNKING
30325 If CHUNKING was advertised and a BDAT command sequence is received,
30326 the &%acl_smtp_predata%& ACL is not run.
30327 . XXX why not?  It should be possible, for the first BDAT.
30328 The &%acl_smtp_data%& is run after the last BDAT command and all of
30329 the data specified is received.
30330
30331 For both of these ACLs, it is not possible to reject individual recipients. An
30332 error response rejects the entire message. Unfortunately, it is known that some
30333 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
30334 before or after the data) correctly &-- they keep the message on their queues
30335 and try again later, but that is their problem, though it does waste some of
30336 your resources.
30337
30338 The &%acl_smtp_data%& ACL is run after
30339 the &%acl_smtp_data_prdr%&,
30340 the &%acl_smtp_dkim%&
30341 and the &%acl_smtp_mime%& ACLs.
30342
30343 .section "The SMTP DKIM ACL" "SECTDKIMACL"
30344 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
30345 enabled (which is the default).
30346
30347 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
30348 received, and is executed for each DKIM signature found in a message.  If not
30349 otherwise specified, the default action is to accept.
30350
30351 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
30352
30353 For details on the operation of DKIM, see section &<<SECDKIM>>&.
30354
30355
30356 .section "The SMTP MIME ACL" "SECID194"
30357 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
30358 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
30359
30360 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
30361
30362
30363 .section "The SMTP PRDR ACL" "SECTPRDRACL"
30364 .cindex "PRDR" "ACL for"
30365 .oindex "&%prdr_enable%&"
30366 The &%acl_smtp_data_prdr%& ACL is available only when Exim is compiled
30367 with PRDR support enabled (which is the default).
30368 It becomes active only when the PRDR feature is negotiated between
30369 client and server for a message, and more than one recipient
30370 has been accepted.
30371
30372 The ACL test specified by &%acl_smtp_data_prdr%& happens after a message
30373 has been received, and is executed once for each recipient of the message
30374 with &$local_part$& and &$domain$& valid.
30375 The test may accept, defer or deny for individual recipients.
30376 The &%acl_smtp_data%& will still be called after this ACL and
30377 can reject the message overall, even if this ACL has accepted it
30378 for some or all recipients.
30379
30380 PRDR may be used to support per-user content filtering.  Without it
30381 one must defer any recipient after the first that has a different
30382 content-filter configuration.  With PRDR, the RCPT-time check
30383 .cindex "PRDR" "variable for"
30384 for this can be disabled when the variable &$prdr_requested$&
30385 is &"yes"&.
30386 Any required difference in behaviour of the main DATA-time
30387 ACL should however depend on the PRDR-time ACL having run, as Exim
30388 will avoid doing so in some situations (e.g. single-recipient mails).
30389
30390 See also the &%prdr_enable%& global option
30391 and the &%hosts_try_prdr%& smtp transport option.
30392
30393 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
30394 If the ACL is not defined, processing completes as if
30395 the feature was not requested by the client.
30396
30397 .section "The QUIT ACL" "SECTQUITACL"
30398 .cindex "QUIT, ACL for"
30399 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
30400 does not affect the response code to QUIT, which is always 221. Thus, the ACL
30401 does not in fact control any access.
30402 For this reason, it may only accept
30403 or warn as its final result.
30404
30405 This ACL can be used for tasks such as custom logging at the end of an SMTP
30406 session. For example, you can use ACL variables in other ACLs to count
30407 messages, recipients, etc., and log the totals at QUIT time using one or
30408 more &%logwrite%& modifiers on a &%warn%& verb.
30409
30410 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
30411 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
30412
30413 You do not need to have a final &%accept%&, but if you do, you can use a
30414 &%message%& modifier to specify custom text that is sent as part of the 221
30415 response to QUIT.
30416
30417 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
30418 failure (for example, failure to open a log file, or when Exim is bombing out
30419 because it has detected an unrecoverable error), all SMTP commands from the
30420 client are given temporary error responses until QUIT is received or the
30421 connection is closed. In these special cases, the QUIT ACL does not run.
30422
30423
30424 .section "The not-QUIT ACL" "SECTNOTQUITACL"
30425 .vindex &$acl_smtp_notquit$&
30426 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
30427 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
30428 trouble, such as being unable to write to its log files, this ACL is not run,
30429 because it might try to do things (such as write to log files) that make the
30430 situation even worse.
30431
30432 Like the QUIT ACL, this ACL is provided to make it possible to do customized
30433 logging or to gather statistics, and its outcome is ignored. The &%delay%&
30434 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
30435 and &%warn%&.
30436
30437 .vindex &$smtp_notquit_reason$&
30438 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
30439 to a string that indicates the reason for the termination of the SMTP
30440 connection. The possible values are:
30441 .table2
30442 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
30443 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
30444 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
30445 .irow &`connection-lost`&          "The SMTP connection has been lost"
30446 .irow &`data-timeout`&             "Timeout while reading message data"
30447 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
30448 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
30449 .irow &`signal-exit`&              "SIGTERM or SIGINT"
30450 .irow &`synchronization-error`&    "SMTP synchronization error"
30451 .irow &`tls-failed`&               "TLS failed to start"
30452 .endtable
30453 In most cases when an SMTP connection is closed without having received QUIT,
30454 Exim sends an SMTP response message before actually closing the connection.
30455 With the exception of the &`acl-drop`& case, the default message can be
30456 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
30457 &%drop%& verb in another ACL, it is the message from the other ACL that is
30458 used.
30459
30460
30461 .section "Finding an ACL to use" "SECID195"
30462 .cindex "&ACL;" "finding which to use"
30463 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
30464 you can use different ACLs in different circumstances. For example,
30465 .code
30466 acl_smtp_rcpt = ${if ={25}{$interface_port} \
30467                      {acl_check_rcpt} {acl_check_rcpt_submit} }
30468 .endd
30469 In the default configuration file there are some example settings for
30470 providing an RFC 4409 message &"submission"& service on port 587 and
30471 an RFC 8314 &"submissions"& service on port 465. You can use a string
30472 expansion like this to choose an ACL for MUAs on these ports which is
30473 more appropriate for this purpose than the default ACL on port 25.
30474
30475 The expanded string does not have to be the name of an ACL in the
30476 configuration file; there are other possibilities. Having expanded the
30477 string, Exim searches for an ACL as follows:
30478
30479 .ilist
30480 If the string begins with a slash, Exim uses it as a filename, and reads its
30481 contents as an ACL. The lines are processed in the same way as lines in the
30482 Exim configuration file. In particular, continuation lines are supported, blank
30483 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
30484 If the file does not exist or cannot be read, an error occurs (typically
30485 causing a temporary failure of whatever caused the ACL to be run). For example:
30486 .code
30487 acl_smtp_data = /etc/acls/\
30488   ${lookup{$sender_host_address}lsearch\
30489   {/etc/acllist}{$value}{default}}
30490 .endd
30491 This looks up an ACL file to use on the basis of the host's IP address, falling
30492 back to a default if the lookup fails. If an ACL is successfully read from a
30493 file, it is retained in memory for the duration of the Exim process, so that it
30494 can be re-used without having to re-read the file.
30495 .next
30496 If the string does not start with a slash, and does not contain any spaces,
30497 Exim searches the ACL section of the configuration for an ACL whose name
30498 matches the string.
30499 .next
30500 If no named ACL is found, or if the string contains spaces, Exim parses
30501 the string as an inline ACL. This can save typing in cases where you just
30502 want to have something like
30503 .code
30504 acl_smtp_vrfy = accept
30505 .endd
30506 in order to allow free use of the VRFY command. Such a string may contain
30507 newlines; it is processed in the same way as an ACL that is read from a file.
30508 .endlist
30509
30510
30511
30512
30513 .section "ACL return codes" "SECID196"
30514 .cindex "&ACL;" "return codes"
30515 Except for the QUIT ACL, which does not affect the SMTP return code (see
30516 section &<<SECTQUITACL>>& above), the result of running an ACL is either
30517 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
30518 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
30519 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
30520 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
30521 This also causes a 4&'xx'& return code.
30522
30523 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
30524 &"deny"&, because there is no mechanism for passing temporary errors to the
30525 submitters of non-SMTP messages.
30526
30527
30528 ACLs that are relevant to message reception may also return &"discard"&. This
30529 has the effect of &"accept"&, but causes either the entire message or an
30530 individual recipient address to be discarded. In other words, it is a
30531 blackholing facility. Use it with care.
30532
30533 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
30534 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
30535 RCPT ACL is to discard just the one recipient address. If there are no
30536 recipients left when the message's data is received, the DATA ACL is not
30537 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
30538 remaining recipients. The &"discard"& return is not permitted for the
30539 &%acl_smtp_predata%& ACL.
30540
30541 If the ACL for VRFY returns &"accept"&, a recipient verify (without callout)
30542 is done on the address and the result determines the SMTP response.
30543
30544
30545 .cindex "&[local_scan()]& function" "when all recipients discarded"
30546 The &[local_scan()]& function is always run, even if there are no remaining
30547 recipients; it may create new recipients.
30548
30549
30550
30551 .section "Unset ACL options" "SECID197"
30552 .cindex "&ACL;" "unset options"
30553 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
30554 all the same. &*Note*&: These defaults apply only when the relevant ACL is
30555 not defined at all. For any defined ACL, the default action when control
30556 reaches the end of the ACL statements is &"deny"&.
30557
30558 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
30559 these two are ACLs that are used only for their side effects. They cannot be
30560 used to accept or reject anything.
30561
30562 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
30563 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
30564 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
30565 when the ACL is not defined is &"accept"&.
30566
30567 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
30568 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
30569 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
30570 messages over an SMTP connection. For an example, see the ACL in the default
30571 configuration file.
30572
30573
30574
30575
30576 .section "Data for message ACLs" "SECID198"
30577 .cindex "&ACL;" "data for message ACL"
30578 .vindex &$domain$&
30579 .vindex &$local_part$&
30580 .vindex &$sender_address$&
30581 .vindex &$sender_host_address$&
30582 .vindex &$smtp_command$&
30583 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
30584 that contain information about the host and the message's sender (for example,
30585 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
30586 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
30587 &$local_part$& are set from the argument address. The entire SMTP command
30588 is available in &$smtp_command$&.
30589
30590 When an ACL for the AUTH parameter of MAIL is running, the variables that
30591 contain information about the host are set, but &$sender_address$& is not yet
30592 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
30593 how it is used.
30594
30595 .vindex "&$message_size$&"
30596 The &$message_size$& variable is set to the value of the SIZE parameter on
30597 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
30598 that parameter is not given. The value is updated to the true message size by
30599 the time the final DATA ACL is run (after the message data has been
30600 received).
30601
30602 .vindex "&$rcpt_count$&"
30603 .vindex "&$recipients_count$&"
30604 The &$rcpt_count$& variable increases by one for each RCPT command received.
30605 The &$recipients_count$& variable increases by one each time a RCPT command is
30606 accepted, so while an ACL for RCPT is being processed, it contains the number
30607 of previously accepted recipients. At DATA time (for both the DATA ACLs),
30608 &$rcpt_count$& contains the total number of RCPT commands, and
30609 &$recipients_count$& contains the total number of accepted recipients.
30610
30611
30612
30613
30614
30615 .section "Data for non-message ACLs" "SECTdatfornon"
30616 .cindex "&ACL;" "data for non-message ACL"
30617 .vindex &$smtp_command_argument$&
30618 .vindex &$smtp_command$&
30619 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
30620 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
30621 and the entire SMTP command is available in &$smtp_command$&.
30622 These variables can be tested using a &%condition%& condition. For example,
30623 here is an ACL for use with AUTH, which insists that either the session is
30624 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
30625 does not permit authentication methods that use cleartext passwords on
30626 unencrypted connections.
30627 .code
30628 acl_check_auth:
30629   accept encrypted = *
30630   accept condition = ${if eq{${uc:$smtp_command_argument}}\
30631                      {CRAM-MD5}}
30632   deny   message   = TLS encryption or CRAM-MD5 required
30633 .endd
30634 (Another way of applying this restriction is to arrange for the authenticators
30635 that use cleartext passwords not to be advertised when the connection is not
30636 encrypted. You can use the generic &%server_advertise_condition%& authenticator
30637 option to do this.)
30638
30639
30640
30641 .section "Format of an ACL" "SECID199"
30642 .cindex "&ACL;" "format of"
30643 .cindex "&ACL;" "verbs, definition of"
30644 An individual ACL consists of a number of statements. Each statement starts
30645 with a verb, optionally followed by a number of conditions and &"modifiers"&.
30646 Modifiers can change the way the verb operates, define error and log messages,
30647 set variables, insert delays, and vary the processing of accepted messages.
30648
30649 If all the conditions are met, the verb is obeyed. The same condition may be
30650 used (with different arguments) more than once in the same statement. This
30651 provides a means of specifying an &"and"& conjunction between conditions. For
30652 example:
30653 .code
30654 deny  dnslists = list1.example
30655       dnslists = list2.example
30656 .endd
30657 If there are no conditions, the verb is always obeyed. Exim stops evaluating
30658 the conditions and modifiers when it reaches a condition that fails. What
30659 happens then depends on the verb (and in one case, on a special modifier). Not
30660 all the conditions make sense at every testing point. For example, you cannot
30661 test a sender address in the ACL that is run for a VRFY command.
30662
30663
30664 .section "ACL verbs" "SECID200"
30665 The ACL verbs are as follows:
30666
30667 .ilist
30668 .cindex "&%accept%& ACL verb"
30669 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
30670 of the conditions are not met, what happens depends on whether &%endpass%&
30671 appears among the conditions (for syntax see below). If the failing condition
30672 is before &%endpass%&, control is passed to the next ACL statement; if it is
30673 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
30674 check a RCPT command:
30675 .code
30676 accept domains = +local_domains
30677        endpass
30678        verify = recipient
30679 .endd
30680 If the recipient domain does not match the &%domains%& condition, control
30681 passes to the next statement. If it does match, the recipient is verified, and
30682 the command is accepted if verification succeeds. However, if verification
30683 fails, the ACL yields &"deny"&, because the failing condition is after
30684 &%endpass%&.
30685
30686 The &%endpass%& feature has turned out to be confusing to many people, so its
30687 use is not recommended nowadays. It is always possible to rewrite an ACL so
30688 that &%endpass%& is not needed, and it is no longer used in the default
30689 configuration.
30690
30691 .cindex "&%message%& ACL modifier" "with &%accept%&"
30692 If a &%message%& modifier appears on an &%accept%& statement, its action
30693 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
30694 (when an &%accept%& verb either accepts or passes control to the next
30695 statement), &%message%& can be used to vary the message that is sent when an
30696 SMTP command is accepted. For example, in a RCPT ACL you could have:
30697 .display
30698 &`accept  `&<&'some conditions'&>
30699 &`        message = OK, I will allow you through today`&
30700 .endd
30701 You can specify an SMTP response code, optionally followed by an &"extended
30702 response code"& at the start of the message, but the first digit must be the
30703 same as would be sent by default, which is 2 for an &%accept%& verb.
30704
30705 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
30706 an error message that is used when access is denied. This behaviour is retained
30707 for backward compatibility, but current &"best practice"& is to avoid the use
30708 of &%endpass%&.
30709
30710
30711 .next
30712 .cindex "&%defer%& ACL verb"
30713 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
30714 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
30715 &%defer%& is the same as &%deny%&, because there is no way of sending a
30716 temporary error. For a RCPT command, &%defer%& is much the same as using a
30717 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
30718 be used in any ACL, and even for a recipient it might be a simpler approach.
30719
30720
30721 .next
30722 .cindex "&%deny%& ACL verb"
30723 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
30724 the conditions are not met, control is passed to the next ACL statement. For
30725 example,
30726 .code
30727 deny dnslists = blackholes.mail-abuse.org
30728 .endd
30729 rejects commands from hosts that are on a DNS black list.
30730
30731
30732 .next
30733 .cindex "&%discard%& ACL verb"
30734 &%discard%&: This verb behaves like &%accept%&, except that it returns
30735 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
30736 that are concerned with receiving messages. When all the conditions are true,
30737 the sending entity receives a &"success"& response. However, &%discard%& causes
30738 recipients to be discarded. If it is used in an ACL for RCPT, just the one
30739 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
30740 message's recipients are discarded. Recipients that are discarded before DATA
30741 do not appear in the log line when the &%received_recipients%& log selector is set.
30742
30743 If the &%log_message%& modifier is set when &%discard%& operates,
30744 its contents are added to the line that is automatically written to the log.
30745 The &%message%& modifier operates exactly as it does for &%accept%&.
30746
30747
30748 .next
30749 .cindex "&%drop%& ACL verb"
30750 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
30751 forcibly closed after the 5&'xx'& error message has been sent. For example:
30752 .code
30753 drop   condition = ${if > {$rcpt_count}{20}}
30754        message   = I don't take more than 20 RCPTs
30755 .endd
30756 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
30757 The connection is always dropped after sending a 550 response.
30758
30759 .next
30760 .cindex "&%require%& ACL verb"
30761 &%require%&: If all the conditions are met, control is passed to the next ACL
30762 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
30763 example, when checking a RCPT command,
30764 .code
30765 require message = Sender did not verify
30766         verify  = sender
30767 .endd
30768 passes control to subsequent statements only if the message's sender can be
30769 verified. Otherwise, it rejects the command. Note the positioning of the
30770 &%message%& modifier, before the &%verify%& condition. The reason for this is
30771 discussed in section &<<SECTcondmodproc>>&.
30772
30773 .next
30774 .cindex "&%warn%& ACL verb"
30775 &%warn%&: If all the conditions are true, a line specified by the
30776 &%log_message%& modifier is written to Exim's main log. Control always passes
30777 to the next ACL statement. If any condition is false, the log line is not
30778 written. If an identical log line is requested several times in the same
30779 message, only one copy is actually written to the log. If you want to force
30780 duplicates to be written, use the &%logwrite%& modifier instead.
30781
30782 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
30783 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
30784 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
30785 first failing condition. There is more about adding header lines in section
30786 &<<SECTaddheadacl>>&.
30787
30788 If any condition on a &%warn%& statement cannot be completed (that is, there is
30789 some sort of defer), the log line specified by &%log_message%& is not written.
30790 This does not include the case of a forced failure from a lookup, which
30791 is considered to be a successful completion. After a defer, no further
30792 conditions or modifiers in the &%warn%& statement are processed. The incident
30793 is logged, and the ACL continues to be processed, from the next statement
30794 onwards.
30795
30796
30797 .vindex "&$acl_verify_message$&"
30798 When one of the &%warn%& conditions is an address verification that fails, the
30799 text of the verification failure message is in &$acl_verify_message$&. If you
30800 want this logged, you must set it up explicitly. For example:
30801 .code
30802 warn   !verify = sender
30803        log_message = sender verify failed: $acl_verify_message
30804 .endd
30805 .endlist
30806
30807 At the end of each ACL there is an implicit unconditional &%deny%&.
30808
30809 As you can see from the examples above, the conditions and modifiers are
30810 written one to a line, with the first one on the same line as the verb, and
30811 subsequent ones on following lines. If you have a very long condition, you can
30812 continue it onto several physical lines by the usual backslash continuation
30813 mechanism. It is conventional to align the conditions vertically.
30814
30815
30816
30817 .section "ACL variables" "SECTaclvariables"
30818 .cindex "&ACL;" "variables"
30819 There are some special variables that can be set during ACL processing. They
30820 can be used to pass information between different ACLs, different invocations
30821 of the same ACL in the same SMTP connection, and between ACLs and the routers,
30822 transports, and filters that are used to deliver a message. The names of these
30823 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
30824 an underscore, but the remainder of the name can be any sequence of
30825 alphanumeric characters and underscores that you choose. There is no limit on
30826 the number of ACL variables. The two sets act as follows:
30827 .ilist
30828 The values of those variables whose names begin with &$acl_c$& persist
30829 throughout an SMTP connection. They are never reset. Thus, a value that is set
30830 while receiving one message is still available when receiving the next message
30831 on the same SMTP connection.
30832 .next
30833 The values of those variables whose names begin with &$acl_m$& persist only
30834 while a message is being received. They are reset afterwards. They are also
30835 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
30836 .endlist
30837
30838 When a message is accepted, the current values of all the ACL variables are
30839 preserved with the message and are subsequently made available at delivery
30840 time. The ACL variables are set by a modifier called &%set%&. For example:
30841 .code
30842 accept hosts = whatever
30843        set acl_m4 = some value
30844 accept authenticated = *
30845        set acl_c_auth = yes
30846 .endd
30847 &*Note*&: A leading dollar sign is not used when naming a variable that is to
30848 be set. If you want to set a variable without taking any action, you can use a
30849 &%warn%& verb without any other modifiers or conditions.
30850
30851 .oindex &%strict_acl_vars%&
30852 What happens if a syntactically valid but undefined ACL variable is
30853 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
30854 false (the default), an empty string is substituted; if it is true, an
30855 error is generated.
30856
30857 Versions of Exim before 4.64 have a limited set of numbered variables, but
30858 their names are compatible, so there is no problem with upgrading.
30859
30860
30861 .section "Condition and modifier processing" "SECTcondmodproc"
30862 .cindex "&ACL;" "conditions; processing"
30863 .cindex "&ACL;" "modifiers; processing"
30864 An exclamation mark preceding a condition negates its result. For example:
30865 .code
30866 deny   domains = *.dom.example
30867       !verify  = recipient
30868 .endd
30869 causes the ACL to return &"deny"& if the recipient domain ends in
30870 &'dom.example'& and the recipient address cannot be verified. Sometimes
30871 negation can be used on the right-hand side of a condition. For example, these
30872 two statements are equivalent:
30873 .code
30874 deny  hosts = !192.168.3.4
30875 deny !hosts =  192.168.3.4
30876 .endd
30877 However, for many conditions (&%verify%& being a good example), only left-hand
30878 side negation of the whole condition is possible.
30879
30880 The arguments of conditions and modifiers are expanded. A forced failure
30881 of an expansion causes a condition to be ignored, that is, it behaves as if the
30882 condition is true. Consider these two statements:
30883 .code
30884 accept  senders = ${lookup{$host_name}lsearch\
30885                   {/some/file}{$value}fail}
30886 accept  senders = ${lookup{$host_name}lsearch\
30887                   {/some/file}{$value}{}}
30888 .endd
30889 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
30890 the returned list is searched, but if the lookup fails the behaviour is
30891 different in the two cases. The &%fail%& in the first statement causes the
30892 condition to be ignored, leaving no further conditions. The &%accept%& verb
30893 therefore succeeds. The second statement, however, generates an empty list when
30894 the lookup fails. No sender can match an empty list, so the condition fails,
30895 and therefore the &%accept%& also fails.
30896
30897 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
30898 specify actions that are taken as the conditions for a statement are checked;
30899 others specify text for messages that are used when access is denied or a
30900 warning is generated. The &%control%& modifier affects the way an incoming
30901 message is handled.
30902
30903 The positioning of the modifiers in an ACL statement is important, because the
30904 processing of a verb ceases as soon as its outcome is known. Only those
30905 modifiers that have already been encountered will take effect. For example,
30906 consider this use of the &%message%& modifier:
30907 .code
30908 require message = Can't verify sender
30909         verify  = sender
30910         message = Can't verify recipient
30911         verify  = recipient
30912         message = This message cannot be used
30913 .endd
30914 If sender verification fails, Exim knows that the result of the statement is
30915 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
30916 so its text is used as the error message. If sender verification succeeds, but
30917 recipient verification fails, the second message is used. If recipient
30918 verification succeeds, the third message becomes &"current"&, but is never used
30919 because there are no more conditions to cause failure.
30920
30921 For the &%deny%& verb, on the other hand, it is always the last &%message%&
30922 modifier that is used, because all the conditions must be true for rejection to
30923 happen. Specifying more than one &%message%& modifier does not make sense, and
30924 the message can even be specified after all the conditions. For example:
30925 .code
30926 deny   hosts = ...
30927       !senders = *@my.domain.example
30928        message = Invalid sender from client host
30929 .endd
30930 The &"deny"& result does not happen until the end of the statement is reached,
30931 by which time Exim has set up the message.
30932
30933
30934
30935 .section "ACL modifiers" "SECTACLmodi"
30936 .cindex "&ACL;" "modifiers; list of"
30937 The ACL modifiers are as follows:
30938
30939 .vlist
30940 .vitem &*add_header*&&~=&~<&'text'&>
30941 This modifier specifies one or more header lines that are to be added to an
30942 incoming message, assuming, of course, that the message is ultimately
30943 accepted. For details, see section &<<SECTaddheadacl>>&.
30944
30945 .vitem &*continue*&&~=&~<&'text'&>
30946 .cindex "&%continue%& ACL modifier"
30947 .cindex "database" "updating in ACL"
30948 This modifier does nothing of itself, and processing of the ACL always
30949 continues with the next condition or modifier. The value of &%continue%& is in
30950 the side effects of expanding its argument. Typically this could be used to
30951 update a database. It is really just a syntactic tidiness, to avoid having to
30952 write rather ugly lines like this:
30953 .display
30954 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
30955 .endd
30956 Instead, all you need is
30957 .display
30958 &`continue = `&<&'some expansion'&>
30959 .endd
30960
30961 .vitem &*control*&&~=&~<&'text'&>
30962 .cindex "&%control%& ACL modifier"
30963 This modifier affects the subsequent processing of the SMTP connection or of an
30964 incoming message that is accepted. The effect of the first type of control
30965 lasts for the duration of the connection, whereas the effect of the second type
30966 lasts only until the current message has been received. The message-specific
30967 controls always apply to the whole message, not to individual recipients,
30968 even if the &%control%& modifier appears in a RCPT ACL.
30969
30970 As there are now quite a few controls that can be applied, they are described
30971 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
30972 in several different ways. For example:
30973
30974 . ==== As this is a nested list, any displays it contains must be indented
30975 . ==== as otherwise they are too far to the left. That comment applies only
30976 . ==== when xmlto and fop are used; formatting with sdop gets it right either
30977 . ==== way.
30978
30979 .ilist
30980 It can be at the end of an &%accept%& statement:
30981 .code
30982     accept  ...some conditions
30983             control = queue
30984 .endd
30985 In this case, the control is applied when this statement yields &"accept"&, in
30986 other words, when the conditions are all true.
30987
30988 .next
30989 It can be in the middle of an &%accept%& statement:
30990 .code
30991     accept  ...some conditions...
30992             control = queue
30993             ...some more conditions...
30994 .endd
30995 If the first set of conditions are true, the control is applied, even if the
30996 statement does not accept because one of the second set of conditions is false.
30997 In this case, some subsequent statement must yield &"accept"& for the control
30998 to be relevant.
30999
31000 .next
31001 It can be used with &%warn%& to apply the control, leaving the
31002 decision about accepting or denying to a subsequent verb. For
31003 example:
31004 .code
31005     warn    ...some conditions...
31006             control = freeze
31007     accept  ...
31008 .endd
31009 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
31010 &%logwrite%&, so it does not add anything to the message and does not write a
31011 log entry.
31012
31013 .next
31014 If you want to apply a control unconditionally, you can use it with a
31015 &%require%& verb. For example:
31016 .code
31017     require  control = no_multiline_responses
31018 .endd
31019 .endlist
31020
31021 .vitem &*delay*&&~=&~<&'time'&>
31022 .cindex "&%delay%& ACL modifier"
31023 .oindex "&%-bh%&"
31024 This modifier may appear in any ACL except notquit. It causes Exim to wait for
31025 the time interval before proceeding. However, when testing Exim using the
31026 &%-bh%& option, the delay is not actually imposed (an appropriate message is
31027 output instead). The time is given in the usual Exim notation, and the delay
31028 happens as soon as the modifier is processed. In an SMTP session, pending
31029 output is flushed before the delay is imposed.
31030
31031 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
31032 example:
31033 .code
31034 deny    ...some conditions...
31035         delay = 30s
31036 .endd
31037 The delay happens if all the conditions are true, before the statement returns
31038 &"deny"&. Compare this with:
31039 .code
31040 deny    delay = 30s
31041         ...some conditions...
31042 .endd
31043 which waits for 30s before processing the conditions. The &%delay%& modifier
31044 can also be used with &%warn%& and together with &%control%&:
31045 .code
31046 warn    ...some conditions...
31047         delay = 2m
31048         control = freeze
31049 accept  ...
31050 .endd
31051
31052 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
31053 responses to several commands are no longer buffered and sent in one packet (as
31054 they would normally be) because all output is flushed before imposing the
31055 delay. This optimization is disabled so that a number of small delays do not
31056 appear to the client as one large aggregated delay that might provoke an
31057 unwanted timeout. You can, however, disable output flushing for &%delay%& by
31058 using a &%control%& modifier to set &%no_delay_flush%&.
31059
31060
31061 .vitem &*endpass*&
31062 .cindex "&%endpass%& ACL modifier"
31063 This modifier, which has no argument, is recognized only in &%accept%& and
31064 &%discard%& statements. It marks the boundary between the conditions whose
31065 failure causes control to pass to the next statement, and the conditions whose
31066 failure causes the ACL to return &"deny"&. This concept has proved to be
31067 confusing to some people, so the use of &%endpass%& is no longer recommended as
31068 &"best practice"&. See the description of &%accept%& above for more details.
31069
31070
31071 .vitem &*log_message*&&~=&~<&'text'&>
31072 .cindex "&%log_message%& ACL modifier"
31073 This modifier sets up a message that is used as part of the log message if the
31074 ACL denies access or a &%warn%& statement's conditions are true. For example:
31075 .code
31076 require log_message = wrong cipher suite $tls_in_cipher
31077         encrypted   = DES-CBC3-SHA
31078 .endd
31079 &%log_message%& is also used when recipients are discarded by &%discard%&. For
31080 example:
31081 .display
31082 &`discard `&<&'some conditions'&>
31083 &`        log_message = Discarded $local_part@$domain because...`&
31084 .endd
31085 When access is denied, &%log_message%& adds to any underlying error message
31086 that may exist because of a condition failure. For example, while verifying a
31087 recipient address, a &':fail:'& redirection might have already set up a
31088 message.
31089
31090 The message may be defined before the conditions to which it applies, because
31091 the string expansion does not happen until Exim decides that access is to be
31092 denied. This means that any variables that are set by the condition are
31093 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
31094 variables are set after a DNS black list lookup succeeds. If the expansion of
31095 &%log_message%& fails, or if the result is an empty string, the modifier is
31096 ignored.
31097
31098 .vindex "&$acl_verify_message$&"
31099 If you want to use a &%warn%& statement to log the result of an address
31100 verification, you can use &$acl_verify_message$& to include the verification
31101 error message.
31102
31103 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
31104 the start of the logged message. If the same warning log message is requested
31105 more than once while receiving  a single email message, only one copy is
31106 actually logged. If you want to log multiple copies, use &%logwrite%& instead
31107 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
31108 is logged for a successful &%warn%& statement.
31109
31110 If &%log_message%& is not present and there is no underlying error message (for
31111 example, from the failure of address verification), but &%message%& is present,
31112 the &%message%& text is used for logging rejections. However, if any text for
31113 logging contains newlines, only the first line is logged. In the absence of
31114 both &%log_message%& and &%message%&, a default built-in message is used for
31115 logging rejections.
31116
31117
31118 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
31119 .cindex "&%log_reject_target%& ACL modifier"
31120 .cindex "logging in ACL" "specifying which log"
31121 This modifier makes it possible to specify which logs are used for messages
31122 about ACL rejections. Its argument is a colon-separated list of words that can
31123 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
31124 may be empty, in which case a rejection is not logged at all. For example, this
31125 ACL fragment writes no logging information when access is denied:
31126 .display
31127 &`deny `&<&'some conditions'&>
31128 &`     log_reject_target =`&
31129 .endd
31130 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
31131 permanent and temporary rejections. Its effect lasts for the rest of the
31132 current ACL.
31133
31134
31135 .vitem &*logwrite*&&~=&~<&'text'&>
31136 .cindex "&%logwrite%& ACL modifier"
31137 .cindex "logging in ACL" "immediate"
31138 This modifier writes a message to a log file as soon as it is encountered when
31139 processing an ACL. (Compare &%log_message%&, which, except in the case of
31140 &%warn%& and &%discard%&, is used only if the ACL statement denies
31141 access.) The &%logwrite%& modifier can be used to log special incidents in
31142 ACLs. For example:
31143 .display
31144 &`accept `&<&'some special conditions'&>
31145 &`       control  = freeze`&
31146 &`       logwrite = froze message because ...`&
31147 .endd
31148 By default, the message is written to the main log. However, it may begin
31149 with a colon, followed by a comma-separated list of log names, and then
31150 another colon, to specify exactly which logs are to be written. For
31151 example:
31152 .code
31153 logwrite = :main,reject: text for main and reject logs
31154 logwrite = :panic: text for panic log only
31155 .endd
31156
31157
31158 .vitem &*message*&&~=&~<&'text'&>
31159 .cindex "&%message%& ACL modifier"
31160 This modifier sets up a text string that is expanded and used as a response
31161 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
31162 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
31163 there is some complication if &%endpass%& is involved; see the description of
31164 &%accept%& for details.)
31165
31166 The expansion of the message happens at the time Exim decides that the ACL is
31167 to end, not at the time it processes &%message%&. If the expansion fails, or
31168 generates an empty string, the modifier is ignored. Here is an example where
31169 &%message%& must be specified first, because the ACL ends with a rejection if
31170 the &%hosts%& condition fails:
31171 .code
31172 require  message = Host not recognized
31173          hosts = 10.0.0.0/8
31174 .endd
31175 (Once a condition has failed, no further conditions or modifiers are
31176 processed.)
31177
31178 .cindex "SMTP" "error codes"
31179 .oindex "&%smtp_banner%&
31180 For ACLs that are triggered by SMTP commands, the message is returned as part
31181 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
31182 is meaningful only for SMTP, as no message is returned when a non-SMTP message
31183 is accepted. In the case of the connect ACL, accepting with a message modifier
31184 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
31185 accept message may not contain more than one line (otherwise it will be
31186 truncated at the first newline and a panic logged), and it cannot affect the
31187 EHLO options.
31188
31189 When SMTP is involved, the message may begin with an overriding response code,
31190 consisting of three digits optionally followed by an &"extended response code"&
31191 of the form &'n.n.n'&, each code being followed by a space. For example:
31192 .code
31193 deny  message = 599 1.2.3 Host not welcome
31194       hosts = 192.168.34.0/24
31195 .endd
31196 The first digit of the supplied response code must be the same as would be sent
31197 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
31198 access, but for the predata ACL, note that the default success code is 354, not
31199 2&'xx'&.
31200
31201 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
31202 the message modifier cannot override the 221 response code.
31203
31204 The text in a &%message%& modifier is literal; any quotes are taken as
31205 literals, but because the string is expanded, backslash escapes are processed
31206 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
31207 response.
31208
31209 .vindex "&$acl_verify_message$&"
31210 For ACLs that are called by an &%acl =%& ACL condition, the message is
31211 stored in &$acl_verify_message$&, from which the calling ACL may use it.
31212
31213 If &%message%& is used on a statement that verifies an address, the message
31214 specified overrides any message that is generated by the verification process.
31215 However, the original message is available in the variable
31216 &$acl_verify_message$&, so you can incorporate it into your message if you
31217 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
31218 routers to be passed back as part of the SMTP response, you should either not
31219 use a &%message%& modifier, or make use of &$acl_verify_message$&.
31220
31221 For compatibility with previous releases of Exim, a &%message%& modifier that
31222 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
31223 modifier, but this usage is now deprecated. However, &%message%& acts only when
31224 all the conditions are true, wherever it appears in an ACL command, whereas
31225 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
31226 &%warn%& in an ACL that is not concerned with receiving a message, it has no
31227 effect.
31228
31229
31230 .vitem &*queue*&&~=&~<&'text'&>
31231 .cindex "&%queue%& ACL modifier"
31232 .cindex "named queues" "selecting in ACL"
31233 This modifier specifies the use of a named queue for spool files
31234 for the message.
31235 It can only be used before the message is received (i.e. not in
31236 the DATA ACL).
31237 This could be used, for example, for known high-volume burst sources
31238 of traffic, or for quarantine of messages.
31239 Separate queue-runner processes will be needed for named queues.
31240 If the text after expansion is empty, the default queue is used.
31241
31242
31243 .vitem &*remove_header*&&~=&~<&'text'&>
31244 This modifier specifies one or more header names in a colon-separated list
31245  that are to be removed from an incoming message, assuming, of course, that
31246 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
31247
31248
31249 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
31250 .cindex "&%set%& ACL modifier"
31251 This modifier puts a value into one of the ACL variables (see section
31252 &<<SECTaclvariables>>&).
31253
31254
31255 .vitem &*udpsend*&&~=&~<&'parameters'&>
31256 .cindex "UDP communications"
31257 This modifier sends a UDP packet, for purposes such as statistics
31258 collection or behaviour monitoring. The parameters are expanded, and
31259 the result of the expansion must be a colon-separated list consisting
31260 of a destination server, port number, and the packet contents. The
31261 server can be specified as a host name or IPv4 or IPv6 address. The
31262 separator can be changed with the usual angle bracket syntax. For
31263 example, you might want to collect information on which hosts connect
31264 when:
31265 .code
31266 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
31267              $tod_zulu $sender_host_address
31268 .endd
31269 .endlist
31270
31271
31272
31273
31274 .section "Use of the control modifier" "SECTcontrols"
31275 .cindex "&%control%& ACL modifier"
31276 The &%control%& modifier supports the following settings:
31277
31278 .vlist
31279 .vitem &*control&~=&~allow_auth_unadvertised*&
31280 This modifier allows a client host to use the SMTP AUTH command even when it
31281 has not been advertised in response to EHLO. Furthermore, because there are
31282 apparently some really broken clients that do this, Exim will accept AUTH after
31283 HELO (rather than EHLO) when this control is set. It should be used only if you
31284 really need it, and you should limit its use to those broken clients that do
31285 not work without it. For example:
31286 .code
31287 warn hosts   = 192.168.34.25
31288      control = allow_auth_unadvertised
31289 .endd
31290 Normally, when an Exim server receives an AUTH command, it checks the name of
31291 the authentication mechanism that is given in the command to ensure that it
31292 matches an advertised mechanism. When this control is set, the check that a
31293 mechanism has been advertised is bypassed. Any configured mechanism can be used
31294 by the client. This control is permitted only in the connection and HELO ACLs.
31295
31296
31297 .vitem &*control&~=&~caseful_local_part*& &&&
31298        &*control&~=&~caselower_local_part*&
31299 .cindex "&ACL;" "case of local part in"
31300 .cindex "case of local parts"
31301 .vindex "&$local_part$&"
31302 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
31303 (that is, during RCPT processing). By default, the contents of &$local_part$&
31304 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
31305 any uppercase letters in the original local part are restored in &$local_part$&
31306 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
31307 is encountered.
31308
31309 These controls affect only the current recipient. Moreover, they apply only to
31310 local part handling that takes place directly in the ACL (for example, as a key
31311 in lookups). If a test to verify the recipient is obeyed, the case-related
31312 handling of the local part during the verification is controlled by the router
31313 configuration (see the &%caseful_local_part%& generic router option).
31314
31315 This facility could be used, for example, to add a spam score to local parts
31316 containing upper case letters. For example, using &$acl_m4$& to accumulate the
31317 spam score:
31318 .code
31319 warn  control = caseful_local_part
31320       set acl_m4 = ${eval:\
31321                      $acl_m4 + \
31322                      ${if match{$local_part}{[A-Z]}{1}{0}}\
31323                     }
31324       control = caselower_local_part
31325 .endd
31326 Notice that we put back the lower cased version afterwards, assuming that
31327 is what is wanted for subsequent tests.
31328
31329
31330 .vitem &*control&~=&~cutthrough_delivery/*&<&'options'&>
31331 .cindex "&ACL;" "cutthrough routing"
31332 .cindex "cutthrough" "requesting"
31333 This option requests delivery be attempted while the item is being received.
31334
31335 The option is usable in the RCPT ACL.
31336 If enabled for a message received via smtp and routed to an smtp transport,
31337 and only one transport, interface, destination host and port combination
31338 is used for all recipients of the message,
31339 then the delivery connection is made while the receiving connection is open
31340 and data is copied from one to the other.
31341
31342 An attempt to set this option for any recipient but the first
31343 for a mail will be quietly ignored.
31344 If a recipient-verify callout
31345 (with use_sender)
31346 connection is subsequently
31347 requested in the same ACL it is held open and used for
31348 any subsequent recipients and the data,
31349 otherwise one is made after the initial RCPT ACL completes.
31350
31351 Note that routers are used in verify mode,
31352 and cannot depend on content of received headers.
31353 Note also that headers cannot be
31354 modified by any of the post-data ACLs (DATA, MIME and DKIM).
31355 Headers may be modified by routers (subject to the above) and transports.
31356 The &'Received-By:'& header is generated as soon as the body reception starts,
31357 rather than the traditional time after the full message is received;
31358 this will affect the timestamp.
31359
31360 All the usual ACLs are called; if one results in the message being
31361 rejected, all effort spent in delivery (including the costs on
31362 the ultimate destination) will be wasted.
31363 Note that in the case of data-time ACLs this includes the entire
31364 message body.
31365
31366 Cutthrough delivery is not supported via transport-filters or when DKIM signing
31367 of outgoing messages is done, because it sends data to the ultimate destination
31368 before the entire message has been received from the source.
31369 It is not supported for messages received with the SMTP PRDR
31370 or CHUNKING
31371 options in use.
31372
31373 Should the ultimate destination system positively accept or reject the mail,
31374 a corresponding indication is given to the source system and nothing is queued.
31375 If the item is successfully delivered in cutthrough mode
31376 the delivery log lines are tagged with ">>" rather than "=>" and appear
31377 before the acceptance "<=" line.
31378
31379 If there is a temporary error the item is queued for later delivery in the
31380 usual fashion.
31381 This behaviour can be adjusted by appending the option &*defer=*&<&'value'&>
31382 to the control; the default value is &"spool"& and the alternate value
31383 &"pass"& copies an SMTP defer response from the target back to the initiator
31384 and does not queue the message.
31385 Note that this is independent of any recipient verify conditions in the ACL.
31386
31387 Delivery in this mode avoids the generation of a bounce mail to a
31388 (possibly faked)
31389 sender when the destination system is doing content-scan based rejection.
31390
31391
31392 .vitem &*control&~=&~debug/*&<&'options'&>
31393 .cindex "&ACL;" "enabling debug logging"
31394 .cindex "debugging" "enabling from an ACL"
31395 This control turns on debug logging, almost as though Exim had been invoked
31396 with &`-d`&, with the output going to a new logfile in the usual logs directory,
31397 by default called &'debuglog'&.
31398 The filename can be adjusted with the &'tag'& option, which
31399 may access any variables already defined.  The logging may be adjusted with
31400 the &'opts'& option, which takes the same values as the &`-d`& command-line
31401 option.
31402 Logging started this way may be stopped, and the file removed,
31403 with the &'kill'& option.
31404 Some examples (which depend on variables that don't exist in all
31405 contexts):
31406 .code
31407       control = debug
31408       control = debug/tag=.$sender_host_address
31409       control = debug/opts=+expand+acl
31410       control = debug/tag=.$message_exim_id/opts=+expand
31411       control = debug/kill
31412 .endd
31413
31414
31415 .vitem &*control&~=&~dkim_disable_verify*&
31416 .cindex "disable DKIM verify"
31417 .cindex "DKIM" "disable verify"
31418 This control turns off DKIM verification processing entirely.  For details on
31419 the operation and configuration of DKIM, see section &<<SECDKIM>>&.
31420
31421
31422 .vitem &*control&~=&~dmarc_disable_verify*&
31423 .cindex "disable DMARC verify"
31424 .cindex "DMARC" "disable verify"
31425 This control turns off DMARC verification processing entirely.  For details on
31426 the operation and configuration of DMARC, see section &<<SECDMARC>>&.
31427
31428
31429 .vitem &*control&~=&~dscp/*&<&'value'&>
31430 .cindex "&ACL;" "setting DSCP value"
31431 .cindex "DSCP" "inbound"
31432 This option causes the DSCP value associated with the socket for the inbound
31433 connection to be adjusted to a given value, given as one of a number of fixed
31434 strings or to numeric value.
31435 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
31436 Common values include &`throughput`&, &`mincost`&, and on newer systems
31437 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
31438
31439 The outbound packets from Exim will be marked with this value in the header
31440 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
31441 that these values will have any effect, not be stripped by networking
31442 equipment, or do much of anything without cooperation with your Network
31443 Engineer and those of all network operators between the source and destination.
31444
31445
31446 .vitem &*control&~=&~enforce_sync*& &&&
31447        &*control&~=&~no_enforce_sync*&
31448 .cindex "SMTP" "synchronization checking"
31449 .cindex "synchronization checking in SMTP"
31450 These controls make it possible to be selective about when SMTP synchronization
31451 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
31452 state of the switch (it is true by default). See the description of this option
31453 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
31454
31455 The effect of these two controls lasts for the remainder of the SMTP
31456 connection. They can appear in any ACL except the one for the non-SMTP
31457 messages. The most straightforward place to put them is in the ACL defined by
31458 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
31459 before the first synchronization check. The expected use is to turn off the
31460 synchronization checks for badly-behaved hosts that you nevertheless need to
31461 work with.
31462
31463
31464 .vitem &*control&~=&~fakedefer/*&<&'message'&>
31465 .cindex "fake defer"
31466 .cindex "defer, fake"
31467 This control works in exactly the same way as &%fakereject%& (described below)
31468 except that it causes an SMTP 450 response after the message data instead of a
31469 550 response. You must take care when using &%fakedefer%& because it causes the
31470 messages to be duplicated when the sender retries. Therefore, you should not
31471 use &%fakedefer%& if the message is to be delivered normally.
31472
31473 .vitem &*control&~=&~fakereject/*&<&'message'&>
31474 .cindex "fake rejection"
31475 .cindex "rejection, fake"
31476 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
31477 words, only when an SMTP message is being received. If Exim accepts the
31478 message, instead the final 250 response, a 550 rejection message is sent.
31479 However, Exim proceeds to deliver the message as normal. The control applies
31480 only to the current message, not to any subsequent ones that may be received in
31481 the same SMTP connection.
31482
31483 The text for the 550 response is taken from the &%control%& modifier. If no
31484 message is supplied, the following is used:
31485 .code
31486 550-Your message has been rejected but is being
31487 550-kept for evaluation.
31488 550-If it was a legitimate message, it may still be
31489 550 delivered to the target recipient(s).
31490 .endd
31491 This facility should be used with extreme caution.
31492
31493 .vitem &*control&~=&~freeze*&
31494 .cindex "frozen messages" "forcing in ACL"
31495 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
31496 other words, only when a message is being received. If the message is accepted,
31497 it is placed on Exim's queue and frozen. The control applies only to the
31498 current message, not to any subsequent ones that may be received in the same
31499 SMTP connection.
31500
31501 This modifier can optionally be followed by &`/no_tell`&. If the global option
31502 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
31503 is told about the freezing), provided all the &*control=freeze*& modifiers that
31504 are obeyed for the current message have the &`/no_tell`& option.
31505
31506 .vitem &*control&~=&~no_delay_flush*&
31507 .cindex "SMTP" "output flushing, disabling for delay"
31508 Exim normally flushes SMTP output before implementing a delay in an ACL, to
31509 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
31510 use. This control, as long as it is encountered before the &%delay%& modifier,
31511 disables such output flushing.
31512
31513 .vitem &*control&~=&~no_callout_flush*&
31514 .cindex "SMTP" "output flushing, disabling for callout"
31515 Exim normally flushes SMTP output before performing a callout in an ACL, to
31516 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
31517 use. This control, as long as it is encountered before the &%verify%& condition
31518 that causes the callout, disables such output flushing.
31519
31520 .vitem &*control&~=&~no_mbox_unspool*&
31521 This control is available when Exim is compiled with the content scanning
31522 extension. Content scanning may require a copy of the current message, or parts
31523 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
31524 or spam scanner. Normally, such copies are deleted when they are no longer
31525 needed. If this control is set, the copies are not deleted. The control applies
31526 only to the current message, not to any subsequent ones that may be received in
31527 the same SMTP connection. It is provided for debugging purposes and is unlikely
31528 to be useful in production.
31529
31530 .vitem &*control&~=&~no_multiline_responses*&
31531 .cindex "multiline responses, suppressing"
31532 This control is permitted for any ACL except the one for non-SMTP messages.
31533 It seems that there are broken clients in use that cannot handle multiline
31534 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
31535
31536 If this control is set, multiline SMTP responses from ACL rejections are
31537 suppressed. One way of doing this would have been to put out these responses as
31538 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
31539 (&"use multiline responses for more"& it says &-- ha!), and some of the
31540 responses might get close to that. So this facility, which is after all only a
31541 sop to broken clients, is implemented by doing two very easy things:
31542
31543 .ilist
31544 Extra information that is normally output as part of a rejection caused by
31545 sender verification failure is omitted. Only the final line (typically &"sender
31546 verification failed"&) is sent.
31547 .next
31548 If a &%message%& modifier supplies a multiline response, only the first
31549 line is output.
31550 .endlist
31551
31552 The setting of the switch can, of course, be made conditional on the
31553 calling host. Its effect lasts until the end of the SMTP connection.
31554
31555 .vitem &*control&~=&~no_pipelining*&
31556 .cindex "PIPELINING" "suppressing advertising"
31557 .cindex "ESMTP extensions" PIPELINING
31558 This control turns off the advertising of the PIPELINING extension to SMTP in
31559 the current session. To be useful, it must be obeyed before Exim sends its
31560 response to an EHLO command. Therefore, it should normally appear in an ACL
31561 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
31562 &%pipelining_advertise_hosts%&.
31563
31564 .vitem &*control&~=&~queue/*&<&'options'&>* &&&
31565        &*control&~=&~queue_only*&
31566 .oindex "&%queue%&"
31567 .oindex "&%queue_only%&"
31568 .cindex "queueing incoming messages"
31569 .cindex queueing "forcing in ACL"
31570 .cindex "first pass routing"
31571 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
31572 other words, only when a message is being received. If the message is accepted,
31573 it is placed on Exim's queue and left there for delivery by a subsequent queue
31574 runner.
31575 If used with no options set,
31576 no immediate delivery process is started. In other words, it has the
31577 effect as the &%queue_only%& global option or &'-odq'& command-line option.
31578
31579 If the &'first_pass_route'& option is given then
31580 the behaviour is like the command-line &'-oqds'& option;
31581 a delivery process is started which stops short of making
31582 any SMTP delivery.  The benefit is that the hints database will be updated for
31583 the message being waiting for a specific host, and a later queue run will be
31584 able to send all such messages on a single connection.
31585
31586 The control only applies to the current message, not to any subsequent ones that
31587  may be received in the same SMTP connection.
31588
31589 .vitem &*control&~=&~submission/*&<&'options'&>
31590 .cindex "message" "submission"
31591 .cindex "submission mode"
31592 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
31593 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
31594 the current message is a submission from a local MUA. In this case, Exim
31595 operates in &"submission mode"&, and applies certain fixups to the message if
31596 necessary. For example, it adds a &'Date:'& header line if one is not present.
31597 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
31598 late (the message has already been created).
31599
31600 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
31601 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
31602 submission mode; the available options for this control are described there.
31603 The control applies only to the current message, not to any subsequent ones
31604 that may be received in the same SMTP connection.
31605
31606 .vitem &*control&~=&~suppress_local_fixups*&
31607 .cindex "submission fixups, suppressing"
31608 This control applies to locally submitted (non TCP/IP) messages, and is the
31609 complement of &`control = submission`&. It disables the fixups that are
31610 normally applied to locally-submitted messages. Specifically:
31611
31612 .ilist
31613 Any &'Sender:'& header line is left alone (in this respect, it is a
31614 dynamic version of &%local_sender_retain%&).
31615 .next
31616 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
31617 .next
31618 There is no check that &'From:'& corresponds to the actual sender.
31619 .endlist ilist
31620
31621 This control may be useful when a remotely-originated message is accepted,
31622 passed to some scanning program, and then re-submitted for delivery. It can be
31623 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
31624 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
31625 data is read.
31626
31627 &*Note:*& This control applies only to the current message, not to any others
31628 that are being submitted at the same time using &%-bs%& or &%-bS%&.
31629
31630 .vitem &*control&~=&~utf8_downconvert*&
31631 This control enables conversion of UTF-8 in message envelope addresses
31632 to a-label form.
31633 For details see section &<<SECTi18nMTA>>&.
31634 .endlist vlist
31635
31636
31637 .section "Summary of message fixup control" "SECTsummesfix"
31638 All four possibilities for message fixups can be specified:
31639
31640 .ilist
31641 Locally submitted, fixups applied: the default.
31642 .next
31643 Locally submitted, no fixups applied: use
31644 &`control = suppress_local_fixups`&.
31645 .next
31646 Remotely submitted, no fixups applied: the default.
31647 .next
31648 Remotely submitted, fixups applied: use &`control = submission`&.
31649 .endlist
31650
31651
31652
31653 .section "Adding header lines in ACLs" "SECTaddheadacl"
31654 .cindex "header lines" "adding in an ACL"
31655 .cindex "header lines" "position of added lines"
31656 .cindex "&%add_header%& ACL modifier"
31657 The &%add_header%& modifier can be used to add one or more extra header lines
31658 to an incoming message, as in this example:
31659 .code
31660 warn dnslists = sbl.spamhaus.org : \
31661                 dialup.mail-abuse.org
31662      add_header = X-blacklisted-at: $dnslist_domain
31663 .endd
31664 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
31665 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
31666 receiving a message). The message must ultimately be accepted for
31667 &%add_header%& to have any significant effect. You can use &%add_header%& with
31668 any ACL verb, including &%deny%& (though this is potentially useful only in a
31669 RCPT ACL).
31670
31671 Headers will not be added to the message if the modifier is used in
31672 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
31673
31674 Leading and trailing newlines are removed from
31675 the data for the &%add_header%& modifier; if it then
31676 contains one or more newlines that
31677 are not followed by a space or a tab, it is assumed to contain multiple header
31678 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
31679 front of any line that is not a valid header line.
31680
31681 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
31682 They are added to the message before processing the DATA and MIME ACLs.
31683 However, if an identical header line is requested more than once, only one copy
31684 is actually added to the message. Further header lines may be accumulated
31685 during the DATA and MIME ACLs, after which they are added to the message, again
31686 with duplicates suppressed. Thus, it is possible to add two identical header
31687 lines to an SMTP message, but only if one is added before DATA and one after.
31688 In the case of non-SMTP messages, new headers are accumulated during the
31689 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
31690 message is rejected after DATA or by the non-SMTP ACL, all added header lines
31691 are included in the entry that is written to the reject log.
31692
31693 .cindex "header lines" "added; visibility of"
31694 Header lines are not visible in string expansions
31695 of message headers
31696 until they are added to the
31697 message. It follows that header lines defined in the MAIL, RCPT, and predata
31698 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
31699 header lines that are added by the DATA or MIME ACLs are not visible in those
31700 ACLs. Because of this restriction, you cannot use header lines as a way of
31701 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
31702 this, you can use ACL variables, as described in section
31703 &<<SECTaclvariables>>&.
31704
31705 The list of headers yet to be added is given by the &%$headers_added%& variable.
31706
31707 The &%add_header%& modifier acts immediately as it is encountered during the
31708 processing of an ACL. Notice the difference between these two cases:
31709 .display
31710 &`accept add_header = ADDED: some text`&
31711 &`       `&<&'some condition'&>
31712
31713 &`accept `&<&'some condition'&>
31714 &`       add_header = ADDED: some text`&
31715 .endd
31716 In the first case, the header line is always added, whether or not the
31717 condition is true. In the second case, the header line is added only if the
31718 condition is true. Multiple occurrences of &%add_header%& may occur in the same
31719 ACL statement. All those that are encountered before a condition fails are
31720 honoured.
31721
31722 .cindex "&%warn%& ACL verb"
31723 For compatibility with previous versions of Exim, a &%message%& modifier for a
31724 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
31725 effect only if all the conditions are true, even if it appears before some of
31726 them. Furthermore, only the last occurrence of &%message%& is honoured. This
31727 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
31728 are present on a &%warn%& verb, both are processed according to their
31729 specifications.
31730
31731 By default, new header lines are added to a message at the end of the existing
31732 header lines. However, you can specify that any particular header line should
31733 be added right at the start (before all the &'Received:'& lines), immediately
31734 after the first block of &'Received:'& lines, or immediately before any line
31735 that is not a &'Received:'& or &'Resent-something:'& header.
31736
31737 This is done by specifying &":at_start:"&, &":after_received:"&, or
31738 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
31739 header line, respectively. (Header text cannot start with a colon, as there has
31740 to be a header name first.) For example:
31741 .code
31742 warn add_header = \
31743        :after_received:X-My-Header: something or other...
31744 .endd
31745 If more than one header line is supplied in a single &%add_header%& modifier,
31746 each one is treated independently and can therefore be placed differently. If
31747 you add more than one line at the start, or after the Received: block, they end
31748 up in reverse order.
31749
31750 &*Warning*&: This facility currently applies only to header lines that are
31751 added in an ACL. It does NOT work for header lines that are added in a
31752 system filter or in a router or transport.
31753
31754
31755
31756 .section "Removing header lines in ACLs" "SECTremoveheadacl"
31757 .cindex "header lines" "removing in an ACL"
31758 .cindex "header lines" "position of removed lines"
31759 .cindex "&%remove_header%& ACL modifier"
31760 The &%remove_header%& modifier can be used to remove one or more header lines
31761 from an incoming message, as in this example:
31762 .code
31763 warn   message        = Remove internal headers
31764        remove_header  = x-route-mail1 : x-route-mail2
31765 .endd
31766 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
31767 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
31768 receiving a message). The message must ultimately be accepted for
31769 &%remove_header%& to have any significant effect. You can use &%remove_header%&
31770 with any ACL verb, including &%deny%&, though this is really not useful for
31771 any verb that doesn't result in a delivered message.
31772
31773 Headers will not be removed from the message if the modifier is used in
31774 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
31775
31776 More than one header can be removed at the same time by using a colon separated
31777 list of header names. The header matching is case insensitive. Wildcards are
31778 not permitted, nor is list expansion performed, so you cannot use hostlists to
31779 create a list of headers, however both connection and message variable expansion
31780 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
31781 .code
31782 warn   hosts           = +internal_hosts
31783        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
31784 warn   message         = Remove internal headers
31785        remove_header   = $acl_c_ihdrs
31786 .endd
31787 Header names for removal are accumulated during the MAIL, RCPT, and predata ACLs.
31788 Matching header lines are removed from the message before processing the DATA and MIME ACLs.
31789 If multiple header lines match, all are removed.
31790 There is no harm in attempting to remove the same header twice nor in removing
31791 a non-existent header. Further header lines to be removed may be accumulated
31792 during the DATA and MIME ACLs, after which they are removed from the message,
31793 if present. In the case of non-SMTP messages, headers to be removed are
31794 accumulated during the non-SMTP ACLs, and are removed from the message after
31795 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
31796 ACL, there really is no effect because there is no logging of what headers
31797 would have been removed.
31798
31799 .cindex "header lines" "removed; visibility of"
31800 Header lines are not visible in string expansions until the DATA phase when it
31801 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
31802 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
31803 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
31804 this restriction, you cannot use header lines as a way of controlling data
31805 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
31806 you should instead use ACL variables, as described in section
31807 &<<SECTaclvariables>>&.
31808
31809 The &%remove_header%& modifier acts immediately as it is encountered during the
31810 processing of an ACL. Notice the difference between these two cases:
31811 .display
31812 &`accept remove_header = X-Internal`&
31813 &`       `&<&'some condition'&>
31814
31815 &`accept `&<&'some condition'&>
31816 &`       remove_header = X-Internal`&
31817 .endd
31818 In the first case, the header line is always removed, whether or not the
31819 condition is true. In the second case, the header line is removed only if the
31820 condition is true. Multiple occurrences of &%remove_header%& may occur in the
31821 same ACL statement. All those that are encountered before a condition fails
31822 are honoured.
31823
31824 &*Warning*&: This facility currently applies only to header lines that are
31825 present during ACL processing. It does NOT remove header lines that are added
31826 in a system filter or in a router or transport.
31827
31828
31829
31830
31831 .section "ACL conditions" "SECTaclconditions"
31832 .cindex "&ACL;" "conditions; list of"
31833 Some of the conditions listed in this section are available only when Exim is
31834 compiled with the content-scanning extension. They are included here briefly
31835 for completeness. More detailed descriptions can be found in the discussion on
31836 content scanning in chapter &<<CHAPexiscan>>&.
31837
31838 Not all conditions are relevant in all circumstances. For example, testing
31839 senders and recipients does not make sense in an ACL that is being run as the
31840 result of the arrival of an ETRN command, and checks on message headers can be
31841 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
31842 can use the same condition (with different parameters) more than once in the
31843 same ACL statement. This provides a way of specifying an &"and"& conjunction.
31844 The conditions are as follows:
31845
31846
31847 .vlist
31848 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
31849 .cindex "&ACL;" "nested"
31850 .cindex "&ACL;" "indirect"
31851 .cindex "&ACL;" "arguments"
31852 .cindex "&%acl%& ACL condition"
31853 The possible values of the argument are the same as for the
31854 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
31855 &"accept"& the condition is true; if it returns &"deny"& the condition is
31856 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
31857 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
31858 condition false. This means that further processing of the &%warn%& verb
31859 ceases, but processing of the ACL continues.
31860
31861 If the argument is a named ACL, up to nine space-separated optional values
31862 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
31863 and $acl_narg is set to the count of values.
31864 Previous values of these variables are restored after the call returns.
31865 The name and values are expanded separately.
31866 Note that spaces in complex expansions which are used as arguments
31867 will act as argument separators.
31868
31869 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
31870 the connection is dropped. If it returns &"discard"&, the verb must be
31871 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
31872 conditions are tested.
31873
31874 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
31875 loops. This condition allows you to use different ACLs in different
31876 circumstances. For example, different ACLs can be used to handle RCPT commands
31877 for different local users or different local domains.
31878
31879 .vitem &*authenticated&~=&~*&<&'string&~list'&>
31880 .cindex "&%authenticated%& ACL condition"
31881 .cindex "authentication" "ACL checking"
31882 .cindex "&ACL;" "testing for authentication"
31883 If the SMTP connection is not authenticated, the condition is false. Otherwise,
31884 the name of the authenticator is tested against the list. To test for
31885 authentication by any authenticator, you can set
31886 .code
31887 authenticated = *
31888 .endd
31889
31890 .vitem &*condition&~=&~*&<&'string'&>
31891 .cindex "&%condition%& ACL condition"
31892 .cindex "customizing" "ACL condition"
31893 .cindex "&ACL;" "customized test"
31894 .cindex "&ACL;" "testing, customized"
31895 This feature allows you to make up custom conditions. If the result of
31896 expanding the string is an empty string, the number zero, or one of the strings
31897 &"no"& or &"false"&, the condition is false. If the result is any non-zero
31898 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
31899 any other value, some error is assumed to have occurred, and the ACL returns
31900 &"defer"&. However, if the expansion is forced to fail, the condition is
31901 ignored. The effect is to treat it as true, whether it is positive or
31902 negative.
31903
31904 .vitem &*decode&~=&~*&<&'location'&>
31905 .cindex "&%decode%& ACL condition"
31906 This condition is available only when Exim is compiled with the
31907 content-scanning extension, and it is allowed only in the ACL defined by
31908 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
31909 If all goes well, the condition is true. It is false only if there are
31910 problems such as a syntax error or a memory shortage. For more details, see
31911 chapter &<<CHAPexiscan>>&.
31912
31913 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
31914 .cindex "&%dnslists%& ACL condition"
31915 .cindex "DNS list" "in ACL"
31916 .cindex "black list (DNS)"
31917 .cindex "&ACL;" "testing a DNS list"
31918 This condition checks for entries in DNS black lists. These are also known as
31919 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
31920 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
31921 different variants of this condition to describe briefly here. See sections
31922 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
31923
31924 .vitem &*domains&~=&~*&<&'domain&~list'&>
31925 .cindex "&%domains%& ACL condition"
31926 .cindex "domain" "ACL checking"
31927 .cindex "&ACL;" "testing a recipient domain"
31928 .vindex "&$domain_data$&"
31929 This condition is relevant only after a RCPT command. It checks that the domain
31930 of the recipient address is in the domain list. If percent-hack processing is
31931 enabled, it is done before this test is done. If the check succeeds with a
31932 lookup, the result of the lookup is placed in &$domain_data$& until the next
31933 &%domains%& test.
31934
31935 &*Note carefully*& (because many people seem to fall foul of this): you cannot
31936 use &%domains%& in a DATA ACL.
31937
31938
31939 .vitem &*encrypted&~=&~*&<&'string&~list'&>
31940 .cindex "&%encrypted%& ACL condition"
31941 .cindex "encryption" "checking in an ACL"
31942 .cindex "&ACL;" "testing for encryption"
31943 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
31944 name of the cipher suite in use is tested against the list. To test for
31945 encryption without testing for any specific cipher suite(s), set
31946 .code
31947 encrypted = *
31948 .endd
31949
31950
31951 .vitem &*hosts&~=&~*&<&'host&~list'&>
31952 .cindex "&%hosts%& ACL condition"
31953 .cindex "host" "ACL checking"
31954 .cindex "&ACL;" "testing the client host"
31955 This condition tests that the calling host matches the host list. If you have
31956 name lookups or wildcarded host names and IP addresses in the same host list,
31957 you should normally put the IP addresses first. For example, you could have:
31958 .code
31959 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
31960 .endd
31961 The lookup in this example uses the host name for its key. This is implied by
31962 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
31963 and it wouldn't matter which way round you had these two items.)
31964
31965 The reason for the problem with host names lies in the left-to-right way that
31966 Exim processes lists. It can test IP addresses without doing any DNS lookups,
31967 but when it reaches an item that requires a host name, it fails if it cannot
31968 find a host name to compare with the pattern. If the above list is given in the
31969 opposite order, the &%accept%& statement fails for a host whose name cannot be
31970 found, even if its IP address is 10.9.8.7.
31971
31972 If you really do want to do the name check first, and still recognize the IP
31973 address even if the name lookup fails, you can rewrite the ACL like this:
31974 .code
31975 accept hosts = dbm;/etc/friendly/hosts
31976 accept hosts = 10.9.8.7
31977 .endd
31978 The default action on failing to find the host name is to assume that the host
31979 is not in the list, so the first &%accept%& statement fails. The second
31980 statement can then check the IP address.
31981
31982 .vindex "&$host_data$&"
31983 If a &%hosts%& condition is satisfied by means of a lookup, the result
31984 of the lookup is made available in the &$host_data$& variable. This
31985 allows you, for example, to set up a statement like this:
31986 .code
31987 deny  hosts = net-lsearch;/some/file
31988       message = $host_data
31989 .endd
31990 which gives a custom error message for each denied host.
31991
31992 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
31993 .cindex "&%local_parts%& ACL condition"
31994 .cindex "local part" "ACL checking"
31995 .cindex "&ACL;" "testing a local part"
31996 .vindex "&$local_part_data$&"
31997 This condition is relevant only after a RCPT command. It checks that the local
31998 part of the recipient address is in the list. If percent-hack processing is
31999 enabled, it is done before this test. If the check succeeds with a lookup, the
32000 result of the lookup is placed in &$local_part_data$&, which remains set until
32001 the next &%local_parts%& test.
32002
32003 .vitem &*malware&~=&~*&<&'option'&>
32004 .cindex "&%malware%& ACL condition"
32005 .cindex "&ACL;" "virus scanning"
32006 .cindex "&ACL;" "scanning for viruses"
32007 This condition is available only when Exim is compiled with the
32008 content-scanning extension
32009 and only after a DATA command.
32010 It causes the incoming message to be scanned for
32011 viruses. For details, see chapter &<<CHAPexiscan>>&.
32012
32013 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
32014 .cindex "&%mime_regex%& ACL condition"
32015 .cindex "&ACL;" "testing by regex matching"
32016 This condition is available only when Exim is compiled with the
32017 content-scanning extension, and it is allowed only in the ACL defined by
32018 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
32019 with any of the regular expressions. For details, see chapter
32020 &<<CHAPexiscan>>&.
32021
32022 .vitem &*ratelimit&~=&~*&<&'parameters'&>
32023 .cindex "rate limiting"
32024 This condition can be used to limit the rate at which a user or host submits
32025 messages. Details are given in section &<<SECTratelimiting>>&.
32026
32027 .vitem &*recipients&~=&~*&<&'address&~list'&>
32028 .cindex "&%recipients%& ACL condition"
32029 .cindex "recipient" "ACL checking"
32030 .cindex "&ACL;" "testing a recipient"
32031 This condition is relevant only after a RCPT command. It checks the entire
32032 recipient address against a list of recipients.
32033
32034 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
32035 .cindex "&%regex%& ACL condition"
32036 .cindex "&ACL;" "testing by regex matching"
32037 This condition is available only when Exim is compiled with the
32038 content-scanning extension, and is available only in the DATA, MIME, and
32039 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
32040 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
32041
32042 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
32043 .cindex "&%sender_domains%& ACL condition"
32044 .cindex "sender" "ACL checking"
32045 .cindex "&ACL;" "testing a sender domain"
32046 .vindex "&$domain$&"
32047 .vindex "&$sender_address_domain$&"
32048 This condition tests the domain of the sender of the message against the given
32049 domain list. &*Note*&: The domain of the sender address is in
32050 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
32051 of this condition. This is an exception to the general rule for testing domain
32052 lists. It is done this way so that, if this condition is used in an ACL for a
32053 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
32054 influence the sender checking.
32055
32056 &*Warning*&: It is a bad idea to use this condition on its own as a control on
32057 relaying, because sender addresses are easily, and commonly, forged.
32058
32059 .vitem &*senders&~=&~*&<&'address&~list'&>
32060 .cindex "&%senders%& ACL condition"
32061 .cindex "sender" "ACL checking"
32062 .cindex "&ACL;" "testing a sender"
32063 This condition tests the sender of the message against the given list. To test
32064 for a bounce message, which has an empty sender, set
32065 .code
32066 senders = :
32067 .endd
32068 &*Warning*&: It is a bad idea to use this condition on its own as a control on
32069 relaying, because sender addresses are easily, and commonly, forged.
32070
32071 .vitem &*spam&~=&~*&<&'username'&>
32072 .cindex "&%spam%& ACL condition"
32073 .cindex "&ACL;" "scanning for spam"
32074 This condition is available only when Exim is compiled with the
32075 content-scanning extension. It causes the incoming message to be scanned by
32076 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
32077
32078 .vitem &*verify&~=&~certificate*&
32079 .cindex "&%verify%& ACL condition"
32080 .cindex "TLS" "client certificate verification"
32081 .cindex "certificate" "verification of client"
32082 .cindex "&ACL;" "certificate verification"
32083 .cindex "&ACL;" "testing a TLS certificate"
32084 This condition is true in an SMTP session if the session is encrypted, and a
32085 certificate was received from the client, and the certificate was verified. The
32086 server requests a certificate only if the client matches &%tls_verify_hosts%&
32087 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
32088
32089 .vitem &*verify&~=&~csa*&
32090 .cindex "CSA verification"
32091 This condition checks whether the sending host (the client) is authorized to
32092 send email. Details of how this works are given in section
32093 &<<SECTverifyCSA>>&.
32094
32095 .vitem &*verify&~=&~header_names_ascii*&
32096 .cindex "&%verify%& ACL condition"
32097 .cindex "&ACL;" "verifying header names only ASCII"
32098 .cindex "header lines" "verifying header names only ASCII"
32099 .cindex "verifying" "header names only ASCII"
32100 This condition is relevant only in an ACL that is run after a message has been
32101 received.
32102 This usually means an ACL specified by &%acl_smtp_data%& or &%acl_not_smtp%&.
32103 It checks all header names (not the content) to make sure
32104 there are no non-ASCII characters, also excluding control characters.  The
32105 allowable characters are decimal ASCII values 33 through 126.
32106
32107 Exim itself will handle headers with non-ASCII characters, but it can cause
32108 problems for downstream applications, so this option will allow their
32109 detection and rejection in the DATA ACL's.
32110
32111 .vitem &*verify&~=&~header_sender/*&<&'options'&>
32112 .cindex "&%verify%& ACL condition"
32113 .cindex "&ACL;" "verifying sender in the header"
32114 .cindex "header lines" "verifying the sender in"
32115 .cindex "sender" "verifying in header"
32116 .cindex "verifying" "sender in header"
32117 This condition is relevant only in an ACL that is run after a message has been
32118 received, that is, in an ACL specified by &%acl_smtp_data%& or
32119 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
32120 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
32121 is loosely thought of as a &"sender"& address (hence the name of the test).
32122 However, an address that appears in one of these headers need not be an address
32123 that accepts bounce messages; only sender addresses in envelopes are required
32124 to accept bounces. Therefore, if you use the callout option on this check, you
32125 might want to arrange for a non-empty address in the MAIL command.
32126
32127 Details of address verification and the options are given later, starting at
32128 section &<<SECTaddressverification>>& (callouts are described in section
32129 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
32130 condition to restrict it to bounce messages only:
32131 .code
32132 deny    senders = :
32133        !verify  = header_sender
32134         message = A valid sender header is required for bounces
32135 .endd
32136
32137 .vitem &*verify&~=&~header_syntax*&
32138 .cindex "&%verify%& ACL condition"
32139 .cindex "&ACL;" "verifying header syntax"
32140 .cindex "header lines" "verifying syntax"
32141 .cindex "verifying" "header syntax"
32142 This condition is relevant only in an ACL that is run after a message has been
32143 received, that is, in an ACL specified by &%acl_smtp_data%& or
32144 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
32145 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
32146 and &'Bcc:'&), returning true if there are no problems.
32147 Unqualified addresses (local parts without domains) are
32148 permitted only in locally generated messages and from hosts that match
32149 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
32150 appropriate.
32151
32152 Note that this condition is a syntax check only. However, a common spamming
32153 ploy used to be to send syntactically invalid headers such as
32154 .code
32155 To: @
32156 .endd
32157 and this condition can be used to reject such messages, though they are not as
32158 common as they used to be.
32159
32160 .vitem &*verify&~=&~helo*&
32161 .cindex "&%verify%& ACL condition"
32162 .cindex "&ACL;" "verifying HELO/EHLO"
32163 .cindex "HELO" "verifying"
32164 .cindex "EHLO" "verifying"
32165 .cindex "verifying" "EHLO"
32166 .cindex "verifying" "HELO"
32167 This condition is true if a HELO or EHLO command has been received from the
32168 client host, and its contents have been verified. If there has been no previous
32169 attempt to verify the HELO/EHLO contents, it is carried out when this
32170 condition is encountered. See the description of the &%helo_verify_hosts%& and
32171 &%helo_try_verify_hosts%& options for details of how to request verification
32172 independently of this condition, and for detail of the verification.
32173
32174 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
32175 option), this condition is always true.
32176
32177
32178 .vitem &*verify&~=&~not_blind/*&<&'options'&>
32179 .cindex "verifying" "not blind"
32180 .cindex "bcc recipients, verifying none"
32181 This condition checks that there are no blind (bcc) recipients in the message.
32182 Every envelope recipient must appear either in a &'To:'& header line or in a
32183 &'Cc:'& header line for this condition to be true. Local parts are checked
32184 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
32185 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
32186 used only in a DATA or non-SMTP ACL.
32187
32188 There is one possible option, &`case_insensitive`&.  If this is present then
32189 local parts are checked case-insensitively.
32190
32191 There are, of course, many legitimate messages that make use of blind (bcc)
32192 recipients. This check should not be used on its own for blocking messages.
32193
32194
32195 .vitem &*verify&~=&~recipient/*&<&'options'&>
32196 .cindex "&%verify%& ACL condition"
32197 .cindex "&ACL;" "verifying recipient"
32198 .cindex "recipient" "verifying"
32199 .cindex "verifying" "recipient"
32200 .vindex "&$address_data$&"
32201 This condition is relevant only after a RCPT command. It verifies the current
32202 recipient. Details of address verification are given later, starting at section
32203 &<<SECTaddressverification>>&. After a recipient has been verified, the value
32204 of &$address_data$& is the last value that was set while routing the address.
32205 This applies even if the verification fails. When an address that is being
32206 verified is redirected to a single address, verification continues with the new
32207 address, and in that case, the subsequent value of &$address_data$& is the
32208 value for the child address.
32209
32210 .vitem &*verify&~=&~reverse_host_lookup/*&<&'options'&>
32211 .cindex "&%verify%& ACL condition"
32212 .cindex "&ACL;" "verifying host reverse lookup"
32213 .cindex "host" "verifying reverse lookup"
32214 This condition ensures that a verified host name has been looked up from the IP
32215 address of the client host. (This may have happened already if the host name
32216 was needed for checking a host list, or if the host matched &%host_lookup%&.)
32217 Verification ensures that the host name obtained from a reverse DNS lookup, or
32218 one of its aliases, does, when it is itself looked up in the DNS, yield the
32219 original IP address.
32220
32221 There is one possible option, &`defer_ok`&.  If this is present and a
32222 DNS operation returns a temporary error, the verify condition succeeds.
32223
32224 If this condition is used for a locally generated message (that is, when there
32225 is no client host involved), it always succeeds.
32226
32227 .vitem &*verify&~=&~sender/*&<&'options'&>
32228 .cindex "&%verify%& ACL condition"
32229 .cindex "&ACL;" "verifying sender"
32230 .cindex "sender" "verifying"
32231 .cindex "verifying" "sender"
32232 This condition is relevant only after a MAIL or RCPT command, or after a
32233 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
32234 the message's sender is empty (that is, this is a bounce message), the
32235 condition is true. Otherwise, the sender address is verified.
32236
32237 .vindex "&$address_data$&"
32238 .vindex "&$sender_address_data$&"
32239 If there is data in the &$address_data$& variable at the end of routing, its
32240 value is placed in &$sender_address_data$& at the end of verification. This
32241 value can be used in subsequent conditions and modifiers in the same ACL
32242 statement. It does not persist after the end of the current statement. If you
32243 want to preserve the value for longer, you can save it in an ACL variable.
32244
32245 Details of verification are given later, starting at section
32246 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
32247 to avoid doing it more than once per message.
32248
32249 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
32250 .cindex "&%verify%& ACL condition"
32251 This is a variation of the previous option, in which a modified address is
32252 verified as a sender.
32253
32254 Note that '/' is legal in local-parts; if the address may have such
32255 (eg. is generated from the received message)
32256 they must be protected from the options parsing by doubling:
32257 .code
32258 verify = sender=${listquote{/}{${address:$h_sender:}}}
32259 .endd
32260 .endlist
32261
32262
32263
32264 .section "Using DNS lists" "SECTmorednslists"
32265 .cindex "DNS list" "in ACL"
32266 .cindex "black list (DNS)"
32267 .cindex "&ACL;" "testing a DNS list"
32268 In its simplest form, the &%dnslists%& condition tests whether the calling host
32269 is on at least one of a number of DNS lists by looking up the inverted IP
32270 address in one or more DNS domains. (Note that DNS list domains are not mail
32271 domains, so the &`+`& syntax for named lists doesn't work - it is used for
32272 special options instead.) For example, if the calling host's IP
32273 address is 192.168.62.43, and the ACL statement is
32274 .code
32275 deny dnslists = blackholes.mail-abuse.org : \
32276                 dialups.mail-abuse.org
32277 .endd
32278 the following records are looked up:
32279 .code
32280 43.62.168.192.blackholes.mail-abuse.org
32281 43.62.168.192.dialups.mail-abuse.org
32282 .endd
32283 As soon as Exim finds an existing DNS record, processing of the list stops.
32284 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
32285 to test that a host is on more than one list (an &"and"& conjunction), you can
32286 use two separate conditions:
32287 .code
32288 deny dnslists = blackholes.mail-abuse.org
32289      dnslists = dialups.mail-abuse.org
32290 .endd
32291 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
32292 behaves as if the host does not match the list item, that is, as if the DNS
32293 record does not exist. If there are further items in the DNS list, they are
32294 processed.
32295
32296 This is usually the required action when &%dnslists%& is used with &%deny%&
32297 (which is the most common usage), because it prevents a DNS failure from
32298 blocking mail. However, you can change this behaviour by putting one of the
32299 following special items in the list:
32300 .display
32301 &`+include_unknown `&   behave as if the item is on the list
32302 &`+exclude_unknown `&   behave as if the item is not on the list (default)
32303 &`+defer_unknown   `&   give a temporary error
32304 .endd
32305 .cindex "&`+include_unknown`&"
32306 .cindex "&`+exclude_unknown`&"
32307 .cindex "&`+defer_unknown`&"
32308 Each of these applies to any subsequent items on the list. For example:
32309 .code
32310 deny dnslists = +defer_unknown : foo.bar.example
32311 .endd
32312 Testing the list of domains stops as soon as a match is found. If you want to
32313 warn for one list and block for another, you can use two different statements:
32314 .code
32315 deny  dnslists = blackholes.mail-abuse.org
32316 warn  dnslists = dialups.mail-abuse.org
32317       message  = X-Warn: sending host is on dialups list
32318 .endd
32319 .cindex caching "of dns lookup"
32320 .cindex DNS TTL
32321 DNS list lookups are cached by Exim for the duration of the SMTP session
32322 (but limited by the DNS return TTL value),
32323 so a lookup based on the IP address is done at most once for any incoming
32324 connection (assuming long-enough TTL).
32325 Exim does not share information between multiple incoming
32326 connections (but your local name server cache should be active).
32327
32328 There are a number of DNS lists to choose from, some commercial, some free,
32329 or free for small deployments.  An overview can be found at
32330 &url(https://en.wikipedia.org/wiki/Comparison_of_DNS_blacklists).
32331
32332
32333
32334 .section "Specifying the IP address for a DNS list lookup" "SECID201"
32335 .cindex "DNS list" "keyed by explicit IP address"
32336 By default, the IP address that is used in a DNS list lookup is the IP address
32337 of the calling host. However, you can specify another IP address by listing it
32338 after the domain name, introduced by a slash. For example:
32339 .code
32340 deny dnslists = black.list.tld/192.168.1.2
32341 .endd
32342 This feature is not very helpful with explicit IP addresses; it is intended for
32343 use with IP addresses that are looked up, for example, the IP addresses of the
32344 MX hosts or nameservers of an email sender address. For an example, see section
32345 &<<SECTmulkeyfor>>& below.
32346
32347
32348
32349
32350 .section "DNS lists keyed on domain names" "SECID202"
32351 .cindex "DNS list" "keyed by domain name"
32352 There are some lists that are keyed on domain names rather than inverted IP
32353 addresses (see, e.g., the &'domain based zones'& link at
32354 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
32355 with these lists. You can change the name that is looked up in a DNS list by
32356 listing it after the domain name, introduced by a slash. For example,
32357 .code
32358 deny  dnslists = dsn.rfc-ignorant.org/$sender_address_domain
32359       message  = Sender's domain is listed at $dnslist_domain
32360 .endd
32361 This particular example is useful only in ACLs that are obeyed after the
32362 RCPT or DATA commands, when a sender address is available. If (for
32363 example) the message's sender is &'user@tld.example'& the name that is looked
32364 up by this example is
32365 .code
32366 tld.example.dsn.rfc-ignorant.org
32367 .endd
32368 A single &%dnslists%& condition can contain entries for both names and IP
32369 addresses. For example:
32370 .code
32371 deny dnslists = sbl.spamhaus.org : \
32372                 dsn.rfc-ignorant.org/$sender_address_domain
32373 .endd
32374 The first item checks the sending host's IP address; the second checks a domain
32375 name. The whole condition is true if either of the DNS lookups succeeds.
32376
32377
32378
32379
32380 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
32381 .cindex "DNS list" "multiple keys for"
32382 The syntax described above for looking up explicitly-defined values (either
32383 names or IP addresses) in a DNS blacklist is a simplification. After the domain
32384 name for the DNS list, what follows the slash can in fact be a list of items.
32385 As with all lists in Exim, the default separator is a colon. However, because
32386 this is a sublist within the list of DNS blacklist domains, it is necessary
32387 either to double the separators like this:
32388 .code
32389 dnslists = black.list.tld/name.1::name.2
32390 .endd
32391 or to change the separator character, like this:
32392 .code
32393 dnslists = black.list.tld/<;name.1;name.2
32394 .endd
32395 If an item in the list is an IP address, it is inverted before the DNS
32396 blacklist domain is appended. If it is not an IP address, no inversion
32397 occurs. Consider this condition:
32398 .code
32399 dnslists = black.list.tld/<;192.168.1.2;a.domain
32400 .endd
32401 The DNS lookups that occur are:
32402 .code
32403 2.1.168.192.black.list.tld
32404 a.domain.black.list.tld
32405 .endd
32406 Once a DNS record has been found (that matches a specific IP return
32407 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
32408 are done. If there is a temporary DNS error, the rest of the sublist of domains
32409 or IP addresses is tried. A temporary error for the whole dnslists item occurs
32410 only if no other DNS lookup in this sublist succeeds. In other words, a
32411 successful lookup for any of the items in the sublist overrides a temporary
32412 error for a previous item.
32413
32414 The ability to supply a list of items after the slash is in some sense just a
32415 syntactic convenience. These two examples have the same effect:
32416 .code
32417 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
32418 dnslists = black.list.tld/a.domain::b.domain
32419 .endd
32420 However, when the data for the list is obtained from a lookup, the second form
32421 is usually much more convenient. Consider this example:
32422 .code
32423 deny dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
32424                                    ${lookup dnsdb {>|mxh=\
32425                                    $sender_address_domain} }} }
32426      message  = The mail servers for the domain \
32427                 $sender_address_domain \
32428                 are listed at $dnslist_domain ($dnslist_value); \
32429                 see $dnslist_text.
32430 .endd
32431 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
32432 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
32433 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
32434 of expanding the condition might be something like this:
32435 .code
32436 dnslists = sbl.spamhaus.org/<|192.168.2.3|192.168.5.6|...
32437 .endd
32438 Thus, this example checks whether or not the IP addresses of the sender
32439 domain's mail servers are on the Spamhaus black list.
32440
32441 The key that was used for a successful DNS list lookup is put into the variable
32442 &$dnslist_matched$& (see section &<<SECID204>>&).
32443
32444
32445
32446
32447 .section "Data returned by DNS lists" "SECID203"
32448 .cindex "DNS list" "data returned from"
32449 DNS lists are constructed using address records in the DNS. The original RBL
32450 just used the address 127.0.0.1 on the right hand side of each record, but the
32451 RBL+ list and some other lists use a number of values with different meanings.
32452 The values used on the RBL+ list are:
32453 .display
32454 127.1.0.1  RBL
32455 127.1.0.2  DUL
32456 127.1.0.3  DUL and RBL
32457 127.1.0.4  RSS
32458 127.1.0.5  RSS and RBL
32459 127.1.0.6  RSS and DUL
32460 127.1.0.7  RSS and DUL and RBL
32461 .endd
32462 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
32463 different values. Some DNS lists may return more than one address record;
32464 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
32465
32466
32467 .section "Variables set from DNS lists" "SECID204"
32468 .cindex "expansion" "variables, set from DNS list"
32469 .cindex "DNS list" "variables set from"
32470 .vindex "&$dnslist_domain$&"
32471 .vindex "&$dnslist_matched$&"
32472 .vindex "&$dnslist_text$&"
32473 .vindex "&$dnslist_value$&"
32474 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
32475 the name of the overall domain that matched (for example,
32476 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
32477 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
32478 the DNS record. When the key is an IP address, it is not reversed in
32479 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
32480 cases, for example:
32481 .code
32482 deny dnslists = spamhaus.example
32483 .endd
32484 the key is also available in another variable (in this case,
32485 &$sender_host_address$&). In more complicated cases, however, this is not true.
32486 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
32487 might generate a dnslists lookup like this:
32488 .code
32489 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
32490 .endd
32491 If this condition succeeds, the value in &$dnslist_matched$& might be
32492 &`192.168.6.7`& (for example).
32493
32494 If more than one address record is returned by the DNS lookup, all the IP
32495 addresses are included in &$dnslist_value$&, separated by commas and spaces.
32496 The variable &$dnslist_text$& contains the contents of any associated TXT
32497 record. For lists such as RBL+ the TXT record for a merged entry is often not
32498 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
32499 information.
32500
32501 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
32502 &-- even if these appear before the condition in the ACL, they are not
32503 expanded until after it has failed. For example:
32504 .code
32505 deny    hosts = !+local_networks
32506         message = $sender_host_address is listed \
32507                   at $dnslist_domain
32508         dnslists = rbl-plus.mail-abuse.example
32509 .endd
32510
32511
32512
32513 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
32514 .cindex "DNS list" "matching specific returned data"
32515 You can add an equals sign and an IP address after a &%dnslists%& domain name
32516 in order to restrict its action to DNS records with a matching right hand side.
32517 For example,
32518 .code
32519 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
32520 .endd
32521 rejects only those hosts that yield 127.0.0.2. Without this additional data,
32522 any address record is considered to be a match. For the moment, we assume
32523 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
32524 describes how multiple records are handled.
32525
32526 More than one IP address may be given for checking, using a comma as a
32527 separator. These are alternatives &-- if any one of them matches, the
32528 &%dnslists%& condition is true. For example:
32529 .code
32530 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
32531 .endd
32532 If you want to specify a constraining address list and also specify names or IP
32533 addresses to be looked up, the constraining address list must be specified
32534 first. For example:
32535 .code
32536 deny dnslists = dsn.rfc-ignorant.org\
32537                 =127.0.0.2/$sender_address_domain
32538 .endd
32539
32540 If the character &`&&`& is used instead of &`=`&, the comparison for each
32541 listed IP address is done by a bitwise &"and"& instead of by an equality test.
32542 In other words, the listed addresses are used as bit masks. The comparison is
32543 true if all the bits in the mask are present in the address that is being
32544 tested. For example:
32545 .code
32546 dnslists = a.b.c&0.0.0.3
32547 .endd
32548 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
32549 want to test whether one bit or another bit is present (as opposed to both
32550 being present), you must use multiple values. For example:
32551 .code
32552 dnslists = a.b.c&0.0.0.1,0.0.0.2
32553 .endd
32554 matches if the final component of the address is an odd number or two times
32555 an odd number.
32556
32557
32558
32559 .section "Negated DNS matching conditions" "SECID205"
32560 You can supply a negative list of IP addresses as part of a &%dnslists%&
32561 condition. Whereas
32562 .code
32563 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
32564 .endd
32565 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
32566 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
32567 .code
32568 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
32569 .endd
32570 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
32571 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
32572 words, the result of the test is inverted if an exclamation mark appears before
32573 the &`=`& (or the &`&&`&) sign.
32574
32575 &*Note*&: This kind of negation is not the same as negation in a domain,
32576 host, or address list (which is why the syntax is different).
32577
32578 If you are using just one list, the negation syntax does not gain you much. The
32579 previous example is precisely equivalent to
32580 .code
32581 deny  dnslists = a.b.c
32582      !dnslists = a.b.c=127.0.0.2,127.0.0.3
32583 .endd
32584 However, if you are using multiple lists, the negation syntax is clearer.
32585 Consider this example:
32586 .code
32587 deny  dnslists = sbl.spamhaus.org : \
32588                  list.dsbl.org : \
32589                  dnsbl.njabl.org!=127.0.0.3 : \
32590                  relays.ordb.org
32591 .endd
32592 Using only positive lists, this would have to be:
32593 .code
32594 deny  dnslists = sbl.spamhaus.org : \
32595                  list.dsbl.org
32596 deny  dnslists = dnsbl.njabl.org
32597      !dnslists = dnsbl.njabl.org=127.0.0.3
32598 deny  dnslists = relays.ordb.org
32599 .endd
32600 which is less clear, and harder to maintain.
32601
32602
32603
32604
32605 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
32606 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
32607 thereby providing more than one IP address. When an item in a &%dnslists%& list
32608 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
32609 the match to specific results from the DNS lookup, there are two ways in which
32610 the checking can be handled. For example, consider the condition:
32611 .code
32612 dnslists = a.b.c=127.0.0.1
32613 .endd
32614 What happens if the DNS lookup for the incoming IP address yields both
32615 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
32616 condition true because at least one given value was found, or is it false
32617 because at least one of the found values was not listed? And how does this
32618 affect negated conditions? Both possibilities are provided for with the help of
32619 additional separators &`==`& and &`=&&`&.
32620
32621 .ilist
32622 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
32623 IP addresses matches one of the listed addresses. For the example above, the
32624 condition is true because 127.0.0.1 matches.
32625 .next
32626 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
32627 looked up IP addresses matches one of the listed addresses. If the condition is
32628 changed to:
32629 .code
32630 dnslists = a.b.c==127.0.0.1
32631 .endd
32632 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
32633 false because 127.0.0.2 is not listed. You would need to have:
32634 .code
32635 dnslists = a.b.c==127.0.0.1,127.0.0.2
32636 .endd
32637 for the condition to be true.
32638 .endlist
32639
32640 When &`!`& is used to negate IP address matching, it inverts the result, giving
32641 the precise opposite of the behaviour above. Thus:
32642 .ilist
32643 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
32644 addresses matches one of the listed addresses. Consider:
32645 .code
32646 dnslists = a.b.c!&0.0.0.1
32647 .endd
32648 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
32649 false because 127.0.0.1 matches.
32650 .next
32651 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
32652 looked up IP address that does not match. Consider:
32653 .code
32654 dnslists = a.b.c!=&0.0.0.1
32655 .endd
32656 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
32657 true, because 127.0.0.2 does not match. You would need to have:
32658 .code
32659 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
32660 .endd
32661 for the condition to be false.
32662 .endlist
32663 When the DNS lookup yields only a single IP address, there is no difference
32664 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
32665
32666
32667
32668
32669 .section "Detailed information from merged DNS lists" "SECTmordetinf"
32670 .cindex "DNS list" "information from merged"
32671 When the facility for restricting the matching IP values in a DNS list is used,
32672 the text from the TXT record that is set in &$dnslist_text$& may not reflect
32673 the true reason for rejection. This happens when lists are merged and the IP
32674 address in the A record is used to distinguish them; unfortunately there is
32675 only one TXT record. One way round this is not to use merged lists, but that
32676 can be inefficient because it requires multiple DNS lookups where one would do
32677 in the vast majority of cases when the host of interest is not on any of the
32678 lists.
32679
32680 A less inefficient way of solving this problem is available. If
32681 two domain names, comma-separated, are given, the second is used first to
32682 do an initial check, making use of any IP value restrictions that are set.
32683 If there is a match, the first domain is used, without any IP value
32684 restrictions, to get the TXT record. As a byproduct of this, there is also
32685 a check that the IP being tested is indeed on the first list. The first
32686 domain is the one that is put in &$dnslist_domain$&. For example:
32687 .code
32688 deny   dnslists = \
32689          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
32690          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
32691        message  = \
32692          rejected because $sender_host_address is blacklisted \
32693          at $dnslist_domain\n$dnslist_text
32694 .endd
32695 For the first blacklist item, this starts by doing a lookup in
32696 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
32697 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
32698 value, and as long as something is found, it looks for the corresponding TXT
32699 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
32700 The second blacklist item is processed similarly.
32701
32702 If you are interested in more than one merged list, the same list must be
32703 given several times, but because the results of the DNS lookups are cached,
32704 the DNS calls themselves are not repeated. For example:
32705 .code
32706 deny dnslists = \
32707          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
32708          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
32709          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
32710          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
32711 .endd
32712 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
32713 values matches (or if no record is found), this is the only lookup that is
32714 done. Only if there is a match is one of the more specific lists consulted.
32715
32716
32717
32718 .section "DNS lists and IPv6" "SECTmorednslistslast"
32719 .cindex "IPv6" "DNS black lists"
32720 .cindex "DNS list" "IPv6 usage"
32721 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
32722 nibble by nibble. For example, if the calling host's IP address is
32723 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
32724 .code
32725 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
32726   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
32727 .endd
32728 (split over two lines here to fit on the page). Unfortunately, some of the DNS
32729 lists contain wildcard records, intended for IPv4, that interact badly with
32730 IPv6. For example, the DNS entry
32731 .code
32732 *.3.some.list.example.    A    127.0.0.1
32733 .endd
32734 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
32735 Unfortunately, it also matches the entire 3::/4 IPv6 network.
32736
32737 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
32738 &%condition%& condition, as in this example:
32739 .code
32740 deny   condition = ${if isip4{$sender_host_address}}
32741        dnslists  = some.list.example
32742 .endd
32743
32744 If an explicit key is being used for a DNS lookup and it may be an IPv6
32745 address you should specify alternate list separators for both the outer
32746 (DNS list name) list and inner (lookup keys) list:
32747 .code
32748        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
32749 .endd
32750
32751 .section "Rate limiting incoming messages" "SECTratelimiting"
32752 .cindex "rate limiting" "client sending"
32753 .cindex "limiting client sending rates"
32754 .oindex "&%smtp_ratelimit_*%&"
32755 The &%ratelimit%& ACL condition can be used to measure and control the rate at
32756 which clients can send email. This is more powerful than the
32757 &%smtp_ratelimit_*%& options, because those options control the rate of
32758 commands in a single SMTP session only, whereas the &%ratelimit%& condition
32759 works across all connections (concurrent and sequential) from the same client
32760 host. The syntax of the &%ratelimit%& condition is:
32761 .display
32762 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
32763 .endd
32764 If the average client sending rate is less than &'m'& messages per time
32765 period &'p'& then the condition is false; otherwise it is true.
32766
32767 As a side-effect, the &%ratelimit%& condition sets the expansion variable
32768 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
32769 configured value of &'m'&, and &$sender_rate_period$& to the configured value
32770 of &'p'&.
32771
32772 The parameter &'p'& is the smoothing time constant, in the form of an Exim
32773 time interval, for example, &`8h`& for eight hours. A larger time constant
32774 means that it takes Exim longer to forget a client's past behaviour. The
32775 parameter &'m'& is the maximum number of messages that a client is permitted to
32776 send in each time interval. It also specifies the number of messages permitted
32777 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
32778 constant, you can allow a client to send more messages in a burst without
32779 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
32780 both small, messages must be sent at an even rate.
32781
32782 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
32783 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
32784 when deploying the &%ratelimit%& ACL condition. The script prints usage
32785 instructions when it is run with no arguments.
32786
32787 The key is used to look up the data for calculating the client's average
32788 sending rate. This data is stored in Exim's spool directory, alongside the
32789 retry and other hints databases. The default key is &$sender_host_address$&,
32790 which means Exim computes the sending rate of each client host IP address.
32791 By changing the key you can change how Exim identifies clients for the purpose
32792 of ratelimiting. For example, to limit the sending rate of each authenticated
32793 user, independent of the computer they are sending from, set the key to
32794 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
32795 example, &$authenticated_id$& is only meaningful if the client has
32796 authenticated (which you can check with the &%authenticated%& ACL condition).
32797
32798 The lookup key does not have to identify clients: If you want to limit the
32799 rate at which a recipient receives messages, you can use the key
32800 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
32801 ACL.
32802
32803 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
32804 specifies what Exim measures the rate of, for example, messages or recipients
32805 or bytes. You can adjust the measurement using the &%unique=%& and/or
32806 &%count=%& options. You can also control when Exim updates the recorded rate
32807 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
32808 separated by a slash, like the other parameters. They may appear in any order.
32809
32810 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
32811 any options that alter the meaning of the stored data. The limit &'m'& is not
32812 stored, so you can alter the configured maximum rate and Exim will still
32813 remember clients' past behaviour. If you change the &%per_*%& mode or add or
32814 remove the &%unique=%& option, the lookup key changes so Exim will forget past
32815 behaviour. The lookup key is not affected by changes to the update mode and
32816 the &%count=%& option.
32817
32818
32819 .section "Ratelimit options for what is being measured" "ratoptmea"
32820 .cindex "rate limiting" "per_* options"
32821 The &%per_conn%& option limits the client's connection rate. It is not
32822 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
32823 &%acl_not_smtp_start%& ACLs.
32824
32825 The &%per_mail%& option limits the client's rate of sending messages. This is
32826 the default if none of the &%per_*%& options is specified. It can be used in
32827 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
32828 &%acl_smtp_data%&, or &%acl_not_smtp%&.
32829
32830 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
32831 the same ACLs as the &%per_mail%& option, though it is best to use this option
32832 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
32833 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
32834 in its MAIL command, which may be inaccurate or completely missing. You can
32835 follow the limit &'m'& in the configuration with K, M, or G to specify limits
32836 in kilobytes, megabytes, or gigabytes, respectively.
32837
32838 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
32839 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
32840 &%acl_smtp_mime%&, or &%acl_smtp_data%& ACLs. In
32841 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
32842 ACLs the rate is updated with the total (accepted) recipient count in one go. Note that
32843 in either case the rate limiting engine will see a message with many
32844 recipients as a large high-speed burst.
32845
32846 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
32847 number of different recipients that the client has sent messages to in the
32848 last time period. That is, if the client repeatedly sends messages to the same
32849 recipient, its measured rate is not increased. This option can only be used in
32850 &%acl_smtp_rcpt%&.
32851
32852 The &%per_cmd%& option causes Exim to recompute the rate every time the
32853 condition is processed. This can be used to limit the rate of any SMTP
32854 command. If it is used in multiple ACLs it can limit the aggregate rate of
32855 multiple different commands.
32856
32857 The &%count=%& option can be used to alter how much Exim adds to the client's
32858 measured rate. For example, the &%per_byte%& option is equivalent to
32859 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
32860 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
32861 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
32862
32863 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
32864
32865
32866 .section "Ratelimit update modes" "ratoptupd"
32867 .cindex "rate limiting" "reading data without updating"
32868 You can specify one of three options with the &%ratelimit%& condition to
32869 control when its database is updated. This section describes the &%readonly%&
32870 mode, and the next section describes the &%strict%& and &%leaky%& modes.
32871
32872 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
32873 previously-computed rate to check against the limit.
32874
32875 For example, you can test the client's sending rate and deny it access (when
32876 it is too fast) in the connect ACL. If the client passes this check then it
32877 can go on to send a message, in which case its recorded rate will be updated
32878 in the MAIL ACL. Subsequent connections from the same client will check this
32879 new rate.
32880 .code
32881 acl_check_connect:
32882  deny ratelimit = 100 / 5m / readonly
32883       log_message = RATE CHECK: $sender_rate/$sender_rate_period \
32884                   (max $sender_rate_limit)
32885 # ...
32886 acl_check_mail:
32887  warn ratelimit = 100 / 5m / strict
32888       log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
32889                   (max $sender_rate_limit)
32890 .endd
32891
32892 If Exim encounters multiple &%ratelimit%& conditions with the same key when
32893 processing a message then it may increase the client's measured rate more than
32894 it should. For example, this will happen if you check the &%per_rcpt%& option
32895 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
32896 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
32897 multiple update problems by using the &%readonly%& option on later ratelimit
32898 checks.
32899
32900 The &%per_*%& options described above do not make sense in some ACLs. If you
32901 use a &%per_*%& option in an ACL where it is not normally permitted then the
32902 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
32903 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
32904 next section) so you must specify the &%readonly%& option explicitly.
32905
32906
32907 .section "Ratelimit options for handling fast clients" "ratoptfast"
32908 .cindex "rate limiting" "strict and leaky modes"
32909 If a client's average rate is greater than the maximum, the rate limiting
32910 engine can react in two possible ways, depending on the presence of the
32911 &%strict%& or &%leaky%& update modes. This is independent of the other
32912 counter-measures (such as rejecting the message) that may be specified by the
32913 rest of the ACL.
32914
32915 The &%leaky%& (default) option means that the client's recorded rate is not
32916 updated if it is above the limit. The effect of this is that Exim measures the
32917 client's average rate of successfully sent email,
32918 up to the given limit.
32919 This is appropriate if the countermeasure when the condition is true
32920 consists of refusing the message, and
32921 is generally the better choice if you have clients that retry automatically.
32922 If the action when true is anything more complex then this option is
32923 likely not what is wanted.
32924
32925 The &%strict%& option means that the client's recorded rate is always
32926 updated. The effect of this is that Exim measures the client's average rate
32927 of attempts to send email, which can be much higher than the maximum it is
32928 actually allowed. If the client is over the limit it may be subjected to
32929 counter-measures by the ACL. It must slow down and allow sufficient time to
32930 pass that its computed rate falls below the maximum before it can send email
32931 again. The time (the number of smoothing periods) it must wait and not
32932 attempt to send mail can be calculated with this formula:
32933 .code
32934         ln(peakrate/maxrate)
32935 .endd
32936
32937
32938 .section "Limiting the rate of different events" "ratoptuniq"
32939 .cindex "rate limiting" "counting unique events"
32940 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
32941 rate of different events. For example, the &%per_addr%& option uses this
32942 mechanism to count the number of different recipients that the client has
32943 sent messages to in the last time period; it is equivalent to
32944 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
32945 measure the rate that a client uses different sender addresses with the
32946 options &`per_mail/unique=$sender_address`&.
32947
32948 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
32949 has seen for that key. The whole set is thrown away when it is older than the
32950 rate smoothing period &'p'&, so each different event is counted at most once
32951 per period. In the &%leaky%& update mode, an event that causes the client to
32952 go over the limit is not added to the set, in the same way that the client's
32953 recorded rate is not updated in the same situation.
32954
32955 When you combine the &%unique=%& and &%readonly%& options, the specific
32956 &%unique=%& value is ignored, and Exim just retrieves the client's stored
32957 rate.
32958
32959 The &%unique=%& mechanism needs more space in the ratelimit database than the
32960 other &%ratelimit%& options in order to store the event set. The number of
32961 unique values is potentially as large as the rate limit, so the extra space
32962 required increases with larger limits.
32963
32964 The uniqueification is not perfect: there is a small probability that Exim
32965 will think a new event has happened before. If the sender's rate is less than
32966 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
32967 the measured rate can go above the limit, in which case Exim may under-count
32968 events by a significant margin. Fortunately, if the rate is high enough (2.7
32969 times the limit) that the false positive rate goes above 9%, then Exim will
32970 throw away the over-full event set before the measured rate falls below the
32971 limit. Therefore the only harm should be that exceptionally high sending rates
32972 are logged incorrectly; any countermeasures you configure will be as effective
32973 as intended.
32974
32975
32976 .section "Using rate limiting" "useratlim"
32977 Exim's other ACL facilities are used to define what counter-measures are taken
32978 when the rate limit is exceeded. This might be anything from logging a warning
32979 (for example, while measuring existing sending rates in order to define
32980 policy), through time delays to slow down fast senders, up to rejecting the
32981 message. For example:
32982 .code
32983 # Log all senders' rates
32984 warn ratelimit = 0 / 1h / strict
32985      log_message = Sender rate $sender_rate / $sender_rate_period
32986
32987 # Slow down fast senders; note the need to truncate $sender_rate
32988 # at the decimal point.
32989 warn ratelimit = 100 / 1h / per_rcpt / strict
32990      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
32991                    $sender_rate_limit }s
32992
32993 # Keep authenticated users under control
32994 deny authenticated = *
32995      ratelimit = 100 / 1d / strict / $authenticated_id
32996
32997 # System-wide rate limit
32998 defer ratelimit = 10 / 1s / $primary_hostname
32999       message = Sorry, too busy. Try again later.
33000
33001 # Restrict incoming rate from each host, with a default
33002 # set using a macro and special cases looked up in a table.
33003 defer ratelimit = ${lookup {$sender_host_address} \
33004                    cdb {DB/ratelimits.cdb} \
33005                    {$value} {RATELIMIT} }
33006       message = Sender rate exceeds $sender_rate_limit \
33007                messages per $sender_rate_period
33008 .endd
33009 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
33010 especially with the &%per_rcpt%& option, you may suffer from a performance
33011 bottleneck caused by locking on the ratelimit hints database. Apart from
33012 making your ACLs less complicated, you can reduce the problem by using a
33013 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
33014 this means that Exim will lose its hints data after a reboot (including retry
33015 hints, the callout cache, and ratelimit data).
33016
33017
33018
33019 .section "Address verification" "SECTaddressverification"
33020 .cindex "verifying address" "options for"
33021 .cindex "policy control" "address verification"
33022 Several of the &%verify%& conditions described in section
33023 &<<SECTaclconditions>>& cause addresses to be verified. Section
33024 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
33025 The verification conditions can be followed by options that modify the
33026 verification process. The options are separated from the keyword and from each
33027 other by slashes, and some of them contain parameters. For example:
33028 .code
33029 verify = sender/callout
33030 verify = recipient/defer_ok/callout=10s,defer_ok
33031 .endd
33032 The first stage of address verification, which always happens, is to run the
33033 address through the routers, in &"verify mode"&. Routers can detect the
33034 difference between verification and routing for delivery, and their actions can
33035 be varied by a number of generic options such as &%verify%& and &%verify_only%&
33036 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
33037 The available options are as follows:
33038
33039 .ilist
33040 If the &%callout%& option is specified, successful routing to one or more
33041 remote hosts is followed by a &"callout"& to those hosts as an additional
33042 check. Callouts and their sub-options are discussed in the next section.
33043 .next
33044 If there is a defer error while doing verification routing, the ACL
33045 normally returns &"defer"&. However, if you include &%defer_ok%& in the
33046 options, the condition is forced to be true instead. Note that this is a main
33047 verification option as well as a suboption for callouts.
33048 .next
33049 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
33050 discusses the reporting of sender address verification failures.
33051 .next
33052 The &%success_on_redirect%& option causes verification always to succeed
33053 immediately after a successful redirection. By default, if a redirection
33054 generates just one address, that address is also verified. See further
33055 discussion in section &<<SECTredirwhilveri>>&.
33056 .new
33057 .next
33058 If the &%quota%& option is specified for recipient verify,
33059 successful routing to an appendfile transport is followed by a call into
33060 the transport to evaluate the quota status for the recipient.
33061 No actual delivery is done, but verification will succeed if the quota
33062 is sufficient for the message (if the sender gave a message size) or
33063 not already exceeded (otherwise).
33064 .wen
33065 .endlist
33066
33067 .cindex "verifying address" "differentiating failures"
33068 .vindex "&$recipient_verify_failure$&"
33069 .vindex "&$sender_verify_failure$&"
33070 .vindex "&$acl_verify_message$&"
33071 After an address verification failure, &$acl_verify_message$& contains the
33072 error message that is associated with the failure. It can be preserved by
33073 coding like this:
33074 .code
33075 warn  !verify = sender
33076        set acl_m0 = $acl_verify_message
33077 .endd
33078 If you are writing your own custom rejection message or log message when
33079 denying access, you can use this variable to include information about the
33080 verification failure.
33081
33082 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
33083 appropriate) contains one of the following words:
33084
33085 .ilist
33086 &%qualify%&: The address was unqualified (no domain), and the message
33087 was neither local nor came from an exempted host.
33088 .next
33089 &%route%&: Routing failed.
33090 .next
33091 &%mail%&: Routing succeeded, and a callout was attempted; rejection
33092 occurred at or before the MAIL command (that is, on initial
33093 connection, HELO, or MAIL).
33094 .next
33095 &%recipient%&: The RCPT command in a callout was rejected.
33096 .next
33097 &%postmaster%&: The postmaster check in a callout was rejected.
33098 .new
33099 .next
33100 &%quota%&: The quota check for a local recipient did non pass.
33101 .endlist
33102
33103 The main use of these variables is expected to be to distinguish between
33104 rejections of MAIL and rejections of RCPT in callouts.
33105
33106 The above variables may also be set after a &*successful*&
33107 address verification to:
33108
33109 .ilist
33110 &%random%&: A random local-part callout succeeded
33111 .endlist
33112
33113
33114
33115
33116 .section "Callout verification" "SECTcallver"
33117 .cindex "verifying address" "by callout"
33118 .cindex "callout" "verification"
33119 .cindex "SMTP" "callout verification"
33120 For non-local addresses, routing verifies the domain, but is unable to do any
33121 checking of the local part. There are situations where some means of verifying
33122 the local part is desirable. One way this can be done is to make an SMTP
33123 &'callback'& to a delivery host for the sender address or a &'callforward'& to
33124 a subsequent host for a recipient address, to see if the host accepts the
33125 address. We use the term &'callout'& to cover both cases. Note that for a
33126 sender address, the callback is not to the client host that is trying to
33127 deliver the message, but to one of the hosts that accepts incoming mail for the
33128 sender's domain.
33129
33130 Exim does not do callouts by default. If you want them to happen, you must
33131 request them by setting appropriate options on the &%verify%& condition, as
33132 described below. This facility should be used with care, because it can add a
33133 lot of resource usage to the cost of verifying an address. However, Exim does
33134 cache the results of callouts, which helps to reduce the cost. Details of
33135 caching are in section &<<SECTcallvercache>>&.
33136
33137 Recipient callouts are usually used only between hosts that are controlled by
33138 the same administration. For example, a corporate gateway host could use
33139 callouts to check for valid recipients on an internal mailserver. A successful
33140 callout does not guarantee that a real delivery to the address would succeed;
33141 on the other hand, a failing callout does guarantee that a delivery would fail.
33142
33143 If the &%callout%& option is present on a condition that verifies an address, a
33144 second stage of verification occurs if the address is successfully routed to
33145 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
33146 &(manualroute)& router, where the router specifies the hosts. However, if a
33147 router that does not set up hosts routes to an &(smtp)& transport with a
33148 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
33149 &%hosts_override%& set, its hosts are always used, whether or not the router
33150 supplies a host list.
33151 Callouts are only supported on &(smtp)& transports.
33152
33153 The port that is used is taken from the transport, if it is specified and is a
33154 remote transport. (For routers that do verification only, no transport need be
33155 specified.) Otherwise, the default SMTP port is used. If a remote transport
33156 specifies an outgoing interface, this is used; otherwise the interface is not
33157 specified. Likewise, the text that is used for the HELO command is taken from
33158 the transport's &%helo_data%& option; if there is no transport, the value of
33159 &$smtp_active_hostname$& is used.
33160
33161 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
33162 test whether a bounce message could be delivered to the sender address. The
33163 following SMTP commands are sent:
33164 .display
33165 &`HELO `&<&'local host name'&>
33166 &`MAIL FROM:<>`&
33167 &`RCPT TO:`&<&'the address to be tested'&>
33168 &`QUIT`&
33169 .endd
33170 LHLO is used instead of HELO if the transport's &%protocol%& option is
33171 set to &"lmtp"&.
33172
33173 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
33174 settings.
33175
33176 A recipient callout check is similar. By default, it also uses an empty address
33177 for the sender. This default is chosen because most hosts do not make use of
33178 the sender address when verifying a recipient. Using the same address means
33179 that a single cache entry can be used for each recipient. Some sites, however,
33180 do make use of the sender address when verifying. These are catered for by the
33181 &%use_sender%& and &%use_postmaster%& options, described in the next section.
33182
33183 If the response to the RCPT command is a 2&'xx'& code, the verification
33184 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
33185 Exim tries the next host, if any. If there is a problem with all the remote
33186 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
33187 &%callout%& option is given, in which case the condition is forced to succeed.
33188
33189 .cindex "SMTP" "output flushing, disabling for callout"
33190 A callout may take a little time. For this reason, Exim normally flushes SMTP
33191 output before performing a callout in an ACL, to avoid unexpected timeouts in
33192 clients when the SMTP PIPELINING extension is in use. The flushing can be
33193 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
33194
33195
33196
33197
33198 .section "Additional parameters for callouts" "CALLaddparcall"
33199 .cindex "callout" "additional parameters for"
33200 The &%callout%& option can be followed by an equals sign and a number of
33201 optional parameters, separated by commas. For example:
33202 .code
33203 verify = recipient/callout=10s,defer_ok
33204 .endd
33205 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
33206 separate verify options, is retained for backwards compatibility, but is now
33207 deprecated. The additional parameters for &%callout%& are as follows:
33208
33209
33210 .vlist
33211 .vitem <&'a&~time&~interval'&>
33212 .cindex "callout" "timeout, specifying"
33213 This specifies the timeout that applies for the callout attempt to each host.
33214 For example:
33215 .code
33216 verify = sender/callout=5s
33217 .endd
33218 The default is 30 seconds. The timeout is used for each response from the
33219 remote host. It is also used for the initial connection, unless overridden by
33220 the &%connect%& parameter.
33221
33222
33223 .vitem &*connect&~=&~*&<&'time&~interval'&>
33224 .cindex "callout" "connection timeout, specifying"
33225 This parameter makes it possible to set a different (usually smaller) timeout
33226 for making the SMTP connection. For example:
33227 .code
33228 verify = sender/callout=5s,connect=1s
33229 .endd
33230 If not specified, this timeout defaults to the general timeout value.
33231
33232 .vitem &*defer_ok*&
33233 .cindex "callout" "defer, action on"
33234 When this parameter is present, failure to contact any host, or any other kind
33235 of temporary error, is treated as success by the ACL. However, the cache is not
33236 updated in this circumstance.
33237
33238 .vitem &*fullpostmaster*&
33239 .cindex "callout" "full postmaster check"
33240 This operates like the &%postmaster%& option (see below), but if the check for
33241 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
33242 accordance with the specification in RFC 2821. The RFC states that the
33243 unqualified address &'postmaster'& should be accepted.
33244
33245
33246 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
33247 .cindex "callout" "sender when verifying header"
33248 When verifying addresses in header lines using the &%header_sender%&
33249 verification option, Exim behaves by default as if the addresses are envelope
33250 sender addresses from a message. Callout verification therefore tests to see
33251 whether a bounce message could be delivered, by using an empty address in the
33252 MAIL command. However, it is arguable that these addresses might never be used
33253 as envelope senders, and could therefore justifiably reject bounce messages
33254 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
33255 address to use in the MAIL command. For example:
33256 .code
33257 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
33258 .endd
33259 This parameter is available only for the &%header_sender%& verification option.
33260
33261
33262 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
33263 .cindex "callout" "overall timeout, specifying"
33264 This parameter sets an overall timeout for performing a callout verification.
33265 For example:
33266 .code
33267 verify = sender/callout=5s,maxwait=30s
33268 .endd
33269 This timeout defaults to four times the callout timeout for individual SMTP
33270 commands. The overall timeout applies when there is more than one host that can
33271 be tried. The timeout is checked before trying the next host. This prevents
33272 very long delays if there are a large number of hosts and all are timing out
33273 (for example, when network connections are timing out).
33274
33275
33276 .vitem &*no_cache*&
33277 .cindex "callout" "cache, suppressing"
33278 .cindex "caching callout, suppressing"
33279 When this parameter is given, the callout cache is neither read nor updated.
33280
33281 .vitem &*postmaster*&
33282 .cindex "callout" "postmaster; checking"
33283 When this parameter is set, a successful callout check is followed by a similar
33284 check for the local part &'postmaster'& at the same domain. If this address is
33285 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
33286 the postmaster check is recorded in a cache record; if it is a failure, this is
33287 used to fail subsequent callouts for the domain without a connection being
33288 made, until the cache record expires.
33289
33290 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
33291 The postmaster check uses an empty sender in the MAIL command by default.
33292 You can use this parameter to do a postmaster check using a different address.
33293 For example:
33294 .code
33295 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
33296 .endd
33297 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
33298 one overrides. The &%postmaster%& parameter is equivalent to this example:
33299 .code
33300 require  verify = sender/callout=postmaster_mailfrom=
33301 .endd
33302 &*Warning*&: The caching arrangements for postmaster checking do not take
33303 account of the sender address. It is assumed that either the empty address or
33304 a fixed non-empty address will be used. All that Exim remembers is that the
33305 postmaster check for the domain succeeded or failed.
33306
33307
33308 .vitem &*random*&
33309 .cindex "callout" "&""random""& check"
33310 When this parameter is set, before doing the normal callout check, Exim does a
33311 check for a &"random"& local part at the same domain. The local part is not
33312 really random &-- it is defined by the expansion of the option
33313 &%callout_random_local_part%&, which defaults to
33314 .code
33315 $primary_hostname-$tod_epoch-testing
33316 .endd
33317 The idea here is to try to determine whether the remote host accepts all local
33318 parts without checking. If it does, there is no point in doing callouts for
33319 specific local parts. If the &"random"& check succeeds, the result is saved in
33320 a cache record, and used to force the current and subsequent callout checks to
33321 succeed without a connection being made, until the cache record expires.
33322
33323 .vitem &*use_postmaster*&
33324 .cindex "callout" "sender for recipient check"
33325 This parameter applies to recipient callouts only. For example:
33326 .code
33327 deny  !verify = recipient/callout=use_postmaster
33328 .endd
33329 .vindex "&$qualify_domain$&"
33330 It causes a non-empty postmaster address to be used in the MAIL command when
33331 performing the callout for the recipient, and also for a &"random"& check if
33332 that is configured. The local part of the address is &`postmaster`& and the
33333 domain is the contents of &$qualify_domain$&.
33334
33335 .vitem &*use_sender*&
33336 This option applies to recipient callouts only. For example:
33337 .code
33338 require  verify = recipient/callout=use_sender
33339 .endd
33340 It causes the message's actual sender address to be used in the MAIL
33341 command when performing the callout, instead of an empty address. There is no
33342 need to use this option unless you know that the called hosts make use of the
33343 sender when checking recipients. If used indiscriminately, it reduces the
33344 usefulness of callout caching.
33345
33346 .vitem &*hold*&
33347 This option applies to recipient callouts only. For example:
33348 .code
33349 require  verify = recipient/callout=use_sender,hold
33350 .endd
33351 It causes the connection to be held open and used for any further recipients
33352 and for eventual delivery (should that be done quickly).
33353 Doing this saves on TCP and SMTP startup costs, and TLS costs also
33354 when that is used for the connections.
33355 The advantage is only gained if there are no callout cache hits
33356 (which could be enforced by the no_cache option),
33357 if the use_sender option is used,
33358 if neither the random nor the use_postmaster option is used,
33359 and if no other callouts intervene.
33360 .endlist
33361
33362 If you use any of the parameters that set a non-empty sender for the MAIL
33363 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
33364 &%use_sender%&), you should think about possible loops. Recipient checking is
33365 usually done between two hosts that are under the same management, and the host
33366 that receives the callouts is not normally configured to do callouts itself.
33367 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
33368 these circumstances.
33369
33370 However, if you use a non-empty sender address for a callout to an arbitrary
33371 host, there is the likelihood that the remote host will itself initiate a
33372 callout check back to your host. As it is checking what appears to be a message
33373 sender, it is likely to use an empty address in MAIL, thus avoiding a
33374 callout loop. However, to be on the safe side it would be best to set up your
33375 own ACLs so that they do not do sender verification checks when the recipient
33376 is the address you use for header sender or postmaster callout checking.
33377
33378 Another issue to think about when using non-empty senders for callouts is
33379 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
33380 by the sender/recipient combination; thus, for any given recipient, many more
33381 actual callouts are performed than when an empty sender or postmaster is used.
33382
33383
33384
33385
33386 .section "Callout caching" "SECTcallvercache"
33387 .cindex "hints database" "callout cache"
33388 .cindex "callout" "cache, description of"
33389 .cindex "caching" "callout"
33390 Exim caches the results of callouts in order to reduce the amount of resources
33391 used, unless you specify the &%no_cache%& parameter with the &%callout%&
33392 option. A hints database called &"callout"& is used for the cache. Two
33393 different record types are used: one records the result of a callout check for
33394 a specific address, and the other records information that applies to the
33395 entire domain (for example, that it accepts the local part &'postmaster'&).
33396
33397 When an original callout fails, a detailed SMTP error message is given about
33398 the failure. However, for subsequent failures use the cache data, this message
33399 is not available.
33400
33401 The expiry times for negative and positive address cache records are
33402 independent, and can be set by the global options &%callout_negative_expire%&
33403 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
33404
33405 If a host gives a negative response to an SMTP connection, or rejects any
33406 commands up to and including
33407 .code
33408 MAIL FROM:<>
33409 .endd
33410 (but not including the MAIL command with a non-empty address),
33411 any callout attempt is bound to fail. Exim remembers such failures in a
33412 domain cache record, which it uses to fail callouts for the domain without
33413 making new connections, until the domain record times out. There are two
33414 separate expiry times for domain cache records:
33415 &%callout_domain_negative_expire%& (default 3h) and
33416 &%callout_domain_positive_expire%& (default 7d).
33417
33418 Domain records expire when the negative expiry time is reached if callouts
33419 cannot be made for the domain, or if the postmaster check failed.
33420 Otherwise, they expire when the positive expiry time is reached. This
33421 ensures that, for example, a host that stops accepting &"random"& local parts
33422 will eventually be noticed.
33423
33424 The callout caching mechanism is based on the domain of the address that is
33425 being tested. If the domain routes to several hosts, it is assumed that their
33426 behaviour will be the same.
33427
33428
33429
33430 .new
33431 .section "Quota caching" "SECTquotacache"
33432 .cindex "hints database" "quota cache"
33433 .cindex "quota" "cache, description of"
33434 .cindex "caching" "quota"
33435 Exim caches the results of quota verification
33436 in order to reduce the amount of resources used.
33437 The &"callout"& hints database is used.
33438
33439 The default cache periods are five minutes for a positive (good) result
33440 and one hour for a negative result.
33441 To change the periods the &%quota%& option can be followed by an equals sign
33442 and a number of optional paramemters, separated by commas.
33443 For example:
33444 .code
33445 verify = recipient/quota=cachepos=1h,cacheneg=1d
33446 .endd
33447 Possible parameters are:
33448 .vlist
33449 .vitem &*cachepos&~=&~*&<&'time&~interval'&>
33450 .cindex "quota cache" "positive entry expiry, specifying"
33451 Set the lifetime for a positive cache entry.
33452 A value of zero seconds is legitimate.
33453
33454 .vitem &*cacheneg&~=&~*&<&'time&~interval'&>
33455 .cindex "quota cache" "negative entry expiry, specifying"
33456 As above, for a negative entry.
33457
33458 .vitem &*no_cache*&
33459 Set both positive and negative lifetimes to zero.
33460 .wen
33461
33462 .section "Sender address verification reporting" "SECTsenaddver"
33463 .cindex "verifying" "suppressing error details"
33464 See section &<<SECTaddressverification>>& for a general discussion of
33465 verification. When sender verification fails in an ACL, the details of the
33466 failure are given as additional output lines before the 550 response to the
33467 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
33468 you might see:
33469 .code
33470 MAIL FROM:<xyz@abc.example>
33471 250 OK
33472 RCPT TO:<pqr@def.example>
33473 550-Verification failed for <xyz@abc.example>
33474 550-Called:   192.168.34.43
33475 550-Sent:     RCPT TO:<xyz@abc.example>
33476 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
33477 550 Sender verification failed
33478 .endd
33479 If more than one RCPT command fails in the same way, the details are given
33480 only for the first of them. However, some administrators do not want to send
33481 out this much information. You can suppress the details by adding
33482 &`/no_details`& to the ACL statement that requests sender verification. For
33483 example:
33484 .code
33485 verify = sender/no_details
33486 .endd
33487
33488 .section "Redirection while verifying" "SECTredirwhilveri"
33489 .cindex "verifying" "redirection while"
33490 .cindex "address redirection" "while verifying"
33491 A dilemma arises when a local address is redirected by aliasing or forwarding
33492 during verification: should the generated addresses themselves be verified,
33493 or should the successful expansion of the original address be enough to verify
33494 it? By default, Exim takes the following pragmatic approach:
33495
33496 .ilist
33497 When an incoming address is redirected to just one child address, verification
33498 continues with the child address, and if that fails to verify, the original
33499 verification also fails.
33500 .next
33501 When an incoming address is redirected to more than one child address,
33502 verification does not continue. A success result is returned.
33503 .endlist
33504
33505 This seems the most reasonable behaviour for the common use of aliasing as a
33506 way of redirecting different local parts to the same mailbox. It means, for
33507 example, that a pair of alias entries of the form
33508 .code
33509 A.Wol:   aw123
33510 aw123:   :fail: Gone away, no forwarding address
33511 .endd
33512 work as expected, with both local parts causing verification failure. When a
33513 redirection generates more than one address, the behaviour is more like a
33514 mailing list, where the existence of the alias itself is sufficient for
33515 verification to succeed.
33516
33517 It is possible, however, to change the default behaviour so that all successful
33518 redirections count as successful verifications, however many new addresses are
33519 generated. This is specified by the &%success_on_redirect%& verification
33520 option. For example:
33521 .code
33522 require verify = recipient/success_on_redirect/callout=10s
33523 .endd
33524 In this example, verification succeeds if a router generates a new address, and
33525 the callout does not occur, because no address was routed to a remote host.
33526
33527 When verification is being tested via the &%-bv%& option, the treatment of
33528 redirections is as just described, unless the &%-v%& or any debugging option is
33529 also specified. In that case, full verification is done for every generated
33530 address and a report is output for each of them.
33531
33532
33533
33534 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
33535 .cindex "CSA" "verifying"
33536 Client SMTP Authorization is a system that allows a site to advertise
33537 which machines are and are not permitted to send email. This is done by placing
33538 special SRV records in the DNS; these are looked up using the client's HELO
33539 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
33540 Authorization checks in Exim are performed by the ACL condition:
33541 .code
33542 verify = csa
33543 .endd
33544 This fails if the client is not authorized. If there is a DNS problem, or if no
33545 valid CSA SRV record is found, or if the client is authorized, the condition
33546 succeeds. These three cases can be distinguished using the expansion variable
33547 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
33548 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
33549 be likely to cause problems for legitimate email.
33550
33551 The error messages produced by the CSA code include slightly more
33552 detail. If &$csa_status$& is &"defer"&, this may be because of problems
33553 looking up the CSA SRV record, or problems looking up the CSA target
33554 address record. There are four reasons for &$csa_status$& being &"fail"&:
33555
33556 .ilist
33557 The client's host name is explicitly not authorized.
33558 .next
33559 The client's IP address does not match any of the CSA target IP addresses.
33560 .next
33561 The client's host name is authorized but it has no valid target IP addresses
33562 (for example, the target's addresses are IPv6 and the client is using IPv4).
33563 .next
33564 The client's host name has no CSA SRV record but a parent domain has asserted
33565 that all subdomains must be explicitly authorized.
33566 .endlist
33567
33568 The &%csa%& verification condition can take an argument which is the domain to
33569 use for the DNS query. The default is:
33570 .code
33571 verify = csa/$sender_helo_name
33572 .endd
33573 This implementation includes an extension to CSA. If the query domain
33574 is an address literal such as [192.0.2.95], or if it is a bare IP
33575 address, Exim searches for CSA SRV records in the reverse DNS as if
33576 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
33577 meaningful to say:
33578 .code
33579 verify = csa/$sender_host_address
33580 .endd
33581 In fact, this is the check that Exim performs if the client does not say HELO.
33582 This extension can be turned off by setting the main configuration option
33583 &%dns_csa_use_reverse%& to be false.
33584
33585 If a CSA SRV record is not found for the domain itself, a search
33586 is performed through its parent domains for a record which might be
33587 making assertions about subdomains. The maximum depth of this search is limited
33588 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
33589 default. Exim does not look for CSA SRV records in a top level domain, so the
33590 default settings handle HELO domains as long as seven
33591 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
33592 of legitimate HELO domains.
33593
33594 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
33595 direct SRV lookups, this is not sufficient because of the extra parent domain
33596 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
33597 addresses into lookups in the reverse DNS space. The result of a successful
33598 lookup such as:
33599 .code
33600 ${lookup dnsdb {csa=$sender_helo_name}}
33601 .endd
33602 has two space-separated fields: an authorization code and a target host name.
33603 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
33604 authorization required but absent, or &"?"& for unknown.
33605
33606
33607
33608
33609 .section "Bounce address tag validation" "SECTverifyPRVS"
33610 .cindex "BATV, verifying"
33611 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
33612 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
33613 Genuine incoming bounce messages should therefore always be addressed to
33614 recipients that have a valid tag. This scheme is a way of detecting unwanted
33615 bounce messages caused by sender address forgeries (often called &"collateral
33616 spam"&), because the recipients of such messages do not include valid tags.
33617
33618 There are two expansion items to help with the implementation of the BATV
33619 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
33620 the original envelope sender address by using a simple key to add a hash of the
33621 address and some time-based randomizing information. The &%prvs%& expansion
33622 item creates a signed address, and the &%prvscheck%& expansion item checks one.
33623 The syntax of these expansion items is described in section
33624 &<<SECTexpansionitems>>&.
33625 The validity period on signed addresses is seven days.
33626
33627 As an example, suppose the secret per-address keys are stored in an MySQL
33628 database. A query to look up the key for an address could be defined as a macro
33629 like this:
33630 .code
33631 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
33632                 WHERE sender='${quote_mysql:$prvscheck_address}'\
33633                 }{$value}}
33634 .endd
33635 Suppose also that the senders who make use of BATV are defined by an address
33636 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
33637 use this:
33638 .code
33639 # Bounces: drop unsigned addresses for BATV senders
33640 deny senders = :
33641      recipients = +batv_senders
33642      message = This address does not send an unsigned reverse path
33643
33644 # Bounces: In case of prvs-signed address, check signature.
33645 deny senders = :
33646      condition  = ${prvscheck {$local_part@$domain}\
33647                   {PRVSCHECK_SQL}{1}}
33648      !condition = $prvscheck_result
33649      message = Invalid reverse path signature.
33650 .endd
33651 The first statement rejects recipients for bounce messages that are addressed
33652 to plain BATV sender addresses, because it is known that BATV senders do not
33653 send out messages with plain sender addresses. The second statement rejects
33654 recipients that are prvs-signed, but with invalid signatures (either because
33655 the key is wrong, or the signature has timed out).
33656
33657 A non-prvs-signed address is not rejected by the second statement, because the
33658 &%prvscheck%& expansion yields an empty string if its first argument is not a
33659 prvs-signed address, thus causing the &%condition%& condition to be false. If
33660 the first argument is a syntactically valid prvs-signed address, the yield is
33661 the third string (in this case &"1"&), whether or not the cryptographic and
33662 timeout checks succeed. The &$prvscheck_result$& variable contains the result
33663 of the checks (empty for failure, &"1"& for success).
33664
33665 There is one more issue you must consider when implementing prvs-signing:
33666 you have to ensure that the routers accept prvs-signed addresses and
33667 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
33668 router to remove the signature with a configuration along these lines:
33669 .code
33670 batv_redirect:
33671   driver = redirect
33672   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
33673 .endd
33674 This works because, if the third argument of &%prvscheck%& is empty, the result
33675 of the expansion of a prvs-signed address is the decoded value of the original
33676 address. This router should probably be the first of your routers that handles
33677 local addresses.
33678
33679 To create BATV-signed addresses in the first place, a transport of this form
33680 can be used:
33681 .code
33682 external_smtp_batv:
33683   driver = smtp
33684   return_path = ${prvs {$return_path} \
33685                        {${lookup mysql{SELECT \
33686                        secret FROM batv_prvs WHERE \
33687                        sender='${quote_mysql:$sender_address}'} \
33688                        {$value}fail}}}
33689 .endd
33690 If no key can be found for the existing return path, no signing takes place.
33691
33692
33693
33694 .section "Using an ACL to control relaying" "SECTrelaycontrol"
33695 .cindex "&ACL;" "relay control"
33696 .cindex "relaying" "control by ACL"
33697 .cindex "policy control" "relay control"
33698 An MTA is said to &'relay'& a message if it receives it from some host and
33699 delivers it directly to another host as a result of a remote address contained
33700 within it. Redirecting a local address via an alias or forward file and then
33701 passing the message on to another host is not relaying,
33702 .cindex "&""percent hack""&"
33703 but a redirection as a result of the &"percent hack"& is.
33704
33705 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
33706 A host which is acting as a gateway or an MX backup is concerned with incoming
33707 relaying from arbitrary hosts to a specific set of domains. On the other hand,
33708 a host which is acting as a smart host for a number of clients is concerned
33709 with outgoing relaying from those clients to the Internet at large. Often the
33710 same host is fulfilling both functions,
33711 . ///
33712 . as illustrated in the diagram below,
33713 . ///
33714 but in principle these two kinds of relaying are entirely independent. What is
33715 not wanted is the transmission of mail from arbitrary remote hosts through your
33716 system to arbitrary domains.
33717
33718
33719 You can implement relay control by means of suitable statements in the ACL that
33720 runs for each RCPT command. For convenience, it is often easiest to use
33721 Exim's named list facility to define the domains and hosts involved. For
33722 example, suppose you want to do the following:
33723
33724 .ilist
33725 Deliver a number of domains to mailboxes on the local host (or process them
33726 locally in some other way). Let's say these are &'my.dom1.example'& and
33727 &'my.dom2.example'&.
33728 .next
33729 Relay mail for a number of other domains for which you are the secondary MX.
33730 These might be &'friend1.example'& and &'friend2.example'&.
33731 .next
33732 Relay mail from the hosts on your local LAN, to whatever domains are involved.
33733 Suppose your LAN is 192.168.45.0/24.
33734 .endlist
33735
33736
33737 In the main part of the configuration, you put the following definitions:
33738 .code
33739 domainlist local_domains    = my.dom1.example : my.dom2.example
33740 domainlist relay_to_domains = friend1.example : friend2.example
33741 hostlist   relay_from_hosts = 192.168.45.0/24
33742 .endd
33743 Now you can use these definitions in the ACL that is run for every RCPT
33744 command:
33745 .code
33746 acl_check_rcpt:
33747   accept domains = +local_domains : +relay_to_domains
33748   accept hosts   = +relay_from_hosts
33749 .endd
33750 The first statement accepts any RCPT command that contains an address in
33751 the local or relay domains. For any other domain, control passes to the second
33752 statement, which accepts the command only if it comes from one of the relay
33753 hosts. In practice, you will probably want to make your ACL more sophisticated
33754 than this, for example, by including sender and recipient verification. The
33755 default configuration includes a more comprehensive example, which is described
33756 in chapter &<<CHAPdefconfil>>&.
33757
33758
33759
33760 .section "Checking a relay configuration" "SECTcheralcon"
33761 .cindex "relaying" "checking control of"
33762 You can check the relay characteristics of your configuration in the same way
33763 that you can test any ACL behaviour for an incoming SMTP connection, by using
33764 the &%-bh%& option to run a fake SMTP session with which you interact.
33765 .ecindex IIDacl
33766
33767
33768
33769 . ////////////////////////////////////////////////////////////////////////////
33770 . ////////////////////////////////////////////////////////////////////////////
33771
33772 .chapter "Content scanning at ACL time" "CHAPexiscan"
33773 .scindex IIDcosca "content scanning" "at ACL time"
33774 The extension of Exim to include content scanning at ACL time, formerly known
33775 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
33776 was integrated into the main source for Exim release 4.50, and Tom continues to
33777 maintain it. Most of the wording of this chapter is taken from Tom's
33778 specification.
33779
33780 It is also possible to scan the content of messages at other times. The
33781 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
33782 scanning after all the ACLs have run. A transport filter can be used to scan
33783 messages at delivery time (see the &%transport_filter%& option, described in
33784 chapter &<<CHAPtransportgeneric>>&).
33785
33786 If you want to include the ACL-time content-scanning features when you compile
33787 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
33788 &_Local/Makefile_&. When you do that, the Exim binary is built with:
33789
33790 .ilist
33791 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
33792 for all MIME parts for SMTP and non-SMTP messages, respectively.
33793 .next
33794 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
33795 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
33796 run at the end of message reception (the &%acl_smtp_data%& ACL).
33797 .next
33798 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
33799 of messages, or parts of messages, for debugging purposes.
33800 .next
33801 Additional expansion variables that are set in the new ACL and by the new
33802 conditions.
33803 .next
33804 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
33805 .endlist
33806
33807 Content-scanning is continually evolving, and new features are still being
33808 added. While such features are still unstable and liable to incompatible
33809 changes, they are made available in Exim by setting options whose names begin
33810 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
33811 this manual. You can find out about them by reading the file called
33812 &_doc/experimental.txt_&.
33813
33814 All the content-scanning facilities work on a MBOX copy of the message that is
33815 temporarily created in a file called:
33816 .display
33817 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
33818 .endd
33819 The &_.eml_& extension is a friendly hint to virus scanners that they can
33820 expect an MBOX-like structure inside that file. The file is created when the
33821 first content scanning facility is called. Subsequent calls to content
33822 scanning conditions open the same file again. The directory is recursively
33823 removed when the &%acl_smtp_data%& ACL has finished running, unless
33824 .code
33825 control = no_mbox_unspool
33826 .endd
33827 has been encountered. When the MIME ACL decodes files, they are put into the
33828 same directory by default.
33829
33830
33831
33832 .section "Scanning for viruses" "SECTscanvirus"
33833 .cindex "virus scanning"
33834 .cindex "content scanning" "for viruses"
33835 .cindex "content scanning" "the &%malware%& condition"
33836 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
33837 It supports a &"generic"& interface to scanners called via the shell, and
33838 specialized interfaces for &"daemon"& type virus scanners, which are resident
33839 in memory and thus are much faster.
33840
33841 Since message data needs to have arrived,
33842 the condition may be only called in ACL defined by
33843 &%acl_smtp_data%&,
33844 &%acl_smtp_data_prdr%&,
33845 &%acl_smtp_mime%& or
33846 &%acl_smtp_dkim%&
33847
33848 A timeout of 2 minutes is applied to a scanner call (by default);
33849 if it expires then a defer action is taken.
33850
33851 .oindex "&%av_scanner%&"
33852 You can set the &%av_scanner%& option in the main part of the configuration
33853 to specify which scanner to use, together with any additional options that
33854 are needed. The basic syntax is as follows:
33855 .display
33856 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
33857 .endd
33858 If you do not set &%av_scanner%&, it defaults to
33859 .code
33860 av_scanner = sophie:/var/run/sophie
33861 .endd
33862 If the value of &%av_scanner%& starts with a dollar character, it is expanded
33863 before use.
33864 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
33865 The following scanner types are supported in this release,
33866 though individual ones can be included or not at build time:
33867
33868 .vlist
33869 .vitem &%avast%&
33870 .cindex "virus scanners" "avast"
33871 This is the scanner daemon of Avast. It has been tested with Avast Core
33872 Security (currently at version 2.2.0).
33873 You can get a trial version at &url(https://www.avast.com) or for Linux
33874 at &url(https://www.avast.com/linux-server-antivirus).
33875 This scanner type takes one option,
33876 which can be either a full path to a UNIX socket,
33877 or host and port specifiers separated by white space.
33878 The host may be a name or an IP address; the port is either a
33879 single number or a pair of numbers with a dash between.
33880 A list of options may follow. These options are interpreted on the
33881 Exim's side of the malware scanner, or are given on separate lines to
33882 the daemon as options before the main scan command.
33883
33884 .cindex &`pass_unscanned`& "avast"
33885 If &`pass_unscanned`&
33886 is set, any files the Avast scanner can't scan (e.g.
33887 decompression bombs, or invalid archives) are considered clean. Use with
33888 care.
33889
33890 For example:
33891 .code
33892 av_scanner = avast:/var/run/avast/scan.sock:FLAGS -fullfiles:SENSITIVITY -pup
33893 av_scanner = avast:/var/run/avast/scan.sock:pass_unscanned:FLAGS -fullfiles:SENSITIVITY -pup
33894 av_scanner = avast:192.168.2.22 5036
33895 .endd
33896 If you omit the argument, the default path
33897 &_/var/run/avast/scan.sock_&
33898 is used.
33899 If you use a remote host,
33900 you need to make Exim's spool directory available to it,
33901 as the scanner is passed a file path, not file contents.
33902 For information about available commands and their options you may use
33903 .code
33904 $ socat UNIX:/var/run/avast/scan.sock STDIO:
33905     FLAGS
33906     SENSITIVITY
33907     PACK
33908 .endd
33909
33910 If the scanner returns a temporary failure (e.g. license issues, or
33911 permission problems), the message is deferred and a paniclog entry is
33912 written.  The usual &`defer_ok`& option is available.
33913
33914 .vitem &%aveserver%&
33915 .cindex "virus scanners" "Kaspersky"
33916 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
33917 at &url(https://www.kaspersky.com/). This scanner type takes one option,
33918 which is the path to the daemon's UNIX socket. The default is shown in this
33919 example:
33920 .code
33921 av_scanner = aveserver:/var/run/aveserver
33922 .endd
33923
33924
33925 .vitem &%clamd%&
33926 .cindex "virus scanners" "clamd"
33927 This daemon-type scanner is GPL and free. You can get it at
33928 &url(https://www.clamav.net/). Some older versions of clamd do not seem to
33929 unpack MIME containers, so it used to be recommended to unpack MIME attachments
33930 in the MIME ACL. This is no longer believed to be necessary.
33931
33932 The options are a list of server specifiers, which may be
33933 a UNIX socket specification,
33934 a TCP socket specification,
33935 or a (global) option.
33936
33937 A socket specification consists of a space-separated list.
33938 For a Unix socket the first element is a full path for the socket,
33939 for a TCP socket the first element is the IP address
33940 and the second a port number,
33941 Any further elements are per-server (non-global) options.
33942 These per-server options are supported:
33943 .code
33944 retry=<timespec>        Retry on connect fail
33945 .endd
33946
33947 The &`retry`& option specifies a time after which a single retry for
33948 a failed connect is made.  The default is to not retry.
33949
33950 If a Unix socket file is specified, only one server is supported.
33951
33952 Examples:
33953 .code
33954 av_scanner = clamd:/opt/clamd/socket
33955 av_scanner = clamd:192.0.2.3 1234
33956 av_scanner = clamd:192.0.2.3 1234:local
33957 av_scanner = clamd:192.0.2.3 1234 retry=10s
33958 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
33959 .endd
33960 If the value of av_scanner points to a UNIX socket file or contains the
33961 &`local`&
33962 option, then the ClamAV interface will pass a filename containing the data
33963 to be scanned, which should normally result in less I/O happening and be
33964 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
33965 Exim does not assume that there is a common filesystem with the remote host.
33966
33967 The final example shows that multiple TCP targets can be specified.  Exim will
33968 randomly use one for each incoming email (i.e. it load balances them).  Note
33969 that only TCP targets may be used if specifying a list of scanners; a UNIX
33970 socket cannot be mixed in with TCP targets.  If one of the servers becomes
33971 unavailable, Exim will try the remaining one(s) until it finds one that works.
33972 When a clamd server becomes unreachable, Exim will log a message.  Exim does
33973 not keep track of scanner state between multiple messages, and the scanner
33974 selection is random, so the message will get logged in the mainlog for each
33975 email that the down scanner gets chosen first (message wrapped to be readable):
33976 .code
33977 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
33978    clamd: connection to localhost, port 3310 failed
33979    (Connection refused)
33980 .endd
33981
33982 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
33983 contributing the code for this scanner.
33984
33985 .vitem &%cmdline%&
33986 .cindex "virus scanners" "command line interface"
33987 This is the keyword for the generic command line scanner interface. It can be
33988 used to attach virus scanners that are invoked from the shell. This scanner
33989 type takes 3 mandatory options:
33990
33991 .olist
33992 The full path and name of the scanner binary, with all command line options,
33993 and a placeholder (&`%s`&) for the directory to scan.
33994
33995 .next
33996 A regular expression to match against the STDOUT and STDERR output of the
33997 virus scanner. If the expression matches, a virus was found. You must make
33998 absolutely sure that this expression matches on &"virus found"&. This is called
33999 the &"trigger"& expression.
34000
34001 .next
34002 Another regular expression, containing exactly one pair of parentheses, to
34003 match the name of the virus found in the scanners output. This is called the
34004 &"name"& expression.
34005 .endlist olist
34006
34007 For example, Sophos Sweep reports a virus on a line like this:
34008 .code
34009 Virus 'W32/Magistr-B' found in file ./those.bat
34010 .endd
34011 For the trigger expression, we can match the phrase &"found in file"&. For the
34012 name expression, we want to extract the W32/Magistr-B string, so we can match
34013 for the single quotes left and right of it. Altogether, this makes the
34014 configuration setting:
34015 .code
34016 av_scanner = cmdline:\
34017              /path/to/sweep -ss -all -rec -archive %s:\
34018              found in file:'(.+)'
34019 .endd
34020 .vitem &%drweb%&
34021 .cindex "virus scanners" "DrWeb"
34022 The DrWeb daemon scanner (&url(https://www.sald.ru/)) interface
34023 takes one option,
34024 either a full path to a UNIX socket,
34025 or host and port specifiers separated by white space.
34026 The host may be a name or an IP address; the port is either a
34027 single number or a pair of numbers with a dash between.
34028 For example:
34029 .code
34030 av_scanner = drweb:/var/run/drwebd.sock
34031 av_scanner = drweb:192.168.2.20 31337
34032 .endd
34033 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
34034 is used. Thanks to Alex Miller for contributing the code for this scanner.
34035
34036 .vitem &%f-protd%&
34037 .cindex "virus scanners" "f-protd"
34038 The f-protd scanner is accessed via HTTP over TCP.
34039 One argument is taken, being a space-separated hostname and port number
34040 (or port-range).
34041 For example:
34042 .code
34043 av_scanner = f-protd:localhost 10200-10204
34044 .endd
34045 If you omit the argument, the default values shown above are used.
34046
34047 .vitem &%f-prot6d%&
34048 .cindex "virus scanners" "f-prot6d"
34049 The f-prot6d scanner is accessed using the FPSCAND protocol over TCP.
34050 One argument is taken, being a space-separated hostname and port number.
34051 For example:
34052 .code
34053 av_scanner = f-prot6d:localhost 10200
34054 .endd
34055 If you omit the argument, the default values show above are used.
34056
34057 .vitem &%fsecure%&
34058 .cindex "virus scanners" "F-Secure"
34059 The F-Secure daemon scanner (&url(https://www.f-secure.com/)) takes one
34060 argument which is the path to a UNIX socket. For example:
34061 .code
34062 av_scanner = fsecure:/path/to/.fsav
34063 .endd
34064 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
34065 Thelmen for contributing the code for this scanner.
34066
34067 .vitem &%kavdaemon%&
34068 .cindex "virus scanners" "Kaspersky"
34069 This is the scanner daemon of Kaspersky Version 4. This version of the
34070 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
34071 scanner type takes one option, which is the path to the daemon's UNIX socket.
34072 For example:
34073 .code
34074 av_scanner = kavdaemon:/opt/AVP/AvpCtl
34075 .endd
34076 The default path is &_/var/run/AvpCtl_&.
34077
34078 .vitem &%mksd%&
34079 .cindex "virus scanners" "mksd"
34080 This was a daemon type scanner that is aimed mainly at Polish users,
34081 though some documentation was available in English.
34082 The history can be shown at &url(https://en.wikipedia.org/wiki/Mks_vir)
34083 and this appears to be a candidate for removal from Exim, unless
34084 we are informed of other virus scanners which use the same protocol
34085 to integrate.
34086 The only option for this scanner type is
34087 the maximum number of processes used simultaneously to scan the attachments,
34088 provided that mksd has
34089 been run with at least the same number of child processes. For example:
34090 .code
34091 av_scanner = mksd:2
34092 .endd
34093 You can safely omit this option (the default value is 1).
34094
34095 .vitem &%sock%&
34096 .cindex "virus scanners" "simple socket-connected"
34097 This is a general-purpose way of talking to simple scanner daemons
34098 running on the local machine.
34099 There are four options:
34100 an address (which may be an IP address and port, or the path of a Unix socket),
34101 a commandline to send (may include a single %s which will be replaced with
34102 the path to the mail file to be scanned),
34103 an RE to trigger on from the returned data,
34104 and an RE to extract malware_name from the returned data.
34105 For example:
34106 .code
34107 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)$
34108 .endd
34109 Note that surrounding whitespace is stripped from each option, meaning
34110 there is no way to specify a trailing newline.
34111 The socket specifier and both regular-expressions are required.
34112 Default for the commandline is &_%s\n_& (note this does have a trailing newline);
34113 specify an empty element to get this.
34114
34115 .vitem &%sophie%&
34116 .cindex "virus scanners" "Sophos and Sophie"
34117 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
34118 You can get Sophie at &url(http://sophie.sourceforge.net/). The only option
34119 for this scanner type is the path to the UNIX socket that Sophie uses for
34120 client communication. For example:
34121 .code
34122 av_scanner = sophie:/tmp/sophie
34123 .endd
34124 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
34125 the option.
34126 .endlist
34127
34128 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
34129 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
34130 ACL.
34131
34132 The &%av_scanner%& option is expanded each time &%malware%& is called. This
34133 makes it possible to use different scanners. See further below for an example.
34134 The &%malware%& condition caches its results, so when you use it multiple times
34135 for the same message, the actual scanning process is only carried out once.
34136 However, using expandable items in &%av_scanner%& disables this caching, in
34137 which case each use of the &%malware%& condition causes a new scan of the
34138 message.
34139
34140 The &%malware%& condition takes a right-hand argument that is expanded before
34141 use and taken as a list, slash-separated by default.
34142 The first element can then be one of
34143
34144 .ilist
34145 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
34146 The condition succeeds if a virus was found, and fail otherwise. This is the
34147 recommended usage.
34148 .next
34149 &"false"& or &"0"& or an empty string, in which case no scanning is done and
34150 the condition fails immediately.
34151 .next
34152 A regular expression, in which case the message is scanned for viruses. The
34153 condition succeeds if a virus is found and its name matches the regular
34154 expression. This allows you to take special actions on certain types of virus.
34155 Note that &"/"& characters in the RE must be doubled due to the list-processing,
34156 unless the separator is changed (in the usual way &<<SECTlistsepchange>>&).
34157 .endlist
34158
34159 You can append a &`defer_ok`& element to the &%malware%& argument list to accept
34160 messages even if there is a problem with the virus scanner.
34161 Otherwise, such a problem causes the ACL to defer.
34162
34163 You can append a &`tmo=<val>`& element to the &%malware%& argument list to
34164 specify a non-default timeout.  The default is two minutes.
34165 For example:
34166 .code
34167 malware = * / defer_ok / tmo=10s
34168 .endd
34169 A timeout causes the ACL to defer.
34170
34171 .vindex "&$callout_address$&"
34172 When a connection is made to the scanner the expansion variable &$callout_address$&
34173 is set to record the actual address used.
34174
34175 .vindex "&$malware_name$&"
34176 When a virus is found, the condition sets up an expansion variable called
34177 &$malware_name$& that contains the name of the virus. You can use it in a
34178 &%message%& modifier that specifies the error returned to the sender, and/or in
34179 logging data.
34180
34181 Beware the interaction of Exim's &%message_size_limit%& with any size limits
34182 imposed by your anti-virus scanner.
34183
34184 Here is a very simple scanning example:
34185 .code
34186 deny malware = *
34187      message = This message contains malware ($malware_name)
34188 .endd
34189 The next example accepts messages when there is a problem with the scanner:
34190 .code
34191 deny malware = */defer_ok
34192      message = This message contains malware ($malware_name)
34193 .endd
34194 The next example shows how to use an ACL variable to scan with both sophie and
34195 aveserver. It assumes you have set:
34196 .code
34197 av_scanner = $acl_m0
34198 .endd
34199 in the main Exim configuration.
34200 .code
34201 deny set acl_m0 = sophie
34202      malware = *
34203      message = This message contains malware ($malware_name)
34204
34205 deny set acl_m0 = aveserver
34206      malware = *
34207      message = This message contains malware ($malware_name)
34208 .endd
34209
34210
34211 .section "Scanning with SpamAssassin and Rspamd" "SECTscanspamass"
34212 .cindex "content scanning" "for spam"
34213 .cindex "spam scanning"
34214 .cindex "SpamAssassin"
34215 .cindex "Rspamd"
34216 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
34217 score and a report for the message.
34218 Support is also provided for Rspamd.
34219
34220 For more information about installation and configuration of SpamAssassin or
34221 Rspamd refer to their respective websites at
34222 &url(https://spamassassin.apache.org/) and &url(https://www.rspamd.com/)
34223
34224 SpamAssassin can be installed with CPAN by running:
34225 .code
34226 perl -MCPAN -e 'install Mail::SpamAssassin'
34227 .endd
34228 SpamAssassin has its own set of configuration files. Please review its
34229 documentation to see how you can tweak it. The default installation should work
34230 nicely, however.
34231
34232 .oindex "&%spamd_address%&"
34233 By default, SpamAssassin listens on 127.0.0.1, TCP port 783 and if you
34234 intend to use an instance running on the local host you do not need to set
34235 &%spamd_address%&. If you intend to use another host or port for SpamAssassin,
34236 you must set the &%spamd_address%& option in the global part of the Exim
34237 configuration as follows (example):
34238 .code
34239 spamd_address = 192.168.99.45 783
34240 .endd
34241 The SpamAssassin protocol relies on a TCP half-close from the client.
34242 If your SpamAssassin client side is running a Linux system with an
34243 iptables firewall, consider setting
34244 &%net.netfilter.nf_conntrack_tcp_timeout_close_wait%& to at least the
34245 timeout, Exim uses when waiting for a response from the SpamAssassin
34246 server (currently defaulting to 120s).  With a lower value the Linux
34247 connection tracking may consider your half-closed connection as dead too
34248 soon.
34249
34250
34251 To use Rspamd (which by default listens on all local addresses
34252 on TCP port 11333)
34253 you should add &%variant=rspamd%& after the address/port pair, for example:
34254 .code
34255 spamd_address = 127.0.0.1 11333 variant=rspamd
34256 .endd
34257
34258 As of version 2.60, &%SpamAssassin%& also supports communication over UNIX
34259 sockets. If you want to us these, supply &%spamd_address%& with an absolute
34260 filename instead of an address/port pair:
34261 .code
34262 spamd_address = /var/run/spamd_socket
34263 .endd
34264 You can have multiple &%spamd%& servers to improve scalability. These can
34265 reside on other hardware reachable over the network. To specify multiple
34266 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
34267 option, separated with colons (the separator can be changed in the usual way &<<SECTlistsepchange>>&):
34268 .code
34269 spamd_address = 192.168.2.10 783 : \
34270                 192.168.2.11 783 : \
34271                 192.168.2.12 783
34272 .endd
34273 Up to 32 &%spamd%& servers are supported.
34274 When a server fails to respond to the connection attempt, all other
34275 servers are tried until one succeeds. If no server responds, the &%spam%&
34276 condition defers.
34277
34278 Unix and TCP socket specifications may be mixed in any order.
34279 Each element of the list is a list itself, space-separated by default
34280 and changeable in the usual way (&<<SECTlistsepchange>>&);
34281 take care to not double the separator.
34282
34283 For TCP socket specifications a host name or IP (v4 or v6, but
34284 subject to list-separator quoting rules) address can be used,
34285 and the port can be one or a dash-separated pair.
34286 In the latter case, the range is tried in strict order.
34287
34288 Elements after the first for Unix sockets, or second for TCP socket,
34289 are options.
34290 The supported options are:
34291 .code
34292 pri=<priority>      Selection priority
34293 weight=<value>      Selection bias
34294 time=<start>-<end>  Use only between these times of day
34295 retry=<timespec>    Retry on connect fail
34296 tmo=<timespec>      Connection time limit
34297 variant=rspamd      Use Rspamd rather than SpamAssassin protocol
34298 .endd
34299
34300 The &`pri`& option specifies a priority for the server within the list,
34301 higher values being tried first.
34302 The default priority is 1.
34303
34304 The &`weight`& option specifies a selection bias.
34305 Within a priority set
34306 servers are queried in a random fashion, weighted by this value.
34307 The default value for selection bias is 1.
34308
34309 Time specifications for the &`time`& option are <hour>.<minute>.<second>
34310 in the local time zone; each element being one or more digits.
34311 Either the seconds or both minutes and seconds, plus the leading &`.`&
34312 characters, may be omitted and will be taken as zero.
34313
34314 Timeout specifications for the &`retry`& and &`tmo`& options
34315 are the usual Exim time interval standard, e.g. &`20s`& or &`1m`&.
34316
34317 The &`tmo`& option specifies an overall timeout for communication.
34318 The default value is two minutes.
34319
34320 The &`retry`& option specifies a time after which a single retry for
34321 a failed connect is made.
34322 The default is to not retry.
34323
34324 The &%spamd_address%& variable is expanded before use if it starts with
34325 a dollar sign. In this case, the expansion may return a string that is
34326 used as the list so that multiple spamd servers can be the result of an
34327 expansion.
34328
34329 .vindex "&$callout_address$&"
34330 When a connection is made to the server the expansion variable &$callout_address$&
34331 is set to record the actual address used.
34332
34333 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
34334 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
34335 .code
34336 deny spam = joe
34337      message = This message was classified as SPAM
34338 .endd
34339 The right-hand side of the &%spam%& condition specifies a name. This is
34340 relevant if you have set up multiple SpamAssassin profiles. If you do not want
34341 to scan using a specific profile, but rather use the SpamAssassin system-wide
34342 default profile, you can scan for an unknown name, or simply use &"nobody"&.
34343 Rspamd does not use this setting. However, you must put something on the
34344 right-hand side.
34345
34346 The name allows you to use per-domain or per-user antispam profiles in
34347 principle, but this is not straightforward in practice, because a message may
34348 have multiple recipients, not necessarily all in the same domain. Because the
34349 &%spam%& condition has to be called from a DATA-time ACL in order to be able to
34350 read the contents of the message, the variables &$local_part$& and &$domain$&
34351 are not set.
34352 Careful enforcement of single-recipient messages
34353 (e.g. by responding with defer in the recipient ACL for all recipients
34354 after the first),
34355 or the use of PRDR,
34356 .cindex "PRDR" "use for per-user SpamAssassin profiles"
34357 are needed to use this feature.
34358
34359 The right-hand side of the &%spam%& condition is expanded before being used, so
34360 you can put lookups or conditions there. When the right-hand side evaluates to
34361 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
34362
34363
34364 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
34365 large ones may cause significant performance degradation. As most spam messages
34366 are quite small, it is recommended that you do not scan the big ones. For
34367 example:
34368 .code
34369 deny condition = ${if < {$message_size}{10K}}
34370      spam = nobody
34371      message = This message was classified as SPAM
34372 .endd
34373
34374 The &%spam%& condition returns true if the threshold specified in the user's
34375 SpamAssassin profile has been matched or exceeded. If you want to use the
34376 &%spam%& condition for its side effects (see the variables below), you can make
34377 it always return &"true"& by appending &`:true`& to the username.
34378
34379 .cindex "spam scanning" "returned variables"
34380 When the &%spam%& condition is run, it sets up a number of expansion
34381 variables.
34382 Except for &$spam_report$&,
34383 these variables are saved with the received message so are
34384 available for use at delivery time.
34385
34386 .vlist
34387 .vitem &$spam_score$&
34388 The spam score of the message, for example, &"3.4"& or &"30.5"&. This is useful
34389 for inclusion in log or reject messages.
34390
34391 .vitem &$spam_score_int$&
34392 The spam score of the message, multiplied by ten, as an integer value. For
34393 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
34394 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
34395 The integer value is useful for numeric comparisons in conditions.
34396
34397 .vitem &$spam_bar$&
34398 A string consisting of a number of &"+"& or &"-"& characters, representing the
34399 integer part of the spam score value. A spam score of 4.4 would have a
34400 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
34401 headers, since MUAs can match on such strings. The maximum length of the
34402 spam bar is 50 characters.
34403
34404 .vitem &$spam_report$&
34405 A multiline text table, containing the full SpamAssassin report for the
34406 message. Useful for inclusion in headers or reject messages.
34407 This variable is only usable in a DATA-time ACL.
34408 Beware that SpamAssassin may return non-ASCII characters, especially
34409 when running in country-specific locales, which are not legal
34410 unencoded in headers.
34411
34412 .vitem &$spam_action$&
34413 For SpamAssassin either 'reject' or 'no action' depending on the
34414 spam score versus threshold.
34415 For Rspamd, the recommended action.
34416
34417 .endlist
34418
34419 The &%spam%& condition caches its results unless expansion in
34420 spamd_address was used. If you call it again with the same user name, it
34421 does not scan again, but rather returns the same values as before.
34422
34423 The &%spam%& condition returns DEFER if there is any error while running
34424 the message through SpamAssassin or if the expansion of spamd_address
34425 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
34426 statement block), append &`/defer_ok`& to the right-hand side of the
34427 spam condition, like this:
34428 .code
34429 deny spam    = joe/defer_ok
34430      message = This message was classified as SPAM
34431 .endd
34432 This causes messages to be accepted even if there is a problem with &%spamd%&.
34433
34434 Here is a longer, commented example of the use of the &%spam%&
34435 condition:
34436 .code
34437 # put headers in all messages (no matter if spam or not)
34438 warn  spam = nobody:true
34439       add_header = X-Spam-Score: $spam_score ($spam_bar)
34440       add_header = X-Spam-Report: $spam_report
34441
34442 # add second subject line with *SPAM* marker when message
34443 # is over threshold
34444 warn  spam = nobody
34445       add_header = Subject: *SPAM* $h_Subject:
34446
34447 # reject spam at high scores (> 12)
34448 deny  spam = nobody:true
34449       condition = ${if >{$spam_score_int}{120}{1}{0}}
34450       message = This message scored $spam_score spam points.
34451 .endd
34452
34453
34454
34455 .section "Scanning MIME parts" "SECTscanmimepart"
34456 .cindex "content scanning" "MIME parts"
34457 .cindex "MIME content scanning"
34458 .oindex "&%acl_smtp_mime%&"
34459 .oindex "&%acl_not_smtp_mime%&"
34460 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
34461 each MIME part of an SMTP message, including multipart types, in the sequence
34462 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
34463 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
34464 options may both refer to the same ACL if you want the same processing in both
34465 cases.
34466
34467 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
34468 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
34469 the case of a non-SMTP message. However, a MIME ACL is called only if the
34470 message contains a &'Content-Type:'& header line. When a call to a MIME
34471 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
34472 result code is sent to the client. In the case of an SMTP message, the
34473 &%acl_smtp_data%& ACL is not called when this happens.
34474
34475 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
34476 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
34477 condition to match against the raw MIME part. You can also use the
34478 &%mime_regex%& condition to match against the decoded MIME part (see section
34479 &<<SECTscanregex>>&).
34480
34481 At the start of a MIME ACL, a number of variables are set from the header
34482 information for the relevant MIME part. These are described below. The contents
34483 of the MIME part are not by default decoded into a disk file except for MIME
34484 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
34485 part into a disk file, you can use the &%decode%& condition. The general
34486 syntax is:
34487 .display
34488 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
34489 .endd
34490 The right hand side is expanded before use. After expansion,
34491 the value can be:
34492
34493 .olist
34494 &"0"& or &"false"&, in which case no decoding is done.
34495 .next
34496 The string &"default"&. In that case, the file is put in the temporary
34497 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
34498 a sequential filename consisting of the message id and a sequence number. The
34499 full path and name is available in &$mime_decoded_filename$& after decoding.
34500 .next
34501 A full path name starting with a slash. If the full name is an existing
34502 directory, it is used as a replacement for the default directory. The filename
34503 is then sequentially assigned. If the path does not exist, it is used as
34504 the full path and filename.
34505 .next
34506 If the string does not start with a slash, it is used as the
34507 filename, and the default path is then used.
34508 .endlist
34509 The &%decode%& condition normally succeeds. It is only false for syntax
34510 errors or unusual circumstances such as memory shortages. You can easily decode
34511 a file with its original, proposed filename using
34512 .code
34513 decode = $mime_filename
34514 .endd
34515 However, you should keep in mind that &$mime_filename$& might contain
34516 anything. If you place files outside of the default path, they are not
34517 automatically unlinked.
34518
34519 For RFC822 attachments (these are messages attached to messages, with a
34520 content-type of &"message/rfc822"&), the ACL is called again in the same manner
34521 as for the primary message, only that the &$mime_is_rfc822$& expansion
34522 variable is set (see below). Attached messages are always decoded to disk
34523 before being checked, and the files are unlinked once the check is done.
34524
34525 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
34526 used to match regular expressions against raw and decoded MIME parts,
34527 respectively. They are described in section &<<SECTscanregex>>&.
34528
34529 .cindex "MIME content scanning" "returned variables"
34530 The following list describes all expansion variables that are
34531 available in the MIME ACL:
34532
34533 .vlist
34534 .vitem &$mime_anomaly_level$& &&&
34535        &$mime_anomaly_text$&
34536 .vindex &$mime_anomaly_level$&
34537 .vindex &$mime_anomaly_text$&
34538 If there are problems decoding, these variables contain information on
34539 the detected issue.
34540
34541 .vitem &$mime_boundary$&
34542 .vindex &$mime_boundary$&
34543 If the current part is a multipart (see &$mime_is_multipart$& below), it should
34544 have a boundary string, which is stored in this variable. If the current part
34545 has no boundary parameter in the &'Content-Type:'& header, this variable
34546 contains the empty string.
34547
34548 .vitem &$mime_charset$&
34549 .vindex &$mime_charset$&
34550 This variable contains the character set identifier, if one was found in the
34551 &'Content-Type:'& header. Examples for charset identifiers are:
34552 .code
34553 us-ascii
34554 gb2312 (Chinese)
34555 iso-8859-1
34556 .endd
34557 Please note that this value is not normalized, so you should do matches
34558 case-insensitively.
34559
34560 .vitem &$mime_content_description$&
34561 .vindex &$mime_content_description$&
34562 This variable contains the normalized content of the &'Content-Description:'&
34563 header. It can contain a human-readable description of the parts content. Some
34564 implementations repeat the filename for attachments here, but they are usually
34565 only used for display purposes.
34566
34567 .vitem &$mime_content_disposition$&
34568 .vindex &$mime_content_disposition$&
34569 This variable contains the normalized content of the &'Content-Disposition:'&
34570 header. You can expect strings like &"attachment"& or &"inline"& here.
34571
34572 .vitem &$mime_content_id$&
34573 .vindex &$mime_content_id$&
34574 This variable contains the normalized content of the &'Content-ID:'& header.
34575 This is a unique ID that can be used to reference a part from another part.
34576
34577 .vitem &$mime_content_size$&
34578 .vindex &$mime_content_size$&
34579 This variable is set only after the &%decode%& modifier (see above) has been
34580 successfully run. It contains the size of the decoded part in kilobytes. The
34581 size is always rounded up to full kilobytes, so only a completely empty part
34582 has a &$mime_content_size$& of zero.
34583
34584 .vitem &$mime_content_transfer_encoding$&
34585 .vindex &$mime_content_transfer_encoding$&
34586 This variable contains the normalized content of the
34587 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
34588 type. Typical values are &"base64"& and &"quoted-printable"&.
34589
34590 .vitem &$mime_content_type$&
34591 .vindex &$mime_content_type$&
34592 If the MIME part has a &'Content-Type:'& header, this variable contains its
34593 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
34594 are some examples of popular MIME types, as they may appear in this variable:
34595 .code
34596 text/plain
34597 text/html
34598 application/octet-stream
34599 image/jpeg
34600 audio/midi
34601 .endd
34602 If the MIME part has no &'Content-Type:'& header, this variable contains the
34603 empty string.
34604
34605 .vitem &$mime_decoded_filename$&
34606 .vindex &$mime_decoded_filename$&
34607 This variable is set only after the &%decode%& modifier (see above) has been
34608 successfully run. It contains the full path and filename of the file
34609 containing the decoded data.
34610 .endlist
34611
34612 .cindex "RFC 2047"
34613 .vlist
34614 .vitem &$mime_filename$&
34615 .vindex &$mime_filename$&
34616 This is perhaps the most important of the MIME variables. It contains a
34617 proposed filename for an attachment, if one was found in either the
34618 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
34619 RFC2047
34620 or RFC2231
34621 decoded, but no additional sanity checks are done.
34622  If no filename was
34623 found, this variable contains the empty string.
34624
34625 .vitem &$mime_is_coverletter$&
34626 .vindex &$mime_is_coverletter$&
34627 This variable attempts to differentiate the &"cover letter"& of an e-mail from
34628 attached data. It can be used to clamp down on flashy or unnecessarily encoded
34629 content in the cover letter, while not restricting attachments at all.
34630
34631 The variable contains 1 (true) for a MIME part believed to be part of the
34632 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
34633 follows:
34634
34635 .olist
34636 The outermost MIME part of a message is always a cover letter.
34637
34638 .next
34639 If a multipart/alternative or multipart/related MIME part is a cover letter,
34640 so are all MIME subparts within that multipart.
34641
34642 .next
34643 If any other multipart is a cover letter, the first subpart is a cover letter,
34644 and the rest are attachments.
34645
34646 .next
34647 All parts contained within an attachment multipart are attachments.
34648 .endlist olist
34649
34650 As an example, the following will ban &"HTML mail"& (including that sent with
34651 alternative plain text), while allowing HTML files to be attached. HTML
34652 coverletter mail attached to non-HTML coverletter mail will also be allowed:
34653 .code
34654 deny !condition = $mime_is_rfc822
34655      condition = $mime_is_coverletter
34656      condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
34657      message = HTML mail is not accepted here
34658 .endd
34659
34660 .vitem &$mime_is_multipart$&
34661 .vindex &$mime_is_multipart$&
34662 This variable has the value 1 (true) when the current part has the main type
34663 &"multipart"&, for example, &"multipart/alternative"& or &"multipart/mixed"&.
34664 Since multipart entities only serve as containers for other parts, you may not
34665 want to carry out specific actions on them.
34666
34667 .vitem &$mime_is_rfc822$&
34668 .vindex &$mime_is_rfc822$&
34669 This variable has the value 1 (true) if the current part is not a part of the
34670 checked message itself, but part of an attached message. Attached message
34671 decoding is fully recursive.
34672
34673 .vitem &$mime_part_count$&
34674 .vindex &$mime_part_count$&
34675 This variable is a counter that is raised for each processed MIME part. It
34676 starts at zero for the very first part (which is usually a multipart). The
34677 counter is per-message, so it is reset when processing RFC822 attachments (see
34678 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
34679 complete, so you can use it in the DATA ACL to determine the number of MIME
34680 parts of a message. For non-MIME messages, this variable contains the value -1.
34681 .endlist
34682
34683
34684
34685 .section "Scanning with regular expressions" "SECTscanregex"
34686 .cindex "content scanning" "with regular expressions"
34687 .cindex "regular expressions" "content scanning with"
34688 You can specify your own custom regular expression matches on the full body of
34689 the message, or on individual MIME parts.
34690
34691 The &%regex%& condition takes one or more regular expressions as arguments and
34692 matches them against the full message (when called in the DATA ACL) or a raw
34693 MIME part (when called in the MIME ACL). The &%regex%& condition matches
34694 linewise, with a maximum line length of 32K characters. That means you cannot
34695 have multiline matches with the &%regex%& condition.
34696
34697 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
34698 to 32K of decoded content (the whole content at once, not linewise). If the
34699 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
34700 is decoded automatically when &%mime_regex%& is executed (using default path
34701 and filename values). If the decoded data is larger than  32K, only the first
34702 32K characters are checked.
34703
34704 The regular expressions are passed as a colon-separated list. To include a
34705 literal colon, you must double it. Since the whole right-hand side string is
34706 expanded before being used, you must also escape dollar signs and backslashes
34707 with more backslashes, or use the &`\N`& facility to disable expansion.
34708 Here is a simple example that contains two regular expressions:
34709 .code
34710 deny regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
34711      message = contains blacklisted regex ($regex_match_string)
34712 .endd
34713 The conditions returns true if any one of the regular expressions matches. The
34714 &$regex_match_string$& expansion variable is then set up and contains the
34715 matching regular expression.
34716 The expansion variables &$regex1$& &$regex2$& etc
34717 are set to any substrings captured by the regular expression.
34718
34719 &*Warning*&: With large messages, these conditions can be fairly
34720 CPU-intensive.
34721
34722 .ecindex IIDcosca
34723
34724
34725
34726
34727 . ////////////////////////////////////////////////////////////////////////////
34728 . ////////////////////////////////////////////////////////////////////////////
34729
34730 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
34731          "Local scan function"
34732 .scindex IIDlosca "&[local_scan()]& function" "description of"
34733 .cindex "customizing" "input scan using C function"
34734 .cindex "policy control" "by local scan function"
34735 In these days of email worms, viruses, and ever-increasing spam, some sites
34736 want to apply a lot of checking to messages before accepting them.
34737
34738 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
34739 passing messages to external virus and spam scanning software. You can also do
34740 a certain amount in Exim itself through string expansions and the &%condition%&
34741 condition in the ACL that runs after the SMTP DATA command or the ACL for
34742 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
34743
34744 To allow for further customization to a site's own requirements, there is the
34745 possibility of linking Exim with a private message scanning function, written
34746 in C. If you want to run code that is written in something other than C, you
34747 can of course use a little C stub to call it.
34748
34749 The local scan function is run once for every incoming message, at the point
34750 when Exim is just about to accept the message.
34751 It can therefore be used to control non-SMTP messages from local processes as
34752 well as messages arriving via SMTP.
34753
34754 Exim applies a timeout to calls of the local scan function, and there is an
34755 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
34756 Zero means &"no timeout"&.
34757 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
34758 before calling the local scan function, so that the most common types of crash
34759 are caught. If the timeout is exceeded or one of those signals is caught, the
34760 incoming message is rejected with a temporary error if it is an SMTP message.
34761 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
34762 code. The incident is logged on the main and reject logs.
34763
34764
34765
34766 .section "Building Exim to use a local scan function" "SECID207"
34767 .cindex "&[local_scan()]& function" "building Exim to use"
34768 To make use of the local scan function feature, you must tell Exim where your
34769 function is before building Exim, by setting
34770 both HAVE_LOCAL_SCAN and
34771 LOCAL_SCAN_SOURCE in your
34772 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
34773 directory, so you might set
34774 .code
34775 HAVE_LOCAL_SCAN=yes
34776 LOCAL_SCAN_SOURCE=Local/local_scan.c
34777 .endd
34778 for example. The function must be called &[local_scan()]&;
34779 the source file(s) for it should first #define LOCAL_SCAN
34780 and then #include "local_scan.h".
34781 It is called by
34782 Exim after it has received a message, when the success return code is about to
34783 be sent. This is after all the ACLs have been run. The return code from your
34784 function controls whether the message is actually accepted or not. There is a
34785 commented template function (that just accepts the message) in the file
34786 _src/local_scan.c_.
34787
34788 If you want to make use of Exim's runtime configuration file to set options
34789 for your &[local_scan()]& function, you must also set
34790 .code
34791 LOCAL_SCAN_HAS_OPTIONS=yes
34792 .endd
34793 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
34794
34795
34796
34797
34798 .section "API for local_scan()" "SECTapiforloc"
34799 .cindex "&[local_scan()]& function" "API description"
34800 .cindex &%dlfunc%& "API description"
34801 You must include this line near the start of your code:
34802 .code
34803 #define LOCAL_SCAN
34804 #include "local_scan.h"
34805 .endd
34806 This header file defines a number of variables and other values, and the
34807 prototype for the function itself. Exim is coded to use unsigned char values
34808 almost exclusively, and one of the things this header defines is a shorthand
34809 for &`unsigned char`& called &`uschar`&.
34810 It also makes available the following macro definitions, to simplify casting character
34811 strings and pointers to character strings:
34812 .code
34813 #define CS   (char *)
34814 #define CCS  (const char *)
34815 #define CSS  (char **)
34816 #define US   (unsigned char *)
34817 #define CUS  (const unsigned char *)
34818 #define USS  (unsigned char **)
34819 .endd
34820 The function prototype for &[local_scan()]& is:
34821 .code
34822 extern int local_scan(int fd, uschar **return_text);
34823 .endd
34824 The arguments are as follows:
34825
34826 .ilist
34827 &%fd%& is a file descriptor for the file that contains the body of the message
34828 (the -D file). The file is open for reading and writing, but updating it is not
34829 recommended. &*Warning*&: You must &'not'& close this file descriptor.
34830
34831 The descriptor is positioned at character 19 of the file, which is the first
34832 character of the body itself, because the first 19 characters are the message
34833 id followed by &`-D`& and a newline. If you rewind the file, you should use the
34834 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
34835 case this changes in some future version.
34836 .next
34837 &%return_text%& is an address which you can use to return a pointer to a text
34838 string at the end of the function. The value it points to on entry is NULL.
34839 .endlist
34840
34841 The function must return an &%int%& value which is one of the following macros:
34842
34843 .vlist
34844 .vitem &`LOCAL_SCAN_ACCEPT`&
34845 .vindex "&$local_scan_data$&"
34846 The message is accepted. If you pass back a string of text, it is saved with
34847 the message, and made available in the variable &$local_scan_data$&. No
34848 newlines are permitted (if there are any, they are turned into spaces) and the
34849 maximum length of text is 1000 characters.
34850
34851 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
34852 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
34853 queued without immediate delivery, and is frozen.
34854
34855 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
34856 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
34857 queued without immediate delivery.
34858
34859 .vitem &`LOCAL_SCAN_REJECT`&
34860 The message is rejected; the returned text is used as an error message which is
34861 passed back to the sender and which is also logged. Newlines are permitted &--
34862 they cause a multiline response for SMTP rejections, but are converted to
34863 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
34864 used.
34865
34866 .vitem &`LOCAL_SCAN_TEMPREJECT`&
34867 The message is temporarily rejected; the returned text is used as an error
34868 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
34869 problem"& is used.
34870
34871 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
34872 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
34873 message is not written to the reject log. It has the effect of unsetting the
34874 &%rejected_header%& log selector for just this rejection. If
34875 &%rejected_header%& is already unset (see the discussion of the
34876 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
34877 same as LOCAL_SCAN_REJECT.
34878
34879 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
34880 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
34881 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
34882 .endlist
34883
34884 If the message is not being received by interactive SMTP, rejections are
34885 reported by writing to &%stderr%& or by sending an email, as configured by the
34886 &%-oe%& command line options.
34887
34888
34889
34890 .section "Configuration options for local_scan()" "SECTconoptloc"
34891 .cindex "&[local_scan()]& function" "configuration options"
34892 It is possible to have option settings in the main configuration file
34893 that set values in static variables in the &[local_scan()]& module. If you
34894 want to do this, you must have the line
34895 .code
34896 LOCAL_SCAN_HAS_OPTIONS=yes
34897 .endd
34898 in your &_Local/Makefile_& when you build Exim. (This line is in
34899 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
34900 file, you must define static variables to hold the option values, and a table
34901 to define them.
34902
34903 The table must be a vector called &%local_scan_options%&, of type
34904 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
34905 and a pointer to the variable that holds the value. The entries must appear in
34906 alphabetical order. Following &%local_scan_options%& you must also define a
34907 variable called &%local_scan_options_count%& that contains the number of
34908 entries in the table. Here is a short example, showing two kinds of option:
34909 .code
34910 static int my_integer_option = 42;
34911 static uschar *my_string_option = US"a default string";
34912
34913 optionlist local_scan_options[] = {
34914   { "my_integer", opt_int,       &my_integer_option },
34915   { "my_string",  opt_stringptr, &my_string_option }
34916 };
34917
34918 int local_scan_options_count =
34919   sizeof(local_scan_options)/sizeof(optionlist);
34920 .endd
34921 The values of the variables can now be changed from Exim's runtime
34922 configuration file by including a local scan section as in this example:
34923 .code
34924 begin local_scan
34925 my_integer = 99
34926 my_string = some string of text...
34927 .endd
34928 The available types of option data are as follows:
34929
34930 .vlist
34931 .vitem &*opt_bool*&
34932 This specifies a boolean (true/false) option. The address should point to a
34933 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
34934 that are defined as &"1"& and &"0"&, respectively. If you want to detect
34935 whether such a variable has been set at all, you can initialize it to
34936 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
34937 values.)
34938
34939 .vitem &*opt_fixed*&
34940 This specifies a fixed point number, such as is used for load averages.
34941 The address should point to a variable of type &`int`&. The value is stored
34942 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
34943
34944 .vitem &*opt_int*&
34945 This specifies an integer; the address should point to a variable of type
34946 &`int`&. The value may be specified in any of the integer formats accepted by
34947 Exim.
34948
34949 .vitem &*opt_mkint*&
34950 This is the same as &%opt_int%&, except that when such a value is output in a
34951 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
34952 printed with the suffix K or M.
34953
34954 .vitem &*opt_octint*&
34955 This also specifies an integer, but the value is always interpreted as an
34956 octal integer, whether or not it starts with the digit zero, and it is
34957 always output in octal.
34958
34959 .vitem &*opt_stringptr*&
34960 This specifies a string value; the address must be a pointer to a
34961 variable that points to a string (for example, of type &`uschar *`&).
34962
34963 .vitem &*opt_time*&
34964 This specifies a time interval value. The address must point to a variable of
34965 type &`int`&. The value that is placed there is a number of seconds.
34966 .endlist
34967
34968 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
34969 out the values of all the &[local_scan()]& options.
34970
34971
34972
34973 .section "Available Exim variables" "SECID208"
34974 .cindex "&[local_scan()]& function" "available Exim variables"
34975 The header &_local_scan.h_& gives you access to a number of C variables. These
34976 are the only ones that are guaranteed to be maintained from release to release.
34977 Note, however, that you can obtain the value of any Exim expansion variable,
34978 including &$recipients$&, by calling &'expand_string()'&. The exported
34979 C variables are as follows:
34980
34981 .vlist
34982 .vitem &*int&~body_linecount*&
34983 This variable contains the number of lines in the message's body.
34984 It is not valid if the &%spool_files_wireformat%& option is used.
34985
34986 .vitem &*int&~body_zerocount*&
34987 This variable contains the number of binary zero bytes in the message's body.
34988 It is not valid if the &%spool_files_wireformat%& option is used.
34989
34990 .vitem &*unsigned&~int&~debug_selector*&
34991 This variable is set to zero when no debugging is taking place. Otherwise, it
34992 is a bitmap of debugging selectors. Two bits are identified for use in
34993 &[local_scan()]&; they are defined as macros:
34994
34995 .ilist
34996 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
34997 testing option that is not privileged &-- any caller may set it. All the
34998 other selector bits can be set only by admin users.
34999
35000 .next
35001 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
35002 by the &`+local_scan`& debug selector. It is not included in the default set
35003 of debugging bits.
35004 .endlist ilist
35005
35006 Thus, to write to the debugging output only when &`+local_scan`& has been
35007 selected, you should use code like this:
35008 .code
35009 if ((debug_selector & D_local_scan) != 0)
35010   debug_printf("xxx", ...);
35011 .endd
35012 .vitem &*uschar&~*expand_string_message*&
35013 After a failing call to &'expand_string()'& (returned value NULL), the
35014 variable &%expand_string_message%& contains the error message, zero-terminated.
35015
35016 .vitem &*header_line&~*header_list*&
35017 A pointer to a chain of header lines. The &%header_line%& structure is
35018 discussed below.
35019
35020 .vitem &*header_line&~*header_last*&
35021 A pointer to the last of the header lines.
35022
35023 .vitem &*uschar&~*headers_charset*&
35024 The value of the &%headers_charset%& configuration option.
35025
35026 .vitem &*BOOL&~host_checking*&
35027 This variable is TRUE during a host checking session that is initiated by the
35028 &%-bh%& command line option.
35029
35030 .vitem &*uschar&~*interface_address*&
35031 The IP address of the interface that received the message, as a string. This
35032 is NULL for locally submitted messages.
35033
35034 .vitem &*int&~interface_port*&
35035 The port on which this message was received. When testing with the &%-bh%&
35036 command line option, the value of this variable is -1 unless a port has been
35037 specified via the &%-oMi%& option.
35038
35039 .vitem &*uschar&~*message_id*&
35040 This variable contains Exim's message id for the incoming message (the value of
35041 &$message_exim_id$&) as a zero-terminated string.
35042
35043 .vitem &*uschar&~*received_protocol*&
35044 The name of the protocol by which the message was received.
35045
35046 .vitem &*int&~recipients_count*&
35047 The number of accepted recipients.
35048
35049 .vitem &*recipient_item&~*recipients_list*&
35050 .cindex "recipient" "adding in local scan"
35051 .cindex "recipient" "removing in local scan"
35052 The list of accepted recipients, held in a vector of length
35053 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
35054 can add additional recipients by calling &'receive_add_recipient()'& (see
35055 below). You can delete recipients by removing them from the vector and
35056 adjusting the value in &%recipients_count%&. In particular, by setting
35057 &%recipients_count%& to zero you remove all recipients. If you then return the
35058 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
35059 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
35060 and then call &'receive_add_recipient()'& as often as needed.
35061
35062 .vitem &*uschar&~*sender_address*&
35063 The envelope sender address. For bounce messages this is the empty string.
35064
35065 .vitem &*uschar&~*sender_host_address*&
35066 The IP address of the sending host, as a string. This is NULL for
35067 locally-submitted messages.
35068
35069 .vitem &*uschar&~*sender_host_authenticated*&
35070 The name of the authentication mechanism that was used, or NULL if the message
35071 was not received over an authenticated SMTP connection.
35072
35073 .vitem &*uschar&~*sender_host_name*&
35074 The name of the sending host, if known.
35075
35076 .vitem &*int&~sender_host_port*&
35077 The port on the sending host.
35078
35079 .vitem &*BOOL&~smtp_input*&
35080 This variable is TRUE for all SMTP input, including BSMTP.
35081
35082 .vitem &*BOOL&~smtp_batched_input*&
35083 This variable is TRUE for BSMTP input.
35084
35085 .vitem &*int&~store_pool*&
35086 The contents of this variable control which pool of memory is used for new
35087 requests. See section &<<SECTmemhanloc>>& for details.
35088 .endlist
35089
35090
35091 .section "Structure of header lines" "SECID209"
35092 The &%header_line%& structure contains the members listed below.
35093 You can add additional header lines by calling the &'header_add()'& function
35094 (see below). You can cause header lines to be ignored (deleted) by setting
35095 their type to *.
35096
35097
35098 .vlist
35099 .vitem &*struct&~header_line&~*next*&
35100 A pointer to the next header line, or NULL for the last line.
35101
35102 .vitem &*int&~type*&
35103 A code identifying certain headers that Exim recognizes. The codes are printing
35104 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
35105 Notice in particular that any header line whose type is * is not transmitted
35106 with the message. This flagging is used for header lines that have been
35107 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
35108 lines.) Effectively, * means &"deleted"&.
35109
35110 .vitem &*int&~slen*&
35111 The number of characters in the header line, including the terminating and any
35112 internal newlines.
35113
35114 .vitem &*uschar&~*text*&
35115 A pointer to the text of the header. It always ends with a newline, followed by
35116 a zero byte. Internal newlines are preserved.
35117 .endlist
35118
35119
35120
35121 .section "Structure of recipient items" "SECID210"
35122 The &%recipient_item%& structure contains these members:
35123
35124 .vlist
35125 .vitem &*uschar&~*address*&
35126 This is a pointer to the recipient address as it was received.
35127
35128 .vitem &*int&~pno*&
35129 This is used in later Exim processing when top level addresses are created by
35130 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
35131 and must always contain -1 at this stage.
35132
35133 .vitem &*uschar&~*errors_to*&
35134 If this value is not NULL, bounce messages caused by failing to deliver to the
35135 recipient are sent to the address it contains. In other words, it overrides the
35136 envelope sender for this one recipient. (Compare the &%errors_to%& generic
35137 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
35138 an unqualified address, Exim qualifies it using the domain from
35139 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
35140 is NULL for all recipients.
35141 .endlist
35142
35143
35144
35145 .section "Available Exim functions" "SECID211"
35146 .cindex "&[local_scan()]& function" "available Exim functions"
35147 The header &_local_scan.h_& gives you access to a number of Exim functions.
35148 These are the only ones that are guaranteed to be maintained from release to
35149 release:
35150
35151 .vlist
35152 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
35153        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
35154
35155 This function creates a child process that runs the command specified by
35156 &%argv%&. The environment for the process is specified by &%envp%&, which can
35157 be NULL if no environment variables are to be passed. A new umask is supplied
35158 for the process in &%newumask%&.
35159
35160 Pipes to the standard input and output of the new process are set up
35161 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
35162 standard error is cloned to the standard output. If there are any file
35163 descriptors &"in the way"& in the new process, they are closed. If the final
35164 argument is TRUE, the new process is made into a process group leader.
35165
35166 The function returns the pid of the new process, or -1 if things go wrong.
35167
35168 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
35169 This function waits for a child process to terminate, or for a timeout (in
35170 seconds) to expire. A timeout value of zero means wait as long as it takes. The
35171 return value is as follows:
35172
35173 .ilist
35174 >= 0
35175
35176 The process terminated by a normal exit and the value is the process
35177 ending status.
35178
35179 .next
35180 < 0 and > &--256
35181
35182 The process was terminated by a signal and the value is the negation of the
35183 signal number.
35184
35185 .next
35186 &--256
35187
35188 The process timed out.
35189 .next
35190 &--257
35191
35192 The was some other error in wait(); &%errno%& is still set.
35193 .endlist
35194
35195 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
35196 This function provide you with a means of submitting a new message to
35197 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
35198 want, but this packages it all up for you.) The function creates a pipe,
35199 forks a subprocess that is running
35200 .code
35201 exim -t -oem -oi -f <>
35202 .endd
35203 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
35204 that is connected to the standard input. The yield of the function is the PID
35205 of the subprocess. You can then write a message to the file descriptor, with
35206 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
35207
35208 When you have finished, call &'child_close()'& to wait for the process to
35209 finish and to collect its ending status. A timeout value of zero is usually
35210 fine in this circumstance. Unless you have made a mistake with the recipient
35211 addresses, you should get a return code of zero.
35212
35213
35214 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
35215        *sender_authentication)*&
35216 This function is a more sophisticated version of &'child_open()'&. The command
35217 that it runs is:
35218 .display
35219 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
35220 .endd
35221 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
35222
35223
35224 .vitem &*void&~debug_printf(char&~*,&~...)*&
35225 This is Exim's debugging function, with arguments as for &'(printf()'&. The
35226 output is written to the standard error stream. If no debugging is selected,
35227 calls to &'debug_printf()'& have no effect. Normally, you should make calls
35228 conditional on the &`local_scan`& debug selector by coding like this:
35229 .code
35230 if ((debug_selector & D_local_scan) != 0)
35231   debug_printf("xxx", ...);
35232 .endd
35233
35234 .vitem &*uschar&~*expand_string(uschar&~*string)*&
35235 This is an interface to Exim's string expansion code. The return value is the
35236 expanded string, or NULL if there was an expansion failure.
35237 The C variable &%expand_string_message%& contains an error message after an
35238 expansion failure. If expansion does not change the string, the return value is
35239 the pointer to the input string. Otherwise, the return value points to a new
35240 block of memory that was obtained by a call to &'store_get()'&. See section
35241 &<<SECTmemhanloc>>& below for a discussion of memory handling.
35242
35243 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
35244 This function allows you to an add additional header line at the end of the
35245 existing ones. The first argument is the type, and should normally be a space
35246 character. The second argument is a format string and any number of
35247 substitution arguments as for &[sprintf()]&. You may include internal newlines
35248 if you want, and you must ensure that the string ends with a newline.
35249
35250 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
35251         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
35252 This function adds a new header line at a specified point in the header
35253 chain. The header itself is specified as for &'header_add()'&.
35254
35255 If &%name%& is NULL, the new header is added at the end of the chain if
35256 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
35257 NULL, the header lines are searched for the first non-deleted header that
35258 matches the name. If one is found, the new header is added before it if
35259 &%after%& is false. If &%after%& is true, the new header is added after the
35260 found header and any adjacent subsequent ones with the same name (even if
35261 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
35262 option controls where the header is added. If it is true, addition is at the
35263 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
35264 headers, or at the top if there are no &'Received:'& headers, you could use
35265 .code
35266 header_add_at_position(TRUE, US"Received", TRUE,
35267   ' ', "X-xxx: ...");
35268 .endd
35269 Normally, there is always at least one non-deleted &'Received:'& header, but
35270 there may not be if &%received_header_text%& expands to an empty string.
35271
35272
35273 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
35274 This function removes header lines. If &%occurrence%& is zero or negative, all
35275 occurrences of the header are removed. If occurrence is greater than zero, that
35276 particular instance of the header is removed. If no header(s) can be found that
35277 match the specification, the function does nothing.
35278
35279
35280 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
35281         int&~length,&~BOOL&~notdel)*&"
35282 This function tests whether the given header has the given name. It is not just
35283 a string comparison, because white space is permitted between the name and the
35284 colon. If the &%notdel%& argument is true, a false return is forced for all
35285 &"deleted"& headers; otherwise they are not treated specially. For example:
35286 .code
35287 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
35288 .endd
35289 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
35290 .cindex "base64 encoding" "functions for &[local_scan()]& use"
35291 This function base64-encodes a string, which is passed by address and length.
35292 The text may contain bytes of any value, including zero. The result is passed
35293 back in dynamic memory that is obtained by calling &'store_get()'&. It is
35294 zero-terminated.
35295
35296 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
35297 This function decodes a base64-encoded string. Its arguments are a
35298 zero-terminated base64-encoded string and the address of a variable that is set
35299 to point to the result, which is in dynamic memory. The length of the decoded
35300 string is the yield of the function. If the input is invalid base64 data, the
35301 yield is -1. A zero byte is added to the end of the output string to make it
35302 easy to interpret as a C string (assuming it contains no zeros of its own). The
35303 added zero byte is not included in the returned count.
35304
35305 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
35306 This function checks for a match in a domain list. Domains are always
35307 matched caselessly. The return value is one of the following:
35308 .display
35309 &`OK     `& match succeeded
35310 &`FAIL   `& match failed
35311 &`DEFER  `& match deferred
35312 .endd
35313 DEFER is usually caused by some kind of lookup defer, such as the
35314 inability to contact a database.
35315
35316 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
35317         BOOL&~caseless)*&"
35318 This function checks for a match in a local part list. The third argument
35319 controls case-sensitivity. The return values are as for
35320 &'lss_match_domain()'&.
35321
35322 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
35323         BOOL&~caseless)*&"
35324 This function checks for a match in an address list. The third argument
35325 controls the case-sensitivity of the local part match. The domain is always
35326 matched caselessly. The return values are as for &'lss_match_domain()'&.
35327
35328 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
35329         uschar&~*list)*&"
35330 This function checks for a match in a host list. The most common usage is
35331 expected to be
35332 .code
35333 lss_match_host(sender_host_name, sender_host_address, ...)
35334 .endd
35335 .vindex "&$sender_host_address$&"
35336 An empty address field matches an empty item in the host list. If the host name
35337 is NULL, the name corresponding to &$sender_host_address$& is automatically
35338 looked up if a host name is required to match an item in the list. The return
35339 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
35340 returns ERROR in the case when it had to look up a host name, but the lookup
35341 failed.
35342
35343 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
35344         *format,&~...)*&"
35345 This function writes to Exim's log files. The first argument should be zero (it
35346 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
35347 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
35348 them. It specifies to which log or logs the message is written. The remaining
35349 arguments are a format and relevant insertion arguments. The string should not
35350 contain any newlines, not even at the end.
35351
35352
35353 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
35354 This function adds an additional recipient to the message. The first argument
35355 is the recipient address. If it is unqualified (has no domain), it is qualified
35356 with the &%qualify_recipient%& domain. The second argument must always be -1.
35357
35358 This function does not allow you to specify a private &%errors_to%& address (as
35359 described with the structure of &%recipient_item%& above), because it pre-dates
35360 the addition of that field to the structure. However, it is easy to add such a
35361 value afterwards. For example:
35362 .code
35363  receive_add_recipient(US"monitor@mydom.example", -1);
35364  recipients_list[recipients_count-1].errors_to =
35365    US"postmaster@mydom.example";
35366 .endd
35367
35368 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
35369 This is a convenience function to remove a named recipient from the list of
35370 recipients. It returns true if a recipient was removed, and false if no
35371 matching recipient could be found. The argument must be a complete email
35372 address.
35373 .endlist
35374
35375
35376 .cindex "RFC 2047"
35377 .vlist
35378 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
35379   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
35380 This function decodes strings that are encoded according to RFC 2047. Typically
35381 these are the contents of header lines. First, each &"encoded word"& is decoded
35382 from the Q or B encoding into a byte-string. Then, if provided with the name of
35383 a charset encoding, and if the &[iconv()]& function is available, an attempt is
35384 made  to translate the result to the named character set. If this fails, the
35385 binary string is returned with an error message.
35386
35387 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
35388 maximum MIME word length is enforced. The third argument is the target
35389 encoding, or NULL if no translation is wanted.
35390
35391 .cindex "binary zero" "in RFC 2047 decoding"
35392 .cindex "RFC 2047" "binary zero in"
35393 If a binary zero is encountered in the decoded string, it is replaced by the
35394 contents of the &%zeroval%& argument. For use with Exim headers, the value must
35395 not be 0 because header lines are handled as zero-terminated strings.
35396
35397 The function returns the result of processing the string, zero-terminated; if
35398 &%lenptr%& is not NULL, the length of the result is set in the variable to
35399 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
35400
35401 If an error is encountered, the function returns NULL and uses the &%error%&
35402 argument to return an error message. The variable pointed to by &%error%& is
35403 set to NULL if there is no error; it may be set non-NULL even when the function
35404 returns a non-NULL value if decoding was successful, but there was a problem
35405 with translation.
35406
35407
35408 .vitem &*int&~smtp_fflush(void)*&
35409 This function is used in conjunction with &'smtp_printf()'&, as described
35410 below.
35411
35412 .vitem &*void&~smtp_printf(char&~*,BOOL,&~...)*&
35413 The arguments of this function are almost like &[printf()]&; it writes to the SMTP
35414 output stream. You should use this function only when there is an SMTP output
35415 stream, that is, when the incoming message is being received via interactive
35416 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
35417 is FALSE. If you want to test for an incoming message from another host (as
35418 opposed to a local process that used the &%-bs%& command line option), you can
35419 test the value of &%sender_host_address%&, which is non-NULL when a remote host
35420 is involved.
35421
35422 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
35423 output function, so it can be used for all forms of SMTP connection.
35424
35425 The second argument is used to request that the data be buffered
35426 (when TRUE) or flushed (along with any previously buffered, when FALSE).
35427 This is advisory only, but likely to save on system-calls and packets
35428 sent when a sequence of calls to the function are made.
35429
35430 The argument was added in Exim version 4.90 - changing the API/ABI.
35431 Nobody noticed until 4.93 was imminent, at which point the
35432 ABI version number was incremented.
35433
35434 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
35435 must start with an appropriate response code: 550 if you are going to return
35436 LOCAL_SCAN_REJECT, 451 if you are going to return
35437 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
35438 initial lines of a multi-line response, the code must be followed by a hyphen
35439 to indicate that the line is not the final response line. You must also ensure
35440 that the lines you write terminate with CRLF. For example:
35441 .code
35442 smtp_printf("550-this is some extra info\r\n");
35443 return LOCAL_SCAN_REJECT;
35444 .endd
35445 Note that you can also create multi-line responses by including newlines in
35446 the data returned via the &%return_text%& argument. The added value of using
35447 &'smtp_printf()'& is that, for instance, you could introduce delays between
35448 multiple output lines.
35449
35450 The &'smtp_printf()'& function does not return any error indication, because it
35451 does not
35452 guarantee a flush of
35453 pending output, and therefore does not test
35454 the state of the stream. (In the main code of Exim, flushing and error
35455 detection is done when Exim is ready for the next SMTP input command.) If
35456 you want to flush the output and check for an error (for example, the
35457 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
35458 arguments. It flushes the output stream, and returns a non-zero value if there
35459 is an error.
35460
35461 .vitem &*void&~*store_get(int,BOOL)*&
35462 This function accesses Exim's internal store (memory) manager. It gets a new
35463 chunk of memory whose size is given by the first argument.
35464 The second argument should be given as TRUE if the memory will be used for
35465 data possibly coming from an attacker (eg. the message content),
35466 FALSE if it is locally-sourced.
35467 Exim bombs out if it ever
35468 runs out of memory. See the next section for a discussion of memory handling.
35469
35470 .vitem &*void&~*store_get_perm(int,BOOL)*&
35471 This function is like &'store_get()'&, but it always gets memory from the
35472 permanent pool. See the next section for a discussion of memory handling.
35473
35474 .vitem &*uschar&~*string_copy(uschar&~*string)*&
35475 See below.
35476
35477 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
35478 See below.
35479
35480 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
35481 These three functions create strings using Exim's dynamic memory facilities.
35482 The first makes a copy of an entire string. The second copies up to a maximum
35483 number of characters, indicated by the second argument. The third uses a format
35484 and insertion arguments to create a new string. In each case, the result is a
35485 pointer to a new string in the current memory pool. See the next section for
35486 more discussion.
35487 .endlist
35488
35489
35490
35491 .section "More about Exim's memory handling" "SECTmemhanloc"
35492 .cindex "&[local_scan()]& function" "memory handling"
35493 No function is provided for freeing memory, because that is never needed.
35494 The dynamic memory that Exim uses when receiving a message is automatically
35495 recycled if another message is received by the same process (this applies only
35496 to incoming SMTP connections &-- other input methods can supply only one
35497 message at a time). After receiving the last message, a reception process
35498 terminates.
35499
35500 Because it is recycled, the normal dynamic memory cannot be used for holding
35501 data that must be preserved over a number of incoming messages on the same SMTP
35502 connection. However, Exim in fact uses two pools of dynamic memory; the second
35503 one is not recycled, and can be used for this purpose.
35504
35505 If you want to allocate memory that remains available for subsequent messages
35506 in the same SMTP connection, you should set
35507 .code
35508 store_pool = POOL_PERM
35509 .endd
35510 before calling the function that does the allocation. There is no need to
35511 restore the value if you do not need to; however, if you do want to revert to
35512 the normal pool, you can either restore the previous value of &%store_pool%& or
35513 set it explicitly to POOL_MAIN.
35514
35515 The pool setting applies to all functions that get dynamic memory, including
35516 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
35517 There is also a convenience function called &'store_get_perm()'& that gets a
35518 block of memory from the permanent pool while preserving the value of
35519 &%store_pool%&.
35520 .ecindex IIDlosca
35521
35522
35523
35524
35525 . ////////////////////////////////////////////////////////////////////////////
35526 . ////////////////////////////////////////////////////////////////////////////
35527
35528 .chapter "System-wide message filtering" "CHAPsystemfilter"
35529 .scindex IIDsysfil1 "filter" "system filter"
35530 .scindex IIDsysfil2 "filtering all mail"
35531 .scindex IIDsysfil3 "system filter"
35532 The previous chapters (on ACLs and the local scan function) describe checks
35533 that can be applied to messages before they are accepted by a host. There is
35534 also a mechanism for checking messages once they have been received, but before
35535 they are delivered. This is called the &'system filter'&.
35536
35537 The system filter operates in a similar manner to users' filter files, but it
35538 is run just once per message (however many recipients the message has).
35539 It should not normally be used as a substitute for routing, because &%deliver%&
35540 commands in a system router provide new envelope recipient addresses.
35541 The system filter must be an Exim filter. It cannot be a Sieve filter.
35542
35543 The system filter is run at the start of a delivery attempt, before any routing
35544 is done. If a message fails to be completely delivered at the first attempt,
35545 the system filter is run again at the start of every retry.
35546 If you want your filter to do something only once per message, you can make use
35547 of the &%first_delivery%& condition in an &%if%& command in the filter to
35548 prevent it happening on retries.
35549
35550 .vindex "&$domain$&"
35551 .vindex "&$local_part$&"
35552 &*Warning*&: Because the system filter runs just once, variables that are
35553 specific to individual recipient addresses, such as &$local_part$& and
35554 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
35555 you want to run a centrally-specified filter for each recipient address
35556 independently, you can do so by setting up a suitable &(redirect)& router, as
35557 described in section &<<SECTperaddfil>>& below.
35558
35559
35560 .section "Specifying a system filter" "SECID212"
35561 .cindex "uid (user id)" "system filter"
35562 .cindex "gid (group id)" "system filter"
35563 The name of the file that contains the system filter must be specified by
35564 setting &%system_filter%&. If you want the filter to run under a uid and gid
35565 other than root, you must also set &%system_filter_user%& and
35566 &%system_filter_group%& as appropriate. For example:
35567 .code
35568 system_filter = /etc/mail/exim.filter
35569 system_filter_user = exim
35570 .endd
35571 If a system filter generates any deliveries directly to files or pipes (via the
35572 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
35573 specified by setting &%system_filter_file_transport%& and
35574 &%system_filter_pipe_transport%&, respectively. Similarly,
35575 &%system_filter_reply_transport%& must be set to handle any messages generated
35576 by the &%reply%& command.
35577
35578
35579 .section "Testing a system filter" "SECID213"
35580 You can run simple tests of a system filter in the same way as for a user
35581 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
35582 are permitted only in system filters are recognized.
35583
35584 If you want to test the combined effect of a system filter and a user filter,
35585 you can use both &%-bF%& and &%-bf%& on the same command line.
35586
35587
35588
35589 .section "Contents of a system filter" "SECID214"
35590 The language used to specify system filters is the same as for users' filter
35591 files. It is described in the separate end-user document &'Exim's interface to
35592 mail filtering'&. However, there are some additional features that are
35593 available only in system filters; these are described in subsequent sections.
35594 If they are encountered in a user's filter file or when testing with &%-bf%&,
35595 they cause errors.
35596
35597 .cindex "frozen messages" "manual thaw; testing in filter"
35598 There are two special conditions which, though available in users' filter
35599 files, are designed for use in system filters. The condition &%first_delivery%&
35600 is true only for the first attempt at delivering a message, and
35601 &%manually_thawed%& is true only if the message has been frozen, and
35602 subsequently thawed by an admin user. An explicit forced delivery counts as a
35603 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
35604
35605 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
35606 specify an &"unseen"& (non-significant) delivery, and that delivery does not
35607 succeed, it will not be tried again.
35608 If you want Exim to retry an unseen delivery until it succeeds, you should
35609 arrange to set it up every time the filter runs.
35610
35611 When a system filter finishes running, the values of the variables &$n0$& &--
35612 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
35613 users' filter files. Thus a system filter can, for example, set up &"scores"&
35614 to which users' filter files can refer.
35615
35616
35617
35618 .section "Additional variable for system filters" "SECID215"
35619 .vindex "&$recipients$&"
35620 The expansion variable &$recipients$&, containing a list of all the recipients
35621 of the message (separated by commas and white space), is available in system
35622 filters. It is not available in users' filters for privacy reasons.
35623
35624
35625
35626 .section "Defer, freeze, and fail commands for system filters" "SECID216"
35627 .cindex "freezing messages"
35628 .cindex "message" "freezing"
35629 .cindex "message" "forced failure"
35630 .cindex "&%fail%&" "in system filter"
35631 .cindex "&%freeze%& in system filter"
35632 .cindex "&%defer%& in system filter"
35633 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
35634 always available in system filters, but are not normally enabled in users'
35635 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
35636 for the &(redirect)& router.) These commands can optionally be followed by the
35637 word &%text%& and a string containing an error message, for example:
35638 .code
35639 fail text "this message looks like spam to me"
35640 .endd
35641 The keyword &%text%& is optional if the next character is a double quote.
35642
35643 The &%defer%& command defers delivery of the original recipients of the
35644 message. The &%fail%& command causes all the original recipients to be failed,
35645 and a bounce message to be created. The &%freeze%& command suspends all
35646 delivery attempts for the original recipients. In all cases, any new deliveries
35647 that are specified by the filter are attempted as normal after the filter has
35648 run.
35649
35650 The &%freeze%& command is ignored if the message has been manually unfrozen and
35651 not manually frozen since. This means that automatic freezing by a system
35652 filter can be used as a way of checking out suspicious messages. If a message
35653 is found to be all right, manually unfreezing it allows it to be delivered.
35654
35655 .cindex "log" "&%fail%& command log line"
35656 .cindex "&%fail%&" "log line; reducing"
35657 The text given with a fail command is used as part of the bounce message as
35658 well as being written to the log. If the message is quite long, this can fill
35659 up a lot of log space when such failures are common. To reduce the size of the
35660 log message, Exim interprets the text in a special way if it starts with the
35661 two characters &`<<`& and contains &`>>`& later. The text between these two
35662 strings is written to the log, and the rest of the text is used in the bounce
35663 message. For example:
35664 .code
35665 fail "<<filter test 1>>Your message is rejected \
35666      because it contains attachments that we are \
35667      not prepared to receive."
35668 .endd
35669
35670 .cindex "loop" "caused by &%fail%&"
35671 Take great care with the &%fail%& command when basing the decision to fail on
35672 the contents of the message, because the bounce message will of course include
35673 the contents of the original message and will therefore trigger the &%fail%&
35674 command again (causing a mail loop) unless steps are taken to prevent this.
35675 Testing the &%error_message%& condition is one way to prevent this. You could
35676 use, for example
35677 .code
35678 if $message_body contains "this is spam" and not error_message
35679 then fail text "spam is not wanted here" endif
35680 .endd
35681 though of course that might let through unwanted bounce messages. The
35682 alternative is clever checking of the body and/or headers to detect bounces
35683 generated by the filter.
35684
35685 The interpretation of a system filter file ceases after a
35686 &%defer%&,
35687 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
35688 set up earlier in the filter file are honoured, so you can use a sequence such
35689 as
35690 .code
35691 mail ...
35692 freeze
35693 .endd
35694 to send a specified message when the system filter is freezing (or deferring or
35695 failing) a message. The normal deliveries for the message do not, of course,
35696 take place.
35697
35698
35699
35700 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
35701 .cindex "header lines" "adding; in system filter"
35702 .cindex "header lines" "removing; in system filter"
35703 .cindex "filter" "header lines; adding/removing"
35704 Two filter commands that are available only in system filters are:
35705 .code
35706 headers add <string>
35707 headers remove <string>
35708 .endd
35709 The argument for the &%headers add%& is a string that is expanded and then
35710 added to the end of the message's headers. It is the responsibility of the
35711 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
35712 space is ignored, and if the string is otherwise empty, or if the expansion is
35713 forced to fail, the command has no effect.
35714
35715 You can use &"\n"& within the string, followed by white space, to specify
35716 continued header lines. More than one header may be added in one command by
35717 including &"\n"& within the string without any following white space. For
35718 example:
35719 .code
35720 headers add "X-header-1: ....\n  \
35721              continuation of X-header-1 ...\n\
35722              X-header-2: ...."
35723 .endd
35724 Note that the header line continuation white space after the first newline must
35725 be placed before the backslash that continues the input string, because white
35726 space after input continuations is ignored.
35727
35728 The argument for &%headers remove%& is a colon-separated list of header names.
35729 This command applies only to those headers that are stored with the message;
35730 those that are added at delivery time (such as &'Envelope-To:'& and
35731 &'Return-Path:'&) cannot be removed by this means. If there is more than one
35732 header with the same name, they are all removed.
35733
35734 The &%headers%& command in a system filter makes an immediate change to the set
35735 of header lines that was received with the message (with possible additions
35736 from ACL processing). Subsequent commands in the system filter operate on the
35737 modified set, which also forms the basis for subsequent message delivery.
35738 Unless further modified during routing or transporting, this set of headers is
35739 used for all recipients of the message.
35740
35741 During routing and transporting, the variables that refer to the contents of
35742 header lines refer only to those lines that are in this set. Thus, header lines
35743 that are added by a system filter are visible to users' filter files and to all
35744 routers and transports. This contrasts with the manipulation of header lines by
35745 routers and transports, which is not immediate, but which instead is saved up
35746 until the message is actually being written (see section
35747 &<<SECTheadersaddrem>>&).
35748
35749 If the message is not delivered at the first attempt, header lines that were
35750 added by the system filter are stored with the message, and so are still
35751 present at the next delivery attempt. Header lines that were removed are still
35752 present, but marked &"deleted"& so that they are not transported with the
35753 message. For this reason, it is usual to make the &%headers%& command
35754 conditional on &%first_delivery%& so that the set of header lines is not
35755 modified more than once.
35756
35757 Because header modification in a system filter acts immediately, you have to
35758 use an indirect approach if you want to modify the contents of a header line.
35759 For example:
35760 .code
35761 headers add "Old-Subject: $h_subject:"
35762 headers remove "Subject"
35763 headers add "Subject: new subject (was: $h_old-subject:)"
35764 headers remove "Old-Subject"
35765 .endd
35766
35767
35768
35769 .section "Setting an errors address in a system filter" "SECID217"
35770 .cindex "envelope from"
35771 .cindex "envelope sender"
35772 In a system filter, if a &%deliver%& command is followed by
35773 .code
35774 errors_to <some address>
35775 .endd
35776 in order to change the envelope sender (and hence the error reporting) for that
35777 delivery, any address may be specified. (In a user filter, only the current
35778 user's address can be set.) For example, if some mail is being monitored, you
35779 might use
35780 .code
35781 unseen deliver monitor@spying.example errors_to root@local.example
35782 .endd
35783 to take a copy which would not be sent back to the normal error reporting
35784 address if its delivery failed.
35785
35786
35787
35788 .section "Per-address filtering" "SECTperaddfil"
35789 .vindex "&$domain_data$&"
35790 .vindex "&$local_part_data$&"
35791 In contrast to the system filter, which is run just once per message for each
35792 delivery attempt, it is also possible to set up a system-wide filtering
35793 operation that runs once for each recipient address. In this case, variables
35794 such as &$local_part_data$& and &$domain_data$& can be used,
35795 and indeed, the choice of filter file could be made dependent on them.
35796 This is an example of a router which implements such a filter:
35797 .code
35798 central_filter:
35799   check_local_user
35800   driver = redirect
35801   domains = +local_domains
35802   file = /central/filters/$local_part_data
35803   no_verify
35804   allow_filter
35805   allow_freeze
35806 .endd
35807 The filter is run in a separate process under its own uid. Therefore, either
35808 &%check_local_user%& must be set (as above), in which case the filter is run as
35809 the local user, or the &%user%& option must be used to specify which user to
35810 use. If both are set, &%user%& overrides.
35811
35812 Care should be taken to ensure that none of the commands in the filter file
35813 specify a significant delivery if the message is to go on to be delivered to
35814 its intended recipient. The router will not then claim to have dealt with the
35815 address, so it will be passed on to subsequent routers to be delivered in the
35816 normal way.
35817 .ecindex IIDsysfil1
35818 .ecindex IIDsysfil2
35819 .ecindex IIDsysfil3
35820
35821
35822
35823
35824
35825
35826 . ////////////////////////////////////////////////////////////////////////////
35827 . ////////////////////////////////////////////////////////////////////////////
35828
35829 .chapter "Message processing" "CHAPmsgproc"
35830 .scindex IIDmesproc "message" "general processing"
35831 Exim performs various transformations on the sender and recipient addresses of
35832 all messages that it handles, and also on the messages' header lines. Some of
35833 these are optional and configurable, while others always take place. All of
35834 this processing, except rewriting as a result of routing, and the addition or
35835 removal of header lines while delivering, happens when a message is received,
35836 before it is placed on Exim's queue.
35837
35838 Some of the automatic processing takes place by default only for
35839 &"locally-originated"& messages. This adjective is used to describe messages
35840 that are not received over TCP/IP, but instead are passed to an Exim process on
35841 its standard input. This includes the interactive &"local SMTP"& case that is
35842 set up by the &%-bs%& command line option.
35843
35844 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
35845 or ::1) are not considered to be locally-originated. Exim does not treat the
35846 loopback interface specially in any way.
35847
35848 If you want the loopback interface to be treated specially, you must ensure
35849 that there are appropriate entries in your ACLs.
35850
35851
35852
35853
35854 .section "Submission mode for non-local messages" "SECTsubmodnon"
35855 .cindex "message" "submission"
35856 .cindex "submission mode"
35857 Processing that happens automatically for locally-originated messages (unless
35858 &%suppress_local_fixups%& is set) can also be requested for messages that are
35859 received over TCP/IP. The term &"submission mode"& is used to describe this
35860 state. Submission mode is set by the modifier
35861 .code
35862 control = submission
35863 .endd
35864 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
35865 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
35866 a local submission, and is normally used when the source of the message is
35867 known to be an MUA running on a client host (as opposed to an MTA). For
35868 example, to set submission mode for messages originating on the IPv4 loopback
35869 interface, you could include the following in the MAIL ACL:
35870 .code
35871 warn  hosts = 127.0.0.1
35872       control = submission
35873 .endd
35874 .cindex "&%sender_retain%& submission option"
35875 There are some options that can be used when setting submission mode. A slash
35876 is used to separate options. For example:
35877 .code
35878 control = submission/sender_retain
35879 .endd
35880 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
35881 true and &%local_from_check%& false for the current incoming message. The first
35882 of these allows an existing &'Sender:'& header in the message to remain, and
35883 the second suppresses the check to ensure that &'From:'& matches the
35884 authenticated sender. With this setting, Exim still fixes up messages by adding
35885 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
35886 attempt to check sender authenticity in header lines.
35887
35888 When &%sender_retain%& is not set, a submission mode setting may specify a
35889 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
35890 example:
35891 .code
35892 control = submission/domain=some.domain
35893 .endd
35894 The domain may be empty. How this value is used is described in sections
35895 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
35896 that allows you to specify the user's full name for inclusion in a created
35897 &'Sender:'& or &'From:'& header line. For example:
35898 .code
35899 accept authenticated = *
35900        control = submission/domain=wonderland.example/\
35901                             name=${lookup {$authenticated_id} \
35902                                    lsearch {/etc/exim/namelist}}
35903 .endd
35904 Because the name may contain any characters, including slashes, the &%name%&
35905 option must be given last. The remainder of the string is used as the name. For
35906 the example above, if &_/etc/exim/namelist_& contains:
35907 .code
35908 bigegg:  Humpty Dumpty
35909 .endd
35910 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
35911 line would be:
35912 .code
35913 Sender: Humpty Dumpty <bigegg@wonderland.example>
35914 .endd
35915 .cindex "return path" "in submission mode"
35916 By default, submission mode forces the return path to the same address as is
35917 used to create the &'Sender:'& header. However, if &%sender_retain%& is
35918 specified, the return path is also left unchanged.
35919
35920 &*Note*&: The changes caused by submission mode take effect after the predata
35921 ACL. This means that any sender checks performed before the fix-ups use the
35922 untrusted sender address specified by the user, not the trusted sender address
35923 specified by submission mode. Although this might be slightly unexpected, it
35924 does mean that you can configure ACL checks to spot that a user is trying to
35925 spoof another's address.
35926
35927 .section "Line endings" "SECTlineendings"
35928 .cindex "line endings"
35929 .cindex "carriage return"
35930 .cindex "linefeed"
35931 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
35932 linefeed) is the line ending for messages transmitted over the Internet using
35933 SMTP over TCP/IP. However, within individual operating systems, different
35934 conventions are used. For example, Unix-like systems use just LF, but others
35935 use CRLF or just CR.
35936
35937 Exim was designed for Unix-like systems, and internally, it stores messages
35938 using the system's convention of a single LF as a line terminator. When
35939 receiving a message, all line endings are translated to this standard format.
35940 Originally, it was thought that programs that passed messages directly to an
35941 MTA within an operating system would use that system's convention. Experience
35942 has shown that this is not the case; for example, there are Unix applications
35943 that use CRLF in this circumstance. For this reason, and for compatibility with
35944 other MTAs, the way Exim handles line endings for all messages is now as
35945 follows:
35946
35947 .ilist
35948 LF not preceded by CR is treated as a line ending.
35949 .next
35950 CR is treated as a line ending; if it is immediately followed by LF, the LF
35951 is ignored.
35952 .next
35953 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
35954 nor a local message in the state where a line containing only a dot is a
35955 terminator.
35956 .next
35957 If a bare CR is encountered within a header line, an extra space is added after
35958 the line terminator so as not to end the header line. The reasoning behind this
35959 is that bare CRs in header lines are most likely either to be mistakes, or
35960 people trying to play silly games.
35961 .next
35962 If the first header line received in a message ends with CRLF, a subsequent
35963 bare LF in a header line is treated in the same way as a bare CR in a header
35964 line.
35965 .endlist
35966
35967
35968
35969
35970
35971 .section "Unqualified addresses" "SECID218"
35972 .cindex "unqualified addresses"
35973 .cindex "address" "qualification"
35974 By default, Exim expects every envelope address it receives from an external
35975 host to be fully qualified. Unqualified addresses cause negative responses to
35976 SMTP commands. However, because SMTP is used as a means of transporting
35977 messages from MUAs running on personal workstations, there is sometimes a
35978 requirement to accept unqualified addresses from specific hosts or IP networks.
35979
35980 Exim has two options that separately control which hosts may send unqualified
35981 sender or recipient addresses in SMTP commands, namely
35982 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
35983 cases, if an unqualified address is accepted, it is qualified by adding the
35984 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
35985
35986 .oindex "&%qualify_domain%&"
35987 .oindex "&%qualify_recipient%&"
35988 Unqualified addresses in header lines are automatically qualified for messages
35989 that are locally originated, unless the &%-bnq%& option is given on the command
35990 line. For messages received over SMTP, unqualified addresses in header lines
35991 are qualified only if unqualified addresses are permitted in SMTP commands. In
35992 other words, such qualification is also controlled by
35993 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
35994
35995
35996
35997
35998 .section "The UUCP From line" "SECID219"
35999 .cindex "&""From""& line"
36000 .cindex "UUCP" "&""From""& line"
36001 .cindex "sender" "address"
36002 .oindex "&%uucp_from_pattern%&"
36003 .oindex "&%uucp_from_sender%&"
36004 .cindex "envelope from"
36005 .cindex "envelope sender"
36006 .cindex "Sendmail compatibility" "&""From""& line"
36007 Messages that have come from UUCP (and some other applications) often begin
36008 with a line containing the envelope sender and a timestamp, following the word
36009 &"From"&. Examples of two common formats are:
36010 .code
36011 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
36012 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
36013 .endd
36014 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
36015 Exim recognizes such lines at the start of messages that are submitted to it
36016 via the command line (that is, on the standard input). It does not recognize
36017 such lines in incoming SMTP messages, unless the sending host matches
36018 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
36019 and &%ignore_fromline_local%& is set. The recognition is controlled by a
36020 regular expression that is defined by the &%uucp_from_pattern%& option, whose
36021 default value matches the two common cases shown above and puts the address
36022 that follows &"From"& into &$1$&.
36023
36024 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
36025 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
36026 a trusted user, the message's sender address is constructed by expanding the
36027 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
36028 then parsed as an RFC 2822 address. If there is no domain, the local part is
36029 qualified with &%qualify_domain%& unless it is the empty string. However, if
36030 the command line &%-f%& option is used, it overrides the &"From"& line.
36031
36032 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
36033 sender address is not changed. This is also the case for incoming SMTP messages
36034 that are permitted to contain &"From"& lines.
36035
36036 Only one &"From"& line is recognized. If there is more than one, the second is
36037 treated as a data line that starts the body of the message, as it is not valid
36038 as a header line. This also happens if a &"From"& line is present in an
36039 incoming SMTP message from a source that is not permitted to send them.
36040
36041
36042
36043 .section "Resent- header lines" "SECID220"
36044 .chindex Resent-
36045 RFC 2822 makes provision for sets of header lines starting with the string
36046 &`Resent-`& to be added to a message when it is resent by the original
36047 recipient to somebody else. These headers are &'Resent-Date:'&,
36048 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
36049 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
36050
36051 .blockquote
36052 &'Resent fields are strictly informational. They MUST NOT be used in the normal
36053 processing of replies or other such automatic actions on messages.'&
36054 .endblockquote
36055
36056 This leaves things a bit vague as far as other processing actions such as
36057 address rewriting are concerned. Exim treats &%Resent-%& header lines as
36058 follows:
36059
36060 .ilist
36061 A &'Resent-From:'& line that just contains the login id of the submitting user
36062 is automatically rewritten in the same way as &'From:'& (see below).
36063 .next
36064 If there's a rewriting rule for a particular header line, it is also applied to
36065 &%Resent-%& header lines of the same type. For example, a rule that rewrites
36066 &'From:'& also rewrites &'Resent-From:'&.
36067 .next
36068 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
36069 also removed.
36070 .next
36071 For a locally-submitted message,
36072 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
36073 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
36074 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
36075 included in log lines in this case.
36076 .next
36077 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
36078 &%Resent-%& header lines are present.
36079 .endlist
36080
36081
36082
36083
36084 .section "The Auto-Submitted: header line" "SECID221"
36085 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
36086 includes the header line:
36087 .code
36088 Auto-Submitted: auto-replied
36089 .endd
36090
36091 .section "The Bcc: header line" "SECID222"
36092 .cindex "&'Bcc:'& header line"
36093 If Exim is called with the &%-t%& option, to take recipient addresses from a
36094 message's header, it removes any &'Bcc:'& header line that may exist (after
36095 extracting its addresses). If &%-t%& is not present on the command line, any
36096 existing &'Bcc:'& is not removed.
36097
36098
36099 .section "The Date: header line" "SECID223"
36100 .cindex Date:
36101 If a locally-generated or submission-mode message has no &'Date:'& header line,
36102 Exim adds one, using the current date and time, unless the
36103 &%suppress_local_fixups%& control has been specified.
36104
36105 .section "The Delivery-date: header line" "SECID224"
36106 .cindex "&'Delivery-date:'& header line"
36107 .oindex "&%delivery_date_remove%&"
36108 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
36109 set. Exim can be configured to add them to the final delivery of messages. (See
36110 the generic &%delivery_date_add%& transport option.) They should not be present
36111 in messages in transit. If the &%delivery_date_remove%& configuration option is
36112 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
36113 messages.
36114
36115
36116 .section "The Envelope-to: header line" "SECID225"
36117 .chindex Envelope-to:
36118 .oindex "&%envelope_to_remove%&"
36119 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
36120 Exim can be configured to add them to the final delivery of messages. (See the
36121 generic &%envelope_to_add%& transport option.) They should not be present in
36122 messages in transit. If the &%envelope_to_remove%& configuration option is set
36123 (the default), Exim removes &'Envelope-to:'& header lines from incoming
36124 messages.
36125
36126
36127 .section "The From: header line" "SECTthefrohea"
36128 .chindex From:
36129 .cindex "Sendmail compatibility" "&""From""& line"
36130 .cindex "message" "submission"
36131 .cindex "submission mode"
36132 If a submission-mode message does not contain a &'From:'& header line, Exim
36133 adds one if either of the following conditions is true:
36134
36135 .ilist
36136 The envelope sender address is not empty (that is, this is not a bounce
36137 message). The added header line copies the envelope sender address.
36138 .next
36139 .vindex "&$authenticated_id$&"
36140 The SMTP session is authenticated and &$authenticated_id$& is not empty.
36141 .olist
36142 .vindex "&$qualify_domain$&"
36143 If no domain is specified by the submission control, the local part is
36144 &$authenticated_id$& and the domain is &$qualify_domain$&.
36145 .next
36146 If a non-empty domain is specified by the submission control, the local
36147 part is &$authenticated_id$&, and the domain is the specified domain.
36148 .next
36149 If an empty domain is specified by the submission control,
36150 &$authenticated_id$& is assumed to be the complete address.
36151 .endlist
36152 .endlist
36153
36154 A non-empty envelope sender takes precedence.
36155
36156 If a locally-generated incoming message does not contain a &'From:'& header
36157 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
36158 containing the sender's address. The calling user's login name and full name
36159 are used to construct the address, as described in section &<<SECTconstr>>&.
36160 They are obtained from the password data by calling &[getpwuid()]& (but see the
36161 &%unknown_login%& configuration option). The address is qualified with
36162 &%qualify_domain%&.
36163
36164 For compatibility with Sendmail, if an incoming, non-SMTP message has a
36165 &'From:'& header line containing just the unqualified login name of the calling
36166 user, this is replaced by an address containing the user's login name and full
36167 name as described in section &<<SECTconstr>>&.
36168
36169
36170 .section "The Message-ID: header line" "SECID226"
36171 .chindex Message-ID:
36172 .cindex "message" "submission"
36173 .oindex "&%message_id_header_text%&"
36174 If a locally-generated or submission-mode incoming message does not contain a
36175 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
36176 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
36177 to the message. If there are any &'Resent-:'& headers in the message, it
36178 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
36179 message id, preceded by the letter E to ensure it starts with a letter, and
36180 followed by @ and the primary host name. Additional information can be included
36181 in this header line by setting the &%message_id_header_text%& and/or
36182 &%message_id_header_domain%& options.
36183
36184
36185 .section "The Received: header line" "SECID227"
36186 .chindex Received:
36187 A &'Received:'& header line is added at the start of every message. The
36188 contents are defined by the &%received_header_text%& configuration option, and
36189 Exim automatically adds a semicolon and a timestamp to the configured string.
36190
36191 The &'Received:'& header is generated as soon as the message's header lines
36192 have been received. At this stage, the timestamp in the &'Received:'& header
36193 line is the time that the message started to be received. This is the value
36194 that is seen by the DATA ACL and by the &[local_scan()]& function.
36195
36196 Once a message is accepted, the timestamp in the &'Received:'& header line is
36197 changed to the time of acceptance, which is (apart from a small delay while the
36198 -H spool file is written) the earliest time at which delivery could start.
36199
36200
36201 .section "The References: header line" "SECID228"
36202 .chindex References:
36203 Messages created by the &(autoreply)& transport include a &'References:'&
36204 header line. This is constructed according to the rules that are described in
36205 section 3.64 of RFC 2822 (which states that replies should contain such a
36206 header line), and section 3.14 of RFC 3834 (which states that automatic
36207 responses are not different in this respect). However, because some mail
36208 processing software does not cope well with very long header lines, no more
36209 than 12 message IDs are copied from the &'References:'& header line in the
36210 incoming message. If there are more than 12, the first one and then the final
36211 11 are copied, before adding the message ID of the incoming message.
36212
36213
36214
36215 .section "The Return-path: header line" "SECID229"
36216 .chindex Return-path:
36217 .oindex "&%return_path_remove%&"
36218 &'Return-path:'& header lines are defined as something an MTA may insert when
36219 it does the final delivery of messages. (See the generic &%return_path_add%&
36220 transport option.) Therefore, they should not be present in messages in
36221 transit. If the &%return_path_remove%& configuration option is set (the
36222 default), Exim removes &'Return-path:'& header lines from incoming messages.
36223
36224
36225
36226 .section "The Sender: header line" "SECTthesenhea"
36227 .cindex "&'Sender:'& header line"
36228 .cindex "message" "submission"
36229 .chindex Sender:
36230 For a locally-originated message from an untrusted user, Exim may remove an
36231 existing &'Sender:'& header line, and it may add a new one. You can modify
36232 these actions by setting the &%local_sender_retain%& option true, the
36233 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
36234 control setting.
36235
36236 When a local message is received from an untrusted user and
36237 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
36238 control has not been set, a check is made to see if the address given in the
36239 &'From:'& header line is the correct (local) sender of the message. The address
36240 that is expected has the login name as the local part and the value of
36241 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
36242 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
36243 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
36244 line is added to the message.
36245
36246 If you set &%local_from_check%& false, this checking does not occur. However,
36247 the removal of an existing &'Sender:'& line still happens, unless you also set
36248 &%local_sender_retain%& to be true. It is not possible to set both of these
36249 options true at the same time.
36250
36251 .cindex "submission mode"
36252 By default, no processing of &'Sender:'& header lines is done for messages
36253 received over TCP/IP or for messages submitted by trusted users. However, when
36254 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
36255 not specified on the submission control, the following processing takes place:
36256
36257 .vindex "&$authenticated_id$&"
36258 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
36259 authenticated, and &$authenticated_id$& is not empty, a sender address is
36260 created as follows:
36261
36262 .ilist
36263 .vindex "&$qualify_domain$&"
36264 If no domain is specified by the submission control, the local part is
36265 &$authenticated_id$& and the domain is &$qualify_domain$&.
36266 .next
36267 If a non-empty domain is specified by the submission control, the local part
36268 is &$authenticated_id$&, and the domain is the specified domain.
36269 .next
36270 If an empty domain is specified by the submission control,
36271 &$authenticated_id$& is assumed to be the complete address.
36272 .endlist
36273
36274 This address is compared with the address in the &'From:'& header line. If they
36275 are different, a &'Sender:'& header line containing the created address is
36276 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
36277 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
36278
36279 .cindex "return path" "created from &'Sender:'&"
36280 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
36281 the message (the envelope sender address) is changed to be the same address,
36282 except in the case of submission mode when &%sender_retain%& is specified.
36283
36284
36285
36286 .section "Adding and removing header lines in routers and transports" &&&
36287          "SECTheadersaddrem"
36288 .cindex "header lines" "adding; in router or transport"
36289 .cindex "header lines" "removing; in router or transport"
36290 When a message is delivered, the addition and removal of header lines can be
36291 specified in a system filter, or on any of the routers and transports that
36292 process the message. Section &<<SECTaddremheasys>>& contains details about
36293 modifying headers in a system filter. Header lines can also be added in an ACL
36294 as a message is received (see section &<<SECTaddheadacl>>&).
36295
36296 In contrast to what happens in a system filter, header modifications that are
36297 specified on routers and transports apply only to the particular recipient
36298 addresses that are being processed by those routers and transports. These
36299 changes do not actually take place until a copy of the message is being
36300 transported. Therefore, they do not affect the basic set of header lines, and
36301 they do not affect the values of the variables that refer to header lines.
36302
36303 &*Note*&: In particular, this means that any expansions in the configuration of
36304 the transport cannot refer to the modified header lines, because such
36305 expansions all occur before the message is actually transported.
36306
36307 For both routers and transports, the argument of a &%headers_add%&
36308 option must be in the form of one or more RFC 2822 header lines, separated by
36309 newlines (coded as &"\n"&). For example:
36310 .code
36311 headers_add = X-added-header: added by $primary_hostname\n\
36312               X-added-second: another added header line
36313 .endd
36314 Exim does not check the syntax of these added header lines.
36315
36316 Multiple &%headers_add%& options for a single router or transport can be
36317 specified; the values will append to a single list of header lines.
36318 Each header-line is separately expanded.
36319
36320 The argument of a &%headers_remove%& option must consist of a colon-separated
36321 list of header names. This is confusing, because header names themselves are
36322 often terminated by colons. In this case, the colons are the list separators,
36323 not part of the names. For example:
36324 .code
36325 headers_remove = return-receipt-to:acknowledge-to
36326 .endd
36327
36328 Multiple &%headers_remove%& options for a single router or transport can be
36329 specified; the arguments will append to a single header-names list.
36330 Each item is separately expanded.
36331 Note that colons in complex expansions which are used to
36332 form all or part of a &%headers_remove%& list
36333 will act as list separators.
36334
36335 When &%headers_add%& or &%headers_remove%& is specified on a router,
36336 items are expanded at routing time,
36337 and then associated with all addresses that are
36338 accepted by that router, and also with any new addresses that it generates. If
36339 an address passes through several routers as a result of aliasing or
36340 forwarding, the changes are cumulative.
36341
36342 .oindex "&%unseen%&"
36343 However, this does not apply to multiple routers that result from the use of
36344 the &%unseen%& option. Any header modifications that were specified by the
36345 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
36346
36347 Addresses that end up with different &%headers_add%& or &%headers_remove%&
36348 settings cannot be delivered together in a batch, so a transport is always
36349 dealing with a set of addresses that have the same header-processing
36350 requirements.
36351
36352 The transport starts by writing the original set of header lines that arrived
36353 with the message, possibly modified by the system filter. As it writes out
36354 these lines, it consults the list of header names that were attached to the
36355 recipient address(es) by &%headers_remove%& options in routers, and it also
36356 consults the transport's own &%headers_remove%& option. Header lines whose
36357 names are on either of these lists are not written out. If there are multiple
36358 instances of any listed header, they are all skipped.
36359
36360 After the remaining original header lines have been written, new header
36361 lines that were specified by routers' &%headers_add%& options are written, in
36362 the order in which they were attached to the address. These are followed by any
36363 header lines specified by the transport's &%headers_add%& option.
36364
36365 This way of handling header line modifications in routers and transports has
36366 the following consequences:
36367
36368 .ilist
36369 The original set of header lines, possibly modified by the system filter,
36370 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
36371 to it, at all times.
36372 .next
36373 Header lines that are added by a router's
36374 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
36375 expansion syntax in subsequent routers or the transport.
36376 .next
36377 Conversely, header lines that are specified for removal by &%headers_remove%&
36378 in a router remain visible to subsequent routers and the transport.
36379 .next
36380 Headers added to an address by &%headers_add%& in a router cannot be removed by
36381 a later router or by a transport.
36382 .next
36383 An added header can refer to the contents of an original header that is to be
36384 removed, even it has the same name as the added header. For example:
36385 .code
36386 headers_remove = subject
36387 headers_add = Subject: new subject (was: $h_subject:)
36388 .endd
36389 .endlist
36390
36391 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
36392 for a &(redirect)& router that has the &%one_time%& option set.
36393
36394
36395
36396
36397
36398 .section "Constructed addresses" "SECTconstr"
36399 .cindex "address" "constructed"
36400 .cindex "constructed address"
36401 When Exim constructs a sender address for a locally-generated message, it uses
36402 the form
36403 .display
36404 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
36405 .endd
36406 For example:
36407 .code
36408 Zaphod Beeblebrox <zaphod@end.univ.example>
36409 .endd
36410 The user name is obtained from the &%-F%& command line option if set, or
36411 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
36412 &"gecos"& field from the password entry. If the &"gecos"& field contains an
36413 ampersand character, this is replaced by the login name with the first letter
36414 upper cased, as is conventional in a number of operating systems. See the
36415 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
36416 The &%unknown_username%& option can be used to specify user names in cases when
36417 there is no password file entry.
36418
36419 .cindex "RFC 2047"
36420 In all cases, the user name is made to conform to RFC 2822 by quoting all or
36421 parts of it if necessary. In addition, if it contains any non-printing
36422 characters, it is encoded as described in RFC 2047, which defines a way of
36423 including non-ASCII characters in header lines. The value of the
36424 &%headers_charset%& option specifies the name of the encoding that is used (the
36425 characters are assumed to be in this encoding). The setting of
36426 &%print_topbitchars%& controls whether characters with the top bit set (that
36427 is, with codes greater than 127) count as printing characters or not.
36428
36429
36430
36431 .section "Case of local parts" "SECID230"
36432 .cindex "case of local parts"
36433 .cindex "local part" "case of"
36434 RFC 2822 states that the case of letters in the local parts of addresses cannot
36435 be assumed to be non-significant. Exim preserves the case of local parts of
36436 addresses, but by default it uses a lower-cased form when it is routing,
36437 because on most Unix systems, usernames are in lower case and case-insensitive
36438 routing is required. However, any particular router can be made to use the
36439 original case for local parts by setting the &%caseful_local_part%& generic
36440 router option.
36441
36442 .cindex "mixed-case login names"
36443 If you must have mixed-case user names on your system, the best way to proceed,
36444 assuming you want case-independent handling of incoming email, is to set up
36445 your first router to convert incoming local parts in your domains to the
36446 correct case by means of a file lookup. For example:
36447 .code
36448 correct_case:
36449   driver = redirect
36450   domains = +local_domains
36451   data = ${lookup{$local_part}cdb\
36452               {/etc/usercased.cdb}{$value}fail}\
36453               @$domain
36454 .endd
36455 For this router, the local part is forced to lower case by the default action
36456 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
36457 up a new local part in the correct case. If you then set &%caseful_local_part%&
36458 on any subsequent routers which process your domains, they will operate on
36459 local parts with the correct case in a case-sensitive manner.
36460
36461
36462
36463 .section "Dots in local parts" "SECID231"
36464 .cindex "dot" "in local part"
36465 .cindex "local part" "dots in"
36466 RFC 2822 forbids empty components in local parts. That is, an unquoted local
36467 part may not begin or end with a dot, nor have two consecutive dots in the
36468 middle. However, it seems that many MTAs do not enforce this, so Exim permits
36469 empty components for compatibility.
36470
36471
36472
36473 .section "Rewriting addresses" "SECID232"
36474 .cindex "rewriting" "addresses"
36475 Rewriting of sender and recipient addresses, and addresses in headers, can
36476 happen automatically, or as the result of configuration options, as described
36477 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
36478 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
36479
36480 Automatic rewriting includes qualification, as mentioned above. The other case
36481 in which it can happen is when an incomplete non-local domain is given. The
36482 routing process may cause this to be expanded into the full domain name. For
36483 example, a header such as
36484 .code
36485 To: hare@teaparty
36486 .endd
36487 might get rewritten as
36488 .code
36489 To: hare@teaparty.wonderland.fict.example
36490 .endd
36491 Rewriting as a result of routing is the one kind of message processing that
36492 does not happen at input time, as it cannot be done until the address has
36493 been routed.
36494
36495 Strictly, one should not do &'any'& deliveries of a message until all its
36496 addresses have been routed, in case any of the headers get changed as a
36497 result of routing. However, doing this in practice would hold up many
36498 deliveries for unreasonable amounts of time, just because one address could not
36499 immediately be routed. Exim therefore does not delay other deliveries when
36500 routing of one or more addresses is deferred.
36501 .ecindex IIDmesproc
36502
36503
36504
36505 . ////////////////////////////////////////////////////////////////////////////
36506 . ////////////////////////////////////////////////////////////////////////////
36507
36508 .chapter "SMTP processing" "CHAPSMTP"
36509 .scindex IIDsmtpproc1 "SMTP" "processing details"
36510 .scindex IIDsmtpproc2 "LMTP" "processing details"
36511 Exim supports a number of different ways of using the SMTP protocol, and its
36512 LMTP variant, which is an interactive protocol for transferring messages into a
36513 closed mail store application. This chapter contains details of how SMTP is
36514 processed. For incoming mail, the following are available:
36515
36516 .ilist
36517 SMTP over TCP/IP (Exim daemon or &'inetd'&);
36518 .next
36519 SMTP over the standard input and output (the &%-bs%& option);
36520 .next
36521 Batched SMTP on the standard input (the &%-bS%& option).
36522 .endlist
36523
36524 For mail delivery, the following are available:
36525
36526 .ilist
36527 SMTP over TCP/IP (the &(smtp)& transport);
36528 .next
36529 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
36530 &"lmtp"&);
36531 .next
36532 LMTP over a pipe to a process running in the local host (the &(lmtp)&
36533 transport);
36534 .next
36535 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
36536 the &%use_bsmtp%& option set).
36537 .endlist
36538
36539 &'Batched SMTP'& is the name for a process in which batches of messages are
36540 stored in or read from files (or pipes), in a format in which SMTP commands are
36541 used to contain the envelope information.
36542
36543
36544
36545 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
36546 .cindex "SMTP" "outgoing over TCP/IP"
36547 .cindex "outgoing SMTP over TCP/IP"
36548 .cindex "LMTP" "over TCP/IP"
36549 .cindex "outgoing LMTP over TCP/IP"
36550 .cindex "EHLO"
36551 .cindex "HELO"
36552 .cindex "SIZE" "option on MAIL command"
36553 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
36554 The &%protocol%& option selects which protocol is to be used, but the actual
36555 processing is the same in both cases.
36556
36557 .cindex "ESMTP extensions" SIZE
36558 If, in response to its EHLO command, Exim is told that the SIZE
36559 extension is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
36560 command. The value of <&'n'&> is the message size plus the value of the
36561 &%size_addition%& option (default 1024) to allow for additions to the message
36562 such as per-transport header lines, or changes made in a
36563 .cindex "transport" "filter"
36564 .cindex "filter" "transport filter"
36565 transport filter. If &%size_addition%& is set negative, the use of SIZE is
36566 suppressed.
36567
36568 If the remote server advertises support for PIPELINING, Exim uses the
36569 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
36570 required for the transaction.
36571
36572 If the remote server advertises support for the STARTTLS command, and Exim
36573 was built to support TLS encryption, it tries to start a TLS session unless the
36574 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
36575 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
36576 is called for verification.
36577
36578 If the remote server advertises support for the AUTH command, Exim scans
36579 the authenticators configuration for any suitable client settings, as described
36580 in chapter &<<CHAPSMTPAUTH>>&.
36581
36582 .cindex "carriage return"
36583 .cindex "linefeed"
36584 Responses from the remote host are supposed to be terminated by CR followed by
36585 LF. However, there are known to be hosts that do not send CR characters, so in
36586 order to be able to interwork with such hosts, Exim treats LF on its own as a
36587 line terminator.
36588
36589 If a message contains a number of different addresses, all those with the same
36590 characteristics (for example, the same envelope sender) that resolve to the
36591 same set of hosts, in the same order, are sent in a single SMTP transaction,
36592 even if they are for different domains, unless there are more than the setting
36593 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
36594 they are split into groups containing no more than &%max_rcpt%&s addresses
36595 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
36596 in parallel sessions. The order of hosts with identical MX values is not
36597 significant when checking whether addresses can be batched in this way.
36598
36599 When the &(smtp)& transport suffers a temporary failure that is not
36600 message-related, Exim updates its transport-specific database, which contains
36601 records indexed by host name that remember which messages are waiting for each
36602 particular host. It also updates the retry database with new retry times.
36603
36604 .cindex "hints database" "retry keys"
36605 Exim's retry hints are based on host name plus IP address, so if one address of
36606 a multi-homed host is broken, it will soon be skipped most of the time.
36607 See the next section for more detail about error handling.
36608
36609 .cindex "SMTP" "passed connection"
36610 .cindex "SMTP" "batching over TCP/IP"
36611 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
36612 looks in the hints database for the transport to see if there are any queued
36613 messages waiting for the host to which it is connected. If it finds one, it
36614 creates a new Exim process using the &%-MC%& option (which can only be used by
36615 a process running as root or the Exim user) and passes the TCP/IP socket to it
36616 so that it can deliver another message using the same socket. The new process
36617 does only those deliveries that are routed to the connected host, and may in
36618 turn pass the socket on to a third process, and so on.
36619
36620 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
36621 limit the number of messages sent down a single TCP/IP connection.
36622
36623 .cindex "asterisk" "after IP address"
36624 The second and subsequent messages delivered down an existing connection are
36625 identified in the main log by the addition of an asterisk after the closing
36626 square bracket of the IP address.
36627
36628
36629
36630
36631 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
36632 .cindex "error" "in outgoing SMTP"
36633 .cindex "SMTP" "errors in outgoing"
36634 .cindex "host" "error"
36635 Three different kinds of error are recognized for outgoing SMTP: host errors,
36636 message errors, and recipient errors.
36637
36638 .vlist
36639 .vitem "&*Host errors*&"
36640 A host error is not associated with a particular message or with a
36641 particular recipient of a message. The host errors are:
36642
36643 .ilist
36644 Connection refused or timed out,
36645 .next
36646 Any error response code on connection,
36647 .next
36648 Any error response code to EHLO or HELO,
36649 .next
36650 Loss of connection at any time, except after &"."&,
36651 .next
36652 I/O errors at any time,
36653 .next
36654 Timeouts during the session, other than in response to MAIL, RCPT or
36655 the &"."& at the end of the data.
36656 .endlist ilist
36657
36658 For a host error, a permanent error response on connection, or in response to
36659 EHLO, causes all addresses routed to the host to be failed. Any other host
36660 error causes all addresses to be deferred, and retry data to be created for the
36661 host. It is not tried again, for any message, until its retry time arrives. If
36662 the current set of addresses are not all delivered in this run (to some
36663 alternative host), the message is added to the list of those waiting for this
36664 host, so if it is still undelivered when a subsequent successful delivery is
36665 made to the host, it will be sent down the same SMTP connection.
36666
36667 .vitem "&*Message errors*&"
36668 .cindex "message" "error"
36669 A message error is associated with a particular message when sent to a
36670 particular host, but not with a particular recipient of the message. The
36671 message errors are:
36672
36673 .ilist
36674 Any error response code to MAIL, DATA, or the &"."& that terminates
36675 the data,
36676 .next
36677 Timeout after MAIL,
36678 .next
36679 Timeout or loss of connection after the &"."& that terminates the data. A
36680 timeout after the DATA command itself is treated as a host error, as is loss of
36681 connection at any other time.
36682 .endlist ilist
36683
36684 For a message error, a permanent error response (5&'xx'&) causes all addresses
36685 to be failed, and a delivery error report to be returned to the sender. A
36686 temporary error response (4&'xx'&), or one of the timeouts, causes all
36687 addresses to be deferred. Retry data is not created for the host, but instead,
36688 a retry record for the combination of host plus message id is created. The
36689 message is not added to the list of those waiting for this host. This ensures
36690 that the failing message will not be sent to this host again until the retry
36691 time arrives. However, other messages that are routed to the host are not
36692 affected, so if it is some property of the message that is causing the error,
36693 it will not stop the delivery of other mail.
36694
36695 If the remote host specified support for the SIZE parameter in its response
36696 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
36697 over-large message will cause a message error because the error arrives as a
36698 response to MAIL.
36699
36700 .vitem "&*Recipient errors*&"
36701 .cindex "recipient" "error"
36702 A recipient error is associated with a particular recipient of a message. The
36703 recipient errors are:
36704
36705 .ilist
36706 Any error response to RCPT,
36707 .next
36708 Timeout after RCPT.
36709 .endlist
36710
36711 For a recipient error, a permanent error response (5&'xx'&) causes the
36712 recipient address to be failed, and a bounce message to be returned to the
36713 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
36714 address to be deferred, and routing retry data to be created for it. This is
36715 used to delay processing of the address in subsequent queue runs, until its
36716 routing retry time arrives. This applies to all messages, but because it
36717 operates only in queue runs, one attempt will be made to deliver a new message
36718 to the failing address before the delay starts to operate. This ensures that,
36719 if the failure is really related to the message rather than the recipient
36720 (&"message too big for this recipient"& is a possible example), other messages
36721 have a chance of getting delivered. If a delivery to the address does succeed,
36722 the retry information gets cleared, so all stuck messages get tried again, and
36723 the retry clock is reset.
36724
36725 The message is not added to the list of those waiting for this host. Use of the
36726 host for other messages is unaffected, and except in the case of a timeout,
36727 other recipients are processed independently, and may be successfully delivered
36728 in the current SMTP session. After a timeout it is of course impossible to
36729 proceed with the session, so all addresses get deferred. However, those other
36730 than the one that failed do not suffer any subsequent retry delays. Therefore,
36731 if one recipient is causing trouble, the others have a chance of getting
36732 through when a subsequent delivery attempt occurs before the failing
36733 recipient's retry time.
36734 .endlist
36735
36736 In all cases, if there are other hosts (or IP addresses) available for the
36737 current set of addresses (for example, from multiple MX records), they are
36738 tried in this run for any undelivered addresses, subject of course to their
36739 own retry data. In other words, recipient error retry data does not take effect
36740 until the next delivery attempt.
36741
36742 Some hosts have been observed to give temporary error responses to every
36743 MAIL command at certain times (&"insufficient space"& has been seen). It
36744 would be nice if such circumstances could be recognized, and defer data for the
36745 host itself created, but this is not possible within the current Exim design.
36746 What actually happens is that retry data for every (host, message) combination
36747 is created.
36748
36749 The reason that timeouts after MAIL and RCPT are treated specially is that
36750 these can sometimes arise as a result of the remote host's verification
36751 procedures. Exim makes this assumption, and treats them as if a temporary error
36752 response had been received. A timeout after &"."& is treated specially because
36753 it is known that some broken implementations fail to recognize the end of the
36754 message if the last character of the last line is a binary zero. Thus, it is
36755 helpful to treat this case as a message error.
36756
36757 Timeouts at other times are treated as host errors, assuming a problem with the
36758 host, or the connection to it. If a timeout after MAIL, RCPT,
36759 or &"."& is really a connection problem, the assumption is that at the next try
36760 the timeout is likely to occur at some other point in the dialogue, causing it
36761 then to be treated as a host error.
36762
36763 There is experimental evidence that some MTAs drop the connection after the
36764 terminating &"."& if they do not like the contents of the message for some
36765 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
36766 should be given. That is why Exim treats this case as a message rather than a
36767 host error, in order not to delay other messages to the same host.
36768
36769
36770
36771
36772 .section "Incoming SMTP messages over TCP/IP" "SECID233"
36773 .cindex "SMTP" "incoming over TCP/IP"
36774 .cindex "incoming SMTP over TCP/IP"
36775 .cindex "inetd"
36776 .cindex "daemon"
36777 Incoming SMTP messages can be accepted in one of two ways: by running a
36778 listening daemon, or by using &'inetd'&. In the latter case, the entry in
36779 &_/etc/inetd.conf_& should be like this:
36780 .code
36781 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
36782 .endd
36783 Exim distinguishes between this case and the case of a locally running user
36784 agent using the &%-bs%& option by checking whether or not the standard input is
36785 a socket. When it is, either the port must be privileged (less than 1024), or
36786 the caller must be root or the Exim user. If any other user passes a socket
36787 with an unprivileged port number, Exim prints a message on the standard error
36788 stream and exits with an error code.
36789
36790 By default, Exim does not make a log entry when a remote host connects or
36791 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
36792 unexpected. It can be made to write such log entries by setting the
36793 &%smtp_connection%& log selector.
36794
36795 .cindex "carriage return"
36796 .cindex "linefeed"
36797 Commands from the remote host are supposed to be terminated by CR followed by
36798 LF. However, there are known to be hosts that do not send CR characters. In
36799 order to be able to interwork with such hosts, Exim treats LF on its own as a
36800 line terminator.
36801 Furthermore, because common code is used for receiving messages from all
36802 sources, a CR on its own is also interpreted as a line terminator. However, the
36803 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
36804
36805 .cindex "EHLO" "invalid data"
36806 .cindex "HELO" "invalid data"
36807 One area that sometimes gives rise to problems concerns the EHLO or
36808 HELO commands. Some clients send syntactically invalid versions of these
36809 commands, which Exim rejects by default. (This is nothing to do with verifying
36810 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
36811 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
36812 match the broken hosts that send invalid commands.
36813
36814 .cindex "SIZE option on MAIL command"
36815 .cindex "MAIL" "SIZE option"
36816 The amount of disk space available is checked whenever SIZE is received on
36817 a MAIL command, independently of whether &%message_size_limit%& or
36818 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
36819 false. A temporary error is given if there is not enough space. If
36820 &%check_spool_space%& is set, the check is for that amount of space plus the
36821 value given with SIZE, that is, it checks that the addition of the incoming
36822 message will not reduce the space below the threshold.
36823
36824 When a message is successfully received, Exim includes the local message id in
36825 its response to the final &"."& that terminates the data. If the remote host
36826 logs this text it can help with tracing what has happened to a message.
36827
36828 The Exim daemon can limit the number of simultaneous incoming connections it is
36829 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
36830 number of simultaneous incoming connections from a single remote host (see the
36831 &%smtp_accept_max_per_host%& option). Additional connection attempts are
36832 rejected using the SMTP temporary error code 421.
36833
36834 The Exim daemon does not rely on the SIGCHLD signal to detect when a
36835 subprocess has finished, as this can get lost at busy times. Instead, it looks
36836 for completed subprocesses every time it wakes up. Provided there are other
36837 things happening (new incoming calls, starts of queue runs), completed
36838 processes will be noticed and tidied away. On very quiet systems you may
36839 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
36840 it will be noticed when the daemon next wakes up.
36841
36842 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
36843 and can also be set up to reject SMTP calls from non-reserved hosts at times of
36844 high system load &-- for details see the &%smtp_accept_reserve%&,
36845 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
36846 applies in both the daemon and &'inetd'& cases.
36847
36848 Exim normally starts a delivery process for each message received, though this
36849 can be varied by means of the &%-odq%& command line option and the
36850 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
36851 number of simultaneously running delivery processes started in this way from
36852 SMTP input can be limited by the &%smtp_accept_queue%& and
36853 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
36854 subsequently received messages are just put on the input queue without starting
36855 a delivery process.
36856
36857 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
36858 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
36859 started up from the &'inetd'& daemon, because in that case each connection is
36860 handled by an entirely independent Exim process. Control by load average is,
36861 however, available with &'inetd'&.
36862
36863 Exim can be configured to verify addresses in incoming SMTP commands as they
36864 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
36865 to rewrite addresses at this time &-- before any syntax checking is done. See
36866 section &<<SECTrewriteS>>&.
36867
36868 Exim can also be configured to limit the rate at which a client host submits
36869 MAIL and RCPT commands in a single SMTP session. See the
36870 &%smtp_ratelimit_hosts%& option.
36871
36872
36873
36874 .section "Unrecognized SMTP commands" "SECID234"
36875 .cindex "SMTP" "unrecognized commands"
36876 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
36877 commands during a single SMTP connection, it drops the connection after sending
36878 the error response to the last command. The default value for
36879 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
36880 abuse that subvert web servers into making connections to SMTP ports; in these
36881 circumstances, a number of non-SMTP lines are sent first.
36882
36883
36884 .section "Syntax and protocol errors in SMTP commands" "SECID235"
36885 .cindex "SMTP" "syntax errors"
36886 .cindex "SMTP" "protocol errors"
36887 A syntax error is detected if an SMTP command is recognized, but there is
36888 something syntactically wrong with its data, for example, a malformed email
36889 address in a RCPT command. Protocol errors include invalid command
36890 sequencing such as RCPT before MAIL. If Exim receives more than
36891 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
36892 drops the connection after sending the error response to the last command. The
36893 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
36894 broken clients that loop sending bad commands (yes, it has been seen).
36895
36896
36897
36898 .section "Use of non-mail SMTP commands" "SECID236"
36899 .cindex "SMTP" "non-mail commands"
36900 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
36901 DATA. Exim counts such commands, and drops the connection if there are too
36902 many of them in a single SMTP session. This action catches some
36903 denial-of-service attempts and things like repeated failing AUTHs, or a mad
36904 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
36905 defines what &"too many"& means. Its default value is 10.
36906
36907 When a new message is expected, one occurrence of RSET is not counted. This
36908 allows a client to send one RSET between messages (this is not necessary,
36909 but some clients do it). Exim also allows one uncounted occurrence of HELO
36910 or EHLO, and one occurrence of STARTTLS between messages. After
36911 starting up a TLS session, another EHLO is expected, and so it too is not
36912 counted.
36913
36914 The first occurrence of AUTH in a connection, or immediately following
36915 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
36916 RCPT, DATA, and QUIT are counted.
36917
36918 You can control which hosts are subject to the limit set by
36919 &%smtp_accept_max_nonmail%& by setting
36920 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
36921 the limit apply to all hosts. This option means that you can exclude any
36922 specific badly-behaved hosts that you have to live with.
36923
36924
36925
36926
36927 .section "The VRFY and EXPN commands" "SECID237"
36928 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
36929 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
36930 appropriate) in order to decide whether the command should be accepted or not.
36931
36932 .cindex "VRFY" "processing"
36933 When no ACL is defined for VRFY, or if it rejects without
36934 setting an explicit response code, the command is accepted
36935 (with a 252 SMTP response code)
36936 in order to support awkward clients that do a VRFY before every RCPT.
36937 When VRFY is accepted, it runs exactly the same code as when Exim is
36938 called with the &%-bv%& option, and returns 250/451/550
36939 SMTP response codes.
36940
36941 .cindex "EXPN" "processing"
36942 If no ACL for EXPN is defined, the command is rejected.
36943 When EXPN is accepted, a single-level expansion of the address is done.
36944 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
36945 than a verification (the &%-bv%& option). If an unqualified local part is given
36946 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
36947 of VRFY and EXPN commands are logged on the main and reject logs, and
36948 VRFY verification failures are logged on the main log for consistency with
36949 RCPT failures.
36950
36951
36952
36953 .section "The ETRN command" "SECTETRN"
36954 .cindex "ETRN" "processing"
36955 .cindex "ESMTP extensions" ETRN
36956 RFC 1985 describes an ESMTP command called ETRN that is designed to
36957 overcome the security problems of the TURN command (which has fallen into
36958 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
36959 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
36960 should be accepted or not. If no ACL is defined, the command is rejected.
36961
36962 The ETRN command is concerned with &"releasing"& messages that are awaiting
36963 delivery to certain hosts. As Exim does not organize its message queue by host,
36964 the only form of ETRN that is supported by default is the one where the
36965 text starts with the &"#"& prefix, in which case the remainder of the text is
36966 specific to the SMTP server. A valid ETRN command causes a run of Exim with
36967 the &%-R%& option to happen, with the remainder of the ETRN text as its
36968 argument. For example,
36969 .code
36970 ETRN #brigadoon
36971 .endd
36972 runs the command
36973 .code
36974 exim -R brigadoon
36975 .endd
36976 which causes a delivery attempt on all messages with undelivered addresses
36977 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
36978 default), Exim prevents the simultaneous execution of more than one queue run
36979 for the same argument string as a result of an ETRN command. This stops
36980 a misbehaving client from starting more than one queue runner at once.
36981
36982 .cindex "hints database" "ETRN serialization"
36983 Exim implements the serialization by means of a hints database in which a
36984 record is written whenever a process is started by ETRN, and deleted when
36985 the process completes. However, Exim does not keep the SMTP session waiting for
36986 the ETRN process to complete. Once ETRN is accepted, the client is sent
36987 a &"success"& return code. Obviously there is scope for hints records to get
36988 left lying around if there is a system or program crash. To guard against this,
36989 Exim ignores any records that are more than six hours old.
36990
36991 .oindex "&%smtp_etrn_command%&"
36992 For more control over what ETRN does, the &%smtp_etrn_command%& option can
36993 used. This specifies a command that is run whenever ETRN is received,
36994 whatever the form of its argument. For
36995 example:
36996 .code
36997 smtp_etrn_command = /etc/etrn_command $domain \
36998                     $sender_host_address
36999 .endd
37000 .vindex "&$domain$&"
37001 The string is split up into arguments which are independently expanded. The
37002 expansion variable &$domain$& is set to the argument of the ETRN command,
37003 and no syntax checking is done on the contents of this argument. Exim does not
37004 wait for the command to complete, so its status code is not checked. Exim runs
37005 under its own uid and gid when receiving incoming SMTP, so it is not possible
37006 for it to change them before running the command.
37007
37008
37009
37010 .section "Incoming local SMTP" "SECID238"
37011 .cindex "SMTP" "local incoming"
37012 Some user agents use SMTP to pass messages to their local MTA using the
37013 standard input and output, as opposed to passing the envelope on the command
37014 line and writing the message to the standard input. This is supported by the
37015 &%-bs%& option. This form of SMTP is handled in the same way as incoming
37016 messages over TCP/IP (including the use of ACLs), except that the envelope
37017 sender given in a MAIL command is ignored unless the caller is trusted. In
37018 an ACL you can detect this form of SMTP input by testing for an empty host
37019 identification. It is common to have this as the first line in the ACL that
37020 runs for RCPT commands:
37021 .code
37022 accept hosts = :
37023 .endd
37024 This accepts SMTP messages from local processes without doing any other tests.
37025
37026
37027
37028 .section "Outgoing batched SMTP" "SECTbatchSMTP"
37029 .cindex "SMTP" "batched outgoing"
37030 .cindex "batched SMTP output"
37031 Both the &(appendfile)& and &(pipe)& transports can be used for handling
37032 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
37033 be output in BSMTP format. No SMTP responses are possible for this form of
37034 delivery. All it is doing is using SMTP commands as a way of transmitting the
37035 envelope along with the message.
37036
37037 The message is written to the file or pipe preceded by the SMTP commands
37038 MAIL and RCPT, and followed by a line containing a single dot. Lines in
37039 the message that start with a dot have an extra dot added. The SMTP command
37040 HELO is not normally used. If it is required, the &%message_prefix%& option
37041 can be used to specify it.
37042
37043 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
37044 one recipient address at a time by default. However, you can arrange for them
37045 to handle several addresses at once by setting the &%batch_max%& option. When
37046 this is done for BSMTP, messages may contain multiple RCPT commands. See
37047 chapter &<<CHAPbatching>>& for more details.
37048
37049 .vindex "&$host$&"
37050 When one or more addresses are routed to a BSMTP transport by a router that
37051 sets up a host list, the name of the first host on the list is available to the
37052 transport in the variable &$host$&. Here is an example of such a transport and
37053 router:
37054 .code
37055 begin routers
37056 route_append:
37057   driver = manualroute
37058   transport = smtp_appendfile
37059   route_list = domain.example  batch.host.example
37060
37061 begin transports
37062 smtp_appendfile:
37063   driver = appendfile
37064   directory = /var/bsmtp/$host
37065   batch_max = 1000
37066   use_bsmtp
37067   user = exim
37068 .endd
37069 This causes messages addressed to &'domain.example'& to be written in BSMTP
37070 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
37071 message (unless there are more than 1000 recipients).
37072
37073
37074
37075 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
37076 .cindex "SMTP" "batched incoming"
37077 .cindex "batched SMTP input"
37078 The &%-bS%& command line option causes Exim to accept one or more messages by
37079 reading SMTP on the standard input, but to generate no responses. If the caller
37080 is trusted, the senders in the MAIL commands are believed; otherwise the
37081 sender is always the caller of Exim. Unqualified senders and receivers are not
37082 rejected (there seems little point) but instead just get qualified. HELO
37083 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
37084 as NOOP; QUIT quits.
37085
37086 Minimal policy checking is done for BSMTP input. Only the non-SMTP
37087 ACL is run in the same way as for non-SMTP local input.
37088
37089 If an error is detected while reading a message, including a missing &"."& at
37090 the end, Exim gives up immediately. It writes details of the error to the
37091 standard output in a stylized way that the calling program should be able to
37092 make some use of automatically, for example:
37093 .code
37094 554 Unexpected end of file
37095 Transaction started in line 10
37096 Error detected in line 14
37097 .endd
37098 It writes a more verbose version, for human consumption, to the standard error
37099 file, for example:
37100 .code
37101 An error was detected while processing a file of BSMTP input.
37102 The error message was:
37103
37104 501 '>' missing at end of address
37105
37106 The SMTP transaction started in line 10.
37107 The error was detected in line 12.
37108 The SMTP command at fault was:
37109
37110 rcpt to:<malformed@in.com.plete
37111
37112 1 previous message was successfully processed.
37113 The rest of the batch was abandoned.
37114 .endd
37115 The return code from Exim is zero only if there were no errors. It is 1 if some
37116 messages were accepted before an error was detected, and 2 if no messages were
37117 accepted.
37118 .ecindex IIDsmtpproc1
37119 .ecindex IIDsmtpproc2
37120
37121
37122
37123 . ////////////////////////////////////////////////////////////////////////////
37124 . ////////////////////////////////////////////////////////////////////////////
37125
37126 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
37127          "Customizing messages"
37128 When a message fails to be delivered, or remains in the queue for more than a
37129 configured amount of time, Exim sends a message to the original sender, or
37130 to an alternative configured address. The text of these messages is built into
37131 the code of Exim, but it is possible to change it, either by adding a single
37132 string, or by replacing each of the paragraphs by text supplied in a file.
37133
37134 The &'From:'& and &'To:'& header lines are automatically generated; you can
37135 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
37136 option. Exim also adds the line
37137 .code
37138 Auto-Submitted: auto-generated
37139 .endd
37140 to all warning and bounce messages,
37141
37142
37143 .section "Customizing bounce messages" "SECID239"
37144 .cindex "customizing" "bounce message"
37145 .cindex "bounce message" "customizing"
37146 If &%bounce_message_text%& is set, its contents are included in the default
37147 message immediately after &"This message was created automatically by mail
37148 delivery software."& The string is not expanded. It is not used if
37149 &%bounce_message_file%& is set.
37150
37151 When &%bounce_message_file%& is set, it must point to a template file for
37152 constructing error messages. The file consists of a series of text items,
37153 separated by lines consisting of exactly four asterisks. If the file cannot be
37154 opened, default text is used and a message is written to the main and panic
37155 logs. If any text item in the file is empty, default text is used for that
37156 item.
37157
37158 .vindex "&$bounce_recipient$&"
37159 .vindex "&$bounce_return_size_limit$&"
37160 Each item of text that is read from the file is expanded, and there are two
37161 expansion variables which can be of use here: &$bounce_recipient$& is set to
37162 the recipient of an error message while it is being created, and
37163 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
37164 option, rounded to a whole number.
37165
37166 The items must appear in the file in the following order:
37167
37168 .ilist
37169 The first item is included in the headers, and should include at least a
37170 &'Subject:'& header. Exim does not check the syntax of these headers.
37171 .next
37172 The second item forms the start of the error message. After it, Exim lists the
37173 failing addresses with their error messages.
37174 .next
37175 The third item is used to introduce any text from pipe transports that is to be
37176 returned to the sender. It is omitted if there is no such text.
37177 .next
37178 The fourth, fifth and sixth items will be ignored and may be empty.
37179 The fields exist for back-compatibility
37180 .endlist
37181
37182 The default state (&%bounce_message_file%& unset) is equivalent to the
37183 following file, in which the sixth item is empty. The &'Subject:'& and some
37184 other lines have been split in order to fit them on the page:
37185 .code
37186 Subject: Mail delivery failed
37187   ${if eq{$sender_address}{$bounce_recipient}
37188   {: returning message to sender}}
37189 ****
37190 This message was created automatically by mail delivery software.
37191
37192 A message ${if eq{$sender_address}{$bounce_recipient}
37193   {that you sent }{sent by
37194
37195 <$sender_address>
37196
37197 }}could not be delivered to all of its recipients.
37198 This is a permanent error. The following address(es) failed:
37199 ****
37200 The following text was generated during the delivery attempt(s):
37201 ****
37202 ------ This is a copy of the message, including all the headers.
37203   ------
37204 ****
37205 ------ The body of the message is $message_size characters long;
37206   only the first
37207 ------ $bounce_return_size_limit or so are included here.
37208 ****
37209 .endd
37210 .section "Customizing warning messages" "SECTcustwarn"
37211 .cindex "customizing" "warning message"
37212 .cindex "warning of delay" "customizing the message"
37213 The option &%warn_message_file%& can be pointed at a template file for use when
37214 warnings about message delays are created. In this case there are only three
37215 text sections:
37216
37217 .ilist
37218 The first item is included in the headers, and should include at least a
37219 &'Subject:'& header. Exim does not check the syntax of these headers.
37220 .next
37221 The second item forms the start of the warning message. After it, Exim lists
37222 the delayed addresses.
37223 .next
37224 The third item then ends the message.
37225 .endlist
37226
37227 The default state is equivalent to the following file, except that some lines
37228 have been split here, in order to fit them on the page:
37229 .code
37230 Subject: Warning: message $message_exim_id delayed
37231   $warn_message_delay
37232 ****
37233 This message was created automatically by mail delivery software.
37234
37235 A message ${if eq{$sender_address}{$warn_message_recipients}
37236 {that you sent }{sent by
37237
37238 <$sender_address>
37239
37240 }}has not been delivered to all of its recipients after
37241 more than $warn_message_delay in the queue on $primary_hostname.
37242
37243 The message identifier is:     $message_exim_id
37244 The subject of the message is: $h_subject
37245 The date of the message is:    $h_date
37246
37247 The following address(es) have not yet been delivered:
37248 ****
37249 No action is required on your part. Delivery attempts will
37250 continue for some time, and this warning may be repeated at
37251 intervals if the message remains undelivered. Eventually the
37252 mail delivery software will give up, and when that happens,
37253 the message will be returned to you.
37254 .endd
37255 .vindex "&$warn_message_delay$&"
37256 .vindex "&$warn_message_recipients$&"
37257 However, in the default state the subject and date lines are omitted if no
37258 appropriate headers exist. During the expansion of this file,
37259 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
37260 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
37261 of recipients for the warning message. There may be more than one if there are
37262 multiple addresses with different &%errors_to%& settings on the routers that
37263 handled them.
37264
37265
37266
37267
37268 . ////////////////////////////////////////////////////////////////////////////
37269 . ////////////////////////////////////////////////////////////////////////////
37270
37271 .chapter "Some common configuration settings" "CHAPcomconreq"
37272 This chapter discusses some configuration settings that seem to be fairly
37273 common. More examples and discussion can be found in the Exim book.
37274
37275
37276
37277 .section "Sending mail to a smart host" "SECID240"
37278 .cindex "smart host" "example router"
37279 If you want to send all mail for non-local domains to a &"smart host"&, you
37280 should replace the default &(dnslookup)& router with a router which does the
37281 routing explicitly:
37282 .code
37283 send_to_smart_host:
37284   driver = manualroute
37285   route_list = !+local_domains smart.host.name
37286   transport = remote_smtp
37287 .endd
37288 You can use the smart host's IP address instead of the name if you wish.
37289 If you are using Exim only to submit messages to a smart host, and not for
37290 receiving incoming messages, you can arrange for it to do the submission
37291 synchronously by setting the &%mua_wrapper%& option (see chapter
37292 &<<CHAPnonqueueing>>&).
37293
37294
37295
37296
37297 .section "Using Exim to handle mailing lists" "SECTmailinglists"
37298 .cindex "mailing lists"
37299 Exim can be used to run simple mailing lists, but for large and/or complicated
37300 requirements, the use of additional specialized mailing list software such as
37301 Majordomo or Mailman is recommended.
37302
37303 The &(redirect)& router can be used to handle mailing lists where each list
37304 is maintained in a separate file, which can therefore be managed by an
37305 independent manager. The &%domains%& router option can be used to run these
37306 lists in a separate domain from normal mail. For example:
37307 .code
37308 lists:
37309   driver = redirect
37310   domains = lists.example
37311   file = ${lookup {$local_part} dsearch,ret=full {/usr/lists}}
37312   forbid_pipe
37313   forbid_file
37314   errors_to = ${quote_local_part:$local_part-request}@lists.example
37315   no_more
37316 .endd
37317 This router is skipped for domains other than &'lists.example'&. For addresses
37318 in that domain, it looks for a file that matches the local part. If there is no
37319 such file, the router declines, but because &%no_more%& is set, no subsequent
37320 routers are tried, and so the whole delivery fails.
37321
37322 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
37323 expanded into a filename or a pipe delivery, which is usually inappropriate in
37324 a mailing list.
37325
37326 .oindex "&%errors_to%&"
37327 The &%errors_to%& option specifies that any delivery errors caused by addresses
37328 taken from a mailing list are to be sent to the given address rather than the
37329 original sender of the message. However, before acting on this, Exim verifies
37330 the error address, and ignores it if verification fails.
37331
37332 For example, using the configuration above, mail sent to
37333 &'dicts@lists.example'& is passed on to those addresses contained in
37334 &_/usr/lists/dicts_&, with error reports directed to
37335 &'dicts-request@lists.example'&, provided that this address can be verified.
37336 There could be a file called &_/usr/lists/dicts-request_& containing
37337 the address(es) of this particular list's manager(s), but other approaches,
37338 such as setting up an earlier router (possibly using the &%local_part_prefix%&
37339 or &%local_part_suffix%& options) to handle addresses of the form
37340 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
37341
37342
37343
37344 .section "Syntax errors in mailing lists" "SECID241"
37345 .cindex "mailing lists" "syntax errors in"
37346 If an entry in redirection data contains a syntax error, Exim normally defers
37347 delivery of the original address. That means that a syntax error in a mailing
37348 list holds up all deliveries to the list. This may not be appropriate when a
37349 list is being maintained automatically from data supplied by users, and the
37350 addresses are not rigorously checked.
37351
37352 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
37353 entries that fail to parse, noting the incident in the log. If in addition
37354 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
37355 whenever a broken address is skipped. It is usually appropriate to set
37356 &%syntax_errors_to%& to the same address as &%errors_to%&.
37357
37358
37359
37360 .section "Re-expansion of mailing lists" "SECID242"
37361 .cindex "mailing lists" "re-expansion of"
37362 Exim remembers every individual address to which a message has been delivered,
37363 in order to avoid duplication, but it normally stores only the original
37364 recipient addresses with a message. If all the deliveries to a mailing list
37365 cannot be done at the first attempt, the mailing list is re-expanded when the
37366 delivery is next tried. This means that alterations to the list are taken into
37367 account at each delivery attempt, so addresses that have been added to
37368 the list since the message arrived will therefore receive a copy of the
37369 message, even though it pre-dates their subscription.
37370
37371 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
37372 on the &(redirect)& router. If this is done, any addresses generated by the
37373 router that fail to deliver at the first attempt are added to the message as
37374 &"top level"& addresses, and the parent address that generated them is marked
37375 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
37376 subsequent delivery attempts. The disadvantage of this is that if any of the
37377 failing addresses are incorrect, correcting them in the file has no effect on
37378 pre-existing messages.
37379
37380 The original top-level address is remembered with each of the generated
37381 addresses, and is output in any log messages. However, any intermediate parent
37382 addresses are not recorded. This makes a difference to the log only if the
37383 &%all_parents%& selector is set, but for mailing lists there is normally only
37384 one level of expansion anyway.
37385
37386
37387
37388 .section "Closed mailing lists" "SECID243"
37389 .cindex "mailing lists" "closed"
37390 The examples so far have assumed open mailing lists, to which anybody may
37391 send mail. It is also possible to set up closed lists, where mail is accepted
37392 from specified senders only. This is done by making use of the generic
37393 &%senders%& option to restrict the router that handles the list.
37394
37395 The following example uses the same file as a list of recipients and as a list
37396 of permitted senders. It requires three routers:
37397 .code
37398 lists_request:
37399   driver = redirect
37400   domains = lists.example
37401   local_part_suffix = -request
37402   local_parts = ${lookup {$local_part} dsearch,filter=file {/usr/lists}}
37403   file = /usr/lists/${local_part_data}-request
37404   no_more
37405
37406 lists_post:
37407   driver = redirect
37408   domains = lists.example
37409   senders = ${if exists {/usr/lists/$local_part}\
37410              {lsearch;/usr/lists/$local_part}{*}}
37411   file = ${lookup {$local_part} dsearch,ret=full {/usr/lists}}
37412   forbid_pipe
37413   forbid_file
37414   errors_to = ${quote_local_part:$local_part-request}@lists.example
37415   no_more
37416
37417 lists_closed:
37418   driver = redirect
37419   domains = lists.example
37420   allow_fail
37421   data = :fail: $local_part@lists.example is a closed mailing list
37422 .endd
37423 All three routers have the same &%domains%& setting, so for any other domains,
37424 they are all skipped. The first router runs only if the local part ends in
37425 &%-request%&. It handles messages to the list manager(s) by means of an open
37426 mailing list.
37427
37428 The second router runs only if the &%senders%& precondition is satisfied. It
37429 checks for the existence of a list that corresponds to the local part, and then
37430 checks that the sender is on the list by means of a linear search. It is
37431 necessary to check for the existence of the file before trying to search it,
37432 because otherwise Exim thinks there is a configuration error. If the file does
37433 not exist, the expansion of &%senders%& is *, which matches all senders. This
37434 means that the router runs, but because there is no list, declines, and
37435 &%no_more%& ensures that no further routers are run. The address fails with an
37436 &"unrouteable address"& error.
37437
37438 The third router runs only if the second router is skipped, which happens when
37439 a mailing list exists, but the sender is not on it. This router forcibly fails
37440 the address, giving a suitable error message.
37441
37442
37443
37444
37445 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
37446 .cindex "VERP"
37447 .cindex "Variable Envelope Return Paths"
37448 .cindex "envelope from"
37449 .cindex "envelope sender"
37450 Variable Envelope Return Paths &-- see &url(https://cr.yp.to/proto/verp.txt) &--
37451 are a way of helping mailing list administrators discover which subscription
37452 address is the cause of a particular delivery failure. The idea is to encode
37453 the original recipient address in the outgoing envelope sender address, so that
37454 if the message is forwarded by another host and then subsequently bounces, the
37455 original recipient can be extracted from the recipient address of the bounce.
37456
37457 .oindex &%errors_to%&
37458 .oindex &%return_path%&
37459 Envelope sender addresses can be modified by Exim using two different
37460 facilities: the &%errors_to%& option on a router (as shown in previous mailing
37461 list examples), or the &%return_path%& option on a transport. The second of
37462 these is effective only if the message is successfully delivered to another
37463 host; it is not used for errors detected on the local host (see the description
37464 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
37465 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
37466 .code
37467 verp_smtp:
37468   driver = smtp
37469   max_rcpt = 1
37470   return_path = \
37471     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
37472       {${quote_local_part:$1-request+$local_part=$domain}@your.dom.example}fail}
37473 .endd
37474 This has the effect of rewriting the return path (envelope sender) on outgoing
37475 SMTP messages, if the local part of the original return path ends in
37476 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
37477 local part and domain of the recipient into the return path. Suppose, for
37478 example, that a message whose return path has been set to
37479 &'somelist-request@your.dom.example'& is sent to
37480 &'subscriber@other.dom.example'&. In the transport, the return path is
37481 rewritten as
37482 .code
37483 somelist-request+subscriber=other.dom.example@your.dom.example
37484 .endd
37485 .vindex "&$local_part$&"
37486 For this to work, you must tell Exim to send multiple copies of messages that
37487 have more than one recipient, so that each copy has just one recipient. This is
37488 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
37489 might be sent to several different recipients in the same domain, in which case
37490 &$local_part$& is not available in the transport, because it is not unique.
37491
37492 Unless your host is doing nothing but mailing list deliveries, you should
37493 probably use a separate transport for the VERP deliveries, so as not to use
37494 extra resources in making one-per-recipient copies for other deliveries. This
37495 can easily be done by expanding the &%transport%& option in the router:
37496 .code
37497 dnslookup:
37498   driver = dnslookup
37499   domains = ! +local_domains
37500   transport = \
37501     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
37502       {verp_smtp}{remote_smtp}}
37503   no_more
37504 .endd
37505 If you want to change the return path using &%errors_to%& in a router instead
37506 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
37507 routers that handle mailing list addresses. This will ensure that all delivery
37508 errors, including those detected on the local host, are sent to the VERP
37509 address.
37510
37511 On a host that does no local deliveries and has no manual routing, only the
37512 &(dnslookup)& router needs to be changed. A special transport is not needed for
37513 SMTP deliveries. Every mailing list recipient has its own return path value,
37514 and so Exim must hand them to the transport one at a time. Here is an example
37515 of a &(dnslookup)& router that implements VERP:
37516 .code
37517 verp_dnslookup:
37518   driver = dnslookup
37519   domains = ! +local_domains
37520   transport = remote_smtp
37521   errors_to = \
37522     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
37523      {${quote_local_part:$1-request+$local_part=$domain}@your.dom.example}fail}
37524   no_more
37525 .endd
37526 Before you start sending out messages with VERPed return paths, you must also
37527 configure Exim to accept the bounce messages that come back to those paths.
37528 Typically this is done by setting a &%local_part_suffix%& option for a
37529 router, and using this to route the messages to wherever you want to handle
37530 them.
37531
37532 The overhead incurred in using VERP depends very much on the size of the
37533 message, the number of recipient addresses that resolve to the same remote
37534 host, and the speed of the connection over which the message is being sent. If
37535 a lot of addresses resolve to the same host and the connection is slow, sending
37536 a separate copy of the message for each address may take substantially longer
37537 than sending a single copy with many recipients (for which VERP cannot be
37538 used).
37539
37540
37541
37542
37543
37544
37545 .section "Virtual domains" "SECTvirtualdomains"
37546 .cindex "virtual domains"
37547 .cindex "domain" "virtual"
37548 The phrase &'virtual domain'& is unfortunately used with two rather different
37549 meanings:
37550
37551 .ilist
37552 A domain for which there are no real mailboxes; all valid local parts are
37553 aliases for other email addresses. Common examples are organizational
37554 top-level domains and &"vanity"& domains.
37555 .next
37556 One of a number of independent domains that are all handled by the same host,
37557 with mailboxes on that host, but where the mailbox owners do not necessarily
37558 have login accounts on that host.
37559 .endlist
37560
37561 The first usage is probably more common, and does seem more &"virtual"& than
37562 the second. This kind of domain can be handled in Exim with a straightforward
37563 aliasing router. One approach is to create a separate alias file for each
37564 virtual domain. Exim can test for the existence of the alias file to determine
37565 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
37566 to a router of this form:
37567 .code
37568 virtual:
37569   driver = redirect
37570   domains = dsearch;/etc/mail/virtual
37571   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain_data}}
37572   no_more
37573 .endd
37574 The &%domains%& option specifies that the router is to be skipped, unless there
37575 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
37576 domain that is being processed.
37577 The &(dsearch)& lookup used results in an untainted version of &$domain$&
37578 being placed into the &$domain_data$& variable.
37579
37580 When the router runs, it looks up the local
37581 part in the file to find a new address (or list of addresses). The &%no_more%&
37582 setting ensures that if the lookup fails (leading to &%data%& being an empty
37583 string), Exim gives up on the address without trying any subsequent routers.
37584
37585 This one router can handle all the virtual domains because the alias filenames
37586 follow a fixed pattern. Permissions can be arranged so that appropriate people
37587 can edit the different alias files. A successful aliasing operation results in
37588 a new envelope recipient address, which is then routed from scratch.
37589
37590 The other kind of &"virtual"& domain can also be handled in a straightforward
37591 way. One approach is to create a file for each domain containing a list of
37592 valid local parts, and use it in a router like this:
37593 .code
37594 my_domains:
37595   driver = accept
37596   domains = dsearch;/etc/mail/domains
37597   local_parts = lsearch;/etc/mail/domains/$domain
37598   transport = my_mailboxes
37599 .endd
37600 The address is accepted if there is a file for the domain, and the local part
37601 can be found in the file. The &%domains%& option is used to check for the
37602 file's existence because &%domains%& is tested before the &%local_parts%&
37603 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
37604 because that option is tested after &%local_parts%&. The transport is as
37605 follows:
37606 .code
37607 my_mailboxes:
37608   driver = appendfile
37609   file = /var/mail/$domain_data/$local_part_data
37610   user = mail
37611 .endd
37612 This uses a directory of mailboxes for each domain. The &%user%& setting is
37613 required, to specify which uid is to be used for writing to the mailboxes.
37614
37615 The configuration shown here is just one example of how you might support this
37616 requirement. There are many other ways this kind of configuration can be set
37617 up, for example, by using a database instead of separate files to hold all the
37618 information about the domains.
37619
37620
37621
37622 .section "Multiple user mailboxes" "SECTmulbox"
37623 .cindex "multiple mailboxes"
37624 .cindex "mailbox" "multiple"
37625 .cindex "local part" "prefix"
37626 .cindex "local part" "suffix"
37627 Heavy email users often want to operate with multiple mailboxes, into which
37628 incoming mail is automatically sorted. A popular way of handling this is to
37629 allow users to use multiple sender addresses, so that replies can easily be
37630 identified. Users are permitted to add prefixes or suffixes to their local
37631 parts for this purpose. The wildcard facility of the generic router options
37632 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
37633 example, consider this router:
37634 .code
37635 userforward:
37636   driver = redirect
37637   check_local_user
37638   file = $home/.forward
37639   local_part_suffix = -*
37640   local_part_suffix_optional
37641   allow_filter
37642 .endd
37643 .vindex "&$local_part_suffix$&"
37644 It runs a user's &_.forward_& file for all local parts of the form
37645 &'username-*'&. Within the filter file the user can distinguish different
37646 cases by testing the variable &$local_part_suffix$&. For example:
37647 .code
37648 if $local_part_suffix contains -special then
37649 save /home/$local_part_data/Mail/special
37650 endif
37651 .endd
37652 If the filter file does not exist, or does not deal with such addresses, they
37653 fall through to subsequent routers, and, assuming no subsequent use of the
37654 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
37655 control over which suffixes are valid.
37656
37657 Alternatively, a suffix can be used to trigger the use of a different
37658 &_.forward_& file &-- which is the way a similar facility is implemented in
37659 another MTA:
37660 .code
37661 userforward:
37662   driver = redirect
37663   check_local_user
37664   local_part_suffix = -*
37665   local_part_suffix_optional
37666   file = ${lookup {.forward$local_part_suffix} dsearch,ret=full {$home} {$value}fail}
37667   allow_filter
37668 .endd
37669 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
37670 example, &_.forward-special_& is used. Once again, if the appropriate file
37671 does not exist, or does not deal with the address, it is passed on to
37672 subsequent routers, which could, if required, look for an unqualified
37673 &_.forward_& file to use as a default.
37674
37675
37676
37677 .section "Simplified vacation processing" "SECID244"
37678 .cindex "vacation processing"
37679 The traditional way of running the &'vacation'& program is for a user to set up
37680 a pipe command in a &_.forward_& file
37681 (see section &<<SECTspecitredli>>& for syntax details).
37682 This is prone to error by inexperienced users. There are two features of Exim
37683 that can be used to make this process simpler for users:
37684
37685 .ilist
37686 A local part prefix such as &"vacation-"& can be specified on a router which
37687 can cause the message to be delivered directly to the &'vacation'& program, or
37688 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
37689 &_.forward_& file are then much simpler. For example:
37690 .code
37691 spqr, vacation-spqr
37692 .endd
37693 .next
37694 The &%require_files%& generic router option can be used to trigger a
37695 vacation delivery by checking for the existence of a certain file in the
37696 user's home directory. The &%unseen%& generic option should also be used, to
37697 ensure that the original delivery also proceeds. In this case, all the user has
37698 to do is to create a file called, say, &_.vacation_&, containing a vacation
37699 message.
37700 .endlist
37701
37702 Another advantage of both these methods is that they both work even when the
37703 use of arbitrary pipes by users is locked out.
37704
37705
37706
37707 .section "Taking copies of mail" "SECID245"
37708 .cindex "message" "copying every"
37709 Some installations have policies that require archive copies of all messages to
37710 be made. A single copy of each message can easily be taken by an appropriate
37711 command in a system filter, which could, for example, use a different file for
37712 each day's messages.
37713
37714 There is also a shadow transport mechanism that can be used to take copies of
37715 messages that are successfully delivered by local transports, one copy per
37716 delivery. This could be used, &'inter alia'&, to implement automatic
37717 notification of delivery by sites that insist on doing such things.
37718
37719
37720
37721 .section "Intermittently connected hosts" "SECID246"
37722 .cindex "intermittently connected hosts"
37723 It has become quite common (because it is cheaper) for hosts to connect to the
37724 Internet periodically rather than remain connected all the time. The normal
37725 arrangement is that mail for such hosts accumulates on a system that is
37726 permanently connected.
37727
37728 Exim was designed for use on permanently connected hosts, and so it is not
37729 particularly well-suited to use in an intermittently connected environment.
37730 Nevertheless there are some features that can be used.
37731
37732
37733 .section "Exim on the upstream server host" "SECID247"
37734 It is tempting to arrange for incoming mail for the intermittently connected
37735 host to remain in Exim's queue until the client connects. However, this
37736 approach does not scale very well. Two different kinds of waiting message are
37737 being mixed up in the same queue &-- those that cannot be delivered because of
37738 some temporary problem, and those that are waiting for their destination host
37739 to connect. This makes it hard to manage the queue, as well as wasting
37740 resources, because each queue runner scans the entire queue.
37741
37742 A better approach is to separate off those messages that are waiting for an
37743 intermittently connected host. This can be done by delivering these messages
37744 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
37745 format, from where they are transmitted by other software when their
37746 destination connects. This makes it easy to collect all the mail for one host
37747 in a single directory, and to apply local timeout rules on a per-message basis
37748 if required.
37749
37750 On a very small scale, leaving the mail on Exim's queue can be made to work. If
37751 you are doing this, you should configure Exim with a long retry period for the
37752 intermittent host. For example:
37753 .code
37754 cheshire.wonderland.fict.example    *   F,5d,24h
37755 .endd
37756 This stops a lot of failed delivery attempts from occurring, but Exim remembers
37757 which messages it has queued up for that host. Once the intermittent host comes
37758 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
37759 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
37760 causes all the queued up messages to be delivered, often down a single SMTP
37761 connection. While the host remains connected, any new messages get delivered
37762 immediately.
37763
37764 If the connecting hosts do not have fixed IP addresses, that is, if a host is
37765 issued with a different IP address each time it connects, Exim's retry
37766 mechanisms on the holding host get confused, because the IP address is normally
37767 used as part of the key string for holding retry information. This can be
37768 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
37769 Since this has disadvantages for permanently connected hosts, it is best to
37770 arrange a separate transport for the intermittently connected ones.
37771
37772
37773
37774 .section "Exim on the intermittently connected client host" "SECID248"
37775 The value of &%smtp_accept_queue_per_connection%& should probably be
37776 increased, or even set to zero (that is, disabled) on the intermittently
37777 connected host, so that all incoming messages down a single connection get
37778 delivered immediately.
37779
37780 .cindex "SMTP" "passed connection"
37781 .cindex "SMTP" "multiple deliveries"
37782 .cindex "multiple SMTP deliveries"
37783 .cindex "first pass routing"
37784 Mail waiting to be sent from an intermittently connected host will probably
37785 not have been routed, because without a connection DNS lookups are not
37786 possible. This means that if a normal queue run is done at connection time,
37787 each message is likely to be sent in a separate SMTP session. This can be
37788 avoided by starting the queue run with a command line option beginning with
37789 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
37790 first pass, routing is done but no deliveries take place. The second pass is a
37791 normal queue run; since all the messages have been previously routed, those
37792 destined for the same host are likely to get sent as multiple deliveries in a
37793 single SMTP connection.
37794
37795
37796
37797 . ////////////////////////////////////////////////////////////////////////////
37798 . ////////////////////////////////////////////////////////////////////////////
37799
37800 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
37801          "Exim as a non-queueing client"
37802 .cindex "client, non-queueing"
37803 .cindex "smart host" "suppressing queueing"
37804 On a personal computer, it is a common requirement for all
37805 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
37806 configured to operate that way, for all the popular operating systems.
37807 However, there are some MUAs for Unix-like systems that cannot be so
37808 configured: they submit messages using the command line interface of
37809 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
37810 messages this way.
37811
37812 If the personal computer runs continuously, there is no problem, because it can
37813 run a conventional MTA that handles delivery to the smart host, and deal with
37814 any delays via its queueing mechanism. However, if the computer does not run
37815 continuously or runs different operating systems at different times, queueing
37816 email is not desirable.
37817
37818 There is therefore a requirement for something that can provide the
37819 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
37820 any queueing or retrying facilities. Furthermore, the delivery to the smart
37821 host should be synchronous, so that if it fails, the sending MUA is immediately
37822 informed. In other words, we want something that extends an MUA that submits
37823 to a local MTA via the command line so that it behaves like one that submits
37824 to a remote smart host using TCP/SMTP.
37825
37826 There are a number of applications (for example, there is one called &'ssmtp'&)
37827 that do this job. However, people have found them to be lacking in various
37828 ways. For instance, you might want to allow aliasing and forwarding to be done
37829 before sending a message to the smart host.
37830
37831 Exim already had the necessary infrastructure for doing this job. Just a few
37832 tweaks were needed to make it behave as required, though it is somewhat of an
37833 overkill to use a fully-featured MTA for this purpose.
37834
37835 .oindex "&%mua_wrapper%&"
37836 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
37837 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
37838 assumes that it is being used to &"wrap"& a command-line MUA in the manner
37839 just described. As well as setting &%mua_wrapper%&, you also need to provide a
37840 compatible router and transport configuration. Typically there will be just one
37841 router and one transport, sending everything to a smart host.
37842
37843 When run in MUA wrapping mode, the behaviour of Exim changes in the
37844 following ways:
37845
37846 .ilist
37847 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
37848 In other words, the only way to submit messages is via the command line.
37849 .next
37850 Each message is synchronously delivered as soon as it is received (&%-odi%& is
37851 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
37852 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
37853 does not finish until the delivery attempt is complete. If the delivery is
37854 successful, a zero return code is given.
37855 .next
37856 Address redirection is permitted, but the final routing for all addresses must
37857 be to the same remote transport, and to the same list of hosts. Furthermore,
37858 the return address (envelope sender) must be the same for all recipients, as
37859 must any added or deleted header lines. In other words, it must be possible to
37860 deliver the message in a single SMTP transaction, however many recipients there
37861 are.
37862 .next
37863 If these conditions are not met, or if routing any address results in a
37864 failure or defer status, or if Exim is unable to deliver all the recipients
37865 successfully to one of the smart hosts, delivery of the entire message fails.
37866 .next
37867 Because no queueing is allowed, all failures are treated as permanent; there
37868 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
37869 smart host. Furthermore, because only a single yes/no response can be given to
37870 the caller, it is not possible to deliver to some recipients and not others. If
37871 there is an error (temporary or permanent) for any recipient, all are failed.
37872 .next
37873 If more than one smart host is listed, Exim will try another host after a
37874 connection failure or a timeout, in the normal way. However, if this kind of
37875 failure happens for all the hosts, the delivery fails.
37876 .next
37877 When delivery fails, an error message is written to the standard error stream
37878 (as well as to Exim's log), and Exim exits to the caller with a return code
37879 value 1. The message is expunged from Exim's spool files. No bounce messages
37880 are ever generated.
37881 .next
37882 No retry data is maintained, and any retry rules are ignored.
37883 .next
37884 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
37885 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
37886 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
37887 .endlist
37888
37889 The overall effect is that Exim makes a single synchronous attempt to deliver
37890 the message, failing if there is any kind of problem. Because no local
37891 deliveries are done and no daemon can be run, Exim does not need root
37892 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
37893 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
37894 the advantages and disadvantages of running without root privilege.
37895
37896
37897
37898
37899 . ////////////////////////////////////////////////////////////////////////////
37900 . ////////////////////////////////////////////////////////////////////////////
37901
37902 .chapter "Log files" "CHAPlog"
37903 .scindex IIDloggen "log" "general description"
37904 .cindex "log" "types of"
37905 Exim writes three different logs, referred to as the main log, the reject log,
37906 and the panic log:
37907
37908 .ilist
37909 .cindex "main log"
37910 The main log records the arrival of each message and each delivery in a single
37911 line in each case. The format is as compact as possible, in an attempt to keep
37912 down the size of log files. Two-character flag sequences make it easy to pick
37913 out these lines. A number of other events are recorded in the main log. Some of
37914 them are optional, in which case the &%log_selector%& option controls whether
37915 they are included or not. A Perl script called &'eximstats'&, which does simple
37916 analysis of main log files, is provided in the Exim distribution (see section
37917 &<<SECTmailstat>>&).
37918 .next
37919 .cindex "reject log"
37920 The reject log records information from messages that are rejected as a result
37921 of a configuration option (that is, for policy reasons).
37922 The first line of each rejection is a copy of the line that is also written to
37923 the main log. Then, if the message's header has been read at the time the log
37924 is written, its contents are written to this log. Only the original header
37925 lines are available; header lines added by ACLs are not logged. You can use the
37926 reject log to check that your policy controls are working correctly; on a busy
37927 host this may be easier than scanning the main log for rejection messages. You
37928 can suppress the writing of the reject log by setting &%write_rejectlog%&
37929 false.
37930 .next
37931 .cindex "panic log"
37932 .cindex "system log"
37933 When certain serious errors occur, Exim writes entries to its panic log. If the
37934 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
37935 are usually written to the main log as well, but can get lost amid the mass of
37936 other entries. The panic log should be empty under normal circumstances. It is
37937 therefore a good idea to check it (or to have a &'cron'& script check it)
37938 regularly, in order to become aware of any problems. When Exim cannot open its
37939 panic log, it tries as a last resort to write to the system log (syslog). This
37940 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
37941 message itself is written at priority LOG_CRIT.
37942 .endlist
37943
37944 Every log line starts with a timestamp, in the format shown in the following
37945 example. Note that many of the examples shown in this chapter are line-wrapped.
37946 In the log file, this would be all on one line:
37947 .code
37948 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
37949   by QUIT
37950 .endd
37951 By default, the timestamps are in the local timezone. There are two
37952 ways of changing this:
37953
37954 .ilist
37955 You can set the &%timezone%& option to a different time zone; in particular, if
37956 you set
37957 .code
37958 timezone = UTC
37959 .endd
37960 the timestamps will be in UTC (aka GMT).
37961 .next
37962 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
37963 example:
37964 .code
37965 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
37966 .endd
37967 .endlist
37968
37969 .cindex "log" "process ids in"
37970 .cindex "pid (process id)" "in log lines"
37971 Exim does not include its process id in log lines by default, but you can
37972 request that it does so by specifying the &`pid`& log selector (see section
37973 &<<SECTlogselector>>&). When this is set, the process id is output, in square
37974 brackets, immediately after the time and date.
37975
37976
37977
37978
37979 .section "Where the logs are written" "SECTwhelogwri"
37980 .cindex "log" "destination"
37981 .cindex "log" "to file"
37982 .cindex "log" "to syslog"
37983 .cindex "syslog"
37984 The logs may be written to local files, or to syslog, or both. However, it
37985 should be noted that many syslog implementations use UDP as a transport, and
37986 are therefore unreliable in the sense that messages are not guaranteed to
37987 arrive at the loghost, nor is the ordering of messages necessarily maintained.
37988 It has also been reported that on large log files (tens of megabytes) you may
37989 need to tweak syslog to prevent it syncing the file with each write &-- on
37990 Linux this has been seen to make syslog take 90% plus of CPU time.
37991
37992 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
37993 &_Local/Makefile_& or by setting &%log_file_path%& in the runtime
37994 configuration. This latter string is expanded, so it can contain, for example,
37995 references to the host name:
37996 .code
37997 log_file_path = /var/log/$primary_hostname/exim_%slog
37998 .endd
37999 It is generally advisable, however, to set the string in &_Local/Makefile_&
38000 rather than at runtime, because then the setting is available right from the
38001 start of Exim's execution. Otherwise, if there's something it wants to log
38002 before it has read the configuration file (for example, an error in the
38003 configuration file) it will not use the path you want, and may not be able to
38004 log at all.
38005
38006 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
38007 list, currently limited to at most two items. This is one option where the
38008 facility for changing a list separator may not be used. The list must always be
38009 colon-separated. If an item in the list is &"syslog"& then syslog is used;
38010 otherwise the item must either be an absolute path, containing &`%s`& at the
38011 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
38012 implying the use of a default path.
38013
38014 When Exim encounters an empty item in the list, it searches the list defined by
38015 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
38016 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
38017 mean &"use the path specified at build time"&. It no such item exists, log
38018 files are written in the &_log_& subdirectory of the spool directory. This is
38019 equivalent to the setting:
38020 .code
38021 log_file_path = $spool_directory/log/%slog
38022 .endd
38023 If you do not specify anything at build time or runtime,
38024 or if you unset the option at runtime (i.e. &`log_file_path = `&),
38025 that is where the logs are written.
38026
38027 A log file path may also contain &`%D`& or &`%M`& if datestamped log filenames
38028 are in use &-- see section &<<SECTdatlogfil>>& below.
38029
38030 Here are some examples of possible settings:
38031 .display
38032 &`LOG_FILE_PATH=syslog                    `& syslog only
38033 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
38034 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
38035 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
38036 .endd
38037 If there are more than two paths in the list, the first is used and a panic
38038 error is logged.
38039
38040
38041
38042 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
38043 .cindex "log" "cycling local files"
38044 .cindex "cycling logs"
38045 .cindex "&'exicyclog'&"
38046 .cindex "log" "local files; writing to"
38047 Some operating systems provide centralized and standardized methods for cycling
38048 log files. For those that do not, a utility script called &'exicyclog'& is
38049 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
38050 main and reject logs each time it is called. The maximum number of old logs to
38051 keep can be set. It is suggested this script is run as a daily &'cron'& job.
38052
38053 An Exim delivery process opens the main log when it first needs to write to it,
38054 and it keeps the file open in case subsequent entries are required &-- for
38055 example, if a number of different deliveries are being done for the same
38056 message. However, remote SMTP deliveries can take a long time, and this means
38057 that the file may be kept open long after it is renamed if &'exicyclog'& or
38058 something similar is being used to rename log files on a regular basis. To
38059 ensure that a switch of log files is noticed as soon as possible, Exim calls
38060 &[stat()]& on the main log's name before reusing an open file, and if the file
38061 does not exist, or its inode has changed, the old file is closed and Exim
38062 tries to open the main log from scratch. Thus, an old log file may remain open
38063 for quite some time, but no Exim processes should write to it once it has been
38064 renamed.
38065
38066
38067
38068 .section "Datestamped log files" "SECTdatlogfil"
38069 .cindex "log" "datestamped files"
38070 Instead of cycling the main and reject log files by renaming them
38071 periodically, some sites like to use files whose names contain a datestamp,
38072 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
38073 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
38074 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
38075 point where the datestamp is required. For example:
38076 .code
38077 log_file_path = /var/spool/exim/log/%slog-%D
38078 log_file_path = /var/log/exim-%s-%D.log
38079 log_file_path = /var/spool/exim/log/%D-%slog
38080 log_file_path = /var/log/exim/%s.%M
38081 .endd
38082 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
38083 examples of names generated by the above examples:
38084 .code
38085 /var/spool/exim/log/mainlog-20021225
38086 /var/log/exim-reject-20021225.log
38087 /var/spool/exim/log/20021225-mainlog
38088 /var/log/exim/main.200212
38089 .endd
38090 When this form of log file is specified, Exim automatically switches to new
38091 files at midnight. It does not make any attempt to compress old logs; you
38092 will need to write your own script if you require this. You should not
38093 run &'exicyclog'& with this form of logging.
38094
38095 The location of the panic log is also determined by &%log_file_path%&, but it
38096 is not datestamped, because rotation of the panic log does not make sense.
38097 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
38098 the string. In addition, if it immediately follows a slash, a following
38099 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
38100 character is removed. Thus, the four examples above would give these panic
38101 log names:
38102 .code
38103 /var/spool/exim/log/paniclog
38104 /var/log/exim-panic.log
38105 /var/spool/exim/log/paniclog
38106 /var/log/exim/panic
38107 .endd
38108
38109
38110 .section "Logging to syslog" "SECID249"
38111 .cindex "log" "syslog; writing to"
38112 The use of syslog does not change what Exim logs or the format of its messages,
38113 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
38114 Exim's log lines are omitted when these lines are sent to syslog. Apart from
38115 that, the same strings are written to syslog as to log files. The syslog
38116 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
38117 by default, but you can change these by setting the &%syslog_facility%& and
38118 &%syslog_processname%& options, respectively. If Exim was compiled with
38119 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
38120 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
38121 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
38122 the time and host name to each line.
38123 The three log streams are mapped onto syslog priorities as follows:
38124
38125 .ilist
38126 &'mainlog'& is mapped to LOG_INFO
38127 .next
38128 &'rejectlog'& is mapped to LOG_NOTICE
38129 .next
38130 &'paniclog'& is mapped to LOG_ALERT
38131 .endlist
38132
38133 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
38134 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
38135 these are routed by syslog to the same place. You can suppress this duplication
38136 by setting &%syslog_duplication%& false.
38137
38138 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
38139 entries contain multiple lines when headers are included. To cope with both
38140 these cases, entries written to syslog are split into separate &[syslog()]&
38141 calls at each internal newline, and also after a maximum of
38142 870 data characters. (This allows for a total syslog line length of 1024, when
38143 additions such as timestamps are added.) If you are running a syslog
38144 replacement that can handle lines longer than the 1024 characters allowed by
38145 RFC 3164, you should set
38146 .code
38147 SYSLOG_LONG_LINES=yes
38148 .endd
38149 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
38150 lines, but it still splits at internal newlines in &'reject'& log entries.
38151
38152 To make it easy to re-assemble split lines later, each component of a split
38153 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
38154 where <&'n'&> is the component number and <&'m'&> is the total number of
38155 components in the entry. The / delimiter is used when the line was split
38156 because it was too long; if it was split because of an internal newline, the \
38157 delimiter is used. For example, supposing the length limit to be 50 instead of
38158 870, the following would be the result of a typical rejection message to
38159 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
38160 name, and pid as added by syslog:
38161 .code
38162 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
38163 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
38164 [3/5]  when scanning for sender: missing or malformed lo
38165 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
38166 [5/5] mple>)
38167 .endd
38168 The same error might cause the following lines to be written to &"rejectlog"&
38169 (LOG_NOTICE):
38170 .code
38171 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
38172 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
38173 [3/18] er when scanning for sender: missing or malformed
38174 [4/18]  local part in "<>" (envelope sender is <ph10@cam
38175 [5\18] .example>)
38176 [6\18] Recipients: ph10@some.domain.cam.example
38177 [7\18] P Received: from [127.0.0.1] (ident=ph10)
38178 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
38179 [9\18]        id 16RdAL-0006pc-00
38180 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
38181 [11\18] 09:43 +0100
38182 [12\18] F From: <>
38183 [13\18]   Subject: this is a test header
38184 [18\18]   X-something: this is another header
38185 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
38186 [16\18] le>
38187 [17\18] B Bcc:
38188 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
38189 .endd
38190 Log lines that are neither too long nor contain newlines are written to syslog
38191 without modification.
38192
38193 If only syslog is being used, the Exim monitor is unable to provide a log tail
38194 display, unless syslog is routing &'mainlog'& to a file on the local host and
38195 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
38196 where it is.
38197
38198
38199
38200 .section "Log line flags" "SECID250"
38201 One line is written to the main log for each message received, and for each
38202 successful, unsuccessful, and delayed delivery. These lines can readily be
38203 picked out by the distinctive two-character flags that immediately follow the
38204 timestamp. The flags are:
38205 .display
38206 &`<=`&     message arrival
38207 &`(=`&     message fakereject
38208 &`=>`&     normal message delivery
38209 &`->`&     additional address in same delivery
38210 &`>>`&     cutthrough message delivery
38211 &`*>`&     delivery suppressed by &%-N%&
38212 &`**`&     delivery failed; address bounced
38213 &`==`&     delivery deferred; temporary problem
38214 .endd
38215
38216
38217 .section "Logging message reception" "SECID251"
38218 .cindex "log" "reception line"
38219 The format of the single-line entry in the main log that is written for every
38220 message received is shown in the basic example below, which is split over
38221 several lines in order to fit it on the page:
38222 .code
38223 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
38224   H=mailer.fict.example [192.168.123.123] U=exim
38225   P=smtp S=5678 id=<incoming message id>
38226 .endd
38227 The address immediately following &"<="& is the envelope sender address. A
38228 bounce message is shown with the sender address &"<>"&, and if it is locally
38229 generated, this is followed by an item of the form
38230 .code
38231 R=<message id>
38232 .endd
38233 which is a reference to the message that caused the bounce to be sent.
38234
38235 .cindex "HELO"
38236 .cindex "EHLO"
38237 For messages from other hosts, the H and U fields identify the remote host and
38238 record the RFC 1413 identity of the user that sent the message, if one was
38239 received. The number given in square brackets is the IP address of the sending
38240 host. If there is a single, unparenthesized  host name in the H field, as
38241 above, it has been verified to correspond to the IP address (see the
38242 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
38243 by the remote host in the SMTP HELO or EHLO command, and has not been
38244 verified. If verification yields a different name to that given for HELO or
38245 EHLO, the verified name appears first, followed by the HELO or EHLO
38246 name in parentheses.
38247
38248 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
38249 without brackets, in the HELO or EHLO command, leading to entries in
38250 the log containing text like these examples:
38251 .code
38252 H=(10.21.32.43) [192.168.8.34]
38253 H=([10.21.32.43]) [192.168.8.34]
38254 .endd
38255 This can be confusing. Only the final address in square brackets can be relied
38256 on.
38257
38258 For locally generated messages (that is, messages not received over TCP/IP),
38259 the H field is omitted, and the U field contains the login name of the caller
38260 of Exim.
38261
38262 .cindex "authentication" "logging"
38263 .cindex "AUTH" "logging"
38264 For all messages, the P field specifies the protocol used to receive the
38265 message. This is the value that is stored in &$received_protocol$&. In the case
38266 of incoming SMTP messages, the value indicates whether or not any SMTP
38267 extensions (ESMTP), encryption, or authentication were used. If the SMTP
38268 session was encrypted, there is an additional X field that records the cipher
38269 suite that was used.
38270
38271 .cindex log protocol
38272 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
38273 hosts that have authenticated themselves using the SMTP AUTH command. The first
38274 value is used when the SMTP connection was encrypted (&"secure"&). In this case
38275 there is an additional item A= followed by the name of the authenticator that
38276 was used. If an authenticated identification was set up by the authenticator's
38277 &%server_set_id%& option, this is logged too, separated by a colon from the
38278 authenticator name.
38279
38280 .cindex "size" "of message"
38281 The id field records the existing message id, if present. The size of the
38282 received message is given by the S field. When the message is delivered,
38283 headers may be removed or added, so that the size of delivered copies of the
38284 message may not correspond with this value (and indeed may be different to each
38285 other).
38286
38287 The &%log_selector%& option can be used to request the logging of additional
38288 data when a message is received. See section &<<SECTlogselector>>& below.
38289
38290
38291
38292 .section "Logging deliveries" "SECID252"
38293 .cindex "log" "delivery line"
38294 The format of the single-line entry in the main log that is written for every
38295 delivery is shown in one of the examples below, for local and remote
38296 deliveries, respectively. Each example has been split into multiple lines in order
38297 to fit it on the page:
38298 .code
38299 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
38300   <marv@hitch.fict.example> R=localuser T=local_delivery
38301 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
38302   monk@holistic.fict.example R=dnslookup T=remote_smtp
38303   H=holistic.fict.example [192.168.234.234]
38304 .endd
38305 For ordinary local deliveries, the original address is given in angle brackets
38306 after the final delivery address, which might be a pipe or a file. If
38307 intermediate address(es) exist between the original and the final address, the
38308 last of these is given in parentheses after the final address. The R and T
38309 fields record the router and transport that were used to process the address.
38310
38311 If SMTP AUTH was used for the delivery there is an additional item A=
38312 followed by the name of the authenticator that was used.
38313 If an authenticated identification was set up by the authenticator's &%client_set_id%&
38314 option, this is logged too, as a second colon-separated list item.
38315 Optionally (see the &%smtp_mailauth%& &%log_selector%&) there may be a third list item.
38316
38317 If a shadow transport was run after a successful local delivery, the log line
38318 for the successful delivery has an item added on the end, of the form
38319 .display
38320 &`ST=<`&&'shadow transport name'&&`>`&
38321 .endd
38322 If the shadow transport did not succeed, the error message is put in
38323 parentheses afterwards.
38324
38325 .cindex "asterisk" "after IP address"
38326 When more than one address is included in a single delivery (for example, two
38327 SMTP RCPT commands in one transaction) the second and subsequent addresses are
38328 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
38329 down a single SMTP connection, an asterisk follows the
38330 .new
38331 remote IP address (and port if enabled)
38332 .wen
38333 in the log lines for the second and subsequent messages.
38334 When two or more messages are delivered down a single TLS connection, the
38335 DNS and some TLS-related information logged for the first message delivered
38336 will not be present in the log lines for the second and subsequent messages.
38337 TLS cipher information is still available.
38338
38339 .cindex "delivery" "cutthrough; logging"
38340 .cindex "cutthrough" "logging"
38341 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
38342 line precedes the reception line, since cutthrough waits for a possible
38343 rejection from the destination in case it can reject the sourced item.
38344
38345 The generation of a reply message by a filter file gets logged as a
38346 &"delivery"& to the addressee, preceded by &">"&.
38347
38348 The &%log_selector%& option can be used to request the logging of additional
38349 data when a message is delivered. See section &<<SECTlogselector>>& below.
38350
38351
38352 .section "Discarded deliveries" "SECID253"
38353 .cindex "discarded messages"
38354 .cindex "message" "discarded"
38355 .cindex "delivery" "discarded; logging"
38356 When a message is discarded as a result of the command &"seen finish"& being
38357 obeyed in a filter file which generates no deliveries, a log entry of the form
38358 .code
38359 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
38360   <low.club@bridge.example> R=userforward
38361 .endd
38362 is written, to record why no deliveries are logged. When a message is discarded
38363 because it is aliased to &":blackhole:"& the log line is like this:
38364 .code
38365 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
38366   <hole@nowhere.example> R=blackhole_router
38367 .endd
38368
38369
38370 .section "Deferred deliveries" "SECID254"
38371 When a delivery is deferred, a line of the following form is logged:
38372 .code
38373 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
38374   R=dnslookup T=smtp defer (146): Connection refused
38375 .endd
38376 In the case of remote deliveries, the error is the one that was given for the
38377 last IP address that was tried. Details of individual SMTP failures are also
38378 written to the log, so the above line would be preceded by something like
38379 .code
38380 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
38381   mail1.endrest.example [192.168.239.239]: Connection refused
38382 .endd
38383 When a deferred address is skipped because its retry time has not been reached,
38384 a message is written to the log, but this can be suppressed by setting an
38385 appropriate value in &%log_selector%&.
38386
38387
38388
38389 .section "Delivery failures" "SECID255"
38390 .cindex "delivery" "failure; logging"
38391 If a delivery fails because an address cannot be routed, a line of the
38392 following form is logged:
38393 .code
38394 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
38395   <jim@trek99.example>: unknown mail domain
38396 .endd
38397 If a delivery fails at transport time, the router and transport are shown, and
38398 the response from the remote host is included, as in this example:
38399 .code
38400 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
38401   R=dnslookup T=remote_smtp: SMTP error from remote mailer
38402   after pipelined RCPT TO:<ace400@pb.example>: host
38403   pbmail3.py.example [192.168.63.111]: 553 5.3.0
38404   <ace400@pb.example>...Addressee unknown
38405 .endd
38406 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
38407 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
38408 disabling PIPELINING. The log lines for all forms of delivery failure are
38409 flagged with &`**`&.
38410
38411
38412
38413 .section "Fake deliveries" "SECID256"
38414 .cindex "delivery" "fake; logging"
38415 If a delivery does not actually take place because the &%-N%& option has been
38416 used to suppress it, a normal delivery line is written to the log, except that
38417 &"=>"& is replaced by &"*>"&.
38418
38419
38420
38421 .section "Completion" "SECID257"
38422 A line of the form
38423 .code
38424 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
38425 .endd
38426 is written to the main log when a message is about to be removed from the spool
38427 at the end of its processing.
38428
38429
38430
38431
38432 .section "Summary of Fields in Log Lines" "SECID258"
38433 .cindex "log" "summary of fields"
38434 A summary of the field identifiers that are used in log lines is shown in
38435 the following table:
38436 .display
38437 &`A   `&        authenticator name (and optional id and sender)
38438 &`C   `&        SMTP confirmation on delivery
38439 &`    `&        command list for &"no mail in SMTP session"&
38440 &`CV  `&        certificate verification status
38441 &`D   `&        duration of &"no mail in SMTP session"&
38442 &`DKIM`&        domain verified in incoming message
38443 &`DN  `&        distinguished name from peer certificate
38444 &`DS  `&        DNSSEC secured lookups
38445 &`DT  `&        on &`=>`&, &'=='& and &'**'& lines: time taken for, or to attempt, a delivery
38446 &`F   `&        sender address (on delivery lines)
38447 &`H   `&        host name and IP address
38448 &`I   `&        local interface used
38449 &`id  `&        message id (from header) for incoming message
38450 &`K   `&        CHUNKING extension used
38451 &`L   `&        on &`<=`& and &`=>`& lines: PIPELINING extension used
38452 &`M8S `&        8BITMIME status for incoming message
38453 &`P   `&        on &`<=`& lines: protocol used
38454 &`    `&        on &`=>`& and &`**`& lines: return path
38455 &`PRDR`&        PRDR extension used
38456 &`PRX `&        on &`<=`& and &`=>`& lines: proxy address
38457 &`Q   `&        alternate queue name
38458 &`QT  `&        on &`=>`& lines: time spent on queue so far
38459 &`    `&        on &"Completed"& lines: time spent on queue
38460 &`R   `&        on &`<=`& lines: reference for local bounce
38461 &`    `&        on &`=>`&  &`>>`& &`**`& and &`==`& lines: router name
38462 &`RT  `&        on &`<=`& lines: time taken for reception
38463 &`S   `&        size of message in bytes
38464 &`SNI `&        server name indication from TLS client hello
38465 &`ST  `&        shadow transport name
38466 &`T   `&        on &`<=`& lines: message subject (topic)
38467 &`TFO `&        connection took advantage of TCP Fast Open
38468 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
38469 &`U   `&        local user or RFC 1413 identity
38470 &`X   `&        TLS cipher suite
38471 .endd
38472
38473
38474 .section "Other log entries" "SECID259"
38475 Various other types of log entry are written from time to time. Most should be
38476 self-explanatory. Among the more common are:
38477
38478 .ilist
38479 .cindex "retry" "time not reached"
38480 &'retry time not reached'&&~&~An address previously suffered a temporary error
38481 during routing or local delivery, and the time to retry has not yet arrived.
38482 This message is not written to an individual message log file unless it happens
38483 during the first delivery attempt.
38484 .next
38485 &'retry time not reached for any host'&&~&~An address previously suffered
38486 temporary errors during remote delivery, and the retry time has not yet arrived
38487 for any of the hosts to which it is routed.
38488 .next
38489 .cindex "spool directory" "file locked"
38490 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
38491 some other Exim process is already working on the message. This can be quite
38492 common if queue running processes are started at frequent intervals. The
38493 &'exiwhat'& utility script can be used to find out what Exim processes are
38494 doing.
38495 .next
38496 .cindex "error" "ignored"
38497 &'error ignored'&&~&~There are several circumstances that give rise to this
38498 message:
38499 .olist
38500 Exim failed to deliver a bounce message whose age was greater than
38501 &%ignore_bounce_errors_after%&. The bounce was discarded.
38502 .next
38503 A filter file set up a delivery using the &"noerror"& option, and the delivery
38504 failed. The delivery was discarded.
38505 .next
38506 A delivery set up by a router configured with
38507 . ==== As this is a nested list, any displays it contains must be indented
38508 . ==== as otherwise they are too far to the left.
38509 .code
38510     errors_to = <>
38511 .endd
38512 failed. The delivery was discarded.
38513 .endlist olist
38514 .next
38515 .cindex DKIM "log line"
38516 &'DKIM: d='&&~&~Verbose results of a DKIM verification attempt, if enabled for
38517 logging and the message has a DKIM signature header.
38518 .endlist ilist
38519
38520
38521
38522
38523
38524 .section "Reducing or increasing what is logged" "SECTlogselector"
38525 .cindex "log" "selectors"
38526 By setting the &%log_selector%& global option, you can disable some of Exim's
38527 default logging, or you can request additional logging. The value of
38528 &%log_selector%& is made up of names preceded by plus or minus characters. For
38529 example:
38530 .code
38531 log_selector = +arguments -retry_defer
38532 .endd
38533 The list of optional log items is in the following table, with the default
38534 selection marked by asterisks:
38535 .display
38536 &` 8bitmime                   `&  received 8BITMIME status
38537 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
38538 &` address_rewrite            `&  address rewriting
38539 &` all_parents                `&  all parents in => lines
38540 &` arguments                  `&  command line arguments
38541 &`*connection_reject          `&  connection rejections
38542 &`*delay_delivery             `&  immediate delivery delayed
38543 &` deliver_time               `&  time taken to attempt delivery
38544 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
38545 &`*dkim                       `&  DKIM verified domain on <= lines
38546 &` dkim_verbose               `&  separate full DKIM verification result line, per signature
38547 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
38548 &` dnssec                     `&  DNSSEC secured lookups
38549 &`*etrn                       `&  ETRN commands
38550 &`*host_lookup_failed         `&  as it says
38551 &` ident_timeout              `&  timeout for ident connection
38552 &` incoming_interface         `&  local interface on <= and => lines
38553 &` incoming_port              `&  remote port on <= lines
38554 &`*lost_incoming_connection   `&  as it says (includes timeouts)
38555 &` millisec                   `&  millisecond timestamps and RT,QT,DT,D times
38556 &`*msg_id                     `&  on <= lines, Message-ID: header value
38557 &` msg_id_created             `&  on <= lines, Message-ID: header value when one had to be added
38558 &` outgoing_interface         `&  local interface on => lines
38559 &` outgoing_port              `&  add remote port to => lines
38560 &`*queue_run                  `&  start and end queue runs
38561 &` queue_time                 `&  time on queue for one recipient
38562 &` queue_time_overall         `&  time on queue for whole message
38563 &` pid                        `&  Exim process id
38564 &` pipelining                 `&  PIPELINING use, on <= and => lines
38565 &` proxy                      `&  proxy address on <= and => lines
38566 &` receive_time               `&  time taken to receive message
38567 &` received_recipients        `&  recipients on <= lines
38568 &` received_sender            `&  sender on <= lines
38569 &`*rejected_header            `&  header contents on reject log
38570 &`*retry_defer                `&  &"retry time not reached"&
38571 &` return_path_on_delivery    `&  put return path on => and ** lines
38572 &` sender_on_delivery         `&  add sender to => lines
38573 &`*sender_verify_fail         `&  sender verification failures
38574 &`*size_reject                `&  rejection because too big
38575 &`*skip_delivery              `&  delivery skipped in a queue run
38576 &`*smtp_confirmation          `&  SMTP confirmation on => lines
38577 &` smtp_connection            `&  incoming SMTP connections
38578 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
38579 &` smtp_mailauth              `&  AUTH argument to MAIL commands
38580 &` smtp_no_mail               `&  session with no MAIL commands
38581 &` smtp_protocol_error        `&  SMTP protocol errors
38582 &` smtp_syntax_error          `&  SMTP syntax errors
38583 &` subject                    `&  contents of &'Subject:'& on <= lines
38584 &`*tls_certificate_verified   `&  certificate verification status
38585 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
38586 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
38587 &` tls_resumption             `&  append * to cipher field
38588 &` tls_sni                    `&  TLS SNI on <= lines
38589 &` unknown_in_list            `&  DNS lookup failed in list match
38590
38591 &` all                        `&  all of the above
38592 .endd
38593 See also the &%slow_lookup_log%& main configuration option,
38594 section &<<SECID99>>&
38595
38596 More details on each of these items follows:
38597
38598 .ilist
38599 .cindex "8BITMIME"
38600 .cindex "log" "8BITMIME"
38601 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
38602 which may help in tracking down interoperability issues with ancient MTAs
38603 that are not 8bit clean.  This is added to the &"<="& line, tagged with
38604 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
38605 &`7BIT`& and &`8BITMIME`& respectively.
38606 .next
38607 .cindex "&%warn%& ACL verb" "log when skipping"
38608 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
38609 its conditions cannot be evaluated, a log line to this effect is written if
38610 this log selector is set.
38611 .next
38612 .cindex "log" "rewriting"
38613 .cindex "rewriting" "logging"
38614 &%address_rewrite%&: This applies both to global rewrites and per-transport
38615 rewrites, but not to rewrites in filters run as an unprivileged user (because
38616 such users cannot access the log).
38617 .next
38618 .cindex "log" "full parentage"
38619 &%all_parents%&: Normally only the original and final addresses are logged on
38620 delivery lines; with this selector, intermediate parents are given in
38621 parentheses between them.
38622 .next
38623 .cindex "log" "Exim arguments"
38624 .cindex "Exim arguments, logging"
38625 &%arguments%&: This causes Exim to write the arguments with which it was called
38626 to the main log, preceded by the current working directory. This is a debugging
38627 feature, added to make it easier to find out how certain MUAs call
38628 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
38629 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
38630 that are empty or that contain white space are quoted. Non-printing characters
38631 are shown as escape sequences. This facility cannot log unrecognized arguments,
38632 because the arguments are checked before the configuration file is read. The
38633 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
38634 between the caller and Exim.
38635 .next
38636 .cindex "log" "connection rejections"
38637 &%connection_reject%&: A log entry is written whenever an incoming SMTP
38638 connection is rejected, for whatever reason.
38639 .next
38640 .cindex "log" "delayed delivery"
38641 .cindex "delayed delivery, logging"
38642 &%delay_delivery%&: A log entry is written whenever a delivery process is not
38643 started for an incoming message because the load is too high or too many
38644 messages were received on one connection. Logging does not occur if no delivery
38645 process is started because &%queue_only%& is set or &%-odq%& was used.
38646 .next
38647 .cindex "log" "delivery duration"
38648 &%deliver_time%&: For each delivery, the amount of real time it has taken to
38649 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
38650 If millisecond logging is enabled, short times will be shown with greater
38651 precision, eg. &`DT=0.304s`&.
38652 .next
38653 .cindex "log" "message size on delivery"
38654 .cindex "size" "of message"
38655 &%delivery_size%&: For each delivery, the size of message delivered is added to
38656 the &"=>"& line, tagged with S=.
38657 .next
38658 .cindex log "DKIM verification"
38659 .cindex DKIM "verification logging"
38660 &%dkim%&: For message acceptance log lines, when an DKIM signature in the header
38661 verifies successfully a tag of DKIM is added, with one of the verified domains.
38662 .next
38663 .cindex log "DKIM verification"
38664 .cindex DKIM "verification logging"
38665 &%dkim_verbose%&: A log entry is written for each attempted DKIM verification.
38666 .next
38667 .cindex "log" "dnslist defer"
38668 .cindex "DNS list" "logging defer"
38669 .cindex "black list (DNS)"
38670 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
38671 DNS black list suffers a temporary error.
38672 .next
38673 .cindex log dnssec
38674 .cindex dnssec logging
38675 &%dnssec%&: For message acceptance and (attempted) delivery log lines, when
38676 dns lookups gave secure results a tag of DS is added.
38677 For acceptance this covers the reverse and forward lookups for host name verification.
38678 It does not cover helo-name verification.
38679 For delivery this covers the SRV, MX, A and/or AAAA lookups.
38680 .next
38681 .cindex "log" "ETRN commands"
38682 .cindex "ETRN" "logging"
38683 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
38684 is run to determine whether or not it is actually accepted. An invalid ETRN
38685 command, or one received within a message transaction is not logged by this
38686 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
38687 .next
38688 .cindex "log" "host lookup failure"
38689 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
38690 any addresses, or when a lookup of an IP address fails to find a host name, a
38691 log line is written. This logging does not apply to direct DNS lookups when
38692 routing email addresses, but it does apply to &"byname"& lookups.
38693 .next
38694 .cindex "log" "ident timeout"
38695 .cindex "RFC 1413" "logging timeout"
38696 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
38697 client's ident port times out.
38698 .next
38699 .cindex "log" "incoming interface"
38700 .cindex "log" "outgoing interface"
38701 .cindex "log" "local interface"
38702 .cindex "log" "local address and port"
38703 .cindex "TCP/IP" "logging local address and port"
38704 .cindex "interface" "logging"
38705 &%incoming_interface%&: The interface on which a message was received is added
38706 to the &"<="& line as an IP address in square brackets, tagged by I= and
38707 followed by a colon and the port number. The local interface and port are also
38708 added to other SMTP log lines, for example, &"SMTP connection from"&, to
38709 rejection lines, and (despite the name) to outgoing
38710 .new
38711 &"=>"&, &"->"&, &"=="& and &"**"& lines.
38712 .wen
38713 The latter can be disabled by turning off the &%outgoing_interface%& option.
38714 .next
38715 .cindex log "incoming proxy address"
38716 .cindex proxy "logging proxy address"
38717 .cindex "TCP/IP" "logging proxy address"
38718 &%proxy%&: The internal (closest to the system running Exim) IP address
38719 of the proxy, tagged by PRX=, on the &"<="& line for a message accepted
38720 on a proxied connection
38721 or the &"=>"& line for a message delivered on a proxied connection.
38722 See &<<SECTproxyInbound>>& for more information.
38723 .next
38724 .cindex "log" "incoming remote port"
38725 .cindex "port" "logging remote"
38726 .cindex "TCP/IP" "logging incoming remote port"
38727 .vindex "&$sender_fullhost$&"
38728 .vindex "&$sender_rcvhost$&"
38729 &%incoming_port%&: The remote port number from which a message was received is
38730 added to log entries and &'Received:'& header lines, following the IP address
38731 in square brackets, and separated from it by a colon. This is implemented by
38732 changing the value that is put in the &$sender_fullhost$& and
38733 &$sender_rcvhost$& variables. Recording the remote port number has become more
38734 important with the widening use of NAT (see RFC 2505).
38735 .next
38736 .cindex "log" "dropped connection"
38737 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
38738 connection is unexpectedly dropped.
38739 .next
38740 .cindex "log" "millisecond timestamps"
38741 .cindex millisecond logging
38742 .cindex timestamps "millisecond, in logs"
38743 &%millisec%&: Timestamps have a period and three decimal places of finer granularity
38744 appended to the seconds value.
38745 .next
38746 .cindex "log" "message id"
38747 &%msg_id%&: The value of the Message-ID: header.
38748 .next
38749 &%msg_id_created%&: The value of the Message-ID: header, when one had to be created.
38750 This will be either because the message is a bounce, or was submitted locally
38751 (submission mode) without one.
38752 The field identifier will have an asterix appended: &"id*="&.
38753 .next
38754 .cindex "log" "outgoing interface"
38755 .cindex "log" "local interface"
38756 .cindex "log" "local address and port"
38757 .cindex "TCP/IP" "logging local address and port"
38758 .cindex "interface" "logging"
38759 &%outgoing_interface%&: If &%incoming_interface%& is turned on, then the
38760 interface on which a message was sent is added to delivery lines as an I= tag
38761 followed by IP address in square brackets. You can disable this by turning
38762 off the &%outgoing_interface%& option.
38763 .next
38764 .cindex "log" "outgoing remote port"
38765 .cindex "port" "logging outgoing remote"
38766 .cindex "TCP/IP" "logging outgoing remote port"
38767 &%outgoing_port%&: The remote port number is added to delivery log lines (those
38768 containing => tags) following the IP address.
38769 The local port is also added if &%incoming_interface%& and
38770 &%outgoing_interface%& are both enabled.
38771 This option is not included in the default setting, because for most ordinary
38772 configurations, the remote port number is always 25 (the SMTP port), and the
38773 local port is a random ephemeral port.
38774 .next
38775 .cindex "log" "process ids in"
38776 .cindex "pid (process id)" "in log lines"
38777 &%pid%&: The current process id is added to every log line, in square brackets,
38778 immediately after the time and date.
38779 .next
38780 .cindex log pipelining
38781 .cindex pipelining "logging outgoing"
38782 &%pipelining%&: A field is added to delivery and accept
38783 log lines when the ESMTP PIPELINING extension was used.
38784 The field is a single "L".
38785
38786 On accept lines, where PIPELINING was offered but not used by the client,
38787 the field has a minus appended.
38788
38789 .cindex "pipelining" "early connection"
38790 If Exim is built with the SUPPORT_PIPE_CONNECT build option
38791 accept "L" fields have a period appended if the feature was
38792 offered but not used, or an asterisk appended if used.
38793 Delivery "L" fields have an asterisk appended if used.
38794
38795 .next
38796 .cindex "log" "queue run"
38797 .cindex "queue runner" "logging"
38798 &%queue_run%&: The start and end of every queue run are logged.
38799 .next
38800 .cindex "log" "queue time"
38801 &%queue_time%&: The amount of time the message has been in the queue on the
38802 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
38803 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
38804 includes reception time as well as the delivery time for the current address.
38805 This means that it may be longer than the difference between the arrival and
38806 delivery log line times, because the arrival log line is not written until the
38807 message has been successfully received.
38808 If millisecond logging is enabled, short times will be shown with greater
38809 precision, eg. &`QT=1.578s`&.
38810 .next
38811 &%queue_time_overall%&: The amount of time the message has been in the queue on
38812 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
38813 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
38814 message, so it includes reception time as well as the total delivery time.
38815 .next
38816 .cindex "log" "receive duration"
38817 &%receive_time%&: For each message, the amount of real time it has taken to
38818 perform the reception is logged as RT=<&'time'&>, for example, &`RT=1s`&.
38819 If millisecond logging is enabled, short times will be shown with greater
38820 precision, eg. &`RT=0.204s`&.
38821 .next
38822 .cindex "log" "recipients"
38823 &%received_recipients%&: The recipients of a message are listed in the main log
38824 as soon as the message is received. The list appears at the end of the log line
38825 that is written when a message is received, preceded by the word &"for"&. The
38826 addresses are listed after they have been qualified, but before any rewriting
38827 has taken place.
38828 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
38829 in the list.
38830 .next
38831 .cindex "log" "sender reception"
38832 &%received_sender%&: The unrewritten original sender of a message is added to
38833 the end of the log line that records the message's arrival, after the word
38834 &"from"& (before the recipients if &%received_recipients%& is also set).
38835 .next
38836 .cindex "log" "header lines for rejection"
38837 &%rejected_header%&: If a message's header has been received at the time a
38838 rejection is written to the reject log, the complete header is added to the
38839 log. Header logging can be turned off individually for messages that are
38840 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
38841 .next
38842 .cindex "log" "retry defer"
38843 &%retry_defer%&: A log line is written if a delivery is deferred because a
38844 retry time has not yet been reached. However, this &"retry time not reached"&
38845 message is always omitted from individual message logs after the first delivery
38846 attempt.
38847 .next
38848 .cindex "log" "return path"
38849 &%return_path_on_delivery%&: The return path that is being transmitted with
38850 the message is included in delivery and bounce lines, using the tag P=.
38851 This is omitted if no delivery actually happens, for example, if routing fails,
38852 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
38853 .next
38854 .cindex "log" "sender on delivery"
38855 &%sender_on_delivery%&: The message's sender address is added to every delivery
38856 and bounce line, tagged by F= (for &"from"&).
38857 This is the original sender that was received with the message; it is not
38858 necessarily the same as the outgoing return path.
38859 .next
38860 .cindex "log" "sender verify failure"
38861 &%sender_verify_fail%&: If this selector is unset, the separate log line that
38862 gives details of a sender verification failure is not written. Log lines for
38863 the rejection of SMTP commands contain just &"sender verify failed"&, so some
38864 detail is lost.
38865 .next
38866 .cindex "log" "size rejection"
38867 &%size_reject%&: A log line is written whenever a message is rejected because
38868 it is too big.
38869 .next
38870 .cindex "log" "frozen messages; skipped"
38871 .cindex "frozen messages" "logging skipping"
38872 &%skip_delivery%&: A log line is written whenever a message is skipped during a
38873 queue run because it is frozen or because another process is already delivering
38874 it.
38875 .cindex "&""spool file is locked""&"
38876 The message that is written is &"spool file is locked"&.
38877 .next
38878 .cindex "log" "smtp confirmation"
38879 .cindex "SMTP" "logging confirmation"
38880 .cindex "LMTP" "logging confirmation"
38881 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
38882 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
38883 A number of MTAs (including Exim) return an identifying string in this
38884 response.
38885 .next
38886 .cindex "log" "SMTP connections"
38887 .cindex "SMTP" "logging connections"
38888 &%smtp_connection%&: A log line is written whenever an incoming SMTP connection is
38889 established or closed, unless the connection is from a host that matches
38890 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
38891 only when the closure is unexpected.) This applies to connections from local
38892 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
38893 dropped in the middle of a message, a log line is always written, whether or
38894 not this selector is set, but otherwise nothing is written at the start and end
38895 of connections unless this selector is enabled.
38896
38897 For TCP/IP connections to an Exim daemon, the current number of connections is
38898 included in the log message for each new connection, but note that the count is
38899 reset if the daemon is restarted.
38900 Also, because connections are closed (and the closure is logged) in
38901 subprocesses, the count may not include connections that have been closed but
38902 whose termination the daemon has not yet noticed. Thus, while it is possible to
38903 match up the opening and closing of connections in the log, the value of the
38904 logged counts may not be entirely accurate.
38905 .next
38906 .cindex "log" "SMTP transaction; incomplete"
38907 .cindex "SMTP" "logging incomplete transactions"
38908 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
38909 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
38910 and the message sender plus any accepted recipients are included in the log
38911 line. This can provide evidence of dictionary attacks.
38912 .next
38913 .cindex "log" "non-MAIL SMTP sessions"
38914 .cindex "MAIL" "logging session without"
38915 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
38916 connection terminates without having issued a MAIL command. This includes both
38917 the case when the connection is dropped, and the case when QUIT is used. It
38918 does not include cases where the connection is rejected right at the start (by
38919 an ACL, or because there are too many connections, or whatever). These cases
38920 already have their own log lines.
38921
38922 The log line that is written contains the identity of the client in the usual
38923 way, followed by D= and a time, which records the duration of the connection.
38924 If the connection was authenticated, this fact is logged exactly as it is for
38925 an incoming message, with an A= item. If the connection was encrypted, CV=,
38926 DN=, and X= items may appear as they do for an incoming message, controlled by
38927 the same logging options.
38928
38929 Finally, if any SMTP commands were issued during the connection, a C= item
38930 is added to the line, listing the commands that were used. For example,
38931 .code
38932 C=EHLO,QUIT
38933 .endd
38934 shows that the client issued QUIT straight after EHLO. If there were fewer
38935 than 20 commands, they are all listed. If there were more than 20 commands,
38936 the last 20 are listed, preceded by &"..."&. However, with the default
38937 setting of 10 for &%smtp_accept_max_nonmail%&, the connection will in any case
38938 have been aborted before 20 non-mail commands are processed.
38939 .next
38940 &%smtp_mailauth%&: A third subfield with the authenticated sender,
38941 colon-separated, is appended to the A= item for a message arrival or delivery
38942 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
38943 was accepted or used.
38944 .next
38945 .cindex "log" "SMTP protocol error"
38946 .cindex "SMTP" "logging protocol error"
38947 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
38948 encountered. Exim does not have perfect detection of all protocol errors
38949 because of transmission delays and the use of pipelining. If PIPELINING has
38950 been advertised to a client, an Exim server assumes that the client will use
38951 it, and therefore it does not count &"expected"& errors (for example, RCPT
38952 received after rejecting MAIL) as protocol errors.
38953 .next
38954 .cindex "SMTP" "logging syntax errors"
38955 .cindex "SMTP" "syntax errors; logging"
38956 .cindex "SMTP" "unknown command; logging"
38957 .cindex "log" "unknown SMTP command"
38958 .cindex "log" "SMTP syntax error"
38959 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
38960 encountered. An unrecognized command is treated as a syntax error. For an
38961 external connection, the host identity is given; for an internal connection
38962 using &%-bs%& the sender identification (normally the calling user) is given.
38963 .next
38964 .cindex "log" "subject"
38965 .cindex "subject, logging"
38966 &%subject%&: The subject of the message is added to the arrival log line,
38967 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
38968 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
38969 specifies whether characters with values greater than 127 should be logged
38970 unchanged, or whether they should be rendered as escape sequences.
38971 .next
38972 .cindex "log" "certificate verification"
38973 .cindex log DANE
38974 .cindex DANE logging
38975 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
38976 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
38977 verified
38978 using a CA trust anchor,
38979 &`CA=dane`& if using a DNS trust anchor,
38980 and &`CV=no`& if not.
38981 .next
38982 .cindex "log" "TLS cipher"
38983 .cindex "TLS" "logging cipher"
38984 &%tls_cipher%&: When a message is sent or received over an encrypted
38985 connection, the cipher suite used is added to the log line, preceded by X=.
38986 .next
38987 .cindex "log" "TLS peer DN"
38988 .cindex "TLS" "logging peer DN"
38989 &%tls_peerdn%&: When a message is sent or received over an encrypted
38990 connection, and a certificate is supplied by the remote host, the peer DN is
38991 added to the log line, preceded by DN=.
38992 .next
38993 .cindex "log" "TLS resumption"
38994 .cindex "TLS" "logging session resumption"
38995 .new
38996 &%tls_resumption%&: When a message is sent or received over an encrypted
38997 connection and the TLS session resumed one used on a previous TCP connection,
38998 an asterisk is appended to the X= cipher field in the log line.
38999 .wen
39000 .next
39001 .cindex "log" "TLS SNI"
39002 .cindex "TLS" "logging SNI"
39003 .cindex SNI logging
39004 &%tls_sni%&: When a message is received over an encrypted connection, and
39005 the remote host provided the Server Name Indication extension, the SNI is
39006 added to the log line, preceded by SNI=.
39007 .next
39008 .cindex "log" "DNS failure in list"
39009 &%unknown_in_list%&: This setting causes a log entry to be written when the
39010 result of a list match is failure because a DNS lookup failed.
39011 .endlist
39012
39013
39014 .section "Message log" "SECID260"
39015 .cindex "message" "log file for"
39016 .cindex "log" "message log; description of"
39017 .cindex "&_msglog_& directory"
39018 .oindex "&%preserve_message_logs%&"
39019 In addition to the general log files, Exim writes a log file for each message
39020 that it handles. The names of these per-message logs are the message ids, and
39021 they are kept in the &_msglog_& sub-directory of the spool directory. Each
39022 message log contains copies of the log lines that apply to the message. This
39023 makes it easier to inspect the status of an individual message without having
39024 to search the main log. A message log is deleted when processing of the message
39025 is complete, unless &%preserve_message_logs%& is set, but this should be used
39026 only with great care because they can fill up your disk very quickly.
39027
39028 On a heavily loaded system, it may be desirable to disable the use of
39029 per-message logs, in order to reduce disk I/O. This can be done by setting the
39030 &%message_logs%& option false.
39031 .ecindex IIDloggen
39032
39033
39034
39035
39036 . ////////////////////////////////////////////////////////////////////////////
39037 . ////////////////////////////////////////////////////////////////////////////
39038
39039 .chapter "Exim utilities" "CHAPutils"
39040 .scindex IIDutils "utilities"
39041 A number of utility scripts and programs are supplied with Exim and are
39042 described in this chapter. There is also the Exim Monitor, which is covered in
39043 the next chapter. The utilities described here are:
39044
39045 .itable none 0 0 3  7* left  15* left  40* left
39046 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
39047   "list what Exim processes are doing"
39048 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
39049 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
39050 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
39051 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
39052                                                 various criteria"
39053 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
39054 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
39055   "extract statistics from the log"
39056 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
39057   "check address acceptance from given IP"
39058 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
39059 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
39060 .irow &<<SECTdumpdb>>&        &'exim_dumpdb'&   "dump a hints database"
39061 .irow &<<SECTtidydb>>&        &'exim_tidydb'&   "clean up a hints database"
39062 .irow &<<SECTfixdb>>&         &'exim_fixdb'&    "patch a hints database"
39063 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
39064 .endtable
39065
39066 Another utility that might be of use to sites with many MTAs is Tom Kistner's
39067 &'exilog'&. It provides log visualizations across multiple Exim servers. See
39068 &url(https://duncanthrax.net/exilog/) for details.
39069
39070
39071
39072
39073 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
39074 .cindex "&'exiwhat'&"
39075 .cindex "process, querying"
39076 .cindex "SIGUSR1"
39077 On operating systems that can restart a system call after receiving a signal
39078 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
39079 a line describing what it is doing to the file &_exim-process.info_& in the
39080 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
39081 processes it can find, having first emptied the file. It then waits for one
39082 second to allow the Exim processes to react before displaying the results. In
39083 order to run &'exiwhat'& successfully you have to have sufficient privilege to
39084 send the signal to the Exim processes, so it is normally run as root.
39085
39086 &*Warning*&: This is not an efficient process. It is intended for occasional
39087 use by system administrators. It is not sensible, for example, to set up a
39088 script that sends SIGUSR1 signals to Exim processes at short intervals.
39089
39090
39091 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
39092 varies in different operating systems. Not only are different options used,
39093 but the format of the output is different. For this reason, there are some
39094 system configuration options that configure exactly how &'exiwhat'& works. If
39095 it doesn't seem to be working for you, check the following compile-time
39096 options:
39097 .display
39098 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
39099 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
39100 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
39101 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
39102 .endd
39103 An example of typical output from &'exiwhat'& is
39104 .code
39105 164 daemon: -q1h, listening on port 25
39106 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
39107 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
39108   [10.19.42.42] (editor@ref.example)
39109 10592 handling incoming call from [192.168.243.242]
39110 10628 accepting a local non-SMTP message
39111 .endd
39112 The first number in the output line is the process number. The third line has
39113 been split here, in order to fit it on the page.
39114
39115
39116
39117 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
39118 .cindex "&'exiqgrep'&"
39119 .cindex "queue" "grepping"
39120 This utility is a Perl script contributed by Matt Hubbard. It runs
39121 .code
39122 exim -bpu
39123 .endd
39124 or (in case &*-a*& switch is specified)
39125 .code
39126 exim -bp
39127 .endd
39128 The &*-C*& option is used to specify an alternate &_exim.conf_& which might
39129 contain alternate exim configuration the queue management might be using.
39130
39131 to obtain a queue listing, and then greps the output to select messages
39132 that match given criteria. The following selection options are available:
39133
39134 .vlist
39135 .vitem &*-f*&&~<&'regex'&>
39136 Match the sender address using a case-insensitive search. The field that is
39137 tested is enclosed in angle brackets, so you can test for bounce messages with
39138 .code
39139 exiqgrep -f '^<>$'
39140 .endd
39141 .vitem &*-r*&&~<&'regex'&>
39142 Match a recipient address using a case-insensitive search. The field that is
39143 tested is not enclosed in angle brackets.
39144
39145 .vitem &*-s*&&~<&'regex'&>
39146 Match against the size field.
39147
39148 .vitem &*-y*&&~<&'seconds'&>
39149 Match messages that are younger than the given time.
39150
39151 .vitem &*-o*&&~<&'seconds'&>
39152 Match messages that are older than the given time.
39153
39154 .vitem &*-z*&
39155 Match only frozen messages.
39156
39157 .vitem &*-x*&
39158 Match only non-frozen messages.
39159
39160 .vitem &*-G*&&~<&'queuename'&>
39161 Match only messages in the given queue.  Without this, the default queue is searched.
39162 .endlist
39163
39164 The following options control the format of the output:
39165
39166 .vlist
39167 .vitem &*-c*&
39168 Display only the count of matching messages.
39169
39170 .vitem &*-l*&
39171 Long format &-- display the full message information as output by Exim. This is
39172 the default.
39173
39174 .vitem &*-i*&
39175 Display message ids only.
39176
39177 .vitem &*-b*&
39178 Brief format &-- one line per message.
39179
39180 .vitem &*-R*&
39181 Display messages in reverse order.
39182
39183 .vitem &*-a*&
39184 Include delivered recipients in queue listing.
39185 .endlist
39186
39187 There is one more option, &%-h%&, which outputs a list of options.
39188
39189
39190
39191 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
39192 .cindex "&'exiqsumm'&"
39193 .cindex "queue" "summary"
39194 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
39195 -bp`& and produces a summary of the messages in the queue. Thus, you use it by
39196 running a command such as
39197 .code
39198 exim -bp | exiqsumm
39199 .endd
39200 The output consists of one line for each domain that has messages waiting for
39201 it, as in the following example:
39202 .code
39203 3   2322   74m   66m  msn.com.example
39204 .endd
39205 Each line lists the number of pending deliveries for a domain, their total
39206 volume, and the length of time that the oldest and the newest messages have
39207 been waiting. Note that the number of pending deliveries is greater than the
39208 number of messages when messages have more than one recipient.
39209
39210 A summary line is output at the end. By default the output is sorted on the
39211 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
39212 the output to be sorted by oldest message and by count of messages,
39213 respectively. There are also three options that split the messages for each
39214 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
39215 separates frozen messages, and &%-s%& separates messages according to their
39216 sender.
39217
39218 The output of &'exim -bp'& contains the original addresses in the message, so
39219 this also applies to the output from &'exiqsumm'&. No domains from addresses
39220 generated by aliasing or forwarding are included (unless the &%one_time%&
39221 option of the &(redirect)& router has been used to convert them into &"top
39222 level"& addresses).
39223
39224
39225
39226
39227 .section "Extracting specific information from the log (exigrep)" &&&
39228          "SECTextspeinf"
39229 .cindex "&'exigrep'&"
39230 .cindex "log" "extracts; grepping for"
39231 The &'exigrep'& utility is a Perl script that searches one or more main log
39232 files for entries that match a given pattern. When it finds a match, it
39233 extracts all the log entries for the relevant message, not just those that
39234 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
39235 given message, or all mail for a given user, or for a given host, for example.
39236 The input files can be in Exim log format or syslog format.
39237 If a matching log line is not associated with a specific message, it is
39238 included in &'exigrep'&'s output without any additional lines. The usage is:
39239 .display
39240 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-M] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
39241 .endd
39242 If no log filenames are given on the command line, the standard input is read.
39243
39244 The &%-t%& argument specifies a number of seconds. It adds an additional
39245 condition for message selection. Messages that are complete are shown only if
39246 they spent more than <&'n'&> seconds in the queue.
39247
39248 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
39249 makes it case-sensitive. This may give a performance improvement when searching
39250 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
39251 option; with &%-I%& they do not. In both cases it is possible to change the
39252 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
39253
39254 The &%-l%& option means &"literal"&, that is, treat all characters in the
39255 pattern as standing for themselves. Otherwise the pattern must be a Perl
39256 regular expression.
39257
39258 The &%-v%& option inverts the matching condition. That is, a line is selected
39259 if it does &'not'& match the pattern.
39260
39261 The &%-M%& options means &"related messages"&. &'exigrep'& will show messages
39262 that are generated as a result/response to a message that &'exigrep'& matched
39263 normally.
39264
39265 Example of &%-M%&:
39266 user_a sends a message to user_b, which generates a bounce back to user_b. If
39267 &'exigrep'& is used to search for &"user_a"&, only the first message will be
39268 displayed.  But if &'exigrep'& is used to search for &"user_b"&, the first and
39269 the second (bounce) message will be displayed. Using &%-M%& with &'exigrep'&
39270 when searching for &"user_a"& will show both messages since the bounce is
39271 &"related"& to or a &"result"& of the first message that was found by the
39272 search term.
39273
39274 If the location of a &'zcat'& command is known from the definition of
39275 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
39276 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
39277 If the ZCAT_COMMAND is not executable, &'exigrep'& tries to use
39278 autodetection of some well known compression extensions.
39279
39280
39281 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
39282 .cindex "&'exipick'&"
39283 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
39284 lists messages from the queue according to a variety of criteria. For details
39285 of &'exipick'&'s facilities, run &'exipick'& with
39286 the &%--help%& option.
39287
39288
39289 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
39290 .cindex "log" "cycling local files"
39291 .cindex "cycling logs"
39292 .cindex "&'exicyclog'&"
39293 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
39294 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
39295 you are using log files with datestamps in their names (see section
39296 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
39297 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
39298 There are two command line options for &'exicyclog'&:
39299 .ilist
39300 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
39301 default that is set when Exim is built. The default default is 10.
39302 .next
39303 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
39304 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
39305 overriding the script's default, which is to find the setting from Exim's
39306 configuration.
39307 .endlist
39308
39309 Each time &'exicyclog'& is run the filenames get &"shuffled down"& by one. If
39310 the main log filename is &_mainlog_& (the default) then when &'exicyclog'& is
39311 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
39312 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
39313 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
39314 logs are handled similarly.
39315
39316 If the limit is greater than 99, the script uses 3-digit numbers such as
39317 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
39318 to one that is greater, or &'vice versa'&, you will have to fix the names of
39319 any existing log files.
39320
39321 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
39322 the end are deleted. All files with numbers greater than 01 are compressed,
39323 using a compression command which is configured by the COMPRESS_COMMAND
39324 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
39325 root &%crontab%& entry of the form
39326 .code
39327 1 0 * * * su exim -c /usr/exim/bin/exicyclog
39328 .endd
39329 assuming you have used the name &"exim"& for the Exim user. You can run
39330 &'exicyclog'& as root if you wish, but there is no need.
39331
39332
39333
39334 .section "Mail statistics (eximstats)" "SECTmailstat"
39335 .cindex "statistics"
39336 .cindex "&'eximstats'&"
39337 A Perl script called &'eximstats'& is provided for extracting statistical
39338 information from log files. The output is either plain text, or HTML.
39339 . --- 2018-09-07: LogReport's Lire appears to be dead; website is a Yahoo Japan
39340 . --- 404 error and everything else points to that.
39341
39342 The &'eximstats'& script has been hacked about quite a bit over time. The
39343 latest version is the result of some extensive revision by Steve Campbell. A
39344 lot of information is given by default, but there are options for suppressing
39345 various parts of it. Following any options, the arguments to the script are a
39346 list of files, which should be main log files. For example:
39347 .code
39348 eximstats -nr /var/spool/exim/log/mainlog.01
39349 .endd
39350 By default, &'eximstats'& extracts information about the number and volume of
39351 messages received from or delivered to various hosts. The information is sorted
39352 both by message count and by volume, and the top fifty hosts in each category
39353 are listed on the standard output. Similar information, based on email
39354 addresses or domains instead of hosts can be requested by means of various
39355 options. For messages delivered and received locally, similar statistics are
39356 also produced per user.
39357
39358 The output also includes total counts and statistics about delivery errors, and
39359 histograms showing the number of messages received and deliveries made in each
39360 hour of the day. A delivery with more than one address in its envelope (for
39361 example, an SMTP transaction with more than one RCPT command) is counted
39362 as a single delivery by &'eximstats'&.
39363
39364 Though normally more deliveries than receipts are reported (as messages may
39365 have multiple recipients), it is possible for &'eximstats'& to report more
39366 messages received than delivered, even though the queue is empty at the start
39367 and end of the period in question. If an incoming message contains no valid
39368 recipients, no deliveries are recorded for it. A bounce message is handled as
39369 an entirely separate message.
39370
39371 &'eximstats'& always outputs a grand total summary giving the volume and number
39372 of messages received and deliveries made, and the number of hosts involved in
39373 each case. It also outputs the number of messages that were delayed (that is,
39374 not completely delivered at the first attempt), and the number that had at
39375 least one address that failed.
39376
39377 The remainder of the output is in sections that can be independently disabled
39378 or modified by various options. It consists of a summary of deliveries by
39379 transport, histograms of messages received and delivered per time interval
39380 (default per hour), information about the time messages spent in the queue,
39381 a list of relayed messages, lists of the top fifty sending hosts, local
39382 senders, destination hosts, and destination local users by count and by volume,
39383 and a list of delivery errors that occurred.
39384
39385 The relay information lists messages that were actually relayed, that is, they
39386 came from a remote host and were directly delivered to some other remote host,
39387 without being processed (for example, for aliasing or forwarding) locally.
39388
39389 There are quite a few options for &'eximstats'& to control exactly what it
39390 outputs. These are documented in the Perl script itself, and can be extracted
39391 by running the command &(perldoc)& on the script. For example:
39392 .code
39393 perldoc /usr/exim/bin/eximstats
39394 .endd
39395
39396 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
39397 .cindex "&'exim_checkaccess'&"
39398 .cindex "policy control" "checking access"
39399 .cindex "checking access"
39400 The &%-bh%& command line argument allows you to run a fake SMTP session with
39401 debugging output, in order to check what Exim is doing when it is applying
39402 policy controls to incoming SMTP mail. However, not everybody is sufficiently
39403 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
39404 sometimes you just want to answer the question &"Does this address have
39405 access?"& without bothering with any further details.
39406
39407 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
39408 two arguments, an IP address and an email address:
39409 .code
39410 exim_checkaccess 10.9.8.7 A.User@a.domain.example
39411 .endd
39412 The utility runs a call to Exim with the &%-bh%& option, to test whether the
39413 given email address would be accepted in a RCPT command in a TCP/IP
39414 connection from the host with the given IP address. The output of the utility
39415 is either the word &"accepted"&, or the SMTP error response, for example:
39416 .code
39417 Rejected:
39418 550 Relay not permitted
39419 .endd
39420 When running this test, the utility uses &`<>`& as the envelope sender address
39421 for the MAIL command, but you can change this by providing additional
39422 options. These are passed directly to the Exim command. For example, to specify
39423 that the test is to be run with the sender address &'himself@there.example'&
39424 you can use:
39425 .code
39426 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
39427                  -f himself@there.example
39428 .endd
39429 Note that these additional Exim command line items must be given after the two
39430 mandatory arguments.
39431
39432 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
39433 while running its checks. You can run checks that include callouts by using
39434 &%-bhc%&, but this is not yet available in a &"packaged"& form.
39435
39436
39437
39438 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
39439 .cindex "DBM" "building dbm files"
39440 .cindex "building DBM files"
39441 .cindex "&'exim_dbmbuild'&"
39442 .cindex "lower casing"
39443 .cindex "binary zero" "in lookup key"
39444 The &'exim_dbmbuild'& program reads an input file containing keys and data in
39445 the format used by the &(lsearch)& lookup (see section
39446 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
39447 names as keys and the remainder of the information as data. The lower-casing
39448 can be prevented by calling the program with the &%-nolc%& option.
39449
39450 A terminating zero is included as part of the key string. This is expected by
39451 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
39452 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
39453 strings or the data strings. The &(dbmnz)& lookup type can be used with such
39454 files.
39455
39456 The program requires two arguments: the name of the input file (which can be a
39457 single hyphen to indicate the standard input), and the name of the output file.
39458 It creates the output under a temporary name, and then renames it if all went
39459 well.
39460
39461 .cindex "USE_DB"
39462 If the native DB interface is in use (USE_DB is set in a compile-time
39463 configuration file &-- this is common in free versions of Unix) the two
39464 filenames must be different, because in this mode the Berkeley DB functions
39465 create a single output file using exactly the name given. For example,
39466 .code
39467 exim_dbmbuild /etc/aliases /etc/aliases.db
39468 .endd
39469 reads the system alias file and creates a DBM version of it in
39470 &_/etc/aliases.db_&.
39471
39472 In systems that use the &'ndbm'& routines (mostly proprietary versions of
39473 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
39474 environment, the suffixes are added to the second argument of
39475 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
39476 when the Berkeley functions are used in compatibility mode (though this is not
39477 recommended), because in that case it adds a &_.db_& suffix to the filename.
39478
39479 If a duplicate key is encountered, the program outputs a warning, and when it
39480 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
39481 option is used. By default, only the first of a set of duplicates is used &--
39482 this makes it compatible with &(lsearch)& lookups. There is an option
39483 &%-lastdup%& which causes it to use the data for the last duplicate instead.
39484 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
39485 &%stderr%&. For other errors, where it doesn't actually make a new file, the
39486 return code is 2.
39487
39488
39489
39490
39491 .section "Finding individual retry times (exinext)" "SECTfinindret"
39492 .cindex "retry" "times"
39493 .cindex "&'exinext'&"
39494 A utility called &'exinext'& (mostly a Perl script) provides the ability to
39495 fish specific information out of the retry database. Given a mail domain (or a
39496 complete address), it looks up the hosts for that domain, and outputs any retry
39497 information for the hosts or for the domain. At present, the retry information
39498 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
39499 output. For example:
39500 .code
39501 $ exinext piglet@milne.fict.example
39502 kanga.milne.example:192.168.8.1 error 146: Connection refused
39503   first failed: 21-Feb-1996 14:57:34
39504   last tried:   21-Feb-1996 14:57:34
39505   next try at:  21-Feb-1996 15:02:34
39506 roo.milne.example:192.168.8.3 error 146: Connection refused
39507   first failed: 20-Jan-1996 13:12:08
39508   last tried:   21-Feb-1996 11:42:03
39509   next try at:  21-Feb-1996 19:42:03
39510   past final cutoff time
39511 .endd
39512 You can also give &'exinext'& a local part, without a domain, and it
39513 will give any retry information for that local part in your default domain.
39514 A message id can be used to obtain retry information pertaining to a specific
39515 message. This exists only when an attempt to deliver a message to a remote host
39516 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
39517 &'exinext'& is not particularly efficient, but then it is not expected to be
39518 run very often.
39519
39520 The &'exinext'& utility calls Exim to find out information such as the location
39521 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
39522 passed on to the &'exim'& commands. The first specifies an alternate Exim
39523 configuration file, and the second sets macros for use within the configuration
39524 file. These features are mainly to help in testing, but might also be useful in
39525 environments where more than one configuration file is in use.
39526
39527
39528
39529 .section "Hints database maintenance" "SECThindatmai"
39530 .cindex "hints database" "maintenance"
39531 .cindex "maintaining Exim's hints database"
39532 Three utility programs are provided for maintaining the DBM files that Exim
39533 uses to contain its delivery hint information. Each program requires two
39534 arguments. The first specifies the name of Exim's spool directory, and the
39535 second is the name of the database it is to operate on. These are as follows:
39536
39537 .ilist
39538 &'retry'&: the database of retry information
39539 .next
39540 &'wait-'&<&'transport name'&>: databases of information about messages waiting
39541 for remote hosts
39542 .next
39543 &'callout'&: the callout cache
39544 .next
39545 &'ratelimit'&: the data for implementing the ratelimit ACL condition
39546 .next
39547 .new
39548 &'tls'&: TLS session resumption data
39549 .wen
39550 .next
39551 &'misc'&: other hints data
39552 .endlist
39553
39554 The &'misc'& database is used for
39555
39556 .ilist
39557 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
39558 .next
39559 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
39560 &(smtp)& transport)
39561 .next
39562 Limiting the concurrency of specific transports (when &%max_parallel%& is set
39563 in a transport)
39564 .endlist
39565
39566
39567
39568 .section "exim_dumpdb" "SECTdumpdb"
39569 .cindex "&'exim_dumpdb'&"
39570 The entire contents of a database are written to the standard output by the
39571 &'exim_dumpdb'& program, which has no options or arguments other than the
39572 spool and database names. For example, to dump the retry database:
39573 .code
39574 exim_dumpdb /var/spool/exim retry
39575 .endd
39576 Two lines of output are produced for each entry:
39577 .code
39578 T:mail.ref.example:192.168.242.242 146 77 Connection refused
39579 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
39580 .endd
39581 The first item on the first line is the key of the record. It starts with one
39582 of the letters R, or T, depending on whether it refers to a routing or
39583 transport retry. For a local delivery, the next part is the local address; for
39584 a remote delivery it is the name of the remote host, followed by its failing IP
39585 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
39586 transport). If the remote port is not the standard one (port 25), it is added
39587 to the IP address. Then there follows an error code, an additional error code,
39588 and a textual description of the error.
39589
39590 The three times on the second line are the time of first failure, the time of
39591 the last delivery attempt, and the computed time for the next attempt. The line
39592 ends with an asterisk if the cutoff time for the last retry rule has been
39593 exceeded.
39594
39595 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
39596 consists of a host name followed by a list of ids for messages that are or were
39597 waiting to be delivered to that host. If there are a very large number for any
39598 one host, continuation records, with a sequence number added to the host name,
39599 may be seen. The data in these records is often out of date, because a message
39600 may be routed to several alternative hosts, and Exim makes no effort to keep
39601 cross-references.
39602
39603
39604
39605 .section "exim_tidydb" "SECTtidydb"
39606 .cindex "&'exim_tidydb'&"
39607 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
39608 database. If run with no options, it removes all records that are more than 30
39609 days old. The age is calculated from the date and time that the record was last
39610 updated. Note that, in the case of the retry database, it is &'not'& the time
39611 since the first delivery failure. Information about a host that has been down
39612 for more than 30 days will remain in the database, provided that the record is
39613 updated sufficiently often.
39614
39615 The cutoff date can be altered by means of the &%-t%& option, which must be
39616 followed by a time. For example, to remove all records older than a week from
39617 the retry database:
39618 .code
39619 exim_tidydb -t 7d /var/spool/exim retry
39620 .endd
39621 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
39622 message ids. In the former these appear as data in records keyed by host &--
39623 they were messages that were waiting for that host &-- and in the latter they
39624 are the keys for retry information for messages that have suffered certain
39625 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
39626 message ids in database records are those of messages that are still on the
39627 queue. Message ids for messages that no longer exist are removed from
39628 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
39629 For the &'retry'& database, records whose keys are non-existent message ids are
39630 removed. The &'exim_tidydb'& utility outputs comments on the standard output
39631 whenever it removes information from the database.
39632
39633 Certain records are automatically removed by Exim when they are no longer
39634 needed, but others are not. For example, if all the MX hosts for a domain are
39635 down, a retry record is created for each one. If the primary MX host comes back
39636 first, its record is removed when Exim successfully delivers to it, but the
39637 records for the others remain because Exim has not tried to use those hosts.
39638
39639 It is important, therefore, to run &'exim_tidydb'& periodically on all the
39640 hints databases. You should do this at a quiet time of day, because it requires
39641 a database to be locked (and therefore inaccessible to Exim) while it does its
39642 work. Removing records from a DBM file does not normally make the file smaller,
39643 but all the common DBM libraries are able to re-use the space that is released.
39644 After an initial phase of increasing in size, the databases normally reach a
39645 point at which they no longer get any bigger, as long as they are regularly
39646 tidied.
39647
39648 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
39649 databases is likely to keep on increasing.
39650
39651
39652
39653
39654 .section "exim_fixdb" "SECTfixdb"
39655 .cindex "&'exim_fixdb'&"
39656 The &'exim_fixdb'& program is a utility for interactively modifying databases.
39657 Its main use is for testing Exim, but it might also be occasionally useful for
39658 getting round problems in a live system. It has no options, and its interface
39659 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
39660 key of a database record can then be entered, and the data for that record is
39661 displayed.
39662
39663 If &"d"& is typed at the next prompt, the entire record is deleted. For all
39664 except the &'retry'& database, that is the only operation that can be carried
39665 out. For the &'retry'& database, each field is output preceded by a number, and
39666 data for individual fields can be changed by typing the field number followed
39667 by new data, for example:
39668 .code
39669 > 4 951102:1000
39670 .endd
39671 resets the time of the next delivery attempt. Time values are given as a
39672 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
39673 used as optional separators.
39674
39675
39676
39677
39678 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
39679 .cindex "mailbox" "maintenance"
39680 .cindex "&'exim_lock'&"
39681 .cindex "locking mailboxes"
39682 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
39683 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
39684 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
39685 a user agent while investigating a problem. The utility requires the name of
39686 the file as its first argument. If the locking is successful, the second
39687 argument is run as a command (using C's &[system()]& function); if there is no
39688 second argument, the value of the SHELL environment variable is used; if this
39689 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
39690 is unlocked and the utility ends. The following options are available:
39691
39692 .vlist
39693 .vitem &%-fcntl%&
39694 Use &[fcntl()]& locking on the open mailbox.
39695
39696 .vitem &%-flock%&
39697 Use &[flock()]& locking on the open mailbox, provided the operating system
39698 supports it.
39699
39700 .vitem &%-interval%&
39701 This must be followed by a number, which is a number of seconds; it sets the
39702 interval to sleep between retries (default 3).
39703
39704 .vitem &%-lockfile%&
39705 Create a lock file before opening the mailbox.
39706
39707 .vitem &%-mbx%&
39708 Lock the mailbox using MBX rules.
39709
39710 .vitem &%-q%&
39711 Suppress verification output.
39712
39713 .vitem &%-retries%&
39714 This must be followed by a number; it sets the number of times to try to get
39715 the lock (default 10).
39716
39717 .vitem &%-restore_time%&
39718 This option causes &%exim_lock%& to restore the modified and read times to the
39719 locked file before exiting. This allows you to access a locked mailbox (for
39720 example, to take a backup copy) without disturbing the times that the user
39721 subsequently sees.
39722
39723 .vitem &%-timeout%&
39724 This must be followed by a number, which is a number of seconds; it sets a
39725 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
39726 default), a non-blocking call is used.
39727
39728 .vitem &%-v%&
39729 Generate verbose output.
39730 .endlist
39731
39732 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
39733 default is to create a lock file and also to use &[fcntl()]& locking on the
39734 mailbox, which is the same as Exim's default. The use of &%-flock%& or
39735 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
39736 requires that the directory containing the file be writeable. Locking by lock
39737 file does not last forever; Exim assumes that a lock file is expired if it is
39738 more than 30 minutes old.
39739
39740 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
39741 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
39742 to be taken out on the open mailbox, and an exclusive lock on the file
39743 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
39744 number of the mailbox file. When the locking is released, if an exclusive lock
39745 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
39746
39747 The default output contains verification of the locking that takes place. The
39748 &%-v%& option causes some additional information to be given. The &%-q%& option
39749 suppresses all output except error messages.
39750
39751 A command such as
39752 .code
39753 exim_lock /var/spool/mail/spqr
39754 .endd
39755 runs an interactive shell while the file is locked, whereas
39756 .display
39757 &`exim_lock -q /var/spool/mail/spqr <<End`&
39758 <&'some commands'&>
39759 &`End`&
39760 .endd
39761 runs a specific non-interactive sequence of commands while the file is locked,
39762 suppressing all verification output. A single command can be run by a command
39763 such as
39764 .code
39765 exim_lock -q /var/spool/mail/spqr \
39766   "cp /var/spool/mail/spqr /some/where"
39767 .endd
39768 Note that if a command is supplied, it must be entirely contained within the
39769 second argument &-- hence the quotes.
39770 .ecindex IIDutils
39771
39772
39773 . ////////////////////////////////////////////////////////////////////////////
39774 . ////////////////////////////////////////////////////////////////////////////
39775
39776 .chapter "The Exim monitor" "CHAPeximon"
39777 .scindex IIDeximon "Exim monitor" "description"
39778 .cindex "X-windows"
39779 .cindex "&'eximon'&"
39780 .cindex "Local/eximon.conf"
39781 .cindex "&_exim_monitor/EDITME_&"
39782 The Exim monitor is an application which displays in an X window information
39783 about the state of Exim's queue and what Exim is doing. An admin user can
39784 perform certain operations on messages from this GUI interface; however all
39785 such facilities are also available from the command line, and indeed, the
39786 monitor itself makes use of the command line to perform any actions requested.
39787
39788
39789
39790 .section "Running the monitor" "SECID264"
39791 The monitor is started by running the script called &'eximon'&. This is a shell
39792 script that sets up a number of environment variables, and then runs the
39793 binary called &_eximon.bin_&. The default appearance of the monitor window can
39794 be changed by editing the &_Local/eximon.conf_& file created by editing
39795 &_exim_monitor/EDITME_&. Comments in that file describe what the various
39796 parameters are for.
39797
39798 The parameters that get built into the &'eximon'& script can be overridden for
39799 a particular invocation by setting up environment variables of the same names,
39800 preceded by &`EXIMON_`&. For example, a shell command such as
39801 .code
39802 EXIMON_LOG_DEPTH=400 eximon
39803 .endd
39804 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
39805 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
39806 overrides the Exim log file configuration. This makes it possible to have
39807 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
39808 syslog messages are routed to a file on the local host.
39809
39810 X resources can be used to change the appearance of the window in the normal
39811 way. For example, a resource setting of the form
39812 .code
39813 Eximon*background: gray94
39814 .endd
39815 changes the colour of the background to light grey rather than white. The
39816 stripcharts are drawn with both the data lines and the reference lines in
39817 black. This means that the reference lines are not visible when on top of the
39818 data. However, their colour can be changed by setting a resource called
39819 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
39820 For example, if your X server is running Unix, you could set up lighter
39821 reference lines in the stripcharts by obeying
39822 .code
39823 xrdb -merge <<End
39824 Eximon*highlight: gray
39825 End
39826 .endd
39827 .cindex "admin user"
39828 In order to see the contents of messages in the queue, and to operate on them,
39829 &'eximon'& must either be run as root or by an admin user.
39830
39831 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
39832 contain X11 resource parameters interpreted by the X11 library.  In addition,
39833 if the first parameter starts with the string "gdb" then it is removed and the
39834 binary is invoked under gdb (the parameter is used as the gdb command-name, so
39835 versioned variants of gdb can be invoked).
39836
39837 The monitor's window is divided into three parts. The first contains one or
39838 more stripcharts and two action buttons, the second contains a &"tail"& of the
39839 main log file, and the third is a display of the queue of messages awaiting
39840 delivery, with two more action buttons. The following sections describe these
39841 different parts of the display.
39842
39843
39844
39845
39846 .section "The stripcharts" "SECID265"
39847 .cindex "stripchart"
39848 The first stripchart is always a count of messages in the queue. Its name can
39849 be configured by setting QUEUE_STRIPCHART_NAME in the
39850 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
39851 configuration script by regular expression matches on log file entries, making
39852 it possible to display, for example, counts of messages delivered to certain
39853 hosts or using certain transports. The supplied defaults display counts of
39854 received and delivered messages, and of local and SMTP deliveries. The default
39855 period between stripchart updates is one minute; this can be adjusted by a
39856 parameter in the &_Local/eximon.conf_& file.
39857
39858 The stripchart displays rescale themselves automatically as the value they are
39859 displaying changes. There are always 10 horizontal lines in each chart; the
39860 title string indicates the value of each division when it is greater than one.
39861 For example, &"x2"& means that each division represents a value of 2.
39862
39863 It is also possible to have a stripchart which shows the percentage fullness of
39864 a particular disk partition, which is useful when local deliveries are confined
39865 to a single partition.
39866
39867 .cindex "&%statvfs%& function"
39868 This relies on the availability of the &[statvfs()]& function or equivalent in
39869 the operating system. Most, but not all versions of Unix that support Exim have
39870 this. For this particular stripchart, the top of the chart always represents
39871 100%, and the scale is given as &"x10%"&. This chart is configured by setting
39872 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
39873 &_Local/eximon.conf_& file.
39874
39875
39876
39877
39878 .section "Main action buttons" "SECID266"
39879 .cindex "size" "of monitor window"
39880 .cindex "Exim monitor" "window size"
39881 .cindex "window size"
39882 Below the stripcharts there is an action button for quitting the monitor. Next
39883 to this is another button marked &"Size"&. They are placed here so that
39884 shrinking the window to its default minimum size leaves just the queue count
39885 stripchart and these two buttons visible. Pressing the &"Size"& button causes
39886 the window to expand to its maximum size, unless it is already at the maximum,
39887 in which case it is reduced to its minimum.
39888
39889 When expanding to the maximum, if the window cannot be fully seen where it
39890 currently is, it is moved back to where it was the last time it was at full
39891 size. When it is expanding from its minimum size, the old position is
39892 remembered, and next time it is reduced to the minimum it is moved back there.
39893
39894 The idea is that you can keep a reduced window just showing one or two
39895 stripcharts at a convenient place on your screen, easily expand it to show
39896 the full window when required, and just as easily put it back to what it was.
39897 The idea is copied from what the &'twm'& window manager does for its
39898 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
39899 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
39900
39901 Normally, the monitor starts up with the window at its full size, but it can be
39902 built so that it starts up with the window at its smallest size, by setting
39903 START_SMALL=yes in &_Local/eximon.conf_&.
39904
39905
39906
39907 .section "The log display" "SECID267"
39908 .cindex "log" "tail of; in monitor"
39909 The second section of the window is an area in which a display of the tail of
39910 the main log is maintained.
39911 To save space on the screen, the timestamp on each log line is shortened by
39912 removing the date and, if &%log_timezone%& is set, the timezone.
39913 The log tail is not available when the only destination for logging data is
39914 syslog, unless the syslog lines are routed to a local file whose name is passed
39915 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
39916
39917 The log sub-window has a scroll bar at its lefthand side which can be used to
39918 move back to look at earlier text, and the up and down arrow keys also have a
39919 scrolling effect. The amount of log that is kept depends on the setting of
39920 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
39921 to use. When this is full, the earlier 50% of data is discarded &-- this is
39922 much more efficient than throwing it away line by line. The sub-window also has
39923 a horizontal scroll bar for accessing the ends of long log lines. This is the
39924 only means of horizontal scrolling; the right and left arrow keys are not
39925 available. Text can be cut from this part of the window using the mouse in the
39926 normal way. The size of this subwindow is controlled by parameters in the
39927 configuration file &_Local/eximon.conf_&.
39928
39929 Searches of the text in the log window can be carried out by means of the ^R
39930 and ^S keystrokes, which default to a reverse and a forward search,
39931 respectively. The search covers only the text that is displayed in the window.
39932 It cannot go further back up the log.
39933
39934 The point from which the search starts is indicated by a caret marker. This is
39935 normally at the end of the text in the window, but can be positioned explicitly
39936 by pointing and clicking with the left mouse button, and is moved automatically
39937 by a successful search. If new text arrives in the window when it is scrolled
39938 back, the caret remains where it is, but if the window is not scrolled back,
39939 the caret is moved to the end of the new text.
39940
39941 Pressing ^R or ^S pops up a window into which the search text can be typed.
39942 There are buttons for selecting forward or reverse searching, for carrying out
39943 the search, and for cancelling. If the &"Search"& button is pressed, the search
39944 happens and the window remains so that further searches can be done. If the
39945 &"Return"& key is pressed, a single search is done and the window is closed. If
39946 ^C is typed the search is cancelled.
39947
39948 The searching facility is implemented using the facilities of the Athena text
39949 widget. By default this pops up a window containing both &"search"& and
39950 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
39951 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
39952 However, the linkers in BSDI and HP-UX seem unable to handle an externally
39953 provided version of &%TextPop%& when the remaining parts of the text widget
39954 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
39955 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
39956 on these systems, at the expense of having unwanted items in the search popup
39957 window.
39958
39959
39960
39961 .section "The queue display" "SECID268"
39962 .cindex "queue" "display in monitor"
39963 The bottom section of the monitor window contains a list of all messages that
39964 are in the queue, which includes those currently being received or delivered,
39965 as well as those awaiting delivery. The size of this subwindow is controlled by
39966 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
39967 at which it is updated is controlled by another parameter in the same file &--
39968 the default is 5 minutes, since queue scans can be quite expensive. However,
39969 there is an &"Update"& action button just above the display which can be used
39970 to force an update of the queue display at any time.
39971
39972 When a host is down for some time, a lot of pending mail can build up for it,
39973 and this can make it hard to deal with other messages in the queue. To help
39974 with this situation there is a button next to &"Update"& called &"Hide"&. If
39975 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
39976 type anything in here and press &"Return"&, the text is added to a chain of
39977 such texts, and if every undelivered address in a message matches at least one
39978 of the texts, the message is not displayed.
39979
39980 If there is an address that does not match any of the texts, all the addresses
39981 are displayed as normal. The matching happens on the ends of addresses so, for
39982 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
39983 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
39984 has been set up, a button called &"Unhide"& is displayed. If pressed, it
39985 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
39986 a hide request is automatically cancelled after one hour.
39987
39988 While the dialogue box is displayed, you can't press any buttons or do anything
39989 else to the monitor window. For this reason, if you want to cut text from the
39990 queue display to use in the dialogue box, you have to do the cutting before
39991 pressing the &"Hide"& button.
39992
39993 The queue display contains, for each unhidden queued message, the length of
39994 time it has been in the queue, the size of the message, the message id, the
39995 message sender, and the first undelivered recipient, all on one line. If it is
39996 a bounce message, the sender is shown as &"<>"&. If there is more than one
39997 recipient to which the message has not yet been delivered, subsequent ones are
39998 listed on additional lines, up to a maximum configured number, following which
39999 an ellipsis is displayed. Recipients that have already received the message are
40000 not shown.
40001
40002 .cindex "frozen messages" "display"
40003 If a message is frozen, an asterisk is displayed at the left-hand side.
40004
40005 The queue display has a vertical scroll bar, and can also be scrolled by means
40006 of the arrow keys. Text can be cut from it using the mouse in the normal way.
40007 The text searching facilities, as described above for the log window, are also
40008 available, but the caret is always moved to the end of the text when the queue
40009 display is updated.
40010
40011
40012
40013 .section "The queue menu" "SECID269"
40014 .cindex "queue" "menu in monitor"
40015 If the &%shift%& key is held down and the left button is clicked when the mouse
40016 pointer is over the text for any message, an action menu pops up, and the first
40017 line of the queue display for the message is highlighted. This does not affect
40018 any selected text.
40019
40020 If you want to use some other event for popping up the menu, you can set the
40021 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
40022 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
40023 value set in this parameter is a standard X event description. For example, to
40024 run eximon using &%ctrl%& rather than &%shift%& you could use
40025 .code
40026 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
40027 .endd
40028 The title of the menu is the message id, and it contains entries which act as
40029 follows:
40030
40031 .ilist
40032 &'message log'&: The contents of the message log for the message are displayed
40033 in a new text window.
40034 .next
40035 &'headers'&: Information from the spool file that contains the envelope
40036 information and headers is displayed in a new text window. See chapter
40037 &<<CHAPspool>>& for a description of the format of spool files.
40038 .next
40039 &'body'&: The contents of the spool file containing the body of the message are
40040 displayed in a new text window. There is a default limit of 20,000 bytes to the
40041 amount of data displayed. This can be changed by setting the BODY_MAX
40042 option at compile time, or the EXIMON_BODY_MAX option at runtime.
40043 .next
40044 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
40045 delivery of the message. This causes an automatic thaw if the message is
40046 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
40047 a new text window. The delivery is run in a separate process, to avoid holding
40048 up the monitor while the delivery proceeds.
40049 .next
40050 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
40051 that the message be frozen.
40052 .next
40053 .cindex "thawing messages"
40054 .cindex "unfreezing messages"
40055 .cindex "frozen messages" "thawing"
40056 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
40057 that the message be thawed.
40058 .next
40059 .cindex "delivery" "forcing failure"
40060 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
40061 that Exim gives up trying to deliver the message. A bounce message is generated
40062 for any remaining undelivered addresses.
40063 .next
40064 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
40065 that the message be deleted from the system without generating a bounce
40066 message.
40067 .next
40068 &'add recipient'&: A dialog box is displayed into which a recipient address can
40069 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
40070 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
40071 Otherwise it must be entered as a fully qualified address. Pressing RETURN
40072 causes a call to Exim to be made using the &%-Mar%& option to request that an
40073 additional recipient be added to the message, unless the entry box is empty, in
40074 which case no action is taken.
40075 .next
40076 &'mark delivered'&: A dialog box is displayed into which a recipient address
40077 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
40078 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
40079 Otherwise it must be entered as a fully qualified address. Pressing RETURN
40080 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
40081 recipient address as already delivered, unless the entry box is empty, in which
40082 case no action is taken.
40083 .next
40084 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
40085 mark all recipient addresses as already delivered.
40086 .next
40087 &'edit sender'&: A dialog box is displayed initialized with the current
40088 sender's address. Pressing RETURN causes a call to Exim to be made using the
40089 &%-Mes%& option to replace the sender address, unless the entry box is empty,
40090 in which case no action is taken. If you want to set an empty sender (as in
40091 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
40092 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
40093 the address is qualified with that domain.
40094 .endlist
40095
40096 When a delivery is forced, a window showing the &%-v%& output is displayed. In
40097 other cases when a call to Exim is made, if there is any output from Exim (in
40098 particular, if the command fails) a window containing the command and the
40099 output is displayed. Otherwise, the results of the action are normally apparent
40100 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
40101 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
40102 if no output is generated.
40103
40104 The queue display is automatically updated for actions such as freezing and
40105 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
40106 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
40107 force an update of the display after one of these actions.
40108
40109 In any text window that is displayed as result of a menu action, the normal
40110 cut-and-paste facility is available, and searching can be carried out using ^R
40111 and ^S, as described above for the log tail window.
40112 .ecindex IIDeximon
40113
40114
40115
40116
40117
40118 . ////////////////////////////////////////////////////////////////////////////
40119 . ////////////////////////////////////////////////////////////////////////////
40120
40121 .chapter "Security considerations" "CHAPsecurity"
40122 .scindex IIDsecurcon "security" "discussion of"
40123 This chapter discusses a number of issues concerned with security, some of
40124 which are also covered in other parts of this manual.
40125
40126 For reasons that this author does not understand, some people have promoted
40127 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
40128 existence of this chapter in the documentation. However, the intent of the
40129 chapter is simply to describe the way Exim works in relation to certain
40130 security concerns, not to make any specific claims about the effectiveness of
40131 its security as compared with other MTAs.
40132
40133 What follows is a description of the way Exim is supposed to be. Best efforts
40134 have been made to try to ensure that the code agrees with the theory, but an
40135 absence of bugs can never be guaranteed. Any that are reported will get fixed
40136 as soon as possible.
40137
40138
40139 .section "Building a more &""hardened""& Exim" "SECID286"
40140 .cindex "security" "build-time features"
40141 There are a number of build-time options that can be set in &_Local/Makefile_&
40142 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
40143 Exim administrator who does not have the root password, or by someone who has
40144 penetrated the Exim (but not the root) account. These options are as follows:
40145
40146 .ilist
40147 ALT_CONFIG_PREFIX can be set to a string that is required to match the
40148 start of any filenames used with the &%-C%& option. When it is set, these
40149 filenames are also not allowed to contain the sequence &"/../"&. (However, if
40150 the value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
40151 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
40152 default setting for &%ALT_CONFIG_PREFIX%&.
40153
40154 If the permitted configuration files are confined to a directory to
40155 which only root has access, this guards against someone who has broken
40156 into the Exim account from running a privileged Exim with an arbitrary
40157 configuration file, and using it to break into other accounts.
40158 .next
40159
40160 If a non-trusted configuration file (i.e. not the default configuration file
40161 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
40162 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
40163 the next item), then root privilege is retained only if the caller of Exim is
40164 root. This locks out the possibility of testing a configuration using &%-C%&
40165 right through message reception and delivery, even if the caller is root. The
40166 reception works, but by that time, Exim is running as the Exim user, so when
40167 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
40168 privilege to be lost. However, root can test reception and delivery using two
40169 separate commands.
40170
40171 .next
40172 The WHITELIST_D_MACROS build option declares some macros to be safe to override
40173 with &%-D%& if the real uid is one of root, the Exim run-time user or the
40174 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
40175 requiring the run-time value supplied to &%-D%& to match a regex that errs on
40176 the restrictive side.  Requiring build-time selection of safe macros is onerous
40177 but this option is intended solely as a transition mechanism to permit
40178 previously-working configurations to continue to work after release 4.73.
40179 .next
40180 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
40181 is disabled.
40182 .next
40183 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
40184 never to be used for any deliveries. This is like the &%never_users%& runtime
40185 option, but it cannot be overridden; the runtime option adds additional users
40186 to the list. The default setting is &"root"&; this prevents a non-root user who
40187 is permitted to modify the runtime file from using Exim as a way to get root.
40188 .endlist
40189
40190
40191
40192 .section "Root privilege" "SECID270"
40193 .cindex "setuid"
40194 .cindex "root privilege"
40195 The Exim binary is normally setuid to root, which means that it gains root
40196 privilege (runs as root) when it starts execution. In some special cases (for
40197 example, when the daemon is not in use and there are no local deliveries), it
40198 may be possible to run Exim setuid to some user other than root. This is
40199 discussed in the next section. However, in most installations, root privilege
40200 is required for two things:
40201
40202 .ilist
40203 To set up a socket connected to the standard SMTP port (25) when initialising
40204 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
40205 not required.
40206 .next
40207 To be able to change uid and gid in order to read users' &_.forward_& files and
40208 perform local deliveries as the receiving user or as specified in the
40209 configuration.
40210 .endlist
40211
40212 It is not necessary to be root to do any of the other things Exim does, such as
40213 receiving messages and delivering them externally over SMTP, and it is
40214 obviously more secure if Exim does not run as root except when necessary.
40215 For this reason, a user and group for Exim to use must be defined in
40216 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
40217 group"&. Their values can be changed by the runtime configuration, though this
40218 is not recommended. Often a user called &'exim'& is used, but some sites use
40219 &'mail'& or another user name altogether.
40220
40221 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
40222 abdication; the process cannot regain root afterwards. Prior to release 4.00,
40223 &[seteuid()]& was used in some circumstances, but this is no longer the case.
40224
40225 After a new Exim process has interpreted its command line options, it changes
40226 uid and gid in the following cases:
40227
40228 .ilist
40229 .oindex "&%-C%&"
40230 .oindex "&%-D%&"
40231 If the &%-C%& option is used to specify an alternate configuration file, or if
40232 the &%-D%& option is used to define macro values for the configuration, and the
40233 calling process is not running as root, the uid and gid are changed to those of
40234 the calling process.
40235 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
40236 option may not be used at all.
40237 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
40238 can be supplied if the calling process is running as root, the Exim run-time
40239 user or CONFIGURE_OWNER, if defined.
40240 .next
40241 .oindex "&%-be%&"
40242 .oindex "&%-bf%&"
40243 .oindex "&%-bF%&"
40244 If the expansion test option (&%-be%&) or one of the filter testing options
40245 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
40246 calling process.
40247 .next
40248 If the process is not a daemon process or a queue runner process or a delivery
40249 process or a process for testing address routing (started with &%-bt%&), the
40250 uid and gid are changed to the Exim user and group. This means that Exim always
40251 runs under its own uid and gid when receiving messages. This also applies when
40252 testing address verification
40253 .oindex "&%-bv%&"
40254 .oindex "&%-bh%&"
40255 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
40256 option).
40257 .next
40258 For a daemon, queue runner, delivery, or address testing process, the uid
40259 remains as root at this stage, but the gid is changed to the Exim group.
40260 .endlist
40261
40262 The processes that initially retain root privilege behave as follows:
40263
40264 .ilist
40265 A daemon process changes the gid to the Exim group and the uid to the Exim
40266 user after setting up one or more listening sockets. The &[initgroups()]&
40267 function is called, so that if the Exim user is in any additional groups, they
40268 will be used during message reception.
40269 .next
40270 A queue runner process retains root privilege throughout its execution. Its
40271 job is to fork a controlled sequence of delivery processes.
40272 .next
40273 A delivery process retains root privilege throughout most of its execution,
40274 but any actual deliveries (that is, the transports themselves) are run in
40275 subprocesses which always change to a non-root uid and gid. For local
40276 deliveries this is typically the uid and gid of the owner of the mailbox; for
40277 remote deliveries, the Exim uid and gid are used. Once all the delivery
40278 subprocesses have been run, a delivery process changes to the Exim uid and gid
40279 while doing post-delivery tidying up such as updating the retry database and
40280 generating bounce and warning messages.
40281
40282 While the recipient addresses in a message are being routed, the delivery
40283 process runs as root. However, if a user's filter file has to be processed,
40284 this is done in a subprocess that runs under the individual user's uid and
40285 gid. A system filter is run as root unless &%system_filter_user%& is set.
40286 .next
40287 A process that is testing addresses (the &%-bt%& option) runs as root so that
40288 the routing is done in the same environment as a message delivery.
40289 .endlist
40290
40291
40292
40293
40294 .section "Running Exim without privilege" "SECTrunexiwitpri"
40295 .cindex "privilege, running without"
40296 .cindex "unprivileged running"
40297 .cindex "root privilege" "running without"
40298 Some installations like to run Exim in an unprivileged state for more of its
40299 operation, for added security. Support for this mode of operation is provided
40300 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
40301 gid are changed to the Exim user and group at the start of a delivery process
40302 (and also queue runner and address testing processes). This means that address
40303 routing is no longer run as root, and the deliveries themselves cannot change
40304 to any other uid.
40305
40306 .cindex SIGHUP
40307 .cindex "daemon" "restarting"
40308 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
40309 that the daemon can still be started in the usual way, and it can respond
40310 correctly to SIGHUP because the re-invocation regains root privilege.
40311
40312 An alternative approach is to make Exim setuid to the Exim user and also setgid
40313 to the Exim group. If you do this, the daemon must be started from a root
40314 process. (Calling Exim from a root process makes it behave in the way it does
40315 when it is setuid root.) However, the daemon cannot restart itself after a
40316 SIGHUP signal because it cannot regain privilege.
40317
40318 It is still useful to set &%deliver_drop_privilege%& in this case, because it
40319 stops Exim from trying to re-invoke itself to do a delivery after a message has
40320 been received. Such a re-invocation is a waste of resources because it has no
40321 effect.
40322
40323 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
40324 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
40325 to the Exim user seems a clean approach, but there is one complication:
40326
40327 In this style of operation, Exim is running with the real uid and gid set to
40328 those of the calling process, and the effective uid/gid set to Exim's values.
40329 Ideally, any association with the calling process' uid/gid should be dropped,
40330 that is, the real uid/gid should be reset to the effective values so as to
40331 discard any privileges that the caller may have. While some operating systems
40332 have a function that permits this action for a non-root effective uid, quite a
40333 number of them do not. Because of this lack of standardization, Exim does not
40334 address this problem at this time.
40335
40336 For this reason, the recommended approach for &"mostly unprivileged"& running
40337 is to keep the Exim binary setuid to root, and to set
40338 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
40339 be used in the most straightforward way.
40340
40341 If you configure Exim not to run delivery processes as root, there are a
40342 number of restrictions on what you can do:
40343
40344 .ilist
40345 You can deliver only as the Exim user/group. You should  explicitly use the
40346 &%user%& and &%group%& options to override routers or local transports that
40347 normally deliver as the recipient. This makes sure that configurations that
40348 work in this mode function the same way in normal mode. Any implicit or
40349 explicit specification of another user causes an error.
40350 .next
40351 Use of &_.forward_& files is severely restricted, such that it is usually
40352 not worthwhile to include them in the configuration.
40353 .next
40354 Users who wish to use &_.forward_& would have to make their home directory and
40355 the file itself accessible to the Exim user. Pipe and append-to-file entries,
40356 and their equivalents in Exim filters, cannot be used. While they could be
40357 enabled in the Exim user's name, that would be insecure and not very useful.
40358 .next
40359 Unless the local user mailboxes are all owned by the Exim user (possible in
40360 some POP3 or IMAP-only environments):
40361
40362 .olist
40363 They must be owned by the Exim group and be writeable by that group. This
40364 implies you must set &%mode%& in the appendfile configuration, as well as the
40365 mode of the mailbox files themselves.
40366 .next
40367 You must set &%no_check_owner%&, since most or all of the files will not be
40368 owned by the Exim user.
40369 .next
40370 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
40371 on a newly created mailbox when unprivileged. This also implies that new
40372 mailboxes need to be created manually.
40373 .endlist olist
40374 .endlist ilist
40375
40376
40377 These restrictions severely restrict what can be done in local deliveries.
40378 However, there are no restrictions on remote deliveries. If you are running a
40379 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
40380 gives more security at essentially no cost.
40381
40382 If you are using the &%mua_wrapper%& facility (see chapter
40383 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
40384
40385
40386
40387
40388 .section "Delivering to local files" "SECID271"
40389 Full details of the checks applied by &(appendfile)& before it writes to a file
40390 are given in chapter &<<CHAPappendfile>>&.
40391
40392
40393
40394 .section "Running local commands" "SECTsecconslocalcmds"
40395 .cindex "security" "local commands"
40396 .cindex "security" "command injection attacks"
40397 There are a number of ways in which an administrator can configure Exim to run
40398 commands based upon received, untrustworthy, data. Further, in some
40399 configurations a user who can control a &_.forward_& file can also arrange to
40400 run commands. Configuration to check includes, but is not limited to:
40401
40402 .ilist
40403 Use of &%use_shell%& in the pipe transport: various forms of shell command
40404 injection may be possible with this option present. It is dangerous and should
40405 be used only with considerable caution. Consider constraints which whitelist
40406 allowed characters in a variable which is to be used in a pipe transport that
40407 has &%use_shell%& enabled.
40408 .next
40409 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
40410 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
40411 &_.forward_& files in a redirect router. If Exim is running on a central mail
40412 hub to which ordinary users do not have shell access, but home directories are
40413 NFS mounted (for instance) then administrators should review the list of these
40414 forbid options available, and should bear in mind that the options that may
40415 need forbidding can change as new features are added between releases.
40416 .next
40417 The &%${run...}%& expansion item does not use a shell by default, but
40418 administrators can configure use of &_/bin/sh_& as part of the command.
40419 Such invocations should be viewed with prejudicial suspicion.
40420 .next
40421 Administrators who use embedded Perl are advised to explore how Perl's
40422 taint checking might apply to their usage.
40423 .next
40424 Use of &%${expand...}%& is somewhat analogous to shell's eval builtin and
40425 administrators are well advised to view its use with suspicion, in case (for
40426 instance) it allows a local-part to contain embedded Exim directives.
40427 .next
40428 Use of &%${match_local_part...}%& and friends becomes more dangerous if
40429 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
40430 each can reference arbitrary lists and files, rather than just being a list
40431 of opaque strings.
40432 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
40433 real-world security vulnerabilities caused by its use with untrustworthy data
40434 injected in, for SQL injection attacks.
40435 Consider the use of the &%inlisti%& expansion condition instead.
40436 .endlist
40437
40438
40439
40440
40441 .section "Trust in configuration data" "SECTsecconfdata"
40442 .cindex "security" "data sources"
40443 .cindex "security" "regular expressions"
40444 .cindex "regular expressions" "security"
40445 .cindex "PCRE" "security"
40446 If configuration data for Exim can come from untrustworthy sources, there
40447 are some issues to be aware of:
40448
40449 .ilist
40450 Use of &%${expand...}%& may provide a path for shell injection attacks.
40451 .next
40452 Letting untrusted data provide a regular expression is unwise.
40453 .next
40454 Using &%${match...}%& to apply a fixed regular expression against untrusted
40455 data may result in pathological behaviour within PCRE.  Be aware of what
40456 "backtracking" means and consider options for being more strict with a regular
40457 expression. Avenues to explore include limiting what can match (avoiding &`.`&
40458 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
40459 possessive quantifiers or just not using regular expressions against untrusted
40460 data.
40461 .next
40462 It can be important to correctly use &%${quote:...}%&,
40463 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
40464 items to ensure that data is correctly constructed.
40465 .next
40466 Some lookups might return multiple results, even though normal usage is only
40467 expected to yield one result.
40468 .endlist
40469
40470
40471
40472
40473 .section "IPv4 source routing" "SECID272"
40474 .cindex "source routing" "in IP packets"
40475 .cindex "IP source routing"
40476 Many operating systems suppress IP source-routed packets in the kernel, but
40477 some cannot be made to do this, so Exim does its own check. It logs incoming
40478 IPv4 source-routed TCP calls, and then drops them. Things are all different in
40479 IPv6. No special checking is currently done.
40480
40481
40482
40483 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
40484 Support for these SMTP commands is disabled by default. If required, they can
40485 be enabled by defining suitable ACLs.
40486
40487
40488
40489
40490 .section "Privileged users" "SECID274"
40491 .cindex "trusted users"
40492 .cindex "admin user"
40493 .cindex "privileged user"
40494 .cindex "user" "trusted"
40495 .cindex "user" "admin"
40496 Exim recognizes two sets of users with special privileges. Trusted users are
40497 able to submit new messages to Exim locally, but supply their own sender
40498 addresses and information about a sending host. For other users submitting
40499 local messages, Exim sets up the sender address from the uid, and doesn't
40500 permit a remote host to be specified.
40501
40502 .oindex "&%-f%&"
40503 However, an untrusted user is permitted to use the &%-f%& command line option
40504 in the special form &%-f <>%& to indicate that a delivery failure for the
40505 message should not cause an error report. This affects the message's envelope,
40506 but it does not affect the &'Sender:'& header. Untrusted users may also be
40507 permitted to use specific forms of address with the &%-f%& option by setting
40508 the &%untrusted_set_sender%& option.
40509
40510 Trusted users are used to run processes that receive mail messages from some
40511 other mail domain and pass them on to Exim for delivery either locally, or over
40512 the Internet. Exim trusts a caller that is running as root, as the Exim user,
40513 as any user listed in the &%trusted_users%& configuration option, or under any
40514 group listed in the &%trusted_groups%& option.
40515
40516 Admin users are permitted to do things to the messages on Exim's queue. They
40517 can freeze or thaw messages, cause them to be returned to their senders, remove
40518 them entirely, or modify them in various ways. In addition, admin users can run
40519 the Exim monitor and see all the information it is capable of providing, which
40520 includes the contents of files on the spool.
40521
40522 .oindex "&%-M%&"
40523 .oindex "&%-q%&"
40524 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
40525 delivery of messages on its queue is restricted to admin users. This
40526 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
40527 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
40528 queue is also restricted to admin users. This restriction can be relaxed by
40529 setting &%no_queue_list_requires_admin%&.
40530
40531 Exim recognizes an admin user if the calling process is running as root or as
40532 the Exim user or if any of the groups associated with the calling process is
40533 the Exim group. It is not necessary actually to be running under the Exim
40534 group. However, if admin users who are not root or the Exim user are to access
40535 the contents of files on the spool via the Exim monitor (which runs
40536 unprivileged), Exim must be built to allow group read access to its spool
40537 files.
40538
40539 By default, regular users are trusted to perform basic testing and
40540 introspection commands, as themselves.  This setting can be tightened by
40541 setting the &%commandline_checks_require_admin%& option.
40542 This affects most of the checking options,
40543 such as &%-be%& and anything else &%-b*%&.
40544
40545
40546 .section "Spool files" "SECID275"
40547 .cindex "spool directory" "files"
40548 Exim's spool directory and everything it contains is owned by the Exim user and
40549 set to the Exim group. The mode for spool files is defined in the
40550 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
40551 any user who is a member of the Exim group can access these files.
40552
40553
40554
40555 .section "Use of argv[0]" "SECID276"
40556 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
40557 of specific strings, Exim assumes certain options. For example, calling Exim
40558 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
40559 to calling it with the option &%-bS%&. There are no security implications in
40560 this.
40561
40562
40563
40564 .section "Use of %f formatting" "SECID277"
40565 The only use made of &"%f"& by Exim is in formatting load average values. These
40566 are actually stored in integer variables as 1000 times the load average.
40567 Consequently, their range is limited and so therefore is the length of the
40568 converted output.
40569
40570
40571
40572 .section "Embedded Exim path" "SECID278"
40573 Exim uses its own path name, which is embedded in the code, only when it needs
40574 to re-exec in order to regain root privilege. Therefore, it is not root when it
40575 does so. If some bug allowed the path to get overwritten, it would lead to an
40576 arbitrary program's being run as exim, not as root.
40577
40578
40579
40580 .section "Dynamic module directory" "SECTdynmoddir"
40581 Any dynamically loadable modules must be installed into the directory
40582 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
40583 loading it.
40584
40585
40586 .section "Use of sprintf()" "SECID279"
40587 .cindex "&[sprintf()]&"
40588 A large number of occurrences of &"sprintf"& in the code are actually calls to
40589 &'string_sprintf()'&, a function that returns the result in malloc'd store.
40590 The intermediate formatting is done into a large fixed buffer by a function
40591 that runs through the format string itself, and checks the length of each
40592 conversion before performing it, thus preventing buffer overruns.
40593
40594 The remaining uses of &[sprintf()]& happen in controlled circumstances where
40595 the output buffer is known to be sufficiently long to contain the converted
40596 string.
40597
40598
40599
40600 .section "Use of debug_printf() and log_write()" "SECID280"
40601 Arbitrary strings are passed to both these functions, but they do their
40602 formatting by calling the function &'string_vformat()'&, which runs through
40603 the format string itself, and checks the length of each conversion.
40604
40605
40606
40607 .section "Use of strcat() and strcpy()" "SECID281"
40608 These are used only in cases where the output buffer is known to be large
40609 enough to hold the result.
40610 .ecindex IIDsecurcon
40611
40612
40613
40614
40615 . ////////////////////////////////////////////////////////////////////////////
40616 . ////////////////////////////////////////////////////////////////////////////
40617
40618 .chapter "Format of spool files" "CHAPspool"
40619 .scindex IIDforspo1 "format" "spool files"
40620 .scindex IIDforspo2 "spool directory" "format of files"
40621 .scindex IIDforspo3 "spool files" "format of"
40622 .cindex "spool files" "editing"
40623 A message on Exim's queue consists of two files, whose names are the message id
40624 followed by -D and -H, respectively. The data portion of the message is kept in
40625 the -D file on its own. The message's envelope, status, and headers are all
40626 kept in the -H file, whose format is described in this chapter. Each of these
40627 two files contains the final component of its own name as its first line. This
40628 is insurance against disk crashes where the directory is lost but the files
40629 themselves are recoverable.
40630
40631 The file formats may be changed, or new formats added, at any release.
40632 Spool files are not intended as an interface to other programs
40633 and should not be used as such.
40634
40635 Some people are tempted into editing -D files in order to modify messages. You
40636 need to be extremely careful if you do this; it is not recommended and you are
40637 on your own if you do it. Here are some of the pitfalls:
40638
40639 .ilist
40640 You must ensure that Exim does not try to deliver the message while you are
40641 fiddling with it. The safest way is to take out a write lock on the -D file,
40642 which is what Exim itself does, using &[fcntl()]&. If you update the file in
40643 place, the lock will be retained. If you write a new file and rename it, the
40644 lock will be lost at the instant of rename.
40645 .next
40646 .vindex "&$body_linecount$&"
40647 If you change the number of lines in the file, the value of
40648 &$body_linecount$&, which is stored in the -H file, will be incorrect and can
40649 cause incomplete transmission of messages or undeliverable messages.
40650 .next
40651 If the message is in MIME format, you must take care not to break it.
40652 .next
40653 If the message is cryptographically signed, any change will invalidate the
40654 signature.
40655 .endlist
40656 All in all, modifying -D files is fraught with danger.
40657
40658 Files whose names end with -J may also be seen in the &_input_& directory (or
40659 its subdirectories when &%split_spool_directory%& is set). These are journal
40660 files, used to record addresses to which the message has been delivered during
40661 the course of a delivery attempt. If there are still undelivered recipients at
40662 the end, the -H file is updated, and the -J file is deleted. If, however, there
40663 is some kind of crash (for example, a power outage) before this happens, the -J
40664 file remains in existence. When Exim next processes the message, it notices the
40665 -J file and uses it to update the -H file before starting the next delivery
40666 attempt.
40667
40668 Files whose names end with -K or .eml may also be seen in the spool.
40669 These are temporaries used for DKIM or malware processing, when that is used.
40670 They should be tidied up by normal operations; any old ones are probably
40671 relics of crashes and can be removed.
40672
40673 .section "Format of the -H file" "SECID282"
40674 .cindex "uid (user id)" "in spool file"
40675 .cindex "gid (group id)" "in spool file"
40676 The second line of the -H file contains the login name for the uid of the
40677 process that called Exim to read the message, followed by the numerical uid and
40678 gid. For a locally generated message, this is normally the user who sent the
40679 message. For a message received over TCP/IP via the daemon, it is
40680 normally the Exim user.
40681
40682 The third line of the file contains the address of the message's sender as
40683 transmitted in the envelope, contained in angle brackets. The sender address is
40684 empty for bounce messages. For incoming SMTP mail, the sender address is given
40685 in the MAIL command. For locally generated mail, the sender address is
40686 created by Exim from the login name of the current user and the configured
40687 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
40688 leading &"From&~"& line if the caller is trusted, or if the supplied address is
40689 &"<>"& or an address that matches &%untrusted_set_senders%&.
40690
40691 The fourth line contains two numbers. The first is the time that the message
40692 was received, in the conventional Unix form &-- the number of seconds since the
40693 start of the epoch. The second number is a count of the number of messages
40694 warning of delayed delivery that have been sent to the sender.
40695
40696 There follow a number of lines starting with a hyphen. These can appear in any
40697 order, and are omitted when not relevant:
40698
40699 .vlist
40700 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
40701 This item is obsolete, and is not generated from Exim release 4.61 onwards;
40702 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
40703 recognized, to provide backward compatibility. In the old format, a line of
40704 this form is present for every ACL variable that is not empty. The number
40705 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
40706 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
40707 the data string for the variable. The string itself starts at the beginning of
40708 the next line, and is followed by a newline character. It may contain internal
40709 newlines.
40710
40711 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
40712 A line of this form is present for every ACL connection variable that is
40713 defined. Note that there is a space between &%-aclc%& and the rest of the name.
40714 The length is the length of the data string for the variable. The string itself
40715 starts at the beginning of the next line, and is followed by a newline
40716 character. It may contain internal newlines.
40717
40718 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
40719 A line of this form is present for every ACL message variable that is defined.
40720 Note that there is a space between &%-aclm%& and the rest of the name. The
40721 length is the length of the data string for the variable. The string itself
40722 starts at the beginning of the next line, and is followed by a newline
40723 character. It may contain internal newlines.
40724
40725 .vitem "&%-active_hostname%&&~<&'hostname'&>"
40726 This is present if, when the message was received over SMTP, the value of
40727 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
40728
40729 .vitem &%-allow_unqualified_recipient%&
40730 This is present if unqualified recipient addresses are permitted in header
40731 lines (to stop such addresses from being qualified if rewriting occurs at
40732 transport time). Local messages that were input using &%-bnq%& and remote
40733 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
40734
40735 .vitem &%-allow_unqualified_sender%&
40736 This is present if unqualified sender addresses are permitted in header lines
40737 (to stop such addresses from being qualified if rewriting occurs at transport
40738 time). Local messages that were input using &%-bnq%& and remote messages from
40739 hosts that match &%sender_unqualified_hosts%& set this flag.
40740
40741 .vitem "&%-auth_id%&&~<&'text'&>"
40742 The id information for a message received on an authenticated SMTP connection
40743 &-- the value of the &$authenticated_id$& variable.
40744
40745 .vitem "&%-auth_sender%&&~<&'address'&>"
40746 The address of an authenticated sender &-- the value of the
40747 &$authenticated_sender$& variable.
40748
40749 .vitem "&%-body_linecount%&&~<&'number'&>"
40750 This records the number of lines in the body of the message, and is
40751 present unless &%-spool_file_wireformat%& is.
40752
40753 .vitem "&%-body_zerocount%&&~<&'number'&>"
40754 This records the number of binary zero bytes in the body of the message, and is
40755 present if the number is greater than zero.
40756
40757 .vitem &%-deliver_firsttime%&
40758 This is written when a new message is first added to the spool. When the spool
40759 file is updated after a deferral, it is omitted.
40760
40761 .vitem "&%-frozen%&&~<&'time'&>"
40762 .cindex "frozen messages" "spool data"
40763 The message is frozen, and the freezing happened at <&'time'&>.
40764
40765 .vitem "&%-helo_name%&&~<&'text'&>"
40766 This records the host name as specified by a remote host in a HELO or EHLO
40767 command.
40768
40769 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
40770 This records the IP address of the host from which the message was received and
40771 the remote port number that was used. It is omitted for locally generated
40772 messages.
40773
40774 .vitem "&%-host_auth%&&~<&'text'&>"
40775 If the message was received on an authenticated SMTP connection, this records
40776 the name of the authenticator &-- the value of the
40777 &$sender_host_authenticated$& variable.
40778
40779 .vitem &%-host_lookup_failed%&
40780 This is present if an attempt to look up the sending host's name from its IP
40781 address failed. It corresponds to the &$host_lookup_failed$& variable.
40782
40783 .vitem "&%-host_name%&&~<&'text'&>"
40784 .cindex "reverse DNS lookup"
40785 .cindex "DNS" "reverse lookup"
40786 This records the name of the remote host from which the message was received,
40787 if the host name was looked up from the IP address when the message was being
40788 received. It is not present if no reverse lookup was done.
40789
40790 .vitem "&%-ident%&&~<&'text'&>"
40791 For locally submitted messages, this records the login of the originating user,
40792 unless it was a trusted user and the &%-oMt%& option was used to specify an
40793 ident value. For messages received over TCP/IP, this records the ident string
40794 supplied by the remote host, if any.
40795
40796 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
40797 This records the IP address of the local interface and the port number through
40798 which a message was received from a remote host. It is omitted for locally
40799 generated messages.
40800
40801 .vitem &%-local%&
40802 The message is from a local sender.
40803
40804 .vitem &%-localerror%&
40805 The message is a locally-generated bounce message.
40806
40807 .vitem "&%-local_scan%&&~<&'string'&>"
40808 This records the data string that was returned by the &[local_scan()]& function
40809 when the message was received &-- the value of the &$local_scan_data$&
40810 variable. It is omitted if no data was returned.
40811
40812 .vitem &%-manual_thaw%&
40813 The message was frozen but has been thawed manually, that is, by an explicit
40814 Exim command rather than via the auto-thaw process.
40815
40816 .vitem &%-N%&
40817 A testing delivery process was started using the &%-N%& option to suppress any
40818 actual deliveries, but delivery was deferred. At any further delivery attempts,
40819 &%-N%& is assumed.
40820
40821 .vitem &%-received_protocol%&
40822 This records the value of the &$received_protocol$& variable, which contains
40823 the name of the protocol by which the message was received.
40824
40825 .vitem &%-sender_set_untrusted%&
40826 The envelope sender of this message was set by an untrusted local caller (used
40827 to ensure that the caller is displayed in queue listings).
40828
40829 .vitem "&%-spam_score_int%&&~<&'number'&>"
40830 If a message was scanned by SpamAssassin, this is present. It records the value
40831 of &$spam_score_int$&.
40832
40833 .vitem &%-spool_file_wireformat%&
40834 The -D file for this message is in wire-format (for ESMTP CHUNKING)
40835 rather than Unix-format.
40836 The line-ending is CRLF rather than newline.
40837 There is still, however, no leading-dot-stuffing.
40838
40839 .vitem &%-tls_certificate_verified%&
40840 A TLS certificate was received from the client that sent this message, and the
40841 certificate was verified by the server.
40842
40843 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
40844 When the message was received over an encrypted connection, this records the
40845 name of the cipher suite that was used.
40846
40847 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
40848 When the message was received over an encrypted connection, and a certificate
40849 was received from the client, this records the Distinguished Name from that
40850 certificate.
40851 .endlist
40852
40853 Any of the above may have an extra hyphen prepended, to indicate the the
40854 corresponding data is untrusted.
40855
40856 Following the options there is a list of those addresses to which the message
40857 is not to be delivered. This set of addresses is initialized from the command
40858 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
40859 is set; otherwise it starts out empty. Whenever a successful delivery is made,
40860 the address is added to this set. The addresses are kept internally as a
40861 balanced binary tree, and it is a representation of that tree which is written
40862 to the spool file. If an address is expanded via an alias or forward file, the
40863 original address is added to the tree when deliveries to all its child
40864 addresses are complete.
40865
40866 If the tree is empty, there is a single line in the spool file containing just
40867 the text &"XX"&. Otherwise, each line consists of two letters, which are either
40868 Y or N, followed by an address. The address is the value for the node of the
40869 tree, and the letters indicate whether the node has a left branch and/or a
40870 right branch attached to it, respectively. If branches exist, they immediately
40871 follow. Here is an example of a three-node tree:
40872 .code
40873 YY darcy@austen.fict.example
40874 NN alice@wonderland.fict.example
40875 NN editor@thesaurus.ref.example
40876 .endd
40877 After the non-recipients tree, there is a list of the message's recipients.
40878 This is a simple list, preceded by a count. It includes all the original
40879 recipients of the message, including those to whom the message has already been
40880 delivered. In the simplest case, the list contains one address per line. For
40881 example:
40882 .code
40883 4
40884 editor@thesaurus.ref.example
40885 darcy@austen.fict.example
40886 rdo@foundation
40887 alice@wonderland.fict.example
40888 .endd
40889 However, when a child address has been added to the top-level addresses as a
40890 result of the use of the &%one_time%& option on a &(redirect)& router, each
40891 line is of the following form:
40892 .display
40893 <&'top-level address'&> <&'errors_to address'&> &&&
40894   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
40895 .endd
40896 The 01 flag bit indicates the presence of the three other fields that follow
40897 the top-level address. Other bits may be used in future to support additional
40898 fields. The <&'parent number'&> is the offset in the recipients list of the
40899 original parent of the &"one time"& address. The first two fields are the
40900 envelope sender that is associated with this address and its length. If the
40901 length is zero, there is no special envelope sender (there are then two space
40902 characters in the line). A non-empty field can arise from a &(redirect)& router
40903 that has an &%errors_to%& setting.
40904
40905
40906 A blank line separates the envelope and status information from the headers
40907 which follow. A header may occupy several lines of the file, and to save effort
40908 when reading it in, each header is preceded by a number and an identifying
40909 character. The number is the number of characters in the header, including any
40910 embedded newlines and the terminating newline. The character is one of the
40911 following:
40912
40913 .table2 50pt
40914 .row <&'blank'&>         "header in which Exim has no special interest"
40915 .row &`B`&               "&'Bcc:'& header"
40916 .row &`C`&               "&'Cc:'& header"
40917 .row &`F`&               "&'From:'& header"
40918 .row &`I`&               "&'Message-id:'& header"
40919 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
40920 .row &`R`&               "&'Reply-To:'& header"
40921 .row &`S`&               "&'Sender:'& header"
40922 .row &`T`&               "&'To:'& header"
40923 .row &`*`&               "replaced or deleted header"
40924 .endtable
40925
40926 Deleted or replaced (rewritten) headers remain in the spool file for debugging
40927 purposes. They are not transmitted when the message is delivered. Here is a
40928 typical set of headers:
40929 .code
40930 111P Received: by hobbit.fict.example with local (Exim 4.00)
40931 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
40932 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
40933 038* X-rewrote-sender: bb@hobbit.fict.example
40934 042* From: Bilbo Baggins <bb@hobbit.fict.example>
40935 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
40936 099* To: alice@wonderland.fict.example, rdo@foundation,
40937 darcy@austen.fict.example, editor@thesaurus.ref.example
40938 104T To: alice@wonderland.fict.example, rdo@foundation.example,
40939 darcy@austen.fict.example, editor@thesaurus.ref.example
40940 038  Date: Fri, 11 May 2001 10:28:59 +0100
40941 .endd
40942 The asterisked headers indicate that the envelope sender, &'From:'& header, and
40943 &'To:'& header have been rewritten, the last one because routing expanded the
40944 unqualified domain &'foundation'&.
40945 .ecindex IIDforspo1
40946 .ecindex IIDforspo2
40947 .ecindex IIDforspo3
40948
40949 .section "Format of the -D file" "SECID282a"
40950 The data file is traditionally in Unix-standard format: lines are ended with
40951 an ASCII newline character.
40952 However, when the &%spool_wireformat%& main option is used some -D files
40953 can have an alternate format.
40954 This is flagged by a &%-spool_file_wireformat%& line in the corresponding -H file.
40955 The -D file lines (not including the first name-component line) are
40956 suitable for direct copying to the wire when transmitting using the
40957 ESMTP CHUNKING option, meaning lower processing overhead.
40958 Lines are terminated with an ASCII CRLF pair.
40959 There is no dot-stuffing (and no dot-termination).
40960
40961 . ////////////////////////////////////////////////////////////////////////////
40962 . ////////////////////////////////////////////////////////////////////////////
40963
40964 .chapter "DKIM, SPF, SRS and DMARC" "CHAPdkim" &&&
40965          "DKIM, SPF, SRS and DMARC Support"
40966
40967 .section "DKIM (DomainKeys Identified Mail)" SECDKIM
40968 .cindex "DKIM"
40969
40970 DKIM is a mechanism by which messages sent by some entity can be provably
40971 linked to a domain which that entity controls.  It permits reputation to
40972 be tracked on a per-domain basis, rather than merely upon source IP address.
40973 DKIM is documented in RFC 6376.
40974
40975 As DKIM relies on the message being unchanged in transit, messages handled
40976 by a mailing-list (which traditionally adds to the message) will not match
40977 any original DKIM signature.
40978
40979 DKIM support is compiled into Exim by default if TLS support is present.
40980 It can be disabled by setting DISABLE_DKIM=yes in &_Local/Makefile_&.
40981
40982 Exim's DKIM implementation allows for
40983 .olist
40984 Signing outgoing messages: This function is implemented in the SMTP transport.
40985 It can co-exist with all other Exim features
40986 (including transport filters)
40987 except cutthrough delivery.
40988 .next
40989 Verifying signatures in incoming messages: This is implemented by an additional
40990 ACL (acl_smtp_dkim), which can be called several times per message, with
40991 different signature contexts.
40992 .endlist
40993
40994 In typical Exim style, the verification implementation does not include any
40995 default "policy". Instead it enables you to build your own policy using
40996 Exim's standard controls.
40997
40998 Please note that verification of DKIM signatures in incoming mail is turned
40999 on by default for logging (in the <= line) purposes.
41000
41001 Additional log detail can be enabled using the &%dkim_verbose%& log_selector.
41002 When set, for each signature in incoming email,
41003 exim will log a line displaying the most important signature details, and the
41004 signature status. Here is an example (with line-breaks added for clarity):
41005 .code
41006 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
41007     d=facebookmail.com s=q1-2009b
41008     c=relaxed/relaxed a=rsa-sha1
41009     i=@facebookmail.com t=1252484542 [verification succeeded]
41010 .endd
41011
41012 You might want to turn off DKIM verification processing entirely for internal
41013 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
41014 control modifier. This should typically be done in the RCPT ACL, at points
41015 where you accept mail from relay sources (internal hosts or authenticated
41016 senders).
41017
41018
41019 .section "Signing outgoing messages" "SECDKIMSIGN"
41020 .cindex "DKIM" "signing"
41021
41022 For signing to be usable you must have published a DKIM record in DNS.
41023 Note that RFC 8301 (which does not cover EC keys) says:
41024 .code
41025 rsa-sha1 MUST NOT be used for signing or verifying.
41026
41027 Signers MUST use RSA keys of at least 1024 bits for all keys.
41028 Signers SHOULD use RSA keys of at least 2048 bits.
41029 .endd
41030
41031 Note also that the key content (the 'p=' field)
41032 in the DNS record is different between RSA and EC keys;
41033 for the former it is the base64 of the ASN.1 for the RSA public key
41034 (equivalent to the private-key .pem with the header/trailer stripped)
41035 but for EC keys it is the base64 of the pure key; no ASN.1 wrapping.
41036
41037 Signing is enabled by setting private options on the SMTP transport.
41038 These options take (expandable) strings as arguments.
41039
41040 .option dkim_domain smtp "string list&!!" unset
41041 The domain(s) you want to sign with.
41042 After expansion, this can be a list.
41043 Each element in turn,
41044 lowercased,
41045 is put into the &%$dkim_domain%& expansion variable
41046 while expanding the remaining signing options.
41047 If it is empty after expansion, DKIM signing is not done,
41048 and no error will result even if &%dkim_strict%& is set.
41049
41050 .option dkim_selector smtp "string list&!!" unset
41051 This sets the key selector string.
41052 After expansion, which can use &$dkim_domain$&, this can be a list.
41053 Each element in turn is put in the expansion
41054 variable &%$dkim_selector%& which may be used in the &%dkim_private_key%&
41055 option along with &%$dkim_domain%&.
41056 If the option is empty after expansion, DKIM signing is not done for this domain,
41057 and no error will result even if &%dkim_strict%& is set.
41058
41059 .option dkim_private_key smtp string&!! unset
41060 This sets the private key to use.
41061 You can use the &%$dkim_domain%& and
41062 &%$dkim_selector%& expansion variables to determine the private key to use.
41063 The result can either
41064 .ilist
41065 be a valid RSA private key in ASCII armor (.pem file), including line breaks
41066 .next
41067 with GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
41068 be a valid Ed25519 private key (same format as above)
41069 .next
41070 start with a slash, in which case it is treated as a file that contains
41071 the private key
41072 .next
41073 be "0", "false" or the empty string, in which case the message will not
41074 be signed. This case will not result in an error, even if &%dkim_strict%&
41075 is set.
41076 .endlist
41077
41078 To generate keys under OpenSSL:
41079 .code
41080 openssl genrsa -out dkim_rsa.private 2048
41081 openssl rsa -in dkim_rsa.private -out /dev/stdout -pubout -outform PEM
41082 .endd
41083 The result file from the first command should be retained, and
41084 this option set to use it.
41085 Take the base-64 lines from the output of the second command, concatenated,
41086 for the DNS TXT record.
41087 See section 3.6 of RFC6376 for the record specification.
41088
41089 Under GnuTLS:
41090 .code
41091 certtool --generate-privkey --rsa --bits=2048 --password='' -8 --outfile=dkim_rsa.private
41092 certtool --load-privkey=dkim_rsa.private --pubkey-info
41093 .endd
41094
41095 Note that RFC 8301 says:
41096 .code
41097 Signers MUST use RSA keys of at least 1024 bits for all keys.
41098 Signers SHOULD use RSA keys of at least 2048 bits.
41099 .endd
41100
41101 EC keys for DKIM are defined by RFC 8463.
41102 They are considerably smaller than RSA keys for equivalent protection.
41103 As they are a recent development, users should consider dual-signing
41104 (by setting a list of selectors, and an expansion for this option)
41105 for some transition period.
41106 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
41107 for EC keys.
41108
41109 OpenSSL 1.1.1 and GnuTLS 3.6.0 can create Ed25519 private keys:
41110 .code
41111 openssl genpkey -algorithm ed25519 -out dkim_ed25519.private
41112 certtool --generate-privkey --key-type=ed25519 --outfile=dkim_ed25519.private
41113 .endd
41114
41115 To produce the required public key value for a DNS record:
41116 .code
41117 openssl pkey -outform DER -pubout -in dkim_ed25519.private | tail -c +13 | base64
41118 certtool --load_privkey=dkim_ed25519.private --pubkey_info --outder | tail -c +13 | base64
41119 .endd
41120
41121 Exim also supports an alternate format
41122 of Ed25519 keys in DNS which was a candidate during development
41123 of the standard, but not adopted.
41124 A future release will probably drop that support.
41125
41126 .option dkim_hash smtp string&!! sha256
41127 Can be set to any one of the supported hash methods, which are:
41128 .ilist
41129 &`sha1`& &-- should not be used, is old and insecure
41130 .next
41131 &`sha256`& &-- the default
41132 .next
41133 &`sha512`& &-- possibly more secure but less well supported
41134 .endlist
41135
41136 Note that RFC 8301 says:
41137 .code
41138 rsa-sha1 MUST NOT be used for signing or verifying.
41139 .endd
41140
41141 .option dkim_identity smtp string&!! unset
41142 If set after expansion, the value is used to set an "i=" tag in
41143 the signing header.  The DKIM standards restrict the permissible
41144 syntax of this optional tag to a mail address, with possibly-empty
41145 local part, an @, and a domain identical to or subdomain of the "d="
41146 tag value.  Note that Exim does not check the value.
41147
41148 .option dkim_canon smtp string&!! unset
41149 This option sets the canonicalization method used when signing a message.
41150 The DKIM RFC currently supports two methods: "simple" and "relaxed".
41151 The option defaults to "relaxed" when unset. Note: the current implementation
41152 only supports signing with the same canonicalization method for both headers and body.
41153
41154 .option dkim_strict smtp string&!! unset
41155 This  option  defines  how  Exim  behaves  when  signing a message that
41156 should be signed fails for some reason.  When the expansion evaluates to
41157 either &"1"& or &"true"&, Exim will defer. Otherwise Exim will send the message
41158 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
41159 variables here.
41160
41161 .option dkim_sign_headers smtp string&!! "see below"
41162 If set, this option must expand to a colon-separated
41163 list of header names.
41164 Headers with these names, or the absence or such a header, will be included
41165 in the message signature.
41166 When unspecified, the header names listed in RFC4871 will be used,
41167 whether or not each header is present in the message.
41168 The default list is available for the expansion in the macro
41169 &"_DKIM_SIGN_HEADERS"&
41170 and an oversigning variant is in &"_DKIM_OVERSIGN_HEADERS"&.
41171
41172 If a name is repeated, multiple headers by that name (or the absence thereof)
41173 will be signed.  The textually later headers in the headers part of the
41174 message are signed first, if there are multiples.
41175
41176 A name can be prefixed with either an &"="& or a &"+"& character.
41177 If an &"="& prefix is used, all headers that are present with this name
41178 will be signed.
41179 If a &"+"& prefix if used, all headers that are present with this name
41180 will be signed, and one signature added for a missing header with the
41181 name will be appended.
41182
41183 .option dkim_timestamps smtp integer&!! unset
41184 This option controls the inclusion of timestamp information in the signature.
41185 If not set, no such information will be included.
41186 Otherwise, must be an unsigned number giving an offset in seconds from the current time
41187 for the expiry tag
41188 (eg. 1209600 for two weeks);
41189 both creation (t=) and expiry (x=) tags will be included.
41190
41191 RFC 6376 lists these tags as RECOMMENDED.
41192
41193
41194 .section "Verifying DKIM signatures in incoming mail" "SECDKIMVFY"
41195 .cindex "DKIM" "verification"
41196
41197 Verification of DKIM signatures in SMTP incoming email is done for all
41198 messages for which an ACL control &%dkim_disable_verify%& has not been set.
41199 .cindex DKIM "selecting signature algorithms"
41200 Individual classes of signature algorithm can be ignored by changing
41201 the main options &%dkim_verify_hashes%& or &%dkim_verify_keytypes%&.
41202 The &%dkim_verify_minimal%& option can be set to cease verification
41203 processing for a message once the first passing signature is found.
41204
41205 .cindex authentication "expansion item"
41206 Performing verification sets up information used by the
41207 &%authresults%& expansion item.
41208
41209 For most purposes the default option settings suffice and the remainder
41210 of this section can be ignored.
41211
41212 The results of verification are made available to the
41213 &%acl_smtp_dkim%& ACL, which can examine and modify them.
41214 A missing ACL definition defaults to accept.
41215 By default, the ACL is called once for each
41216 syntactically(!) correct signature in the incoming message.
41217 If any ACL call does not accept, the message is not accepted.
41218 If a cutthrough delivery was in progress for the message, that is
41219 summarily dropped (having wasted the transmission effort).
41220
41221 To evaluate the verification result in the ACL
41222 a large number of expansion variables
41223 containing the signature status and its details are set up during the
41224 runtime of the ACL.
41225
41226 Calling the ACL only for existing signatures is not sufficient to build
41227 more advanced policies. For that reason, the main option
41228 &%dkim_verify_signers%&, and an expansion variable
41229 &%$dkim_signers%& exist.
41230
41231 The main option &%dkim_verify_signers%& can be set to a colon-separated
41232 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
41233 called. It is expanded when the message has been received. At this point,
41234 the expansion variable &%$dkim_signers%& already contains a colon-separated
41235 list of signer domains and identities for the message. When
41236 &%dkim_verify_signers%& is not specified in the main configuration,
41237 it defaults as:
41238 .code
41239 dkim_verify_signers = $dkim_signers
41240 .endd
41241 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
41242 DKIM signature in the message. Current DKIM verifiers may want to explicitly
41243 call the ACL for known domains or identities. This would be achieved as follows:
41244 .code
41245 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
41246 .endd
41247 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
41248 and "ebay.com", plus all domains and identities that have signatures in the message.
41249 You can also be more creative in constructing your policy. For example:
41250 .code
41251 dkim_verify_signers = $sender_address_domain:$dkim_signers
41252 .endd
41253
41254 If a domain or identity is listed several times in the (expanded) value of
41255 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
41256
41257 Note that if the option is set using untrustworthy data
41258 (such as the From: header)
41259 care should be taken to force lowercase for domains
41260 and for the domain part if identities.
41261 The default setting can be regarded as trustworthy in this respect.
41262
41263 If multiple signatures match a domain (or identity), the ACL is called once
41264 for each matching signature.
41265
41266
41267 Inside the DKIM ACL, the following expansion variables are
41268 available (from most to least important):
41269
41270
41271 .vlist
41272 .vitem &%$dkim_cur_signer%&
41273 The signer that is being evaluated in this ACL run. This can be a domain or
41274 an identity. This is one of the list items from the expanded main option
41275 &%dkim_verify_signers%& (see above).
41276
41277 .vitem &%$dkim_verify_status%&
41278 Within the DKIM ACL,
41279 a string describing the general status of the signature. One of
41280 .ilist
41281 &%none%&: There is no signature in the message for the current domain or
41282 identity (as reflected by &%$dkim_cur_signer%&).
41283 .next
41284 &%invalid%&: The signature could not be verified due to a processing error.
41285 More detail is available in &%$dkim_verify_reason%&.
41286 .next
41287 &%fail%&: Verification of the signature failed.  More detail is
41288 available in &%$dkim_verify_reason%&.
41289 .next
41290 &%pass%&: The signature passed verification. It is valid.
41291 .endlist
41292
41293 This variable can be overwritten using an ACL 'set' modifier.
41294 This might, for instance, be done to enforce a policy restriction on
41295 hash-method or key-size:
41296 .code
41297   warn condition       = ${if eq {$dkim_verify_status}{pass}}
41298        condition       = ${if eq {${length_3:$dkim_algo}}{rsa}}
41299        condition       = ${if or {{eq {$dkim_algo}{rsa-sha1}} \
41300                                   {< {$dkim_key_length}{1024}}}}
41301        logwrite        = NOTE: forcing DKIM verify fail (was pass)
41302        set dkim_verify_status = fail
41303        set dkim_verify_reason = hash too weak or key too short
41304 .endd
41305
41306 So long as a DKIM ACL is defined (it need do no more than accept),
41307 after all the DKIM ACL runs have completed, the value becomes a
41308 colon-separated list of the values after each run.
41309 This is maintained for the mime, prdr and data ACLs.
41310
41311 .vitem &%$dkim_verify_reason%&
41312 A string giving a little bit more detail when &%$dkim_verify_status%& is either
41313 "fail" or "invalid". One of
41314 .ilist
41315 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
41316 key for the domain could not be retrieved. This may be a temporary problem.
41317 .next
41318 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
41319 record for the domain is syntactically invalid.
41320 .next
41321 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
41322 body hash does not match the one specified in the signature header. This
41323 means that the message body was modified in transit.
41324 .next
41325 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
41326 could not be verified. This may mean that headers were modified,
41327 re-written or otherwise changed in a way which is incompatible with
41328 DKIM verification. It may of course also mean that the signature is forged.
41329 .endlist
41330
41331 This variable can be overwritten, with any value, using an ACL 'set' modifier.
41332
41333 .vitem &%$dkim_domain%&
41334 The signing domain. IMPORTANT: This variable is only populated if there is
41335 an actual signature in the message for the current domain or identity (as
41336 reflected by &%$dkim_cur_signer%&).
41337
41338 .vitem &%$dkim_identity%&
41339 The signing identity, if present. IMPORTANT: This variable is only populated
41340 if there is an actual signature in the message for the current domain or
41341 identity (as reflected by &%$dkim_cur_signer%&).
41342
41343 .vitem &%$dkim_selector%&
41344 The key record selector string.
41345
41346 .vitem &%$dkim_algo%&
41347 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
41348 If running under GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
41349 may also be 'ed25519-sha256'.
41350 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
41351 for EC keys.
41352
41353 Note that RFC 8301 says:
41354 .code
41355 rsa-sha1 MUST NOT be used for signing or verifying.
41356
41357 DKIM signatures identified as having been signed with historic
41358 algorithms (currently, rsa-sha1) have permanently failed evaluation
41359 .endd
41360
41361 To enforce this you must either have a DKIM ACL which checks this variable
41362 and overwrites the &$dkim_verify_status$& variable as discussed above,
41363 or have set the main option &%dkim_verify_hashes%& to exclude
41364 processing of such signatures.
41365
41366 .vitem &%$dkim_canon_body%&
41367 The body canonicalization method. One of 'relaxed' or 'simple'.
41368
41369 .vitem &%$dkim_canon_headers%&
41370 The header canonicalization method. One of 'relaxed' or 'simple'.
41371
41372 .vitem &%$dkim_copiedheaders%&
41373 A transcript of headers and their values which are included in the signature
41374 (copied from the 'z=' tag of the signature).
41375 Note that RFC6376 requires that verification fail if the From: header is
41376 not included in the signature.  Exim does not enforce this; sites wishing
41377 strict enforcement should code the check explicitly.
41378
41379 .vitem &%$dkim_bodylength%&
41380 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
41381 limit was set by the signer, "9999999999999" is returned. This makes sure
41382 that this variable always expands to an integer value.
41383 &*Note:*& The presence of the signature tag specifying a signing body length
41384 is one possible route to spoofing of valid DKIM signatures.
41385 A paranoid implementation might wish to regard signature where this variable
41386 shows less than the "no limit" return as being invalid.
41387
41388 .vitem &%$dkim_created%&
41389 UNIX timestamp reflecting the date and time when the signature was created.
41390 When this was not specified by the signer, "0" is returned.
41391
41392 .vitem &%$dkim_expires%&
41393 UNIX timestamp reflecting the date and time when the signer wants the
41394 signature to be treated as "expired". When this was not specified by the
41395 signer, "9999999999999" is returned. This makes it possible to do useful
41396 integer size comparisons against this value.
41397 Note that Exim does not check this value.
41398
41399 .vitem &%$dkim_headernames%&
41400 A colon-separated list of names of headers included in the signature.
41401
41402 .vitem &%$dkim_key_testing%&
41403 "1" if the key record has the "testing" flag set, "0" if not.
41404
41405 .vitem &%$dkim_key_nosubdomains%&
41406 "1" if the key record forbids subdomaining, "0" otherwise.
41407
41408 .vitem &%$dkim_key_srvtype%&
41409 Service type (tag s=) from the key record. Defaults to "*" if not specified
41410 in the key record.
41411
41412 .vitem &%$dkim_key_granularity%&
41413 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
41414 in the key record.
41415
41416 .vitem &%$dkim_key_notes%&
41417 Notes from the key record (tag n=).
41418
41419 .vitem &%$dkim_key_length%&
41420 Number of bits in the key.
41421 Valid only once the key is loaded, which is at the time the header signature
41422 is verified, which is after the body hash is.
41423
41424 Note that RFC 8301 says:
41425 .code
41426 Verifiers MUST NOT consider signatures using RSA keys of
41427 less than 1024 bits as valid signatures.
41428 .endd
41429
41430 This is enforced by the default setting for the &%dkim_verify_min_keysizes%&
41431 option.
41432
41433 .endlist
41434
41435 In addition, two ACL conditions are provided:
41436
41437 .vlist
41438 .vitem &%dkim_signers%&
41439 ACL condition that checks a colon-separated list of domains or identities
41440 for a match against the domain or identity that the ACL is currently verifying
41441 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
41442 verb to a group of domains or identities. For example:
41443
41444 .code
41445 # Warn when Mail purportedly from GMail has no gmail signature
41446 warn sender_domains = gmail.com
41447      dkim_signers = gmail.com
41448      dkim_status = none
41449      log_message = GMail sender without gmail.com DKIM signature
41450 .endd
41451
41452 Note that the above does not check for a total lack of DKIM signing;
41453 for that check for empty &$h_DKIM-Signature:$& in the data ACL.
41454
41455 .vitem &%dkim_status%&
41456 ACL condition that checks a colon-separated list of possible DKIM verification
41457 results against the actual result of verification. This is typically used
41458 to restrict an ACL verb to a list of verification outcomes, for example:
41459
41460 .code
41461 deny sender_domains = paypal.com:paypal.de
41462      dkim_signers = paypal.com:paypal.de
41463      dkim_status = none:invalid:fail
41464      message = Mail from Paypal with invalid/missing signature
41465 .endd
41466
41467 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
41468 see the documentation of the &%$dkim_verify_status%& expansion variable above
41469 for more information of what they mean.
41470 .endlist
41471
41472
41473
41474
41475 .section "SPF (Sender Policy Framework)" SECSPF
41476 .cindex SPF verification
41477
41478 SPF is a mechanism whereby a domain may assert which IP addresses may transmit
41479 messages with its domain in the envelope from, documented by RFC 7208.
41480 For more information on SPF see &url(http://www.open-spf.org), a static copy of
41481 the &url(http://openspf.org).
41482 . --- 2019-10-28: still not https, open-spf.org is told to be a
41483 . --- web-archive copy of the now dead openspf.org site
41484 . --- See https://www.mail-archive.com/mailop@mailop.org/msg08019.html for a
41485 . --- discussion.
41486
41487 Messages sent by a system not authorised will fail checking of such assertions.
41488 This includes retransmissions done by traditional forwarders.
41489
41490 SPF verification support is built into Exim if SUPPORT_SPF=yes is set in
41491 &_Local/Makefile_&.  The support uses the &_libspf2_& library
41492 &url(https://www.libspf2.org/).
41493 There is no Exim involvement in the transmission of messages;
41494 publishing certain DNS records is all that is required.
41495
41496 For verification, an ACL condition and an expansion lookup are provided.
41497 .cindex authentication "expansion item"
41498 Performing verification sets up information used by the
41499 &%authresults%& expansion item.
41500
41501
41502 .cindex SPF "ACL condition"
41503 .cindex ACL "spf condition"
41504 The ACL condition "spf" can be used at or after the MAIL ACL.
41505 It takes as an argument a list of strings giving the outcome of the SPF check,
41506 and will succeed for any matching outcome.
41507 Valid strings are:
41508 .vlist
41509 .vitem &%pass%&
41510 The SPF check passed, the sending host is positively verified by SPF.
41511
41512 .vitem &%fail%&
41513 The SPF check failed, the sending host is NOT allowed to send mail for the
41514 domain in the envelope-from address.
41515
41516 .vitem &%softfail%&
41517 The SPF check failed, but the queried domain can't absolutely confirm that this
41518 is a forgery.
41519
41520 .vitem &%none%&
41521 The queried domain does not publish SPF records.
41522
41523 .vitem &%neutral%&
41524 The SPF check returned a "neutral" state.  This means the queried domain has
41525 published a SPF record, but wants to allow outside servers to send mail under
41526 its domain as well.  This should be treated like "none".
41527
41528 .vitem &%permerror%&
41529 This indicates a syntax error in the SPF record of the queried domain.
41530 You may deny messages when this occurs.
41531
41532 .vitem &%temperror%&
41533 This indicates a temporary error during all processing, including Exim's
41534 SPF processing.  You may defer messages when this occurs.
41535 .endlist
41536
41537 You can prefix each string with an exclamation mark to  invert
41538 its meaning,  for example  "!fail" will  match all  results but
41539 "fail".  The  string  list is  evaluated  left-to-right,  in a
41540 short-circuit fashion.
41541
41542 Example:
41543 .code
41544 deny spf = fail
41545      message = $sender_host_address is not allowed to send mail from \
41546                ${if def:sender_address_domain \
41547                     {$sender_address_domain}{$sender_helo_name}}.  \
41548                Please see http://www.open-spf.org/Why;\
41549                identity=${if def:sender_address_domain \
41550                              {$sender_address}{$sender_helo_name}};\
41551                ip=$sender_host_address
41552 .endd
41553
41554 Note: The above mentioned URL may not be as helpful as expected. You are
41555 encouraged to replace the link with a link to a site with more
41556 explanations.
41557
41558 When the spf condition has run, it sets up several expansion
41559 variables:
41560
41561 .cindex SPF "verification variables"
41562 .vlist
41563 .vitem &$spf_header_comment$&
41564 .vindex &$spf_header_comment$&
41565   This contains a human-readable string describing the outcome
41566   of the SPF check. You can add it to a custom header or use
41567   it for logging purposes.
41568
41569 .vitem &$spf_received$&
41570 .vindex &$spf_received$&
41571   This contains a complete Received-SPF: header that can be
41572   added to the message. Please note that according to the SPF
41573   draft, this header must be added at the top of the header
41574   list. Please see section 10 on how you can do this.
41575
41576   Note: in case of "Best-guess" (see below), the convention is
41577   to put this string in a header called X-SPF-Guess: instead.
41578
41579 .vitem &$spf_result$&
41580 .vindex &$spf_result$&
41581   This contains the outcome of the SPF check in string form,
41582   one of pass, fail, softfail, none, neutral, permerror or
41583   temperror.
41584
41585 .vitem &$spf_result_guessed$&
41586 .vindex &$spf_result_guessed$&
41587   This boolean is true only if a best-guess operation was used
41588   and required in order to obtain a result.
41589
41590 .vitem &$spf_smtp_comment$&
41591 .vindex &$spf_smtp_comment$&
41592 .vindex &%spf_smtp_comment_template%&
41593   This contains a string that can be used in a SMTP response
41594   to the calling party. Useful for "fail".
41595   The string is generated by the SPF library from the template configured in the main config
41596   option &%spf_smtp_comment_template%&.
41597 .endlist
41598
41599
41600 .cindex SPF "ACL condition"
41601 .cindex ACL "spf_guess condition"
41602 .cindex SPF "best guess"
41603 In addition to SPF, you can also perform checks for so-called
41604 "Best-guess".  Strictly speaking, "Best-guess" is not standard
41605 SPF, but it is supported by the same framework that enables SPF
41606 capability.
41607 Refer to &url(http://www.open-spf.org/FAQ/Best_guess_record)
41608 for a description of what it means.
41609 . --- 2019-10-28: still not https:
41610
41611 To access this feature, simply use the spf_guess condition in place
41612 of the spf one.  For example:
41613
41614 .code
41615 deny spf_guess = fail
41616      message = $sender_host_address doesn't look trustworthy to me
41617 .endd
41618
41619 In case you decide to reject messages based on this check, you
41620 should note that although it uses the same framework, "Best-guess"
41621 is not SPF, and therefore you should not mention SPF at all in your
41622 reject message.
41623
41624 When the spf_guess condition has run, it sets up the same expansion
41625 variables as when spf condition is run, described above.
41626
41627 Additionally, since Best-guess is not standardized, you may redefine
41628 what "Best-guess" means to you by redefining the main configuration
41629 &%spf_guess%& option.
41630 For example, the following:
41631
41632 .code
41633 spf_guess = v=spf1 a/16 mx/16 ptr ?all
41634 .endd
41635
41636 would relax host matching rules to a broader network range.
41637
41638
41639 .cindex SPF "lookup expansion"
41640 .cindex lookup spf
41641 A lookup expansion is also available. It takes an email
41642 address as the key and an IP address
41643 (v4 or v6)
41644 as the database:
41645
41646 .code
41647   ${lookup {username@domain} spf {ip.ip.ip.ip}}
41648 .endd
41649
41650 The lookup will return the same result strings as can appear in
41651 &$spf_result$& (pass,fail,softfail,neutral,none,err_perm,err_temp).
41652
41653
41654
41655
41656
41657 .section "SRS (Sender Rewriting Scheme)" SECTSRS
41658 .cindex SRS "sender rewriting scheme"
41659
41660 .new
41661 SRS can be used to modify sender addresses when forwarding so that
41662 SPF verification does not object to them.
41663 It operates by encoding the original envelope sender in a new
41664 sender local part and using a domain run by the forwarding site
41665 as the new domain for the sender.  Any DSN message should be returned
41666 to this new sender at the forwarding site, which can extract the
41667 original sender from the coded local part and forward the DSN to
41668 the originator.
41669
41670 This is a way of avoiding the breakage that SPF does to forwarding.
41671 The constructed local-part will be longer than the original,
41672 leading to possible problems with very long addresses.
41673 The changing of the sender address also hinders the tracing of mail
41674 problems.
41675
41676 Exim can be built to include native SRS support.  To do this
41677 SUPPORT_SRS=yes must be defined in &_Local/Makefile_&.
41678 If this has been done, the macros _HAVE_SRS and _HAVE_NATIVE_SRS
41679 will be defined.
41680 The support is limited to SRS0-encoding; SRS1 is not supported.
41681
41682 .cindex SRS excoding
41683 To encode an address use this expansion item:
41684 .vlist
41685 .vitem &*${srs_encode&~{*&<&'secret'&>&*}{*&<&'return&~path'&>&*}{*&<&'original&~domain'&>&*}}*&
41686 .cindex "&%srs_encode%& expansion item"
41687 .cindex SRS "expansion item"
41688 The first argument should be a secret known and used by all systems
41689 handling the recipient domain for the original message.
41690 There is no need to periodically change this key; a timestamp is also
41691 encoded.
41692 The second argument should be given as the envelope sender address before this
41693 encoding operation.
41694 The third argument should be the recipient domain of the message when
41695 it arrived at this system.
41696 .endlist
41697
41698 .cindex SRS decoding
41699 To decode an address use this expansion condition:
41700 .vlist
41701 .vitem &*inbound_srs&~{*&<&'local&~part'&>&*}{*&<&'secret'&>&*}*&
41702 The first argument should be the recipient local prt as is was received.
41703 The second argument is the site secret.
41704
41705 If the messages is not for an SRS-encoded recipient the condition will
41706 return false.  If it is, the condition will return true and the variable
41707 &$srs_recipient$& will be set to the decoded (original) value.
41708 .endlist
41709
41710 Example usage:
41711 .code
41712   #macro
41713   SRS_SECRET = <pick something unique for your site for this. Use on all MXs.>
41714
41715   #routers
41716
41717   outbound:
41718     driver =    dnslookup
41719     # if outbound, and forwarding has been done, use an alternate transport
41720     domains =   ! +my_domains
41721     transport = ${if eq {$local_part@$domain} \
41722                         {$original_local_part@$original_domain} \
41723                      {remote_smtp} {remote_forwarded_smtp}}
41724
41725   inbound_srs:
41726     driver =    redirect
41727     senders =   :
41728     domains =   +my_domains
41729     # detect inbound bounces which are SRS'd, and decode them
41730     condition = ${if inbound_srs {$local_part} {SRS_SECRET}}
41731     data =      $srs_recipient
41732
41733   inbound_srs_failure:
41734     driver =    redirect
41735     senders =   :
41736     domains =   +my_domains
41737     # detect inbound bounces which look SRS'd but are invalid
41738     condition = ${if inbound_srs {$local_part} {}}
41739     allow_fail
41740     data =      :fail: Invalid SRS recipient address
41741
41742   #... further routers here
41743
41744
41745   # transport; should look like the non-forward outbound
41746   # one, plus the max_rcpt and return_path options
41747   remote_forwarded_smtp:
41748     driver =              smtp
41749     # modify the envelope from, for mails that we forward
41750     max_rcpt =            1
41751     return_path =         ${srs_encode {SRS_SECRET} {$return_path} {$original_domain}}
41752 .endd
41753
41754
41755 .wen
41756
41757
41758
41759 .section DMARC SECDMARC
41760 .cindex DMARC verification
41761
41762 DMARC combines feedback from SPF, DKIM, and header From: in order
41763 to attempt to provide better indicators of the authenticity of an
41764 email.  This document does not explain the fundamentals; you
41765 should read and understand how it works by visiting the website at
41766 &url(http://www.dmarc.org/).
41767
41768 If Exim is built with DMARC support,
41769 the libopendmarc library is used.
41770
41771 For building Exim yourself, obtain the library from
41772 &url(http://sourceforge.net/projects/opendmarc/)
41773 to obtain a copy, or find it in your favorite package
41774 repository.  You will need to attend to the local/Makefile feature
41775 SUPPORT_DMARC and the associated LDFLAGS addition.
41776 This description assumes
41777 that headers will be in /usr/local/include, and that the libraries
41778 are in /usr/local/lib.
41779
41780 . subsection
41781
41782 There are three main-configuration options:
41783 .cindex DMARC "configuration options"
41784
41785 The &%dmarc_tld_file%& option
41786 .oindex &%dmarc_tld_file%&
41787 defines the location of a text file of valid
41788 top level domains the opendmarc library uses
41789 during domain parsing. Maintained by Mozilla,
41790 the most current version can be downloaded
41791 from a link at &url(https://publicsuffix.org/list/public_suffix_list.dat).
41792 See also the util/renew-opendmarc-tlds.sh script.
41793 The default for the option is unset.
41794 If not set, DMARC processing is disabled.
41795
41796
41797 The &%dmarc_history_file%& option, if set
41798 .oindex &%dmarc_history_file%&
41799 defines the location of a file to log results
41800 of dmarc verification on inbound emails. The
41801 contents are importable by the opendmarc tools
41802 which will manage the data, send out DMARC
41803 reports, and expire the data. Make sure the
41804 directory of this file is writable by the user
41805 exim runs as.
41806 The default is unset.
41807
41808 The &%dmarc_forensic_sender%& option
41809 .oindex &%dmarc_forensic_sender%&
41810 defines an alternate email address to use when sending a
41811 forensic report detailing alignment failures
41812 if a sender domain's dmarc record specifies it
41813 and you have configured Exim to send them.
41814 If set, this is expanded and used for the
41815 From: header line; the address is extracted
41816 from it and used for the envelope from.
41817 If not set (the default), the From: header is expanded from
41818 the dsn_from option, and <> is used for the
41819 envelope from.
41820
41821 . I wish we had subsections...
41822
41823 .cindex DMARC controls
41824 By default, the DMARC processing will run for any remote,
41825 non-authenticated user.  It makes sense to only verify DMARC
41826 status of messages coming from remote, untrusted sources.  You can
41827 use standard conditions such as hosts, senders, etc, to decide that
41828 DMARC verification should *not* be performed for them and disable
41829 DMARC with an ACL control modifier:
41830 .code
41831   control = dmarc_disable_verify
41832 .endd
41833 A DMARC record can also specify a "forensic address", which gives
41834 exim an email address to submit reports about failed alignment.
41835 Exim does not do this by default because in certain conditions it
41836 results in unintended information leakage (what lists a user might
41837 be subscribed to, etc).  You must configure exim to submit forensic
41838 reports to the owner of the domain.  If the DMARC record contains a
41839 forensic address and you specify the control statement below, then
41840 exim will send these forensic emails.  It is also advised that you
41841 configure a &%dmarc_forensic_sender%& because the default sender address
41842 construction might be inadequate.
41843 .code
41844   control = dmarc_enable_forensic
41845 .endd
41846 (AGAIN: You can choose not to send these forensic reports by simply
41847 not putting the dmarc_enable_forensic control line at any point in
41848 your exim config.  If you don't tell exim to send them, it will not
41849 send them.)
41850
41851 There are no options to either control.  Both must appear before
41852 the DATA acl.
41853
41854 . subsection
41855
41856 DMARC checks cam be run on incoming SMTP  messages by using the
41857 &"dmarc_status"& ACL condition in the DATA ACL.  You are required to
41858 call the &"spf"& condition first in the ACLs, then the &"dmarc_status"&
41859 condition.  Putting this condition in the ACLs is required in order
41860 for a DMARC check to actually occur.  All of the variables are set
41861 up before the DATA ACL, but there is no actual DMARC check that
41862 occurs until a &"dmarc_status"& condition is encountered in the ACLs.
41863
41864 The &"dmarc_status"& condition takes a list of strings on its
41865 right-hand side.  These strings describe recommended action based
41866 on the DMARC check.  To understand what the policy recommendations
41867 mean, refer to the DMARC website above.  Valid strings are:
41868 .display
41869 &'accept      '& The DMARC check passed and the library recommends accepting the email.
41870 &'reject      '& The DMARC check failed and the library recommends rejecting the email.
41871 &'quarantine  '& The DMARC check failed and the library recommends keeping it for further inspection.
41872 &'none        '& The DMARC check passed and the library recommends no specific action, neutral.
41873 &'norecord    '& No policy section in the DMARC record for this RFC5322.From field
41874 &'nofrom      '& Unable to determine the domain of the sender.
41875 &'temperror   '& Library error or dns error.
41876 &'off         '& The DMARC check was disabled for this email.
41877 .endd
41878 You can prefix each string with an exclamation mark to invert its
41879 meaning, for example "!accept" will match all results but
41880 "accept".  The string list is evaluated left-to-right in a
41881 short-circuit fashion.  When a string matches the outcome of the
41882 DMARC check, the condition succeeds.  If none of the listed
41883 strings matches the outcome of the DMARC check, the condition
41884 fails.
41885
41886 Of course, you can also use any other lookup method that Exim
41887 supports, including LDAP, Postgres, MySQL, etc, as long as the
41888 result is a list of colon-separated strings.
41889
41890 Performing the check sets up information used by the
41891 &%authresults%& expansion item.
41892
41893 Several expansion variables are set before the DATA ACL is
41894 processed, and you can use them in this ACL.  The following
41895 expansion variables are available:
41896
41897 .vlist
41898 .vitem &$dmarc_status$&
41899 .vindex &$dmarc_status$&
41900 .cindex DMARC result
41901 A one word status indicating what the DMARC library
41902 thinks of the email.  It is a combination of the results of
41903 DMARC record lookup and the SPF/DKIM/DMARC processing results
41904 (if a DMARC record was found).  The actual policy declared
41905 in the DMARC record is in a separate expansion variable.
41906
41907 .vitem &$dmarc_status_text$&
41908 .vindex &$dmarc_status_text$&
41909 Slightly longer, human readable status.
41910
41911 .vitem &$dmarc_used_domain$&
41912 .vindex &$dmarc_used_domain$&
41913 The domain which DMARC used to look up the DMARC policy record.
41914
41915 .vitem &$dmarc_domain_policy$&
41916 .vindex &$dmarc_domain_policy$&
41917 The policy declared in the DMARC record.  Valid values
41918 are "none", "reject" and "quarantine".  It is blank when there
41919 is any error, including no DMARC record.
41920 .endlist
41921
41922 . subsection
41923
41924 By default, Exim's DMARC configuration is intended to be
41925 non-intrusive and conservative.  To facilitate this, Exim will not
41926 create any type of logging files without explicit configuration by
41927 you, the admin.  Nor will Exim send out any emails/reports about
41928 DMARC issues without explicit configuration by you, the admin (other
41929 than typical bounce messages that may come about due to ACL
41930 processing or failure delivery issues).
41931
41932 In order to log statistics suitable to be imported by the opendmarc
41933 tools, you need to:
41934 .ilist
41935 Configure the global option &%dmarc_history_file%&
41936 .next
41937 Configure cron jobs to call the appropriate opendmarc history
41938 import scripts and truncating the dmarc_history_file
41939 .endlist
41940
41941 In order to send forensic reports, you need to:
41942 .ilist
41943 Configure the global option &%dmarc_forensic_sender%&
41944 .next
41945 Configure, somewhere before the DATA ACL, the control option to
41946 enable sending DMARC forensic reports
41947 .endlist
41948
41949 . subsection
41950
41951 Example usage:
41952 .code
41953 (RCPT ACL)
41954   warn    domains        = +local_domains
41955           hosts          = +local_hosts
41956           control        = dmarc_disable_verify
41957
41958   warn    !domains       = +screwed_up_dmarc_records
41959           control        = dmarc_enable_forensic
41960
41961   warn    condition      = (lookup if destined to mailing list)
41962           set acl_m_mailing_list = 1
41963
41964 (DATA ACL)
41965   warn    dmarc_status   = accept : none : off
41966           !authenticated = *
41967           log_message    = DMARC DEBUG: $dmarc_status $dmarc_used_domain
41968
41969   warn    dmarc_status   = !accept
41970           !authenticated = *
41971           log_message    = DMARC DEBUG: '$dmarc_status' for $dmarc_used_domain
41972
41973   warn    dmarc_status   = quarantine
41974           !authenticated = *
41975           set $acl_m_quarantine = 1
41976           # Do something in a transport with this flag variable
41977
41978   deny    condition      = ${if eq{$dmarc_domain_policy}{reject}}
41979           condition      = ${if eq{$acl_m_mailing_list}{1}}
41980           message        = Messages from $dmarc_used_domain break mailing lists
41981
41982   deny    dmarc_status   = reject
41983           !authenticated = *
41984           message        = Message from $dmarc_used_domain failed sender's DMARC policy, REJECT
41985
41986   warn    add_header     = :at_start:${authresults {$primary_hostname}}
41987 .endd
41988
41989
41990
41991
41992
41993 . ////////////////////////////////////////////////////////////////////////////
41994 . ////////////////////////////////////////////////////////////////////////////
41995
41996 .chapter "Proxies" "CHAPproxies" &&&
41997          "Proxy support"
41998 .cindex "proxy support"
41999 .cindex "proxy" "access via"
42000
42001 A proxy is an intermediate system through which communication is passed.
42002 Proxies may provide a security, availability or load-distribution function.
42003
42004
42005 .section "Inbound proxies" SECTproxyInbound
42006 .cindex proxy inbound
42007 .cindex proxy "server side"
42008 .cindex proxy "Proxy protocol"
42009 .cindex "Proxy protocol" proxy
42010
42011 Exim has support for receiving inbound SMTP connections via a proxy
42012 that uses &"Proxy Protocol"& to speak to it.
42013 To include this support, include &"SUPPORT_PROXY=yes"&
42014 in Local/Makefile.
42015
42016 It was built on the HAProxy specification, found at
42017 &url(https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt).
42018
42019 The purpose of this facility is so that an application load balancer,
42020 such as HAProxy, can sit in front of several Exim servers
42021 to distribute load.
42022 Exim uses the local protocol communication with the proxy to obtain
42023 the remote SMTP system IP address and port information.
42024 There is no logging if a host passes or
42025 fails Proxy Protocol negotiation, but it can easily be determined and
42026 recorded in an ACL (example is below).
42027
42028 Use of a proxy is enabled by setting the &%hosts_proxy%&
42029 main configuration option to a hostlist; connections from these
42030 hosts will use Proxy Protocol.
42031 Exim supports both version 1 and version 2 of the Proxy Protocol and
42032 automatically determines which version is in use.
42033
42034 The Proxy Protocol header is the first data received on a TCP connection
42035 and is inserted before any TLS-on-connect handshake from the client; Exim
42036 negotiates TLS between Exim-as-server and the remote client, not between
42037 Exim and the proxy server. The Proxy Protocol header must be received
42038 within &%proxy_protocol_timeout%&, which defaults to 3s.
42039
42040 The following expansion variables are usable
42041 (&"internal"& and &"external"& here refer to the interfaces
42042 of the proxy):
42043 .display
42044 &'proxy_external_address   '& IP of host being proxied or IP of remote interface of proxy
42045 &'proxy_external_port      '& Port of host being proxied or Port on remote interface of proxy
42046 &'proxy_local_address      '& IP of proxy server inbound or IP of local interface of proxy
42047 &'proxy_local_port         '& Port of proxy server inbound or Port on local interface of proxy
42048 &'proxy_session            '& boolean: SMTP connection via proxy
42049 .endd
42050 If &$proxy_session$& is set but &$proxy_external_address$& is empty
42051 there was a protocol error.
42052 The variables &$sender_host_address$& and &$sender_host_port$&
42053 will have values for the actual client system, not the proxy.
42054
42055 Since the real connections are all coming from the proxy, and the
42056 per host connection tracking is done before Proxy Protocol is
42057 evaluated, &%smtp_accept_max_per_host%& must be set high enough to
42058 handle all of the parallel volume you expect per inbound proxy.
42059 With the option set so high, you lose the ability
42060 to protect your server from many connections from one IP.
42061 In order to prevent your server from overload, you
42062 need to add a per connection ratelimit to your connect ACL.
42063 A possible solution is:
42064 .display
42065   # Set max number of connections per host
42066   LIMIT   = 5
42067   # Or do some kind of IP lookup in a flat file or database
42068   # LIMIT = ${lookup{$sender_host_address}iplsearch{/etc/exim/proxy_limits}}
42069
42070   defer   ratelimit      = LIMIT / 5s / per_conn / strict
42071           message        = Too many connections from this IP right now
42072 .endd
42073
42074
42075
42076 .section "Outbound proxies" SECTproxySOCKS
42077 .cindex proxy outbound
42078 .cindex proxy "client side"
42079 .cindex proxy SOCKS
42080 .cindex SOCKS proxy
42081 Exim has support for sending outbound SMTP via a proxy
42082 using a protocol called SOCKS5 (defined by RFC1928).
42083 The support can be optionally included by defining SUPPORT_SOCKS=yes in
42084 Local/Makefile.
42085
42086 Use of a proxy is enabled by setting the &%socks_proxy%& option
42087 on an smtp transport.
42088 The option value is expanded and should then be a list
42089 (colon-separated by default) of proxy specifiers.
42090 Each proxy specifier is a list
42091 (space-separated by default) where the initial element
42092 is an IP address and any subsequent elements are options.
42093
42094 Options are a string <name>=<value>.
42095 The list of options is in the following table:
42096 .display
42097 &'auth   '& authentication method
42098 &'name   '& authentication username
42099 &'pass   '& authentication password
42100 &'port   '& tcp port
42101 &'tmo    '& connection timeout
42102 &'pri    '& priority
42103 &'weight '& selection bias
42104 .endd
42105
42106 More details on each of these options follows:
42107
42108 .ilist
42109 .cindex authentication "to proxy"
42110 .cindex proxy authentication
42111 &%auth%&: Either &"none"& (default) or &"name"&.
42112 Using &"name"& selects username/password authentication per RFC 1929
42113 for access to the proxy.
42114 Default is &"none"&.
42115 .next
42116 &%name%&: sets the username for the &"name"& authentication method.
42117 Default is empty.
42118 .next
42119 &%pass%&: sets the password for the &"name"& authentication method.
42120 Default is empty.
42121 .next
42122 &%port%&: the TCP port number to use for the connection to the proxy.
42123 Default is 1080.
42124 .next
42125 &%tmo%&: sets a connection timeout in seconds for this proxy.
42126 Default is 5.
42127 .next
42128 &%pri%&: specifies a priority for the proxy within the list,
42129 higher values being tried first.
42130 The default priority is 1.
42131 .next
42132 &%weight%&: specifies a selection bias.
42133 Within a priority set servers are queried in a random fashion,
42134 weighted by this value.
42135 The default value for selection bias is 1.
42136 .endlist
42137
42138 Proxies from the list are tried according to their priority
42139 and weight settings until one responds.  The timeout for the
42140 overall connection applies to the set of proxied attempts.
42141
42142 .section Logging SECTproxyLog
42143 To log the (local) IP of a proxy in the incoming or delivery logline,
42144 add &"+proxy"& to the &%log_selector%& option.
42145 This will add a component tagged with &"PRX="& to the line.
42146
42147 . ////////////////////////////////////////////////////////////////////////////
42148 . ////////////////////////////////////////////////////////////////////////////
42149
42150 .chapter "Internationalisation" "CHAPi18n" &&&
42151          "Internationalisation""
42152 .cindex internationalisation "email address"
42153 .cindex EAI
42154 .cindex i18n
42155 .cindex utf8 "mail name handling"
42156
42157 Exim has support for Internationalised mail names.
42158 To include this it must be built with SUPPORT_I18N and the libidn library.
42159 Standards supported are RFCs 2060, 5890, 6530 and 6533.
42160
42161 If Exim is built with SUPPORT_I18N_2008 (in addition to SUPPORT_I18N, not
42162 instead of it) then IDNA2008 is supported; this adds an extra library
42163 requirement, upon libidn2.
42164
42165 .section "MTA operations" SECTi18nMTA
42166 .cindex SMTPUTF8 "ESMTP option"
42167 .cindex "ESMTP extensions" SMTPUTF8
42168 The main configuration option &%smtputf8_advertise_hosts%& specifies
42169 a host list.  If this matches the sending host and
42170 accept_8bitmime is true (the default) then the ESMTP option
42171 SMTPUTF8 will be advertised.
42172
42173 If the sender specifies the SMTPUTF8 option on a MAIL command
42174 international handling for the message is enabled and
42175 the expansion variable &$message_smtputf8$& will have value TRUE.
42176
42177 The option &%allow_utf8_domains%& is set to true for this
42178 message. All DNS lookups are converted to a-label form
42179 whatever the setting of &%allow_utf8_domains%&
42180 when Exim is built with SUPPORT_I18N.
42181
42182 Both localparts and domain are maintained as the original
42183 UTF-8 form internally; any comparison or regular-expression use will
42184 require appropriate care.  Filenames created, eg. by
42185 the appendfile transport, will have UTF-8 names.
42186
42187 HELO names sent by the smtp transport will have any UTF-8
42188 components expanded to a-label form,
42189 and any certificate name checks will be done using the a-label
42190 form of the name.
42191
42192 .cindex log protocol
42193 .cindex SMTPUTF8 logging
42194 .cindex i18n logging
42195 Log lines and Received-by: header lines will acquire a "utf8"
42196 prefix on the protocol element, eg. utf8esmtp.
42197
42198 The following expansion operators can be used:
42199 .code
42200 ${utf8_domain_to_alabel:str}
42201 ${utf8_domain_from_alabel:str}
42202 ${utf8_localpart_to_alabel:str}
42203 ${utf8_localpart_from_alabel:str}
42204 .endd
42205
42206 .cindex utf8 "address downconversion"
42207 .cindex i18n "utf8 address downconversion"
42208 The RCPT ACL
42209 may use the following modifier:
42210 .display
42211 control = utf8_downconvert
42212 control = utf8_downconvert/<value>
42213 .endd
42214 This sets a flag requiring that envelope addresses are converted to
42215 a-label form before smtp delivery.
42216 This is usually for use in a Message Submission Agent context,
42217 but could be used for any message.
42218
42219 If a value is appended it may be:
42220 .display
42221 &`1  `& mandatory downconversion
42222 &`0  `& no downconversion
42223 &`-1 `& if SMTPUTF8 not supported by destination host
42224 .endd
42225 If no value is given, 1 is used.
42226
42227 If mua_wrapper is set, the utf8_downconvert control
42228 is initially set to -1.
42229
42230 The smtp transport has an option &%utf8_downconvert%&.
42231 If set it must expand to one of the three values described above,
42232 or an empty string.
42233 If non-empty it overrides value previously set
42234 (due to mua_wrapper or by an ACL control).
42235
42236
42237 There is no explicit support for VRFY and EXPN.
42238 Configurations supporting these should inspect
42239 &$smtp_command_argument$& for an SMTPUTF8 argument.
42240
42241 There is no support for LMTP on Unix sockets.
42242 Using the "lmtp" protocol option on an smtp transport,
42243 for LMTP over TCP, should work as expected.
42244
42245 There is no support for DSN unitext handling,
42246 and no provision for converting logging from or to UTF-8.
42247
42248
42249
42250 .section "MDA operations" SECTi18nMDA
42251 To aid in constructing names suitable for IMAP folders
42252 the following expansion operator can be used:
42253 .code
42254 ${imapfolder {<string>} {<sep>} {<specials>}}
42255 .endd
42256
42257 The string is converted from the charset specified by
42258 the "headers charset" command (in a filter file)
42259 or &%headers_charset%& main configuration option (otherwise),
42260 to the
42261 modified UTF-7 encoding specified by RFC 2060,
42262 with the following exception: All occurrences of <sep>
42263 (which has to be a single character)
42264 are replaced with periods ("."), and all periods and slashes that are not
42265 <sep> and are not in the <specials> string are BASE64 encoded.
42266
42267 The third argument can be omitted, defaulting to an empty string.
42268 The second argument can be omitted, defaulting to "/".
42269
42270 This is the encoding used by Courier for Maildir names on disk, and followed
42271 by many other IMAP servers.
42272
42273 Examples:
42274 .display
42275 &`${imapfolder {Foo/Bar}}       `& yields &`Foo.Bar`&
42276 &`${imapfolder {Foo/Bar}{.}{/}} `& yields &`Foo&&AC8-Bar`&
42277 &`${imapfolder {Räksmörgås}}    `& yields &`R&&AOQ-ksm&&APY-rg&&AOU-s`&
42278 .endd
42279
42280 Note that the source charset setting is vital, and also that characters
42281 must be representable in UTF-16.
42282
42283
42284 . ////////////////////////////////////////////////////////////////////////////
42285 . ////////////////////////////////////////////////////////////////////////////
42286
42287 .chapter "Events" "CHAPevents" &&&
42288          "Events"
42289 .cindex events
42290
42291 The events mechanism in Exim can be used to intercept processing at a number
42292 of points.  It was originally invented to give a way to do customised logging
42293 actions (for example, to a database) but can also be used to modify some
42294 processing actions.
42295
42296 Most installations will never need to use Events.
42297 The support can be left out of a build by defining DISABLE_EVENT=yes
42298 in &_Local/Makefile_&.
42299
42300 There are two major classes of events: main and transport.
42301 The main configuration option &%event_action%& controls reception events;
42302 a transport option &%event_action%& controls delivery events.
42303
42304 Both options are a string which is expanded when the event fires.
42305 An example might look like:
42306 .cindex logging custom
42307 .code
42308 event_action = ${if eq {msg:delivery}{$event_name} \
42309 {${lookup pgsql {SELECT * FROM record_Delivery( \
42310     '${quote_pgsql:$sender_address_domain}',\
42311     '${quote_pgsql:${lc:$sender_address_local_part}}', \
42312     '${quote_pgsql:$domain}', \
42313     '${quote_pgsql:${lc:$local_part}}', \
42314     '${quote_pgsql:$host_address}', \
42315     '${quote_pgsql:${lc:$host}}', \
42316     '${quote_pgsql:$message_exim_id}')}} \
42317 } {}}
42318 .endd
42319
42320 Events have names which correspond to the point in process at which they fire.
42321 The name is placed in the variable &$event_name$& and the event action
42322 expansion must check this, as it will be called for every possible event type.
42323
42324 The current list of events is:
42325 .display
42326 &`dane:fail              after    transport  `& per connection
42327 &`msg:complete           after    main       `& per message
42328 &`msg:defer              after    transport  `& per message per delivery try
42329 &`msg:delivery           after    transport  `& per recipient
42330 &`msg:rcpt:host:defer    after    transport  `& per recipient per host
42331 &`msg:rcpt:defer         after    transport  `& per recipient
42332 &`msg:host:defer         after    transport  `& per host per delivery try; host errors
42333 &`msg:fail:delivery      after    transport  `& per recipient
42334 &`msg:fail:internal      after    main       `& per recipient
42335 &`tcp:connect            before   transport  `& per connection
42336 &`tcp:close              after    transport  `& per connection
42337 &`tls:cert               before   both       `& per certificate in verification chain
42338 &`smtp:connect           after    transport  `& per connection
42339 &`smtp:ehlo              after    transport  `& per connection
42340 .endd
42341 New event types may be added in future.
42342
42343 The event name is a colon-separated list, defining the type of
42344 event in a tree of possibilities.  It may be used as a list
42345 or just matched on as a whole.  There will be no spaces in the name.
42346
42347 The second column in the table above describes whether the event fires
42348 before or after the action is associates with.  Those which fire before
42349 can be used to affect that action (more on this below).
42350
42351 The third column in the table above says what section of the configuration
42352 should define the event action.
42353
42354 An additional variable, &$event_data$&, is filled with information varying
42355 with the event type:
42356 .display
42357 &`dane:fail            `& failure reason
42358 &`msg:defer            `& error string
42359 &`msg:delivery         `& smtp confirmation message
42360 &`msg:fail:internal    `& failure reason
42361 &`msg:fail:delivery    `& smtp error message
42362 &`msg:host:defer       `& error string
42363 &`msg:rcpt:host:defer  `& error string
42364 &`msg:rcpt:defer       `& error string
42365 &`tls:cert             `& verification chain depth
42366 &`smtp:connect         `& smtp banner
42367 &`smtp:ehlo            `& smtp ehlo response
42368 .endd
42369
42370 The :defer events populate one extra variable: &$event_defer_errno$&.
42371
42372 For complex operations an ACL expansion can be used in &%event_action%&
42373 however due to the multiple contexts that Exim operates in during
42374 the course of its processing:
42375 .ilist
42376 variables set in transport events will not be visible outside that
42377 transport call
42378 .next
42379 acl_m variables in a server context are lost on a new connection,
42380 and after smtp helo/ehlo/mail/starttls/rset commands
42381 .endlist
42382 Using an ACL expansion with the logwrite modifier can be
42383 a useful way of writing to the main log.
42384
42385 The expansion of the event_action option should normally
42386 return an empty string.  Should it return anything else the
42387 following will be forced:
42388 .display
42389 &`tcp:connect      `&  do not connect
42390 &`tls:cert         `&  refuse verification
42391 &`smtp:connect     `&  close connection
42392 .endd
42393 All other message types ignore the result string, and
42394 no other use is made of it.
42395
42396 For a tcp:connect event, if the connection is being made to a proxy
42397 then the address and port variables will be that of the proxy and not
42398 the target system.
42399
42400 For tls:cert events, if GnuTLS is in use this will trigger only per
42401 chain element received on the connection.
42402 For OpenSSL it will trigger for every chain element including those
42403 loaded locally.
42404
42405 . ////////////////////////////////////////////////////////////////////////////
42406 . ////////////////////////////////////////////////////////////////////////////
42407
42408 .chapter "Adding new drivers or lookup types" "CHID13" &&&
42409          "Adding drivers or lookups"
42410 .cindex "adding drivers"
42411 .cindex "new drivers, adding"
42412 .cindex "drivers" "adding new"
42413 The following actions have to be taken in order to add a new router, transport,
42414 authenticator, or lookup type to Exim:
42415
42416 .olist
42417 Choose a name for the driver or lookup type that does not conflict with any
42418 existing name; I will use &"newdriver"& in what follows.
42419 .next
42420 Add to &_src/EDITME_& the line:
42421 .display
42422 <&'type'&>&`_NEWDRIVER=yes`&
42423 .endd
42424 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
42425 code is not to be included in the binary by default, comment this line out. You
42426 should also add any relevant comments about the driver or lookup type.
42427 .next
42428 Add to &_src/config.h.defaults_& the line:
42429 .code
42430 #define <type>_NEWDRIVER
42431 .endd
42432 .next
42433 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
42434 and create a table entry as is done for all the other drivers and lookup types.
42435 .next
42436 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
42437 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
42438 Add your &`NEWDRIVER`& to that list.
42439 As long as the dynamic module would be named &_newdriver.so_&, you can use the
42440 simple form that most lookups have.
42441 .next
42442 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
42443 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
42444 driver or lookup type and add it to the definition of OBJ.
42445 .next
42446 Edit &_OS/Makefile-Base_& adding a &_.o_& file for the predefined-macros, to the
42447 definition of OBJ_MACRO.  Add a set of line to do the compile also.
42448 .next
42449 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
42450 &_src_&.
42451 .next
42452 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
42453 as for other drivers and lookups.
42454 .endlist
42455
42456 Then all you need to do is write the code! A good way to start is to make a
42457 proforma by copying an existing module of the same type, globally changing all
42458 occurrences of the name, and cutting out most of the code. Note that any
42459 options you create must be listed in alphabetical order, because the tables are
42460 searched using a binary chop procedure.
42461
42462 There is a &_README_& file in each of the sub-directories of &_src_& describing
42463 the interface that is expected.
42464
42465
42466
42467
42468 . ////////////////////////////////////////////////////////////////////////////
42469 . ////////////////////////////////////////////////////////////////////////////
42470
42471 . /////////////////////////////////////////////////////////////////////////////
42472 . These lines are processing instructions for the Simple DocBook Processor that
42473 . Philip Hazel has developed as a less cumbersome way of making PostScript and
42474 . PDFs than using xmlto and fop. They will be ignored by all other XML
42475 . processors.
42476 . /////////////////////////////////////////////////////////////////////////////
42477
42478 .literal xml
42479 <?sdop
42480   format="newpage"
42481   foot_right_recto="&chaptertitle;"
42482   foot_right_verso="&chaptertitle;"
42483 ?>
42484 .literal off
42485
42486 .makeindex "Options index"   "option"
42487 .makeindex "Variables index" "variable"
42488 .makeindex "Concept index"   "concept"
42489
42490
42491 . /////////////////////////////////////////////////////////////////////////////
42492 . /////////////////////////////////////////////////////////////////////////////