1d5c0fa38a3c33c3a14c70c8eba41a1f7826887a
[exim.git] / doc / doc-docbook / spec.xfpt
1 . /////////////////////////////////////////////////////////////////////////////
2 . This is the primary source of the Exim Manual. It is an xfpt document that is
3 . converted into DocBook XML for subsequent conversion into printing and online
4 . formats. The markup used herein is "standard" xfpt markup, with some extras.
5 . The markup is summarized in a file called Markup.txt.
6 .
7 . WARNING: When you use the .new macro, make sure it appears *before* any
8 . adjacent index items; otherwise you get an empty "paragraph" which causes
9 . unwanted vertical space.
10 . /////////////////////////////////////////////////////////////////////////////
11
12 .include stdflags
13 .include stdmacs
14
15 . /////////////////////////////////////////////////////////////////////////////
16 . This outputs the standard DocBook boilerplate.
17 . /////////////////////////////////////////////////////////////////////////////
18
19 .docbook
20
21 . /////////////////////////////////////////////////////////////////////////////
22 . These lines are processing instructions for the Simple DocBook Processor that
23 . Philip Hazel has developed as a less cumbersome way of making PostScript and
24 . PDFs than using xmlto and fop. They will be ignored by all other XML
25 . processors.
26 . /////////////////////////////////////////////////////////////////////////////
27
28 .literal xml
29 <?sdop
30   foot_right_recto="&chaptertitle; (&chapternumber;)"
31   foot_right_verso="&chaptertitle; (&chapternumber;)"
32   toc_chapter_blanks="yes,yes"
33   table_warn_overflow="overprint"
34 ?>
35 .literal off
36
37 . /////////////////////////////////////////////////////////////////////////////
38 . This generate the outermost <book> element that wraps then entire document.
39 . /////////////////////////////////////////////////////////////////////////////
40
41 .book
42
43 . /////////////////////////////////////////////////////////////////////////////
44 . These definitions set some parameters and save some typing.
45 . Update the Copyright year (only) when changing content.
46 . /////////////////////////////////////////////////////////////////////////////
47
48 .set previousversion "4.90"
49 .include ./local_params
50
51 .set ACL "access control lists (ACLs)"
52 .set I   "&nbsp;&nbsp;&nbsp;&nbsp;"
53
54 .macro copyyear
55 2018
56 .endmacro
57
58 . /////////////////////////////////////////////////////////////////////////////
59 . Additional xfpt markup used by this document, over and above the default
60 . provided in the xfpt library.
61 . /////////////////////////////////////////////////////////////////////////////
62
63 . --- Override the &$ flag to automatically insert a $ with the variable name
64
65 .flag &$  $&   "<varname>$"  "</varname>"
66
67 . --- Short flags for daggers in option headings. They will always be inside
68 . --- an italic string, but we want the daggers to be roman.
69
70 .flag &!!      "</emphasis>&dagger;<emphasis>"
71 .flag &!?      "</emphasis>&Dagger;<emphasis>"
72
73 . --- A macro for an Exim option definition heading, generating a one-line
74 . --- table with four columns. For cases when the option name is given with
75 . --- a space, so that it can be split, a fifth argument is used for the
76 . --- index entry.
77
78 .macro option
79 .arg 5
80 .oindex "&%$5%&"
81 .endarg
82 .arg -5
83 .oindex "&%$1%&"
84 .endarg
85 .itable all 0 0 4 8* left 6* center 6* center 6* right
86 .row "&%$1%&" "Use: &'$2'&" "Type: &'$3'&" "Default: &'$4'&"
87 .endtable
88 .endmacro
89
90 . --- A macro for the common 2-column tables. The width of the first column
91 . --- is suitable for the many tables at the start of the main options chapter;
92 . --- the small number of other 2-column tables override it.
93
94 .macro table2 196pt 254pt
95 .itable none 0 0 2 $1 left $2 left
96 .endmacro
97
98 . --- A macro that generates .row, but puts &I; at the start of the first
99 . --- argument, thus indenting it. Assume a minimum of two arguments, and
100 . --- allow up to four arguments, which is as many as we'll ever need.
101
102 .macro irow
103 .arg 4
104 .row "&I;$1" "$2" "$3" "$4"
105 .endarg
106 .arg -4
107 .arg 3
108 .row "&I;$1" "$2" "$3"
109 .endarg
110 .arg -3
111 .row "&I;$1" "$2"
112 .endarg
113 .endarg
114 .endmacro
115
116 . --- Macros for option, variable, and concept index entries. For a "range"
117 . --- style of entry, use .scindex for the start and .ecindex for the end. The
118 . --- first argument of .scindex and the only argument of .ecindex must be the
119 . --- ID that ties them together.
120
121 .macro cindex
122 &<indexterm role="concept">&
123 &<primary>&$1&</primary>&
124 .arg 2
125 &<secondary>&$2&</secondary>&
126 .endarg
127 &</indexterm>&
128 .endmacro
129
130 .macro scindex
131 &<indexterm role="concept" id="$1" class="startofrange">&
132 &<primary>&$2&</primary>&
133 .arg 3
134 &<secondary>&$3&</secondary>&
135 .endarg
136 &</indexterm>&
137 .endmacro
138
139 .macro ecindex
140 &<indexterm role="concept" startref="$1" class="endofrange"/>&
141 .endmacro
142
143 .macro oindex
144 &<indexterm role="option">&
145 &<primary>&$1&</primary>&
146 .arg 2
147 &<secondary>&$2&</secondary>&
148 .endarg
149 &</indexterm>&
150 .endmacro
151
152 .macro vindex
153 &<indexterm role="variable">&
154 &<primary>&$1&</primary>&
155 .arg 2
156 &<secondary>&$2&</secondary>&
157 .endarg
158 &</indexterm>&
159 .endmacro
160
161 .macro index
162 .echo "** Don't use .index; use .cindex or .oindex or .vindex"
163 .endmacro
164 . ////////////////////////////////////////////////////////////////////////////
165
166
167 . ////////////////////////////////////////////////////////////////////////////
168 . The <bookinfo> element is removed from the XML before processing for Ascii
169 . output formats.
170 . ////////////////////////////////////////////////////////////////////////////
171
172 .literal xml
173 <bookinfo>
174 <title>Specification of the Exim Mail Transfer Agent</title>
175 <titleabbrev>The Exim MTA</titleabbrev>
176 <date>
177 .fulldate
178 </date>
179 <author><firstname>Exim</firstname><surname>Maintainers</surname></author>
180 <authorinitials>EM</authorinitials>
181 <revhistory><revision>
182 .versiondatexml
183   <authorinitials>EM</authorinitials>
184 </revision></revhistory>
185 <copyright><year>
186 .copyyear
187            </year><holder>University of Cambridge</holder></copyright>
188 </bookinfo>
189 .literal off
190
191
192 . /////////////////////////////////////////////////////////////////////////////
193 . This chunk of literal XML implements index entries of the form "x, see y" and
194 . "x, see also y". However, the DocBook DTD doesn't allow <indexterm> entries
195 . at the top level, so we have to put the .chapter directive first.
196 . /////////////////////////////////////////////////////////////////////////////
197
198 .chapter "Introduction" "CHID1"
199 .literal xml
200
201 <indexterm role="variable">
202   <primary>$1, $2, etc.</primary>
203   <see><emphasis>numerical variables</emphasis></see>
204 </indexterm>
205 <indexterm role="concept">
206   <primary>address</primary>
207   <secondary>rewriting</secondary>
208   <see><emphasis>rewriting</emphasis></see>
209 </indexterm>
210 <indexterm role="concept">
211   <primary>Bounce Address Tag Validation</primary>
212   <see><emphasis>BATV</emphasis></see>
213 </indexterm>
214 <indexterm role="concept">
215   <primary>Client SMTP Authorization</primary>
216   <see><emphasis>CSA</emphasis></see>
217 </indexterm>
218 <indexterm role="concept">
219   <primary>CR character</primary>
220   <see><emphasis>carriage return</emphasis></see>
221 </indexterm>
222 <indexterm role="concept">
223   <primary>CRL</primary>
224   <see><emphasis>certificate revocation list</emphasis></see>
225 </indexterm>
226 <indexterm role="concept">
227   <primary>delivery</primary>
228   <secondary>failure report</secondary>
229   <see><emphasis>bounce message</emphasis></see>
230 </indexterm>
231 <indexterm role="concept">
232   <primary>dialup</primary>
233   <see><emphasis>intermittently connected hosts</emphasis></see>
234 </indexterm>
235 <indexterm role="concept">
236   <primary>exiscan</primary>
237   <see><emphasis>content scanning</emphasis></see>
238 </indexterm>
239 <indexterm role="concept">
240   <primary>failover</primary>
241   <see><emphasis>fallback</emphasis></see>
242 </indexterm>
243 <indexterm role="concept">
244   <primary>fallover</primary>
245   <see><emphasis>fallback</emphasis></see>
246 </indexterm>
247 <indexterm role="concept">
248   <primary>filter</primary>
249   <secondary>Sieve</secondary>
250   <see><emphasis>Sieve filter</emphasis></see>
251 </indexterm>
252 <indexterm role="concept">
253   <primary>ident</primary>
254   <see><emphasis>RFC 1413</emphasis></see>
255 </indexterm>
256 <indexterm role="concept">
257   <primary>LF character</primary>
258   <see><emphasis>linefeed</emphasis></see>
259 </indexterm>
260 <indexterm role="concept">
261   <primary>maximum</primary>
262   <seealso><emphasis>limit</emphasis></seealso>
263 </indexterm>
264 <indexterm role="concept">
265   <primary>monitor</primary>
266   <see><emphasis>Exim monitor</emphasis></see>
267 </indexterm>
268 <indexterm role="concept">
269   <primary>no_<emphasis>xxx</emphasis></primary>
270   <see>entry for xxx</see>
271 </indexterm>
272 <indexterm role="concept">
273   <primary>NUL</primary>
274   <see><emphasis>binary zero</emphasis></see>
275 </indexterm>
276 <indexterm role="concept">
277   <primary>passwd file</primary>
278   <see><emphasis>/etc/passwd</emphasis></see>
279 </indexterm>
280 <indexterm role="concept">
281   <primary>process id</primary>
282   <see><emphasis>pid</emphasis></see>
283 </indexterm>
284 <indexterm role="concept">
285   <primary>RBL</primary>
286   <see><emphasis>DNS list</emphasis></see>
287 </indexterm>
288 <indexterm role="concept">
289   <primary>redirection</primary>
290   <see><emphasis>address redirection</emphasis></see>
291 </indexterm>
292 <indexterm role="concept">
293   <primary>return path</primary>
294   <seealso><emphasis>envelope sender</emphasis></seealso>
295 </indexterm>
296 <indexterm role="concept">
297   <primary>scanning</primary>
298   <see><emphasis>content scanning</emphasis></see>
299 </indexterm>
300 <indexterm role="concept">
301   <primary>SSL</primary>
302   <see><emphasis>TLS</emphasis></see>
303 </indexterm>
304 <indexterm role="concept">
305   <primary>string</primary>
306   <secondary>expansion</secondary>
307   <see><emphasis>expansion</emphasis></see>
308 </indexterm>
309 <indexterm role="concept">
310   <primary>top bit</primary>
311   <see><emphasis>8-bit characters</emphasis></see>
312 </indexterm>
313 <indexterm role="concept">
314   <primary>variables</primary>
315   <see><emphasis>expansion, variables</emphasis></see>
316 </indexterm>
317 <indexterm role="concept">
318   <primary>zero, binary</primary>
319   <see><emphasis>binary zero</emphasis></see>
320 </indexterm>
321
322 .literal off
323
324
325 . /////////////////////////////////////////////////////////////////////////////
326 . This is the real start of the first chapter. See the comment above as to why
327 . we can't have the .chapter line here.
328 . chapter "Introduction"
329 . /////////////////////////////////////////////////////////////////////////////
330
331 Exim is a mail transfer agent (MTA) for hosts that are running Unix or
332 Unix-like operating systems. It was designed on the assumption that it would be
333 run on hosts that are permanently connected to the Internet. However, it can be
334 used on intermittently connected hosts with suitable configuration adjustments.
335
336 Configuration files currently exist for the following operating systems: AIX,
337 BSD/OS (aka BSDI), Darwin (Mac OS X), DGUX, Dragonfly, FreeBSD, GNU/Hurd,
338 GNU/Linux, HI-OSF (Hitachi), HI-UX, HP-UX, IRIX, MIPS RISCOS, NetBSD, OpenBSD,
339 OpenUNIX, QNX, SCO, SCO SVR4.2 (aka UNIX-SV), Solaris (aka SunOS5), SunOS4,
340 Tru64-Unix (formerly Digital UNIX, formerly DEC-OSF1), Ultrix, and Unixware.
341 Some of these operating systems are no longer current and cannot easily be
342 tested, so the configuration files may no longer work in practice.
343
344 There are also configuration files for compiling Exim in the Cygwin environment
345 that can be installed on systems running Windows. However, this document does
346 not contain any information about running Exim in the Cygwin environment.
347
348 The terms and conditions for the use and distribution of Exim are contained in
349 the file &_NOTICE_&. Exim is distributed under the terms of the GNU General
350 Public Licence, a copy of which may be found in the file &_LICENCE_&.
351
352 The use, supply or promotion of Exim for the purpose of sending bulk,
353 unsolicited electronic mail is incompatible with the basic aims of the program,
354 which revolve around the free provision of a service that enhances the quality
355 of personal communications. The author of Exim regards indiscriminate
356 mass-mailing as an antisocial, irresponsible abuse of the Internet.
357
358 Exim owes a great deal to Smail 3 and its author, Ron Karr. Without the
359 experience of running and working on the Smail 3 code, I could never have
360 contemplated starting to write a new MTA. Many of the ideas and user interfaces
361 were originally taken from Smail 3, though the actual code of Exim is entirely
362 new, and has developed far beyond the initial concept.
363
364 Many people, both in Cambridge and around the world, have contributed to the
365 development and the testing of Exim, and to porting it to various operating
366 systems. I am grateful to them all. The distribution now contains a file called
367 &_ACKNOWLEDGMENTS_&, in which I have started recording the names of
368 contributors.
369
370
371 .section "Exim documentation" "SECID1"
372 . Keep this example change bar when updating the documentation!
373
374 .new
375 .cindex "documentation"
376 This edition of the Exim specification applies to version &version() of Exim.
377 Substantive changes from the &previousversion; edition are marked in some
378 renditions of the document; this paragraph is so marked if the rendition is
379 capable of showing a change indicator.
380 .wen
381
382 This document is very much a reference manual; it is not a tutorial. The reader
383 is expected to have some familiarity with the SMTP mail transfer protocol and
384 with general Unix system administration. Although there are some discussions
385 and examples in places, the information is mostly organized in a way that makes
386 it easy to look up, rather than in a natural order for sequential reading.
387 Furthermore, the manual aims to cover every aspect of Exim in detail, including
388 a number of rarely-used, special-purpose features that are unlikely to be of
389 very wide interest.
390
391 .cindex "books about Exim"
392 An &"easier"& discussion of Exim which provides more in-depth explanatory,
393 introductory, and tutorial material can be found in a book entitled &'The Exim
394 SMTP Mail Server'& (second edition, 2007), published by UIT Cambridge
395 (&url(http://www.uit.co.uk/exim-book/)).
396
397 This book also contains a chapter that gives a general introduction to SMTP and
398 Internet mail. Inevitably, however, the book is unlikely to be fully up-to-date
399 with the latest release of Exim. (Note that the earlier book about Exim,
400 published by O'Reilly, covers Exim 3, and many things have changed in Exim 4.)
401
402 .cindex "Debian" "information sources"
403 If you are using a Debian distribution of Exim, you will find information about
404 Debian-specific features in the file
405 &_/usr/share/doc/exim4-base/README.Debian_&.
406 The command &(man update-exim.conf)& is another source of Debian-specific
407 information.
408
409 .cindex "&_doc/NewStuff_&"
410 .cindex "&_doc/ChangeLog_&"
411 .cindex "change log"
412 As the program develops, there may be features in newer versions that have not
413 yet made it into this document, which is updated only when the most significant
414 digit of the fractional part of the version number changes. Specifications of
415 new features that are not yet in this manual are placed in the file
416 &_doc/NewStuff_& in the Exim distribution.
417
418 Some features may be classified as &"experimental"&. These may change
419 incompatibly while they are developing, or even be withdrawn. For this reason,
420 they are not documented in this manual. Information about experimental features
421 can be found in the file &_doc/experimental.txt_&.
422
423 All changes to the program (whether new features, bug fixes, or other kinds of
424 change) are noted briefly in the file called &_doc/ChangeLog_&.
425
426 .cindex "&_doc/spec.txt_&"
427 This specification itself is available as an ASCII file in &_doc/spec.txt_& so
428 that it can easily be searched with a text editor. Other files in the &_doc_&
429 directory are:
430
431 .table2 100pt
432 .row &_OptionLists.txt_&     "list of all options in alphabetical order"
433 .row &_dbm.discuss.txt_&     "discussion about DBM libraries"
434 .row &_exim.8_&              "a man page of Exim's command line options"
435 .row &_experimental.txt_&    "documentation of experimental features"
436 .row &_filter.txt_&          "specification of the filter language"
437 .row &_Exim3.upgrade_&       "upgrade notes from release 2 to release 3"
438 .row &_Exim4.upgrade_&       "upgrade notes from release 3 to release 4"
439 .row &_openssl.txt_&         "installing a current OpenSSL release"
440 .endtable
441
442 The main specification and the specification of the filtering language are also
443 available in other formats (HTML, PostScript, PDF, and Texinfo). Section
444 &<<SECTavail>>& below tells you how to get hold of these.
445
446
447
448 .section "FTP and web sites" "SECID2"
449 .cindex "web site"
450 .cindex "FTP site"
451 .new
452 The primary site for Exim source distributions is the &%exim.org%& FTP site,
453 available over HTTPS, HTTP and FTP.  These services, and the &%exim.org%&
454 website, are hosted at the University of Cambridge.
455 .wen
456
457 .cindex "wiki"
458 .cindex "FAQ"
459 As well as Exim distribution tar files, the Exim web site contains a number of
460 differently formatted versions of the documentation. A recent addition to the
461 online information is the Exim wiki (&url(http://wiki.exim.org)),
462 which contains what used to be a separate FAQ, as well as various other
463 examples, tips, and know-how that have been contributed by Exim users.
464 .new
465 The wiki site should always redirect to the correct place, which is currently
466 provided by GitHub, and is open to editing by anyone with a GitHub account.
467 .wen
468
469 .cindex Bugzilla
470 An Exim Bugzilla exists at &url(https://bugs.exim.org). You can use
471 this to report bugs, and also to add items to the wish list. Please search
472 first to check that you are not duplicating a previous entry.
473 .new
474 Please do not ask for configuration help in the bug-tracker.
475 .wen
476
477
478 .section "Mailing lists" "SECID3"
479 .cindex "mailing lists" "for Exim users"
480 The following Exim mailing lists exist:
481
482 .table2 140pt
483 .row &'exim-announce@exim.org'&   "Moderated, low volume announcements list"
484 .row &'exim-users@exim.org'&      "General discussion list"
485 .row &'exim-dev@exim.org'&        "Discussion of bugs, enhancements, etc."
486 .row &'exim-cvs@exim.org'&        "Automated commit messages from the VCS"
487 .endtable
488
489 You can subscribe to these lists, change your existing subscriptions, and view
490 or search the archives via the mailing lists link on the Exim home page.
491 .cindex "Debian" "mailing list for"
492 If you are using a Debian distribution of Exim, you may wish to subscribe to
493 the Debian-specific mailing list &'pkg-exim4-users@lists.alioth.debian.org'&
494 via this web page:
495 .display
496 &url(http://lists.alioth.debian.org/mailman/listinfo/pkg-exim4-users)
497 .endd
498 Please ask Debian-specific questions on this list and not on the general Exim
499 lists.
500
501 .section "Bug reports" "SECID5"
502 .cindex "bug reports"
503 .cindex "reporting bugs"
504 Reports of obvious bugs can be emailed to &'bugs@exim.org'& or reported
505 via the Bugzilla (&url(https://bugs.exim.org)). However, if you are unsure
506 whether some behaviour is a bug or not, the best thing to do is to post a
507 message to the &'exim-dev'& mailing list and have it discussed.
508
509
510
511 .section "Where to find the Exim distribution" "SECTavail"
512 .cindex "FTP site"
513 .cindex "HTTPS download site"
514 .cindex "distribution" "ftp site"
515 .cindex "distribution" "https site"
516 .new
517 The master distribution site for the Exim distribution is
518 .display
519 &*https://downloads.exim.org/*&
520 .endd
521 The service is available over HTTPS, HTTP and FTP.
522 We encourage people to migrate to HTTPS.
523
524 The content served at &'https://downloads.exim.org/'& is identical to the
525 content served at &'https://ftp.exim.org/pub/exim'& and
526 &'ftp://ftp.exim.org/pub/exim'&.
527
528 If accessing via a hostname containing &'ftp'&, then the file references that
529 follow are relative to the &_exim_& directories at these sites.
530 If accessing via the hostname &'downloads'& then the subdirectories described
531 here are top-level directories.
532 .wen
533
534 There are now quite a number of independent mirror sites around
535 the world. Those that I know about are listed in the file called &_Mirrors_&.
536
537 Within the top exim directory there are subdirectories called &_exim3_& (for
538 previous Exim 3 distributions), &_exim4_& (for the latest Exim 4
539 distributions), and &_Testing_& for testing versions. In the &_exim4_&
540 subdirectory, the current release can always be found in files called
541 .display
542 &_exim-n.nn.tar.xz_&
543 &_exim-n.nn.tar.gz_&
544 &_exim-n.nn.tar.bz2_&
545 .endd
546 where &'n.nn'& is the highest such version number in the directory. The three
547 files contain identical data; the only difference is the type of compression.
548 .new
549 The &_.xz_& file is usually the smallest, while the &_.gz_& file is the
550 most portable to old systems.
551 .wen
552
553 .cindex "distribution" "signing details"
554 .cindex "distribution" "public key"
555 .cindex "public key for signed distribution"
556 The distributions will be PGP signed by an individual key of the Release
557 Coordinator.  This key will have a uid containing an email address in the
558 &'exim.org'& domain and will have signatures from other people, including
559 other Exim maintainers.  We expect that the key will be in the "strong set" of
560 PGP keys.  There should be a trust path to that key from Nigel Metheringham's
561 PGP key, a version of which can be found in the release directory in the file
562 &_nigel-pubkey.asc_&.  All keys used will be available in public keyserver pools,
563 such as &'pool.sks-keyservers.net'&.
564
565 .new
566 At time of last update, releases were being made by Jeremy Harris and signed
567 with key &'0xBCE58C8CE41F32DF'&.  Other recent keys used for signing are those
568 of Heiko Schlittermann, &'0x26101B62F69376CE'&,
569 and of Phil Pennock, &'0x4D1E900E14C1CC04'&.
570 .wen
571
572 The signatures for the tar bundles are in:
573 .display
574 &_exim-n.nn.tar.xz.asc_&
575 &_exim-n.nn.tar.gz.asc_&
576 &_exim-n.nn.tar.bz2.asc_&
577 .endd
578 For each released version, the log of changes is made separately available in a
579 separate file in the directory &_ChangeLogs_& so that it is possible to
580 find out what has changed without having to download the entire distribution.
581
582 .cindex "documentation" "available formats"
583 The main distribution contains ASCII versions of this specification and other
584 documentation; other formats of the documents are available in separate files
585 inside the &_exim4_& directory of the FTP site:
586 .display
587 &_exim-html-n.nn.tar.gz_&
588 &_exim-pdf-n.nn.tar.gz_&
589 &_exim-postscript-n.nn.tar.gz_&
590 &_exim-texinfo-n.nn.tar.gz_&
591 .endd
592 .new
593 These tar files contain only the &_doc_& directory, not the complete
594 distribution, and are also available in &_.bz2_& and &_.xz_& forms.
595 .wen
596
597
598 .section "Limitations" "SECID6"
599 .ilist
600 .cindex "limitations of Exim"
601 .cindex "bang paths" "not handled by Exim"
602 Exim is designed for use as an Internet MTA, and therefore handles addresses in
603 RFC 2822 domain format only. It cannot handle UUCP &"bang paths"&, though
604 simple two-component bang paths can be converted by a straightforward rewriting
605 configuration. This restriction does not prevent Exim from being interfaced to
606 UUCP as a transport mechanism, provided that domain addresses are used.
607 .next
608 .cindex "domainless addresses"
609 .cindex "address" "without domain"
610 Exim insists that every address it handles has a domain attached. For incoming
611 local messages, domainless addresses are automatically qualified with a
612 configured domain value. Configuration options specify from which remote
613 systems unqualified addresses are acceptable. These are then qualified on
614 arrival.
615 .next
616 .cindex "transport" "external"
617 .cindex "external transports"
618 The only external transport mechanisms that are currently implemented are SMTP
619 and LMTP over a TCP/IP network (including support for IPv6). However, a pipe
620 transport is available, and there are facilities for writing messages to files
621 and pipes, optionally in &'batched SMTP'& format; these facilities can be used
622 to send messages to other transport mechanisms such as UUCP, provided they can
623 handle domain-style addresses. Batched SMTP input is also catered for.
624 .next
625 Exim is not designed for storing mail for dial-in hosts. When the volumes of
626 such mail are large, it is better to get the messages &"delivered"& into files
627 (that is, off Exim's queue) and subsequently passed on to the dial-in hosts by
628 other means.
629 .next
630 Although Exim does have basic facilities for scanning incoming messages, these
631 are not comprehensive enough to do full virus or spam scanning. Such operations
632 are best carried out using additional specialized software packages. If you
633 compile Exim with the content-scanning extension, straightforward interfaces to
634 a number of common scanners are provided.
635 .endlist
636
637
638 .section "Run time configuration" "SECID7"
639 Exim's run time configuration is held in a single text file that is divided
640 into a number of sections. The entries in this file consist of keywords and
641 values, in the style of Smail 3 configuration files. A default configuration
642 file which is suitable for simple online installations is provided in the
643 distribution, and is described in chapter &<<CHAPdefconfil>>& below.
644
645
646 .section "Calling interface" "SECID8"
647 .cindex "Sendmail compatibility" "command line interface"
648 Like many MTAs, Exim has adopted the Sendmail command line interface so that it
649 can be a straight replacement for &_/usr/lib/sendmail_& or
650 &_/usr/sbin/sendmail_& when sending mail, but you do not need to know anything
651 about Sendmail in order to run Exim. For actions other than sending messages,
652 Sendmail-compatible options also exist, but those that produce output (for
653 example, &%-bp%&, which lists the messages on the queue) do so in Exim's own
654 format. There are also some additional options that are compatible with Smail
655 3, and some further options that are new to Exim. Chapter &<<CHAPcommandline>>&
656 documents all Exim's command line options. This information is automatically
657 made into the man page that forms part of the Exim distribution.
658
659 Control of messages on the queue can be done via certain privileged command
660 line options. There is also an optional monitor program called &'eximon'&,
661 which displays current information in an X window, and which contains a menu
662 interface to Exim's command line administration options.
663
664
665
666 .section "Terminology" "SECID9"
667 .cindex "terminology definitions"
668 .cindex "body of message" "definition of"
669 The &'body'& of a message is the actual data that the sender wants to transmit.
670 It is the last part of a message, and is separated from the &'header'& (see
671 below) by a blank line.
672
673 .cindex "bounce message" "definition of"
674 When a message cannot be delivered, it is normally returned to the sender in a
675 delivery failure message or a &"non-delivery report"& (NDR). The term
676 &'bounce'& is commonly used for this action, and the error reports are often
677 called &'bounce messages'&. This is a convenient shorthand for &"delivery
678 failure error report"&. Such messages have an empty sender address in the
679 message's &'envelope'& (see below) to ensure that they cannot themselves give
680 rise to further bounce messages.
681
682 The term &'default'& appears frequently in this manual. It is used to qualify a
683 value which is used in the absence of any setting in the configuration. It may
684 also qualify an action which is taken unless a configuration setting specifies
685 otherwise.
686
687 The term &'defer'& is used when the delivery of a message to a specific
688 destination cannot immediately take place for some reason (a remote host may be
689 down, or a user's local mailbox may be full). Such deliveries are &'deferred'&
690 until a later time.
691
692 The word &'domain'& is sometimes used to mean all but the first component of a
693 host's name. It is &'not'& used in that sense here, where it normally refers to
694 the part of an email address following the @ sign.
695
696 .cindex "envelope, definition of"
697 .cindex "sender" "definition of"
698 A message in transit has an associated &'envelope'&, as well as a header and a
699 body. The envelope contains a sender address (to which bounce messages should
700 be delivered), and any number of recipient addresses. References to the
701 sender or the recipients of a message usually mean the addresses in the
702 envelope. An MTA uses these addresses for delivery, and for returning bounce
703 messages, not the addresses that appear in the header lines.
704
705 .cindex "message" "header, definition of"
706 .cindex "header section" "definition of"
707 The &'header'& of a message is the first part of a message's text, consisting
708 of a number of lines, each of which has a name such as &'From:'&, &'To:'&,
709 &'Subject:'&, etc. Long header lines can be split over several text lines by
710 indenting the continuations. The header is separated from the body by a blank
711 line.
712
713 .cindex "local part" "definition of"
714 .cindex "domain" "definition of"
715 The term &'local part'&, which is taken from RFC 2822, is used to refer to that
716 part of an email address that precedes the @ sign. The part that follows the
717 @ sign is called the &'domain'& or &'mail domain'&.
718
719 .cindex "local delivery" "definition of"
720 .cindex "remote delivery, definition of"
721 The terms &'local delivery'& and &'remote delivery'& are used to distinguish
722 delivery to a file or a pipe on the local host from delivery by SMTP over
723 TCP/IP to another host. As far as Exim is concerned, all hosts other than the
724 host it is running on are &'remote'&.
725
726 .cindex "return path" "definition of"
727 &'Return path'& is another name that is used for the sender address in a
728 message's envelope.
729
730 .cindex "queue" "definition of"
731 The term &'queue'& is used to refer to the set of messages awaiting delivery,
732 because this term is in widespread use in the context of MTAs. However, in
733 Exim's case the reality is more like a pool than a queue, because there is
734 normally no ordering of waiting messages.
735
736 .cindex "queue runner" "definition of"
737 The term &'queue runner'& is used to describe a process that scans the queue
738 and attempts to deliver those messages whose retry times have come. This term
739 is used by other MTAs, and also relates to the command &%runq%&, but in Exim
740 the waiting messages are normally processed in an unpredictable order.
741
742 .cindex "spool directory" "definition of"
743 The term &'spool directory'& is used for a directory in which Exim keeps the
744 messages on its queue &-- that is, those that it is in the process of
745 delivering. This should not be confused with the directory in which local
746 mailboxes are stored, which is called a &"spool directory"& by some people. In
747 the Exim documentation, &"spool"& is always used in the first sense.
748
749
750
751
752
753
754 . ////////////////////////////////////////////////////////////////////////////
755 . ////////////////////////////////////////////////////////////////////////////
756
757 .chapter "Incorporated code" "CHID2"
758 .cindex "incorporated code"
759 .cindex "regular expressions" "library"
760 .cindex "PCRE"
761 .cindex "OpenDMARC"
762 A number of pieces of external code are included in the Exim distribution.
763
764 .ilist
765 Regular expressions are supported in the main Exim program and in the
766 Exim monitor using the freely-distributable PCRE library, copyright
767 &copy; University of Cambridge. The source to PCRE is no longer shipped with
768 Exim, so you will need to use the version of PCRE shipped with your system,
769 or obtain and install the full version of the library from
770 &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre).
771 .next
772 .cindex "cdb" "acknowledgment"
773 Support for the cdb (Constant DataBase) lookup method is provided by code
774 contributed by Nigel Metheringham of (at the time he contributed it) Planet
775 Online Ltd. The implementation is completely contained within the code of Exim.
776 It does not link against an external cdb library. The code contains the
777 following statements:
778
779 .blockquote
780 Copyright &copy; 1998 Nigel Metheringham, Planet Online Ltd
781
782 This program is free software; you can redistribute it and/or modify it under
783 the terms of the GNU General Public License as published by the Free Software
784 Foundation; either version 2 of the License, or (at your option) any later
785 version.
786 This code implements Dan Bernstein's Constant DataBase (cdb) spec. Information,
787 the spec and sample code for cdb can be obtained from
788 &url(http://www.pobox.com/~djb/cdb.html). This implementation borrows
789 some code from Dan Bernstein's implementation (which has no license
790 restrictions applied to it).
791 .endblockquote
792 .next
793 .cindex "SPA authentication"
794 .cindex "Samba project"
795 .cindex "Microsoft Secure Password Authentication"
796 Client support for Microsoft's &'Secure Password Authentication'& is provided
797 by code contributed by Marc Prud'hommeaux. Server support was contributed by
798 Tom Kistner. This includes code taken from the Samba project, which is released
799 under the Gnu GPL.
800 .next
801 .cindex "Cyrus"
802 .cindex "&'pwcheck'& daemon"
803 .cindex "&'pwauthd'& daemon"
804 Support for calling the Cyrus &'pwcheck'& and &'saslauthd'& daemons is provided
805 by code taken from the Cyrus-SASL library and adapted by Alexander S.
806 Sabourenkov. The permission notice appears below, in accordance with the
807 conditions expressed therein.
808
809 .blockquote
810 Copyright &copy; 2001 Carnegie Mellon University.  All rights reserved.
811
812 Redistribution and use in source and binary forms, with or without
813 modification, are permitted provided that the following conditions
814 are met:
815
816 .olist
817 Redistributions of source code must retain the above copyright
818 notice, this list of conditions and the following disclaimer.
819 .next
820 Redistributions in binary form must reproduce the above copyright
821 notice, this list of conditions and the following disclaimer in
822 the documentation and/or other materials provided with the
823 distribution.
824 .next
825 The name &"Carnegie Mellon University"& must not be used to
826 endorse or promote products derived from this software without
827 prior written permission. For permission or any other legal
828 details, please contact
829 .display
830               Office of Technology Transfer
831               Carnegie Mellon University
832               5000 Forbes Avenue
833               Pittsburgh, PA  15213-3890
834               (412) 268-4387, fax: (412) 268-7395
835               tech-transfer@andrew.cmu.edu
836 .endd
837 .next
838 Redistributions of any form whatsoever must retain the following
839 acknowledgment:
840
841 &"This product includes software developed by Computing Services
842 at Carnegie Mellon University (&url(http://www.cmu.edu/computing/)."&
843
844 CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
845 THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
846 AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
847 FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
848 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
849 AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
850 OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
851 .endlist
852 .endblockquote
853
854 .next
855 .cindex "Exim monitor" "acknowledgment"
856 .cindex "X-windows"
857 .cindex "Athena"
858 The Exim Monitor program, which is an X-Window application, includes
859 modified versions of the Athena StripChart and TextPop widgets.
860 This code is copyright by DEC and MIT, and their permission notice appears
861 below, in accordance with the conditions expressed therein.
862
863 .blockquote
864 Copyright 1987, 1988 by Digital Equipment Corporation, Maynard, Massachusetts,
865 and the Massachusetts Institute of Technology, Cambridge, Massachusetts.
866
867 All Rights Reserved
868
869 Permission to use, copy, modify, and distribute this software and its
870 documentation for any purpose and without fee is hereby granted,
871 provided that the above copyright notice appear in all copies and that
872 both that copyright notice and this permission notice appear in
873 supporting documentation, and that the names of Digital or MIT not be
874 used in advertising or publicity pertaining to distribution of the
875 software without specific, written prior permission.
876
877 DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
878 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
879 DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
880 ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
881 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
882 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
883 SOFTWARE.
884 .endblockquote
885
886 .next
887 .cindex "opendmarc" "acknowledgment"
888 The DMARC implementation uses the OpenDMARC library which is Copyrighted by
889 The Trusted Domain Project. Portions of Exim source which use OpenDMARC
890 derived code are indicated in the respective source files. The full OpenDMARC
891 license is provided in the LICENSE.opendmarc file contained in the distributed
892 source code.
893
894 .next
895 Many people have contributed code fragments, some large, some small, that were
896 not covered by any specific licence requirements. It is assumed that the
897 contributors are happy to see their code incorporated into Exim under the GPL.
898 .endlist
899
900
901
902
903
904 . ////////////////////////////////////////////////////////////////////////////
905 . ////////////////////////////////////////////////////////////////////////////
906
907 .chapter "How Exim receives and delivers mail" "CHID11" &&&
908          "Receiving and delivering mail"
909
910
911 .section "Overall philosophy" "SECID10"
912 .cindex "design philosophy"
913 Exim is designed to work efficiently on systems that are permanently connected
914 to the Internet and are handling a general mix of mail. In such circumstances,
915 most messages can be delivered immediately. Consequently, Exim does not
916 maintain independent queues of messages for specific domains or hosts, though
917 it does try to send several messages in a single SMTP connection after a host
918 has been down, and it also maintains per-host retry information.
919
920
921 .section "Policy control" "SECID11"
922 .cindex "policy control" "overview"
923 Policy controls are now an important feature of MTAs that are connected to the
924 Internet. Perhaps their most important job is to stop MTAs being abused as
925 &"open relays"& by misguided individuals who send out vast amounts of
926 unsolicited junk, and want to disguise its source. Exim provides flexible
927 facilities for specifying policy controls on incoming mail:
928
929 .ilist
930 .cindex "&ACL;" "introduction"
931 Exim 4 (unlike previous versions of Exim) implements policy controls on
932 incoming mail by means of &'Access Control Lists'& (ACLs). Each list is a
933 series of statements that may either grant or deny access. ACLs can be used at
934 several places in the SMTP dialogue while receiving a message from a remote
935 host. However, the most common places are after each RCPT command, and at the
936 very end of the message. The sysadmin can specify conditions for accepting or
937 rejecting individual recipients or the entire message, respectively, at these
938 two points (see chapter &<<CHAPACL>>&). Denial of access results in an SMTP
939 error code.
940 .next
941 An ACL is also available for locally generated, non-SMTP messages. In this
942 case, the only available actions are to accept or deny the entire message.
943 .next
944 When Exim is compiled with the content-scanning extension, facilities are
945 provided in the ACL mechanism for passing the message to external virus and/or
946 spam scanning software. The result of such a scan is passed back to the ACL,
947 which can then use it to decide what to do with the message.
948 .next
949 When a message has been received, either from a remote host or from the local
950 host, but before the final acknowledgment has been sent, a locally supplied C
951 function called &[local_scan()]& can be run to inspect the message and decide
952 whether to accept it or not (see chapter &<<CHAPlocalscan>>&). If the message
953 is accepted, the list of recipients can be modified by the function.
954 .next
955 Using the &[local_scan()]& mechanism is another way of calling external scanner
956 software. The &%SA-Exim%& add-on package works this way. It does not require
957 Exim to be compiled with the content-scanning extension.
958 .next
959 After a message has been accepted, a further checking mechanism is available in
960 the form of the &'system filter'& (see chapter &<<CHAPsystemfilter>>&). This
961 runs at the start of every delivery process.
962 .endlist
963
964
965
966 .section "User filters" "SECID12"
967 .cindex "filter" "introduction"
968 .cindex "Sieve filter"
969 In a conventional Exim configuration, users are able to run private filters by
970 setting up appropriate &_.forward_& files in their home directories. See
971 chapter &<<CHAPredirect>>& (about the &(redirect)& router) for the
972 configuration needed to support this, and the separate document entitled
973 &'Exim's interfaces to mail filtering'& for user details. Two different kinds
974 of filtering are available:
975
976 .ilist
977 Sieve filters are written in the standard filtering language that is defined
978 by RFC 3028.
979 .next
980 Exim filters are written in a syntax that is unique to Exim, but which is more
981 powerful than Sieve, which it pre-dates.
982 .endlist
983
984 User filters are run as part of the routing process, described below.
985
986
987
988 .section "Message identification" "SECTmessiden"
989 .cindex "message ids" "details of format"
990 .cindex "format" "of message id"
991 .cindex "id of message"
992 .cindex "base62"
993 .cindex "base36"
994 .cindex "Darwin"
995 .cindex "Cygwin"
996 Every message handled by Exim is given a &'message id'& which is sixteen
997 characters long. It is divided into three parts, separated by hyphens, for
998 example &`16VDhn-0001bo-D3`&. Each part is a sequence of letters and digits,
999 normally encoding numbers in base 62. However, in the Darwin operating
1000 system (Mac OS X) and when Exim is compiled to run under Cygwin, base 36
1001 (avoiding the use of lower case letters) is used instead, because the message
1002 id is used to construct file names, and the names of files in those systems are
1003 not always case-sensitive.
1004
1005 .cindex "pid (process id)" "re-use of"
1006 The detail of the contents of the message id have changed as Exim has evolved.
1007 Earlier versions relied on the operating system not re-using a process id (pid)
1008 within one second. On modern operating systems, this assumption can no longer
1009 be made, so the algorithm had to be changed. To retain backward compatibility,
1010 the format of the message id was retained, which is why the following rules are
1011 somewhat eccentric:
1012
1013 .ilist
1014 The first six characters of the message id are the time at which the message
1015 started to be received, to a granularity of one second. That is, this field
1016 contains the number of seconds since the start of the epoch (the normal Unix
1017 way of representing the date and time of day).
1018 .next
1019 After the first hyphen, the next six characters are the id of the process that
1020 received the message.
1021 .next
1022 There are two different possibilities for the final two characters:
1023 .olist
1024 .oindex "&%localhost_number%&"
1025 If &%localhost_number%& is not set, this value is the fractional part of the
1026 time of reception, normally in units of 1/2000 of a second, but for systems
1027 that must use base 36 instead of base 62 (because of case-insensitive file
1028 systems), the units are 1/1000 of a second.
1029 .next
1030 If &%localhost_number%& is set, it is multiplied by 200 (100) and added to
1031 the fractional part of the time, which in this case is in units of 1/200
1032 (1/100) of a second.
1033 .endlist
1034 .endlist
1035
1036 After a message has been received, Exim waits for the clock to tick at the
1037 appropriate resolution before proceeding, so that if another message is
1038 received by the same process, or by another process with the same (re-used)
1039 pid, it is guaranteed that the time will be different. In most cases, the clock
1040 will already have ticked while the message was being received.
1041
1042
1043 .section "Receiving mail" "SECID13"
1044 .cindex "receiving mail"
1045 .cindex "message" "reception"
1046 The only way Exim can receive mail from another host is using SMTP over
1047 TCP/IP, in which case the sender and recipient addresses are transferred using
1048 SMTP commands. However, from a locally running process (such as a user's MUA),
1049 there are several possibilities:
1050
1051 .ilist
1052 If the process runs Exim with the &%-bm%& option, the message is read
1053 non-interactively (usually via a pipe), with the recipients taken from the
1054 command line, or from the body of the message if &%-t%& is also used.
1055 .next
1056 If the process runs Exim with the &%-bS%& option, the message is also read
1057 non-interactively, but in this case the recipients are listed at the start of
1058 the message in a series of SMTP RCPT commands, terminated by a DATA
1059 command. This is so-called &"batch SMTP"& format,
1060 but it isn't really SMTP. The SMTP commands are just another way of passing
1061 envelope addresses in a non-interactive submission.
1062 .next
1063 If the process runs Exim with the &%-bs%& option, the message is read
1064 interactively, using the SMTP protocol. A two-way pipe is normally used for
1065 passing data between the local process and the Exim process.
1066 This is &"real"& SMTP and is handled in the same way as SMTP over TCP/IP. For
1067 example, the ACLs for SMTP commands are used for this form of submission.
1068 .next
1069 A local process may also make a TCP/IP call to the host's loopback address
1070 (127.0.0.1) or any other of its IP addresses. When receiving messages, Exim
1071 does not treat the loopback address specially. It treats all such connections
1072 in the same way as connections from other hosts.
1073 .endlist
1074
1075
1076 .cindex "message sender, constructed by Exim"
1077 .cindex "sender" "constructed by Exim"
1078 In the three cases that do not involve TCP/IP, the sender address is
1079 constructed from the login name of the user that called Exim and a default
1080 qualification domain (which can be set by the &%qualify_domain%& configuration
1081 option). For local or batch SMTP, a sender address that is passed using the
1082 SMTP MAIL command is ignored. However, the system administrator may allow
1083 certain users (&"trusted users"&) to specify a different sender address
1084 unconditionally, or all users to specify certain forms of different sender
1085 address. The &%-f%& option or the SMTP MAIL command is used to specify these
1086 different addresses. See section &<<SECTtrustedadmin>>& for details of trusted
1087 users, and the &%untrusted_set_sender%& option for a way of allowing untrusted
1088 users to change sender addresses.
1089
1090 Messages received by either of the non-interactive mechanisms are subject to
1091 checking by the non-SMTP ACL, if one is defined. Messages received using SMTP
1092 (either over TCP/IP, or interacting with a local process) can be checked by a
1093 number of ACLs that operate at different times during the SMTP session. Either
1094 individual recipients, or the entire message, can be rejected if local policy
1095 requirements are not met. The &[local_scan()]& function (see chapter
1096 &<<CHAPlocalscan>>&) is run for all incoming messages.
1097
1098 Exim can be configured not to start a delivery process when a message is
1099 received; this can be unconditional, or depend on the number of incoming SMTP
1100 connections or the system load. In these situations, new messages wait on the
1101 queue until a queue runner process picks them up. However, in standard
1102 configurations under normal conditions, delivery is started as soon as a
1103 message is received.
1104
1105
1106
1107
1108
1109 .section "Handling an incoming message" "SECID14"
1110 .cindex "spool directory" "files that hold a message"
1111 .cindex "file" "how a message is held"
1112 When Exim accepts a message, it writes two files in its spool directory. The
1113 first contains the envelope information, the current status of the message, and
1114 the header lines, and the second contains the body of the message. The names of
1115 the two spool files consist of the message id, followed by &`-H`& for the
1116 file containing the envelope and header, and &`-D`& for the data file.
1117
1118 .cindex "spool directory" "&_input_& sub-directory"
1119 By default all these message files are held in a single directory called
1120 &_input_& inside the general Exim spool directory. Some operating systems do
1121 not perform very well if the number of files in a directory gets large; to
1122 improve performance in such cases, the &%split_spool_directory%& option can be
1123 used. This causes Exim to split up the input files into 62 sub-directories
1124 whose names are single letters or digits. When this is done, the queue is
1125 processed one sub-directory at a time instead of all at once, which can improve
1126 overall performance even when there are not enough files in each directory to
1127 affect file system performance.
1128
1129 The envelope information consists of the address of the message's sender and
1130 the addresses of the recipients. This information is entirely separate from
1131 any addresses contained in the header lines. The status of the message includes
1132 a list of recipients who have already received the message. The format of the
1133 first spool file is described in chapter &<<CHAPspool>>&.
1134
1135 .cindex "rewriting" "addresses"
1136 Address rewriting that is specified in the rewrite section of the configuration
1137 (see chapter &<<CHAPrewrite>>&) is done once and for all on incoming addresses,
1138 both in the header lines and the envelope, at the time the message is accepted.
1139 If during the course of delivery additional addresses are generated (for
1140 example, via aliasing), these new addresses are rewritten as soon as they are
1141 generated. At the time a message is actually delivered (transported) further
1142 rewriting can take place; because this is a transport option, it can be
1143 different for different forms of delivery. It is also possible to specify the
1144 addition or removal of certain header lines at the time the message is
1145 delivered (see chapters &<<CHAProutergeneric>>& and
1146 &<<CHAPtransportgeneric>>&).
1147
1148
1149
1150 .section "Life of a message" "SECID15"
1151 .cindex "message" "life of"
1152 .cindex "message" "frozen"
1153 A message remains in the spool directory until it is completely delivered to
1154 its recipients or to an error address, or until it is deleted by an
1155 administrator or by the user who originally created it. In cases when delivery
1156 cannot proceed &-- for example, when a message can neither be delivered to its
1157 recipients nor returned to its sender, the message is marked &"frozen"& on the
1158 spool, and no more deliveries are attempted.
1159
1160 .cindex "frozen messages" "thawing"
1161 .cindex "message" "thawing frozen"
1162 An administrator can &"thaw"& such messages when the problem has been
1163 corrected, and can also freeze individual messages by hand if necessary. In
1164 addition, an administrator can force a delivery error, causing a bounce message
1165 to be sent.
1166
1167 .oindex "&%timeout_frozen_after%&"
1168 .oindex "&%ignore_bounce_errors_after%&"
1169 There are options called &%ignore_bounce_errors_after%& and
1170 &%timeout_frozen_after%&, which discard frozen messages after a certain time.
1171 The first applies only to frozen bounces, the second to any frozen messages.
1172
1173 .cindex "message" "log file for"
1174 .cindex "log" "file for each message"
1175 While Exim is working on a message, it writes information about each delivery
1176 attempt to its main log file. This includes successful, unsuccessful, and
1177 delayed deliveries for each recipient (see chapter &<<CHAPlog>>&). The log
1178 lines are also written to a separate &'message log'& file for each message.
1179 These logs are solely for the benefit of the administrator, and are normally
1180 deleted along with the spool files when processing of a message is complete.
1181 The use of individual message logs can be disabled by setting
1182 &%no_message_logs%&; this might give an improvement in performance on very busy
1183 systems.
1184
1185 .cindex "journal file"
1186 .cindex "file" "journal"
1187 All the information Exim itself needs to set up a delivery is kept in the first
1188 spool file, along with the header lines. When a successful delivery occurs, the
1189 address is immediately written at the end of a journal file, whose name is the
1190 message id followed by &`-J`&. At the end of a delivery run, if there are some
1191 addresses left to be tried again later, the first spool file (the &`-H`& file)
1192 is updated to indicate which these are, and the journal file is then deleted.
1193 Updating the spool file is done by writing a new file and renaming it, to
1194 minimize the possibility of data loss.
1195
1196 Should the system or the program crash after a successful delivery but before
1197 the spool file has been updated, the journal is left lying around. The next
1198 time Exim attempts to deliver the message, it reads the journal file and
1199 updates the spool file before proceeding. This minimizes the chances of double
1200 deliveries caused by crashes.
1201
1202
1203
1204 .section "Processing an address for delivery" "SECTprocaddress"
1205 .cindex "drivers" "definition of"
1206 .cindex "router" "definition of"
1207 .cindex "transport" "definition of"
1208 The main delivery processing elements of Exim are called &'routers'& and
1209 &'transports'&, and collectively these are known as &'drivers'&. Code for a
1210 number of them is provided in the source distribution, and compile-time options
1211 specify which ones are included in the binary. Run time options specify which
1212 ones are actually used for delivering messages.
1213
1214 .cindex "drivers" "instance definition"
1215 Each driver that is specified in the run time configuration is an &'instance'&
1216 of that particular driver type. Multiple instances are allowed; for example,
1217 you can set up several different &(smtp)& transports, each with different
1218 option values that might specify different ports or different timeouts. Each
1219 instance has its own identifying name. In what follows we will normally use the
1220 instance name when discussing one particular instance (that is, one specific
1221 configuration of the driver), and the generic driver name when discussing
1222 the driver's features in general.
1223
1224 A &'router'& is a driver that operates on an address, either determining how
1225 its delivery should happen, by assigning it to a specific transport, or
1226 converting the address into one or more new addresses (for example, via an
1227 alias file). A router may also explicitly choose to fail an address, causing it
1228 to be bounced.
1229
1230 A &'transport'& is a driver that transmits a copy of the message from Exim's
1231 spool to some destination. There are two kinds of transport: for a &'local'&
1232 transport, the destination is a file or a pipe on the local host, whereas for a
1233 &'remote'& transport the destination is some other host. A message is passed
1234 to a specific transport as a result of successful routing. If a message has
1235 several recipients, it may be passed to a number of different transports.
1236
1237 .cindex "preconditions" "definition of"
1238 An address is processed by passing it to each configured router instance in
1239 turn, subject to certain preconditions, until a router accepts the address or
1240 specifies that it should be bounced. We will describe this process in more
1241 detail shortly. First, as a simple example, we consider how each recipient
1242 address in a message is processed in a small configuration of three routers.
1243
1244 To make this a more concrete example, it is described in terms of some actual
1245 routers, but remember, this is only an example. You can configure Exim's
1246 routers in many different ways, and there may be any number of routers in a
1247 configuration.
1248
1249 The first router that is specified in a configuration is often one that handles
1250 addresses in domains that are not recognized specially by the local host. These
1251 are typically addresses for arbitrary domains on the Internet. A precondition
1252 is set up which looks for the special domains known to the host (for example,
1253 its own domain name), and the router is run for addresses that do &'not'&
1254 match. Typically, this is a router that looks up domains in the DNS in order to
1255 find the hosts to which this address routes. If it succeeds, the address is
1256 assigned to a suitable SMTP transport; if it does not succeed, the router is
1257 configured to fail the address.
1258
1259 The second router is reached only when the domain is recognized as one that
1260 &"belongs"& to the local host. This router does redirection &-- also known as
1261 aliasing and forwarding. When it generates one or more new addresses from the
1262 original, each of them is routed independently from the start. Otherwise, the
1263 router may cause an address to fail, or it may simply decline to handle the
1264 address, in which case the address is passed to the next router.
1265
1266 The final router in many configurations is one that checks to see if the
1267 address belongs to a local mailbox. The precondition may involve a check to
1268 see if the local part is the name of a login account, or it may look up the
1269 local part in a file or a database. If its preconditions are not met, or if
1270 the router declines, we have reached the end of the routers. When this happens,
1271 the address is bounced.
1272
1273
1274
1275 .section "Processing an address for verification" "SECID16"
1276 .cindex "router" "for verification"
1277 .cindex "verifying address" "overview"
1278 As well as being used to decide how to deliver to an address, Exim's routers
1279 are also used for &'address verification'&. Verification can be requested as
1280 one of the checks to be performed in an ACL for incoming messages, on both
1281 sender and recipient addresses, and it can be tested using the &%-bv%& and
1282 &%-bvs%& command line options.
1283
1284 When an address is being verified, the routers are run in &"verify mode"&. This
1285 does not affect the way the routers work, but it is a state that can be
1286 detected. By this means, a router can be skipped or made to behave differently
1287 when verifying. A common example is a configuration in which the first router
1288 sends all messages to a message-scanning program, unless they have been
1289 previously scanned. Thus, the first router accepts all addresses without any
1290 checking, making it useless for verifying. Normally, the &%no_verify%& option
1291 would be set for such a router, causing it to be skipped in verify mode.
1292
1293
1294
1295
1296 .section "Running an individual router" "SECTrunindrou"
1297 .cindex "router" "running details"
1298 .cindex "preconditions" "checking"
1299 .cindex "router" "result of running"
1300 As explained in the example above, a number of preconditions are checked before
1301 running a router. If any are not met, the router is skipped, and the address is
1302 passed to the next router. When all the preconditions on a router &'are'& met,
1303 the router is run. What happens next depends on the outcome, which is one of
1304 the following:
1305
1306 .ilist
1307 &'accept'&: The router accepts the address, and either assigns it to a
1308 transport, or generates one or more &"child"& addresses. Processing the
1309 original address ceases,
1310 .oindex "&%unseen%&"
1311 unless the &%unseen%& option is set on the router. This option
1312 can be used to set up multiple deliveries with different routing (for example,
1313 for keeping archive copies of messages). When &%unseen%& is set, the address is
1314 passed to the next router. Normally, however, an &'accept'& return marks the
1315 end of routing.
1316
1317 Any child addresses generated by the router are processed independently,
1318 starting with the first router by default. It is possible to change this by
1319 setting the &%redirect_router%& option to specify which router to start at for
1320 child addresses. Unlike &%pass_router%& (see below) the router specified by
1321 &%redirect_router%& may be anywhere in the router configuration.
1322 .next
1323 &'pass'&: The router recognizes the address, but cannot handle it itself. It
1324 requests that the address be passed to another router. By default the address
1325 is passed to the next router, but this can be changed by setting the
1326 &%pass_router%& option. However, (unlike &%redirect_router%&) the named router
1327 must be below the current router (to avoid loops).
1328 .next
1329 &'decline'&: The router declines to accept the address because it does not
1330 recognize it at all. By default, the address is passed to the next router, but
1331 this can be prevented by setting the &%no_more%& option. When &%no_more%& is
1332 set, all the remaining routers are skipped. In effect, &%no_more%& converts
1333 &'decline'& into &'fail'&.
1334 .next
1335 &'fail'&: The router determines that the address should fail, and queues it for
1336 the generation of a bounce message. There is no further processing of the
1337 original address unless &%unseen%& is set on the router.
1338 .next
1339 &'defer'&: The router cannot handle the address at the present time. (A
1340 database may be offline, or a DNS lookup may have timed out.) No further
1341 processing of the address happens in this delivery attempt. It is tried again
1342 next time the message is considered for delivery.
1343 .next
1344 &'error'&: There is some error in the router (for example, a syntax error in
1345 its configuration). The action is as for defer.
1346 .endlist
1347
1348 If an address reaches the end of the routers without having been accepted by
1349 any of them, it is bounced as unrouteable. The default error message in this
1350 situation is &"unrouteable address"&, but you can set your own message by
1351 making use of the &%cannot_route_message%& option. This can be set for any
1352 router; the value from the last router that &"saw"& the address is used.
1353
1354 Sometimes while routing you want to fail a delivery when some conditions are
1355 met but others are not, instead of passing the address on for further routing.
1356 You can do this by having a second router that explicitly fails the delivery
1357 when the relevant conditions are met. The &(redirect)& router has a &"fail"&
1358 facility for this purpose.
1359
1360
1361 .section "Duplicate addresses" "SECID17"
1362 .cindex "case of local parts"
1363 .cindex "address duplicate, discarding"
1364 .cindex "duplicate addresses"
1365 Once routing is complete, Exim scans the addresses that are assigned to local
1366 and remote transports, and discards any duplicates that it finds. During this
1367 check, local parts are treated as case-sensitive. This happens only when
1368 actually delivering a message; when testing routers with &%-bt%&, all the
1369 routed addresses are shown.
1370
1371
1372
1373 .section "Router preconditions" "SECTrouprecon"
1374 .cindex "router" "preconditions, order of processing"
1375 .cindex "preconditions" "order of processing"
1376 The preconditions that are tested for each router are listed below, in the
1377 order in which they are tested. The individual configuration options are
1378 described in more detail in chapter &<<CHAProutergeneric>>&.
1379
1380 .ilist
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 .next
1411 If the &%domains%& option is set, the domain of the address must be in the set
1412 of domains that it defines.
1413 .next
1414 .vindex "&$local_part_prefix$&"
1415 .vindex "&$local_part$&"
1416 .vindex "&$local_part_suffix$&"
1417 If the &%local_parts%& option is set, the local part of the address must be in
1418 the set of local parts that it defines. If &%local_part_prefix%& or
1419 &%local_part_suffix%& is in use, the prefix or suffix is removed from the local
1420 part before this check. If you want to do precondition tests on local parts
1421 that include affixes, you can do so by using a &%condition%& option (see below)
1422 that uses the variables &$local_part$&, &$local_part_prefix$&, and
1423 &$local_part_suffix$& as necessary.
1424 .next
1425 .vindex "&$local_user_uid$&"
1426 .vindex "&$local_user_gid$&"
1427 .vindex "&$home$&"
1428 If the &%check_local_user%& option is set, the local part must be the name of
1429 an account on the local host. If this check succeeds, the uid and gid of the
1430 local user are placed in &$local_user_uid$& and &$local_user_gid$& and the
1431 user's home directory is placed in &$home$&; these values can be used in the
1432 remaining preconditions.
1433 .next
1434 If the &%router_home_directory%& option is set, it is expanded at this point,
1435 because it overrides the value of &$home$&. If this expansion were left till
1436 later, the value of &$home$& as set by &%check_local_user%& would be used in
1437 subsequent tests. Having two different values of &$home$& in the same router
1438 could lead to confusion.
1439 .next
1440 If the &%senders%& option is set, the envelope sender address must be in the
1441 set of addresses that it defines.
1442 .next
1443 If the &%require_files%& option is set, the existence or non-existence of
1444 specified files is tested.
1445 .next
1446 .cindex "customizing" "precondition"
1447 If the &%condition%& option is set, it is evaluated and tested. This option
1448 uses an expanded string to allow you to set up your own custom preconditions.
1449 Expanded strings are described in chapter &<<CHAPexpand>>&.
1450 .endlist
1451
1452
1453 Note that &%require_files%& comes near the end of the list, so you cannot use
1454 it to check for the existence of a file in which to lookup up a domain, local
1455 part, or sender. However, as these options are all expanded, you can use the
1456 &%exists%& expansion condition to make such tests within each condition. The
1457 &%require_files%& option is intended for checking files that the router may be
1458 going to use internally, or which are needed by a specific transport (for
1459 example, &_.procmailrc_&).
1460
1461
1462
1463 .section "Delivery in detail" "SECID18"
1464 .cindex "delivery" "in detail"
1465 When a message is to be delivered, the sequence of events is as follows:
1466
1467 .ilist
1468 If a system-wide filter file is specified, the message is passed to it. The
1469 filter may add recipients to the message, replace the recipients, discard the
1470 message, cause a new message to be generated, or cause the message delivery to
1471 fail. The format of the system filter file is the same as for Exim user filter
1472 files, described in the separate document entitled &'Exim's interfaces to mail
1473 filtering'&.
1474 .cindex "Sieve filter" "not available for system filter"
1475 (&*Note*&: Sieve cannot be used for system filter files.)
1476
1477 Some additional features are available in system filters &-- see chapter
1478 &<<CHAPsystemfilter>>& for details. Note that a message is passed to the system
1479 filter only once per delivery attempt, however many recipients it has. However,
1480 if there are several delivery attempts because one or more addresses could not
1481 be immediately delivered, the system filter is run each time. The filter
1482 condition &%first_delivery%& can be used to detect the first run of the system
1483 filter.
1484 .next
1485 Each recipient address is offered to each configured router in turn, subject to
1486 its preconditions, until one is able to handle it. If no router can handle the
1487 address, that is, if they all decline, the address is failed. Because routers
1488 can be targeted at particular domains, several locally handled domains can be
1489 processed entirely independently of each other.
1490 .next
1491 .cindex "routing" "loops in"
1492 .cindex "loop" "while routing"
1493 A router that accepts an address may assign it to a local or a remote
1494 transport. However, the transport is not run at this time. Instead, the address
1495 is placed on a list for the particular transport, which will be run later.
1496 Alternatively, the router may generate one or more new addresses (typically
1497 from alias, forward, or filter files). New addresses are fed back into this
1498 process from the top, but in order to avoid loops, a router ignores any address
1499 which has an identically-named ancestor that was processed by itself.
1500 .next
1501 When all the routing has been done, addresses that have been successfully
1502 handled are passed to their assigned transports. When local transports are
1503 doing real local deliveries, they handle only one address at a time, but if a
1504 local transport is being used as a pseudo-remote transport (for example, to
1505 collect batched SMTP messages for transmission by some other means) multiple
1506 addresses can be handled. Remote transports can always handle more than one
1507 address at a time, but can be configured not to do so, or to restrict multiple
1508 addresses to the same domain.
1509 .next
1510 Each local delivery to a file or a pipe runs in a separate process under a
1511 non-privileged uid, and these deliveries are run one at a time. Remote
1512 deliveries also run in separate processes, normally under a uid that is private
1513 to Exim (&"the Exim user"&), but in this case, several remote deliveries can be
1514 run in parallel. The maximum number of simultaneous remote deliveries for any
1515 one message is set by the &%remote_max_parallel%& option.
1516 The order in which deliveries are done is not defined, except that all local
1517 deliveries happen before any remote deliveries.
1518 .next
1519 .cindex "queue runner"
1520 When it encounters a local delivery during a queue run, Exim checks its retry
1521 database to see if there has been a previous temporary delivery failure for the
1522 address before running the local transport. If there was a previous failure,
1523 Exim does not attempt a new delivery until the retry time for the address is
1524 reached. However, this happens only for delivery attempts that are part of a
1525 queue run. Local deliveries are always attempted when delivery immediately
1526 follows message reception, even if retry times are set for them. This makes for
1527 better behaviour if one particular message is causing problems (for example,
1528 causing quota overflow, or provoking an error in a filter file).
1529 .next
1530 .cindex "delivery" "retry in remote transports"
1531 Remote transports do their own retry handling, since an address may be
1532 deliverable to one of a number of hosts, each of which may have a different
1533 retry time. If there have been previous temporary failures and no host has
1534 reached its retry time, no delivery is attempted, whether in a queue run or
1535 not. See chapter &<<CHAPretry>>& for details of retry strategies.
1536 .next
1537 If there were any permanent errors, a bounce message is returned to an
1538 appropriate address (the sender in the common case), with details of the error
1539 for each failing address. Exim can be configured to send copies of bounce
1540 messages to other addresses.
1541 .next
1542 .cindex "delivery" "deferral"
1543 If one or more addresses suffered a temporary failure, the message is left on
1544 the queue, to be tried again later. Delivery of these addresses is said to be
1545 &'deferred'&.
1546 .next
1547 When all the recipient addresses have either been delivered or bounced,
1548 handling of the message is complete. The spool files and message log are
1549 deleted, though the message log can optionally be preserved if required.
1550 .endlist
1551
1552
1553
1554
1555 .section "Retry mechanism" "SECID19"
1556 .cindex "delivery" "retry mechanism"
1557 .cindex "retry" "description of mechanism"
1558 .cindex "queue runner"
1559 Exim's mechanism for retrying messages that fail to get delivered at the first
1560 attempt is the queue runner process. You must either run an Exim daemon that
1561 uses the &%-q%& option with a time interval to start queue runners at regular
1562 intervals, or use some other means (such as &'cron'&) to start them. If you do
1563 not arrange for queue runners to be run, messages that fail temporarily at the
1564 first attempt will remain on your queue for ever. A queue runner process works
1565 its way through the queue, one message at a time, trying each delivery that has
1566 passed its retry time.
1567 You can run several queue runners at once.
1568
1569 Exim uses a set of configured rules to determine when next to retry the failing
1570 address (see chapter &<<CHAPretry>>&). These rules also specify when Exim
1571 should give up trying to deliver to the address, at which point it generates a
1572 bounce message. If no retry rules are set for a particular host, address, and
1573 error combination, no retries are attempted, and temporary errors are treated
1574 as permanent.
1575
1576
1577
1578 .section "Temporary delivery failure" "SECID20"
1579 .cindex "delivery" "temporary failure"
1580 There are many reasons why a message may not be immediately deliverable to a
1581 particular address. Failure to connect to a remote machine (because it, or the
1582 connection to it, is down) is one of the most common. Temporary failures may be
1583 detected during routing as well as during the transport stage of delivery.
1584 Local deliveries may be delayed if NFS files are unavailable, or if a mailbox
1585 is on a file system where the user is over quota. Exim can be configured to
1586 impose its own quotas on local mailboxes; where system quotas are set they will
1587 also apply.
1588
1589 If a host is unreachable for a period of time, a number of messages may be
1590 waiting for it by the time it recovers, and sending them in a single SMTP
1591 connection is clearly beneficial. Whenever a delivery to a remote host is
1592 deferred,
1593 .cindex "hints database" "deferred deliveries"
1594 Exim makes a note in its hints database, and whenever a successful
1595 SMTP delivery has happened, it looks to see if any other messages are waiting
1596 for the same host. If any are found, they are sent over the same SMTP
1597 connection, subject to a configuration limit as to the maximum number in any
1598 one connection.
1599
1600
1601
1602 .section "Permanent delivery failure" "SECID21"
1603 .cindex "delivery" "permanent failure"
1604 .cindex "bounce message" "when generated"
1605 When a message cannot be delivered to some or all of its intended recipients, a
1606 bounce message is generated. Temporary delivery failures turn into permanent
1607 errors when their timeout expires. All the addresses that fail in a given
1608 delivery attempt are listed in a single message. If the original message has
1609 many recipients, it is possible for some addresses to fail in one delivery
1610 attempt and others to fail subsequently, giving rise to more than one bounce
1611 message. The wording of bounce messages can be customized by the administrator.
1612 See chapter &<<CHAPemsgcust>>& for details.
1613
1614 .cindex "&'X-Failed-Recipients:'& header line"
1615 Bounce messages contain an &'X-Failed-Recipients:'& header line that lists the
1616 failed addresses, for the benefit of programs that try to analyse such messages
1617 automatically.
1618
1619 .cindex "bounce message" "recipient of"
1620 A bounce message is normally sent to the sender of the original message, as
1621 obtained from the message's envelope. For incoming SMTP messages, this is the
1622 address given in the MAIL command. However, when an address is expanded via a
1623 forward or alias file, an alternative address can be specified for delivery
1624 failures of the generated addresses. For a mailing list expansion (see section
1625 &<<SECTmailinglists>>&) it is common to direct bounce messages to the manager
1626 of the list.
1627
1628
1629
1630 .section "Failures to deliver bounce messages" "SECID22"
1631 .cindex "bounce message" "failure to deliver"
1632 If a bounce message (either locally generated or received from a remote host)
1633 itself suffers a permanent delivery failure, the message is left on the queue,
1634 but it is frozen, awaiting the attention of an administrator. There are options
1635 that can be used to make Exim discard such failed messages, or to keep them
1636 for only a short time (see &%timeout_frozen_after%& and
1637 &%ignore_bounce_errors_after%&).
1638
1639
1640
1641
1642
1643 . ////////////////////////////////////////////////////////////////////////////
1644 . ////////////////////////////////////////////////////////////////////////////
1645
1646 .chapter "Building and installing Exim" "CHID3"
1647 .scindex IIDbuex "building Exim"
1648
1649 .section "Unpacking" "SECID23"
1650 Exim is distributed as a gzipped or bzipped tar file which, when unpacked,
1651 creates a directory with the name of the current release (for example,
1652 &_exim-&version()_&) into which the following files are placed:
1653
1654 .table2 140pt
1655 .irow &_ACKNOWLEDGMENTS_& "contains some acknowledgments"
1656 .irow &_CHANGES_&         "contains a reference to where changes are &&&
1657   documented"
1658 .irow &_LICENCE_&         "the GNU General Public Licence"
1659 .irow &_Makefile_&        "top-level make file"
1660 .irow &_NOTICE_&          "conditions for the use of Exim"
1661 .irow &_README_&          "list of files, directories and simple build &&&
1662   instructions"
1663 .endtable
1664
1665 Other files whose names begin with &_README_& may also be present. The
1666 following subdirectories are created:
1667
1668 .table2 140pt
1669 .irow &_Local_&           "an empty directory for local configuration files"
1670 .irow &_OS_&              "OS-specific files"
1671 .irow &_doc_&             "documentation files"
1672 .irow &_exim_monitor_&    "source files for the Exim monitor"
1673 .irow &_scripts_&         "scripts used in the build process"
1674 .irow &_src_&             "remaining source files"
1675 .irow &_util_&            "independent utilities"
1676 .endtable
1677
1678 The main utility programs are contained in the &_src_& directory, and are built
1679 with the Exim binary. The &_util_& directory contains a few optional scripts
1680 that may be useful to some sites.
1681
1682
1683 .section "Multiple machine architectures and operating systems" "SECID24"
1684 .cindex "building Exim" "multiple OS/architectures"
1685 The building process for Exim is arranged to make it easy to build binaries for
1686 a number of different architectures and operating systems from the same set of
1687 source files. Compilation does not take place in the &_src_& directory.
1688 Instead, a &'build directory'& is created for each architecture and operating
1689 system.
1690 .cindex "symbolic link" "to build directory"
1691 Symbolic links to the sources are installed in this directory, which is where
1692 the actual building takes place. In most cases, Exim can discover the machine
1693 architecture and operating system for itself, but the defaults can be
1694 overridden if necessary.
1695 .cindex compiler requirements
1696 .cindex compiler version
1697 A C99-capable compiler will be required for the build.
1698
1699
1700 .section "PCRE library" "SECTpcre"
1701 .cindex "PCRE library"
1702 Exim no longer has an embedded PCRE library as the vast majority of
1703 modern systems include PCRE as a system library, although you may need
1704 to install the PCRE or PCRE development package for your operating
1705 system. If your system has a normal PCRE installation the Exim build
1706 process will need no further configuration. If the library or the
1707 headers are in an unusual location you will need to either set the PCRE_LIBS
1708 and INCLUDE directives appropriately,
1709 or set PCRE_CONFIG=yes to use the installed &(pcre-config)& command.
1710 If your operating system has no
1711 PCRE support then you will need to obtain and build the current PCRE
1712 from &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/).
1713 More information on PCRE is available at &url(http://www.pcre.org/).
1714
1715 .section "DBM libraries" "SECTdb"
1716 .cindex "DBM libraries" "discussion of"
1717 .cindex "hints database" "DBM files used for"
1718 Even if you do not use any DBM files in your configuration, Exim still needs a
1719 DBM library in order to operate, because it uses indexed files for its hints
1720 databases. Unfortunately, there are a number of DBM libraries in existence, and
1721 different operating systems often have different ones installed.
1722
1723 .cindex "Solaris" "DBM library for"
1724 .cindex "IRIX, DBM library for"
1725 .cindex "BSD, DBM library for"
1726 .cindex "Linux, DBM library for"
1727 If you are using Solaris, IRIX, one of the modern BSD systems, or a modern
1728 Linux distribution, the DBM configuration should happen automatically, and you
1729 may be able to ignore this section. Otherwise, you may have to learn more than
1730 you would like about DBM libraries from what follows.
1731
1732 .cindex "&'ndbm'& DBM library"
1733 Licensed versions of Unix normally contain a library of DBM functions operating
1734 via the &'ndbm'& interface, and this is what Exim expects by default. Free
1735 versions of Unix seem to vary in what they contain as standard. In particular,
1736 some early versions of Linux have no default DBM library, and different
1737 distributors have chosen to bundle different libraries with their packaged
1738 versions. However, the more recent releases seem to have standardized on the
1739 Berkeley DB library.
1740
1741 Different DBM libraries have different conventions for naming the files they
1742 use. When a program opens a file called &_dbmfile_&, there are several
1743 possibilities:
1744
1745 .olist
1746 A traditional &'ndbm'& implementation, such as that supplied as part of
1747 Solaris, operates on two files called &_dbmfile.dir_& and &_dbmfile.pag_&.
1748 .next
1749 .cindex "&'gdbm'& DBM library"
1750 The GNU library, &'gdbm'&, operates on a single file. If used via its &'ndbm'&
1751 compatibility interface it makes two different hard links to it with names
1752 &_dbmfile.dir_& and &_dbmfile.pag_&, but if used via its native interface, the
1753 file name is used unmodified.
1754 .next
1755 .cindex "Berkeley DB library"
1756 The Berkeley DB package, if called via its &'ndbm'& compatibility interface,
1757 operates on a single file called &_dbmfile.db_&, but otherwise looks to the
1758 programmer exactly the same as the traditional &'ndbm'& implementation.
1759 .next
1760 If the Berkeley package is used in its native mode, it operates on a single
1761 file called &_dbmfile_&; the programmer's interface is somewhat different to
1762 the traditional &'ndbm'& interface.
1763 .next
1764 To complicate things further, there are several very different versions of the
1765 Berkeley DB package. Version 1.85 was stable for a very long time, releases
1766 2.&'x'& and 3.&'x'& were current for a while, but the latest versions are now
1767 numbered 4.&'x'&. Maintenance of some of the earlier releases has ceased. All
1768 versions of Berkeley DB can be obtained from
1769 &url(http://www.sleepycat.com/).
1770 .next
1771 .cindex "&'tdb'& DBM library"
1772 Yet another DBM library, called &'tdb'&, is available from
1773 &url(http://download.sourceforge.net/tdb). It has its own interface, and also
1774 operates on a single file.
1775 .endlist
1776
1777 .cindex "USE_DB"
1778 .cindex "DBM libraries" "configuration for building"
1779 Exim and its utilities can be compiled to use any of these interfaces. In order
1780 to use any version of the Berkeley DB package in native mode, you must set
1781 USE_DB in an appropriate configuration file (typically
1782 &_Local/Makefile_&). For example:
1783 .code
1784 USE_DB=yes
1785 .endd
1786 Similarly, for gdbm you set USE_GDBM, and for tdb you set USE_TDB. An
1787 error is diagnosed if you set more than one of these.
1788
1789 At the lowest level, the build-time configuration sets none of these options,
1790 thereby assuming an interface of type (1). However, some operating system
1791 configuration files (for example, those for the BSD operating systems and
1792 Linux) assume type (4) by setting USE_DB as their default, and the
1793 configuration files for Cygwin set USE_GDBM. Anything you set in
1794 &_Local/Makefile_&, however, overrides these system defaults.
1795
1796 As well as setting USE_DB, USE_GDBM, or USE_TDB, it may also be
1797 necessary to set DBMLIB, to cause inclusion of the appropriate library, as
1798 in one of these lines:
1799 .code
1800 DBMLIB = -ldb
1801 DBMLIB = -ltdb
1802 .endd
1803 Settings like that will work if the DBM library is installed in the standard
1804 place. Sometimes it is not, and the library's header file may also not be in
1805 the default path. You may need to set INCLUDE to specify where the header
1806 file is, and to specify the path to the library more fully in DBMLIB, as in
1807 this example:
1808 .code
1809 INCLUDE=-I/usr/local/include/db-4.1
1810 DBMLIB=/usr/local/lib/db-4.1/libdb.a
1811 .endd
1812 There is further detailed discussion about the various DBM libraries in the
1813 file &_doc/dbm.discuss.txt_& in the Exim distribution.
1814
1815
1816
1817 .section "Pre-building configuration" "SECID25"
1818 .cindex "building Exim" "pre-building configuration"
1819 .cindex "configuration for building Exim"
1820 .cindex "&_Local/Makefile_&"
1821 .cindex "&_src/EDITME_&"
1822 Before building Exim, a local configuration file that specifies options
1823 independent of any operating system has to be created with the name
1824 &_Local/Makefile_&. A template for this file is supplied as the file
1825 &_src/EDITME_&, and it contains full descriptions of all the option settings
1826 therein. These descriptions are therefore not repeated here. If you are
1827 building Exim for the first time, the simplest thing to do is to copy
1828 &_src/EDITME_& to &_Local/Makefile_&, then read it and edit it appropriately.
1829
1830 There are three settings that you must supply, because Exim will not build
1831 without them. They are the location of the run time configuration file
1832 (CONFIGURE_FILE), the directory in which Exim binaries will be installed
1833 (BIN_DIRECTORY), and the identity of the Exim user (EXIM_USER and
1834 maybe EXIM_GROUP as well). The value of CONFIGURE_FILE can in fact be
1835 a colon-separated list of file names; Exim uses the first of them that exists.
1836
1837 There are a few other parameters that can be specified either at build time or
1838 at run time, to enable the same binary to be used on a number of different
1839 machines. However, if the locations of Exim's spool directory and log file
1840 directory (if not within the spool directory) are fixed, it is recommended that
1841 you specify them in &_Local/Makefile_& instead of at run time, so that errors
1842 detected early in Exim's execution (such as a malformed configuration file) can
1843 be logged.
1844
1845 .cindex "content scanning" "specifying at build time"
1846 Exim's interfaces for calling virus and spam scanning software directly from
1847 access control lists are not compiled by default. If you want to include these
1848 facilities, you need to set
1849 .code
1850 WITH_CONTENT_SCAN=yes
1851 .endd
1852 in your &_Local/Makefile_&. For details of the facilities themselves, see
1853 chapter &<<CHAPexiscan>>&.
1854
1855
1856 .cindex "&_Local/eximon.conf_&"
1857 .cindex "&_exim_monitor/EDITME_&"
1858 If you are going to build the Exim monitor, a similar configuration process is
1859 required. The file &_exim_monitor/EDITME_& must be edited appropriately for
1860 your installation and saved under the name &_Local/eximon.conf_&. If you are
1861 happy with the default settings described in &_exim_monitor/EDITME_&,
1862 &_Local/eximon.conf_& can be empty, but it must exist.
1863
1864 This is all the configuration that is needed in straightforward cases for known
1865 operating systems. However, the building process is set up so that it is easy
1866 to override options that are set by default or by operating-system-specific
1867 configuration files, for example to change the name of the C compiler, which
1868 defaults to &%gcc%&. See section &<<SECToverride>>& below for details of how to
1869 do this.
1870
1871
1872
1873 .section "Support for iconv()" "SECID26"
1874 .cindex "&[iconv()]& support"
1875 .cindex "RFC 2047"
1876 The contents of header lines in messages may be encoded according to the rules
1877 described RFC 2047. This makes it possible to transmit characters that are not
1878 in the ASCII character set, and to label them as being in a particular
1879 character set. When Exim is inspecting header lines by means of the &%$h_%&
1880 mechanism, it decodes them, and translates them into a specified character set
1881 (default is set at build time). The translation is possible only if the operating system
1882 supports the &[iconv()]& function.
1883
1884 However, some of the operating systems that supply &[iconv()]& do not support
1885 very many conversions. The GNU &%libiconv%& library (available from
1886 &url(http://www.gnu.org/software/libiconv/)) can be installed on such
1887 systems to remedy this deficiency, as well as on systems that do not supply
1888 &[iconv()]& at all. After installing &%libiconv%&, you should add
1889 .code
1890 HAVE_ICONV=yes
1891 .endd
1892 to your &_Local/Makefile_& and rebuild Exim.
1893
1894
1895
1896 .section "Including TLS/SSL encryption support" "SECTinctlsssl"
1897 .cindex "TLS" "including support for TLS"
1898 .cindex "encryption" "including support for"
1899 .cindex "SUPPORT_TLS"
1900 .cindex "OpenSSL" "building Exim with"
1901 .cindex "GnuTLS" "building Exim with"
1902 Exim can be built to support encrypted SMTP connections, using the STARTTLS
1903 command as per RFC 2487. It can also support legacy clients that expect to
1904 start a TLS session immediately on connection to a non-standard port (see the
1905 &%tls_on_connect_ports%& runtime option and the &%-tls-on-connect%& command
1906 line option).
1907
1908 If you want to build Exim with TLS support, you must first install either the
1909 OpenSSL or GnuTLS library. There is no cryptographic code in Exim itself for
1910 implementing SSL.
1911
1912 If OpenSSL is installed, you should set
1913 .code
1914 SUPPORT_TLS=yes
1915 TLS_LIBS=-lssl -lcrypto
1916 .endd
1917 in &_Local/Makefile_&. You may also need to specify the locations of the
1918 OpenSSL library and include files. For example:
1919 .code
1920 SUPPORT_TLS=yes
1921 TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
1922 TLS_INCLUDE=-I/usr/local/openssl/include/
1923 .endd
1924 .cindex "pkg-config" "OpenSSL"
1925 If you have &'pkg-config'& available, then instead you can just use:
1926 .code
1927 SUPPORT_TLS=yes
1928 USE_OPENSSL_PC=openssl
1929 .endd
1930 .cindex "USE_GNUTLS"
1931 If GnuTLS is installed, you should set
1932 .code
1933 SUPPORT_TLS=yes
1934 USE_GNUTLS=yes
1935 TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
1936 .endd
1937 in &_Local/Makefile_&, and again you may need to specify the locations of the
1938 library and include files. For example:
1939 .code
1940 SUPPORT_TLS=yes
1941 USE_GNUTLS=yes
1942 TLS_LIBS=-L/usr/gnu/lib -lgnutls -ltasn1 -lgcrypt
1943 TLS_INCLUDE=-I/usr/gnu/include
1944 .endd
1945 .cindex "pkg-config" "GnuTLS"
1946 If you have &'pkg-config'& available, then instead you can just use:
1947 .code
1948 SUPPORT_TLS=yes
1949 USE_GNUTLS=yes
1950 USE_GNUTLS_PC=gnutls
1951 .endd
1952
1953 You do not need to set TLS_INCLUDE if the relevant directory is already
1954 specified in INCLUDE. Details of how to configure Exim to make use of TLS are
1955 given in chapter &<<CHAPTLS>>&.
1956
1957
1958
1959
1960 .section "Use of tcpwrappers" "SECID27"
1961
1962 .cindex "tcpwrappers, building Exim to support"
1963 .cindex "USE_TCP_WRAPPERS"
1964 .cindex "TCP_WRAPPERS_DAEMON_NAME"
1965 .cindex "tcp_wrappers_daemon_name"
1966 Exim can be linked with the &'tcpwrappers'& library in order to check incoming
1967 SMTP calls using the &'tcpwrappers'& control files. This may be a convenient
1968 alternative to Exim's own checking facilities for installations that are
1969 already making use of &'tcpwrappers'& for other purposes. To do this, you
1970 should set USE_TCP_WRAPPERS in &_Local/Makefile_&, arrange for the file
1971 &_tcpd.h_& to be available at compile time, and also ensure that the library
1972 &_libwrap.a_& is available at link time, typically by including &%-lwrap%& in
1973 EXTRALIBS_EXIM. For example, if &'tcpwrappers'& is installed in &_/usr/local_&,
1974 you might have
1975 .code
1976 USE_TCP_WRAPPERS=yes
1977 CFLAGS=-O -I/usr/local/include
1978 EXTRALIBS_EXIM=-L/usr/local/lib -lwrap
1979 .endd
1980 in &_Local/Makefile_&. The daemon name to use in the &'tcpwrappers'& control
1981 files is &"exim"&. For example, the line
1982 .code
1983 exim : LOCAL  192.168.1.  .friendly.domain.example
1984 .endd
1985 in your &_/etc/hosts.allow_& file allows connections from the local host, from
1986 the subnet 192.168.1.0/24, and from all hosts in &'friendly.domain.example'&.
1987 All other connections are denied. The daemon name used by &'tcpwrappers'&
1988 can be changed at build time by setting TCP_WRAPPERS_DAEMON_NAME in
1989 &_Local/Makefile_&, or by setting tcp_wrappers_daemon_name in the
1990 configure file. Consult the &'tcpwrappers'& documentation for
1991 further details.
1992
1993
1994 .section "Including support for IPv6" "SECID28"
1995 .cindex "IPv6" "including support for"
1996 Exim contains code for use on systems that have IPv6 support. Setting
1997 &`HAVE_IPV6=YES`& in &_Local/Makefile_& causes the IPv6 code to be included;
1998 it may also be necessary to set IPV6_INCLUDE and IPV6_LIBS on systems
1999 where the IPv6 support is not fully integrated into the normal include and
2000 library files.
2001
2002 Two different types of DNS record for handling IPv6 addresses have been
2003 defined. AAAA records (analogous to A records for IPv4) are in use, and are
2004 currently seen as the mainstream. Another record type called A6 was proposed
2005 as better than AAAA because it had more flexibility. However, it was felt to be
2006 over-complex, and its status was reduced to &"experimental"&.
2007 Exim used to
2008 have a compile option for including A6 record support but this has now been
2009 withdrawn.
2010
2011
2012
2013 .section "Dynamically loaded lookup module support" "SECTdynamicmodules"
2014 .cindex "lookup modules"
2015 .cindex "dynamic modules"
2016 .cindex ".so building"
2017 On some platforms, Exim supports not compiling all lookup types directly into
2018 the main binary, instead putting some into external modules which can be loaded
2019 on demand.
2020 This permits packagers to build Exim with support for lookups with extensive
2021 library dependencies without requiring all users to install all of those
2022 dependencies.
2023 Most, but not all, lookup types can be built this way.
2024
2025 Set &`LOOKUP_MODULE_DIR`& to the directory into which the modules will be
2026 installed; Exim will only load modules from that directory, as a security
2027 measure.  You will need to set &`CFLAGS_DYNAMIC`& if not already defined
2028 for your OS; see &_OS/Makefile-Linux_& for an example.
2029 Some other requirements for adjusting &`EXTRALIBS`& may also be necessary,
2030 see &_src/EDITME_& for details.
2031
2032 Then, for each module to be loaded dynamically, define the relevant
2033 &`LOOKUP_`&<&'lookup_type'&> flags to have the value "2" instead of "yes".
2034 For example, this will build in lsearch but load sqlite and mysql support
2035 on demand:
2036 .code
2037 LOOKUP_LSEARCH=yes
2038 LOOKUP_SQLITE=2
2039 LOOKUP_MYSQL=2
2040 .endd
2041
2042
2043 .section "The building process" "SECID29"
2044 .cindex "build directory"
2045 Once &_Local/Makefile_& (and &_Local/eximon.conf_&, if required) have been
2046 created, run &'make'& at the top level. It determines the architecture and
2047 operating system types, and creates a build directory if one does not exist.
2048 For example, on a Sun system running Solaris 8, the directory
2049 &_build-SunOS5-5.8-sparc_& is created.
2050 .cindex "symbolic link" "to source files"
2051 Symbolic links to relevant source files are installed in the build directory.
2052
2053 If this is the first time &'make'& has been run, it calls a script that builds
2054 a make file inside the build directory, using the configuration files from the
2055 &_Local_& directory. The new make file is then passed to another instance of
2056 &'make'&. This does the real work, building a number of utility scripts, and
2057 then compiling and linking the binaries for the Exim monitor (if configured), a
2058 number of utility programs, and finally Exim itself. The command &`make
2059 makefile`& can be used to force a rebuild of the make file in the build
2060 directory, should this ever be necessary.
2061
2062 If you have problems building Exim, check for any comments there may be in the
2063 &_README_& file concerning your operating system, and also take a look at the
2064 FAQ, where some common problems are covered.
2065
2066
2067
2068 .section 'Output from &"make"&' "SECID283"
2069 The output produced by the &'make'& process for compile lines is often very
2070 unreadable, because these lines can be very long. For this reason, the normal
2071 output is suppressed by default, and instead output similar to that which
2072 appears when compiling the 2.6 Linux kernel is generated: just a short line for
2073 each module that is being compiled or linked. However, it is still possible to
2074 get the full output, by calling &'make'& like this:
2075 .code
2076 FULLECHO='' make -e
2077 .endd
2078 The value of FULLECHO defaults to &"@"&, the flag character that suppresses
2079 command reflection in &'make'&. When you ask for the full output, it is
2080 given in addition to the short output.
2081
2082
2083
2084 .section "Overriding build-time options for Exim" "SECToverride"
2085 .cindex "build-time options, overriding"
2086 The main make file that is created at the beginning of the building process
2087 consists of the concatenation of a number of files which set configuration
2088 values, followed by a fixed set of &'make'& instructions. If a value is set
2089 more than once, the last setting overrides any previous ones. This provides a
2090 convenient way of overriding defaults. The files that are concatenated are, in
2091 order:
2092 .display
2093 &_OS/Makefile-Default_&
2094 &_OS/Makefile-_&<&'ostype'&>
2095 &_Local/Makefile_&
2096 &_Local/Makefile-_&<&'ostype'&>
2097 &_Local/Makefile-_&<&'archtype'&>
2098 &_Local/Makefile-_&<&'ostype'&>-<&'archtype'&>
2099 &_OS/Makefile-Base_&
2100 .endd
2101 .cindex "&_Local/Makefile_&"
2102 .cindex "building Exim" "operating system type"
2103 .cindex "building Exim" "architecture type"
2104 where <&'ostype'&> is the operating system type and <&'archtype'&> is the
2105 architecture type. &_Local/Makefile_& is required to exist, and the building
2106 process fails if it is absent. The other three &_Local_& files are optional,
2107 and are often not needed.
2108
2109 The values used for <&'ostype'&> and <&'archtype'&> are obtained from scripts
2110 called &_scripts/os-type_& and &_scripts/arch-type_& respectively. If either of
2111 the environment variables EXIM_OSTYPE or EXIM_ARCHTYPE is set, their
2112 values are used, thereby providing a means of forcing particular settings.
2113 Otherwise, the scripts try to get values from the &%uname%& command. If this
2114 fails, the shell variables OSTYPE and ARCHTYPE are inspected. A number
2115 of &'ad hoc'& transformations are then applied, to produce the standard names
2116 that Exim expects. You can run these scripts directly from the shell in order
2117 to find out what values are being used on your system.
2118
2119
2120 &_OS/Makefile-Default_& contains comments about the variables that are set
2121 therein. Some (but not all) are mentioned below. If there is something that
2122 needs changing, review the contents of this file and the contents of the make
2123 file for your operating system (&_OS/Makefile-<ostype>_&) to see what the
2124 default values are.
2125
2126
2127 .cindex "building Exim" "overriding default settings"
2128 If you need to change any of the values that are set in &_OS/Makefile-Default_&
2129 or in &_OS/Makefile-<ostype>_&, or to add any new definitions, you do not
2130 need to change the original files. Instead, you should make the changes by
2131 putting the new values in an appropriate &_Local_& file. For example,
2132 .cindex "Tru64-Unix build-time settings"
2133 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2134 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2135 compiler is called &'cc'& rather than &'gcc'&. Also, the compiler must be
2136 called with the option &%-std1%&, to make it recognize some of the features of
2137 Standard C that Exim uses. (Most other compilers recognize Standard C by
2138 default.) To do this, you should create a file called &_Local/Makefile-OSF1_&
2139 containing the lines
2140 .code
2141 CC=cc
2142 CFLAGS=-std1
2143 .endd
2144 If you are compiling for just one operating system, it may be easier to put
2145 these lines directly into &_Local/Makefile_&.
2146
2147 Keeping all your local configuration settings separate from the distributed
2148 files makes it easy to transfer them to new versions of Exim simply by copying
2149 the contents of the &_Local_& directory.
2150
2151
2152 .cindex "NIS lookup type" "including support for"
2153 .cindex "NIS+ lookup type" "including support for"
2154 .cindex "LDAP" "including support for"
2155 .cindex "lookup" "inclusion in binary"
2156 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2157 lookup, but not all systems have these components installed, so the default is
2158 not to include the relevant code in the binary. All the different kinds of file
2159 and database lookup that Exim supports are implemented as separate code modules
2160 which are included only if the relevant compile-time options are set. In the
2161 case of LDAP, NIS, and NIS+, the settings for &_Local/Makefile_& are:
2162 .code
2163 LOOKUP_LDAP=yes
2164 LOOKUP_NIS=yes
2165 LOOKUP_NISPLUS=yes
2166 .endd
2167 and similar settings apply to the other lookup types. They are all listed in
2168 &_src/EDITME_&. In many cases the relevant include files and interface
2169 libraries need to be installed before compiling Exim.
2170 .cindex "cdb" "including support for"
2171 However, there are some optional lookup types (such as cdb) for which
2172 the code is entirely contained within Exim, and no external include
2173 files or libraries are required. When a lookup type is not included in the
2174 binary, attempts to configure Exim to use it cause run time configuration
2175 errors.
2176
2177 .cindex "pkg-config" "lookups"
2178 .cindex "pkg-config" "authenticators"
2179 Many systems now use a tool called &'pkg-config'& to encapsulate information
2180 about how to compile against a library; Exim has some initial support for
2181 being able to use pkg-config for lookups and authenticators.  For any given
2182 makefile variable which starts &`LOOKUP_`& or &`AUTH_`&, you can add a new
2183 variable with the &`_PC`& suffix in the name and assign as the value the
2184 name of the package to be queried.  The results of querying via the
2185 &'pkg-config'& command will be added to the appropriate Makefile variables
2186 with &`+=`& directives, so your version of &'make'& will need to support that
2187 syntax.  For instance:
2188 .code
2189 LOOKUP_SQLITE=yes
2190 LOOKUP_SQLITE_PC=sqlite3
2191 AUTH_GSASL=yes
2192 AUTH_GSASL_PC=libgsasl
2193 AUTH_HEIMDAL_GSSAPI=yes
2194 AUTH_HEIMDAL_GSSAPI_PC=heimdal-gssapi
2195 .endd
2196
2197 .cindex "Perl" "including support for"
2198 Exim can be linked with an embedded Perl interpreter, allowing Perl
2199 subroutines to be called during string expansion. To enable this facility,
2200 .code
2201 EXIM_PERL=perl.o
2202 .endd
2203 must be defined in &_Local/Makefile_&. Details of this facility are given in
2204 chapter &<<CHAPperl>>&.
2205
2206 .cindex "X11 libraries, location of"
2207 The location of the X11 libraries is something that varies a lot between
2208 operating systems, and there may be different versions of X11 to cope
2209 with. Exim itself makes no use of X11, but if you are compiling the Exim
2210 monitor, the X11 libraries must be available.
2211 The following three variables are set in &_OS/Makefile-Default_&:
2212 .code
2213 X11=/usr/X11R6
2214 XINCLUDE=-I$(X11)/include
2215 XLFLAGS=-L$(X11)/lib
2216 .endd
2217 These are overridden in some of the operating-system configuration files. For
2218 example, in &_OS/Makefile-SunOS5_& there is
2219 .code
2220 X11=/usr/openwin
2221 XINCLUDE=-I$(X11)/include
2222 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2223 .endd
2224 If you need to override the default setting for your operating system, place a
2225 definition of all three of these variables into your
2226 &_Local/Makefile-<ostype>_& file.
2227
2228 .cindex "EXTRALIBS"
2229 If you need to add any extra libraries to the link steps, these can be put in a
2230 variable called EXTRALIBS, which appears in all the link commands, but by
2231 default is not defined. In contrast, EXTRALIBS_EXIM is used only on the
2232 command for linking the main Exim binary, and not for any associated utilities.
2233
2234 .cindex "DBM libraries" "configuration for building"
2235 There is also DBMLIB, which appears in the link commands for binaries that
2236 use DBM functions (see also section &<<SECTdb>>&). Finally, there is
2237 EXTRALIBS_EXIMON, which appears only in the link step for the Exim monitor
2238 binary, and which can be used, for example, to include additional X11
2239 libraries.
2240
2241 .cindex "configuration file" "editing"
2242 The make file copes with rebuilding Exim correctly if any of the configuration
2243 files are edited. However, if an optional configuration file is deleted, it is
2244 necessary to touch the associated non-optional file (that is,
2245 &_Local/Makefile_& or &_Local/eximon.conf_&) before rebuilding.
2246
2247
2248 .section "OS-specific header files" "SECID30"
2249 .cindex "&_os.h_&"
2250 .cindex "building Exim" "OS-specific C header files"
2251 The &_OS_& directory contains a number of files with names of the form
2252 &_os.h-<ostype>_&. These are system-specific C header files that should not
2253 normally need to be changed. There is a list of macro settings that are
2254 recognized in the file &_OS/os.configuring_&, which should be consulted if you
2255 are porting Exim to a new operating system.
2256
2257
2258
2259 .section "Overriding build-time options for the monitor" "SECID31"
2260 .cindex "building Eximon"
2261 A similar process is used for overriding things when building the Exim monitor,
2262 where the files that are involved are
2263 .display
2264 &_OS/eximon.conf-Default_&
2265 &_OS/eximon.conf-_&<&'ostype'&>
2266 &_Local/eximon.conf_&
2267 &_Local/eximon.conf-_&<&'ostype'&>
2268 &_Local/eximon.conf-_&<&'archtype'&>
2269 &_Local/eximon.conf-_&<&'ostype'&>-<&'archtype'&>
2270 .endd
2271 .cindex "&_Local/eximon.conf_&"
2272 As with Exim itself, the final three files need not exist, and in this case the
2273 &_OS/eximon.conf-<ostype>_& file is also optional. The default values in
2274 &_OS/eximon.conf-Default_& can be overridden dynamically by setting environment
2275 variables of the same name, preceded by EXIMON_. For example, setting
2276 EXIMON_LOG_DEPTH in the environment overrides the value of
2277 LOG_DEPTH at run time.
2278 .ecindex IIDbuex
2279
2280
2281 .section "Installing Exim binaries and scripts" "SECID32"
2282 .cindex "installing Exim"
2283 .cindex "BIN_DIRECTORY"
2284 The command &`make install`& runs the &(exim_install)& script with no
2285 arguments. The script copies binaries and utility scripts into the directory
2286 whose name is specified by the BIN_DIRECTORY setting in &_Local/Makefile_&.
2287 .cindex "setuid" "installing Exim with"
2288 The install script copies files only if they are newer than the files they are
2289 going to replace. The Exim binary is required to be owned by root and have the
2290 &'setuid'& bit set, for normal configurations. Therefore, you must run &`make
2291 install`& as root so that it can set up the Exim binary in this way. However, in
2292 some special situations (for example, if a host is doing no local deliveries)
2293 it may be possible to run Exim without making the binary setuid root (see
2294 chapter &<<CHAPsecurity>>& for details).
2295
2296 .cindex "CONFIGURE_FILE"
2297 Exim's run time configuration file is named by the CONFIGURE_FILE setting
2298 in &_Local/Makefile_&. If this names a single file, and the file does not
2299 exist, the default configuration file &_src/configure.default_& is copied there
2300 by the installation script. If a run time configuration file already exists, it
2301 is left alone. If CONFIGURE_FILE is a colon-separated list, naming several
2302 alternative files, no default is installed.
2303
2304 .cindex "system aliases file"
2305 .cindex "&_/etc/aliases_&"
2306 One change is made to the default configuration file when it is installed: the
2307 default configuration contains a router that references a system aliases file.
2308 The path to this file is set to the value specified by
2309 SYSTEM_ALIASES_FILE in &_Local/Makefile_& (&_/etc/aliases_& by default).
2310 If the system aliases file does not exist, the installation script creates it,
2311 and outputs a comment to the user.
2312
2313 The created file contains no aliases, but it does contain comments about the
2314 aliases a site should normally have. Mail aliases have traditionally been
2315 kept in &_/etc/aliases_&. However, some operating systems are now using
2316 &_/etc/mail/aliases_&. You should check if yours is one of these, and change
2317 Exim's configuration if necessary.
2318
2319 The default configuration uses the local host's name as the only local domain,
2320 and is set up to do local deliveries into the shared directory &_/var/mail_&,
2321 running as the local user. System aliases and &_.forward_& files in users' home
2322 directories are supported, but no NIS or NIS+ support is configured. Domains
2323 other than the name of the local host are routed using the DNS, with delivery
2324 over SMTP.
2325
2326 It is possible to install Exim for special purposes (such as building a binary
2327 distribution) in a private part of the file system. You can do this by a
2328 command such as
2329 .code
2330 make DESTDIR=/some/directory/ install
2331 .endd
2332 This has the effect of pre-pending the specified directory to all the file
2333 paths, except the name of the system aliases file that appears in the default
2334 configuration. (If a default alias file is created, its name &'is'& modified.)
2335 For backwards compatibility, ROOT is used if DESTDIR is not set,
2336 but this usage is deprecated.
2337
2338 .cindex "installing Exim" "what is not installed"
2339 Running &'make install'& does not copy the Exim 4 conversion script
2340 &'convert4r4'&. You will probably run this only once if you are
2341 upgrading from Exim 3. None of the documentation files in the &_doc_&
2342 directory are copied, except for the info files when you have set
2343 INFO_DIRECTORY, as described in section &<<SECTinsinfdoc>>& below.
2344
2345 For the utility programs, old versions are renamed by adding the suffix &_.O_&
2346 to their names. The Exim binary itself, however, is handled differently. It is
2347 installed under a name that includes the version number and the compile number,
2348 for example &_exim-&version()-1_&. The script then arranges for a symbolic link
2349 called &_exim_& to point to the binary. If you are updating a previous version
2350 of Exim, the script takes care to ensure that the name &_exim_& is never absent
2351 from the directory (as seen by other processes).
2352
2353 .cindex "installing Exim" "testing the script"
2354 If you want to see what the &'make install'& will do before running it for
2355 real, you can pass the &%-n%& option to the installation script by this
2356 command:
2357 .code
2358 make INSTALL_ARG=-n install
2359 .endd
2360 The contents of the variable INSTALL_ARG are passed to the installation
2361 script. You do not need to be root to run this test. Alternatively, you can run
2362 the installation script directly, but this must be from within the build
2363 directory. For example, from the top-level Exim directory you could use this
2364 command:
2365 .code
2366 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
2367 .endd
2368 .cindex "installing Exim" "install script options"
2369 There are two other options that can be supplied to the installation script.
2370
2371 .ilist
2372 &%-no_chown%& bypasses the call to change the owner of the installed binary
2373 to root, and the call to make it a setuid binary.
2374 .next
2375 &%-no_symlink%& bypasses the setting up of the symbolic link &_exim_& to the
2376 installed binary.
2377 .endlist
2378
2379 INSTALL_ARG can be used to pass these options to the script. For example:
2380 .code
2381 make INSTALL_ARG=-no_symlink install
2382 .endd
2383 The installation script can also be given arguments specifying which files are
2384 to be copied. For example, to install just the Exim binary, and nothing else,
2385 without creating the symbolic link, you could use:
2386 .code
2387 make INSTALL_ARG='-no_symlink exim' install
2388 .endd
2389
2390
2391
2392 .section "Installing info documentation" "SECTinsinfdoc"
2393 .cindex "installing Exim" "&'info'& documentation"
2394 Not all systems use the GNU &'info'& system for documentation, and for this
2395 reason, the Texinfo source of Exim's documentation is not included in the main
2396 distribution. Instead it is available separately from the ftp site (see section
2397 &<<SECTavail>>&).
2398
2399 If you have defined INFO_DIRECTORY in &_Local/Makefile_& and the Texinfo
2400 source of the documentation is found in the source tree, running &`make
2401 install`& automatically builds the info files and installs them.
2402
2403
2404
2405 .section "Setting up the spool directory" "SECID33"
2406 .cindex "spool directory" "creating"
2407 When it starts up, Exim tries to create its spool directory if it does not
2408 exist. The Exim uid and gid are used for the owner and group of the spool
2409 directory. Sub-directories are automatically created in the spool directory as
2410 necessary.
2411
2412
2413
2414
2415 .section "Testing" "SECID34"
2416 .cindex "testing" "installation"
2417 Having installed Exim, you can check that the run time configuration file is
2418 syntactically valid by running the following command, which assumes that the
2419 Exim binary directory is within your PATH environment variable:
2420 .code
2421 exim -bV
2422 .endd
2423 If there are any errors in the configuration file, Exim outputs error messages.
2424 Otherwise it outputs the version number and build date,
2425 the DBM library that is being used, and information about which drivers and
2426 other optional code modules are included in the binary.
2427 Some simple routing tests can be done by using the address testing option. For
2428 example,
2429 .display
2430 &`exim -bt`& <&'local username'&>
2431 .endd
2432 should verify that it recognizes a local mailbox, and
2433 .display
2434 &`exim -bt`& <&'remote address'&>
2435 .endd
2436 a remote one. Then try getting it to deliver mail, both locally and remotely.
2437 This can be done by passing messages directly to Exim, without going through a
2438 user agent. For example:
2439 .code
2440 exim -v postmaster@your.domain.example
2441 From: user@your.domain.example
2442 To: postmaster@your.domain.example
2443 Subject: Testing Exim
2444
2445 This is a test message.
2446 ^D
2447 .endd
2448 The &%-v%& option causes Exim to output some verification of what it is doing.
2449 In this case you should see copies of three log lines, one for the message's
2450 arrival, one for its delivery, and one containing &"Completed"&.
2451
2452 .cindex "delivery" "problems with"
2453 If you encounter problems, look at Exim's log files (&'mainlog'& and
2454 &'paniclog'&) to see if there is any relevant information there. Another source
2455 of information is running Exim with debugging turned on, by specifying the
2456 &%-d%& option. If a message is stuck on Exim's spool, you can force a delivery
2457 with debugging turned on by a command of the form
2458 .display
2459 &`exim -d -M`& <&'exim-message-id'&>
2460 .endd
2461 You must be root or an &"admin user"& in order to do this. The &%-d%& option
2462 produces rather a lot of output, but you can cut this down to specific areas.
2463 For example, if you use &%-d-all+route%& only the debugging information
2464 relevant to routing is included. (See the &%-d%& option in chapter
2465 &<<CHAPcommandline>>& for more details.)
2466
2467 .cindex '&"sticky"& bit'
2468 .cindex "lock files"
2469 One specific problem that has shown up on some sites is the inability to do
2470 local deliveries into a shared mailbox directory, because it does not have the
2471 &"sticky bit"& set on it. By default, Exim tries to create a lock file before
2472 writing to a mailbox file, and if it cannot create the lock file, the delivery
2473 is deferred. You can get round this either by setting the &"sticky bit"& on the
2474 directory, or by setting a specific group for local deliveries and allowing
2475 that group to create files in the directory (see the comments above the
2476 &(local_delivery)& transport in the default configuration file). Another
2477 approach is to configure Exim not to use lock files, but just to rely on
2478 &[fcntl()]& locking instead. However, you should do this only if all user
2479 agents also use &[fcntl()]& locking. For further discussion of locking issues,
2480 see chapter &<<CHAPappendfile>>&.
2481
2482 One thing that cannot be tested on a system that is already running an MTA is
2483 the receipt of incoming SMTP mail on the standard SMTP port. However, the
2484 &%-oX%& option can be used to run an Exim daemon that listens on some other
2485 port, or &'inetd'& can be used to do this. The &%-bh%& option and the
2486 &'exim_checkaccess'& utility can be used to check out policy controls on
2487 incoming SMTP mail.
2488
2489 Testing a new version on a system that is already running Exim can most easily
2490 be done by building a binary with a different CONFIGURE_FILE setting. From
2491 within the run time configuration, all other file and directory names
2492 that Exim uses can be altered, in order to keep it entirely clear of the
2493 production version.
2494
2495
2496 .section "Replacing another MTA with Exim" "SECID35"
2497 .cindex "replacing another MTA"
2498 Building and installing Exim for the first time does not of itself put it in
2499 general use. The name by which the system's MTA is called by mail user agents
2500 is either &_/usr/sbin/sendmail_&, or &_/usr/lib/sendmail_& (depending on the
2501 operating system), and it is necessary to make this name point to the &'exim'&
2502 binary in order to get the user agents to pass messages to Exim. This is
2503 normally done by renaming any existing file and making &_/usr/sbin/sendmail_&
2504 or &_/usr/lib/sendmail_&
2505 .cindex "symbolic link" "to &'exim'& binary"
2506 a symbolic link to the &'exim'& binary. It is a good idea to remove any setuid
2507 privilege and executable status from the old MTA. It is then necessary to stop
2508 and restart the mailer daemon, if one is running.
2509
2510 .cindex "FreeBSD, MTA indirection"
2511 .cindex "&_/etc/mail/mailer.conf_&"
2512 Some operating systems have introduced alternative ways of switching MTAs. For
2513 example, if you are running FreeBSD, you need to edit the file
2514 &_/etc/mail/mailer.conf_& instead of setting up a symbolic link as just
2515 described. A typical example of the contents of this file for running Exim is
2516 as follows:
2517 .code
2518 sendmail            /usr/exim/bin/exim
2519 send-mail           /usr/exim/bin/exim
2520 mailq               /usr/exim/bin/exim -bp
2521 newaliases          /usr/bin/true
2522 .endd
2523 Once you have set up the symbolic link, or edited &_/etc/mail/mailer.conf_&,
2524 your Exim installation is &"live"&. Check it by sending a message from your
2525 favourite user agent.
2526
2527 You should consider what to tell your users about the change of MTA. Exim may
2528 have different capabilities to what was previously running, and there are
2529 various operational differences such as the text of messages produced by
2530 command line options and in bounce messages. If you allow your users to make
2531 use of Exim's filtering capabilities, you should make the document entitled
2532 &'Exim's interface to mail filtering'& available to them.
2533
2534
2535
2536 .section "Upgrading Exim" "SECID36"
2537 .cindex "upgrading Exim"
2538 If you are already running Exim on your host, building and installing a new
2539 version automatically makes it available to MUAs, or any other programs that
2540 call the MTA directly. However, if you are running an Exim daemon, you do need
2541 to send it a HUP signal, to make it re-execute itself, and thereby pick up the
2542 new binary. You do not need to stop processing mail in order to install a new
2543 version of Exim. The install script does not modify an existing runtime
2544 configuration file.
2545
2546
2547
2548
2549 .section "Stopping the Exim daemon on Solaris" "SECID37"
2550 .cindex "Solaris" "stopping Exim on"
2551 The standard command for stopping the mailer daemon on Solaris is
2552 .code
2553 /etc/init.d/sendmail stop
2554 .endd
2555 If &_/usr/lib/sendmail_& has been turned into a symbolic link, this script
2556 fails to stop Exim because it uses the command &'ps -e'& and greps the output
2557 for the text &"sendmail"&; this is not present because the actual program name
2558 (that is, &"exim"&) is given by the &'ps'& command with these options. A
2559 solution is to replace the line that finds the process id with something like
2560 .code
2561 pid=`cat /var/spool/exim/exim-daemon.pid`
2562 .endd
2563 to obtain the daemon's pid directly from the file that Exim saves it in.
2564
2565 Note, however, that stopping the daemon does not &"stop Exim"&. Messages can
2566 still be received from local processes, and if automatic delivery is configured
2567 (the normal case), deliveries will still occur.
2568
2569
2570
2571
2572 . ////////////////////////////////////////////////////////////////////////////
2573 . ////////////////////////////////////////////////////////////////////////////
2574
2575 .chapter "The Exim command line" "CHAPcommandline"
2576 .scindex IIDclo1 "command line" "options"
2577 .scindex IIDclo2 "options" "command line"
2578 Exim's command line takes the standard Unix form of a sequence of options,
2579 each starting with a hyphen character, followed by a number of arguments. The
2580 options are compatible with the main options of Sendmail, and there are also
2581 some additional options, some of which are compatible with Smail 3. Certain
2582 combinations of options do not make sense, and provoke an error if used.
2583 The form of the arguments depends on which options are set.
2584
2585
2586 .section "Setting options by program name" "SECID38"
2587 .cindex "&'mailq'&"
2588 If Exim is called under the name &'mailq'&, it behaves as if the option &%-bp%&
2589 were present before any other options.
2590 The &%-bp%& option requests a listing of the contents of the mail queue on the
2591 standard output.
2592 This feature is for compatibility with some systems that contain a command of
2593 that name in one of the standard libraries, symbolically linked to
2594 &_/usr/sbin/sendmail_& or &_/usr/lib/sendmail_&.
2595
2596 .cindex "&'rsmtp'&"
2597 If Exim is called under the name &'rsmtp'& it behaves as if the option &%-bS%&
2598 were present before any other options, for compatibility with Smail. The
2599 &%-bS%& option is used for reading in a number of messages in batched SMTP
2600 format.
2601
2602 .cindex "&'rmail'&"
2603 If Exim is called under the name &'rmail'& it behaves as if the &%-i%& and
2604 &%-oee%& options were present before any other options, for compatibility with
2605 Smail. The name &'rmail'& is used as an interface by some UUCP systems.
2606
2607 .cindex "&'runq'&"
2608 .cindex "queue runner"
2609 If Exim is called under the name &'runq'& it behaves as if the option &%-q%&
2610 were present before any other options, for compatibility with Smail. The &%-q%&
2611 option causes a single queue runner process to be started.
2612
2613 .cindex "&'newaliases'&"
2614 .cindex "alias file" "building"
2615 .cindex "Sendmail compatibility" "calling Exim as &'newaliases'&"
2616 If Exim is called under the name &'newaliases'& it behaves as if the option
2617 &%-bi%& were present before any other options, for compatibility with Sendmail.
2618 This option is used for rebuilding Sendmail's alias file. Exim does not have
2619 the concept of a single alias file, but can be configured to run a given
2620 command if called with the &%-bi%& option.
2621
2622
2623 .section "Trusted and admin users" "SECTtrustedadmin"
2624 Some Exim options are available only to &'trusted users'& and others are
2625 available only to &'admin users'&. In the description below, the phrases &"Exim
2626 user"& and &"Exim group"& mean the user and group defined by EXIM_USER and
2627 EXIM_GROUP in &_Local/Makefile_& or set by the &%exim_user%& and
2628 &%exim_group%& options. These do not necessarily have to use the name &"exim"&.
2629
2630 .ilist
2631 .cindex "trusted users" "definition of"
2632 .cindex "user" "trusted definition of"
2633 The trusted users are root, the Exim user, any user listed in the
2634 &%trusted_users%& configuration option, and any user whose current group or any
2635 supplementary group is one of those listed in the &%trusted_groups%&
2636 configuration option. Note that the Exim group is not automatically trusted.
2637
2638 .cindex '&"From"& line'
2639 .cindex "envelope sender"
2640 Trusted users are always permitted to use the &%-f%& option or a leading
2641 &"From&~"& line to specify the envelope sender of a message that is passed to
2642 Exim through the local interface (see the &%-bm%& and &%-f%& options below).
2643 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
2644 users to set envelope senders.
2645
2646 .cindex "&'From:'& header line"
2647 .cindex "&'Sender:'& header line"
2648 .cindex "header lines" "From:"
2649 .cindex "header lines" "Sender:"
2650 For a trusted user, there is never any check on the contents of the &'From:'&
2651 header line, and a &'Sender:'& line is never added. Furthermore, any existing
2652 &'Sender:'& line in incoming local (non-TCP/IP) messages is not removed.
2653
2654 Trusted users may also specify a host name, host address, interface address,
2655 protocol name, ident value, and authentication data when submitting a message
2656 locally. Thus, they are able to insert messages into Exim's queue locally that
2657 have the characteristics of messages received from a remote host. Untrusted
2658 users may in some circumstances use &%-f%&, but can never set the other values
2659 that are available to trusted users.
2660 .next
2661 .cindex "user" "admin definition of"
2662 .cindex "admin user" "definition of"
2663 The admin users are root, the Exim user, and any user that is a member of the
2664 Exim group or of any group listed in the &%admin_groups%& configuration option.
2665 The current group does not have to be one of these groups.
2666
2667 Admin users are permitted to list the queue, and to carry out certain
2668 operations on messages, for example, to force delivery failures. It is also
2669 necessary to be an admin user in order to see the full information provided by
2670 the Exim monitor, and full debugging output.
2671
2672 By default, the use of the &%-M%&, &%-q%&, &%-R%&, and &%-S%& options to cause
2673 Exim to attempt delivery of messages on its queue is restricted to admin users.
2674 However, this restriction can be relaxed by setting the &%prod_requires_admin%&
2675 option false (that is, specifying &%no_prod_requires_admin%&).
2676
2677 Similarly, the use of the &%-bp%& option to list all the messages in the queue
2678 is restricted to admin users unless &%queue_list_requires_admin%& is set
2679 false.
2680 .endlist
2681
2682
2683 &*Warning*&: If you configure your system so that admin users are able to
2684 edit Exim's configuration file, you are giving those users an easy way of
2685 getting root. There is further discussion of this issue at the start of chapter
2686 &<<CHAPconf>>&.
2687
2688
2689
2690
2691 .section "Command line options" "SECID39"
2692 Exim's command line options are described in alphabetical order below. If none
2693 of the options that specifies a specific action (such as starting the daemon or
2694 a queue runner, or testing an address, or receiving a message in a specific
2695 format, or listing the queue) are present, and there is at least one argument
2696 on the command line, &%-bm%& (accept a local message on the standard input,
2697 with the arguments specifying the recipients) is assumed. Otherwise, Exim
2698 outputs a brief message about itself and exits.
2699
2700 . ////////////////////////////////////////////////////////////////////////////
2701 . Insert a stylized XML comment here, to identify the start of the command line
2702 . options. This is for the benefit of the Perl script that automatically
2703 . creates a man page for the options.
2704 . ////////////////////////////////////////////////////////////////////////////
2705
2706 .literal xml
2707 <!-- === Start of command line options === -->
2708 .literal off
2709
2710
2711 .vlist
2712 .vitem &%--%&
2713 .oindex "--"
2714 .cindex "options" "command line; terminating"
2715 This is a pseudo-option whose only purpose is to terminate the options and
2716 therefore to cause subsequent command line items to be treated as arguments
2717 rather than options, even if they begin with hyphens.
2718
2719 .vitem &%--help%&
2720 .oindex "&%--help%&"
2721 This option causes Exim to output a few sentences stating what it is.
2722 The same output is generated if the Exim binary is called with no options and
2723 no arguments.
2724
2725 .vitem &%--version%&
2726 .oindex "&%--version%&"
2727 This option is an alias for &%-bV%& and causes version information to be
2728 displayed.
2729
2730 .vitem &%-Ac%& &&&
2731        &%-Am%&
2732 .oindex "&%-Ac%&"
2733 .oindex "&%-Am%&"
2734 These options are used by Sendmail for selecting configuration files and are
2735 ignored by Exim.
2736
2737 .vitem &%-B%&<&'type'&>
2738 .oindex "&%-B%&"
2739 .cindex "8-bit characters"
2740 .cindex "Sendmail compatibility" "8-bit characters"
2741 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2742 clean; it ignores this option.
2743
2744 .vitem &%-bd%&
2745 .oindex "&%-bd%&"
2746 .cindex "daemon"
2747 .cindex "SMTP" "listener"
2748 .cindex "queue runner"
2749 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2750 the &%-bd%& option is combined with the &%-q%&<&'time'&> option, to specify
2751 that the daemon should also initiate periodic queue runs.
2752
2753 The &%-bd%& option can be used only by an admin user. If either of the &%-d%&
2754 (debugging) or &%-v%& (verifying) options are set, the daemon does not
2755 disconnect from the controlling terminal. When running this way, it can be
2756 stopped by pressing ctrl-C.
2757
2758 By default, Exim listens for incoming connections to the standard SMTP port on
2759 all the host's running interfaces. However, it is possible to listen on other
2760 ports, on multiple ports, and only on specific interfaces. Chapter
2761 &<<CHAPinterfaces>>& contains a description of the options that control this.
2762
2763 When a listening daemon
2764 .cindex "daemon" "process id (pid)"
2765 .cindex "pid (process id)" "of daemon"
2766 is started without the use of &%-oX%& (that is, without overriding the normal
2767 configuration), it writes its process id to a file called &_exim-daemon.pid_&
2768 in Exim's spool directory. This location can be overridden by setting
2769 PID_FILE_PATH in &_Local/Makefile_&. The file is written while Exim is still
2770 running as root.
2771
2772 When &%-oX%& is used on the command line to start a listening daemon, the
2773 process id is not written to the normal pid file path. However, &%-oP%& can be
2774 used to specify a path on the command line if a pid file is required.
2775
2776 The SIGHUP signal
2777 .cindex "SIGHUP"
2778 .cindex "daemon" "restarting"
2779 can be used to cause the daemon to re-execute itself. This should be done
2780 whenever Exim's configuration file, or any file that is incorporated into it by
2781 means of the &%.include%& facility, is changed, and also whenever a new version
2782 of Exim is installed. It is not necessary to do this when other files that are
2783 referenced from the configuration (for example, alias files) are changed,
2784 because these are reread each time they are used.
2785
2786 .vitem &%-bdf%&
2787 .oindex "&%-bdf%&"
2788 This option has the same effect as &%-bd%& except that it never disconnects
2789 from the controlling terminal, even when no debugging is specified.
2790
2791 .vitem &%-be%&
2792 .oindex "&%-be%&"
2793 .cindex "testing" "string expansion"
2794 .cindex "expansion" "testing"
2795 Run Exim in expansion testing mode. Exim discards its root privilege, to
2796 prevent ordinary users from using this mode to read otherwise inaccessible
2797 files. If no arguments are given, Exim runs interactively, prompting for lines
2798 of data. Otherwise, it processes each argument in turn.
2799
2800 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2801 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2802 used without command line arguments. If successful, it uses the &[readline()]&
2803 function, which provides extensive line-editing facilities, for reading the
2804 test data. A line history is supported.
2805
2806 Long expansion expressions can be split over several lines by using backslash
2807 continuations. As in Exim's run time configuration, white space at the start of
2808 continuation lines is ignored. Each argument or data line is passed through the
2809 string expansion mechanism, and the result is output. Variable values from the
2810 configuration file (for example, &$qualify_domain$&) are available, but no
2811 message-specific values (such as &$message_exim_id$&) are set, because no message
2812 is being processed (but see &%-bem%& and &%-Mset%&).
2813
2814 &*Note*&: If you use this mechanism to test lookups, and you change the data
2815 files or databases you are using, you must exit and restart Exim before trying
2816 the same lookup again. Otherwise, because each Exim process caches the results
2817 of lookups, you will just get the same result as before.
2818
2819 Macro processing is done on lines before string-expansion: new macros can be
2820 defined and macros will be expanded.
2821 Because macros in the config file are often used for secrets, those are only
2822 available to admin users.
2823
2824 .vitem &%-bem%&&~<&'filename'&>
2825 .oindex "&%-bem%&"
2826 .cindex "testing" "string expansion"
2827 .cindex "expansion" "testing"
2828 This option operates like &%-be%& except that it must be followed by the name
2829 of a file. For example:
2830 .code
2831 exim -bem /tmp/testmessage
2832 .endd
2833 The file is read as a message (as if receiving a locally-submitted non-SMTP
2834 message) before any of the test expansions are done. Thus, message-specific
2835 variables such as &$message_size$& and &$header_from:$& are available. However,
2836 no &'Received:'& header is added to the message. If the &%-t%& option is set,
2837 recipients are read from the headers in the normal way, and are shown in the
2838 &$recipients$& variable. Note that recipients cannot be given on the command
2839 line, because further arguments are taken as strings to expand (just like
2840 &%-be%&).
2841
2842 .vitem &%-bF%&&~<&'filename'&>
2843 .oindex "&%-bF%&"
2844 .cindex "system filter" "testing"
2845 .cindex "testing" "system filter"
2846 This option is the same as &%-bf%& except that it assumes that the filter being
2847 tested is a system filter. The additional commands that are available only in
2848 system filters are recognized.
2849
2850 .vitem &%-bf%&&~<&'filename'&>
2851 .oindex "&%-bf%&"
2852 .cindex "filter" "testing"
2853 .cindex "testing" "filter file"
2854 .cindex "forward file" "testing"
2855 .cindex "testing" "forward file"
2856 .cindex "Sieve filter" "testing"
2857 This option runs Exim in user filter testing mode; the file is the filter file
2858 to be tested, and a test message must be supplied on the standard input. If
2859 there are no message-dependent tests in the filter, an empty file can be
2860 supplied.
2861
2862 If you want to test a system filter file, use &%-bF%& instead of &%-bf%&. You
2863 can use both &%-bF%& and &%-bf%& on the same command, in order to test a system
2864 filter and a user filter in the same run. For example:
2865 .code
2866 exim -bF /system/filter -bf /user/filter </test/message
2867 .endd
2868 This is helpful when the system filter adds header lines or sets filter
2869 variables that are used by the user filter.
2870
2871 If the test filter file does not begin with one of the special lines
2872 .code
2873 # Exim filter
2874 # Sieve filter
2875 .endd
2876 it is taken to be a normal &_.forward_& file, and is tested for validity under
2877 that interpretation. See sections &<<SECTitenonfilred>>& to
2878 &<<SECTspecitredli>>& for a description of the possible contents of non-filter
2879 redirection lists.
2880
2881 The result of an Exim command that uses &%-bf%&, provided no errors are
2882 detected, is a list of the actions that Exim would try to take if presented
2883 with the message for real. More details of filter testing are given in the
2884 separate document entitled &'Exim's interfaces to mail filtering'&.
2885
2886 When testing a filter file,
2887 .cindex "&""From""& line"
2888 .cindex "envelope sender"
2889 .oindex "&%-f%&" "for filter testing"
2890 the envelope sender can be set by the &%-f%& option,
2891 or by a &"From&~"& line at the start of the test message. Various parameters
2892 that would normally be taken from the envelope recipient address of the message
2893 can be set by means of additional command line options (see the next four
2894 options).
2895
2896 .vitem &%-bfd%&&~<&'domain'&>
2897 .oindex "&%-bfd%&"
2898 .vindex "&$qualify_domain$&"
2899 This sets the domain of the recipient address when a filter file is being
2900 tested by means of the &%-bf%& option. The default is the value of
2901 &$qualify_domain$&.
2902
2903 .vitem &%-bfl%&&~<&'local&~part'&>
2904 .oindex "&%-bfl%&"
2905 This sets the local part of the recipient address when a filter file is being
2906 tested by means of the &%-bf%& option. The default is the username of the
2907 process that calls Exim. A local part should be specified with any prefix or
2908 suffix stripped, because that is how it appears to the filter when a message is
2909 actually being delivered.
2910
2911 .vitem &%-bfp%&&~<&'prefix'&>
2912 .oindex "&%-bfp%&"
2913 This sets the prefix of the local part of the recipient address when a filter
2914 file is being tested by means of the &%-bf%& option. The default is an empty
2915 prefix.
2916
2917 .vitem &%-bfs%&&~<&'suffix'&>
2918 .oindex "&%-bfs%&"
2919 This sets the suffix of the local part of the recipient address when a filter
2920 file is being tested by means of the &%-bf%& option. The default is an empty
2921 suffix.
2922
2923 .vitem &%-bh%&&~<&'IP&~address'&>
2924 .oindex "&%-bh%&"
2925 .cindex "testing" "incoming SMTP"
2926 .cindex "SMTP" "testing incoming"
2927 .cindex "testing" "relay control"
2928 .cindex "relaying" "testing configuration"
2929 .cindex "policy control" "testing"
2930 .cindex "debugging" "&%-bh%& option"
2931 This option runs a fake SMTP session as if from the given IP address, using the
2932 standard input and output. The IP address may include a port number at the end,
2933 after a full stop. For example:
2934 .code
2935 exim -bh 10.9.8.7.1234
2936 exim -bh fe80::a00:20ff:fe86:a061.5678
2937 .endd
2938 When an IPv6 address is given, it is converted into canonical form. In the case
2939 of the second example above, the value of &$sender_host_address$& after
2940 conversion to the canonical form is
2941 &`fe80:0000:0000:0a00:20ff:fe86:a061.5678`&.
2942
2943 Comments as to what is going on are written to the standard error file. These
2944 include lines beginning with &"LOG"& for anything that would have been logged.
2945 This facility is provided for testing configuration options for incoming
2946 messages, to make sure they implement the required policy. For example, you can
2947 test your relay controls using &%-bh%&.
2948
2949 &*Warning 1*&:
2950 .cindex "RFC 1413"
2951 You can test features of the configuration that rely on ident (RFC 1413)
2952 information by using the &%-oMt%& option. However, Exim cannot actually perform
2953 an ident callout when testing using &%-bh%& because there is no incoming SMTP
2954 connection.
2955
2956 &*Warning 2*&: Address verification callouts (see section &<<SECTcallver>>&)
2957 are also skipped when testing using &%-bh%&. If you want these callouts to
2958 occur, use &%-bhc%& instead.
2959
2960 Messages supplied during the testing session are discarded, and nothing is
2961 written to any of the real log files. There may be pauses when DNS (and other)
2962 lookups are taking place, and of course these may time out. The &%-oMi%& option
2963 can be used to specify a specific IP interface and port if this is important,
2964 and &%-oMaa%& and &%-oMai%& can be used to set parameters as if the SMTP
2965 session were authenticated.
2966
2967 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%& whose
2968 output just states whether a given recipient address from a given host is
2969 acceptable or not. See section &<<SECTcheckaccess>>&.
2970
2971 Features such as authentication and encryption, where the client input is not
2972 plain text, cannot easily be tested with &%-bh%&. Instead, you should use a
2973 specialized SMTP test program such as
2974 &url(http://jetmore.org/john/code/#swaks,swaks).
2975
2976 .vitem &%-bhc%&&~<&'IP&~address'&>
2977 .oindex "&%-bhc%&"
2978 This option operates in the same way as &%-bh%&, except that address
2979 verification callouts are performed if required. This includes consulting and
2980 updating the callout cache database.
2981
2982 .vitem &%-bi%&
2983 .oindex "&%-bi%&"
2984 .cindex "alias file" "building"
2985 .cindex "building alias file"
2986 .cindex "Sendmail compatibility" "&%-bi%& option"
2987 Sendmail interprets the &%-bi%& option as a request to rebuild its alias file.
2988 Exim does not have the concept of a single alias file, and so it cannot mimic
2989 this behaviour. However, calls to &_/usr/lib/sendmail_& with the &%-bi%& option
2990 tend to appear in various scripts such as NIS make files, so the option must be
2991 recognized.
2992
2993 If &%-bi%& is encountered, the command specified by the &%bi_command%&
2994 configuration option is run, under the uid and gid of the caller of Exim. If
2995 the &%-oA%& option is used, its value is passed to the command as an argument.
2996 The command set by &%bi_command%& may not contain arguments. The command can
2997 use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files
2998 if this is required. If the &%bi_command%& option is not set, calling Exim with
2999 &%-bi%& is a no-op.
3000
3001 . // Keep :help first, then the rest in alphabetical order
3002 .vitem &%-bI:help%&
3003 .oindex "&%-bI:help%&"
3004 .cindex "querying exim information"
3005 We shall provide various options starting &`-bI:`& for querying Exim for
3006 information.  The output of many of these will be intended for machine
3007 consumption.  This one is not.  The &%-bI:help%& option asks Exim for a
3008 synopsis of supported options beginning &`-bI:`&.  Use of any of these
3009 options shall cause Exim to exit after producing the requested output.
3010
3011 .vitem &%-bI:dscp%&
3012 .oindex "&%-bI:dscp%&"
3013 .cindex "DSCP" "values"
3014 This option causes Exim to emit an alphabetically sorted list of all
3015 recognised DSCP names.
3016
3017 .vitem &%-bI:sieve%&
3018 .oindex "&%-bI:sieve%&"
3019 .cindex "Sieve filter" "capabilities"
3020 This option causes Exim to emit an alphabetically sorted list of all supported
3021 Sieve protocol extensions on stdout, one per line.  This is anticipated to be
3022 useful for ManageSieve (RFC 5804) implementations, in providing that protocol's
3023 &`SIEVE`& capability response line.  As the precise list may depend upon
3024 compile-time build options, which this option will adapt to, this is the only
3025 way to guarantee a correct response.
3026
3027 .vitem &%-bm%&
3028 .oindex "&%-bm%&"
3029 .cindex "local message reception"
3030 This option runs an Exim receiving process that accepts an incoming,
3031 locally-generated message on the standard input. The recipients are given as the
3032 command arguments (except when &%-t%& is also present &-- see below). Each
3033 argument can be a comma-separated list of RFC 2822 addresses. This is the
3034 default option for selecting the overall action of an Exim call; it is assumed
3035 if no other conflicting option is present.
3036
3037 If any addresses in the message are unqualified (have no domain), they are
3038 qualified by the values of the &%qualify_domain%& or &%qualify_recipient%&
3039 options, as appropriate. The &%-bnq%& option (see below) provides a way of
3040 suppressing this for special cases.
3041
3042 Policy checks on the contents of local messages can be enforced by means of
3043 the non-SMTP ACL. See chapter &<<CHAPACL>>& for details.
3044
3045 .cindex "return code" "for &%-bm%&"
3046 The return code is zero if the message is successfully accepted. Otherwise, the
3047 action is controlled by the &%-oe%&&'x'& option setting &-- see below.
3048
3049 The format
3050 .cindex "message" "format"
3051 .cindex "format" "message"
3052 .cindex "&""From""& line"
3053 .cindex "UUCP" "&""From""& line"
3054 .cindex "Sendmail compatibility" "&""From""& line"
3055 of the message must be as defined in RFC 2822, except that, for
3056 compatibility with Sendmail and Smail, a line in one of the forms
3057 .code
3058 From sender Fri Jan  5 12:55 GMT 1997
3059 From sender Fri, 5 Jan 97 12:55:01
3060 .endd
3061 (with the weekday optional, and possibly with additional text after the date)
3062 is permitted to appear at the start of the message. There appears to be no
3063 authoritative specification of the format of this line. Exim recognizes it by
3064 matching against the regular expression defined by the &%uucp_from_pattern%&
3065 option, which can be changed if necessary.
3066
3067 .oindex "&%-f%&" "overriding &""From""& line"
3068 The specified sender is treated as if it were given as the argument to the
3069 &%-f%& option, but if a &%-f%& option is also present, its argument is used in
3070 preference to the address taken from the message. The caller of Exim must be a
3071 trusted user for the sender of a message to be set in this way.
3072
3073 .vitem &%-bmalware%&&~<&'filename'&>
3074 .oindex "&%-bmalware%&"
3075 .cindex "testing", "malware"
3076 .cindex "malware scan test"
3077 This debugging option causes Exim to scan the given file or directory
3078 (depending on the used scanner interface),
3079 using the malware scanning framework.  The option of &%av_scanner%& influences
3080 this option, so if &%av_scanner%&'s value is dependent upon an expansion then
3081 the expansion should have defaults which apply to this invocation.  ACLs are
3082 not invoked, so if &%av_scanner%& references an ACL variable then that variable
3083 will never be populated and &%-bmalware%& will fail.
3084
3085 Exim will have changed working directory before resolving the filename, so
3086 using fully qualified pathnames is advisable.  Exim will be running as the Exim
3087 user when it tries to open the file, rather than as the invoking user.
3088 This option requires admin privileges.
3089
3090 The &%-bmalware%& option will not be extended to be more generally useful,
3091 there are better tools for file-scanning.  This option exists to help
3092 administrators verify their Exim and AV scanner configuration.
3093
3094 .vitem &%-bnq%&
3095 .oindex "&%-bnq%&"
3096 .cindex "address qualification, suppressing"
3097 By default, Exim automatically qualifies unqualified addresses (those
3098 without domains) that appear in messages that are submitted locally (that
3099 is, not over TCP/IP). This qualification applies both to addresses in
3100 envelopes, and addresses in header lines. Sender addresses are qualified using
3101 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
3102 defaults to the value of &%qualify_domain%&).
3103
3104 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
3105 being used to re-submit messages that originally came from remote hosts after
3106 content scanning, you probably do not want to qualify unqualified addresses in
3107 header lines. (Such lines will be present only if you have not enabled a header
3108 syntax check in the appropriate ACL.)
3109
3110 The &%-bnq%& option suppresses all qualification of unqualified addresses in
3111 messages that originate on the local host. When this is used, unqualified
3112 addresses in the envelope provoke errors (causing message rejection) and
3113 unqualified addresses in header lines are left alone.
3114
3115
3116 .vitem &%-bP%&
3117 .oindex "&%-bP%&"
3118 .cindex "configuration options" "extracting"
3119 .cindex "options" "configuration &-- extracting"
3120 If this option is given with no arguments, it causes the values of all Exim's
3121 main configuration options to be written to the standard output. The values
3122 of one or more specific options can be requested by giving their names as
3123 arguments, for example:
3124 .code
3125 exim -bP qualify_domain hold_domains
3126 .endd
3127 .cindex "hiding configuration option values"
3128 .cindex "configuration options" "hiding value of"
3129 .cindex "options" "hiding value of"
3130 However, any option setting that is preceded by the word &"hide"& in the
3131 configuration file is not shown in full, except to an admin user. For other
3132 users, the output is as in this example:
3133 .code
3134 mysql_servers = <value not displayable>
3135 .endd
3136 If &%config%& is given as an argument, the config is
3137 output, as it was parsed, any include file resolved, any comment removed.
3138
3139 If &%config_file%& is given as an argument, the name of the run time
3140 configuration file is output. (&%configure_file%& works too, for
3141 backward compatibility.)
3142 If a list of configuration files was supplied, the value that is output here
3143 is the name of the file that was actually used.
3144
3145 .cindex "options" "hiding name of"
3146 If the &%-n%& flag is given, then for most modes of &%-bP%& operation the
3147 name will not be output.
3148
3149 .cindex "daemon" "process id (pid)"
3150 .cindex "pid (process id)" "of daemon"
3151 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
3152 directories where log files and daemon pid files are written are output,
3153 respectively. If these values are unset, log files are written in a
3154 sub-directory of the spool directory called &%log%&, and the pid file is
3155 written directly into the spool directory.
3156
3157 If &%-bP%& is followed by a name preceded by &`+`&, for example,
3158 .code
3159 exim -bP +local_domains
3160 .endd
3161 it searches for a matching named list of any type (domain, host, address, or
3162 local part) and outputs what it finds.
3163
3164 .cindex "options" "router &-- extracting"
3165 .cindex "options" "transport &-- extracting"
3166 .cindex "options" "authenticator &-- extracting"
3167 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
3168 followed by the name of an appropriate driver instance, the option settings for
3169 that driver are output. For example:
3170 .code
3171 exim -bP transport local_delivery
3172 .endd
3173 The generic driver options are output first, followed by the driver's private
3174 options. A list of the names of drivers of a particular type can be obtained by
3175 using one of the words &%router_list%&, &%transport_list%&, or
3176 &%authenticator_list%&, and a complete list of all drivers with their option
3177 settings can be obtained by using &%routers%&, &%transports%&, or
3178 &%authenticators%&.
3179
3180 .cindex "environment"
3181 If &%environment%& is given as an argument, the set of environment
3182 variables is output, line by line. Using the &%-n%& flag suppresses the value of the
3183 variables.
3184
3185 .cindex "options" "macro &-- extracting"
3186 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3187 are available, similarly to the drivers.  Because macros are sometimes used
3188 for storing passwords, this option is restricted.
3189 The output format is one item per line.
3190 .new
3191 For the "-bP macro <name>" form, if no such macro is found
3192 the exit status will be nonzero.
3193 .wen
3194
3195 .vitem &%-bp%&
3196 .oindex "&%-bp%&"
3197 .cindex "queue" "listing messages on"
3198 .cindex "listing" "messages on the queue"
3199 This option requests a listing of the contents of the mail queue on the
3200 standard output. If the &%-bp%& option is followed by a list of message ids,
3201 just those messages are listed. By default, this option can be used only by an
3202 admin user. However, the &%queue_list_requires_admin%& option can be set false
3203 to allow any user to see the queue.
3204
3205 Each message on the queue is displayed as in the following example:
3206 .code
3207 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3208           red.king@looking-glass.fict.example
3209           <other addresses>
3210 .endd
3211 .cindex "message" "size in queue listing"
3212 .cindex "size" "of message"
3213 The first line contains the length of time the message has been on the queue
3214 (in this case 25 minutes), the size of the message (2.9K), the unique local
3215 identifier for the message, and the message sender, as contained in the
3216 envelope. For bounce messages, the sender address is empty, and appears as
3217 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3218 the default sender address, the user's login name is shown in parentheses
3219 before the sender address.
3220
3221 .cindex "frozen messages" "in queue listing"
3222 If the message is frozen (attempts to deliver it are suspended) then the text
3223 &"*** frozen ***"& is displayed at the end of this line.
3224
3225 The recipients of the message (taken from the envelope, not the headers) are
3226 displayed on subsequent lines. Those addresses to which the message has already
3227 been delivered are marked with the letter D. If an original address gets
3228 expanded into several addresses via an alias or forward file, the original is
3229 displayed with a D only when deliveries for all of its child addresses are
3230 complete.
3231
3232
3233 .vitem &%-bpa%&
3234 .oindex "&%-bpa%&"
3235 This option operates like &%-bp%&, but in addition it shows delivered addresses
3236 that were generated from the original top level address(es) in each message by
3237 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3238 of just &"D"&.
3239
3240
3241 .vitem &%-bpc%&
3242 .oindex "&%-bpc%&"
3243 .cindex "queue" "count of messages on"
3244 This option counts the number of messages on the queue, and writes the total
3245 to the standard output. It is restricted to admin users, unless
3246 &%queue_list_requires_admin%& is set false.
3247
3248
3249 .vitem &%-bpr%&
3250 .oindex "&%-bpr%&"
3251 This option operates like &%-bp%&, but the output is not sorted into
3252 chronological order of message arrival. This can speed it up when there are
3253 lots of messages on the queue, and is particularly useful if the output is
3254 going to be post-processed in a way that doesn't need the sorting.
3255
3256 .vitem &%-bpra%&
3257 .oindex "&%-bpra%&"
3258 This option is a combination of &%-bpr%& and &%-bpa%&.
3259
3260 .vitem &%-bpru%&
3261 .oindex "&%-bpru%&"
3262 This option is a combination of &%-bpr%& and &%-bpu%&.
3263
3264
3265 .vitem &%-bpu%&
3266 .oindex "&%-bpu%&"
3267 This option operates like &%-bp%& but shows only undelivered top-level
3268 addresses for each message displayed. Addresses generated by aliasing or
3269 forwarding are not shown, unless the message was deferred after processing by a
3270 router with the &%one_time%& option set.
3271
3272
3273 .vitem &%-brt%&
3274 .oindex "&%-brt%&"
3275 .cindex "testing" "retry configuration"
3276 .cindex "retry" "configuration testing"
3277 This option is for testing retry rules, and it must be followed by up to three
3278 arguments. It causes Exim to look for a retry rule that matches the values
3279 and to write it to the standard output. For example:
3280 .code
3281 exim -brt bach.comp.mus.example
3282 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3283 .endd
3284 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3285 argument, which is required, can be a complete address in the form
3286 &'local_part@domain'&, or it can be just a domain name. If the second argument
3287 contains a dot, it is interpreted as an optional second domain name; if no
3288 retry rule is found for the first argument, the second is tried. This ties in
3289 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3290 rule is found that matches the host, one that matches the mail domain is
3291 sought. Finally, an argument that is the name of a specific delivery error, as
3292 used in setting up retry rules, can be given. For example:
3293 .code
3294 exim -brt haydn.comp.mus.example quota_3d
3295 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3296 .endd
3297
3298 .vitem &%-brw%&
3299 .oindex "&%-brw%&"
3300 .cindex "testing" "rewriting"
3301 .cindex "rewriting" "testing"
3302 This option is for testing address rewriting rules, and it must be followed by
3303 a single argument, consisting of either a local part without a domain, or a
3304 complete address with a fully qualified domain. Exim outputs how this address
3305 would be rewritten for each possible place it might appear. See chapter
3306 &<<CHAPrewrite>>& for further details.
3307
3308 .vitem &%-bS%&
3309 .oindex "&%-bS%&"
3310 .cindex "SMTP" "batched incoming"
3311 .cindex "batched SMTP input"
3312 This option is used for batched SMTP input, which is an alternative interface
3313 for non-interactive local message submission. A number of messages can be
3314 submitted in a single run. However, despite its name, this is not really SMTP
3315 input. Exim reads each message's envelope from SMTP commands on the standard
3316 input, but generates no responses. If the caller is trusted, or
3317 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3318 believed; otherwise the sender is always the caller of Exim.
3319
3320 The message itself is read from the standard input, in SMTP format (leading
3321 dots doubled), terminated by a line containing just a single dot. An error is
3322 provoked if the terminating dot is missing. A further message may then follow.
3323
3324 As for other local message submissions, the contents of incoming batch SMTP
3325 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3326 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3327 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3328
3329 Some other SMTP commands are recognized in the input. HELO and EHLO act
3330 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3331 QUIT quits, ignoring the rest of the standard input.
3332
3333 .cindex "return code" "for &%-bS%&"
3334 If any error is encountered, reports are written to the standard output and
3335 error streams, and Exim gives up immediately. The return code is 0 if no error
3336 was detected; it is 1 if one or more messages were accepted before the error
3337 was detected; otherwise it is 2.
3338
3339 More details of input using batched SMTP are given in section
3340 &<<SECTincomingbatchedSMTP>>&.
3341
3342 .vitem &%-bs%&
3343 .oindex "&%-bs%&"
3344 .cindex "SMTP" "local input"
3345 .cindex "local SMTP input"
3346 This option causes Exim to accept one or more messages by reading SMTP commands
3347 on the standard input, and producing SMTP replies on the standard output. SMTP
3348 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3349 Some user agents use this interface as a way of passing locally-generated
3350 messages to the MTA.
3351
3352 In
3353 .cindex "sender" "source of"
3354 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3355 set, the senders of messages are taken from the SMTP MAIL commands.
3356 Otherwise the content of these commands is ignored and the sender is set up as
3357 the calling user. Unqualified addresses are automatically qualified using
3358 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3359 &%-bnq%& option is used.
3360
3361 .cindex "inetd"
3362 The
3363 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3364 using a listening daemon. Exim can distinguish the two cases by checking
3365 whether the standard input is a TCP/IP socket. When Exim is called from
3366 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3367 above concerning senders and qualification do not apply. In this situation,
3368 Exim behaves in exactly the same way as it does when receiving a message via
3369 the listening daemon.
3370
3371 .vitem &%-bt%&
3372 .oindex "&%-bt%&"
3373 .cindex "testing" "addresses"
3374 .cindex "address" "testing"
3375 This option runs Exim in address testing mode, in which each argument is taken
3376 as a recipient address to be tested for deliverability. The results are
3377 written to the standard output. If a test fails, and the caller is not an admin
3378 user, no details of the failure are output, because these might contain
3379 sensitive information such as usernames and passwords for database lookups.
3380
3381 If no arguments are given, Exim runs in an interactive manner, prompting with a
3382 right angle bracket for addresses to be tested.
3383
3384 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3385 &[readline()]& function, because it is running as &'root'& and there are
3386 security issues.
3387
3388 Each address is handled as if it were the recipient address of a message
3389 (compare the &%-bv%& option). It is passed to the routers and the result is
3390 written to the standard output. However, any router that has
3391 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3392 genuine routing tests if your first router passes everything to a scanner
3393 program.
3394
3395 .cindex "return code" "for &%-bt%&"
3396 The return code is 2 if any address failed outright; it is 1 if no address
3397 failed outright but at least one could not be resolved for some reason. Return
3398 code 0 is given only when all addresses succeed.
3399
3400 .cindex "duplicate addresses"
3401 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3402 addresses after routing is complete, so that only one delivery takes place.
3403 This does not happen when testing with &%-bt%&; the full results of routing are
3404 always shown.
3405
3406 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3407 routers in the configuration makes any tests on the sender address of a
3408 message,
3409 .oindex "&%-f%&" "for address testing"
3410 you can use the &%-f%& option to set an appropriate sender when running
3411 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3412 default qualifying domain. However, if you have set up (for example) routers
3413 whose behaviour depends on the contents of an incoming message, you cannot test
3414 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3415 doing such tests.
3416
3417 .vitem &%-bV%&
3418 .oindex "&%-bV%&"
3419 .cindex "version number of Exim"
3420 This option causes Exim to write the current version number, compilation
3421 number, and compilation date of the &'exim'& binary to the standard output.
3422 It also lists the DBM library that is being used, the optional modules (such as
3423 specific lookup types), the drivers that are included in the binary, and the
3424 name of the run time configuration file that is in use.
3425
3426 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3427 configuration file. However, this is a static check only. It cannot check
3428 values that are to be expanded. For example, although a misspelt ACL verb is
3429 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3430 alone to discover (for example) all the typos in the configuration; some
3431 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3432 dynamic testing facilities.
3433
3434 .vitem &%-bv%&
3435 .oindex "&%-bv%&"
3436 .cindex "verifying address" "using &%-bv%&"
3437 .cindex "address" "verification"
3438 This option runs Exim in address verification mode, in which each argument is
3439 taken as a recipient address to be verified by the routers. (This does
3440 not involve any verification callouts). During normal operation, verification
3441 happens mostly as a consequence processing a &%verify%& condition in an ACL
3442 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3443 including callouts, see the &%-bh%& and &%-bhc%& options.
3444
3445 If verification fails, and the caller is not an admin user, no details of the
3446 failure are output, because these might contain sensitive information such as
3447 usernames and passwords for database lookups.
3448
3449 If no arguments are given, Exim runs in an interactive manner, prompting with a
3450 right angle bracket for addresses to be verified.
3451
3452 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3453 &[readline()]& function, because it is running as &'exim'& and there are
3454 security issues.
3455
3456 Verification differs from address testing (the &%-bt%& option) in that routers
3457 that have &%no_verify%& set are skipped, and if the address is accepted by a
3458 router that has &%fail_verify%& set, verification fails. The address is
3459 verified as a recipient if &%-bv%& is used; to test verification for a sender
3460 address, &%-bvs%& should be used.
3461
3462 If the &%-v%& option is not set, the output consists of a single line for each
3463 address, stating whether it was verified or not, and giving a reason in the
3464 latter case. Without &%-v%&, generating more than one address by redirection
3465 causes verification to end successfully, without considering the generated
3466 addresses. However, if just one address is generated, processing continues,
3467 and the generated address must verify successfully for the overall verification
3468 to succeed.
3469
3470 When &%-v%& is set, more details are given of how the address has been handled,
3471 and in the case of address redirection, all the generated addresses are also
3472 considered. Verification may succeed for some and fail for others.
3473
3474 The
3475 .cindex "return code" "for &%-bv%&"
3476 return code is 2 if any address failed outright; it is 1 if no address
3477 failed outright but at least one could not be resolved for some reason. Return
3478 code 0 is given only when all addresses succeed.
3479
3480 If any of the routers in the configuration makes any tests on the sender
3481 address of a message, you should use the &%-f%& option to set an appropriate
3482 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3483 calling user at the default qualifying domain.
3484
3485 .vitem &%-bvs%&
3486 .oindex "&%-bvs%&"
3487 This option acts like &%-bv%&, but verifies the address as a sender rather
3488 than a recipient address. This affects any rewriting and qualification that
3489 might happen.
3490
3491 .vitem &%-bw%&
3492 .oindex "&%-bw%&"
3493 .cindex "daemon"
3494 .cindex "inetd"
3495 .cindex "inetd" "wait mode"
3496 This option runs Exim as a daemon, awaiting incoming SMTP connections,
3497 similarly to the &%-bd%& option.  All port specifications on the command-line
3498 and in the configuration file are ignored.  Queue-running may not be specified.
3499
3500 In this mode, Exim expects to be passed a socket as fd 0 (stdin) which is
3501 listening for connections.  This permits the system to start up and have
3502 inetd (or equivalent) listen on the SMTP ports, starting an Exim daemon for
3503 each port only when the first connection is received.
3504
3505 If the option is given as &%-bw%&<&'time'&> then the time is a timeout, after
3506 which the daemon will exit, which should cause inetd to listen once more.
3507
3508 .vitem &%-C%&&~<&'filelist'&>
3509 .oindex "&%-C%&"
3510 .cindex "configuration file" "alternate"
3511 .cindex "CONFIGURE_FILE"
3512 .cindex "alternate configuration file"
3513 This option causes Exim to find the run time configuration file from the given
3514 list instead of from the list specified by the CONFIGURE_FILE
3515 compile-time setting. Usually, the list will consist of just a single file
3516 name, but it can be a colon-separated list of names. In this case, the first
3517 file that exists is used. Failure to open an existing file stops Exim from
3518 proceeding any further along the list, and an error is generated.
3519
3520 When this option is used by a caller other than root, and the list is different
3521 from the compiled-in list, Exim gives up its root privilege immediately, and
3522 runs with the real and effective uid and gid set to those of the caller.
3523 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3524 file contains a list of full pathnames, one per line, for configuration files
3525 which are trusted. Root privilege is retained for any configuration file so
3526 listed, as long as the caller is the Exim user (or the user specified in the
3527 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3528 not writeable by inappropriate users or groups.
3529
3530 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3531 configuration using &%-C%& right through message reception and delivery,
3532 even if the caller is root. The reception works, but by that time, Exim is
3533 running as the Exim user, so when it re-executes to regain privilege for the
3534 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3535 test reception and delivery using two separate commands (one to put a message
3536 on the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3537
3538 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3539 prefix string with which any file named in a &%-C%& command line option
3540 must start. In addition, the file name must not contain the sequence &`/../`&.
3541 However, if the value of the &%-C%& option is identical to the value of
3542 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3543 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3544 unset, any file name can be used with &%-C%&.
3545
3546 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3547 to a directory to which only root has access. This prevents someone who has
3548 broken into the Exim account from running a privileged Exim with an arbitrary
3549 configuration file.
3550
3551 The &%-C%& facility is useful for ensuring that configuration files are
3552 syntactically correct, but cannot be used for test deliveries, unless the
3553 caller is privileged, or unless it is an exotic configuration that does not
3554 require privilege. No check is made on the owner or group of the files
3555 specified by this option.
3556
3557
3558 .vitem &%-D%&<&'macro'&>=<&'value'&>
3559 .oindex "&%-D%&"
3560 .cindex "macro" "setting on command line"
3561 This option can be used to override macro definitions in the configuration file
3562 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3563 unprivileged caller, it causes Exim to give up its root privilege.
3564 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3565 completely disabled, and its use causes an immediate error exit.
3566
3567 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3568 colon-separated list of macros which are considered safe and, if &%-D%& only
3569 supplies macros from this list, and the values are acceptable, then Exim will
3570 not give up root privilege if the caller is root, the Exim run-time user, or
3571 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3572 to be removed in the future.  Acceptable values for the macros satisfy the
3573 regexp: &`^[A-Za-z0-9_/.-]*$`&
3574
3575 The entire option (including equals sign if present) must all be within one
3576 command line item. &%-D%& can be used to set the value of a macro to the empty
3577 string, in which case the equals sign is optional. These two commands are
3578 synonymous:
3579 .code
3580 exim -DABC  ...
3581 exim -DABC= ...
3582 .endd
3583 To include spaces in a macro definition item, quotes must be used. If you use
3584 quotes, spaces are permitted around the macro name and the equals sign. For
3585 example:
3586 .code
3587 exim '-D ABC = something' ...
3588 .endd
3589 &%-D%& may be repeated up to 10 times on a command line.
3590 Only macro names up to 22 letters long can be set.
3591
3592
3593 .vitem &%-d%&<&'debug&~options'&>
3594 .oindex "&%-d%&"
3595 .cindex "debugging" "list of selectors"
3596 .cindex "debugging" "&%-d%& option"
3597 This option causes debugging information to be written to the standard
3598 error stream. It is restricted to admin users because debugging output may show
3599 database queries that contain password information. Also, the details of users'
3600 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3601 writes an error message to the standard error stream and exits with a non-zero
3602 return code.
3603
3604 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3605 standard debugging data is output. This can be reduced, or increased to include
3606 some more rarely needed information, by directly following &%-d%& with a string
3607 made up of names preceded by plus or minus characters. These add or remove sets
3608 of debugging data, respectively. For example, &%-d+filter%& adds filter
3609 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3610 no spaces are allowed in the debug setting. The available debugging categories
3611 are:
3612 .display
3613 &`acl            `& ACL interpretation
3614 &`auth           `& authenticators
3615 &`deliver        `& general delivery logic
3616 &`dns            `& DNS lookups (see also resolver)
3617 &`dnsbl          `& DNS black list (aka RBL) code
3618 &`exec           `& arguments for &[execv()]& calls
3619 &`expand         `& detailed debugging for string expansions
3620 &`filter         `& filter handling
3621 &`hints_lookup   `& hints data lookups
3622 &`host_lookup    `& all types of name-to-IP address handling
3623 &`ident          `& ident lookup
3624 &`interface      `& lists of local interfaces
3625 &`lists          `& matching things in lists
3626 &`load           `& system load checks
3627 &`local_scan     `& can be used by &[local_scan()]& (see chapter &&&
3628                     &<<CHAPlocalscan>>&)
3629 &`lookup         `& general lookup code and all lookups
3630 &`memory         `& memory handling
3631 &`pid            `& add pid to debug output lines
3632 &`process_info   `& setting info for the process log
3633 &`queue_run      `& queue runs
3634 &`receive        `& general message reception logic
3635 &`resolver       `& turn on the DNS resolver's debugging output
3636 &`retry          `& retry handling
3637 &`rewrite        `& address rewriting
3638 &`route          `& address routing
3639 &`timestamp      `& add timestamp to debug output lines
3640 &`tls            `& TLS logic
3641 &`transport      `& transports
3642 &`uid            `& changes of uid/gid and looking up uid/gid
3643 &`verify         `& address verification logic
3644 &`all            `& almost all of the above (see below), and also &%-v%&
3645 .endd
3646 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3647 for &`-all`&. The reason for this is that &`+all`& is something that people
3648 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3649 is included, an awful lot of output that is very rarely of interest is
3650 generated, so it now has to be explicitly requested. However, &`-all`& does
3651 turn everything off.
3652
3653 .cindex "resolver, debugging output"
3654 .cindex "DNS resolver, debugging output"
3655 The &`resolver`& option produces output only if the DNS resolver was compiled
3656 with DEBUG enabled. This is not the case in some operating systems. Also,
3657 unfortunately, debugging output from the DNS resolver is written to stdout
3658 rather than stderr.
3659
3660 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3661 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3662 However, the &`pid`& selector is forced when debugging is turned on for a
3663 daemon, which then passes it on to any re-executed Exims. Exim also
3664 automatically adds the pid to debug lines when several remote deliveries are
3665 run in parallel.
3666
3667 The &`timestamp`& selector causes the current time to be inserted at the start
3668 of all debug output lines. This can be useful when trying to track down delays
3669 in processing.
3670
3671 If the &%debug_print%& option is set in any driver, it produces output whenever
3672 any debugging is selected, or if &%-v%& is used.
3673
3674 .vitem &%-dd%&<&'debug&~options'&>
3675 .oindex "&%-dd%&"
3676 This option behaves exactly like &%-d%& except when used on a command that
3677 starts a daemon process. In that case, debugging is turned off for the
3678 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3679 behaviour of the daemon without creating as much output as full debugging does.
3680
3681 .vitem &%-dropcr%&
3682 .oindex "&%-dropcr%&"
3683 This is an obsolete option that is now a no-op. It used to affect the way Exim
3684 handled CR and LF characters in incoming messages. What happens now is
3685 described in section &<<SECTlineendings>>&.
3686
3687 .vitem &%-E%&
3688 .oindex "&%-E%&"
3689 .cindex "bounce message" "generating"
3690 This option specifies that an incoming message is a locally-generated delivery
3691 failure report. It is used internally by Exim when handling delivery failures
3692 and is not intended for external use. Its only effect is to stop Exim
3693 generating certain messages to the postmaster, as otherwise message cascades
3694 could occur in some situations. As part of the same option, a message id may
3695 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3696 new message contains the id, following &"R="&, as a cross-reference.
3697
3698 .vitem &%-e%&&'x'&
3699 .oindex "&%-e%&&'x'&"
3700 There are a number of Sendmail options starting with &%-oe%& which seem to be
3701 called by various programs without the leading &%o%& in the option. For
3702 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3703 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3704
3705 .vitem &%-F%&&~<&'string'&>
3706 .oindex "&%-F%&"
3707 .cindex "sender" "name"
3708 .cindex "name" "of sender"
3709 This option sets the sender's full name for use when a locally-generated
3710 message is being accepted. In the absence of this option, the user's &'gecos'&
3711 entry from the password data is used. As users are generally permitted to alter
3712 their &'gecos'& entries, no security considerations are involved. White space
3713 between &%-F%& and the <&'string'&> is optional.
3714
3715 .vitem &%-f%&&~<&'address'&>
3716 .oindex "&%-f%&"
3717 .cindex "sender" "address"
3718 .cindex "address" "sender"
3719 .cindex "trusted users"
3720 .cindex "envelope sender"
3721 .cindex "user" "trusted"
3722 This option sets the address of the envelope sender of a locally-generated
3723 message (also known as the return path). The option can normally be used only
3724 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3725 users to use it.
3726
3727 Processes running as root or the Exim user are always trusted. Other
3728 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3729 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3730 of a local message is set to the caller's login name at the default qualify
3731 domain.
3732
3733 There is one exception to the restriction on the use of &%-f%&: an empty sender
3734 can be specified by any user, trusted or not, to create a message that can
3735 never provoke a bounce. An empty sender can be specified either as an empty
3736 string, or as a pair of angle brackets with nothing between them, as in these
3737 examples of shell commands:
3738 .code
3739 exim -f '<>' user@domain
3740 exim -f "" user@domain
3741 .endd
3742 In addition, the use of &%-f%& is not restricted when testing a filter file
3743 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3744 &%-bv%& options.
3745
3746 Allowing untrusted users to change the sender address does not of itself make
3747 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3748 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3749 though this can be overridden by setting &%no_local_from_check%&.
3750
3751 White
3752 .cindex "&""From""& line"
3753 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3754 given as two arguments or one combined argument). The sender of a
3755 locally-generated message can also be set (when permitted) by an initial
3756 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3757 if &%-f%& is also present, it overrides &"From&~"&.
3758
3759 .vitem &%-G%&
3760 .oindex "&%-G%&"
3761 .cindex "submission fixups, suppressing (command-line)"
3762 This option is equivalent to an ACL applying:
3763 .code
3764 control = suppress_local_fixups
3765 .endd
3766 for every message received.  Note that Sendmail will complain about such
3767 bad formatting, where Exim silently just does not fix it up.  This may change
3768 in future.
3769
3770 As this affects audit information, the caller must be a trusted user to use
3771 this option.
3772
3773 .vitem &%-h%&&~<&'number'&>
3774 .oindex "&%-h%&"
3775 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3776 This option is accepted for compatibility with Sendmail, but has no effect. (In
3777 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3778 headers.)
3779
3780 .vitem &%-i%&
3781 .oindex "&%-i%&"
3782 .cindex "Solaris" "&'mail'& command"
3783 .cindex "dot" "in incoming non-SMTP message"
3784 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3785 line by itself should not terminate an incoming, non-SMTP message. I can find
3786 no documentation for this option in Solaris 2.4 Sendmail, but the &'mailx'&
3787 command in Solaris 2.4 uses it. See also &%-ti%&.
3788
3789 .vitem &%-L%&&~<&'tag'&>
3790 .oindex "&%-L%&"
3791 .cindex "syslog" "process name; set with flag"
3792 This option is equivalent to setting &%syslog_processname%& in the config
3793 file and setting &%log_file_path%& to &`syslog`&.
3794 Its use is restricted to administrators.  The configuration file has to be
3795 read and parsed, to determine access rights, before this is set and takes
3796 effect, so early configuration file errors will not honour this flag.
3797
3798 The tag should not be longer than 32 characters.
3799
3800 .vitem &%-M%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3801 .oindex "&%-M%&"
3802 .cindex "forcing delivery"
3803 .cindex "delivery" "forcing attempt"
3804 .cindex "frozen messages" "forcing delivery"
3805 This option requests Exim to run a delivery attempt on each message in turn. If
3806 any of the messages are frozen, they are automatically thawed before the
3807 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3808 and &%hold_domains%& are ignored.
3809
3810 Retry
3811 .cindex "hints database" "overriding retry hints"
3812 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3813 the normal retry time has not yet been reached. This option requires the caller
3814 to be an admin user. However, there is an option called &%prod_requires_admin%&
3815 which can be set false to relax this restriction (and also the same requirement
3816 for the &%-q%&, &%-R%&, and &%-S%& options).
3817
3818 The deliveries happen synchronously, that is, the original Exim process does
3819 not terminate until all the delivery attempts have finished. No output is
3820 produced unless there is a serious error. If you want to see what is happening,
3821 use the &%-v%& option as well, or inspect Exim's main log.
3822
3823 .vitem &%-Mar%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3824 .oindex "&%-Mar%&"
3825 .cindex "message" "adding recipients"
3826 .cindex "recipient" "adding"
3827 This option requests Exim to add the addresses to the list of recipients of the
3828 message (&"ar"& for &"add recipients"&). The first argument must be a message
3829 id, and the remaining ones must be email addresses. However, if the message is
3830 active (in the middle of a delivery attempt), it is not altered. This option
3831 can be used only by an admin user.
3832
3833 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&~<&'sequence&~number'&>&&&
3834         &~<&'message&~id'&>"
3835 .oindex "&%-MC%&"
3836 .cindex "SMTP" "passed connection"
3837 .cindex "SMTP" "multiple deliveries"
3838 .cindex "multiple SMTP deliveries"
3839 This option is not intended for use by external callers. It is used internally
3840 by Exim to invoke another instance of itself to deliver a waiting message using
3841 an existing SMTP connection, which is passed as the standard input. Details are
3842 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3843 must be root or the Exim user in order to use it.
3844
3845 .vitem &%-MCA%&
3846 .oindex "&%-MCA%&"
3847 This option is not intended for use by external callers. It is used internally
3848 by Exim in conjunction with the &%-MC%& option. It signifies that the
3849 connection to the remote host has been authenticated.
3850
3851 .vitem &%-MCD%&
3852 .oindex "&%-MCD%&"
3853 This option is not intended for use by external callers. It is used internally
3854 by Exim in conjunction with the &%-MC%& option. It signifies that the
3855 remote host supports the ESMTP &_DSN_& extension.
3856
3857 .vitem &%-MCG%&&~<&'queue&~name'&>
3858 .oindex "&%-MCG%&"
3859 This option is not intended for use by external callers. It is used internally
3860 by Exim in conjunction with the &%-MC%& option. It signifies that an
3861 alternate queue is used, named by the following argument.
3862
3863 .vitem &%-MCK%&
3864 .oindex "&%-MCK%&"
3865 This option is not intended for use by external callers. It is used internally
3866 by Exim in conjunction with the &%-MC%& option. It signifies that an
3867 remote host supports the ESMTP &_CHUNKING_& extension.
3868
3869 .vitem &%-MCP%&
3870 .oindex "&%-MCP%&"
3871 This option is not intended for use by external callers. It is used internally
3872 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3873 which Exim is connected supports pipelining.
3874
3875 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3876 .oindex "&%-MCQ%&"
3877 This option is not intended for use by external callers. It is used internally
3878 by Exim in conjunction with the &%-MC%& option when the original delivery was
3879 started by a queue runner. It passes on the process id of the queue runner,
3880 together with the file descriptor number of an open pipe. Closure of the pipe
3881 signals the final completion of the sequence of processes that are passing
3882 messages through the same SMTP connection.
3883
3884 .vitem &%-MCS%&
3885 .oindex "&%-MCS%&"
3886 This option is not intended for use by external callers. It is used internally
3887 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3888 SMTP SIZE option should be used on messages delivered down the existing
3889 connection.
3890
3891 .vitem &%-MCT%&
3892 .oindex "&%-MCT%&"
3893 This option is not intended for use by external callers. It is used internally
3894 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3895 host to which Exim is connected supports TLS encryption.
3896
3897 .vitem &%-MCt%&&~<&'IP&~address'&>&~<&'port'&>&~<&'cipher'&>
3898 .oindex "&%-MCt%&"
3899 This option is not intended for use by external callers. It is used internally
3900 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3901 connection is being proxied by a parent process for handling TLS encryption.
3902 The arguments give the local address and port being proxied, and the TLS cipher.
3903
3904 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3905 .oindex "&%-Mc%&"
3906 .cindex "hints database" "not overridden by &%-Mc%&"
3907 .cindex "delivery" "manually started &-- not forced"
3908 This option requests Exim to run a delivery attempt on each message in turn,
3909 but unlike the &%-M%& option, it does check for retry hints, and respects any
3910 that are found. This option is not very useful to external callers. It is
3911 provided mainly for internal use by Exim when it needs to re-invoke itself in
3912 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3913 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3914 respects retry times and other options such as &%hold_domains%& that are
3915 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3916 If you want to run a specific delivery as if in a queue run, you should use
3917 &%-q%& with a message id argument. A distinction between queue run deliveries
3918 and other deliveries is made in one or two places.
3919
3920 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
3921 .oindex "&%-Mes%&"
3922 .cindex "message" "changing sender"
3923 .cindex "sender" "changing"
3924 This option requests Exim to change the sender address in the message to the
3925 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3926 &"edit sender"&). There must be exactly two arguments. The first argument must
3927 be a message id, and the second one an email address. However, if the message
3928 is active (in the middle of a delivery attempt), its status is not altered.
3929 This option can be used only by an admin user.
3930
3931 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3932 .oindex "&%-Mf%&"
3933 .cindex "freezing messages"
3934 .cindex "message" "manually freezing"
3935 This option requests Exim to mark each listed message as &"frozen"&. This
3936 prevents any delivery attempts taking place until the message is &"thawed"&,
3937 either manually or as a result of the &%auto_thaw%& configuration option.
3938 However, if any of the messages are active (in the middle of a delivery
3939 attempt), their status is not altered. This option can be used only by an admin
3940 user.
3941
3942 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3943 .oindex "&%-Mg%&"
3944 .cindex "giving up on messages"
3945 .cindex "message" "abandoning delivery attempts"
3946 .cindex "delivery" "abandoning further attempts"
3947 This option requests Exim to give up trying to deliver the listed messages,
3948 including any that are frozen. However, if any of the messages are active,
3949 their status is not altered. For non-bounce messages, a delivery error message
3950 is sent to the sender, containing the text &"cancelled by administrator"&.
3951 Bounce messages are just discarded. This option can be used only by an admin
3952 user.
3953
3954 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3955 .oindex "&%-Mmad%&"
3956 .cindex "delivery" "cancelling all"
3957 This option requests Exim to mark all the recipient addresses in the messages
3958 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
3959 message is active (in the middle of a delivery attempt), its status is not
3960 altered. This option can be used only by an admin user.
3961
3962 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3963 .oindex "&%-Mmd%&"
3964 .cindex "delivery" "cancelling by address"
3965 .cindex "recipient" "removing"
3966 .cindex "removing recipients"
3967 This option requests Exim to mark the given addresses as already delivered
3968 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
3969 the remaining ones must be email addresses. These are matched to recipient
3970 addresses in the message in a case-sensitive manner. If the message is active
3971 (in the middle of a delivery attempt), its status is not altered. This option
3972 can be used only by an admin user.
3973
3974 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3975 .oindex "&%-Mrm%&"
3976 .cindex "removing messages"
3977 .cindex "abandoning mail"
3978 .cindex "message" "manually discarding"
3979 This option requests Exim to remove the given messages from the queue. No
3980 bounce messages are sent; each message is simply forgotten. However, if any of
3981 the messages are active, their status is not altered. This option can be used
3982 only by an admin user or by the user who originally caused the message to be
3983 placed on the queue.
3984
3985 .vitem &%-Mset%&&~<&'message&~id'&>
3986 .oindex "&%-Mset%&
3987 .cindex "testing" "string expansion"
3988 .cindex "expansion" "testing"
3989 This option is useful only in conjunction with &%-be%& (that is, when testing
3990 string expansions). Exim loads the given message from its spool before doing
3991 the test expansions, thus setting message-specific variables such as
3992 &$message_size$& and the header variables. The &$recipients$& variable is made
3993 available. This feature is provided to make it easier to test expansions that
3994 make use of these variables. However, this option can be used only by an admin
3995 user. See also &%-bem%&.
3996
3997 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3998 .oindex "&%-Mt%&"
3999 .cindex "thawing messages"
4000 .cindex "unfreezing messages"
4001 .cindex "frozen messages" "thawing"
4002 .cindex "message" "thawing frozen"
4003 This option requests Exim to &"thaw"& any of the listed messages that are
4004 &"frozen"&, so that delivery attempts can resume. However, if any of the
4005 messages are active, their status is not altered. This option can be used only
4006 by an admin user.
4007
4008 .vitem &%-Mvb%&&~<&'message&~id'&>
4009 .oindex "&%-Mvb%&"
4010 .cindex "listing" "message body"
4011 .cindex "message" "listing body of"
4012 This option causes the contents of the message body (-D) spool file to be
4013 written to the standard output. This option can be used only by an admin user.
4014
4015 .vitem &%-Mvc%&&~<&'message&~id'&>
4016 .oindex "&%-Mvc%&"
4017 .cindex "message" "listing in RFC 2822 format"
4018 .cindex "listing" "message in RFC 2822 format"
4019 This option causes a copy of the complete message (header lines plus body) to
4020 be written to the standard output in RFC 2822 format. This option can be used
4021 only by an admin user.
4022
4023 .vitem &%-Mvh%&&~<&'message&~id'&>
4024 .oindex "&%-Mvh%&"
4025 .cindex "listing" "message headers"
4026 .cindex "header lines" "listing"
4027 .cindex "message" "listing header lines"
4028 This option causes the contents of the message headers (-H) spool file to be
4029 written to the standard output. This option can be used only by an admin user.
4030
4031 .vitem &%-Mvl%&&~<&'message&~id'&>
4032 .oindex "&%-Mvl%&"
4033 .cindex "listing" "message log"
4034 .cindex "message" "listing message log"
4035 This option causes the contents of the message log spool file to be written to
4036 the standard output. This option can be used only by an admin user.
4037
4038 .vitem &%-m%&
4039 .oindex "&%-m%&"
4040 This is apparently a synonym for &%-om%& that is accepted by Sendmail, so Exim
4041 treats it that way too.
4042
4043 .vitem &%-N%&
4044 .oindex "&%-N%&"
4045 .cindex "debugging" "&%-N%& option"
4046 .cindex "debugging" "suppressing delivery"
4047 This is a debugging option that inhibits delivery of a message at the transport
4048 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
4049 it just doesn't actually transport the message, but instead behaves as if it
4050 had successfully done so. However, it does not make any updates to the retry
4051 database, and the log entries for deliveries are flagged with &"*>"& rather
4052 than &"=>"&.
4053
4054 Because &%-N%& discards any message to which it applies, only root or the Exim
4055 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
4056 words, an ordinary user can use it only when supplying an incoming message to
4057 which it will apply. Although transportation never fails when &%-N%& is set, an
4058 address may be deferred because of a configuration problem on a transport, or a
4059 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
4060 the message, and applies to any subsequent delivery attempts that may happen
4061 for that message.
4062
4063 .vitem &%-n%&
4064 .oindex "&%-n%&"
4065 This option is interpreted by Sendmail to mean &"no aliasing"&.
4066 For normal modes of operation, it is ignored by Exim.
4067 When combined with &%-bP%& it makes the output more terse (suppresses
4068 option names, environment values and config pretty printing).
4069
4070 .vitem &%-O%&&~<&'data'&>
4071 .oindex "&%-O%&"
4072 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
4073 Exim.
4074
4075 .vitem &%-oA%&&~<&'file&~name'&>
4076 .oindex "&%-oA%&"
4077 .cindex "Sendmail compatibility" "&%-oA%& option"
4078 This option is used by Sendmail in conjunction with &%-bi%& to specify an
4079 alternative alias file name. Exim handles &%-bi%& differently; see the
4080 description above.
4081
4082 .vitem &%-oB%&&~<&'n'&>
4083 .oindex "&%-oB%&"
4084 .cindex "SMTP" "passed connection"
4085 .cindex "SMTP" "multiple deliveries"
4086 .cindex "multiple SMTP deliveries"
4087 This is a debugging option which limits the maximum number of messages that can
4088 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
4089 transport. If <&'n'&> is omitted, the limit is set to 1.
4090
4091 .vitem &%-odb%&
4092 .oindex "&%-odb%&"
4093 .cindex "background delivery"
4094 .cindex "delivery" "in the background"
4095 This option applies to all modes in which Exim accepts incoming messages,
4096 including the listening daemon. It requests &"background"& delivery of such
4097 messages, which means that the accepting process automatically starts a
4098 delivery process for each message received, but does not wait for the delivery
4099 processes to finish.
4100
4101 When all the messages have been received, the reception process exits,
4102 leaving the delivery processes to finish in their own time. The standard output
4103 and error streams are closed at the start of each delivery process.
4104 This is the default action if none of the &%-od%& options are present.
4105
4106 If one of the queueing options in the configuration file
4107 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
4108 overrides it if &%queue_only_override%& is set true, which is the default
4109 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
4110
4111 .vitem &%-odf%&
4112 .oindex "&%-odf%&"
4113 .cindex "foreground delivery"
4114 .cindex "delivery" "in the foreground"
4115 This option requests &"foreground"& (synchronous) delivery when Exim has
4116 accepted a locally-generated message. (For the daemon it is exactly the same as
4117 &%-odb%&.) A delivery process is automatically started to deliver the message,
4118 and Exim waits for it to complete before proceeding.
4119
4120 The original Exim reception process does not finish until the delivery
4121 process for the final message has ended. The standard error stream is left open
4122 during deliveries.
4123
4124 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
4125 false and one of the queueing options in the configuration file is in effect.
4126
4127 If there is a temporary delivery error during foreground delivery, the
4128 message is left on the queue for later delivery, and the original reception
4129 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
4130 restricted configuration that never queues messages.
4131
4132
4133 .vitem &%-odi%&
4134 .oindex "&%-odi%&"
4135 This option is synonymous with &%-odf%&. It is provided for compatibility with
4136 Sendmail.
4137
4138 .vitem &%-odq%&
4139 .oindex "&%-odq%&"
4140 .cindex "non-immediate delivery"
4141 .cindex "delivery" "suppressing immediate"
4142 .cindex "queueing incoming messages"
4143 This option applies to all modes in which Exim accepts incoming messages,
4144 including the listening daemon. It specifies that the accepting process should
4145 not automatically start a delivery process for each message received. Messages
4146 are placed on the queue, and remain there until a subsequent queue runner
4147 process encounters them. There are several configuration options (such as
4148 &%queue_only%&) that can be used to queue incoming messages under certain
4149 conditions. This option overrides all of them and also &%-odqs%&. It always
4150 forces queueing.
4151
4152 .vitem &%-odqs%&
4153 .oindex "&%-odqs%&"
4154 .cindex "SMTP" "delaying delivery"
4155 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4156 However, like &%-odb%& and &%-odi%&, this option has no effect if
4157 &%queue_only_override%& is false and one of the queueing options in the
4158 configuration file is in effect.
4159
4160 When &%-odqs%& does operate, a delivery process is started for each incoming
4161 message, in the background by default, but in the foreground if &%-odi%& is
4162 also present. The recipient addresses are routed, and local deliveries are done
4163 in the normal way. However, if any SMTP deliveries are required, they are not
4164 done at this time, so the message remains on the queue until a subsequent queue
4165 runner process encounters it. Because routing was done, Exim knows which
4166 messages are waiting for which hosts, and so a number of messages for the same
4167 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4168 configuration option has the same effect for specific domains. See also the
4169 &%-qq%& option.
4170
4171 .vitem &%-oee%&
4172 .oindex "&%-oee%&"
4173 .cindex "error" "reporting"
4174 If an error is detected while a non-SMTP message is being received (for
4175 example, a malformed address), the error is reported to the sender in a mail
4176 message.
4177
4178 .cindex "return code" "for &%-oee%&"
4179 Provided
4180 this error message is successfully sent, the Exim receiving process
4181 exits with a return code of zero. If not, the return code is 2 if the problem
4182 is that the original message has no recipients, or 1 for any other error.
4183 This is the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4184
4185 .vitem &%-oem%&
4186 .oindex "&%-oem%&"
4187 .cindex "error" "reporting"
4188 .cindex "return code" "for &%-oem%&"
4189 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4190 return code, whether or not the error message was successfully sent.
4191 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4192
4193 .vitem &%-oep%&
4194 .oindex "&%-oep%&"
4195 .cindex "error" "reporting"
4196 If an error is detected while a non-SMTP message is being received, the
4197 error is reported by writing a message to the standard error file (stderr).
4198 .cindex "return code" "for &%-oep%&"
4199 The return code is 1 for all errors.
4200
4201 .vitem &%-oeq%&
4202 .oindex "&%-oeq%&"
4203 .cindex "error" "reporting"
4204 This option is supported for compatibility with Sendmail, but has the same
4205 effect as &%-oep%&.
4206
4207 .vitem &%-oew%&
4208 .oindex "&%-oew%&"
4209 .cindex "error" "reporting"
4210 This option is supported for compatibility with Sendmail, but has the same
4211 effect as &%-oem%&.
4212
4213 .vitem &%-oi%&
4214 .oindex "&%-oi%&"
4215 .cindex "dot" "in incoming non-SMTP message"
4216 This option, which has the same effect as &%-i%&, specifies that a dot on a
4217 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4218 single dot does terminate, though Exim does no special processing for other
4219 lines that start with a dot. This option is set by default if Exim is called as
4220 &'rmail'&. See also &%-ti%&.
4221
4222 .vitem &%-oitrue%&
4223 .oindex "&%-oitrue%&"
4224 This option is treated as synonymous with &%-oi%&.
4225
4226 .vitem &%-oMa%&&~<&'host&~address'&>
4227 .oindex "&%-oMa%&"
4228 .cindex "sender" "host address, specifying for local message"
4229 A number of options starting with &%-oM%& can be used to set values associated
4230 with remote hosts on locally-submitted messages (that is, messages not received
4231 over TCP/IP). These options can be used by any caller in conjunction with the
4232 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4233 other circumstances, they are ignored unless the caller is trusted.
4234
4235 The &%-oMa%& option sets the sender host address. This may include a port
4236 number at the end, after a full stop (period). For example:
4237 .code
4238 exim -bs -oMa 10.9.8.7.1234
4239 .endd
4240 An alternative syntax is to enclose the IP address in square brackets,
4241 followed by a colon and the port number:
4242 .code
4243 exim -bs -oMa [10.9.8.7]:1234
4244 .endd
4245 The IP address is placed in the &$sender_host_address$& variable, and the
4246 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4247 are present on the command line, the sender host IP address is taken from
4248 whichever one is last.
4249
4250 .vitem &%-oMaa%&&~<&'name'&>
4251 .oindex "&%-oMaa%&"
4252 .cindex "authentication" "name, specifying for local message"
4253 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4254 option sets the value of &$sender_host_authenticated$& (the authenticator
4255 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4256 This option can be used with &%-bh%& and &%-bs%& to set up an
4257 authenticated SMTP session without actually using the SMTP AUTH command.
4258
4259 .vitem &%-oMai%&&~<&'string'&>
4260 .oindex "&%-oMai%&"
4261 .cindex "authentication" "id, specifying for local message"
4262 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4263 option sets the value of &$authenticated_id$& (the id that was authenticated).
4264 This overrides the default value (the caller's login id, except with &%-bh%&,
4265 where there is no default) for messages from local sources. See chapter
4266 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4267
4268 .vitem &%-oMas%&&~<&'address'&>
4269 .oindex "&%-oMas%&"
4270 .cindex "authentication" "sender, specifying for local message"
4271 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4272 option sets the authenticated sender value in &$authenticated_sender$&. It
4273 overrides the sender address that is created from the caller's login id for
4274 messages from local sources, except when &%-bh%& is used, when there is no
4275 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4276 specified on a MAIL command overrides this value. See chapter
4277 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4278
4279 .vitem &%-oMi%&&~<&'interface&~address'&>
4280 .oindex "&%-oMi%&"
4281 .cindex "interface" "address, specifying for local message"
4282 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4283 option sets the IP interface address value. A port number may be included,
4284 using the same syntax as for &%-oMa%&. The interface address is placed in
4285 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4286
4287 .vitem &%-oMm%&&~<&'message&~reference'&>
4288 .oindex "&%-oMm%&"
4289 .cindex "message reference" "message reference, specifying for local message"
4290 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMm%&
4291 option sets the message reference, e.g. message-id, and is logged during
4292 delivery. This is useful when some kind of audit trail is required to tie
4293 messages together. The format of the message reference is checked and will
4294 abort if the format is invalid. The option will only be accepted if exim is
4295 running in trusted mode, not as any regular user.
4296
4297 The best example of a message reference is when Exim sends a bounce message.
4298 The message reference is the message-id of the original message for which Exim
4299 is sending the bounce.
4300
4301 .vitem &%-oMr%&&~<&'protocol&~name'&>
4302 .oindex "&%-oMr%&"
4303 .cindex "protocol, specifying for local message"
4304 .vindex "&$received_protocol$&"
4305 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4306 option sets the received protocol value that is stored in
4307 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4308 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4309 SMTP protocol names (see the description of &$received_protocol$& in section
4310 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4311 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4312 be set by &%-oMr%&. Repeated use of this option is not supported.
4313
4314 .vitem &%-oMs%&&~<&'host&~name'&>
4315 .oindex "&%-oMs%&"
4316 .cindex "sender" "host name, specifying for local message"
4317 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4318 option sets the sender host name in &$sender_host_name$&. When this option is
4319 present, Exim does not attempt to look up a host name from an IP address; it
4320 uses the name it is given.
4321
4322 .vitem &%-oMt%&&~<&'ident&~string'&>
4323 .oindex "&%-oMt%&"
4324 .cindex "sender" "ident string, specifying for local message"
4325 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4326 option sets the sender ident value in &$sender_ident$&. The default setting for
4327 local callers is the login id of the calling process, except when &%-bh%& is
4328 used, when there is no default.
4329
4330 .vitem &%-om%&
4331 .oindex "&%-om%&"
4332 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4333 In Sendmail, this option means &"me too"&, indicating that the sender of a
4334 message should receive a copy of the message if the sender appears in an alias
4335 expansion. Exim always does this, so the option does nothing.
4336
4337 .vitem &%-oo%&
4338 .oindex "&%-oo%&"
4339 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4340 This option is ignored. In Sendmail it specifies &"old style headers"&,
4341 whatever that means.
4342
4343 .vitem &%-oP%&&~<&'path'&>
4344 .oindex "&%-oP%&"
4345 .cindex "pid (process id)" "of daemon"
4346 .cindex "daemon" "process id (pid)"
4347 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4348 value. The option specifies the file to which the process id of the daemon is
4349 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4350 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4351 because in those cases, the normal pid file is not used.
4352
4353 .vitem &%-or%&&~<&'time'&>
4354 .oindex "&%-or%&"
4355 .cindex "timeout" "for non-SMTP input"
4356 This option sets a timeout value for incoming non-SMTP messages. If it is not
4357 set, Exim will wait forever for the standard input. The value can also be set
4358 by the &%receive_timeout%& option. The format used for specifying times is
4359 described in section &<<SECTtimeformat>>&.
4360
4361 .vitem &%-os%&&~<&'time'&>
4362 .oindex "&%-os%&"
4363 .cindex "timeout" "for SMTP input"
4364 .cindex "SMTP" "input timeout"
4365 This option sets a timeout value for incoming SMTP messages. The timeout
4366 applies to each SMTP command and block of data. The value can also be set by
4367 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4368 for specifying times is described in section &<<SECTtimeformat>>&.
4369
4370 .vitem &%-ov%&
4371 .oindex "&%-ov%&"
4372 This option has exactly the same effect as &%-v%&.
4373
4374 .vitem &%-oX%&&~<&'number&~or&~string'&>
4375 .oindex "&%-oX%&"
4376 .cindex "TCP/IP" "setting listening ports"
4377 .cindex "TCP/IP" "setting listening interfaces"
4378 .cindex "port" "receiving TCP/IP"
4379 This option is relevant only when the &%-bd%& (start listening daemon) option
4380 is also given. It controls which ports and interfaces the daemon uses. Details
4381 of the syntax, and how it interacts with configuration file options, are given
4382 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4383 file is written unless &%-oP%& is also present to specify a pid file name.
4384
4385 .vitem &%-pd%&
4386 .oindex "&%-pd%&"
4387 .cindex "Perl" "starting the interpreter"
4388 This option applies when an embedded Perl interpreter is linked with Exim (see
4389 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4390 option, forcing the starting of the interpreter to be delayed until it is
4391 needed.
4392
4393 .vitem &%-ps%&
4394 .oindex "&%-ps%&"
4395 .cindex "Perl" "starting the interpreter"
4396 This option applies when an embedded Perl interpreter is linked with Exim (see
4397 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4398 option, forcing the starting of the interpreter to occur as soon as Exim is
4399 started.
4400
4401 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4402 .oindex "&%-p%&"
4403 For compatibility with Sendmail, this option is equivalent to
4404 .display
4405 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4406 .endd
4407 It sets the incoming protocol and host name (for trusted callers). The
4408 host name and its colon can be omitted when only the protocol is to be set.
4409 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4410 to embedded Perl. It is therefore impossible to set a protocol value of &`d`&
4411 or &`s`& using this option (but that does not seem a real limitation).
4412 Repeated use of this option is not supported.
4413
4414 .vitem &%-q%&
4415 .oindex "&%-q%&"
4416 .cindex "queue runner" "starting manually"
4417 This option is normally restricted to admin users. However, there is a
4418 configuration option called &%prod_requires_admin%& which can be set false to
4419 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4420 and &%-S%& options).
4421
4422 .cindex "queue runner" "description of operation"
4423 If other commandline options do not specify an action,
4424 the &%-q%& option starts one queue runner process. This scans the queue of
4425 waiting messages, and runs a delivery process for each one in turn. It waits
4426 for each delivery process to finish before starting the next one. A delivery
4427 process may not actually do any deliveries if the retry times for the addresses
4428 have not been reached. Use &%-qf%& (see below) if you want to override this.
4429
4430 If
4431 .cindex "SMTP" "passed connection"
4432 .cindex "SMTP" "multiple deliveries"
4433 .cindex "multiple SMTP deliveries"
4434 the delivery process spawns other processes to deliver other messages down
4435 passed SMTP connections, the queue runner waits for these to finish before
4436 proceeding.
4437
4438 When all the queued messages have been considered, the original queue runner
4439 process terminates. In other words, a single pass is made over the waiting
4440 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4441 this to be repeated periodically.
4442
4443 Exim processes the waiting messages in an unpredictable order. It isn't very
4444 random, but it is likely to be different each time, which is all that matters.
4445 If one particular message screws up a remote MTA, other messages to the same
4446 MTA have a chance of getting through if they get tried first.
4447
4448 It is possible to cause the messages to be processed in lexical message id
4449 order, which is essentially the order in which they arrived, by setting the
4450 &%queue_run_in_order%& option, but this is not recommended for normal use.
4451
4452 .vitem &%-q%&<&'qflags'&>
4453 The &%-q%& option may be followed by one or more flag letters that change its
4454 behaviour. They are all optional, but if more than one is present, they must
4455 appear in the correct order. Each flag is described in a separate item below.
4456
4457 .vitem &%-qq...%&
4458 .oindex "&%-qq%&"
4459 .cindex "queue" "double scanning"
4460 .cindex "queue" "routing"
4461 .cindex "routing" "whole queue before delivery"
4462 An option starting with &%-qq%& requests a two-stage queue run. In the first
4463 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4464 every domain. Addresses are routed, local deliveries happen, but no remote
4465 transports are run.
4466
4467 .cindex "hints database" "remembering routing"
4468 The hints database that remembers which messages are waiting for specific hosts
4469 is updated, as if delivery to those hosts had been deferred. After this is
4470 complete, a second, normal queue scan happens, with routing and delivery taking
4471 place as normal. Messages that are routed to the same host should mostly be
4472 delivered down a single SMTP
4473 .cindex "SMTP" "passed connection"
4474 .cindex "SMTP" "multiple deliveries"
4475 .cindex "multiple SMTP deliveries"
4476 connection because of the hints that were set up during the first queue scan.
4477 This option may be useful for hosts that are connected to the Internet
4478 intermittently.
4479
4480 .vitem &%-q[q]i...%&
4481 .oindex "&%-qi%&"
4482 .cindex "queue" "initial delivery"
4483 If the &'i'& flag is present, the queue runner runs delivery processes only for
4484 those messages that haven't previously been tried. (&'i'& stands for &"initial
4485 delivery"&.) This can be helpful if you are putting messages on the queue using
4486 &%-odq%& and want a queue runner just to process the new messages.
4487
4488 .vitem &%-q[q][i]f...%&
4489 .oindex "&%-qf%&"
4490 .cindex "queue" "forcing delivery"
4491 .cindex "delivery" "forcing in queue run"
4492 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4493 message, whereas without &'f'& only those non-frozen addresses that have passed
4494 their retry times are tried.
4495
4496 .vitem &%-q[q][i]ff...%&
4497 .oindex "&%-qff%&"
4498 .cindex "frozen messages" "forcing delivery"
4499 If &'ff'& is present, a delivery attempt is forced for every message, whether
4500 frozen or not.
4501
4502 .vitem &%-q[q][i][f[f]]l%&
4503 .oindex "&%-ql%&"
4504 .cindex "queue" "local deliveries only"
4505 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4506 be done. If a message requires any remote deliveries, it remains on the queue
4507 for later delivery.
4508
4509 .vitem &%-q[q][i][f[f]][l][G<name>[/<time>]]]%&
4510 .oindex "&%-qG%&"
4511 .cindex queue named
4512 .cindex "named queues"
4513 .cindex "queue" "delivering specific messages"
4514 If the &'G'& flag and a name is present, the queue runner operates on the
4515 queue with the given name rather than the default queue.
4516 The name should not contain a &'/'& character.
4517 For a periodic queue run (see below)
4518 append to the name a slash and a time value.
4519
4520 If other commandline options specify an action, a &'-qG<name>'& option
4521 will specify a queue to operate on.
4522 For example:
4523 .code
4524 exim -bp -qGquarantine
4525 mailq -qGquarantine
4526 exim -qGoffpeak -Rf @special.domain.example
4527 .endd
4528
4529 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4530 When scanning the queue, Exim can be made to skip over messages whose ids are
4531 lexically less than a given value by following the &%-q%& option with a
4532 starting message id. For example:
4533 .code
4534 exim -q 0t5C6f-0000c8-00
4535 .endd
4536 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4537 second message id is given, messages whose ids are lexically greater than it
4538 are also skipped. If the same id is given twice, for example,
4539 .code
4540 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4541 .endd
4542 just one delivery process is started, for that message. This differs from
4543 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4544 that it counts as a delivery from a queue run. Note that the selection
4545 mechanism does not affect the order in which the messages are scanned. There
4546 are also other ways of selecting specific sets of messages for delivery in a
4547 queue run &-- see &%-R%& and &%-S%&.
4548
4549 .vitem &%-q%&<&'qflags'&><&'time'&>
4550 .cindex "queue runner" "starting periodically"
4551 .cindex "periodic queue running"
4552 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4553 starting a queue runner process at intervals specified by the given time value
4554 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4555 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4556 single daemon process handles both functions. A common way of starting up a
4557 combined daemon at system boot time is to use a command such as
4558 .code
4559 /usr/exim/bin/exim -bd -q30m
4560 .endd
4561 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4562 process every 30 minutes.
4563
4564 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4565 pid file is written unless one is explicitly requested by the &%-oP%& option.
4566
4567 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4568 .oindex "&%-qR%&"
4569 This option is synonymous with &%-R%&. It is provided for Sendmail
4570 compatibility.
4571
4572 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4573 .oindex "&%-qS%&"
4574 This option is synonymous with &%-S%&.
4575
4576 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4577 .oindex "&%-R%&"
4578 .cindex "queue runner" "for specific recipients"
4579 .cindex "delivery" "to given domain"
4580 .cindex "domain" "delivery to"
4581 The <&'rsflags'&> may be empty, in which case the white space before the string
4582 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4583 which are the possible values for <&'rsflags'&>. White space is required if
4584 <&'rsflags'&> is not empty.
4585
4586 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4587 perform a single queue run, except that, when scanning the messages on the
4588 queue, Exim processes only those that have at least one undelivered recipient
4589 address containing the given string, which is checked in a case-independent
4590 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4591 regular expression; otherwise it is a literal string.
4592
4593 If you want to do periodic queue runs for messages with specific recipients,
4594 you can combine &%-R%& with &%-q%& and a time value. For example:
4595 .code
4596 exim -q25m -R @special.domain.example
4597 .endd
4598 This example does a queue run for messages with recipients in the given domain
4599 every 25 minutes. Any additional flags that are specified with &%-q%& are
4600 applied to each queue run.
4601
4602 Once a message is selected for delivery by this mechanism, all its addresses
4603 are processed. For the first selected message, Exim overrides any retry
4604 information and forces a delivery attempt for each undelivered address. This
4605 means that if delivery of any address in the first message is successful, any
4606 existing retry information is deleted, and so delivery attempts for that
4607 address in subsequently selected messages (which are processed without forcing)
4608 will run. However, if delivery of any address does not succeed, the retry
4609 information is updated, and in subsequently selected messages, the failing
4610 address will be skipped.
4611
4612 .cindex "frozen messages" "forcing delivery"
4613 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4614 all selected messages, not just the first; frozen messages are included when
4615 &'ff'& is present.
4616
4617 The &%-R%& option makes it straightforward to initiate delivery of all messages
4618 to a given domain after a host has been down for some time. When the SMTP
4619 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4620 effect is to run Exim with the &%-R%& option, but it can be configured to run
4621 an arbitrary command instead.
4622
4623 .vitem &%-r%&
4624 .oindex "&%-r%&"
4625 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4626
4627 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4628 .oindex "&%-S%&"
4629 .cindex "delivery" "from given sender"
4630 .cindex "queue runner" "for specific senders"
4631 This option acts like &%-R%& except that it checks the string against each
4632 message's sender instead of against the recipients. If &%-R%& is also set, both
4633 conditions must be met for a message to be selected. If either of the options
4634 has &'f'& or &'ff'& in its flags, the associated action is taken.
4635
4636 .vitem &%-Tqt%&&~<&'times'&>
4637 .oindex "&%-Tqt%&"
4638 This is an option that is exclusively for use by the Exim testing suite. It is not
4639 recognized when Exim is run normally. It allows for the setting up of explicit
4640 &"queue times"& so that various warning/retry features can be tested.
4641
4642 .vitem &%-t%&
4643 .oindex "&%-t%&"
4644 .cindex "recipient" "extracting from header lines"
4645 .cindex "&'Bcc:'& header line"
4646 .cindex "&'Cc:'& header line"
4647 .cindex "&'To:'& header line"
4648 When Exim is receiving a locally-generated, non-SMTP message on its standard
4649 input, the &%-t%& option causes the recipients of the message to be obtained
4650 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4651 from the command arguments. The addresses are extracted before any rewriting
4652 takes place and the &'Bcc:'& header line, if present, is then removed.
4653
4654 .cindex "Sendmail compatibility" "&%-t%& option"
4655 If the command has any arguments, they specify addresses to which the message
4656 is &'not'& to be delivered. That is, the argument addresses are removed from
4657 the recipients list obtained from the headers. This is compatible with Smail 3
4658 and in accordance with the documented behaviour of several versions of
4659 Sendmail, as described in man pages on a number of operating systems (e.g.
4660 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4661 argument addresses to those obtained from the headers, and the O'Reilly
4662 Sendmail book documents it that way. Exim can be made to add argument addresses
4663 instead of subtracting them by setting the option
4664 &%extract_addresses_remove_arguments%& false.
4665
4666 .cindex "&%Resent-%& header lines" "with &%-t%&"
4667 If there are any &%Resent-%& header lines in the message, Exim extracts
4668 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4669 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4670 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4671 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4672
4673 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4674 message is resent several times). The RFC also specifies that they should be
4675 added at the front of the message, and separated by &'Received:'& lines. It is
4676 not at all clear how &%-t%& should operate in the present of multiple sets,
4677 nor indeed exactly what constitutes a &"set"&.
4678 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4679 are often added at the end of the header, and if a message is resent more than
4680 once, it is common for the original set of &%Resent-%& headers to be renamed as
4681 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4682
4683 .vitem &%-ti%&
4684 .oindex "&%-ti%&"
4685 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4686 compatibility with Sendmail.
4687
4688 .vitem &%-tls-on-connect%&
4689 .oindex "&%-tls-on-connect%&"
4690 .cindex "TLS" "use without STARTTLS"
4691 .cindex "TLS" "automatic start"
4692 This option is available when Exim is compiled with TLS support. It forces all
4693 incoming SMTP connections to behave as if the incoming port is listed in the
4694 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4695 &<<CHAPTLS>>& for further details.
4696
4697
4698 .vitem &%-U%&
4699 .oindex "&%-U%&"
4700 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4701 Sendmail uses this option for &"initial message submission"&, and its
4702 documentation states that in future releases, it may complain about
4703 syntactically invalid messages rather than fixing them when this flag is not
4704 set. Exim ignores this option.
4705
4706 .vitem &%-v%&
4707 .oindex "&%-v%&"
4708 This option causes Exim to write information to the standard error stream,
4709 describing what it is doing. In particular, it shows the log lines for
4710 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4711 dialogue is shown. Some of the log lines shown may not actually be written to
4712 the log if the setting of &%log_selector%& discards them. Any relevant
4713 selectors are shown with each log line. If none are shown, the logging is
4714 unconditional.
4715
4716 .vitem &%-x%&
4717 .oindex "&%-x%&"
4718 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4719 National Language Support extended characters in the body of the mail item"&).
4720 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4721 this option.
4722
4723 .vitem &%-X%&&~<&'logfile'&>
4724 .oindex "&%-X%&"
4725 This option is interpreted by Sendmail to cause debug information to be sent
4726 to the named file.  It is ignored by Exim.
4727
4728 .vitem &%-z%&&~<&'log-line'&>
4729 .oindex "&%-z%&"
4730 This option writes its argument to Exim's logfile.
4731 Use is restricted to administrators; the intent is for operational notes.
4732 Quotes should be used to maintain a multi-word item as a single argument,
4733 under most shells.
4734 .endlist
4735
4736 .ecindex IIDclo1
4737 .ecindex IIDclo2
4738
4739
4740 . ////////////////////////////////////////////////////////////////////////////
4741 . Insert a stylized DocBook comment here, to identify the end of the command
4742 . line options. This is for the benefit of the Perl script that automatically
4743 . creates a man page for the options.
4744 . ////////////////////////////////////////////////////////////////////////////
4745
4746 .literal xml
4747 <!-- === End of command line options === -->
4748 .literal off
4749
4750
4751
4752
4753
4754 . ////////////////////////////////////////////////////////////////////////////
4755 . ////////////////////////////////////////////////////////////////////////////
4756
4757
4758 .chapter "The Exim run time configuration file" "CHAPconf" &&&
4759          "The runtime configuration file"
4760
4761 .cindex "run time configuration"
4762 .cindex "configuration file" "general description"
4763 .cindex "CONFIGURE_FILE"
4764 .cindex "configuration file" "errors in"
4765 .cindex "error" "in configuration file"
4766 .cindex "return code" "for bad configuration"
4767 Exim uses a single run time configuration file that is read whenever an Exim
4768 binary is executed. Note that in normal operation, this happens frequently,
4769 because Exim is designed to operate in a distributed manner, without central
4770 control.
4771
4772 If a syntax error is detected while reading the configuration file, Exim
4773 writes a message on the standard error, and exits with a non-zero return code.
4774 The message is also written to the panic log. &*Note*&: Only simple syntax
4775 errors can be detected at this time. The values of any expanded options are
4776 not checked until the expansion happens, even when the expansion does not
4777 actually alter the string.
4778
4779 The name of the configuration file is compiled into the binary for security
4780 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4781 most configurations, this specifies a single file. However, it is permitted to
4782 give a colon-separated list of file names, in which case Exim uses the first
4783 existing file in the list.
4784
4785 .cindex "EXIM_USER"
4786 .cindex "EXIM_GROUP"
4787 .cindex "CONFIGURE_OWNER"
4788 .cindex "CONFIGURE_GROUP"
4789 .cindex "configuration file" "ownership"
4790 .cindex "ownership" "configuration file"
4791 The run time configuration file must be owned by root or by the user that is
4792 specified at compile time by the CONFIGURE_OWNER option (if set). The
4793 configuration file must not be world-writeable, or group-writeable unless its
4794 group is the root group or the one specified at compile time by the
4795 CONFIGURE_GROUP option.
4796
4797 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4798 to root, anybody who is able to edit the run time configuration file has an
4799 easy way to run commands as root. If you specify a user or group in the
4800 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4801 who are members of that group will trivially be able to obtain root privileges.
4802
4803 Up to Exim version 4.72, the run time configuration file was also permitted to
4804 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4805 since it offered a simple privilege escalation for any attacker who managed to
4806 compromise the Exim user account.
4807
4808 A default configuration file, which will work correctly in simple situations,
4809 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4810 defines just one file name, the installation process copies the default
4811 configuration to a new file of that name if it did not previously exist. If
4812 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4813 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4814 configuration.
4815
4816
4817
4818 .section "Using a different configuration file" "SECID40"
4819 .cindex "configuration file" "alternate"
4820 A one-off alternate configuration can be specified by the &%-C%& command line
4821 option, which may specify a single file or a list of files. However, when
4822 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4823 unless the argument for &%-C%& is identical to the built-in value from
4824 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4825 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4826 is useful mainly for checking the syntax of configuration files before
4827 installing them. No owner or group checks are done on a configuration file
4828 specified by &%-C%&, if root privilege has been dropped.
4829
4830 Even the Exim user is not trusted to specify an arbitrary configuration file
4831 with the &%-C%& option to be used with root privileges, unless that file is
4832 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4833 testing a configuration using &%-C%& right through message reception and
4834 delivery, even if the caller is root. The reception works, but by that time,
4835 Exim is running as the Exim user, so when it re-execs to regain privilege for
4836 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4837 can test reception and delivery using two separate commands (one to put a
4838 message on the queue, using &%-odq%&, and another to do the delivery, using
4839 &%-M%&).
4840
4841 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4842 prefix string with which any file named in a &%-C%& command line option must
4843 start. In addition, the file name must not contain the sequence &"&`/../`&"&.
4844 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any file
4845 name can be used with &%-C%&.
4846
4847 One-off changes to a configuration can be specified by the &%-D%& command line
4848 option, which defines and overrides values for macros used inside the
4849 configuration file. However, like &%-C%&, the use of this option by a
4850 non-privileged user causes Exim to discard its root privilege.
4851 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4852 completely disabled, and its use causes an immediate error exit.
4853
4854 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4855 to declare certain macro names trusted, such that root privilege will not
4856 necessarily be discarded.
4857 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4858 considered safe and, if &%-D%& only supplies macros from this list, and the
4859 values are acceptable, then Exim will not give up root privilege if the caller
4860 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4861 transition mechanism and is expected to be removed in the future.  Acceptable
4862 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4863
4864 Some sites may wish to use the same Exim binary on different machines that
4865 share a file system, but to use different configuration files on each machine.
4866 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4867 looks for a file whose name is the configuration file name followed by a dot
4868 and the machine's node name, as obtained from the &[uname()]& function. If this
4869 file does not exist, the standard name is tried. This processing occurs for
4870 each file name in the list given by CONFIGURE_FILE or &%-C%&.
4871
4872 In some esoteric situations different versions of Exim may be run under
4873 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4874 help with this. See the comments in &_src/EDITME_& for details.
4875
4876
4877
4878 .section "Configuration file format" "SECTconffilfor"
4879 .cindex "configuration file" "format of"
4880 .cindex "format" "configuration file"
4881 Exim's configuration file is divided into a number of different parts. General
4882 option settings must always appear at the start of the file. The other parts
4883 are all optional, and may appear in any order. Each part other than the first
4884 is introduced by the word &"begin"& followed by at least one literal
4885 space, and the name of the part. The optional parts are:
4886
4887 .ilist
4888 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4889 &<<CHAPACL>>&).
4890 .next
4891 .cindex "AUTH" "configuration"
4892 &'authenticators'&: Configuration settings for the authenticator drivers. These
4893 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4894 .next
4895 &'routers'&: Configuration settings for the router drivers. Routers process
4896 addresses and determine how the message is to be delivered (see chapters
4897 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4898 .next
4899 &'transports'&: Configuration settings for the transport drivers. Transports
4900 define mechanisms for copying messages to destinations (see chapters
4901 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4902 .next
4903 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4904 If there is no retry section, or if it is empty (that is, no retry rules are
4905 defined), Exim will not retry deliveries. In this situation, temporary errors
4906 are treated the same as permanent errors. Retry rules are discussed in chapter
4907 &<<CHAPretry>>&.
4908 .next
4909 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4910 when new addresses are generated during delivery. Rewriting is discussed in
4911 chapter &<<CHAPrewrite>>&.
4912 .next
4913 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4914 want to use this feature, you must set
4915 .code
4916 LOCAL_SCAN_HAS_OPTIONS=yes
4917 .endd
4918 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4919 facility are given in chapter &<<CHAPlocalscan>>&.
4920 .endlist
4921
4922 .cindex "configuration file" "leading white space in"
4923 .cindex "configuration file" "trailing white space in"
4924 .cindex "white space" "in configuration file"
4925 Leading and trailing white space in configuration lines is always ignored.
4926
4927 Blank lines in the file, and lines starting with a # character (ignoring
4928 leading white space) are treated as comments and are ignored. &*Note*&: A
4929 # character other than at the beginning of a line is not treated specially,
4930 and does not introduce a comment.
4931
4932 Any non-comment line can be continued by ending it with a backslash. Note that
4933 the general rule for white space means that trailing white space after the
4934 backslash and leading white space at the start of continuation
4935 lines is ignored. Comment lines beginning with # (but not empty lines) may
4936 appear in the middle of a sequence of continuation lines.
4937
4938 A convenient way to create a configuration file is to start from the
4939 default, which is supplied in &_src/configure.default_&, and add, delete, or
4940 change settings as required.
4941
4942 The ACLs, retry rules, and rewriting rules have their own syntax which is
4943 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
4944 respectively. The other parts of the configuration file have some syntactic
4945 items in common, and these are described below, from section &<<SECTcos>>&
4946 onwards. Before that, the inclusion, macro, and conditional facilities are
4947 described.
4948
4949
4950
4951 .section "File inclusions in the configuration file" "SECID41"
4952 .cindex "inclusions in configuration file"
4953 .cindex "configuration file" "including other files"
4954 .cindex "&`.include`& in configuration file"
4955 .cindex "&`.include_if_exists`& in configuration file"
4956 You can include other files inside Exim's run time configuration file by
4957 using this syntax:
4958 .display
4959 &`.include`& <&'file name'&>
4960 &`.include_if_exists`& <&'file name'&>
4961 .endd
4962 on a line by itself. Double quotes round the file name are optional. If you use
4963 the first form, a configuration error occurs if the file does not exist; the
4964 second form does nothing for non-existent files.
4965 The first form allows a relative name. It is resolved relative to
4966 the directory of the including file. For the second form an absolute file
4967 name is required.
4968
4969 Includes may be nested to any depth, but remember that Exim reads its
4970 configuration file often, so it is a good idea to keep them to a minimum.
4971 If you change the contents of an included file, you must HUP the daemon,
4972 because an included file is read only when the configuration itself is read.
4973
4974 The processing of inclusions happens early, at a physical line level, so, like
4975 comment lines, an inclusion can be used in the middle of an option setting,
4976 for example:
4977 .code
4978 hosts_lookup = a.b.c \
4979                .include /some/file
4980 .endd
4981 Include processing happens after macro processing (see below). Its effect is to
4982 process the lines of the included file as if they occurred inline where the
4983 inclusion appears.
4984
4985
4986
4987 .section "Macros in the configuration file" "SECTmacrodefs"
4988 .cindex "macro" "description of"
4989 .cindex "configuration file" "macros"
4990 If a line in the main part of the configuration (that is, before the first
4991 &"begin"& line) begins with an upper case letter, it is taken as a macro
4992 definition, and must be of the form
4993 .display
4994 <&'name'&> = <&'rest of line'&>
4995 .endd
4996 The name must consist of letters, digits, and underscores, and need not all be
4997 in upper case, though that is recommended. The rest of the line, including any
4998 continuations, is the replacement text, and has leading and trailing white
4999 space removed. Quotes are not removed. The replacement text can never end with
5000 a backslash character, but this doesn't seem to be a serious limitation.
5001
5002 Macros may also be defined between router, transport, authenticator, or ACL
5003 definitions. They may not, however, be defined within an individual driver or
5004 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
5005
5006 .section "Macro substitution" "SECID42"
5007 Once a macro is defined, all subsequent lines in the file (and any included
5008 files) are scanned for the macro name; if there are several macros, the line is
5009 scanned for each in turn, in the order in which the macros are defined. The
5010 replacement text is not re-scanned for the current macro, though it is scanned
5011 for subsequently defined macros. For this reason, a macro name may not contain
5012 the name of a previously defined macro as a substring. You could, for example,
5013 define
5014 .display
5015 &`ABCD_XYZ = `&<&'something'&>
5016 &`ABCD = `&<&'something else'&>
5017 .endd
5018 but putting the definitions in the opposite order would provoke a configuration
5019 error. Macro expansion is applied to individual physical lines from the file,
5020 before checking for line continuation or file inclusion (see above). If a line
5021 consists solely of a macro name, and the expansion of the macro is empty, the
5022 line is ignored. A macro at the start of a line may turn the line into a
5023 comment line or a &`.include`& line.
5024
5025
5026 .section "Redefining macros" "SECID43"
5027 Once defined, the value of a macro can be redefined later in the configuration
5028 (or in an included file). Redefinition is specified by using &'=='& instead of
5029 &'='&. For example:
5030 .code
5031 MAC =  initial value
5032 ...
5033 MAC == updated value
5034 .endd
5035 Redefinition does not alter the order in which the macros are applied to the
5036 subsequent lines of the configuration file. It is still the same order in which
5037 the macros were originally defined. All that changes is the macro's value.
5038 Redefinition makes it possible to accumulate values. For example:
5039 .code
5040 MAC =  initial value
5041 ...
5042 MAC == MAC and something added
5043 .endd
5044 This can be helpful in situations where the configuration file is built
5045 from a number of other files.
5046
5047 .section "Overriding macro values" "SECID44"
5048 The values set for macros in the configuration file can be overridden by the
5049 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
5050 used, unless called by root or the Exim user. A definition on the command line
5051 using the &%-D%& option causes all definitions and redefinitions within the
5052 file to be ignored.
5053
5054
5055
5056 .section "Example of macro usage" "SECID45"
5057 As an example of macro usage, consider a configuration where aliases are looked
5058 up in a MySQL database. It helps to keep the file less cluttered if long
5059 strings such as SQL statements are defined separately as macros, for example:
5060 .code
5061 ALIAS_QUERY = select mailbox from user where \
5062               login='${quote_mysql:$local_part}';
5063 .endd
5064 This can then be used in a &(redirect)& router setting like this:
5065 .code
5066 data = ${lookup mysql{ALIAS_QUERY}}
5067 .endd
5068 In earlier versions of Exim macros were sometimes used for domain, host, or
5069 address lists. In Exim 4 these are handled better by named lists &-- see
5070 section &<<SECTnamedlists>>&.
5071
5072
5073 .section "Builtin macros" "SECTbuiltinmacros"
5074 Exim defines some macros depending on facilities available, which may
5075 differ due to build-time definitions and from one release to another.
5076 All of these macros start with an underscore.
5077 They can be used to conditionally include parts of a configuration
5078 (see below).
5079
5080 The following classes of macros are defined:
5081 .display
5082 &` _HAVE_*                    `&  build-time defines
5083 &` _DRIVER_ROUTER_*           `&  router drivers
5084 &` _DRIVER_TRANSPORT_*        `&  transport drivers
5085 &` _DRIVER_AUTHENTICATOR_*    `&  authenticator drivers
5086 &` _OPT_MAIN_*                `&  main config options
5087 &` _OPT_ROUTERS_*             `&  generic router options
5088 &` _OPT_TRANSPORTS_*          `&  generic transport options
5089 &` _OPT_AUTHENTICATORS_*      `&  generic authenticator options
5090 &` _OPT_ROUTER_*_*            `&  private router options
5091 &` _OPT_TRANSPORT_*_*         `&  private transport options
5092 &` _OPT_AUTHENTICATOR_*_*     `&  private authenticator options
5093 .endd
5094
5095 Use an &"exim -bP macros"& command to get the list of macros.
5096
5097
5098 .section "Conditional skips in the configuration file" "SECID46"
5099 .cindex "configuration file" "conditional skips"
5100 .cindex "&`.ifdef`&"
5101 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
5102 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
5103 portions of the configuration file. The processing happens whenever the file is
5104 read (that is, when an Exim binary starts to run).
5105
5106 The implementation is very simple. Instances of the first four directives must
5107 be followed by text that includes the names of one or macros. The condition
5108 that is tested is whether or not any macro substitution has taken place in the
5109 line. Thus:
5110 .code
5111 .ifdef AAA
5112 message_size_limit = 50M
5113 .else
5114 message_size_limit = 100M
5115 .endif
5116 .endd
5117 sets a message size limit of 50M if the macro &`AAA`& is defined
5118 (or &`A`& or &`AA`&), and 100M
5119 otherwise. If there is more than one macro named on the line, the condition
5120 is true if any of them are defined. That is, it is an &"or"& condition. To
5121 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
5122
5123 Although you can use a macro expansion to generate one of these directives,
5124 it is not very useful, because the condition &"there was a macro substitution
5125 in this line"& will always be true.
5126
5127 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
5128 to clarify complicated nestings.
5129
5130
5131
5132 .section "Common option syntax" "SECTcos"
5133 .cindex "common option syntax"
5134 .cindex "syntax of common options"
5135 .cindex "configuration file" "common option syntax"
5136 For the main set of options, driver options, and &[local_scan()]& options,
5137 each setting is on a line by itself, and starts with a name consisting of
5138 lower-case letters and underscores. Many options require a data value, and in
5139 these cases the name must be followed by an equals sign (with optional white
5140 space) and then the value. For example:
5141 .code
5142 qualify_domain = mydomain.example.com
5143 .endd
5144 .cindex "hiding configuration option values"
5145 .cindex "configuration options" "hiding value of"
5146 .cindex "options" "hiding value of"
5147 Some option settings may contain sensitive data, for example, passwords for
5148 accessing databases. To stop non-admin users from using the &%-bP%& command
5149 line option to read these values, you can precede the option settings with the
5150 word &"hide"&. For example:
5151 .code
5152 hide mysql_servers = localhost/users/admin/secret-password
5153 .endd
5154 For non-admin users, such options are displayed like this:
5155 .code
5156 mysql_servers = <value not displayable>
5157 .endd
5158 If &"hide"& is used on a driver option, it hides the value of that option on
5159 all instances of the same driver.
5160
5161 The following sections describe the syntax used for the different data types
5162 that are found in option settings.
5163
5164
5165 .section "Boolean options" "SECID47"
5166 .cindex "format" "boolean"
5167 .cindex "boolean configuration values"
5168 .oindex "&%no_%&&'xxx'&"
5169 .oindex "&%not_%&&'xxx'&"
5170 Options whose type is given as boolean are on/off switches. There are two
5171 different ways of specifying such options: with and without a data value. If
5172 the option name is specified on its own without data, the switch is turned on;
5173 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5174 boolean options may be followed by an equals sign and one of the words
5175 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5176 the following two settings have exactly the same effect:
5177 .code
5178 queue_only
5179 queue_only = true
5180 .endd
5181 The following two lines also have the same (opposite) effect:
5182 .code
5183 no_queue_only
5184 queue_only = false
5185 .endd
5186 You can use whichever syntax you prefer.
5187
5188
5189
5190
5191 .section "Integer values" "SECID48"
5192 .cindex "integer configuration values"
5193 .cindex "format" "integer"
5194 If an option's type is given as &"integer"&, the value can be given in decimal,
5195 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5196 number is assumed. Otherwise, it is treated as an octal number unless it starts
5197 with the characters &"0x"&, in which case the remainder is interpreted as a
5198 hexadecimal number.
5199
5200 If an integer value is followed by the letter K, it is multiplied by 1024; if
5201 it is followed by the letter M, it is multiplied by 1024x1024;
5202 if by the letter G, 1024x1024x1024.
5203 When the values
5204 of integer option settings are output, values which are an exact multiple of
5205 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5206 and M. The printing style is independent of the actual input format that was
5207 used.
5208
5209
5210 .section "Octal integer values" "SECID49"
5211 .cindex "integer format"
5212 .cindex "format" "octal integer"
5213 If an option's type is given as &"octal integer"&, its value is always
5214 interpreted as an octal number, whether or not it starts with the digit zero.
5215 Such options are always output in octal.
5216
5217
5218 .section "Fixed point numbers" "SECID50"
5219 .cindex "fixed point configuration values"
5220 .cindex "format" "fixed point"
5221 If an option's type is given as &"fixed-point"&, its value must be a decimal
5222 integer, optionally followed by a decimal point and up to three further digits.
5223
5224
5225
5226 .section "Time intervals" "SECTtimeformat"
5227 .cindex "time interval" "specifying in configuration"
5228 .cindex "format" "time interval"
5229 A time interval is specified as a sequence of numbers, each followed by one of
5230 the following letters, with no intervening white space:
5231
5232 .table2 30pt
5233 .irow &%s%& seconds
5234 .irow &%m%& minutes
5235 .irow &%h%& hours
5236 .irow &%d%& days
5237 .irow &%w%& weeks
5238 .endtable
5239
5240 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5241 intervals are output in the same format. Exim does not restrict the values; it
5242 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5243
5244
5245
5246 .section "String values" "SECTstrings"
5247 .cindex "string" "format of configuration values"
5248 .cindex "format" "string"
5249 If an option's type is specified as &"string"&, the value can be specified with
5250 or without double-quotes. If it does not start with a double-quote, the value
5251 consists of the remainder of the line plus any continuation lines, starting at
5252 the first character after any leading white space, with trailing white space
5253 removed, and with no interpretation of the characters in the string. Because
5254 Exim removes comment lines (those beginning with #) at an early stage, they can
5255 appear in the middle of a multi-line string. The following two settings are
5256 therefore equivalent:
5257 .code
5258 trusted_users = uucp:mail
5259 trusted_users = uucp:\
5260                 # This comment line is ignored
5261                 mail
5262 .endd
5263 .cindex "string" "quoted"
5264 .cindex "escape characters in quoted strings"
5265 If a string does start with a double-quote, it must end with a closing
5266 double-quote, and any backslash characters other than those used for line
5267 continuation are interpreted as escape characters, as follows:
5268
5269 .table2 100pt
5270 .irow &`\\`&                     "single backslash"
5271 .irow &`\n`&                     "newline"
5272 .irow &`\r`&                     "carriage return"
5273 .irow &`\t`&                     "tab"
5274 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5275 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5276                                    character"
5277 .endtable
5278
5279 If a backslash is followed by some other character, including a double-quote
5280 character, that character replaces the pair.
5281
5282 Quoting is necessary only if you want to make use of the backslash escapes to
5283 insert special characters, or if you need to specify a value with leading or
5284 trailing spaces. These cases are rare, so quoting is almost never needed in
5285 current versions of Exim. In versions of Exim before 3.14, quoting was required
5286 in order to continue lines, so you may come across older configuration files
5287 and examples that apparently quote unnecessarily.
5288
5289
5290 .section "Expanded strings" "SECID51"
5291 .cindex "expansion" "definition of"
5292 Some strings in the configuration file are subjected to &'string expansion'&,
5293 by which means various parts of the string may be changed according to the
5294 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5295 is as just described; in particular, the handling of backslashes in quoted
5296 strings is done as part of the input process, before expansion takes place.
5297 However, backslash is also an escape character for the expander, so any
5298 backslashes that are required for that reason must be doubled if they are
5299 within a quoted configuration string.
5300
5301
5302 .section "User and group names" "SECID52"
5303 .cindex "user name" "format of"
5304 .cindex "format" "user name"
5305 .cindex "groups" "name format"
5306 .cindex "format" "group name"
5307 User and group names are specified as strings, using the syntax described
5308 above, but the strings are interpreted specially. A user or group name must
5309 either consist entirely of digits, or be a name that can be looked up using the
5310 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5311
5312
5313 .section "List construction" "SECTlistconstruct"
5314 .cindex "list" "syntax of in configuration"
5315 .cindex "format" "list item in configuration"
5316 .cindex "string" "list, definition of"
5317 The data for some configuration options is a list of items, with colon as the
5318 default separator. Many of these options are shown with type &"string list"& in
5319 the descriptions later in this document. Others are listed as &"domain list"&,
5320 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5321 are all the same; however, those other than &"string list"& are subject to
5322 particular kinds of interpretation, as described in chapter
5323 &<<CHAPdomhosaddlists>>&.
5324
5325 In all these cases, the entire list is treated as a single string as far as the
5326 input syntax is concerned. The &%trusted_users%& setting in section
5327 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5328 in a list, it must be entered as two colons. Leading and trailing white space
5329 on each item in a list is ignored. This makes it possible to include items that
5330 start with a colon, and in particular, certain forms of IPv6 address. For
5331 example, the list
5332 .code
5333 local_interfaces = 127.0.0.1 : ::::1
5334 .endd
5335 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5336
5337 &*Note*&: Although leading and trailing white space is ignored in individual
5338 list items, it is not ignored when parsing the list. The space after the first
5339 colon in the example above is necessary. If it were not there, the list would
5340 be interpreted as the two items 127.0.0.1:: and 1.
5341
5342 .section "Changing list separators" "SECTlistsepchange"
5343 .cindex "list separator" "changing"
5344 .cindex "IPv6" "addresses in lists"
5345 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5346 introduced to allow the separator character to be changed. If a list begins
5347 with a left angle bracket, followed by any punctuation character, that
5348 character is used instead of colon as the list separator. For example, the list
5349 above can be rewritten to use a semicolon separator like this:
5350 .code
5351 local_interfaces = <; 127.0.0.1 ; ::1
5352 .endd
5353 This facility applies to all lists, with the exception of the list in
5354 &%log_file_path%&. It is recommended that the use of non-colon separators be
5355 confined to circumstances where they really are needed.
5356
5357 .cindex "list separator" "newline as"
5358 .cindex "newline" "as list separator"
5359 It is also possible to use newline and other control characters (those with
5360 code values less than 32, plus DEL) as separators in lists. Such separators
5361 must be provided literally at the time the list is processed. For options that
5362 are string-expanded, you can write the separator using a normal escape
5363 sequence. This will be processed by the expander before the string is
5364 interpreted as a list. For example, if a newline-separated list of domains is
5365 generated by a lookup, you can process it directly by a line such as this:
5366 .code
5367 domains = <\n ${lookup mysql{.....}}
5368 .endd
5369 This avoids having to change the list separator in such data. You are unlikely
5370 to want to use a control character as a separator in an option that is not
5371 expanded, because the value is literal text. However, it can be done by giving
5372 the value in quotes. For example:
5373 .code
5374 local_interfaces = "<\n 127.0.0.1 \n ::1"
5375 .endd
5376 Unlike printing character separators, which can be included in list items by
5377 doubling, it is not possible to include a control character as data when it is
5378 set as the separator. Two such characters in succession are interpreted as
5379 enclosing an empty list item.
5380
5381
5382
5383 .section "Empty items in lists" "SECTempitelis"
5384 .cindex "list" "empty item in"
5385 An empty item at the end of a list is always ignored. In other words, trailing
5386 separator characters are ignored. Thus, the list in
5387 .code
5388 senders = user@domain :
5389 .endd
5390 contains only a single item. If you want to include an empty string as one item
5391 in a list, it must not be the last item. For example, this list contains three
5392 items, the second of which is empty:
5393 .code
5394 senders = user1@domain : : user2@domain
5395 .endd
5396 &*Note*&: There must be white space between the two colons, as otherwise they
5397 are interpreted as representing a single colon data character (and the list
5398 would then contain just one item). If you want to specify a list that contains
5399 just one, empty item, you can do it as in this example:
5400 .code
5401 senders = :
5402 .endd
5403 In this case, the first item is empty, and the second is discarded because it
5404 is at the end of the list.
5405
5406
5407
5408
5409 .section "Format of driver configurations" "SECTfordricon"
5410 .cindex "drivers" "configuration format"
5411 There are separate parts in the configuration for defining routers, transports,
5412 and authenticators. In each part, you are defining a number of driver
5413 instances, each with its own set of options. Each driver instance is defined by
5414 a sequence of lines like this:
5415 .display
5416 <&'instance name'&>:
5417   <&'option'&>
5418   ...
5419   <&'option'&>
5420 .endd
5421 In the following example, the instance name is &(localuser)&, and it is
5422 followed by three options settings:
5423 .code
5424 localuser:
5425   driver = accept
5426   check_local_user
5427   transport = local_delivery
5428 .endd
5429 For each driver instance, you specify which Exim code module it uses &-- by the
5430 setting of the &%driver%& option &-- and (optionally) some configuration
5431 settings. For example, in the case of transports, if you want a transport to
5432 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5433 a local file you would use the &(appendfile)& driver. Each of the drivers is
5434 described in detail in its own separate chapter later in this manual.
5435
5436 You can have several routers, transports, or authenticators that are based on
5437 the same underlying driver (each must have a different instance name).
5438
5439 The order in which routers are defined is important, because addresses are
5440 passed to individual routers one by one, in order. The order in which
5441 transports are defined does not matter at all. The order in which
5442 authenticators are defined is used only when Exim, as a client, is searching
5443 them to find one that matches an authentication mechanism offered by the
5444 server.
5445
5446 .cindex "generic options"
5447 .cindex "options" "generic &-- definition of"
5448 Within a driver instance definition, there are two kinds of option: &'generic'&
5449 and &'private'&. The generic options are those that apply to all drivers of the
5450 same type (that is, all routers, all transports or all authenticators). The
5451 &%driver%& option is a generic option that must appear in every definition.
5452 .cindex "private options"
5453 The private options are special for each driver, and none need appear, because
5454 they all have default values.
5455
5456 The options may appear in any order, except that the &%driver%& option must
5457 precede any private options, since these depend on the particular driver. For
5458 this reason, it is recommended that &%driver%& always be the first option.
5459
5460 Driver instance names, which are used for reference in log entries and
5461 elsewhere, can be any sequence of letters, digits, and underscores (starting
5462 with a letter) and must be unique among drivers of the same type. A router and
5463 a transport (for example) can each have the same name, but no two router
5464 instances can have the same name. The name of a driver instance should not be
5465 confused with the name of the underlying driver module. For example, the
5466 configuration lines:
5467 .code
5468 remote_smtp:
5469   driver = smtp
5470 .endd
5471 create an instance of the &(smtp)& transport driver whose name is
5472 &(remote_smtp)&. The same driver code can be used more than once, with
5473 different instance names and different option settings each time. A second
5474 instance of the &(smtp)& transport, with different options, might be defined
5475 thus:
5476 .code
5477 special_smtp:
5478   driver = smtp
5479   port = 1234
5480   command_timeout = 10s
5481 .endd
5482 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5483 these transport instances from routers, and these names would appear in log
5484 lines.
5485
5486 Comment lines may be present in the middle of driver specifications. The full
5487 list of option settings for any particular driver instance, including all the
5488 defaulted values, can be extracted by making use of the &%-bP%& command line
5489 option.
5490
5491
5492
5493
5494
5495
5496 . ////////////////////////////////////////////////////////////////////////////
5497 . ////////////////////////////////////////////////////////////////////////////
5498
5499 .chapter "The default configuration file" "CHAPdefconfil"
5500 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5501 .cindex "default" "configuration file &""walk through""&"
5502 The default configuration file supplied with Exim as &_src/configure.default_&
5503 is sufficient for a host with simple mail requirements. As an introduction to
5504 the way Exim is configured, this chapter &"walks through"& the default
5505 configuration, giving brief explanations of the settings. Detailed descriptions
5506 of the options are given in subsequent chapters. The default configuration file
5507 itself contains extensive comments about ways you might want to modify the
5508 initial settings. However, note that there are many options that are not
5509 mentioned at all in the default configuration.
5510
5511
5512
5513 .section "Main configuration settings" "SECTdefconfmain"
5514 The main (global) configuration option settings must always come first in the
5515 file. The first thing you'll see in the file, after some initial comments, is
5516 the line
5517 .code
5518 # primary_hostname =
5519 .endd
5520 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5521 to know the official, fully qualified name of your host, and this is where you
5522 can specify it. However, in most cases you do not need to set this option. When
5523 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5524
5525 The first three non-comment configuration lines are as follows:
5526 .code
5527 domainlist local_domains    = @
5528 domainlist relay_to_domains =
5529 hostlist   relay_from_hosts = 127.0.0.1
5530 .endd
5531 These are not, in fact, option settings. They are definitions of two named
5532 domain lists and one named host list. Exim allows you to give names to lists of
5533 domains, hosts, and email addresses, in order to make it easier to manage the
5534 configuration file (see section &<<SECTnamedlists>>&).
5535
5536 The first line defines a domain list called &'local_domains'&; this is used
5537 later in the configuration to identify domains that are to be delivered
5538 on the local host.
5539
5540 .cindex "@ in a domain list"
5541 There is just one item in this list, the string &"@"&. This is a special form
5542 of entry which means &"the name of the local host"&. Thus, if the local host is
5543 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5544 be delivered locally. Because the local host's name is referenced indirectly,
5545 the same configuration file can be used on different hosts.
5546
5547 The second line defines a domain list called &'relay_to_domains'&, but the
5548 list itself is empty. Later in the configuration we will come to the part that
5549 controls mail relaying through the local host; it allows relaying to any
5550 domains in this list. By default, therefore, no relaying on the basis of a mail
5551 domain is permitted.
5552
5553 The third line defines a host list called &'relay_from_hosts'&. This list is
5554 used later in the configuration to permit relaying from any host or IP address
5555 that matches the list. The default contains just the IP address of the IPv4
5556 loopback interface, which means that processes on the local host are able to
5557 submit mail for relaying by sending it over TCP/IP to that interface. No other
5558 hosts are permitted to submit messages for relaying.
5559
5560 Just to be sure there's no misunderstanding: at this point in the configuration
5561 we aren't actually setting up any controls. We are just defining some domains
5562 and hosts that will be used in the controls that are specified later.
5563
5564 The next two configuration lines are genuine option settings:
5565 .code
5566 acl_smtp_rcpt = acl_check_rcpt
5567 acl_smtp_data = acl_check_data
5568 .endd
5569 These options specify &'Access Control Lists'& (ACLs) that are to be used
5570 during an incoming SMTP session for every recipient of a message (every RCPT
5571 command), and after the contents of the message have been received,
5572 respectively. The names of the lists are &'acl_check_rcpt'& and
5573 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5574 section of the configuration. The RCPT ACL controls which recipients are
5575 accepted for an incoming message &-- if a configuration does not provide an ACL
5576 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5577 contents of a message to be checked.
5578
5579 Two commented-out option settings are next:
5580 .code
5581 # av_scanner = clamd:/tmp/clamd
5582 # spamd_address = 127.0.0.1 783
5583 .endd
5584 These are example settings that can be used when Exim is compiled with the
5585 content-scanning extension. The first specifies the interface to the virus
5586 scanner, and the second specifies the interface to SpamAssassin. Further
5587 details are given in chapter &<<CHAPexiscan>>&.
5588
5589 Three more commented-out option settings follow:
5590 .code
5591 # tls_advertise_hosts = *
5592 # tls_certificate = /etc/ssl/exim.crt
5593 # tls_privatekey = /etc/ssl/exim.pem
5594 .endd
5595 These are example settings that can be used when Exim is compiled with
5596 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5597 first one specifies the list of clients that are allowed to use TLS when
5598 connecting to this server; in this case the wildcard means all clients. The
5599 other options specify where Exim should find its TLS certificate and private
5600 key, which together prove the server's identity to any clients that connect.
5601 More details are given in chapter &<<CHAPTLS>>&.
5602
5603 Another two commented-out option settings follow:
5604 .code
5605 # daemon_smtp_ports = 25 : 465 : 587
5606 # tls_on_connect_ports = 465
5607 .endd
5608 .cindex "port" "465 and 587"
5609 .cindex "port" "for message submission"
5610 .cindex "message" "submission, ports for"
5611 .cindex "submissions protocol"
5612 .cindex "smtps protocol"
5613 .cindex "ssmtp protocol"
5614 .cindex "SMTP" "submissions protocol"
5615 .cindex "SMTP" "ssmtp protocol"
5616 .cindex "SMTP" "smtps protocol"
5617 These options provide better support for roaming users who wish to use this
5618 server for message submission. They are not much use unless you have turned on
5619 TLS (as described in the previous paragraph) and authentication (about which
5620 more in section &<<SECTdefconfauth>>&).
5621 Mail submission from mail clients (MUAs) should be separate from inbound mail
5622 to your domain (MX delivery) for various good reasons (eg, ability to impose
5623 much saner TLS protocol and ciphersuite requirements without unintended
5624 consequences).
5625 RFC 6409 (previously 4409) specifies use of port 587 for SMTP Submission,
5626 which uses STARTTLS, so this is the &"submission"& port.
5627 RFC 8314 specifies use of port 465 as the &"submissions"& protocol,
5628 which should be used in preference to 587.
5629 You should also consider deploying SRV records to help clients find
5630 these ports.
5631 Older names for &"submissions"& are &"smtps"& and &"ssmtp"&.
5632
5633 Two more commented-out options settings follow:
5634 .code
5635 # qualify_domain =
5636 # qualify_recipient =
5637 .endd
5638 The first of these specifies a domain that Exim uses when it constructs a
5639 complete email address from a local login name. This is often needed when Exim
5640 receives a message from a local process. If you do not set &%qualify_domain%&,
5641 the value of &%primary_hostname%& is used. If you set both of these options,
5642 you can have different qualification domains for sender and recipient
5643 addresses. If you set only the first one, its value is used in both cases.
5644
5645 .cindex "domain literal" "recognizing format"
5646 The following line must be uncommented if you want Exim to recognize
5647 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5648 (an IP address within square brackets) instead of a named domain.
5649 .code
5650 # allow_domain_literals
5651 .endd
5652 The RFCs still require this form, but many people think that in the modern
5653 Internet it makes little sense to permit mail to be sent to specific hosts by
5654 quoting their IP addresses. This ancient format has been used by people who
5655 try to abuse hosts by using them for unwanted relaying. However, some
5656 people believe there are circumstances (for example, messages addressed to
5657 &'postmaster'&) where domain literals are still useful.
5658
5659 The next configuration line is a kind of trigger guard:
5660 .code
5661 never_users = root
5662 .endd
5663 It specifies that no delivery must ever be run as the root user. The normal
5664 convention is to set up &'root'& as an alias for the system administrator. This
5665 setting is a guard against slips in the configuration.
5666 The list of users specified by &%never_users%& is not, however, the complete
5667 list; the build-time configuration in &_Local/Makefile_& has an option called
5668 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5669 contents of &%never_users%& are added to this list. By default
5670 FIXED_NEVER_USERS also specifies root.
5671
5672 When a remote host connects to Exim in order to send mail, the only information
5673 Exim has about the host's identity is its IP address. The next configuration
5674 line,
5675 .code
5676 host_lookup = *
5677 .endd
5678 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5679 in order to get a host name. This improves the quality of the logging
5680 information, but if you feel it is too expensive, you can remove it entirely,
5681 or restrict the lookup to hosts on &"nearby"& networks.
5682 Note that it is not always possible to find a host name from an IP address,
5683 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5684 unreachable.
5685
5686 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5687 1413 (hence their names):
5688 .code
5689 rfc1413_hosts = *
5690 rfc1413_query_timeout = 0s
5691 .endd
5692 These settings cause Exim to avoid ident callbacks for all incoming SMTP calls.
5693 Few hosts offer RFC1413 service these days; calls have to be
5694 terminated by a timeout and this needlessly delays the startup
5695 of an incoming SMTP connection.
5696 If you have hosts for which you trust RFC1413 and need this
5697 information, you can change this.
5698
5699 This line enables an efficiency SMTP option.  It is negotiated by clients
5700 and not expected to cause problems but can be disabled if needed.
5701 .code
5702 prdr_enable = true
5703 .endd
5704
5705 When Exim receives messages over SMTP connections, it expects all addresses to
5706 be fully qualified with a domain, as required by the SMTP definition. However,
5707 if you are running a server to which simple clients submit messages, you may
5708 find that they send unqualified addresses. The two commented-out options:
5709 .code
5710 # sender_unqualified_hosts =
5711 # recipient_unqualified_hosts =
5712 .endd
5713 show how you can specify hosts that are permitted to send unqualified sender
5714 and recipient addresses, respectively.
5715
5716 The &%log_selector%& option is used to increase the detail of logging
5717 over the default:
5718 .code
5719 log_selector = +smtp_protocol_error +smtp_syntax_error \
5720                +tls_certificate_verified
5721 .endd
5722
5723 The &%percent_hack_domains%& option is also commented out:
5724 .code
5725 # percent_hack_domains =
5726 .endd
5727 It provides a list of domains for which the &"percent hack"& is to operate.
5728 This is an almost obsolete form of explicit email routing. If you do not know
5729 anything about it, you can safely ignore this topic.
5730
5731 The next two settings in the main part of the default configuration are
5732 concerned with messages that have been &"frozen"& on Exim's queue. When a
5733 message is frozen, Exim no longer continues to try to deliver it. Freezing
5734 occurs when a bounce message encounters a permanent failure because the sender
5735 address of the original message that caused the bounce is invalid, so the
5736 bounce cannot be delivered. This is probably the most common case, but there
5737 are also other conditions that cause freezing, and frozen messages are not
5738 always bounce messages.
5739 .code
5740 ignore_bounce_errors_after = 2d
5741 timeout_frozen_after = 7d
5742 .endd
5743 The first of these options specifies that failing bounce messages are to be
5744 discarded after 2 days on the queue. The second specifies that any frozen
5745 message (whether a bounce message or not) is to be timed out (and discarded)
5746 after a week. In this configuration, the first setting ensures that no failing
5747 bounce message ever lasts a week.
5748
5749 Exim queues it's messages in a spool directory. If you expect to have
5750 large queues, you may consider using this option. It splits the spool
5751 directory into subdirectories to avoid file system degradation from
5752 many files in a single directory, resulting in better performance.
5753 Manual manipulation of queued messages becomes more complex (though fortunately
5754 not often needed).
5755 .code
5756 # split_spool_directory = true
5757 .endd
5758
5759 In an ideal world everybody follows the standards. For non-ASCII
5760 messages RFC 2047 is a standard, allowing a maximum line length of 76
5761 characters. Exim adheres that standard and won't process messages which
5762 violate this standard. (Even ${rfc2047:...} expansions will fail.)
5763 In particular, the Exim maintainers have had multiple reports of
5764 problems from Russian administrators of issues until they disable this
5765 check, because of some popular, yet buggy, mail composition software.
5766 .code
5767 # check_rfc2047_length = false
5768 .endd
5769
5770 If you need to be strictly RFC compliant you may wish to disable the
5771 8BITMIME advertisement. Use this, if you exchange mails with systems
5772 that are not 8-bit clean.
5773 .code
5774 # accept_8bitmime = false
5775 .endd
5776
5777 Libraries you use may depend on specific environment settings.  This
5778 imposes a security risk (e.g. PATH). There are two lists:
5779 &%keep_environment%& for the variables to import as they are, and
5780 &%add_environment%& for variables we want to set to a fixed value.
5781 Note that TZ is handled separately, by the $%timezone%$ runtime
5782 option and by the TIMEZONE_DEFAULT buildtime option.
5783 .code
5784 # keep_environment = ^LDAP
5785 # add_environment = PATH=/usr/bin::/bin
5786 .endd
5787
5788
5789 .section "ACL configuration" "SECID54"
5790 .cindex "default" "ACLs"
5791 .cindex "&ACL;" "default configuration"
5792 In the default configuration, the ACL section follows the main configuration.
5793 It starts with the line
5794 .code
5795 begin acl
5796 .endd
5797 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5798 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5799 and &%acl_smtp_data%& above.
5800
5801 .cindex "RCPT" "ACL for"
5802 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5803 RCPT command specifies one of the message's recipients. The ACL statements
5804 are considered in order, until the recipient address is either accepted or
5805 rejected. The RCPT command is then accepted or rejected, according to the
5806 result of the ACL processing.
5807 .code
5808 acl_check_rcpt:
5809 .endd
5810 This line, consisting of a name terminated by a colon, marks the start of the
5811 ACL, and names it.
5812 .code
5813 accept  hosts = :
5814 .endd
5815 This ACL statement accepts the recipient if the sending host matches the list.
5816 But what does that strange list mean? It doesn't actually contain any host
5817 names or IP addresses. The presence of the colon puts an empty item in the
5818 list; Exim matches this only if the incoming message did not come from a remote
5819 host, because in that case, the remote hostname is empty. The colon is
5820 important. Without it, the list itself is empty, and can never match anything.
5821
5822 What this statement is doing is to accept unconditionally all recipients in
5823 messages that are submitted by SMTP from local processes using the standard
5824 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5825 manner.
5826 .code
5827 deny    message       = Restricted characters in address
5828         domains       = +local_domains
5829         local_parts   = ^[.] : ^.*[@%!/|]
5830
5831 deny    message       = Restricted characters in address
5832         domains       = !+local_domains
5833         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5834 .endd
5835 These statements are concerned with local parts that contain any of the
5836 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5837 Although these characters are entirely legal in local parts (in the case of
5838 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5839 in Internet mail addresses.
5840
5841 The first three have in the past been associated with explicitly routed
5842 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5843 option). Addresses containing these characters are regularly tried by spammers
5844 in an attempt to bypass relaying restrictions, and also by open relay testing
5845 programs. Unless you really need them it is safest to reject these characters
5846 at this early stage. This configuration is heavy-handed in rejecting these
5847 characters for all messages it accepts from remote hosts. This is a deliberate
5848 policy of being as safe as possible.
5849
5850 The first rule above is stricter, and is applied to messages that are addressed
5851 to one of the local domains handled by this host. This is implemented by the
5852 first condition, which restricts it to domains that are listed in the
5853 &'local_domains'& domain list. The &"+"& character is used to indicate a
5854 reference to a named list. In this configuration, there is just one domain in
5855 &'local_domains'&, but in general there may be many.
5856
5857 The second condition on the first statement uses two regular expressions to
5858 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5859 or &"|"&. If you have local accounts that include these characters, you will
5860 have to modify this rule.
5861
5862 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5863 allows them because they have been encountered in practice. (Consider the
5864 common convention of local parts constructed as
5865 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5866 the author of Exim, who has no second initial.) However, a local part starting
5867 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5868 file name (for example, for a mailing list). This is also true for local parts
5869 that contain slashes. A pipe symbol can also be troublesome if the local part
5870 is incorporated unthinkingly into a shell command line.
5871
5872 The second rule above applies to all other domains, and is less strict. This
5873 allows your own users to send outgoing messages to sites that use slashes
5874 and vertical bars in their local parts. It blocks local parts that begin
5875 with a dot, slash, or vertical bar, but allows these characters within the
5876 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5877 and &"!"& is blocked, as before. The motivation here is to prevent your users
5878 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5879 .code
5880 accept  local_parts   = postmaster
5881         domains       = +local_domains
5882 .endd
5883 This statement, which has two conditions, accepts an incoming address if the
5884 local part is &'postmaster'& and the domain is one of those listed in the
5885 &'local_domains'& domain list. The &"+"& character is used to indicate a
5886 reference to a named list. In this configuration, there is just one domain in
5887 &'local_domains'&, but in general there may be many.
5888
5889 The presence of this statement means that mail to postmaster is never blocked
5890 by any of the subsequent tests. This can be helpful while sorting out problems
5891 in cases where the subsequent tests are incorrectly denying access.
5892 .code
5893 require verify        = sender
5894 .endd
5895 This statement requires the sender address to be verified before any subsequent
5896 ACL statement can be used. If verification fails, the incoming recipient
5897 address is refused. Verification consists of trying to route the address, to
5898 see if a bounce message could be delivered to it. In the case of remote
5899 addresses, basic verification checks only the domain, but &'callouts'& can be
5900 used for more verification if required. Section &<<SECTaddressverification>>&
5901 discusses the details of address verification.
5902 .code
5903 accept  hosts         = +relay_from_hosts
5904         control       = submission
5905 .endd
5906 This statement accepts the address if the message is coming from one of the
5907 hosts that are defined as being allowed to relay through this host. Recipient
5908 verification is omitted here, because in many cases the clients are dumb MUAs
5909 that do not cope well with SMTP error responses. For the same reason, the
5910 second line specifies &"submission mode"& for messages that are accepted. This
5911 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5912 messages that are deficient in some way, for example, because they lack a
5913 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5914 probably add recipient verification here, and disable submission mode.
5915 .code
5916 accept  authenticated = *
5917         control       = submission
5918 .endd
5919 This statement accepts the address if the client host has authenticated itself.
5920 Submission mode is again specified, on the grounds that such messages are most
5921 likely to come from MUAs. The default configuration does not define any
5922 authenticators, though it does include some nearly complete commented-out
5923 examples described in &<<SECTdefconfauth>>&. This means that no client can in
5924 fact authenticate until you complete the authenticator definitions.
5925 .code
5926 require message = relay not permitted
5927         domains = +local_domains : +relay_to_domains
5928 .endd
5929 This statement rejects the address if its domain is neither a local domain nor
5930 one of the domains for which this host is a relay.
5931 .code
5932 require verify = recipient
5933 .endd
5934 This statement requires the recipient address to be verified; if verification
5935 fails, the address is rejected.
5936 .code
5937 # deny    message     = rejected because $sender_host_address \
5938 #                       is in a black list at $dnslist_domain\n\
5939 #                       $dnslist_text
5940 #         dnslists    = black.list.example
5941 #
5942 # warn    dnslists    = black.list.example
5943 #         add_header  = X-Warning: $sender_host_address is in \
5944 #                       a black list at $dnslist_domain
5945 #         log_message = found in $dnslist_domain
5946 .endd
5947 These commented-out lines are examples of how you could configure Exim to check
5948 sending hosts against a DNS black list. The first statement rejects messages
5949 from blacklisted hosts, whereas the second just inserts a warning header
5950 line.
5951 .code
5952 # require verify = csa
5953 .endd
5954 This commented-out line is an example of how you could turn on client SMTP
5955 authorization (CSA) checking. Such checks do DNS lookups for special SRV
5956 records.
5957 .code
5958 accept
5959 .endd
5960 The final statement in the first ACL unconditionally accepts any recipient
5961 address that has successfully passed all the previous tests.
5962 .code
5963 acl_check_data:
5964 .endd
5965 This line marks the start of the second ACL, and names it. Most of the contents
5966 of this ACL are commented out:
5967 .code
5968 # deny    malware   = *
5969 #         message   = This message contains a virus \
5970 #                     ($malware_name).
5971 .endd
5972 These lines are examples of how to arrange for messages to be scanned for
5973 viruses when Exim has been compiled with the content-scanning extension, and a
5974 suitable virus scanner is installed. If the message is found to contain a
5975 virus, it is rejected with the given custom error message.
5976 .code
5977 # warn    spam      = nobody
5978 #         message   = X-Spam_score: $spam_score\n\
5979 #                     X-Spam_score_int: $spam_score_int\n\
5980 #                     X-Spam_bar: $spam_bar\n\
5981 #                     X-Spam_report: $spam_report
5982 .endd
5983 These lines are an example of how to arrange for messages to be scanned by
5984 SpamAssassin when Exim has been compiled with the content-scanning extension,
5985 and SpamAssassin has been installed. The SpamAssassin check is run with
5986 &`nobody`& as its user parameter, and the results are added to the message as a
5987 series of extra header line. In this case, the message is not rejected,
5988 whatever the spam score.
5989 .code
5990 accept
5991 .endd
5992 This final line in the DATA ACL accepts the message unconditionally.
5993
5994
5995 .section "Router configuration" "SECID55"
5996 .cindex "default" "routers"
5997 .cindex "routers" "default"
5998 The router configuration comes next in the default configuration, introduced
5999 by the line
6000 .code
6001 begin routers
6002 .endd
6003 Routers are the modules in Exim that make decisions about where to send
6004 messages. An address is passed to each router in turn, until it is either
6005 accepted, or failed. This means that the order in which you define the routers
6006 matters. Each router is fully described in its own chapter later in this
6007 manual. Here we give only brief overviews.
6008 .code
6009 # domain_literal:
6010 #   driver = ipliteral
6011 #   domains = !+local_domains
6012 #   transport = remote_smtp
6013 .endd
6014 .cindex "domain literal" "default router"
6015 This router is commented out because the majority of sites do not want to
6016 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
6017 you uncomment this router, you also need to uncomment the setting of
6018 &%allow_domain_literals%& in the main part of the configuration.
6019 .code
6020 dnslookup:
6021   driver = dnslookup
6022   domains = ! +local_domains
6023   transport = remote_smtp
6024   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
6025   no_more
6026 .endd
6027 The first uncommented router handles addresses that do not involve any local
6028 domains. This is specified by the line
6029 .code
6030 domains = ! +local_domains
6031 .endd
6032 The &%domains%& option lists the domains to which this router applies, but the
6033 exclamation mark is a negation sign, so the router is used only for domains
6034 that are not in the domain list called &'local_domains'& (which was defined at
6035 the start of the configuration). The plus sign before &'local_domains'&
6036 indicates that it is referring to a named list. Addresses in other domains are
6037 passed on to the following routers.
6038
6039 The name of the router driver is &(dnslookup)&,
6040 and is specified by the &%driver%& option. Do not be confused by the fact that
6041 the name of this router instance is the same as the name of the driver. The
6042 instance name is arbitrary, but the name set in the &%driver%& option must be
6043 one of the driver modules that is in the Exim binary.
6044
6045 The &(dnslookup)& router routes addresses by looking up their domains in the
6046 DNS in order to obtain a list of hosts to which the address is routed. If the
6047 router succeeds, the address is queued for the &(remote_smtp)& transport, as
6048 specified by the &%transport%& option. If the router does not find the domain
6049 in the DNS, no further routers are tried because of the &%no_more%& setting, so
6050 the address fails and is bounced.
6051
6052 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
6053 be entirely ignored. This option is present because a number of cases have been
6054 encountered where MX records in the DNS point to host names
6055 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
6056 Completely ignoring these IP addresses causes Exim to fail to route the
6057 email address, so it bounces. Otherwise, Exim would log a routing problem, and
6058 continue to try to deliver the message periodically until the address timed
6059 out.
6060 .code
6061 system_aliases:
6062   driver = redirect
6063   allow_fail
6064   allow_defer
6065   data = ${lookup{$local_part}lsearch{/etc/aliases}}
6066 # user = exim
6067   file_transport = address_file
6068   pipe_transport = address_pipe
6069 .endd
6070 Control reaches this and subsequent routers only for addresses in the local
6071 domains. This router checks to see whether the local part is defined as an
6072 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
6073 data that it looks up from that file. If no data is found for the local part,
6074 the value of the &%data%& option is empty, causing the address to be passed to
6075 the next router.
6076
6077 &_/etc/aliases_& is a conventional name for the system aliases file that is
6078 often used. That is why it is referenced by from the default configuration
6079 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
6080 &_Local/Makefile_& before building Exim.
6081 .code
6082 userforward:
6083   driver = redirect
6084   check_local_user
6085 # local_part_suffix = +* : -*
6086 # local_part_suffix_optional
6087   file = $home/.forward
6088 # allow_filter
6089   no_verify
6090   no_expn
6091   check_ancestor
6092   file_transport = address_file
6093   pipe_transport = address_pipe
6094   reply_transport = address_reply
6095 .endd
6096 This is the most complicated router in the default configuration. It is another
6097 redirection router, but this time it is looking for forwarding data set up by
6098 individual users. The &%check_local_user%& setting specifies a check that the
6099 local part of the address is the login name of a local user. If it is not, the
6100 router is skipped. The two commented options that follow &%check_local_user%&,
6101 namely:
6102 .code
6103 # local_part_suffix = +* : -*
6104 # local_part_suffix_optional
6105 .endd
6106 .vindex "&$local_part_suffix$&"
6107 show how you can specify the recognition of local part suffixes. If the first
6108 is uncommented, a suffix beginning with either a plus or a minus sign, followed
6109 by any sequence of characters, is removed from the local part and placed in the
6110 variable &$local_part_suffix$&. The second suffix option specifies that the
6111 presence of a suffix in the local part is optional. When a suffix is present,
6112 the check for a local login uses the local part with the suffix removed.
6113
6114 When a local user account is found, the file called &_.forward_& in the user's
6115 home directory is consulted. If it does not exist, or is empty, the router
6116 declines. Otherwise, the contents of &_.forward_& are interpreted as
6117 redirection data (see chapter &<<CHAPredirect>>& for more details).
6118
6119 .cindex "Sieve filter" "enabling in default router"
6120 Traditional &_.forward_& files contain just a list of addresses, pipes, or
6121 files. Exim supports this by default. However, if &%allow_filter%& is set (it
6122 is commented out by default), the contents of the file are interpreted as a set
6123 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
6124 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
6125 separate document entitled &'Exim's interfaces to mail filtering'&.
6126
6127 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
6128 verifying addresses, or when running as a consequence of an SMTP EXPN command.
6129 There are two reasons for doing this:
6130
6131 .olist
6132 Whether or not a local user has a &_.forward_& file is not really relevant when
6133 checking an address for validity; it makes sense not to waste resources doing
6134 unnecessary work.
6135 .next
6136 More importantly, when Exim is verifying addresses or handling an EXPN
6137 command during an SMTP session, it is running as the Exim user, not as root.
6138 The group is the Exim group, and no additional groups are set up.
6139 It may therefore not be possible for Exim to read users' &_.forward_& files at
6140 this time.
6141 .endlist
6142
6143 The setting of &%check_ancestor%& prevents the router from generating a new
6144 address that is the same as any previous address that was redirected. (This
6145 works round a problem concerning a bad interaction between aliasing and
6146 forwarding &-- see section &<<SECTredlocmai>>&).
6147
6148 The final three option settings specify the transports that are to be used when
6149 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
6150 auto-reply, respectively. For example, if a &_.forward_& file contains
6151 .code
6152 a.nother@elsewhere.example, /home/spqr/archive
6153 .endd
6154 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
6155 transport.
6156 .code
6157 localuser:
6158   driver = accept
6159   check_local_user
6160 # local_part_suffix = +* : -*
6161 # local_part_suffix_optional
6162   transport = local_delivery
6163 .endd
6164 The final router sets up delivery into local mailboxes, provided that the local
6165 part is the name of a local login, by accepting the address and assigning it to
6166 the &(local_delivery)& transport. Otherwise, we have reached the end of the
6167 routers, so the address is bounced. The commented suffix settings fulfil the
6168 same purpose as they do for the &(userforward)& router.
6169
6170
6171 .section "Transport configuration" "SECID56"
6172 .cindex "default" "transports"
6173 .cindex "transports" "default"
6174 Transports define mechanisms for actually delivering messages. They operate
6175 only when referenced from routers, so the order in which they are defined does
6176 not matter. The transports section of the configuration starts with
6177 .code
6178 begin transports
6179 .endd
6180 One remote transport and four local transports are defined.
6181 .code
6182 remote_smtp:
6183   driver = smtp
6184   hosts_try_prdr = *
6185 .endd
6186 This transport is used for delivering messages over SMTP connections.
6187 The list of remote hosts comes from the router.
6188 The &%hosts_try_prdr%& option enables an efficiency SMTP option.
6189 It is negotiated between client and server
6190 and not expected to cause problems but can be disabled if needed.
6191 All other options are defaulted.
6192 .code
6193 local_delivery:
6194   driver = appendfile
6195   file = /var/mail/$local_part
6196   delivery_date_add
6197   envelope_to_add
6198   return_path_add
6199 # group = mail
6200 # mode = 0660
6201 .endd
6202 This &(appendfile)& transport is used for local delivery to user mailboxes in
6203 traditional BSD mailbox format. By default it runs under the uid and gid of the
6204 local user, which requires the sticky bit to be set on the &_/var/mail_&
6205 directory. Some systems use the alternative approach of running mail deliveries
6206 under a particular group instead of using the sticky bit. The commented options
6207 show how this can be done.
6208
6209 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
6210 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
6211 similarly-named options above.
6212 .code
6213 address_pipe:
6214   driver = pipe
6215   return_output
6216 .endd
6217 This transport is used for handling deliveries to pipes that are generated by
6218 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6219 option specifies that any output on stdout or stderr generated by the pipe is to
6220 be returned to the sender.
6221 .code
6222 address_file:
6223   driver = appendfile
6224   delivery_date_add
6225   envelope_to_add
6226   return_path_add
6227 .endd
6228 This transport is used for handling deliveries to files that are generated by
6229 redirection. The name of the file is not specified in this instance of
6230 &(appendfile)&, because it comes from the &(redirect)& router.
6231 .code
6232 address_reply:
6233   driver = autoreply
6234 .endd
6235 This transport is used for handling automatic replies generated by users'
6236 filter files.
6237
6238
6239
6240 .section "Default retry rule" "SECID57"
6241 .cindex "retry" "default rule"
6242 .cindex "default" "retry rule"
6243 The retry section of the configuration file contains rules which affect the way
6244 Exim retries deliveries that cannot be completed at the first attempt. It is
6245 introduced by the line
6246 .code
6247 begin retry
6248 .endd
6249 In the default configuration, there is just one rule, which applies to all
6250 errors:
6251 .code
6252 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6253 .endd
6254 This causes any temporarily failing address to be retried every 15 minutes for
6255 2 hours, then at intervals starting at one hour and increasing by a factor of
6256 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6257 is not delivered after 4 days of temporary failure, it is bounced. The time is
6258 measured from first failure, not from the time the message was received.
6259
6260 If the retry section is removed from the configuration, or is empty (that is,
6261 if no retry rules are defined), Exim will not retry deliveries. This turns
6262 temporary errors into permanent errors.
6263
6264
6265 .section "Rewriting configuration" "SECID58"
6266 The rewriting section of the configuration, introduced by
6267 .code
6268 begin rewrite
6269 .endd
6270 contains rules for rewriting addresses in messages as they arrive. There are no
6271 rewriting rules in the default configuration file.
6272
6273
6274
6275 .section "Authenticators configuration" "SECTdefconfauth"
6276 .cindex "AUTH" "configuration"
6277 The authenticators section of the configuration, introduced by
6278 .code
6279 begin authenticators
6280 .endd
6281 defines mechanisms for the use of the SMTP AUTH command. The default
6282 configuration file contains two commented-out example authenticators
6283 which support plaintext username/password authentication using the
6284 standard PLAIN mechanism and the traditional but non-standard LOGIN
6285 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6286 to support most MUA software.
6287
6288 The example PLAIN authenticator looks like this:
6289 .code
6290 #PLAIN:
6291 #  driver                  = plaintext
6292 #  server_set_id           = $auth2
6293 #  server_prompts          = :
6294 #  server_condition        = Authentication is not yet configured
6295 #  server_advertise_condition = ${if def:tls_in_cipher }
6296 .endd
6297 And the example LOGIN authenticator looks like this:
6298 .code
6299 #LOGIN:
6300 #  driver                  = plaintext
6301 #  server_set_id           = $auth1
6302 #  server_prompts          = <| Username: | Password:
6303 #  server_condition        = Authentication is not yet configured
6304 #  server_advertise_condition = ${if def:tls_in_cipher }
6305 .endd
6306
6307 The &%server_set_id%& option makes Exim remember the authenticated username
6308 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6309 &%server_prompts%& option configures the &(plaintext)& authenticator so
6310 that it implements the details of the specific authentication mechanism,
6311 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6312 when Exim offers authentication to clients; in the examples, this is only
6313 when TLS or SSL has been started, so to enable the authenticators you also
6314 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6315
6316 The &%server_condition%& setting defines how to verify that the username and
6317 password are correct. In the examples it just produces an error message.
6318 To make the authenticators work, you can use a string expansion
6319 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6320
6321 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6322 usercode and password are in different positions.
6323 Chapter &<<CHAPplaintext>>& covers both.
6324
6325 .ecindex IIDconfiwal
6326
6327
6328
6329 . ////////////////////////////////////////////////////////////////////////////
6330 . ////////////////////////////////////////////////////////////////////////////
6331
6332 .chapter "Regular expressions" "CHAPregexp"
6333
6334 .cindex "regular expressions" "library"
6335 .cindex "PCRE"
6336 Exim supports the use of regular expressions in many of its options. It
6337 uses the PCRE regular expression library; this provides regular expression
6338 matching that is compatible with Perl 5. The syntax and semantics of
6339 regular expressions is discussed in
6340 online Perl manpages, in
6341 many Perl reference books, and also in
6342 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6343 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6344
6345 The documentation for the syntax and semantics of the regular expressions that
6346 are supported by PCRE is included in the PCRE distribution, and no further
6347 description is included here. The PCRE functions are called from Exim using
6348 the default option settings (that is, with no PCRE options set), except that
6349 the PCRE_CASELESS option is set when the matching is required to be
6350 case-insensitive.
6351
6352 In most cases, when a regular expression is required in an Exim configuration,
6353 it has to start with a circumflex, in order to distinguish it from plain text
6354 or an &"ends with"& wildcard. In this example of a configuration setting, the
6355 second item in the colon-separated list is a regular expression.
6356 .code
6357 domains = a.b.c : ^\\d{3} : *.y.z : ...
6358 .endd
6359 The doubling of the backslash is required because of string expansion that
6360 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6361 of this issue, and a way of avoiding the need for doubling backslashes. The
6362 regular expression that is eventually used in this example contains just one
6363 backslash. The circumflex is included in the regular expression, and has the
6364 normal effect of &"anchoring"& it to the start of the string that is being
6365 matched.
6366
6367 There are, however, two cases where a circumflex is not required for the
6368 recognition of a regular expression: these are the &%match%& condition in a
6369 string expansion, and the &%matches%& condition in an Exim filter file. In
6370 these cases, the relevant string is always treated as a regular expression; if
6371 it does not start with a circumflex, the expression is not anchored, and can
6372 match anywhere in the subject string.
6373
6374 In all cases, if you want a regular expression to match at the end of a string,
6375 you must code the $ metacharacter to indicate this. For example:
6376 .code
6377 domains = ^\\d{3}\\.example
6378 .endd
6379 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6380 You need to use:
6381 .code
6382 domains = ^\\d{3}\\.example\$
6383 .endd
6384 if you want &'example'& to be the top-level domain. The backslash before the
6385 $ is needed because string expansion also interprets dollar characters.
6386
6387
6388
6389 . ////////////////////////////////////////////////////////////////////////////
6390 . ////////////////////////////////////////////////////////////////////////////
6391
6392 .chapter "File and database lookups" "CHAPfdlookup"
6393 .scindex IIDfidalo1 "file" "lookups"
6394 .scindex IIDfidalo2 "database" "lookups"
6395 .cindex "lookup" "description of"
6396 Exim can be configured to look up data in files or databases as it processes
6397 messages. Two different kinds of syntax are used:
6398
6399 .olist
6400 A string that is to be expanded may contain explicit lookup requests. These
6401 cause parts of the string to be replaced by data that is obtained from the
6402 lookup. Lookups of this type are conditional expansion items. Different results
6403 can be defined for the cases of lookup success and failure. See chapter
6404 &<<CHAPexpand>>&, where string expansions are described in detail.
6405 The key for the lookup is specified as part of the string expansion.
6406 .next
6407 Lists of domains, hosts, and email addresses can contain lookup requests as a
6408 way of avoiding excessively long linear lists. In this case, the data that is
6409 returned by the lookup is often (but not always) discarded; whether the lookup
6410 succeeds or fails is what really counts. These kinds of list are described in
6411 chapter &<<CHAPdomhosaddlists>>&.
6412 The key for the lookup is given by the context in which the list is expanded.
6413 .endlist
6414
6415 String expansions, lists, and lookups interact with each other in such a way
6416 that there is no order in which to describe any one of them that does not
6417 involve references to the others. Each of these three chapters makes more sense
6418 if you have read the other two first. If you are reading this for the first
6419 time, be aware that some of it will make a lot more sense after you have read
6420 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6421
6422 .section "Examples of different lookup syntax" "SECID60"
6423 It is easy to confuse the two different kinds of lookup, especially as the
6424 lists that may contain the second kind are always expanded before being
6425 processed as lists. Therefore, they may also contain lookups of the first kind.
6426 Be careful to distinguish between the following two examples:
6427 .code
6428 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6429 domains = lsearch;/some/file
6430 .endd
6431 The first uses a string expansion, the result of which must be a domain list.
6432 No strings have been specified for a successful or a failing lookup; the
6433 defaults in this case are the looked-up data and an empty string, respectively.
6434 The expansion takes place before the string is processed as a list, and the
6435 file that is searched could contain lines like this:
6436 .code
6437 192.168.3.4: domain1:domain2:...
6438 192.168.1.9: domain3:domain4:...
6439 .endd
6440 When the lookup succeeds, the result of the expansion is a list of domains (and
6441 possibly other types of item that are allowed in domain lists).
6442
6443 In the second example, the lookup is a single item in a domain list. It causes
6444 Exim to use a lookup to see if the domain that is being processed can be found
6445 in the file. The file could contains lines like this:
6446 .code
6447 domain1:
6448 domain2:
6449 .endd
6450 Any data that follows the keys is not relevant when checking that the domain
6451 matches the list item.
6452
6453 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6454 Consider a file containing lines like this:
6455 .code
6456 192.168.5.6: lsearch;/another/file
6457 .endd
6458 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6459 first &%domains%& setting above generates the second setting, which therefore
6460 causes a second lookup to occur.
6461
6462 The rest of this chapter describes the different lookup types that are
6463 available. Any of them can be used in any part of the configuration where a
6464 lookup is permitted.
6465
6466
6467 .section "Lookup types" "SECID61"
6468 .cindex "lookup" "types of"
6469 .cindex "single-key lookup" "definition of"
6470 Two different types of data lookup are implemented:
6471
6472 .ilist
6473 The &'single-key'& type requires the specification of a file in which to look,
6474 and a single key to search for. The key must be a non-empty string for the
6475 lookup to succeed. The lookup type determines how the file is searched.
6476 .next
6477 .cindex "query-style lookup" "definition of"
6478 The &'query-style'& type accepts a generalized database query. No particular
6479 key value is assumed by Exim for query-style lookups. You can use whichever
6480 Exim variables you need to construct the database query.
6481 .endlist
6482
6483 The code for each lookup type is in a separate source file that is included in
6484 the binary of Exim only if the corresponding compile-time option is set. The
6485 default settings in &_src/EDITME_& are:
6486 .code
6487 LOOKUP_DBM=yes
6488 LOOKUP_LSEARCH=yes
6489 .endd
6490 which means that only linear searching and DBM lookups are included by default.
6491 For some types of lookup (e.g. SQL databases), you need to install appropriate
6492 libraries and header files before building Exim.
6493
6494
6495
6496
6497 .section "Single-key lookup types" "SECTsinglekeylookups"
6498 .cindex "lookup" "single-key types"
6499 .cindex "single-key lookup" "list of types"
6500 The following single-key lookup types are implemented:
6501
6502 .ilist
6503 .cindex "cdb" "description of"
6504 .cindex "lookup" "cdb"
6505 .cindex "binary zero" "in lookup key"
6506 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6507 string without a terminating binary zero. The cdb format is designed for
6508 indexed files that are read frequently and never updated, except by total
6509 re-creation. As such, it is particularly suitable for large files containing
6510 aliases or other indexed data referenced by an MTA. Information about cdb can
6511 be found in several places:
6512 .display
6513 &url(http://www.pobox.com/~djb/cdb.html)
6514 &url(ftp://ftp.corpit.ru/pub/tinycdb/)
6515 &url(http://packages.debian.org/stable/utils/freecdb.html)
6516 .endd
6517 A cdb distribution is not needed in order to build Exim with cdb support,
6518 because the code for reading cdb files is included directly in Exim itself.
6519 However, no means of building or testing cdb files is provided with Exim, so
6520 you need to obtain a cdb distribution in order to do this.
6521 .next
6522 .cindex "DBM" "lookup type"
6523 .cindex "lookup" "dbm"
6524 .cindex "binary zero" "in lookup key"
6525 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6526 DBM file by looking up the record with the given key. A terminating binary
6527 zero is included in the key that is passed to the DBM library. See section
6528 &<<SECTdb>>& for a discussion of DBM libraries.
6529
6530 .cindex "Berkeley DB library" "file format"
6531 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6532 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6533 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6534 the DB_UNKNOWN option. This enables it to handle any of the types of database
6535 that the library supports, and can be useful for accessing DBM files created by
6536 other applications. (For earlier DB versions, DB_HASH is always used.)
6537 .next
6538 .cindex "lookup" "dbmjz"
6539 .cindex "lookup" "dbm &-- embedded NULs"
6540 .cindex "sasldb2"
6541 .cindex "dbmjz lookup type"
6542 &(dbmjz)&: This is the same as &(dbm)&, except that the lookup key is
6543 interpreted as an Exim list; the elements of the list are joined together with
6544 ASCII NUL characters to form the lookup key.  An example usage would be to
6545 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6546 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6547 &(cram_md5)& authenticator.
6548 .next
6549 .cindex "lookup" "dbmnz"
6550 .cindex "lookup" "dbm &-- terminating zero"
6551 .cindex "binary zero" "in lookup key"
6552 .cindex "Courier"
6553 .cindex "&_/etc/userdbshadow.dat_&"
6554 .cindex "dbmnz lookup type"
6555 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6556 is not included in the key that is passed to the DBM library. You may need this
6557 if you want to look up data in files that are created by or shared with some
6558 other application that does not use terminating zeros. For example, you need to
6559 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6560 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6561 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6562 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6563 .next
6564 .cindex "lookup" "dsearch"
6565 .cindex "dsearch lookup type"
6566 &(dsearch)&: The given file must be a directory; this is searched for an entry
6567 whose name is the key by calling the &[lstat()]& function. The key may not
6568 contain any forward slash characters. If &[lstat()]& succeeds, the result of
6569 the lookup is the name of the entry, which may be a file, directory,
6570 symbolic link, or any other kind of directory entry. An example of how this
6571 lookup can be used to support virtual domains is given in section
6572 &<<SECTvirtualdomains>>&.
6573 .next
6574 .cindex "lookup" "iplsearch"
6575 .cindex "iplsearch lookup type"
6576 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6577 terminated by a colon or white space or the end of the line. The keys in the
6578 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6579 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6580 being interpreted as a key terminator. For example:
6581 .code
6582 1.2.3.4:           data for 1.2.3.4
6583 192.168.0.0/16:    data for 192.168.0.0/16
6584 "abcd::cdab":      data for abcd::cdab
6585 "abcd:abcd::/32"   data for abcd:abcd::/32
6586 .endd
6587 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6588 file is searched linearly, using the CIDR masks where present, until a matching
6589 key is found. The first key that matches is used; there is no attempt to find a
6590 &"best"& match. Apart from the way the keys are matched, the processing for
6591 &(iplsearch)& is the same as for &(lsearch)&.
6592
6593 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6594 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6595 lookup types support only literal keys.
6596
6597 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6598 the implicit key is the host's IP address rather than its name (see section
6599 &<<SECThoslispatsikey>>&).
6600 .next
6601 .cindex "linear search"
6602 .cindex "lookup" "lsearch"
6603 .cindex "lsearch lookup type"
6604 .cindex "case sensitivity" "in lsearch lookup"
6605 &(lsearch)&: The given file is a text file that is searched linearly for a
6606 line beginning with the search key, terminated by a colon or white space or the
6607 end of the line. The search is case-insensitive; that is, upper and lower case
6608 letters are treated as the same. The first occurrence of the key that is found
6609 in the file is used.
6610
6611 White space between the key and the colon is permitted. The remainder of the
6612 line, with leading and trailing white space removed, is the data. This can be
6613 continued onto subsequent lines by starting them with any amount of white
6614 space, but only a single space character is included in the data at such a
6615 junction. If the data begins with a colon, the key must be terminated by a
6616 colon, for example:
6617 .code
6618 baduser:  :fail:
6619 .endd
6620 Empty lines and lines beginning with # are ignored, even if they occur in the
6621 middle of an item. This is the traditional textual format of alias files. Note
6622 that the keys in an &(lsearch)& file are literal strings. There is no
6623 wildcarding of any kind.
6624
6625 .cindex "lookup" "lsearch &-- colons in keys"
6626 .cindex "white space" "in lsearch key"
6627 In most &(lsearch)& files, keys are not required to contain colons or #
6628 characters, or white space. However, if you need this feature, it is available.
6629 If a key begins with a doublequote character, it is terminated only by a
6630 matching quote (or end of line), and the normal escaping rules apply to its
6631 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6632 quoted keys (exactly as for unquoted keys). There is no special handling of
6633 quotes for the data part of an &(lsearch)& line.
6634
6635 .next
6636 .cindex "NIS lookup type"
6637 .cindex "lookup" "NIS"
6638 .cindex "binary zero" "in lookup key"
6639 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6640 the given key, without a terminating binary zero. There is a variant called
6641 &(nis0)& which does include the terminating binary zero in the key. This is
6642 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6643 aliases; the full map names must be used.
6644
6645 .next
6646 .cindex "wildlsearch lookup type"
6647 .cindex "lookup" "wildlsearch"
6648 .cindex "nwildlsearch lookup type"
6649 .cindex "lookup" "nwildlsearch"
6650 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6651 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6652 the file may be wildcarded. The difference between these two lookup types is
6653 that for &(wildlsearch)&, each key in the file is string-expanded before being
6654 used, whereas for &(nwildlsearch)&, no expansion takes place.
6655
6656 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6657 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6658 file that are regular expressions can be made case-sensitive by the use of
6659 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6660
6661 . ==== As this is a nested list, any displays it contains must be indented
6662 . ==== as otherwise they are too far to the left.
6663
6664 .olist
6665 The string may begin with an asterisk to mean &"ends with"&. For example:
6666 .code
6667     *.a.b.c       data for anything.a.b.c
6668     *fish         data for anythingfish
6669 .endd
6670 .next
6671 The string may begin with a circumflex to indicate a regular expression. For
6672 example, for &(wildlsearch)&:
6673 .code
6674     ^\N\d+\.a\.b\N    data for <digits>.a.b
6675 .endd
6676 Note the use of &`\N`& to disable expansion of the contents of the regular
6677 expression. If you are using &(nwildlsearch)&, where the keys are not
6678 string-expanded, the equivalent entry is:
6679 .code
6680     ^\d+\.a\.b        data for <digits>.a.b
6681 .endd
6682 The case-insensitive flag is set at the start of compiling the regular
6683 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6684 For example, to make the entire pattern case-sensitive:
6685 .code
6686     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6687 .endd
6688
6689 If the regular expression contains white space or colon characters, you must
6690 either quote it (see &(lsearch)& above), or represent these characters in other
6691 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6692 colon. This may be easier than quoting, because if you quote, you have to
6693 escape all the backslashes inside the quotes.
6694
6695 &*Note*&: It is not possible to capture substrings in a regular expression
6696 match for later use, because the results of all lookups are cached. If a lookup
6697 is repeated, the result is taken from the cache, and no actual pattern matching
6698 takes place. The values of all the numeric variables are unset after a
6699 &((n)wildlsearch)& match.
6700
6701 .next
6702 Although I cannot see it being of much use, the general matching function that
6703 is used to implement &((n)wildlsearch)& means that the string may begin with a
6704 lookup name terminated by a semicolon, and followed by lookup data. For
6705 example:
6706 .code
6707     cdb;/some/file  data for keys that match the file
6708 .endd
6709 The data that is obtained from the nested lookup is discarded.
6710 .endlist olist
6711
6712 Keys that do not match any of these patterns are interpreted literally. The
6713 continuation rules for the data are the same as for &(lsearch)&, and keys may
6714 be followed by optional colons.
6715
6716 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6717 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6718 lookup types support only literal keys.
6719 .endlist ilist
6720
6721
6722 .section "Query-style lookup types" "SECTquerystylelookups"
6723 .cindex "lookup" "query-style types"
6724 .cindex "query-style lookup" "list of types"
6725 The supported query-style lookup types are listed below. Further details about
6726 many of them are given in later sections.
6727
6728 .ilist
6729 .cindex "DNS" "as a lookup type"
6730 .cindex "lookup" "DNS"
6731 &(dnsdb)&: This does a DNS search for one or more records whose domain names
6732 are given in the supplied query. The resulting data is the contents of the
6733 records. See section &<<SECTdnsdb>>&.
6734 .next
6735 .cindex "InterBase lookup type"
6736 .cindex "lookup" "InterBase"
6737 &(ibase)&: This does a lookup in an InterBase database.
6738 .next
6739 .cindex "LDAP" "lookup type"
6740 .cindex "lookup" "LDAP"
6741 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
6742 returns attributes from a single entry. There is a variant called &(ldapm)&
6743 that permits values from multiple entries to be returned. A third variant
6744 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
6745 any attribute values. See section &<<SECTldap>>&.
6746 .next
6747 .cindex "MySQL" "lookup type"
6748 .cindex "lookup" "MySQL"
6749 &(mysql)&: The format of the query is an SQL statement that is passed to a
6750 MySQL database. See section &<<SECTsql>>&.
6751 .next
6752 .cindex "NIS+ lookup type"
6753 .cindex "lookup" "NIS+"
6754 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
6755 the field to be returned. See section &<<SECTnisplus>>&.
6756 .next
6757 .cindex "Oracle" "lookup type"
6758 .cindex "lookup" "Oracle"
6759 &(oracle)&: The format of the query is an SQL statement that is passed to an
6760 Oracle database. See section &<<SECTsql>>&.
6761 .next
6762 .cindex "lookup" "passwd"
6763 .cindex "passwd lookup type"
6764 .cindex "&_/etc/passwd_&"
6765 &(passwd)& is a query-style lookup with queries that are just user names. The
6766 lookup calls &[getpwnam()]& to interrogate the system password data, and on
6767 success, the result string is the same as you would get from an &(lsearch)&
6768 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
6769 password value. For example:
6770 .code
6771 *:42:42:King Rat:/home/kr:/bin/bash
6772 .endd
6773 .next
6774 .cindex "PostgreSQL lookup type"
6775 .cindex "lookup" "PostgreSQL"
6776 &(pgsql)&: The format of the query is an SQL statement that is passed to a
6777 PostgreSQL database. See section &<<SECTsql>>&.
6778
6779 .next
6780 .cindex "Redis lookup type"
6781 .cindex lookup Redis
6782 &(redis)&: The format of the query is either a simple get or simple set,
6783 passed to a Redis database. See section &<<SECTsql>>&.
6784
6785 .next
6786 .cindex "sqlite lookup type"
6787 .cindex "lookup" "sqlite"
6788 &(sqlite)&: The format of the query is a file name followed by an SQL statement
6789 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
6790
6791 .next
6792 &(testdb)&: This is a lookup type that is used for testing Exim. It is
6793 not likely to be useful in normal operation.
6794 .next
6795 .cindex "whoson lookup type"
6796 .cindex "lookup" "whoson"
6797 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
6798 allows a server to check whether a particular (dynamically allocated) IP
6799 address is currently allocated to a known (trusted) user and, optionally, to
6800 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
6801 at one time for &"POP before SMTP"& authentication, but that approach has been
6802 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
6803 &"POP before SMTP"& checking using ACL statements such as
6804 .code
6805 require condition = \
6806   ${lookup whoson {$sender_host_address}{yes}{no}}
6807 .endd
6808 The query consists of a single IP address. The value returned is the name of
6809 the authenticated user, which is stored in the variable &$value$&. However, in
6810 this example, the data in &$value$& is not used; the result of the lookup is
6811 one of the fixed strings &"yes"& or &"no"&.
6812 .endlist
6813
6814
6815
6816 .section "Temporary errors in lookups" "SECID63"
6817 .cindex "lookup" "temporary error in"
6818 Lookup functions can return temporary error codes if the lookup cannot be
6819 completed. For example, an SQL or LDAP database might be unavailable. For this
6820 reason, it is not advisable to use a lookup that might do this for critical
6821 options such as a list of local domains.
6822
6823 When a lookup cannot be completed in a router or transport, delivery
6824 of the message (to the relevant address) is deferred, as for any other
6825 temporary error. In other circumstances Exim may assume the lookup has failed,
6826 or may give up altogether.
6827
6828
6829
6830 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
6831 .cindex "wildcard lookups"
6832 .cindex "lookup" "default values"
6833 .cindex "lookup" "wildcard"
6834 .cindex "lookup" "* added to type"
6835 .cindex "default" "in single-key lookups"
6836 In this context, a &"default value"& is a value specified by the administrator
6837 that is to be used if a lookup fails.
6838
6839 &*Note:*& This section applies only to single-key lookups. For query-style
6840 lookups, the facilities of the query language must be used. An attempt to
6841 specify a default for a query-style lookup provokes an error.
6842
6843 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
6844 and the initial lookup fails, the key &"*"& is looked up in the file to
6845 provide a default value. See also the section on partial matching below.
6846
6847 .cindex "*@ with single-key lookup"
6848 .cindex "lookup" "*@ added to type"
6849 .cindex "alias file" "per-domain default"
6850 Alternatively, if &"*@"& is added to a single-key lookup type (for example
6851 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
6852 character, a second lookup is done with everything before the last @ replaced
6853 by *. This makes it possible to provide per-domain defaults in alias files
6854 that include the domains in the keys. If the second lookup fails (or doesn't
6855 take place because there is no @ in the key), &"*"& is looked up.
6856 For example, a &(redirect)& router might contain:
6857 .code
6858 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
6859 .endd
6860 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
6861 looks up these keys, in this order:
6862 .code
6863 jane@eyre.example
6864 *@eyre.example
6865 *
6866 .endd
6867 The data is taken from whichever key it finds first. &*Note*&: In an
6868 &(lsearch)& file, this does not mean the first of these keys in the file. A
6869 complete scan is done for each key, and only if it is not found at all does
6870 Exim move on to try the next key.
6871
6872
6873
6874 .section "Partial matching in single-key lookups" "SECTpartiallookup"
6875 .cindex "partial matching"
6876 .cindex "wildcard lookups"
6877 .cindex "lookup" "partial matching"
6878 .cindex "lookup" "wildcard"
6879 .cindex "asterisk" "in search type"
6880 The normal operation of a single-key lookup is to search the file for an exact
6881 match with the given key. However, in a number of situations where domains are
6882 being looked up, it is useful to be able to do partial matching. In this case,
6883 information in the file that has a key starting with &"*."& is matched by any
6884 domain that ends with the components that follow the full stop. For example, if
6885 a key in a DBM file is
6886 .code
6887 *.dates.fict.example
6888 .endd
6889 then when partial matching is enabled this is matched by (amongst others)
6890 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
6891 by &'dates.fict.example'&, if that does not appear as a separate key in the
6892 file.
6893
6894 &*Note*&: Partial matching is not available for query-style lookups. It is
6895 also not available for any lookup items in address lists (see section
6896 &<<SECTaddresslist>>&).
6897
6898 Partial matching is implemented by doing a series of separate lookups using
6899 keys constructed by modifying the original subject key. This means that it can
6900 be used with any of the single-key lookup types, provided that
6901 partial matching keys
6902 beginning with a special prefix (default &"*."&) are included in the data file.
6903 Keys in the file that do not begin with the prefix are matched only by
6904 unmodified subject keys when partial matching is in use.
6905
6906 Partial matching is requested by adding the string &"partial-"& to the front of
6907 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
6908 is done, the subject key is first looked up unmodified; if that fails, &"*."&
6909 is added at the start of the subject key, and it is looked up again. If that
6910 fails, further lookups are tried with dot-separated components removed from the
6911 start of the subject key, one-by-one, and &"*."& added on the front of what
6912 remains.
6913
6914 A minimum number of two non-* components are required. This can be adjusted
6915 by including a number before the hyphen in the search type. For example,
6916 &%partial3-lsearch%& specifies a minimum of three non-* components in the
6917 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
6918 subject key is &'2250.dates.fict.example'& then the following keys are looked
6919 up when the minimum number of non-* components is two:
6920 .code
6921 2250.dates.fict.example
6922 *.2250.dates.fict.example
6923 *.dates.fict.example
6924 *.fict.example
6925 .endd
6926 As soon as one key in the sequence is successfully looked up, the lookup
6927 finishes.
6928
6929 .cindex "lookup" "partial matching &-- changing prefix"
6930 .cindex "prefix" "for partial matching"
6931 The use of &"*."& as the partial matching prefix is a default that can be
6932 changed. The motivation for this feature is to allow Exim to operate with file
6933 formats that are used by other MTAs. A different prefix can be supplied in
6934 parentheses instead of the hyphen after &"partial"&. For example:
6935 .code
6936 domains = partial(.)lsearch;/some/file
6937 .endd
6938 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
6939 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
6940 components is unchanged). The prefix may consist of any punctuation characters
6941 other than a closing parenthesis. It may be empty, for example:
6942 .code
6943 domains = partial1()cdb;/some/file
6944 .endd
6945 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
6946 &`a.b.c`&, &`b.c`&, and &`c`&.
6947
6948 If &"partial0"& is specified, what happens at the end (when the lookup with
6949 just one non-wild component has failed, and the original key is shortened right
6950 down to the null string) depends on the prefix:
6951
6952 .ilist
6953 If the prefix has zero length, the whole lookup fails.
6954 .next
6955 If the prefix has length 1, a lookup for just the prefix is done. For
6956 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
6957 .next
6958 Otherwise, if the prefix ends in a dot, the dot is removed, and the
6959 remainder is looked up. With the default prefix, therefore, the final lookup is
6960 for &"*"& on its own.
6961 .next
6962 Otherwise, the whole prefix is looked up.
6963 .endlist
6964
6965
6966 If the search type ends in &"*"& or &"*@"& (see section
6967 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
6968 this implies happens after all partial lookups have failed. If &"partial0"& is
6969 specified, adding &"*"& to the search type has no effect with the default
6970 prefix, because the &"*"& key is already included in the sequence of partial
6971 lookups. However, there might be a use for lookup types such as
6972 &"partial0(.)lsearch*"&.
6973
6974 The use of &"*"& in lookup partial matching differs from its use as a wildcard
6975 in domain lists and the like. Partial matching works only in terms of
6976 dot-separated components; a key such as &`*fict.example`&
6977 in a database file is useless, because the asterisk in a partial matching
6978 subject key is always followed by a dot.
6979
6980
6981
6982
6983 .section "Lookup caching" "SECID64"
6984 .cindex "lookup" "caching"
6985 .cindex "caching" "lookup data"
6986 Exim caches all lookup results in order to avoid needless repetition of
6987 lookups. However, because (apart from the daemon) Exim operates as a collection
6988 of independent, short-lived processes, this caching applies only within a
6989 single Exim process. There is no inter-process lookup caching facility.
6990
6991 For single-key lookups, Exim keeps the relevant files open in case there is
6992 another lookup that needs them. In some types of configuration this can lead to
6993 many files being kept open for messages with many recipients. To avoid hitting
6994 the operating system limit on the number of simultaneously open files, Exim
6995 closes the least recently used file when it needs to open more files than its
6996 own internal limit, which can be changed via the &%lookup_open_max%& option.
6997
6998 The single-key lookup files are closed and the lookup caches are flushed at
6999 strategic points during delivery &-- for example, after all routing is
7000 complete.
7001
7002
7003
7004
7005 .section "Quoting lookup data" "SECID65"
7006 .cindex "lookup" "quoting"
7007 .cindex "quoting" "in lookups"
7008 When data from an incoming message is included in a query-style lookup, there
7009 is the possibility of special characters in the data messing up the syntax of
7010 the query. For example, a NIS+ query that contains
7011 .code
7012 [name=$local_part]
7013 .endd
7014 will be broken if the local part happens to contain a closing square bracket.
7015 For NIS+, data can be enclosed in double quotes like this:
7016 .code
7017 [name="$local_part"]
7018 .endd
7019 but this still leaves the problem of a double quote in the data. The rule for
7020 NIS+ is that double quotes must be doubled. Other lookup types have different
7021 rules, and to cope with the differing requirements, an expansion operator
7022 of the following form is provided:
7023 .code
7024 ${quote_<lookup-type>:<string>}
7025 .endd
7026 For example, the safest way to write the NIS+ query is
7027 .code
7028 [name="${quote_nisplus:$local_part}"]
7029 .endd
7030 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
7031 operator can be used for all lookup types, but has no effect for single-key
7032 lookups, since no quoting is ever needed in their key strings.
7033
7034
7035
7036
7037 .section "More about dnsdb" "SECTdnsdb"
7038 .cindex "dnsdb lookup"
7039 .cindex "lookup" "dnsdb"
7040 .cindex "DNS" "as a lookup type"
7041 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
7042 of a record type and a domain name, separated by an equals sign. For example,
7043 an expansion string could contain:
7044 .code
7045 ${lookup dnsdb{mx=a.b.example}{$value}fail}
7046 .endd
7047 If the lookup succeeds, the result is placed in &$value$&, which in this case
7048 is used on its own as the result. If the lookup does not succeed, the
7049 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
7050 &<<SECTforexpfai>>& for an explanation of what this means.
7051
7052 The supported DNS record types are A, CNAME, MX, NS, PTR, SOA, SPF, SRV, TLSA
7053 and TXT, and, when Exim is compiled with IPv6 support, AAAA.
7054 If no type is given, TXT is assumed.
7055
7056 For any record type, if multiple records are found, the data is returned as a
7057 concatenation, with newline as the default separator. The order, of course,
7058 depends on the DNS resolver. You can specify a different separator character
7059 between multiple records by putting a right angle-bracket followed immediately
7060 by the new separator at the start of the query. For example:
7061 .code
7062 ${lookup dnsdb{>: a=host1.example}}
7063 .endd
7064 It is permitted to specify a space as the separator character. Further
7065 white space is ignored.
7066 For lookup types that return multiple fields per record,
7067 an alternate field separator can be specified using a comma after the main
7068 separator character, followed immediately by the field separator.
7069
7070 .cindex "PTR record" "in &(dnsdb)& lookup"
7071 When the type is PTR,
7072 the data can be an IP address, written as normal; inversion and the addition of
7073 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
7074 .code
7075 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
7076 .endd
7077 If the data for a PTR record is not a syntactically valid IP address, it is not
7078 altered and nothing is added.
7079
7080 .cindex "MX record" "in &(dnsdb)& lookup"
7081 .cindex "SRV record" "in &(dnsdb)& lookup"
7082 For an MX lookup, both the preference value and the host name are returned for
7083 each record, separated by a space. For an SRV lookup, the priority, weight,
7084 port, and host name are returned for each record, separated by spaces.
7085 The field separator can be modified as above.
7086
7087 .cindex "TXT record" "in &(dnsdb)& lookup"
7088 .cindex "SPF record" "in &(dnsdb)& lookup"
7089 For TXT records with multiple items of data, only the first item is returned,
7090 unless a field separator is specified.
7091 To concatenate items without a separator, use a semicolon instead.
7092 For SPF records the
7093 default behaviour is to concatenate multiple items without using a separator.
7094 .code
7095 ${lookup dnsdb{>\n,: txt=a.b.example}}
7096 ${lookup dnsdb{>\n; txt=a.b.example}}
7097 ${lookup dnsdb{spf=example.org}}
7098 .endd
7099 It is permitted to specify a space as the separator character. Further
7100 white space is ignored.
7101
7102 .cindex "SOA record" "in &(dnsdb)& lookup"
7103 For an SOA lookup, while no result is obtained the lookup is redone with
7104 successively more leading components dropped from the given domain.
7105 Only the primary-nameserver field is returned unless a field separator is
7106 specified.
7107 .code
7108 ${lookup dnsdb{>:,; soa=a.b.example.com}}
7109 .endd
7110
7111 .section "Dnsdb lookup modifiers" "SECTdnsdb_mod"
7112 .cindex "dnsdb modifiers"
7113 .cindex "modifiers" "dnsdb"
7114 .cindex "options" "dnsdb"
7115 Modifiers for &(dnsdb)& lookups are given by optional keywords,
7116 each followed by a comma,
7117 that may appear before the record type.
7118
7119 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
7120 temporary DNS error for any of them, the behaviour is controlled by
7121 a defer-option modifier.
7122 The possible keywords are
7123 &"defer_strict"&, &"defer_never"&, and &"defer_lax"&.
7124 With &"strict"& behaviour, any temporary DNS error causes the
7125 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
7126 ignored, and the behaviour is as if the DNS lookup failed to find anything.
7127 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
7128 error causes the whole lookup to defer only if none of the other lookups
7129 succeed. The default is &"lax"&, so the following lookups are equivalent:
7130 .code
7131 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
7132 ${lookup dnsdb{a=one.host.com:two.host.com}}
7133 .endd
7134 Thus, in the default case, as long as at least one of the DNS lookups
7135 yields some data, the lookup succeeds.
7136
7137 .cindex "DNSSEC" "dns lookup"
7138 Use of &(DNSSEC)& is controlled by a dnssec modifier.
7139 The possible keywords are
7140 &"dnssec_strict"&, &"dnssec_lax"&, and &"dnssec_never"&.
7141 With &"strict"& or &"lax"& DNSSEC information is requested
7142 with the lookup.
7143 With &"strict"& a response from the DNS resolver that
7144 is not labelled as authenticated data
7145 is treated as equivalent to a temporary DNS error.
7146 The default is &"never"&.
7147
7148 See also the &$lookup_dnssec_authenticated$& variable.
7149
7150 .cindex timeout "dns lookup"
7151 .cindex "DNS" timeout
7152 Timeout for the dnsdb lookup can be controlled by a retrans modifier.
7153 The form is &"retrans_VAL"& where VAL is an Exim time specification
7154 (e.g. &"5s"&).
7155 The default value is set by the main configuration option &%dns_retrans%&.
7156
7157 Retries for the dnsdb lookup can be controlled by a retry modifier.
7158 The form if &"retry_VAL"& where VAL is an integer.
7159 The default count is set by the main configuration option &%dns_retry%&.
7160
7161 .cindex caching "of dns lookup"
7162 .cindex TTL "of dns lookup"
7163 .cindex DNS TTL
7164 Dnsdb lookup results are cached within a single process (and its children).
7165 The cache entry lifetime is limited to the smallest time-to-live (TTL)
7166 value of the set of returned DNS records.
7167
7168
7169 .section "Pseudo dnsdb record types" "SECID66"
7170 .cindex "MX record" "in &(dnsdb)& lookup"
7171 By default, both the preference value and the host name are returned for
7172 each MX record, separated by a space. If you want only host names, you can use
7173 the pseudo-type MXH:
7174 .code
7175 ${lookup dnsdb{mxh=a.b.example}}
7176 .endd
7177 In this case, the preference values are omitted, and just the host names are
7178 returned.
7179
7180 .cindex "name server for enclosing domain"
7181 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
7182 records on the given domain, but if none are found, it removes the first
7183 component of the domain name, and tries again. This process continues until NS
7184 records are found or there are no more components left (or there is a DNS
7185 error). In other words, it may return the name servers for a top-level domain,
7186 but it never returns the root name servers. If there are no NS records for the
7187 top-level domain, the lookup fails. Consider these examples:
7188 .code
7189 ${lookup dnsdb{zns=xxx.quercite.com}}
7190 ${lookup dnsdb{zns=xxx.edu}}
7191 .endd
7192 Assuming that in each case there are no NS records for the full domain name,
7193 the first returns the name servers for &%quercite.com%&, and the second returns
7194 the name servers for &%edu%&.
7195
7196 You should be careful about how you use this lookup because, unless the
7197 top-level domain does not exist, the lookup always returns some host names. The
7198 sort of use to which this might be put is for seeing if the name servers for a
7199 given domain are on a blacklist. You can probably assume that the name servers
7200 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
7201 such a list.
7202
7203 .cindex "CSA" "in &(dnsdb)& lookup"
7204 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
7205 records according to the CSA rules, which are described in section
7206 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
7207 not sufficient because of the extra parent domain search behaviour of CSA. The
7208 result of a successful lookup such as:
7209 .code
7210 ${lookup dnsdb {csa=$sender_helo_name}}
7211 .endd
7212 has two space-separated fields: an authorization code and a target host name.
7213 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
7214 authorization required but absent, or &"?"& for unknown.
7215
7216 .cindex "A+" "in &(dnsdb)& lookup"
7217 The pseudo-type A+ performs an AAAA
7218 and then an A lookup.  All results are returned; defer processing
7219 (see below) is handled separately for each lookup.  Example:
7220 .code
7221 ${lookup dnsdb {>; a+=$sender_helo_name}}
7222 .endd
7223
7224
7225 .section "Multiple dnsdb lookups" "SECID67"
7226 In the previous sections, &(dnsdb)& lookups for a single domain are described.
7227 However, you can specify a list of domains or IP addresses in a single
7228 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
7229 the default separator, but with the ability to change this. For example:
7230 .code
7231 ${lookup dnsdb{one.domain.com:two.domain.com}}
7232 ${lookup dnsdb{a=one.host.com:two.host.com}}
7233 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
7234 .endd
7235 In order to retain backwards compatibility, there is one special case: if
7236 the lookup type is PTR and no change of separator is specified, Exim looks
7237 to see if the rest of the string is precisely one IPv6 address. In this
7238 case, it does not treat it as a list.
7239
7240 The data from each lookup is concatenated, with newline separators by default,
7241 in the same way that multiple DNS records for a single item are handled. A
7242 different separator can be specified, as described above.
7243
7244
7245
7246
7247 .section "More about LDAP" "SECTldap"
7248 .cindex "LDAP" "lookup, more about"
7249 .cindex "lookup" "LDAP"
7250 .cindex "Solaris" "LDAP"
7251 The original LDAP implementation came from the University of Michigan; this has
7252 become &"Open LDAP"&, and there are now two different releases. Another
7253 implementation comes from Netscape, and Solaris 7 and subsequent releases
7254 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7255 the lookup function level, their error handling is different. For this reason
7256 it is necessary to set a compile-time variable when building Exim with LDAP, to
7257 indicate which LDAP library is in use. One of the following should appear in
7258 your &_Local/Makefile_&:
7259 .code
7260 LDAP_LIB_TYPE=UMICHIGAN
7261 LDAP_LIB_TYPE=OPENLDAP1
7262 LDAP_LIB_TYPE=OPENLDAP2
7263 LDAP_LIB_TYPE=NETSCAPE
7264 LDAP_LIB_TYPE=SOLARIS
7265 .endd
7266 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7267 same interface as the University of Michigan version.
7268
7269 There are three LDAP lookup types in Exim. These behave slightly differently in
7270 the way they handle the results of a query:
7271
7272 .ilist
7273 &(ldap)& requires the result to contain just one entry; if there are more, it
7274 gives an error.
7275 .next
7276 &(ldapdn)& also requires the result to contain just one entry, but it is the
7277 Distinguished Name that is returned rather than any attribute values.
7278 .next
7279 &(ldapm)& permits the result to contain more than one entry; the attributes
7280 from all of them are returned.
7281 .endlist
7282
7283
7284 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7285 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7286 the data returned by a successful lookup is described in the next section.
7287 First we explain how LDAP queries are coded.
7288
7289
7290 .section "Format of LDAP queries" "SECTforldaque"
7291 .cindex "LDAP" "query format"
7292 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7293 the configuration of a &(redirect)& router one might have this setting:
7294 .code
7295 data = ${lookup ldap \
7296   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7297   c=UK?mailbox?base?}}
7298 .endd
7299 .cindex "LDAP" "with TLS"
7300 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7301 secure (encrypted) LDAP connections. The second of these ensures that an
7302 encrypted TLS connection is used.
7303
7304 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7305 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7306 See the &%ldap_start_tls%& option.
7307
7308 Starting with Exim 4.83, the initialization of LDAP with TLS is more tightly
7309 controlled. Every part of the TLS configuration can be configured by settings in
7310 &_exim.conf_&. Depending on the version of the client libraries installed on
7311 your system, some of the initialization may have required setting options in
7312 &_/etc/ldap.conf_& or &_~/.ldaprc_& to get TLS working with self-signed
7313 certificates. This revealed a nuance where the current UID that exim was
7314 running as could affect which config files it read. With Exim 4.83, these
7315 methods become optional, only taking effect if not specifically set in
7316 &_exim.conf_&.
7317
7318
7319 .section "LDAP quoting" "SECID68"
7320 .cindex "LDAP" "quoting"
7321 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7322 and the second because the LDAP query is represented as a URL. Furthermore,
7323 within an LDAP query, two different kinds of quoting are required. For this
7324 reason, there are two different LDAP-specific quoting operators.
7325
7326 The &%quote_ldap%& operator is designed for use on strings that are part of
7327 filter specifications. Conceptually, it first does the following conversions on
7328 the string:
7329 .code
7330 *   =>   \2A
7331 (   =>   \28
7332 )   =>   \29
7333 \   =>   \5C
7334 .endd
7335 in accordance with RFC 2254. The resulting string is then quoted according
7336 to the rules for URLs, that is, all non-alphanumeric characters except
7337 .code
7338 ! $ ' - . _ ( ) * +
7339 .endd
7340 are converted to their hex values, preceded by a percent sign. For example:
7341 .code
7342 ${quote_ldap: a(bc)*, a<yz>; }
7343 .endd
7344 yields
7345 .code
7346 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7347 .endd
7348 Removing the URL quoting, this is (with a leading and a trailing space):
7349 .code
7350 a\28bc\29\2A, a<yz>;
7351 .endd
7352 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7353 base DN specifications in queries. Conceptually, it first converts the string
7354 by inserting a backslash in front of any of the following characters:
7355 .code
7356 , + " \ < > ;
7357 .endd
7358 It also inserts a backslash before any leading spaces or # characters, and
7359 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7360 is then quoted according to the rules for URLs. For example:
7361 .code
7362 ${quote_ldap_dn: a(bc)*, a<yz>; }
7363 .endd
7364 yields
7365 .code
7366 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7367 .endd
7368 Removing the URL quoting, this is (with a trailing space):
7369 .code
7370 \ a(bc)*\, a\<yz\>\;\
7371 .endd
7372 There are some further comments about quoting in the section on LDAP
7373 authentication below.
7374
7375
7376 .section "LDAP connections" "SECID69"
7377 .cindex "LDAP" "connections"
7378 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7379 is in use, via a Unix domain socket. The example given above does not specify
7380 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7381 by starting it with
7382 .code
7383 ldap://<hostname>:<port>/...
7384 .endd
7385 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7386 used. When no server is specified in a query, a list of default servers is
7387 taken from the &%ldap_default_servers%& configuration option. This supplies a
7388 colon-separated list of servers which are tried in turn until one successfully
7389 handles a query, or there is a serious error. Successful handling either
7390 returns the requested data, or indicates that it does not exist. Serious errors
7391 are syntactical, or multiple values when only a single value is expected.
7392 Errors which cause the next server to be tried are connection failures, bind
7393 failures, and timeouts.
7394
7395 For each server name in the list, a port number can be given. The standard way
7396 of specifying a host and port is to use a colon separator (RFC 1738). Because
7397 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7398 doubled. For example
7399 .code
7400 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7401 .endd
7402 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7403 to the LDAP library with no server name, and the library's default (normally
7404 the local host) is used.
7405
7406 If you are using the OpenLDAP library, you can connect to an LDAP server using
7407 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7408 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7409 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7410 not available.
7411
7412 For this type of connection, instead of a host name for the server, a pathname
7413 for the socket is required, and the port number is not relevant. The pathname
7414 can be specified either as an item in &%ldap_default_servers%&, or inline in
7415 the query. In the former case, you can have settings such as
7416 .code
7417 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7418 .endd
7419 When the pathname is given in the query, you have to escape the slashes as
7420 &`%2F`& to fit in with the LDAP URL syntax. For example:
7421 .code
7422 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7423 .endd
7424 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7425 a pathname, it uses the Unix domain socket code, even if the query actually
7426 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7427 socket connection. This behaviour means that you can use a setting of
7428 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7429 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7430 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7431 backup host.
7432
7433 If an explicit &`ldapi`& type is given in a query when a host name is
7434 specified, an error is diagnosed. However, if there are more items in
7435 &%ldap_default_servers%&, they are tried. In other words:
7436
7437 .ilist
7438 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7439 interface.
7440 .next
7441 Using &`ldapi`& with a host name causes an error.
7442 .endlist
7443
7444
7445 Using &`ldapi`& with no host or path in the query, and no setting of
7446 &%ldap_default_servers%&, does whatever the library does by default.
7447
7448
7449
7450 .section "LDAP authentication and control information" "SECID70"
7451 .cindex "LDAP" "authentication"
7452 The LDAP URL syntax provides no way of passing authentication and other control
7453 information to the server. To make this possible, the URL in an LDAP query may
7454 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7455 spaces. If a value contains spaces it must be enclosed in double quotes, and
7456 when double quotes are used, backslash is interpreted in the usual way inside
7457 them. The following names are recognized:
7458 .display
7459 &`DEREFERENCE`&  set the dereferencing parameter
7460 &`NETTIME    `&  set a timeout for a network operation
7461 &`USER       `&  set the DN, for authenticating the LDAP bind
7462 &`PASS       `&  set the password, likewise
7463 &`REFERRALS  `&  set the referrals parameter
7464 &`SERVERS    `&  set alternate server list for this query only
7465 &`SIZE       `&  set the limit for the number of entries returned
7466 &`TIME       `&  set the maximum waiting time for a query
7467 .endd
7468 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7469 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7470 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7471 library from trying to follow referrals issued by the LDAP server.
7472
7473 .cindex LDAP timeout
7474 .cindex timeout "LDAP lookup"
7475 The name CONNECT is an obsolete name for NETTIME, retained for
7476 backwards compatibility. This timeout (specified as a number of seconds) is
7477 enforced from the client end for operations that can be carried out over a
7478 network. Specifically, it applies to network connections and calls to the
7479 &'ldap_result()'& function. If the value is greater than zero, it is used if
7480 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7481 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7482 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7483 Netscape SDK; for OpenLDAP no action is taken.
7484
7485 The TIME parameter (also a number of seconds) is passed to the server to
7486 set a server-side limit on the time taken to complete a search.
7487
7488 The SERVERS parameter allows you to specify an alternate list of ldap servers
7489 to use for an individual lookup.  The global &%ldap_default_servers%& option provides a
7490 default list of ldap servers, and a single lookup can specify a single ldap
7491 server to use.  But when you need to do a lookup with a list of servers that is
7492 different than the default list (maybe different order, maybe a completely
7493 different set of servers), the SERVERS parameter allows you to specify this
7494 alternate list (colon-separated).
7495
7496 Here is an example of an LDAP query in an Exim lookup that uses some of these
7497 values. This is a single line, folded to fit on the page:
7498 .code
7499 ${lookup ldap
7500   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7501   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7502   {$value}fail}
7503 .endd
7504 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7505 any of the auxiliary data. Exim configuration settings that include lookups
7506 which contain password information should be preceded by &"hide"& to prevent
7507 non-admin users from using the &%-bP%& option to see their values.
7508
7509 The auxiliary data items may be given in any order. The default is no
7510 connection timeout (the system timeout is used), no user or password, no limit
7511 on the number of entries returned, and no time limit on queries.
7512
7513 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7514 removes any URL quoting that it may contain before passing it LDAP. Apparently
7515 some libraries do this for themselves, but some do not. Removing the URL
7516 quoting has two advantages:
7517
7518 .ilist
7519 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7520 DNs as with DNs inside actual queries.
7521 .next
7522 It permits spaces inside USER= DNs.
7523 .endlist
7524
7525 For example, a setting such as
7526 .code
7527 USER=cn=${quote_ldap_dn:$1}
7528 .endd
7529 should work even if &$1$& contains spaces.
7530
7531 Expanded data for the PASS= value should be quoted using the &%quote%&
7532 expansion operator, rather than the LDAP quote operators. The only reason this
7533 field needs quoting is to ensure that it conforms to the Exim syntax, which
7534 does not allow unquoted spaces. For example:
7535 .code
7536 PASS=${quote:$3}
7537 .endd
7538 The LDAP authentication mechanism can be used to check passwords as part of
7539 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7540 &<<CHAPexpand>>&.
7541
7542
7543
7544 .section "Format of data returned by LDAP" "SECID71"
7545 .cindex "LDAP" "returned data formats"
7546 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7547 as a sequence of values, for example
7548 .code
7549 cn=manager,o=University of Cambridge,c=UK
7550 .endd
7551 The &(ldap)& lookup type generates an error if more than one entry matches the
7552 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7553 the result between the data from different entries. It is possible for multiple
7554 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7555 you know that whatever values are returned all came from a single entry in the
7556 directory.
7557
7558 In the common case where you specify a single attribute in your LDAP query, the
7559 result is not quoted, and does not contain the attribute name. If the attribute
7560 has multiple values, they are separated by commas. Any comma that is
7561 part of an attribute's value is doubled.
7562
7563 If you specify multiple attributes, the result contains space-separated, quoted
7564 strings, each preceded by the attribute name and an equals sign. Within the
7565 quotes, the quote character, backslash, and newline are escaped with
7566 backslashes, and commas are used to separate multiple values for the attribute.
7567 Any commas in attribute values are doubled
7568 (permitting treatment of the values as a comma-separated list).
7569 Apart from the escaping, the string within quotes takes the same form as the
7570 output when a single attribute is requested. Specifying no attributes is the
7571 same as specifying all of an entry's attributes.
7572
7573 Here are some examples of the output format. The first line of each pair is an
7574 LDAP query, and the second is the data that is returned. The attribute called
7575 &%attr1%& has two values, one of them with an embedded comma, whereas
7576 &%attr2%& has only one value. Both attributes are derived from &%attr%&
7577 (they have SUP &%attr%& in their schema definitions).
7578
7579 .code
7580 ldap:///o=base?attr1?sub?(uid=fred)
7581 value1.1,value1,,2
7582
7583 ldap:///o=base?attr2?sub?(uid=fred)
7584 value two
7585
7586 ldap:///o=base?attr?sub?(uid=fred)
7587 value1.1,value1,,2,value two
7588
7589 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7590 attr1="value1.1,value1,,2" attr2="value two"
7591
7592 ldap:///o=base??sub?(uid=fred)
7593 objectClass="top" attr1="value1.1,value1,,2" attr2="value two"
7594 .endd
7595 You can
7596 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7597 results of LDAP lookups.
7598 The &%extract%& operator in string expansions can be used to pick out
7599 individual fields from data that consists of &'key'&=&'value'& pairs.
7600 The &%listextract%& operator should be used to pick out individual values
7601 of attributes, even when only a single value is expected.
7602 The doubling of embedded commas allows you to use the returned data as a
7603 comma separated list (using the "<," syntax for changing the input list separator).
7604
7605
7606
7607
7608 .section "More about NIS+" "SECTnisplus"
7609 .cindex "NIS+ lookup type"
7610 .cindex "lookup" "NIS+"
7611 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7612 and field name. If this is given, the result of a successful query is the
7613 contents of the named field; otherwise the result consists of a concatenation
7614 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7615 values containing spaces are quoted. For example, the query
7616 .code
7617 [name=mg1456],passwd.org_dir
7618 .endd
7619 might return the string
7620 .code
7621 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7622 home=/home/mg1456 shell=/bin/bash shadow=""
7623 .endd
7624 (split over two lines here to fit on the page), whereas
7625 .code
7626 [name=mg1456],passwd.org_dir:gcos
7627 .endd
7628 would just return
7629 .code
7630 Martin Guerre
7631 .endd
7632 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7633 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7634 operator is to double any quote characters within the text.
7635
7636
7637
7638 .section "SQL lookups" "SECTsql"
7639 .cindex "SQL lookup types"
7640 .cindex "MySQL" "lookup type"
7641 .cindex "PostgreSQL lookup type"
7642 .cindex "lookup" "MySQL"
7643 .cindex "lookup" "PostgreSQL"
7644 .cindex "Oracle" "lookup type"
7645 .cindex "lookup" "Oracle"
7646 .cindex "InterBase lookup type"
7647 .cindex "lookup" "InterBase"
7648 .cindex "Redis lookup type"
7649 .cindex lookup Redis
7650 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, Redis,
7651 and SQLite
7652 databases. Queries for these databases contain SQL statements, so an example
7653 might be
7654 .code
7655 ${lookup mysql{select mailbox from users where id='userx'}\
7656   {$value}fail}
7657 .endd
7658 If the result of the query contains more than one field, the data for each
7659 field in the row is returned, preceded by its name, so the result of
7660 .code
7661 ${lookup pgsql{select home,name from users where id='userx'}\
7662   {$value}}
7663 .endd
7664 might be
7665 .code
7666 home=/home/userx name="Mister X"
7667 .endd
7668 Empty values and values containing spaces are double quoted, with embedded
7669 quotes escaped by a backslash. If the result of the query contains just one
7670 field, the value is passed back verbatim, without a field name, for example:
7671 .code
7672 Mister X
7673 .endd
7674 If the result of the query yields more than one row, it is all concatenated,
7675 with a newline between the data for each row.
7676
7677
7678 .section "More about MySQL, PostgreSQL, Oracle, InterBase, and Redis" "SECID72"
7679 .cindex "MySQL" "lookup type"
7680 .cindex "PostgreSQL lookup type"
7681 .cindex "lookup" "MySQL"
7682 .cindex "lookup" "PostgreSQL"
7683 .cindex "Oracle" "lookup type"
7684 .cindex "lookup" "Oracle"
7685 .cindex "InterBase lookup type"
7686 .cindex "lookup" "InterBase"
7687 .cindex "Redis lookup type"
7688 .cindex lookup Redis
7689 If any MySQL, PostgreSQL, Oracle, InterBase or Redis lookups are used, the
7690 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, &%ibase_servers%&,
7691 or &%redis_servers%&
7692 option (as appropriate) must be set to a colon-separated list of server
7693 information.
7694 (For MySQL and PostgreSQL, the global option need not be set if all
7695 queries contain their own server information &-- see section
7696 &<<SECTspeserque>>&.)
7697 For all but Redis
7698 each item in the list is a slash-separated list of four
7699 items: host name, database name, user name, and password. In the case of
7700 Oracle, the host name field is used for the &"service name"&, and the database
7701 name field is not used and should be empty. For example:
7702 .code
7703 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7704 .endd
7705 Because password data is sensitive, you should always precede the setting with
7706 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7707 option. Here is an example where two MySQL servers are listed:
7708 .code
7709 hide mysql_servers = localhost/users/root/secret:\
7710                      otherhost/users/root/othersecret
7711 .endd
7712 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7713 because this is a colon-separated list, the colon has to be doubled. For each
7714 query, these parameter groups are tried in order until a connection is made and
7715 a query is successfully processed. The result of a query may be that no data is
7716 found, but that is still a successful query. In other words, the list of
7717 servers provides a backup facility, not a list of different places to look.
7718
7719 For Redis the global option need not be specified if all queries contain their
7720 own server information &-- see section &<<SECTspeserque>>&.
7721 If specified, the option must be set to a colon-separated list of server
7722 information.
7723 Each item in the list is a slash-separated list of three items:
7724 host, database number, and password.
7725 .olist
7726 The host is required and may be either an IPv4 address and optional
7727 port number (separated by a colon, which needs doubling due to the
7728 higher-level list), or a Unix socket pathname enclosed in parentheses
7729 .next
7730 The database number is optional; if present that number is selected in the backend
7731 .next
7732 The password is optional; if present it is used to authenticate to the backend
7733 .endlist
7734
7735 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
7736 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
7737 respectively, and the characters single-quote, double-quote, and backslash
7738 itself are escaped with backslashes.
7739
7740 The &%quote_redis%& expansion operator
7741 escapes whitespace and backslash characters with a backslash.
7742
7743 .section "Specifying the server in the query" "SECTspeserque"
7744 For MySQL, PostgreSQL and Redis lookups (but not currently for Oracle and InterBase),
7745 it is possible to specify a list of servers with an individual query. This is
7746 done by starting the query with
7747 .display
7748 &`servers=`&&'server1:server2:server3:...'&&`;`&
7749 .endd
7750 Each item in the list may take one of two forms:
7751 .olist
7752 If it contains no slashes it is assumed to be just a host name. The appropriate
7753 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
7754 of the same name, and the remaining parameters (database, user, password) are
7755 taken from there.
7756 .next
7757 If it contains any slashes, it is taken as a complete parameter set.
7758 .endlist
7759 The list of servers is used in exactly the same way as the global list.
7760 Once a connection to a server has happened and a query has been
7761 successfully executed, processing of the lookup ceases.
7762
7763 This feature is intended for use in master/slave situations where updates
7764 are occurring and you want to update the master rather than a slave. If the
7765 master is in the list as a backup for reading, you might have a global setting
7766 like this:
7767 .code
7768 mysql_servers = slave1/db/name/pw:\
7769                 slave2/db/name/pw:\
7770                 master/db/name/pw
7771 .endd
7772 In an updating lookup, you could then write:
7773 .code
7774 ${lookup mysql{servers=master; UPDATE ...} }
7775 .endd
7776 That query would then be sent only to the master server. If, on the other hand,
7777 the master is not to be used for reading, and so is not present in the global
7778 option, you can still update it by a query of this form:
7779 .code
7780 ${lookup pgsql{servers=master/db/name/pw; UPDATE ...} }
7781 .endd
7782
7783
7784 .section "Special MySQL features" "SECID73"
7785 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
7786 causes a connection to the server on the local host by means of a Unix domain
7787 socket. An alternate socket can be specified in parentheses.
7788 An option group name for MySQL option files can be specified in square brackets;
7789 the default value is &"exim"&.
7790 The full syntax of each item in &%mysql_servers%& is:
7791 .display
7792 <&'hostname'&>::<&'port'&>(<&'socket name'&>)[<&'option group'&>]/&&&
7793   <&'database'&>/<&'user'&>/<&'password'&>
7794 .endd
7795 Any of the four sub-parts of the first field can be omitted. For normal use on
7796 the local host it can be left blank or set to just &"localhost"&.
7797
7798 No database need be supplied &-- but if it is absent here, it must be given in
7799 the queries.
7800
7801 If a MySQL query is issued that does not request any data (an insert, update,
7802 or delete command), the result of the lookup is the number of rows affected.
7803
7804 &*Warning*&: This can be misleading. If an update does not actually change
7805 anything (for example, setting a field to the value it already has), the result
7806 is zero because no rows are affected.
7807
7808
7809 .section "Special PostgreSQL features" "SECID74"
7810 PostgreSQL lookups can also use Unix domain socket connections to the database.
7811 This is usually faster and costs less CPU time than a TCP/IP connection.
7812 However it can be used only if the mail server runs on the same machine as the
7813 database server. A configuration line for PostgreSQL via Unix domain sockets
7814 looks like this:
7815 .code
7816 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
7817 .endd
7818 In other words, instead of supplying a host name, a path to the socket is
7819 given. The path name is enclosed in parentheses so that its slashes aren't
7820 visually confused with the delimiters for the other server parameters.
7821
7822 If a PostgreSQL query is issued that does not request any data (an insert,
7823 update, or delete command), the result of the lookup is the number of rows
7824 affected.
7825
7826 .section "More about SQLite" "SECTsqlite"
7827 .cindex "lookup" "SQLite"
7828 .cindex "sqlite lookup type"
7829 SQLite is different to the other SQL lookups because a file name is required in
7830 addition to the SQL query. An SQLite database is a single file, and there is no
7831 daemon as in the other SQL databases. The interface to Exim requires the name
7832 of the file, as an absolute path, to be given at the start of the query. It is
7833 separated from the query by white space. This means that the path name cannot
7834 contain white space. Here is a lookup expansion example:
7835 .code
7836 ${lookup sqlite {/some/thing/sqlitedb \
7837   select name from aliases where id='userx';}}
7838 .endd
7839 In a list, the syntax is similar. For example:
7840 .code
7841 domainlist relay_to_domains = sqlite;/some/thing/sqlitedb \
7842    select * from relays where ip='$sender_host_address';
7843 .endd
7844 The only character affected by the &%quote_sqlite%& operator is a single
7845 quote, which it doubles.
7846
7847 .cindex timeout SQLite
7848 .cindex sqlite "lookup timeout"
7849 The SQLite library handles multiple simultaneous accesses to the database
7850 internally. Multiple readers are permitted, but only one process can
7851 update at once. Attempts to access the database while it is being updated
7852 are rejected after a timeout period, during which the SQLite library
7853 waits for the lock to be released. In Exim, the default timeout is set
7854 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
7855 option.
7856
7857 .section "More about Redis" "SECTredis"
7858 .cindex "lookup" "Redis"
7859 .cindex "redis lookup type"
7860 Redis is a non-SQL database. Commands are simple get and set.
7861 Examples:
7862 .code
7863 ${lookup redis{set keyname ${quote_redis:objvalue plus}}}
7864 ${lookup redis{get keyname}}
7865 .endd
7866
7867 .new
7868 As of release 4.91, "lightweight" support for Redis Cluster is available.
7869 Requires &%redis_servers%& list to contain all the servers in the cluster, all
7870 of which must be reachable from the running exim instance. If the cluster has
7871 master/slave replication, the list must contain all the master and slave
7872 servers.
7873
7874 When the Redis Cluster returns a "MOVED" response to a query, exim does not
7875 immediately follow the redirection but treats the response as a DEFER, moving on
7876 to the next server in the &%redis_servers%& list until the correct server is
7877 reached.
7878 .wen
7879
7880 .ecindex IIDfidalo1
7881 .ecindex IIDfidalo2
7882
7883
7884 . ////////////////////////////////////////////////////////////////////////////
7885 . ////////////////////////////////////////////////////////////////////////////
7886
7887 .chapter "Domain, host, address, and local part lists" &&&
7888          "CHAPdomhosaddlists" &&&
7889          "Domain, host, and address lists"
7890 .scindex IIDdohoadli "lists of domains; hosts; etc."
7891 A number of Exim configuration options contain lists of domains, hosts,
7892 email addresses, or local parts. For example, the &%hold_domains%& option
7893 contains a list of domains whose delivery is currently suspended. These lists
7894 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
7895 arguments to expansion conditions such as &%match_domain%&.
7896
7897 Each item in one of these lists is a pattern to be matched against a domain,
7898 host, email address, or local part, respectively. In the sections below, the
7899 different types of pattern for each case are described, but first we cover some
7900 general facilities that apply to all four kinds of list.
7901
7902 Note that other parts of Exim use a &'string list'& which does not
7903 support all the complexity available in
7904 domain, host, address and local part lists.
7905
7906
7907
7908 .section "Expansion of lists" "SECTlistexpand"
7909 .cindex "expansion" "of lists"
7910 Each list is expanded as a single string before it is used.
7911
7912 &'Exception: the router headers_remove option, where list-item
7913 splitting is done before string-expansion.'&
7914
7915 The result of
7916 expansion must be a list, possibly containing empty items, which is split up
7917 into separate items for matching. By default, colon is the separator character,
7918 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
7919 &<<SECTempitelis>>& for details of the list syntax; the second of these
7920 discusses the way to specify empty list items.
7921
7922
7923 If the string expansion is forced to fail, Exim behaves as if the item it is
7924 testing (domain, host, address, or local part) is not in the list. Other
7925 expansion failures cause temporary errors.
7926
7927 If an item in a list is a regular expression, backslashes, dollars and possibly
7928 other special characters in the expression must be protected against
7929 misinterpretation by the string expander. The easiest way to do this is to use
7930 the &`\N`& expansion feature to indicate that the contents of the regular
7931 expression should not be expanded. For example, in an ACL you might have:
7932 .code
7933 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
7934                ${lookup{$domain}lsearch{/badsenders/bydomain}}
7935 .endd
7936 The first item is a regular expression that is protected from expansion by
7937 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
7938 senders based on the receiving domain.
7939
7940
7941
7942
7943 .section "Negated items in lists" "SECID76"
7944 .cindex "list" "negation"
7945 .cindex "negation" "in lists"
7946 Items in a list may be positive or negative. Negative items are indicated by a
7947 leading exclamation mark, which may be followed by optional white space. A list
7948 defines a set of items (domains, etc). When Exim processes one of these lists,
7949 it is trying to find out whether a domain, host, address, or local part
7950 (respectively) is in the set that is defined by the list. It works like this:
7951
7952 The list is scanned from left to right. If a positive item is matched, the
7953 subject that is being checked is in the set; if a negative item is matched, the
7954 subject is not in the set. If the end of the list is reached without the
7955 subject having matched any of the patterns, it is in the set if the last item
7956 was a negative one, but not if it was a positive one. For example, the list in
7957 .code
7958 domainlist relay_to_domains = !a.b.c : *.b.c
7959 .endd
7960 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
7961 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
7962 list is positive. However, if the setting were
7963 .code
7964 domainlist relay_to_domains = !a.b.c
7965 .endd
7966 then all domains other than &'a.b.c'& would match because the last item in the
7967 list is negative. In other words, a list that ends with a negative item behaves
7968 as if it had an extra item &`:*`& on the end.
7969
7970 Another way of thinking about positive and negative items in lists is to read
7971 the connector as &"or"& after a positive item and as &"and"& after a negative
7972 item.
7973
7974
7975
7976 .section "File names in lists" "SECTfilnamlis"
7977 .cindex "list" "file name in"
7978 If an item in a domain, host, address, or local part list is an absolute file
7979 name (beginning with a slash character), each line of the file is read and
7980 processed as if it were an independent item in the list, except that further
7981 file names are not allowed,
7982 and no expansion of the data from the file takes place.
7983 Empty lines in the file are ignored, and the file may also contain comment
7984 lines:
7985
7986 .ilist
7987 For domain and host lists, if a # character appears anywhere in a line of the
7988 file, it and all following characters are ignored.
7989 .next
7990 Because local parts may legitimately contain # characters, a comment in an
7991 address list or local part list file is recognized only if # is preceded by
7992 white space or the start of the line. For example:
7993 .code
7994 not#comment@x.y.z   # but this is a comment
7995 .endd
7996 .endlist
7997
7998 Putting a file name in a list has the same effect as inserting each line of the
7999 file as an item in the list (blank lines and comments excepted). However, there
8000 is one important difference: the file is read each time the list is processed,
8001 so if its contents vary over time, Exim's behaviour changes.
8002
8003 If a file name is preceded by an exclamation mark, the sense of any match
8004 within the file is inverted. For example, if
8005 .code
8006 hold_domains = !/etc/nohold-domains
8007 .endd
8008 and the file contains the lines
8009 .code
8010 !a.b.c
8011 *.b.c
8012 .endd
8013 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
8014 any domain matching &`*.b.c`& is not.
8015
8016
8017
8018 .section "An lsearch file is not an out-of-line list" "SECID77"
8019 As will be described in the sections that follow, lookups can be used in lists
8020 to provide indexed methods of checking list membership. There has been some
8021 confusion about the way &(lsearch)& lookups work in lists. Because
8022 an &(lsearch)& file contains plain text and is scanned sequentially, it is
8023 sometimes thought that it is allowed to contain wild cards and other kinds of
8024 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
8025 always fixed strings, just as for any other single-key lookup type.
8026
8027 If you want to use a file to contain wild-card patterns that form part of a
8028 list, just give the file name on its own, without a search type, as described
8029 in the previous section. You could also use the &(wildlsearch)& or
8030 &(nwildlsearch)&, but there is no advantage in doing this.
8031
8032
8033
8034
8035 .section "Named lists" "SECTnamedlists"
8036 .cindex "named lists"
8037 .cindex "list" "named"
8038 A list of domains, hosts, email addresses, or local parts can be given a name
8039 which is then used to refer to the list elsewhere in the configuration. This is
8040 particularly convenient if the same list is required in several different
8041 places. It also allows lists to be given meaningful names, which can improve
8042 the readability of the configuration. For example, it is conventional to define
8043 a domain list called &'local_domains'& for all the domains that are handled
8044 locally on a host, using a configuration line such as
8045 .code
8046 domainlist local_domains = localhost:my.dom.example
8047 .endd
8048 Named lists are referenced by giving their name preceded by a plus sign, so,
8049 for example, a router that is intended to handle local domains would be
8050 configured with the line
8051 .code
8052 domains = +local_domains
8053 .endd
8054 The first router in a configuration is often one that handles all domains
8055 except the local ones, using a configuration with a negated item like this:
8056 .code
8057 dnslookup:
8058   driver = dnslookup
8059   domains = ! +local_domains
8060   transport = remote_smtp
8061   no_more
8062 .endd
8063 The four kinds of named list are created by configuration lines starting with
8064 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
8065 respectively. Then there follows the name that you are defining, followed by an
8066 equals sign and the list itself. For example:
8067 .code
8068 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
8069 addresslist bad_senders = cdb;/etc/badsenders
8070 .endd
8071 A named list may refer to other named lists:
8072 .code
8073 domainlist  dom1 = first.example : second.example
8074 domainlist  dom2 = +dom1 : third.example
8075 domainlist  dom3 = fourth.example : +dom2 : fifth.example
8076 .endd
8077 &*Warning*&: If the last item in a referenced list is a negative one, the
8078 effect may not be what you intended, because the negation does not propagate
8079 out to the higher level. For example, consider:
8080 .code
8081 domainlist  dom1 = !a.b
8082 domainlist  dom2 = +dom1 : *.b
8083 .endd
8084 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
8085 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
8086 means it matches the second list as well. The effect is not the same as
8087 .code
8088 domainlist  dom2 = !a.b : *.b
8089 .endd
8090 where &'x.y'& does not match. It's best to avoid negation altogether in
8091 referenced lists if you can.
8092
8093 Named lists may have a performance advantage. When Exim is routing an
8094 address or checking an incoming message, it caches the result of tests on named
8095 lists. So, if you have a setting such as
8096 .code
8097 domains = +local_domains
8098 .endd
8099 on several of your routers
8100 or in several ACL statements,
8101 the actual test is done only for the first one. However, the caching works only
8102 if there are no expansions within the list itself or any sublists that it
8103 references. In other words, caching happens only for lists that are known to be
8104 the same each time they are referenced.
8105
8106 By default, there may be up to 16 named lists of each type. This limit can be
8107 extended by changing a compile-time variable. The use of domain and host lists
8108 is recommended for concepts such as local domains, relay domains, and relay
8109 hosts. The default configuration is set up like this.
8110
8111
8112
8113 .section "Named lists compared with macros" "SECID78"
8114 .cindex "list" "named compared with macro"
8115 .cindex "macro" "compared with named list"
8116 At first sight, named lists might seem to be no different from macros in the
8117 configuration file. However, macros are just textual substitutions. If you
8118 write
8119 .code
8120 ALIST = host1 : host2
8121 auth_advertise_hosts = !ALIST
8122 .endd
8123 it probably won't do what you want, because that is exactly the same as
8124 .code
8125 auth_advertise_hosts = !host1 : host2
8126 .endd
8127 Notice that the second host name is not negated. However, if you use a host
8128 list, and write
8129 .code
8130 hostlist alist = host1 : host2
8131 auth_advertise_hosts = ! +alist
8132 .endd
8133 the negation applies to the whole list, and so that is equivalent to
8134 .code
8135 auth_advertise_hosts = !host1 : !host2
8136 .endd
8137
8138
8139 .section "Named list caching" "SECID79"
8140 .cindex "list" "caching of named"
8141 .cindex "caching" "named lists"
8142 While processing a message, Exim caches the result of checking a named list if
8143 it is sure that the list is the same each time. In practice, this means that
8144 the cache operates only if the list contains no $ characters, which guarantees
8145 that it will not change when it is expanded. Sometimes, however, you may have
8146 an expanded list that you know will be the same each time within a given
8147 message. For example:
8148 .code
8149 domainlist special_domains = \
8150            ${lookup{$sender_host_address}cdb{/some/file}}
8151 .endd
8152 This provides a list of domains that depends only on the sending host's IP
8153 address. If this domain list is referenced a number of times (for example,
8154 in several ACL lines, or in several routers) the result of the check is not
8155 cached by default, because Exim does not know that it is going to be the
8156 same list each time.
8157
8158 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
8159 cache the result anyway. For example:
8160 .code
8161 domainlist_cache special_domains = ${lookup{...
8162 .endd
8163 If you do this, you should be absolutely sure that caching is going to do
8164 the right thing in all cases. When in doubt, leave it out.
8165
8166
8167
8168 .section "Domain lists" "SECTdomainlist"
8169 .cindex "domain list" "patterns for"
8170 .cindex "list" "domain list"
8171 Domain lists contain patterns that are to be matched against a mail domain.
8172 The following types of item may appear in domain lists:
8173
8174 .ilist
8175 .cindex "primary host name"
8176 .cindex "host name" "matched in domain list"
8177 .oindex "&%primary_hostname%&"
8178 .cindex "domain list" "matching primary host name"
8179 .cindex "@ in a domain list"
8180 If a pattern consists of a single @ character, it matches the local host name,
8181 as set by the &%primary_hostname%& option (or defaulted). This makes it
8182 possible to use the same configuration file on several different hosts that
8183 differ only in their names.
8184 .next
8185 .cindex "@[] in a domain list"
8186 .cindex "domain list" "matching local IP interfaces"
8187 .cindex "domain literal"
8188 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
8189 in square brackets (as in an email address that contains a domain literal), but
8190 only if that IP address is recognized as local for email routing purposes. The
8191 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
8192 control which of a host's several IP addresses are treated as local.
8193 In today's Internet, the use of domain literals is controversial.
8194 .next
8195 .cindex "@mx_any"
8196 .cindex "@mx_primary"
8197 .cindex "@mx_secondary"
8198 .cindex "domain list" "matching MX pointers to local host"
8199 If a pattern consists of the string &`@mx_any`& it matches any domain that
8200 has an MX record pointing to the local host or to any host that is listed in
8201 .oindex "&%hosts_treat_as_local%&"
8202 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
8203 are similar, except that the first matches only when a primary MX target is the
8204 local host, and the second only when no primary MX target is the local host,
8205 but a secondary MX target is. &"Primary"& means an MX record with the lowest
8206 preference value &-- there may of course be more than one of them.
8207
8208 The MX lookup that takes place when matching a pattern of this type is
8209 performed with the resolver options for widening names turned off. Thus, for
8210 example, a single-component domain will &'not'& be expanded by adding the
8211 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
8212 options of the &(dnslookup)& router for a discussion of domain widening.
8213
8214 Sometimes you may want to ignore certain IP addresses when using one of these
8215 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
8216 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
8217 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
8218 on a router). For example:
8219 .code
8220 domains = @mx_any/ignore=127.0.0.1
8221 .endd
8222 This example matches any domain that has an MX record pointing to one of
8223 the local host's IP addresses other than 127.0.0.1.
8224
8225 The list of IP addresses is in fact processed by the same code that processes
8226 host lists, so it may contain CIDR-coded network specifications and it may also
8227 contain negative items.
8228
8229 Because the list of IP addresses is a sublist within a domain list, you have to
8230 be careful about delimiters if there is more than one address. Like any other
8231 list, the default delimiter can be changed. Thus, you might have:
8232 .code
8233 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
8234           an.other.domain : ...
8235 .endd
8236 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
8237 involved, it is easiest to change the delimiter for the main list as well:
8238 .code
8239 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
8240           an.other.domain ? ...
8241 .endd
8242 .next
8243 .cindex "asterisk" "in domain list"
8244 .cindex "domain list" "asterisk in"
8245 .cindex "domain list" "matching &""ends with""&"
8246 If a pattern starts with an asterisk, the remaining characters of the pattern
8247 are compared with the terminating characters of the domain. The use of &"*"& in
8248 domain lists differs from its use in partial matching lookups. In a domain
8249 list, the character following the asterisk need not be a dot, whereas partial
8250 matching works only in terms of dot-separated components. For example, a domain
8251 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
8252 &'cipher.key.ex'&.
8253
8254 .next
8255 .cindex "regular expressions" "in domain list"
8256 .cindex "domain list" "matching regular expression"
8257 If a pattern starts with a circumflex character, it is treated as a regular
8258 expression, and matched against the domain using a regular expression matching
8259 function. The circumflex is treated as part of the regular expression.
8260 Email domains are case-independent, so this regular expression match is by
8261 default case-independent, but you can make it case-dependent by starting it
8262 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
8263 are given in chapter &<<CHAPregexp>>&.
8264
8265 &*Warning*&: Because domain lists are expanded before being processed, you
8266 must escape any backslash and dollar characters in the regular expression, or
8267 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
8268 it is not to be expanded (unless you really do want to build a regular
8269 expression by expansion, of course).
8270 .next
8271 .cindex "lookup" "in domain list"
8272 .cindex "domain list" "matching by lookup"
8273 If a pattern starts with the name of a single-key lookup type followed by a
8274 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
8275 must be a file name in a suitable format for the lookup type. For example, for
8276 &"cdb;"& it must be an absolute path:
8277 .code
8278 domains = cdb;/etc/mail/local_domains.cdb
8279 .endd
8280 The appropriate type of lookup is done on the file using the domain name as the
8281 key. In most cases, the data that is looked up is not used; Exim is interested
8282 only in whether or not the key is present in the file. However, when a lookup
8283 is used for the &%domains%& option on a router
8284 or a &%domains%& condition in an ACL statement, the data is preserved in the
8285 &$domain_data$& variable and can be referred to in other router options or
8286 other statements in the same ACL.
8287
8288 .next
8289 Any of the single-key lookup type names may be preceded by
8290 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
8291 .code
8292 domains = partial-dbm;/partial/domains
8293 .endd
8294 This causes partial matching logic to be invoked; a description of how this
8295 works is given in section &<<SECTpartiallookup>>&.
8296
8297 .next
8298 .cindex "asterisk" "in lookup type"
8299 Any of the single-key lookup types may be followed by an asterisk. This causes
8300 a default lookup for a key consisting of a single asterisk to be done if the
8301 original lookup fails. This is not a useful feature when using a domain list to
8302 select particular domains (because any domain would match), but it might have
8303 value if the result of the lookup is being used via the &$domain_data$&
8304 expansion variable.
8305 .next
8306 If the pattern starts with the name of a query-style lookup type followed by a
8307 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
8308 pattern must be an appropriate query for the lookup type, as described in
8309 chapter &<<CHAPfdlookup>>&. For example:
8310 .code
8311 hold_domains = mysql;select domain from holdlist \
8312   where domain = '${quote_mysql:$domain}';
8313 .endd
8314 In most cases, the data that is looked up is not used (so for an SQL query, for
8315 example, it doesn't matter what field you select). Exim is interested only in
8316 whether or not the query succeeds. However, when a lookup is used for the
8317 &%domains%& option on a router, the data is preserved in the &$domain_data$&
8318 variable and can be referred to in other options.
8319 .next
8320 .cindex "domain list" "matching literal domain name"
8321 If none of the above cases apply, a caseless textual comparison is made
8322 between the pattern and the domain.
8323 .endlist
8324
8325 Here is an example that uses several different kinds of pattern:
8326 .code
8327 domainlist funny_domains = \
8328   @ : \
8329   lib.unseen.edu : \
8330   *.foundation.fict.example : \
8331   \N^[1-2]\d{3}\.fict\.example$\N : \
8332   partial-dbm;/opt/data/penguin/book : \
8333   nis;domains.byname : \
8334   nisplus;[name=$domain,status=local],domains.org_dir
8335 .endd
8336 There are obvious processing trade-offs among the various matching modes. Using
8337 an asterisk is faster than a regular expression, and listing a few names
8338 explicitly probably is too. The use of a file or database lookup is expensive,
8339 but may be the only option if hundreds of names are required. Because the
8340 patterns are tested in order, it makes sense to put the most commonly matched
8341 patterns earlier.
8342
8343
8344
8345 .section "Host lists" "SECThostlist"
8346 .cindex "host list" "patterns in"
8347 .cindex "list" "host list"
8348 Host lists are used to control what remote hosts are allowed to do. For
8349 example, some hosts may be allowed to use the local host as a relay, and some
8350 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8351 two different ways, by name or by IP address. In a host list, some types of
8352 pattern are matched to a host name, and some are matched to an IP address.
8353 You need to be particularly careful with this when single-key lookups are
8354 involved, to ensure that the right value is being used as the key.
8355
8356
8357 .section "Special host list patterns" "SECID80"
8358 .cindex "empty item in hosts list"
8359 .cindex "host list" "empty string in"
8360 If a host list item is the empty string, it matches only when no remote host is
8361 involved. This is the case when a message is being received from a local
8362 process using SMTP on the standard input, that is, when a TCP/IP connection is
8363 not used.
8364
8365 .cindex "asterisk" "in host list"
8366 The special pattern &"*"& in a host list matches any host or no host. Neither
8367 the IP address nor the name is actually inspected.
8368
8369
8370
8371 .section "Host list patterns that match by IP address" "SECThoslispatip"
8372 .cindex "host list" "matching IP addresses"
8373 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8374 the incoming address actually appears in the IPv6 host as
8375 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8376 list, it is converted into a traditional IPv4 address first. (Not all operating
8377 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8378 concerns.)
8379
8380 The following types of pattern in a host list check the remote host by
8381 inspecting its IP address:
8382
8383 .ilist
8384 If the pattern is a plain domain name (not a regular expression, not starting
8385 with *, not a lookup of any kind), Exim calls the operating system function
8386 to find the associated IP address(es). Exim uses the newer
8387 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8388 This typically causes a forward DNS lookup of the name. The result is compared
8389 with the IP address of the subject host.
8390
8391 If there is a temporary problem (such as a DNS timeout) with the host name
8392 lookup, a temporary error occurs. For example, if the list is being used in an
8393 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8394 temporary SMTP error code. If no IP address can be found for the host name,
8395 what happens is described in section &<<SECTbehipnot>>& below.
8396
8397 .next
8398 .cindex "@ in a host list"
8399 If the pattern is &"@"&, the primary host name is substituted and used as a
8400 domain name, as just described.
8401
8402 .next
8403 If the pattern is an IP address, it is matched against the IP address of the
8404 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8405 IPv6 addresses can be given in colon-separated format, but the colons have to
8406 be doubled so as not to be taken as item separators when the default list
8407 separator is used. IPv6 addresses are recognized even when Exim is compiled
8408 without IPv6 support. This means that if they appear in a host list on an
8409 IPv4-only host, Exim will not treat them as host names. They are just addresses
8410 that can never match a client host.
8411
8412 .next
8413 .cindex "@[] in a host list"
8414 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8415 the local host. For example, if the local host is an IPv4 host with one
8416 interface address 10.45.23.56, these two ACL statements have the same effect:
8417 .code
8418 accept hosts = 127.0.0.1 : 10.45.23.56
8419 accept hosts = @[]
8420 .endd
8421 .next
8422 .cindex "CIDR notation"
8423 If the pattern is an IP address followed by a slash and a mask length (for
8424 example 10.11.42.0/24), it is matched against the IP address of the subject
8425 host under the given mask. This allows, an entire network of hosts to be
8426 included (or excluded) by a single item. The mask uses CIDR notation; it
8427 specifies the number of address bits that must match, starting from the most
8428 significant end of the address.
8429
8430 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8431 of a range of addresses. It is the number of bits in the network portion of the
8432 address. The above example specifies a 24-bit netmask, so it matches all 256
8433 addresses in the 10.11.42.0 network. An item such as
8434 .code
8435 192.168.23.236/31
8436 .endd
8437 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8438 32 for an IPv4 address is the same as no mask at all; just a single address
8439 matches.
8440
8441 Here is another example which shows an IPv4 and an IPv6 network:
8442 .code
8443 recipient_unqualified_hosts = 192.168.0.0/16: \
8444                               3ffe::ffff::836f::::/48
8445 .endd
8446 The doubling of list separator characters applies only when these items
8447 appear inline in a host list. It is not required when indirecting via a file.
8448 For example:
8449 .code
8450 recipient_unqualified_hosts = /opt/exim/unqualnets
8451 .endd
8452 could make use of a file containing
8453 .code
8454 172.16.0.0/12
8455 3ffe:ffff:836f::/48
8456 .endd
8457 to have exactly the same effect as the previous example. When listing IPv6
8458 addresses inline, it is usually more convenient to use the facility for
8459 changing separator characters. This list contains the same two networks:
8460 .code
8461 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8462                                  3ffe:ffff:836f::/48
8463 .endd
8464 The separator is changed to semicolon by the leading &"<;"& at the start of the
8465 list.
8466 .endlist
8467
8468
8469
8470 .section "Host list patterns for single-key lookups by host address" &&&
8471          "SECThoslispatsikey"
8472 .cindex "host list" "lookup of IP address"
8473 When a host is to be identified by a single-key lookup of its complete IP
8474 address, the pattern takes this form:
8475 .display
8476 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8477 .endd
8478 For example:
8479 .code
8480 hosts_lookup = net-cdb;/hosts-by-ip.db
8481 .endd
8482 The text form of the IP address of the subject host is used as the lookup key.
8483 IPv6 addresses are converted to an unabbreviated form, using lower case
8484 letters, with dots as separators because colon is the key terminator in
8485 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8486 quoting the keys, but this is a facility that was added later.] The data
8487 returned by the lookup is not used.
8488
8489 .cindex "IP address" "masking"
8490 .cindex "host list" "masked IP address"
8491 Single-key lookups can also be performed using masked IP addresses, using
8492 patterns of this form:
8493 .display
8494 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8495 .endd
8496 For example:
8497 .code
8498 net24-dbm;/networks.db
8499 .endd
8500 The IP address of the subject host is masked using <&'number'&> as the mask
8501 length. A textual string is constructed from the masked value, followed by the
8502 mask, and this is used as the lookup key. For example, if the host's IP address
8503 is 192.168.34.6, the key that is looked up for the above example is
8504 &"192.168.34.0/24"&.
8505
8506 When an IPv6 address is converted to a string, dots are normally used instead
8507 of colons, so that keys in &(lsearch)& files need not contain colons (which
8508 terminate &(lsearch)& keys). This was implemented some time before the ability
8509 to quote keys was made available in &(lsearch)& files. However, the more
8510 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8511 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8512 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8513 converted using colons and not dots. In all cases, full, unabbreviated IPv6
8514 addresses are always used.
8515
8516 Ideally, it would be nice to tidy up this anomalous situation by changing to
8517 colons in all cases, given that quoting is now available for &(lsearch)&.
8518 However, this would be an incompatible change that might break some existing
8519 configurations.
8520
8521 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8522 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8523 the former case the key strings include the mask value, whereas in the latter
8524 case the IP address is used on its own.
8525
8526
8527
8528 .section "Host list patterns that match by host name" "SECThoslispatnam"
8529 .cindex "host" "lookup failures"
8530 .cindex "unknown host name"
8531 .cindex "host list" "matching host name"
8532 There are several types of pattern that require Exim to know the name of the
8533 remote host. These are either wildcard patterns or lookups by name. (If a
8534 complete hostname is given without any wildcarding, it is used to find an IP
8535 address to match against, as described in section &<<SECThoslispatip>>&
8536 above.)
8537
8538 If the remote host name is not already known when Exim encounters one of these
8539 patterns, it has to be found from the IP address.
8540 Although many sites on the Internet are conscientious about maintaining reverse
8541 DNS data for their hosts, there are also many that do not do this.
8542 Consequently, a name cannot always be found, and this may lead to unwanted
8543 effects. Take care when configuring host lists with wildcarded name patterns.
8544 Consider what will happen if a name cannot be found.
8545
8546 Because of the problems of determining host names from IP addresses, matching
8547 against host names is not as common as matching against IP addresses.
8548
8549 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8550 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8551 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8552 are done can be changed by setting the &%host_lookup_order%& option. For
8553 security, once Exim has found one or more names, it looks up the IP addresses
8554 for these names and compares them with the IP address that it started with.
8555 Only those names whose IP addresses match are accepted. Any other names are
8556 discarded. If no names are left, Exim behaves as if the host name cannot be
8557 found. In the most common case there is only one name and one IP address.
8558
8559 There are some options that control what happens if a host name cannot be
8560 found. These are described in section &<<SECTbehipnot>>& below.
8561
8562 .cindex "host" "alias for"
8563 .cindex "alias for host"
8564 As a result of aliasing, hosts may have more than one name. When processing any
8565 of the following types of pattern, all the host's names are checked:
8566
8567 .ilist
8568 .cindex "asterisk" "in host list"
8569 If a pattern starts with &"*"& the remainder of the item must match the end of
8570 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8571 &'.b.c'&. This special simple form is provided because this is a very common
8572 requirement. Other kinds of wildcarding require the use of a regular
8573 expression.
8574 .next
8575 .cindex "regular expressions" "in host list"
8576 .cindex "host list" "regular expression in"
8577 If the item starts with &"^"& it is taken to be a regular expression which is
8578 matched against the host name. Host names are case-independent, so this regular
8579 expression match is by default case-independent, but you can make it
8580 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
8581 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
8582 example,
8583 .code
8584 ^(a|b)\.c\.d$
8585 .endd
8586 is a regular expression that matches either of the two hosts &'a.c.d'& or
8587 &'b.c.d'&. When a regular expression is used in a host list, you must take care
8588 that backslash and dollar characters are not misinterpreted as part of the
8589 string expansion. The simplest way to do this is to use &`\N`& to mark that
8590 part of the string as non-expandable. For example:
8591 .code
8592 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
8593 .endd
8594 &*Warning*&: If you want to match a complete host name, you must include the
8595 &`$`& terminating metacharacter in the regular expression, as in the above
8596 example. Without it, a match at the start of the host name is all that is
8597 required.
8598 .endlist
8599
8600
8601
8602
8603 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
8604 .cindex "host" "lookup failures, permanent"
8605 While processing a host list, Exim may need to look up an IP address from a
8606 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
8607 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
8608 behaviour when it fails to find the information it is seeking is the same.
8609
8610 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
8611 apply to temporary DNS errors, whose handling is described in the next section.
8612
8613 .cindex "&`+include_unknown`&"
8614 .cindex "&`+ignore_unknown`&"
8615 Exim parses a host list from left to right. If it encounters a permanent
8616 lookup failure in any item in the host list before it has found a match,
8617 Exim treats it as a failure and the default behavior is as if the host
8618 does not match the list. This may not always be what you want to happen.
8619 To change Exim's behaviour, the special items &`+include_unknown`& or
8620 &`+ignore_unknown`& may appear in the list (at top level &-- they are
8621 not recognized in an indirected file).
8622
8623 .ilist
8624 If any item that follows &`+include_unknown`& requires information that
8625 cannot found, Exim behaves as if the host does match the list. For example,
8626 .code
8627 host_reject_connection = +include_unknown:*.enemy.ex
8628 .endd
8629 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
8630 any hosts whose name it cannot find.
8631
8632 .next
8633 If any item that follows &`+ignore_unknown`& requires information that cannot
8634 be found, Exim ignores that item and proceeds to the rest of the list. For
8635 example:
8636 .code
8637 accept hosts = +ignore_unknown : friend.example : \
8638                192.168.4.5
8639 .endd
8640 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
8641 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
8642 name can be found for 192.168.4.5, it is rejected.
8643 .endlist
8644
8645 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
8646 list. The effect of each one lasts until the next, or until the end of the
8647 list.
8648
8649 .section "Mixing wildcarded host names and addresses in host lists" &&&
8650          "SECTmixwilhos"
8651 .cindex "host list" "mixing names and addresses in"
8652
8653 This section explains the host/ip processing logic with the same concepts
8654 as the previous section, but specifically addresses what happens when a
8655 wildcarded hostname is one of the items in the hostlist.
8656
8657 .ilist
8658 If you have name lookups or wildcarded host names and
8659 IP addresses in the same host list, you should normally put the IP
8660 addresses first. For example, in an ACL you could have:
8661 .code
8662 accept hosts = 10.9.8.7 : *.friend.example
8663 .endd
8664 The reason you normally would order it this way lies in the
8665 left-to-right way that Exim processes lists.  It can test IP addresses
8666 without doing any DNS lookups, but when it reaches an item that requires
8667 a host name, it fails if it cannot find a host name to compare with the
8668 pattern. If the above list is given in the opposite order, the
8669 &%accept%& statement fails for a host whose name cannot be found, even
8670 if its IP address is 10.9.8.7.
8671
8672 .next
8673 If you really do want to do the name check first, and still recognize the IP
8674 address, you can rewrite the ACL like this:
8675 .code
8676 accept hosts = *.friend.example
8677 accept hosts = 10.9.8.7
8678 .endd
8679 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
8680 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
8681 &`+ignore_unknown`&, which was discussed in depth in the first example in
8682 this section.
8683 .endlist
8684
8685
8686 .section "Temporary DNS errors when looking up host information" &&&
8687          "SECTtemdnserr"
8688 .cindex "host" "lookup failures, temporary"
8689 .cindex "&`+include_defer`&"
8690 .cindex "&`+ignore_defer`&"
8691 A temporary DNS lookup failure normally causes a defer action (except when
8692 &%dns_again_means_nonexist%& converts it into a permanent error). However,
8693 host lists can include &`+ignore_defer`& and &`+include_defer`&, analogous to
8694 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
8695 section. These options should be used with care, probably only in non-critical
8696 host lists such as whitelists.
8697
8698
8699
8700 .section "Host list patterns for single-key lookups by host name" &&&
8701          "SECThoslispatnamsk"
8702 .cindex "unknown host name"
8703 .cindex "host list" "matching host name"
8704 If a pattern is of the form
8705 .display
8706 <&'single-key-search-type'&>;<&'search-data'&>
8707 .endd
8708 for example
8709 .code
8710 dbm;/host/accept/list
8711 .endd
8712 a single-key lookup is performed, using the host name as its key. If the
8713 lookup succeeds, the host matches the item. The actual data that is looked up
8714 is not used.
8715
8716 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
8717 keys in the file, not IP addresses. If you want to do lookups based on IP
8718 addresses, you must precede the search type with &"net-"& (see section
8719 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
8720 two items in the same list, one doing an address lookup and one doing a name
8721 lookup, both using the same file.
8722
8723
8724
8725 .section "Host list patterns for query-style lookups" "SECID81"
8726 If a pattern is of the form
8727 .display
8728 <&'query-style-search-type'&>;<&'query'&>
8729 .endd
8730 the query is obeyed, and if it succeeds, the host matches the item. The actual
8731 data that is looked up is not used. The variables &$sender_host_address$& and
8732 &$sender_host_name$& can be used in the query. For example:
8733 .code
8734 hosts_lookup = pgsql;\
8735   select ip from hostlist where ip='$sender_host_address'
8736 .endd
8737 The value of &$sender_host_address$& for an IPv6 address contains colons. You
8738 can use the &%sg%& expansion item to change this if you need to. If you want to
8739 use masked IP addresses in database queries, you can use the &%mask%& expansion
8740 operator.
8741
8742 If the query contains a reference to &$sender_host_name$&, Exim automatically
8743 looks up the host name if it has not already done so. (See section
8744 &<<SECThoslispatnam>>& for comments on finding host names.)
8745
8746 Historical note: prior to release 4.30, Exim would always attempt to find a
8747 host name before running the query, unless the search type was preceded by
8748 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
8749 still recognized for query-style lookups, but its presence or absence has no
8750 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
8751 See section &<<SECThoslispatsikey>>&.)
8752
8753
8754
8755
8756
8757 .section "Address lists" "SECTaddresslist"
8758 .cindex "list" "address list"
8759 .cindex "address list" "empty item"
8760 .cindex "address list" "patterns"
8761 Address lists contain patterns that are matched against mail addresses. There
8762 is one special case to be considered: the sender address of a bounce message is
8763 always empty. You can test for this by providing an empty item in an address
8764 list. For example, you can set up a router to process bounce messages by
8765 using this option setting:
8766 .code
8767 senders = :
8768 .endd
8769 The presence of the colon creates an empty item. If you do not provide any
8770 data, the list is empty and matches nothing. The empty sender can also be
8771 detected by a regular expression that matches an empty string,
8772 and by a query-style lookup that succeeds when &$sender_address$& is empty.
8773
8774 Non-empty items in an address list can be straightforward email addresses. For
8775 example:
8776 .code
8777 senders = jbc@askone.example : hs@anacreon.example
8778 .endd
8779 A certain amount of wildcarding is permitted. If a pattern contains an @
8780 character, but is not a regular expression and does not begin with a
8781 semicolon-terminated lookup type (described below), the local part of the
8782 subject address is compared with the local part of the pattern, which may start
8783 with an asterisk. If the local parts match, the domain is checked in exactly
8784 the same way as for a pattern in a domain list. For example, the domain can be
8785 wildcarded, refer to a named list, or be a lookup:
8786 .code
8787 deny senders = *@*.spamming.site:\
8788                *@+hostile_domains:\
8789                bozo@partial-lsearch;/list/of/dodgy/sites:\
8790                *@dbm;/bad/domains.db
8791 .endd
8792 .cindex "local part" "starting with !"
8793 .cindex "address list" "local part starting with !"
8794 If a local part that begins with an exclamation mark is required, it has to be
8795 specified using a regular expression, because otherwise the exclamation mark is
8796 treated as a sign of negation, as is standard in lists.
8797
8798 If a non-empty pattern that is not a regular expression or a lookup does not
8799 contain an @ character, it is matched against the domain part of the subject
8800 address. The only two formats that are recognized this way are a literal
8801 domain, or a domain pattern that starts with *. In both these cases, the effect
8802 is the same as if &`*@`& preceded the pattern. For example:
8803 .code
8804 deny senders = enemy.domain : *.enemy.domain
8805 .endd
8806
8807 The following kinds of more complicated address list pattern can match any
8808 address, including the empty address that is characteristic of bounce message
8809 senders:
8810
8811 .ilist
8812 .cindex "regular expressions" "in address list"
8813 .cindex "address list" "regular expression in"
8814 If (after expansion) a pattern starts with &"^"&, a regular expression match is
8815 done against the complete address, with the pattern as the regular expression.
8816 You must take care that backslash and dollar characters are not misinterpreted
8817 as part of the string expansion. The simplest way to do this is to use &`\N`&
8818 to mark that part of the string as non-expandable. For example:
8819 .code
8820 deny senders = \N^.*this.*@example\.com$\N : \
8821                \N^\d{8}.+@spamhaus.example$\N : ...
8822 .endd
8823 The &`\N`& sequences are removed by the expansion, so these items do indeed
8824 start with &"^"& by the time they are being interpreted as address patterns.
8825
8826 .next
8827 .cindex "address list" "lookup for complete address"
8828 Complete addresses can be looked up by using a pattern that starts with a
8829 lookup type terminated by a semicolon, followed by the data for the lookup. For
8830 example:
8831 .code
8832 deny senders = cdb;/etc/blocked.senders : \
8833   mysql;select address from blocked where \
8834   address='${quote_mysql:$sender_address}'
8835 .endd
8836 Both query-style and single-key lookup types can be used. For a single-key
8837 lookup type, Exim uses the complete address as the key. However, empty keys are
8838 not supported for single-key lookups, so a match against the empty address
8839 always fails. This restriction does not apply to query-style lookups.
8840
8841 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
8842 cannot be used, and is ignored if specified, with an entry being written to the
8843 panic log.
8844 .cindex "*@ with single-key lookup"
8845 However, you can configure lookup defaults, as described in section
8846 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
8847 default. For example, with this lookup:
8848 .code
8849 accept senders = lsearch*@;/some/file
8850 .endd
8851 the file could contains lines like this:
8852 .code
8853 user1@domain1.example
8854 *@domain2.example
8855 .endd
8856 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
8857 that are tried is:
8858 .code
8859 nimrod@jaeger.example
8860 *@jaeger.example
8861 *
8862 .endd
8863 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
8864 would mean that every address matches, thus rendering the test useless.
8865
8866 &*Warning 2*&: Do not confuse these two kinds of item:
8867 .code
8868 deny recipients = dbm*@;/some/file
8869 deny recipients = *@dbm;/some/file
8870 .endd
8871 The first does a whole address lookup, with defaulting, as just described,
8872 because it starts with a lookup type. The second matches the local part and
8873 domain independently, as described in a bullet point below.
8874 .endlist
8875
8876
8877 The following kinds of address list pattern can match only non-empty addresses.
8878 If the subject address is empty, a match against any of these pattern types
8879 always fails.
8880
8881
8882 .ilist
8883 .cindex "@@ with single-key lookup"
8884 .cindex "address list" "@@ lookup type"
8885 .cindex "address list" "split local part and domain"
8886 If a pattern starts with &"@@"& followed by a single-key lookup item
8887 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
8888 split into a local part and a domain. The domain is looked up in the file. If
8889 it is not found, there is no match. If it is found, the data that is looked up
8890 from the file is treated as a colon-separated list of local part patterns, each
8891 of which is matched against the subject local part in turn.
8892
8893 .cindex "asterisk" "in address list"
8894 The lookup may be a partial one, and/or one involving a search for a default
8895 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
8896 patterns that are looked up can be regular expressions or begin with &"*"&, or
8897 even be further lookups. They may also be independently negated. For example,
8898 with
8899 .code
8900 deny senders = @@dbm;/etc/reject-by-domain
8901 .endd
8902 the data from which the DBM file is built could contain lines like
8903 .code
8904 baddomain.com:  !postmaster : *
8905 .endd
8906 to reject all senders except &%postmaster%& from that domain.
8907
8908 .cindex "local part" "starting with !"
8909 If a local part that actually begins with an exclamation mark is required, it
8910 has to be specified using a regular expression. In &(lsearch)& files, an entry
8911 may be split over several lines by indenting the second and subsequent lines,
8912 but the separating colon must still be included at line breaks. White space
8913 surrounding the colons is ignored. For example:
8914 .code
8915 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
8916   spammer3 : spammer4
8917 .endd
8918 As in all colon-separated lists in Exim, a colon can be included in an item by
8919 doubling.
8920
8921 If the last item in the list starts with a right angle-bracket, the remainder
8922 of the item is taken as a new key to look up in order to obtain a continuation
8923 list of local parts. The new key can be any sequence of characters. Thus one
8924 might have entries like
8925 .code
8926 aol.com: spammer1 : spammer 2 : >*
8927 xyz.com: spammer3 : >*
8928 *:       ^\d{8}$
8929 .endd
8930 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
8931 local parts for all domains, in addition to the specific local parts listed for
8932 each domain. Of course, using this feature costs another lookup each time a
8933 chain is followed, but the effort needed to maintain the data is reduced.
8934
8935 .cindex "loop" "in lookups"
8936 It is possible to construct loops using this facility, and in order to catch
8937 them, the chains may be no more than fifty items long.
8938
8939 .next
8940 The @@<&'lookup'&> style of item can also be used with a query-style
8941 lookup, but in this case, the chaining facility is not available. The lookup
8942 can only return a single list of local parts.
8943 .endlist
8944
8945 &*Warning*&: There is an important difference between the address list items
8946 in these two examples:
8947 .code
8948 senders = +my_list
8949 senders = *@+my_list
8950 .endd
8951 In the first one, &`my_list`& is a named address list, whereas in the second
8952 example it is a named domain list.
8953
8954
8955
8956
8957 .section "Case of letters in address lists" "SECTcasletadd"
8958 .cindex "case of local parts"
8959 .cindex "address list" "case forcing"
8960 .cindex "case forcing in address lists"
8961 Domains in email addresses are always handled caselessly, but for local parts
8962 case may be significant on some systems (see &%caseful_local_part%& for how
8963 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
8964 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
8965 blocking lists should be done in a case-independent manner. Since most address
8966 lists in Exim are used for this kind of control, Exim attempts to do this by
8967 default.
8968
8969 The domain portion of an address is always lowercased before matching it to an
8970 address list. The local part is lowercased by default, and any string
8971 comparisons that take place are done caselessly. This means that the data in
8972 the address list itself, in files included as plain file names, and in any file
8973 that is looked up using the &"@@"& mechanism, can be in any case. However, the
8974 keys in files that are looked up by a search type other than &(lsearch)& (which
8975 works caselessly) must be in lower case, because these lookups are not
8976 case-independent.
8977
8978 .cindex "&`+caseful`&"
8979 To allow for the possibility of caseful address list matching, if an item in
8980 an address list is the string &"+caseful"&, the original case of the local
8981 part is restored for any comparisons that follow, and string comparisons are no
8982 longer case-independent. This does not affect the domain, which remains in
8983 lower case. However, although independent matches on the domain alone are still
8984 performed caselessly, regular expressions that match against an entire address
8985 become case-sensitive after &"+caseful"& has been seen.
8986
8987
8988
8989 .section "Local part lists" "SECTlocparlis"
8990 .cindex "list" "local part list"
8991 .cindex "local part" "list"
8992 Case-sensitivity in local part lists is handled in the same way as for address
8993 lists, as just described. The &"+caseful"& item can be used if required. In a
8994 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
8995 set false, the subject is lowercased and the matching is initially
8996 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
8997 matching in the local part list, but not elsewhere in the router. If
8998 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
8999 option is case-sensitive from the start.
9000
9001 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
9002 comments are handled in the same way as address lists &-- they are recognized
9003 only if the # is preceded by white space or the start of the line.
9004 Otherwise, local part lists are matched in the same way as domain lists, except
9005 that the special items that refer to the local host (&`@`&, &`@[]`&,
9006 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
9007 Refer to section &<<SECTdomainlist>>& for details of the other available item
9008 types.
9009 .ecindex IIDdohoadli
9010
9011
9012
9013
9014 . ////////////////////////////////////////////////////////////////////////////
9015 . ////////////////////////////////////////////////////////////////////////////
9016
9017 .chapter "String expansions" "CHAPexpand"
9018 .scindex IIDstrexp "expansion" "of strings"
9019 Many strings in Exim's run time configuration are expanded before use. Some of
9020 them are expanded every time they are used; others are expanded only once.
9021
9022 When a string is being expanded it is copied verbatim from left to right except
9023 when a dollar or backslash character is encountered. A dollar specifies the
9024 start of a portion of the string that is interpreted and replaced as described
9025 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
9026 escape character, as described in the following section.
9027
9028 Whether a string is expanded depends upon the context.  Usually this is solely
9029 dependent upon the option for which a value is sought; in this documentation,
9030 options for which string expansion is performed are marked with &dagger; after
9031 the data type.  ACL rules always expand strings.  A couple of expansion
9032 conditions do not expand some of the brace-delimited branches, for security
9033 reasons.
9034
9035
9036
9037 .section "Literal text in expanded strings" "SECTlittext"
9038 .cindex "expansion" "including literal text"
9039 An uninterpreted dollar can be included in an expanded string by putting a
9040 backslash in front of it. A backslash can be used to prevent any special
9041 character being treated specially in an expansion, including backslash itself.
9042 If the string appears in quotes in the configuration file, two backslashes are
9043 required because the quotes themselves cause interpretation of backslashes when
9044 the string is read in (see section &<<SECTstrings>>&).
9045
9046 .cindex "expansion" "non-expandable substrings"
9047 A portion of the string can specified as non-expandable by placing it between
9048 two occurrences of &`\N`&. This is particularly useful for protecting regular
9049 expressions, which often contain backslashes and dollar signs. For example:
9050 .code
9051 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
9052 .endd
9053 On encountering the first &`\N`&, the expander copies subsequent characters
9054 without interpretation until it reaches the next &`\N`& or the end of the
9055 string.
9056
9057
9058
9059 .section "Character escape sequences in expanded strings" "SECID82"
9060 .cindex "expansion" "escape sequences"
9061 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
9062 expanded string is recognized as an escape sequence for the character newline,
9063 carriage return, or tab, respectively. A backslash followed by up to three
9064 octal digits is recognized as an octal encoding for a single character, and a
9065 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
9066 encoding.
9067
9068 These escape sequences are also recognized in quoted strings when they are read
9069 in. Their interpretation in expansions as well is useful for unquoted strings,
9070 and for other cases such as looked-up strings that are then expanded.
9071
9072
9073 .section "Testing string expansions" "SECID83"
9074 .cindex "expansion" "testing"
9075 .cindex "testing" "string expansion"
9076 .oindex "&%-be%&"
9077 Many expansions can be tested by calling Exim with the &%-be%& option. This
9078 takes the command arguments, or lines from the standard input if there are no
9079 arguments, runs them through the string expansion code, and writes the results
9080 to the standard output. Variables based on configuration values are set up, but
9081 since no message is being processed, variables such as &$local_part$& have no
9082 value. Nevertheless the &%-be%& option can be useful for checking out file and
9083 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
9084 and &%nhash%&.
9085
9086 Exim gives up its root privilege when it is called with the &%-be%& option, and
9087 instead runs under the uid and gid it was called with, to prevent users from
9088 using &%-be%& for reading files to which they do not have access.
9089
9090 .oindex "&%-bem%&"
9091 If you want to test expansions that include variables whose values are taken
9092 from a message, there are two other options that can be used. The &%-bem%&
9093 option is like &%-be%& except that it is followed by a file name. The file is
9094 read as a message before doing the test expansions. For example:
9095 .code
9096 exim -bem /tmp/test.message '$h_subject:'
9097 .endd
9098 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
9099 Exim message identifier. For example:
9100 .code
9101 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
9102 .endd
9103 This loads the message from Exim's spool before doing the test expansions, and
9104 is therefore restricted to admin users.
9105
9106
9107 .section "Forced expansion failure" "SECTforexpfai"
9108 .cindex "expansion" "forced failure"
9109 A number of expansions that are described in the following section have
9110 alternative &"true"& and &"false"& substrings, enclosed in brace characters
9111 (which are sometimes called &"curly brackets"&). Which of the two strings is
9112 used depends on some condition that is evaluated as part of the expansion. If,
9113 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
9114 the entire string expansion fails in a way that can be detected by the code
9115 that requested the expansion. This is called &"forced expansion failure"&, and
9116 its consequences depend on the circumstances. In some cases it is no different
9117 from any other expansion failure, but in others a different action may be
9118 taken. Such variations are mentioned in the documentation of the option that is
9119 being expanded.
9120
9121
9122
9123
9124 .section "Expansion items" "SECTexpansionitems"
9125 The following items are recognized in expanded strings. White space may be used
9126 between sub-items that are keywords or substrings enclosed in braces inside an
9127 outer set of braces, to improve readability. &*Warning*&: Within braces,
9128 white space is significant.
9129
9130 .vlist
9131 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
9132 .cindex "expansion" "variables"
9133 Substitute the contents of the named variable, for example:
9134 .code
9135 $local_part
9136 ${domain}
9137 .endd
9138 The second form can be used to separate the name from subsequent alphanumeric
9139 characters. This form (using braces) is available only for variables; it does
9140 &'not'& apply to message headers. The names of the variables are given in
9141 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
9142 given, the expansion fails.
9143
9144 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
9145 .cindex "expansion" "operators"
9146 The string is first itself expanded, and then the operation specified by
9147 <&'op'&> is applied to it. For example:
9148 .code
9149 ${lc:$local_part}
9150 .endd
9151 The string starts with the first character after the colon, which may be
9152 leading white space. A list of operators is given in section &<<SECTexpop>>&
9153 below. The operator notation is used for simple expansion items that have just
9154 one argument, because it reduces the number of braces and therefore makes the
9155 string easier to understand.
9156
9157 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
9158 This item inserts &"basic"& header lines. It is described with the &%header%&
9159 expansion item below.
9160
9161
9162 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
9163 .cindex "expansion" "calling an acl"
9164 .cindex "&%acl%&" "call from expansion"
9165 The name and zero to nine argument strings are first expanded separately.  The expanded
9166 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
9167 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
9168 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
9169 and may use the variables; if another acl expansion is used the values
9170 are restored after it returns.  If the ACL sets
9171 a value using a "message =" modifier and returns accept or deny, the value becomes
9172 the result of the expansion.
9173 If no message is set and the ACL returns accept or deny
9174 the expansion result is an empty string.
9175 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
9176
9177
9178 .new
9179 .vitem "&*${authresults{*&<&'authserv-id'&>&*}}*&"
9180 .cindex authentication "results header"
9181 .cindex headers "authentication-results:"
9182 .cindex authentication "expansion item"
9183 This item returns a string suitable for insertion as an
9184 &'Authentication-Results"'&
9185 header line.
9186 The given <&'authserv-id'&> is included in the result; typically this
9187 will ba a domain name identifying the system performing the authentications.
9188 Methods that may be present in the result include:
9189 .code
9190 none
9191 iprev
9192 auth
9193 spf
9194 dkim
9195 .endd
9196
9197 Example use (as an ACL modifier):
9198 .code
9199       add_header = :at_start:${authresults {$primary_hostname}}
9200 .endd
9201 This is safe even if no authentication reselts are available.
9202 .wen
9203
9204
9205 .vitem "&*${certextract{*&<&'field'&>&*}{*&<&'certificate'&>&*}&&&
9206        {*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9207 .cindex "expansion" "extracting certificate fields"
9208 .cindex "&%certextract%&" "certificate fields"
9209 .cindex "certificate" "extracting fields"
9210 The <&'certificate'&> must be a variable of type certificate.
9211 The field name is expanded and used to retrieve the relevant field from
9212 the certificate.  Supported fields are:
9213 .display
9214 &`version        `&
9215 &`serial_number  `&
9216 &`subject        `& RFC4514 DN
9217 &`issuer         `& RFC4514 DN
9218 &`notbefore      `& time
9219 &`notafter       `& time
9220 &`sig_algorithm  `&
9221 &`signature      `&
9222 &`subj_altname   `& tagged list
9223 &`ocsp_uri       `& list
9224 &`crl_uri        `& list
9225 .endd
9226 If the field is found,
9227 <&'string2'&> is expanded, and replaces the whole item;
9228 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9229 variable &$value$& contains the value that has been extracted. Afterwards, it
9230 is restored to any previous value it might have had.
9231
9232 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9233 key is not found. If {<&'string2'&>} is also omitted, the value that was
9234 extracted is used.
9235
9236 Some field names take optional modifiers, appended and separated by commas.
9237
9238 The field selectors marked as "RFC4514" above
9239 output a Distinguished Name string which is
9240 not quite
9241 parseable by Exim as a comma-separated tagged list
9242 (the exceptions being elements containing commas).
9243 RDN elements of a single type may be selected by
9244 a modifier of the type label; if so the expansion
9245 result is a list (newline-separated by default).
9246 The separator may be changed by another modifier of
9247 a right angle-bracket followed immediately by the new separator.
9248 Recognised RDN type labels include "CN", "O", "OU" and "DC".
9249
9250 The field selectors marked as "time" above
9251 take an optional modifier of "int"
9252 for which the result is the number of seconds since epoch.
9253 Otherwise the result is a human-readable string
9254 in the timezone selected by the main "timezone" option.
9255
9256 The field selectors marked as "list" above return a list,
9257 newline-separated by default,
9258 (embedded separator characters in elements are doubled).
9259 The separator may be changed by a modifier of
9260 a right angle-bracket followed immediately by the new separator.
9261
9262 The field selectors marked as "tagged" above
9263 prefix each list element with a type string and an equals sign.
9264 Elements of only one type may be selected by a modifier
9265 which is one of "dns", "uri" or "mail";
9266 if so the element tags are omitted.
9267
9268 If not otherwise noted field values are presented in human-readable form.
9269
9270 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
9271        {*&<&'arg'&>&*}...}*&"
9272 .cindex &%dlfunc%&
9273 This expansion dynamically loads and then calls a locally-written C function.
9274 This functionality is available only if Exim is compiled with
9275 .code
9276 EXPAND_DLFUNC=yes
9277 .endd
9278 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
9279 object so that it doesn't reload the same object file in the same Exim process
9280 (but of course Exim does start new processes frequently).
9281
9282 There may be from zero to eight arguments to the function. When compiling
9283 a local function that is to be called in this way, &_local_scan.h_& should be
9284 included. The Exim variables and functions that are defined by that API
9285 are also available for dynamically loaded functions. The function itself
9286 must have the following type:
9287 .code
9288 int dlfunction(uschar **yield, int argc, uschar *argv[])
9289 .endd
9290 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
9291 function should return one of the following values:
9292
9293 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
9294 into the expanded string that is being built.
9295
9296 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
9297 from &'yield'&, if it is set.
9298
9299 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
9300 taken from &'yield'& if it is set.
9301
9302 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
9303
9304 When compiling a function that is to be used in this way with gcc,
9305 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
9306 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
9307
9308
9309 .vitem "&*${env{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&"
9310 .cindex "expansion" "extracting value from environment"
9311 .cindex "environment" "values from"
9312 The key is first expanded separately, and leading and trailing white space
9313 removed.
9314 This is then searched for as a name in the environment.
9315 If a variable is found then its value is placed in &$value$&
9316 and <&'string1'&> is expanded, otherwise <&'string2'&> is expanded.
9317
9318 Instead of {<&'string2'&>} the word &"fail"& (not in curly brackets) can
9319 appear, for example:
9320 .code
9321 ${env{USER}{$value} fail }
9322 .endd
9323 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9324 {<&'string1'&>} must be present for &"fail"& to be recognized.
9325
9326 If {<&'string2'&>} is omitted an empty string is substituted on
9327 search failure.
9328 If {<&'string1'&>} is omitted the search result is substituted on
9329 search success.
9330
9331 The environment is adjusted by the &%keep_environment%& and
9332 &%add_environment%& main section options.
9333
9334
9335 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9336        {*&<&'string3'&>&*}}*&"
9337 .cindex "expansion" "extracting substrings by key"
9338 .cindex "&%extract%&" "substrings by key"
9339 The key and <&'string1'&> are first expanded separately. Leading and trailing
9340 white space is removed from the key (but not from any of the strings). The key
9341 must not be empty and must not consist entirely of digits.
9342 The expanded <&'string1'&> must be of the form:
9343 .display
9344 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
9345 .endd
9346 .vindex "&$value$&"
9347 where the equals signs and spaces (but not both) are optional. If any of the
9348 values contain white space, they must be enclosed in double quotes, and any
9349 values that are enclosed in double quotes are subject to escape processing as
9350 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
9351 for the value that corresponds to the key. The search is case-insensitive. If
9352 the key is found, <&'string2'&> is expanded, and replaces the whole item;
9353 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9354 variable &$value$& contains the value that has been extracted. Afterwards, it
9355 is restored to any previous value it might have had.
9356
9357 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9358 key is not found. If {<&'string2'&>} is also omitted, the value that was
9359 extracted is used. Thus, for example, these two expansions are identical, and
9360 yield &"2001"&:
9361 .code
9362 ${extract{gid}{uid=1984 gid=2001}}
9363 ${extract{gid}{uid=1984 gid=2001}{$value}}
9364 .endd
9365 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
9366 appear, for example:
9367 .code
9368 ${extract{Z}{A=... B=...}{$value} fail }
9369 .endd
9370 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9371 {<&'string2'&>} must be present for &"fail"& to be recognized.
9372
9373
9374 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
9375         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9376 .cindex "expansion" "extracting substrings by number"
9377 .cindex "&%extract%&" "substrings by number"
9378 The <&'number'&> argument must consist entirely of decimal digits,
9379 apart from leading and trailing white space, which is ignored.
9380 This is what distinguishes this form of &%extract%& from the previous kind. It
9381 behaves in the same way, except that, instead of extracting a named field, it
9382 extracts from <&'string1'&> the field whose number is given as the first
9383 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
9384 <&'string3'&> as before.
9385
9386 The fields in the string are separated by any one of the characters in the
9387 separator string. These may include space or tab characters.
9388 The first field is numbered one. If the number is negative, the fields are
9389 counted from the end of the string, with the rightmost one numbered -1. If the
9390 number given is zero, the entire string is returned. If the modulus of the
9391 number is greater than the number of fields in the string, the result is the
9392 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
9393 provided. For example:
9394 .code
9395 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
9396 .endd
9397 yields &"42"&, and
9398 .code
9399 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
9400 .endd
9401 yields &"99"&. Two successive separators mean that the field between them is
9402 empty (for example, the fifth field above).
9403
9404
9405 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
9406 .cindex "list" "selecting by condition"
9407 .cindex "expansion" "selecting from list by condition"
9408 .vindex "&$item$&"
9409 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9410 default, but the separator can be changed in the usual way. For each item
9411 in this list, its value is place in &$item$&, and then the condition is
9412 evaluated. If the condition is true, &$item$& is added to the output as an
9413 item in a new list; if the condition is false, the item is discarded. The
9414 separator used for the output list is the same as the one used for the
9415 input, but a separator setting is not included in the output. For example:
9416 .code
9417 ${filter{a:b:c}{!eq{$item}{b}}}
9418 .endd
9419 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
9420 to what it was before. See also the &*map*& and &*reduce*& expansion items.
9421
9422
9423 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9424 .cindex "hash function" "textual"
9425 .cindex "expansion" "textual hash"
9426 This is a textual hashing function, and was the first to be implemented in
9427 early versions of Exim. In current releases, there are other hashing functions
9428 (numeric, MD5, and SHA-1), which are described below.
9429
9430 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
9431 <&'n'&>. If you are using fixed values for these numbers, that is, if
9432 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
9433 use the simpler operator notation that avoids some of the braces:
9434 .code
9435 ${hash_<n>_<m>:<string>}
9436 .endd
9437 The second number is optional (in both notations). If <&'n'&> is greater than
9438 or equal to the length of the string, the expansion item returns the string.
9439 Otherwise it computes a new string of length <&'n'&> by applying a hashing
9440 function to the string. The new string consists of characters taken from the
9441 first <&'m'&> characters of the string
9442 .code
9443 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
9444 .endd
9445 If <&'m'&> is not present the value 26 is used, so that only lower case
9446 letters appear. For example:
9447 .display
9448 &`$hash{3}{monty}}           `&   yields  &`jmg`&
9449 &`$hash{5}{monty}}           `&   yields  &`monty`&
9450 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
9451 .endd
9452
9453 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
9454         &*$h_*&<&'header&~name'&>&*:*&" &&&
9455        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9456         &*$bh_*&<&'header&~name'&>&*:*&" &&&
9457        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9458         &*$rh_*&<&'header&~name'&>&*:*&"
9459 .cindex "expansion" "header insertion"
9460 .vindex "&$header_$&"
9461 .vindex "&$bheader_$&"
9462 .vindex "&$rheader_$&"
9463 .cindex "header lines" "in expansion strings"
9464 .cindex "header lines" "character sets"
9465 .cindex "header lines" "decoding"
9466 Substitute the contents of the named message header line, for example
9467 .code
9468 $header_reply-to:
9469 .endd
9470 The newline that terminates a header line is not included in the expansion, but
9471 internal newlines (caused by splitting the header line over several physical
9472 lines) may be present.
9473
9474 The difference between &%rheader%&, &%bheader%&, and &%header%& is in the way
9475 the data in the header line is interpreted.
9476
9477 .ilist
9478 .cindex "white space" "in header lines"
9479 &%rheader%& gives the original &"raw"& content of the header line, with no
9480 processing at all, and without the removal of leading and trailing white space.
9481
9482 .next
9483 .cindex "base64 encoding" "in header lines"
9484 &%bheader%& removes leading and trailing white space, and then decodes base64
9485 or quoted-printable MIME &"words"& within the header text, but does no
9486 character set translation. If decoding of what looks superficially like a MIME
9487 &"word"& fails, the raw string is returned. If decoding
9488 .cindex "binary zero" "in header line"
9489 produces a binary zero character, it is replaced by a question mark &-- this is
9490 what Exim does for binary zeros that are actually received in header lines.
9491
9492 .next
9493 &%header%& tries to translate the string as decoded by &%bheader%& to a
9494 standard character set. This is an attempt to produce the same string as would
9495 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
9496 returned. Translation is attempted only on operating systems that support the
9497 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
9498 a system Makefile or in &_Local/Makefile_&.
9499 .endlist ilist
9500
9501 In a filter file, the target character set for &%header%& can be specified by a
9502 command of the following form:
9503 .code
9504 headers charset "UTF-8"
9505 .endd
9506 This command affects all references to &$h_$& (or &$header_$&) expansions in
9507 subsequently obeyed filter commands. In the absence of this command, the target
9508 character set in a filter is taken from the setting of the &%headers_charset%&
9509 option in the runtime configuration. The value of this option defaults to the
9510 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
9511 ISO-8859-1.
9512
9513 Header names follow the syntax of RFC 2822, which states that they may contain
9514 any printing characters except space and colon. Consequently, curly brackets
9515 &'do not'& terminate header names, and should not be used to enclose them as
9516 if they were variables. Attempting to do so causes a syntax error.
9517
9518 Only header lines that are common to all copies of a message are visible to
9519 this mechanism. These are the original header lines that are received with the
9520 message, and any that are added by an ACL statement or by a system
9521 filter. Header lines that are added to a particular copy of a message by a
9522 router or transport are not accessible.
9523
9524 For incoming SMTP messages, no header lines are visible in
9525 ACLs that are obeyed before the data phase completes,
9526 because the header structure is not set up until the message is received.
9527 They are visible in DKIM, PRDR and DATA ACLs.
9528 Header lines that are added in a RCPT ACL (for example)
9529 are saved until the message's incoming header lines are available, at which
9530 point they are added.
9531 When any of the above ACLs ar
9532 running, however, header lines added by earlier ACLs are visible.
9533
9534 Upper case and lower case letters are synonymous in header names. If the
9535 following character is white space, the terminating colon may be omitted, but
9536 this is not recommended, because you may then forget it when it is needed. When
9537 white space terminates the header name, this white space is included in the
9538 expanded string.  If the message does not contain the given header, the
9539 expansion item is replaced by an empty string. (See the &%def%& condition in
9540 section &<<SECTexpcond>>& for a means of testing for the existence of a
9541 header.)
9542
9543 If there is more than one header with the same name, they are all concatenated
9544 to form the substitution string, up to a maximum length of 64K. Unless
9545 &%rheader%& is being used, leading and trailing white space is removed from
9546 each header before concatenation, and a completely empty header is ignored. A
9547 newline character is then inserted between non-empty headers, but there is no
9548 newline at the very end. For the &%header%& and &%bheader%& expansion, for
9549 those headers that contain lists of addresses, a comma is also inserted at the
9550 junctions between headers. This does not happen for the &%rheader%& expansion.
9551
9552
9553 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
9554 .cindex "expansion" "hmac hashing"
9555 .cindex &%hmac%&
9556 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
9557 shared secret and some text into a message authentication code, as specified in
9558 RFC 2104. This differs from &`${md5:secret_text...}`& or
9559 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
9560 cryptographic hash, allowing for authentication that is not possible with MD5
9561 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
9562 present. For example:
9563 .code
9564 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
9565 .endd
9566 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
9567 produces:
9568 .code
9569 dd97e3ba5d1a61b5006108f8c8252953
9570 .endd
9571 As an example of how this might be used, you might put in the main part of
9572 an Exim configuration:
9573 .code
9574 SPAMSCAN_SECRET=cohgheeLei2thahw
9575 .endd
9576 In a router or a transport you could then have:
9577 .code
9578 headers_add = \
9579   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
9580   ${hmac{md5}{SPAMSCAN_SECRET}\
9581   {${primary_hostname},${message_exim_id},$h_message-id:}}
9582 .endd
9583 Then given a message, you can check where it was scanned by looking at the
9584 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
9585 this header line is authentic by recomputing the authentication code from the
9586 host name, message ID and the &'Message-id:'& header line. This can be done
9587 using Exim's &%-be%& option, or by other means, for example by using the
9588 &'hmac_md5_hex()'& function in Perl.
9589
9590
9591 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9592 .cindex "expansion" "conditional"
9593 .cindex "&%if%&, expansion item"
9594 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
9595 item; otherwise <&'string2'&> is used. The available conditions are described
9596 in section &<<SECTexpcond>>& below. For example:
9597 .code
9598 ${if eq {$local_part}{postmaster} {yes}{no} }
9599 .endd
9600 The second string need not be present; if it is not and the condition is not
9601 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
9602 be present instead of the second string (without any curly brackets). In this
9603 case, the expansion is forced to fail if the condition is not true (see section
9604 &<<SECTforexpfai>>&).
9605
9606 If both strings are omitted, the result is the string &`true`& if the condition
9607 is true, and the empty string if the condition is false. This makes it less
9608 cumbersome to write custom ACL and router conditions. For example, instead of
9609 .code
9610 condition = ${if >{$acl_m4}{3}{true}{false}}
9611 .endd
9612 you can use
9613 .code
9614 condition = ${if >{$acl_m4}{3}}
9615 .endd
9616
9617
9618
9619 .vitem &*${imapfolder{*&<&'foldername'&>&*}}*&
9620 .cindex expansion "imap folder"
9621 .cindex "&%imapfolder%& expansion item"
9622 This item converts a (possibly multilevel, or with non-ASCII characters)
9623 folder specification to a Maildir name for filesystem use.
9624 For information on internationalisation support see &<<SECTi18nMDA>>&.
9625
9626
9627
9628 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9629 .cindex "expansion" "string truncation"
9630 .cindex "&%length%& expansion item"
9631 The &%length%& item is used to extract the initial portion of a string. Both
9632 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
9633 you are using a fixed value for the number, that is, if <&'string1'&> does not
9634 change when expanded, you can use the simpler operator notation that avoids
9635 some of the braces:
9636 .code
9637 ${length_<n>:<string>}
9638 .endd
9639 The result of this item is either the first <&'n'&> characters or the whole
9640 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
9641 &%strlen%&, which gives the length of a string.
9642
9643
9644 .vitem "&*${listextract{*&<&'number'&>&*}&&&
9645         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9646 .cindex "expansion" "extracting list elements by number"
9647 .cindex "&%listextract%&" "extract list elements by number"
9648 .cindex "list" "extracting elements by number"
9649 The <&'number'&> argument must consist entirely of decimal digits,
9650 apart from an optional leading minus,
9651 and leading and trailing white space (which is ignored).
9652
9653 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9654 default, but the separator can be changed in the usual way.
9655
9656 The first field of the list is numbered one.
9657 If the number is negative, the fields are
9658 counted from the end of the list, with the rightmost one numbered -1.
9659 The numbered element of the list is extracted and placed in &$value$&,
9660 then <&'string2'&> is expanded as the result.
9661
9662 If the modulus of the
9663 number is zero or greater than the number of fields in the string,
9664 the result is the expansion of <&'string3'&>.
9665
9666 For example:
9667 .code
9668 ${listextract{2}{x:42:99}}
9669 .endd
9670 yields &"42"&, and
9671 .code
9672 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
9673 .endd
9674 yields &"result: 42"&.
9675
9676 If {<&'string3'&>} is omitted, an empty string is used for string3.
9677 If {<&'string2'&>} is also omitted, the value that was
9678 extracted is used.
9679 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
9680
9681
9682 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
9683         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9684 This is the first of one of two different types of lookup item, which are both
9685 described in the next item.
9686
9687 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
9688         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9689 .cindex "expansion" "lookup in"
9690 .cindex "file" "lookups"
9691 .cindex "lookup" "in expanded string"
9692 The two forms of lookup item specify data lookups in files and databases, as
9693 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
9694 lookups, and the second is used for query-style lookups. The <&'key'&>,
9695 <&'file'&>, and <&'query'&> strings are expanded before use.
9696
9697 If there is any white space in a lookup item which is part of a filter command,
9698 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
9699 other place where white space is significant, the lookup item must be enclosed
9700 in double quotes. The use of data lookups in users' filter files may be locked
9701 out by the system administrator.
9702
9703 .vindex "&$value$&"
9704 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
9705 During its expansion, the variable &$value$& contains the data returned by the
9706 lookup. Afterwards it reverts to the value it had previously (at the outer
9707 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
9708 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
9709 string on failure. If <&'string2'&> is provided, it can itself be a nested
9710 lookup, thus providing a mechanism for looking up a default value when the
9711 original lookup fails.
9712
9713 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
9714 data for the outer lookup while the parameters of the second lookup are
9715 expanded, and also while <&'string2'&> of the second lookup is expanded, should
9716 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
9717 appear, and in this case, if the lookup fails, the entire expansion is forced
9718 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
9719 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
9720 successful lookup, and nothing in the case of failure.
9721
9722 For single-key lookups, the string &"partial"& is permitted to precede the
9723 search type in order to do partial matching, and * or *@ may follow a search
9724 type to request default lookups if the key does not match (see sections
9725 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
9726
9727 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
9728 If a partial search is used, the variables &$1$& and &$2$& contain the wild
9729 and non-wild parts of the key during the expansion of the replacement text.
9730 They return to their previous values at the end of the lookup item.
9731
9732 This example looks up the postmaster alias in the conventional alias file:
9733 .code
9734 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
9735 .endd
9736 This example uses NIS+ to look up the full name of the user corresponding to
9737 the local part of an address, forcing the expansion to fail if it is not found:
9738 .code
9739 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
9740   {$value}fail}
9741 .endd
9742
9743
9744 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9745 .cindex "expansion" "list creation"
9746 .vindex "&$item$&"
9747 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9748 default, but the separator can be changed in the usual way. For each item
9749 in this list, its value is place in &$item$&, and then <&'string2'&> is
9750 expanded and added to the output as an item in a new list. The separator used
9751 for the output list is the same as the one used for the input, but a separator
9752 setting is not included in the output. For example:
9753 .code
9754 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
9755 .endd
9756 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
9757 value of &$item$& is restored to what it was before. See also the &*filter*&
9758 and &*reduce*& expansion items.
9759
9760 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9761 .cindex "expansion" "numeric hash"
9762 .cindex "hash function" "numeric"
9763 The three strings are expanded; the first two must yield numbers. Call them
9764 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9765 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9766 can use the simpler operator notation that avoids some of the braces:
9767 .code
9768 ${nhash_<n>_<m>:<string>}
9769 .endd
9770 The second number is optional (in both notations). If there is only one number,
9771 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
9772 processed by a div/mod hash function that returns two numbers, separated by a
9773 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
9774 example,
9775 .code
9776 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
9777 .endd
9778 returns the string &"6/33"&.
9779
9780
9781
9782 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
9783 .cindex "Perl" "use in expanded string"
9784 .cindex "expansion" "calling Perl from"
9785 This item is available only if Exim has been built to include an embedded Perl
9786 interpreter. The subroutine name and the arguments are first separately
9787 expanded, and then the Perl subroutine is called with those arguments. No
9788 additional arguments need be given; the maximum number permitted, including the
9789 name of the subroutine, is nine.
9790
9791 The return value of the subroutine is inserted into the expanded string, unless
9792 the return value is &%undef%&. In that case, the expansion fails in the same
9793 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
9794 Whatever you return is evaluated in a scalar context. For example, if you
9795 return the name of a Perl vector, the return value is the size of the vector,
9796 not its contents.
9797
9798 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
9799 with the error message that was passed to &%die%&. More details of the embedded
9800 Perl facility are given in chapter &<<CHAPperl>>&.
9801
9802 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
9803 out the use of this expansion item in filter files.
9804
9805
9806 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
9807 .cindex "&%prvs%& expansion item"
9808 The first argument is a complete email address and the second is secret
9809 keystring. The third argument, specifying a key number, is optional. If absent,
9810 it defaults to 0. The result of the expansion is a prvs-signed email address,
9811 to be typically used with the &%return_path%& option on an &(smtp)& transport
9812 as part of a bounce address tag validation (BATV) scheme. For more discussion
9813 and an example, see section &<<SECTverifyPRVS>>&.
9814
9815 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
9816         {*&<&'string'&>&*}}*&"
9817 .cindex "&%prvscheck%& expansion item"
9818 This expansion item is the complement of the &%prvs%& item. It is used for
9819 checking prvs-signed addresses. If the expansion of the first argument does not
9820 yield a syntactically valid prvs-signed address, the whole item expands to the
9821 empty string. When the first argument does expand to a syntactically valid
9822 prvs-signed address, the second argument is expanded, with the prvs-decoded
9823 version of the address and the key number extracted from the address in the
9824 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
9825
9826 These two variables can be used in the expansion of the second argument to
9827 retrieve the secret. The validity of the prvs-signed address is then checked
9828 against the secret. The result is stored in the variable &$prvscheck_result$&,
9829 which is empty for failure or &"1"& for success.
9830
9831 The third argument is optional; if it is missing, it defaults to an empty
9832 string. This argument is now expanded. If the result is an empty string, the
9833 result of the expansion is the decoded version of the address. This is the case
9834 whether or not the signature was valid. Otherwise, the result of the expansion
9835 is the expansion of the third argument.
9836
9837 All three variables can be used in the expansion of the third argument.
9838 However, once the expansion is complete, only &$prvscheck_result$& remains set.
9839 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
9840
9841 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
9842 .cindex "expansion" "inserting an entire file"
9843 .cindex "file" "inserting into expansion"
9844 .cindex "&%readfile%& expansion item"
9845 The file name and end-of-line string are first expanded separately. The file is
9846 then read, and its contents replace the entire item. All newline characters in
9847 the file are replaced by the end-of-line string if it is present. Otherwise,
9848 newlines are left in the string.
9849 String expansion is not applied to the contents of the file. If you want this,
9850 you must wrap the item in an &%expand%& operator. If the file cannot be read,
9851 the string expansion fails.
9852
9853 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
9854 locks out the use of this expansion item in filter files.
9855
9856
9857
9858 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
9859         {*&<&'options'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
9860 .cindex "expansion" "inserting from a socket"
9861 .cindex "socket, use of in expansion"
9862 .cindex "&%readsocket%& expansion item"
9863 This item inserts data from a Unix domain or TCP socket into the expanded
9864 string. The minimal way of using it uses just two arguments, as in these
9865 examples:
9866 .code
9867 ${readsocket{/socket/name}{request string}}
9868 ${readsocket{inet:some.host:1234}{request string}}
9869 .endd
9870 For a Unix domain socket, the first substring must be the path to the socket.
9871 For an Internet socket, the first substring must contain &`inet:`& followed by
9872 a host name or IP address, followed by a colon and a port, which can be a
9873 number or the name of a TCP port in &_/etc/services_&. An IP address may
9874 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
9875 example:
9876 .code
9877 ${readsocket{inet:[::1]:1234}{request string}}
9878 .endd
9879 Only a single host name may be given, but if looking it up yields more than
9880 one IP address, they are each tried in turn until a connection is made. For
9881 both kinds of socket, Exim makes a connection, writes the request string
9882 unless it is an empty string; and no terminating NUL is ever sent)
9883 and reads from the socket until an end-of-file
9884 is read. A timeout of 5 seconds is applied. Additional, optional arguments
9885 extend what can be done. Firstly, you can vary the timeout. For example:
9886 .code
9887 ${readsocket{/socket/name}{request string}{3s}}
9888 .endd
9889 The third argument is a list of options, of which the first element is the timeout
9890 and must be present if the argument is given.
9891 Further elements are options of form &'name=value'&.
9892 One option type is currently recognised, defining whether (the default)
9893 or not a shutdown is done on the connection after sending the request.
9894 Example, to not do so (preferred, eg. by some webservers):
9895 .code
9896 ${readsocket{/socket/name}{request string}{3s:shutdown=no}}
9897 .endd
9898 A fourth argument allows you to change any newlines that are in the data
9899 that is read, in the same way as for &%readfile%& (see above). This example
9900 turns them into spaces:
9901 .code
9902 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
9903 .endd
9904 As with all expansions, the substrings are expanded before the processing
9905 happens. Errors in these sub-expansions cause the expansion to fail. In
9906 addition, the following errors can occur:
9907
9908 .ilist
9909 Failure to create a socket file descriptor;
9910 .next
9911 Failure to connect the socket;
9912 .next
9913 Failure to write the request string;
9914 .next
9915 Timeout on reading from the socket.
9916 .endlist
9917
9918 By default, any of these errors causes the expansion to fail. However, if
9919 you supply a fifth substring, it is expanded and used when any of the above
9920 errors occurs. For example:
9921 .code
9922 ${readsocket{/socket/name}{request string}{3s}{\n}\
9923   {socket failure}}
9924 .endd
9925 You can test for the existence of a Unix domain socket by wrapping this
9926 expansion in &`${if exists`&, but there is a race condition between that test
9927 and the actual opening of the socket, so it is safer to use the fifth argument
9928 if you want to be absolutely sure of avoiding an expansion error for a
9929 non-existent Unix domain socket, or a failure to connect to an Internet socket.
9930
9931 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
9932 locks out the use of this expansion item in filter files.
9933
9934
9935 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9936 .cindex "expansion" "reducing a list to a scalar"
9937 .cindex "list" "reducing to a scalar"
9938 .vindex "&$value$&"
9939 .vindex "&$item$&"
9940 This operation reduces a list to a single, scalar string. After expansion,
9941 <&'string1'&> is interpreted as a list, colon-separated by default, but the
9942 separator can be changed in the usual way. Then <&'string2'&> is expanded and
9943 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
9944 list is assigned to &$item$& in turn, and <&'string3'&> is expanded for each of
9945 them. The result of that expansion is assigned to &$value$& before the next
9946 iteration. When the end of the list is reached, the final value of &$value$& is
9947 added to the expansion output. The &*reduce*& expansion item can be used in a
9948 number of ways. For example, to add up a list of numbers:
9949 .code
9950 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
9951 .endd
9952 The result of that expansion would be &`6`&. The maximum of a list of numbers
9953 can be found:
9954 .code
9955 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
9956 .endd
9957 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
9958 restored to what they were before. See also the &*filter*& and &*map*&
9959 expansion items.
9960
9961 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
9962 This item inserts &"raw"& header lines. It is described with the &%header%&
9963 expansion item above.
9964
9965 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
9966         {*&<&'string2'&>&*}}*&"
9967 .cindex "expansion" "running a command"
9968 .cindex "&%run%& expansion item"
9969 The command and its arguments are first expanded as one string. The string is
9970 split apart into individual arguments by spaces, and then the command is run
9971 in a separate process, but under the same uid and gid.  As in other command
9972 executions from Exim, a shell is not used by default. If the command requires
9973 a shell, you must explicitly code it.
9974
9975 Since the arguments are split by spaces, when there is a variable expansion
9976 which has an empty result, it will cause the situation that the argument will
9977 simply be omitted when the program is actually executed by Exim. If the
9978 script/program requires a specific number of arguments and the expanded
9979 variable could possibly result in this empty expansion, the variable must be
9980 quoted. This is more difficult if the expanded variable itself could result
9981 in a string containing quotes, because it would interfere with the quotes
9982 around the command arguments. A possible guard against this is to wrap the
9983 variable in the &%sg%& operator to change any quote marks to some other
9984 character.
9985
9986 The standard input for the command exists, but is empty. The standard output
9987 and standard error are set to the same file descriptor.
9988 .cindex "return code" "from &%run%& expansion"
9989 .vindex "&$value$&"
9990 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
9991 and replaces the entire item; during this expansion, the standard output/error
9992 from the command is in the variable &$value$&. If the command fails,
9993 <&'string2'&>, if present, is expanded and used. Once again, during the
9994 expansion, the standard output/error from the command is in the variable
9995 &$value$&.
9996
9997 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
9998 can be the word &"fail"& (not in braces) to force expansion failure if the
9999 command does not succeed. If both strings are omitted, the result is contents
10000 of the standard output/error on success, and nothing on failure.
10001
10002 .vindex "&$run_in_acl$&"
10003 The standard output/error of the command is put in the variable &$value$&.
10004 In this ACL example, the output of a command is logged for the admin to
10005 troubleshoot:
10006 .code
10007 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
10008       log_message  = Output of id: $value
10009 .endd
10010 If the command requires shell idioms, such as the > redirect operator, the
10011 shell must be invoked directly, such as with:
10012 .code
10013 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
10014 .endd
10015
10016 .vindex "&$runrc$&"
10017 The return code from the command is put in the variable &$runrc$&, and this
10018 remains set afterwards, so in a filter file you can do things like this:
10019 .code
10020 if "${run{x y z}{}}$runrc" is 1 then ...
10021   elif $runrc is 2 then ...
10022   ...
10023 endif
10024 .endd
10025 If execution of the command fails (for example, the command does not exist),
10026 the return code is 127 &-- the same code that shells use for non-existent
10027 commands.
10028
10029 &*Warning*&: In a router or transport, you cannot assume the order in which
10030 option values are expanded, except for those preconditions whose order of
10031 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
10032 by the expansion of one option, and use it in another.
10033
10034 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
10035 out the use of this expansion item in filter files.
10036
10037
10038 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
10039 .cindex "expansion" "string substitution"
10040 .cindex "&%sg%& expansion item"
10041 This item works like Perl's substitution operator (s) with the global (/g)
10042 option; hence its name. However, unlike the Perl equivalent, Exim does not
10043 modify the subject string; instead it returns the modified string for insertion
10044 into the overall expansion. The item takes three arguments: the subject string,
10045 a regular expression, and a substitution string. For example:
10046 .code
10047 ${sg{abcdefabcdef}{abc}{xyz}}
10048 .endd
10049 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
10050 if any $, } or \ characters are required in the regular expression or in the
10051 substitution string, they have to be escaped. For example:
10052 .code
10053 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
10054 .endd
10055 yields &"defabc"&, and
10056 .code
10057 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
10058 .endd
10059 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
10060 the regular expression from string expansion.
10061
10062
10063
10064 .vitem &*${sort{*&<&'string'&>&*}{*&<&'comparator'&>&*}{*&<&'extractor'&>&*}}*&
10065 .cindex sorting "a list"
10066 .cindex list sorting
10067 .cindex expansion "list sorting"
10068 After expansion, <&'string'&> is interpreted as a list, colon-separated by
10069 default, but the separator can be changed in the usual way.
10070 The <&'comparator'&> argument is interpreted as the operator
10071 of a two-argument expansion condition.
10072 The numeric operators plus ge, gt, le, lt (and ~i variants) are supported.
10073 The comparison should return true when applied to two values
10074 if the first value should sort before the second value.
10075 The <&'extractor'&> expansion is applied repeatedly to elements of the list,
10076 the element being placed in &$item$&,
10077 to give values for comparison.
10078
10079 The item result is a sorted list,
10080 with the original list separator,
10081 of the list elements (in full) of the original.
10082
10083 Examples:
10084 .code
10085 ${sort{3:2:1:4}{<}{$item}}
10086 .endd
10087 sorts a list of numbers, and
10088 .code
10089 ${sort {${lookup dnsdb{>:,,mx=example.com}}} {<} {${listextract{1}{<,$item}}}}
10090 .endd
10091 will sort an MX lookup into priority order.
10092
10093
10094 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10095 .cindex "&%substr%& expansion item"
10096 .cindex "substring extraction"
10097 .cindex "expansion" "substring extraction"
10098 The three strings are expanded; the first two must yield numbers. Call them
10099 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10100 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
10101 can use the simpler operator notation that avoids some of the braces:
10102 .code
10103 ${substr_<n>_<m>:<string>}
10104 .endd
10105 The second number is optional (in both notations).
10106 If it is absent in the simpler format, the preceding underscore must also be
10107 omitted.
10108
10109 The &%substr%& item can be used to extract more general substrings than
10110 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
10111 length required. For example
10112 .code
10113 ${substr{3}{2}{$local_part}}
10114 .endd
10115 If the starting offset is greater than the string length the result is the
10116 null string; if the length plus starting offset is greater than the string
10117 length, the result is the right-hand part of the string, starting from the
10118 given offset. The first character in the string has offset zero.
10119
10120 The &%substr%& expansion item can take negative offset values to count
10121 from the right-hand end of its operand. The last character is offset -1, the
10122 second-last is offset -2, and so on. Thus, for example,
10123 .code
10124 ${substr{-5}{2}{1234567}}
10125 .endd
10126 yields &"34"&. If the absolute value of a negative offset is greater than the
10127 length of the string, the substring starts at the beginning of the string, and
10128 the length is reduced by the amount of overshoot. Thus, for example,
10129 .code
10130 ${substr{-5}{2}{12}}
10131 .endd
10132 yields an empty string, but
10133 .code
10134 ${substr{-3}{2}{12}}
10135 .endd
10136 yields &"1"&.
10137
10138 When the second number is omitted from &%substr%&, the remainder of the string
10139 is taken if the offset is positive. If it is negative, all characters in the
10140 string preceding the offset point are taken. For example, an offset of -1 and
10141 no length, as in these semantically identical examples:
10142 .code
10143 ${substr_-1:abcde}
10144 ${substr{-1}{abcde}}
10145 .endd
10146 yields all but the last character of the string, that is, &"abcd"&.
10147
10148
10149
10150 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
10151         {*&<&'replacements'&>&*}}*&"
10152 .cindex "expansion" "character translation"
10153 .cindex "&%tr%& expansion item"
10154 This item does single-character translation on its subject string. The second
10155 argument is a list of characters to be translated in the subject string. Each
10156 matching character is replaced by the corresponding character from the
10157 replacement list. For example
10158 .code
10159 ${tr{abcdea}{ac}{13}}
10160 .endd
10161 yields &`1b3de1`&. If there are duplicates in the second character string, the
10162 last occurrence is used. If the third string is shorter than the second, its
10163 last character is replicated. However, if it is empty, no translation takes
10164 place.
10165 .endlist
10166
10167
10168
10169 .section "Expansion operators" "SECTexpop"
10170 .cindex "expansion" "operators"
10171 For expansion items that perform transformations on a single argument string,
10172 the &"operator"& notation is used because it is simpler and uses fewer braces.
10173 The substring is first expanded before the operation is applied to it. The
10174 following operations can be performed:
10175
10176 .vlist
10177 .vitem &*${address:*&<&'string'&>&*}*&
10178 .cindex "expansion" "RFC 2822 address handling"
10179 .cindex "&%address%& expansion item"
10180 The string is interpreted as an RFC 2822 address, as it might appear in a
10181 header line, and the effective address is extracted from it. If the string does
10182 not parse successfully, the result is empty.
10183
10184
10185 .vitem &*${addresses:*&<&'string'&>&*}*&
10186 .cindex "expansion" "RFC 2822 address handling"
10187 .cindex "&%addresses%& expansion item"
10188 The string (after expansion) is interpreted as a list of addresses in RFC
10189 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
10190 operative address (&'local-part@domain'&) is extracted from each item, and the
10191 result of the expansion is a colon-separated list, with appropriate
10192 doubling of colons should any happen to be present in the email addresses.
10193 Syntactically invalid RFC2822 address items are omitted from the output.
10194
10195 It is possible to specify a character other than colon for the output
10196 separator by starting the string with > followed by the new separator
10197 character. For example:
10198 .code
10199 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
10200 .endd
10201 expands to &`ceo@up.stairs&&sec@base.ment`&. The string is expanded
10202 first, so if the expanded string starts with >, it may change the output
10203 separator unintentionally. This can be avoided by setting the output
10204 separator explicitly:
10205 .code
10206 ${addresses:>:$h_from:}
10207 .endd
10208
10209 Compare the &*address*& (singular)
10210 expansion item, which extracts the working address from a single RFC2822
10211 address. See the &*filter*&, &*map*&, and &*reduce*& items for ways of
10212 processing lists.
10213
10214 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
10215 a strict interpretation of header line formatting.  Exim parses the bare,
10216 unquoted portion of an email address and if it finds a comma, treats it as an
10217 email address separator. For the example header line:
10218 .code
10219 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
10220 .endd
10221 The first example below demonstrates that Q-encoded email addresses are parsed
10222 properly if it is given the raw header (in this example, &`$rheader_from:`&).
10223 It does not see the comma because it's still encoded as "=2C".  The second
10224 example below is passed the contents of &`$header_from:`&, meaning it gets
10225 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
10226 The third example shows that the presence of a comma is skipped when it is
10227 quoted.
10228 .code
10229 # exim -be '${addresses:From: \
10230 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
10231 user@example.com
10232 # exim -be '${addresses:From: Last, First <user@example.com>}'
10233 Last:user@example.com
10234 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
10235 user@example.com
10236 .endd
10237
10238 .vitem &*${base32:*&<&'digits'&>&*}*&
10239 .cindex "&%base32%& expansion item"
10240 .cindex "expansion" "conversion to base 32"
10241 The string must consist entirely of decimal digits. The number is converted to
10242 base 32 and output as a (empty, for zero) string of characters.
10243 Only lowercase letters are used.
10244
10245 .vitem &*${base32d:*&<&'base-32&~digits'&>&*}*&
10246 .cindex "&%base32d%& expansion item"
10247 .cindex "expansion" "conversion to base 32"
10248 The string must consist entirely of base-32 digits.
10249 The number is converted to decimal and output as a string.
10250
10251 .vitem &*${base62:*&<&'digits'&>&*}*&
10252 .cindex "&%base62%& expansion item"
10253 .cindex "expansion" "conversion to base 62"
10254 The string must consist entirely of decimal digits. The number is converted to
10255 base 62 and output as a string of six characters, including leading zeros. In
10256 the few operating environments where Exim uses base 36 instead of base 62 for
10257 its message identifiers (because those systems do not have case-sensitive file
10258 names), base 36 is used by this operator, despite its name. &*Note*&: Just to
10259 be absolutely clear: this is &'not'& base64 encoding.
10260
10261 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
10262 .cindex "&%base62d%& expansion item"
10263 .cindex "expansion" "conversion to base 62"
10264 The string must consist entirely of base-62 digits, or, in operating
10265 environments where Exim uses base 36 instead of base 62 for its message
10266 identifiers, base-36 digits. The number is converted to decimal and output as a
10267 string.
10268
10269 .vitem &*${base64:*&<&'string'&>&*}*&
10270 .cindex "expansion" "base64 encoding"
10271 .cindex "base64 encoding" "in string expansion"
10272 .cindex "&%base64%& expansion item"
10273 .cindex certificate "base64 of DER"
10274 This operator converts a string into one that is base64 encoded.
10275
10276 If the string is a single variable of type certificate,
10277 returns the base64 encoding of the DER form of the certificate.
10278
10279
10280 .vitem &*${base64d:*&<&'string'&>&*}*&
10281 .cindex "expansion" "base64 decoding"
10282 .cindex "base64 decoding" "in string expansion"
10283 .cindex "&%base64d%& expansion item"
10284 This operator converts a base64-encoded string into the un-coded form.
10285
10286
10287 .vitem &*${domain:*&<&'string'&>&*}*&
10288 .cindex "domain" "extraction"
10289 .cindex "expansion" "domain extraction"
10290 The string is interpreted as an RFC 2822 address and the domain is extracted
10291 from it. If the string does not parse successfully, the result is empty.
10292
10293
10294 .vitem &*${escape:*&<&'string'&>&*}*&
10295 .cindex "expansion" "escaping non-printing characters"
10296 .cindex "&%escape%& expansion item"
10297 If the string contains any non-printing characters, they are converted to
10298 escape sequences starting with a backslash. Whether characters with the most
10299 significant bit set (so-called &"8-bit characters"&) count as printing or not
10300 is controlled by the &%print_topbitchars%& option.
10301
10302 .vitem &*${escape8bit:*&<&'string'&>&*}*&
10303 .cindex "expansion" "escaping 8-bit characters"
10304 .cindex "&%escape8bit%& expansion item"
10305 If the string contains and characters with the most significant bit set,
10306 they are converted to escape sequences starting with a backslash.
10307 Backslashes and DEL characters are also converted.
10308
10309
10310 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
10311 .cindex "expansion" "expression evaluation"
10312 .cindex "expansion" "arithmetic expression"
10313 .cindex "&%eval%& expansion item"
10314 These items supports simple arithmetic and bitwise logical operations in
10315 expansion strings. The string (after expansion) must be a conventional
10316 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
10317 logical operators, and parentheses. All operations are carried out using
10318 integer arithmetic. The operator priorities are as follows (the same as in the
10319 C programming language):
10320 .table2 70pt 300pt
10321 .irow &'highest:'& "not (~), negate (-)"
10322 .irow ""   "multiply (*), divide (/), remainder (%)"
10323 .irow ""   "plus (+), minus (-)"
10324 .irow ""   "shift-left (<<), shift-right (>>)"
10325 .irow ""   "and (&&)"
10326 .irow ""   "xor (^)"
10327 .irow &'lowest:'&  "or (|)"
10328 .endtable
10329 Binary operators with the same priority are evaluated from left to right. White
10330 space is permitted before or after operators.
10331
10332 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
10333 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
10334 decimal, even if they start with a leading zero; hexadecimal numbers are not
10335 permitted. This can be useful when processing numbers extracted from dates or
10336 times, which often do have leading zeros.
10337
10338 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
10339 or 1024*1024*1024,
10340 respectively. Negative numbers are supported. The result of the computation is
10341 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
10342
10343 .display
10344 &`${eval:1+1}            `&  yields 2
10345 &`${eval:1+2*3}          `&  yields 7
10346 &`${eval:(1+2)*3}        `&  yields 9
10347 &`${eval:2+42%5}         `&  yields 4
10348 &`${eval:0xc&amp;5}          `&  yields 4
10349 &`${eval:0xc|5}          `&  yields 13
10350 &`${eval:0xc^5}          `&  yields 9
10351 &`${eval:0xc>>1}         `&  yields 6
10352 &`${eval:0xc<<1}         `&  yields 24
10353 &`${eval:~255&amp;0x1234}    `&  yields 4608
10354 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
10355 .endd
10356
10357 As a more realistic example, in an ACL you might have
10358 .code
10359 deny   message = Too many bad recipients
10360        condition =                    \
10361          ${if and {                   \
10362            {>{$rcpt_count}{10}}       \
10363            {                          \
10364            <                          \
10365              {$recipients_count}      \
10366              {${eval:$rcpt_count/2}}  \
10367            }                          \
10368          }{yes}{no}}
10369 .endd
10370 The condition is true if there have been more than 10 RCPT commands and
10371 fewer than half of them have resulted in a valid recipient.
10372
10373
10374 .vitem &*${expand:*&<&'string'&>&*}*&
10375 .cindex "expansion" "re-expansion of substring"
10376 The &%expand%& operator causes a string to be expanded for a second time. For
10377 example,
10378 .code
10379 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
10380 .endd
10381 first looks up a string in a file while expanding the operand for &%expand%&,
10382 and then re-expands what it has found.
10383
10384
10385 .vitem &*${from_utf8:*&<&'string'&>&*}*&
10386 .cindex "Unicode"
10387 .cindex "UTF-8" "conversion from"
10388 .cindex "expansion" "UTF-8 conversion"
10389 .cindex "&%from_utf8%& expansion item"
10390 The world is slowly moving towards Unicode, although there are no standards for
10391 email yet. However, other applications (including some databases) are starting
10392 to store data in Unicode, using UTF-8 encoding. This operator converts from a
10393 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
10394 converted to underscores. The input must be a valid UTF-8 string. If it is not,
10395 the result is an undefined sequence of bytes.
10396
10397 Unicode code points with values less than 256 are compatible with ASCII and
10398 ISO-8859-1 (also known as Latin-1).
10399 For example, character 169 is the copyright symbol in both cases, though the
10400 way it is encoded is different. In UTF-8, more than one byte is needed for
10401 characters with code values greater than 127, whereas ISO-8859-1 is a
10402 single-byte encoding (but thereby limited to 256 characters). This makes
10403 translation from UTF-8 to ISO-8859-1 straightforward.
10404
10405
10406 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10407 .cindex "hash function" "textual"
10408 .cindex "expansion" "textual hash"
10409 The &%hash%& operator is a simpler interface to the hashing function that can
10410 be used when the two parameters are fixed numbers (as opposed to strings that
10411 change when expanded). The effect is the same as
10412 .code
10413 ${hash{<n>}{<m>}{<string>}}
10414 .endd
10415 See the description of the general &%hash%& item above for details. The
10416 abbreviation &%h%& can be used when &%hash%& is used as an operator.
10417
10418
10419
10420 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
10421 .cindex "base64 encoding" "conversion from hex"
10422 .cindex "expansion" "hex to base64"
10423 .cindex "&%hex2b64%& expansion item"
10424 This operator converts a hex string into one that is base64 encoded. This can
10425 be useful for processing the output of the MD5 and SHA-1 hashing functions.
10426
10427
10428
10429 .vitem &*${hexquote:*&<&'string'&>&*}*&
10430 .cindex "quoting" "hex-encoded unprintable characters"
10431 .cindex "&%hexquote%& expansion item"
10432 This operator converts non-printable characters in a string into a hex
10433 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
10434 as is, and other byte values are converted to &`\xNN`&, for example a
10435 byte value 127 is converted to &`\x7f`&.
10436
10437
10438 .vitem &*${ipv6denorm:*&<&'string'&>&*}*&
10439 .cindex "&%ipv6denorm%& expansion item"
10440 .cindex "IP address" normalisation
10441 This expands an IPv6 address to a full eight-element colon-separated set
10442 of hex digits including leading zeroes.
10443 A trailing ipv4-style dotted-decimal set is converted to hex.
10444 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10445
10446 .vitem &*${ipv6norm:*&<&'string'&>&*}*&
10447 .cindex "&%ipv6norm%& expansion item"
10448 .cindex "IP address" normalisation
10449 .cindex "IP address" "canonical form"
10450 This converts an IPv6 address to canonical form.
10451 Leading zeroes of groups are omitted, and the longest
10452 set of zero-valued groups is replaced with a double colon.
10453 A trailing ipv4-style dotted-decimal set is converted to hex.
10454 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10455
10456
10457 .vitem &*${lc:*&<&'string'&>&*}*&
10458 .cindex "case forcing in strings"
10459 .cindex "string" "case forcing"
10460 .cindex "lower casing"
10461 .cindex "expansion" "case forcing"
10462 .cindex "&%lc%& expansion item"
10463 This forces the letters in the string into lower-case, for example:
10464 .code
10465 ${lc:$local_part}
10466 .endd
10467
10468 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
10469 .cindex "expansion" "string truncation"
10470 .cindex "&%length%& expansion item"
10471 The &%length%& operator is a simpler interface to the &%length%& function that
10472 can be used when the parameter is a fixed number (as opposed to a string that
10473 changes when expanded). The effect is the same as
10474 .code
10475 ${length{<number>}{<string>}}
10476 .endd
10477 See the description of the general &%length%& item above for details. Note that
10478 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
10479 when &%length%& is used as an operator.
10480
10481
10482 .vitem &*${listcount:*&<&'string'&>&*}*&
10483 .cindex "expansion" "list item count"
10484 .cindex "list" "item count"
10485 .cindex "list" "count of items"
10486 .cindex "&%listcount%& expansion item"
10487 The string is interpreted as a list and the number of items is returned.
10488
10489
10490 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
10491 .cindex "expansion" "named list"
10492 .cindex "&%listnamed%& expansion item"
10493 The name is interpreted as a named list and the content of the list is returned,
10494 expanding any referenced lists, re-quoting as needed for colon-separation.
10495 If the optional type is given it must be one of "a", "d", "h" or "l"
10496 and selects address-, domain-, host- or localpart- lists to search among respectively.
10497 Otherwise all types are searched in an undefined order and the first
10498 matching list is returned.
10499
10500
10501 .vitem &*${local_part:*&<&'string'&>&*}*&
10502 .cindex "expansion" "local part extraction"
10503 .cindex "&%local_part%& expansion item"
10504 The string is interpreted as an RFC 2822 address and the local part is
10505 extracted from it. If the string does not parse successfully, the result is
10506 empty.
10507
10508
10509 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
10510 .cindex "masked IP address"
10511 .cindex "IP address" "masking"
10512 .cindex "CIDR notation"
10513 .cindex "expansion" "IP address masking"
10514 .cindex "&%mask%& expansion item"
10515 If the form of the string to be operated on is not an IP address followed by a
10516 slash and an integer (that is, a network address in CIDR notation), the
10517 expansion fails. Otherwise, this operator converts the IP address to binary,
10518 masks off the least significant bits according to the bit count, and converts
10519 the result back to text, with mask appended. For example,
10520 .code
10521 ${mask:10.111.131.206/28}
10522 .endd
10523 returns the string &"10.111.131.192/28"&. Since this operation is expected to
10524 be mostly used for looking up masked addresses in files, the result for an IPv6
10525 address uses dots to separate components instead of colons, because colon
10526 terminates a key string in lsearch files. So, for example,
10527 .code
10528 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
10529 .endd
10530 returns the string
10531 .code
10532 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
10533 .endd
10534 Letters in IPv6 addresses are always output in lower case.
10535
10536
10537 .vitem &*${md5:*&<&'string'&>&*}*&
10538 .cindex "MD5 hash"
10539 .cindex "expansion" "MD5 hash"
10540 .cindex certificate fingerprint
10541 .cindex "&%md5%& expansion item"
10542 The &%md5%& operator computes the MD5 hash value of the string, and returns it
10543 as a 32-digit hexadecimal number, in which any letters are in lower case.
10544
10545 If the string is a single variable of type certificate,
10546 returns the MD5 hash fingerprint of the certificate.
10547
10548
10549 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10550 .cindex "expansion" "numeric hash"
10551 .cindex "hash function" "numeric"
10552 The &%nhash%& operator is a simpler interface to the numeric hashing function
10553 that can be used when the two parameters are fixed numbers (as opposed to
10554 strings that change when expanded). The effect is the same as
10555 .code
10556 ${nhash{<n>}{<m>}{<string>}}
10557 .endd
10558 See the description of the general &%nhash%& item above for details.
10559
10560
10561 .vitem &*${quote:*&<&'string'&>&*}*&
10562 .cindex "quoting" "in string expansions"
10563 .cindex "expansion" "quoting"
10564 .cindex "&%quote%& expansion item"
10565 The &%quote%& operator puts its argument into double quotes if it
10566 is an empty string or
10567 contains anything other than letters, digits, underscores, dots, and hyphens.
10568 Any occurrences of double quotes and backslashes are escaped with a backslash.
10569 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
10570 respectively For example,
10571 .code
10572 ${quote:ab"*"cd}
10573 .endd
10574 becomes
10575 .code
10576 "ab\"*\"cd"
10577 .endd
10578 The place where this is useful is when the argument is a substitution from a
10579 variable or a message header.
10580
10581 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
10582 .cindex "&%quote_local_part%& expansion item"
10583 This operator is like &%quote%&, except that it quotes the string only if
10584 required to do so by the rules of RFC 2822 for quoting local parts. For
10585 example, a plus sign would not cause quoting (but it would for &%quote%&).
10586 If you are creating a new email address from the contents of &$local_part$&
10587 (or any other unknown data), you should always use this operator.
10588
10589
10590 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
10591 .cindex "quoting" "lookup-specific"
10592 This operator applies lookup-specific quoting rules to the string. Each
10593 query-style lookup type has its own quoting rules which are described with
10594 the lookups in chapter &<<CHAPfdlookup>>&. For example,
10595 .code
10596 ${quote_ldap:two * two}
10597 .endd
10598 returns
10599 .code
10600 two%20%5C2A%20two
10601 .endd
10602 For single-key lookup types, no quoting is ever necessary and this operator
10603 yields an unchanged string.
10604
10605
10606 .vitem &*${randint:*&<&'n'&>&*}*&
10607 .cindex "random number"
10608 This operator returns a somewhat random number which is less than the
10609 supplied number and is at least 0.  The quality of this randomness depends
10610 on how Exim was built; the values are not suitable for keying material.
10611 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
10612 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
10613 for versions of GnuTLS with that function.
10614 Otherwise, the implementation may be arc4random(), random() seeded by
10615 srandomdev() or srandom(), or a custom implementation even weaker than
10616 random().
10617
10618
10619 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
10620 .cindex "expansion" "IP address"
10621 This operator reverses an IP address; for IPv4 addresses, the result is in
10622 dotted-quad decimal form, while for IPv6 addresses the result is in
10623 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
10624 for DNS.  For example,
10625 .code
10626 ${reverse_ip:192.0.2.4}
10627 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
10628 .endd
10629 returns
10630 .code
10631 4.2.0.192
10632 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
10633 .endd
10634
10635
10636 .vitem &*${rfc2047:*&<&'string'&>&*}*&
10637 .cindex "expansion" "RFC 2047"
10638 .cindex "RFC 2047" "expansion operator"
10639 .cindex "&%rfc2047%& expansion item"
10640 This operator encodes text according to the rules of RFC 2047. This is an
10641 encoding that is used in header lines to encode non-ASCII characters. It is
10642 assumed that the input string is in the encoding specified by the
10643 &%headers_charset%& option, which gets its default at build time. If the string
10644 contains only characters in the range 33&--126, and no instances of the
10645 characters
10646 .code
10647 ? = ( ) < > @ , ; : \ " . [ ] _
10648 .endd
10649 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
10650 string, using as many &"encoded words"& as necessary to encode all the
10651 characters.
10652
10653
10654 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
10655 .cindex "expansion" "RFC 2047"
10656 .cindex "RFC 2047" "decoding"
10657 .cindex "&%rfc2047d%& expansion item"
10658 This operator decodes strings that are encoded as per RFC 2047. Binary zero
10659 bytes are replaced by question marks. Characters are converted into the
10660 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
10661 not recognized unless &%check_rfc2047_length%& is set false.
10662
10663 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
10664 access a header line, RFC 2047 decoding is done automatically. You do not need
10665 to use this operator as well.
10666
10667
10668
10669 .vitem &*${rxquote:*&<&'string'&>&*}*&
10670 .cindex "quoting" "in regular expressions"
10671 .cindex "regular expressions" "quoting"
10672 .cindex "&%rxquote%& expansion item"
10673 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
10674 characters in its argument. This is useful when substituting the values of
10675 variables or headers inside regular expressions.
10676
10677
10678 .vitem &*${sha1:*&<&'string'&>&*}*&
10679 .cindex "SHA-1 hash"
10680 .cindex "expansion" "SHA-1 hashing"
10681 .cindex certificate fingerprint
10682 .cindex "&%sha1%& expansion item"
10683 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
10684 it as a 40-digit hexadecimal number, in which any letters are in upper case.
10685
10686 If the string is a single variable of type certificate,
10687 returns the SHA-1 hash fingerprint of the certificate.
10688
10689
10690 .vitem &*${sha256:*&<&'string'&>&*}*&
10691 .cindex "SHA-256 hash"
10692 .cindex certificate fingerprint
10693 .cindex "expansion" "SHA-256 hashing"
10694 .cindex "&%sha256%& expansion item"
10695 The &%sha256%& operator computes the SHA-256 hash value of the string
10696 and returns
10697 it as a 64-digit hexadecimal number, in which any letters are in upper case.
10698
10699 If the string is a single variable of type certificate,
10700 returns the SHA-256 hash fingerprint of the certificate.
10701
10702
10703 .vitem &*${sha3:*&<&'string'&>&*}*& &&&
10704        &*${sha3_<n>:*&<&'string'&>&*}*&
10705 .cindex "SHA3 hash"
10706 .cindex "expansion" "SHA3 hashing"
10707 .cindex "&%sha3%& expansion item"
10708 The &%sha3%& operator computes the SHA3-256 hash value of the string
10709 and returns
10710 it as a 64-digit hexadecimal number, in which any letters are in upper case.
10711
10712 If a number is appended, separated by an underbar, it specifies
10713 the output length.  Values of 224, 256, 384 and 512 are accepted;
10714 with 256 being the default.
10715
10716 The &%sha3%& expansion item is only supported if Exim has been
10717 compiled with GnuTLS 3.5.0 or later,
10718 .new
10719 or OpenSSL 1.1.1 or later.
10720 The macro "_CRYPTO_HASH_SHA3" will be defined if it is supported.
10721 .wen
10722
10723
10724 .vitem &*${stat:*&<&'string'&>&*}*&
10725 .cindex "expansion" "statting a file"
10726 .cindex "file" "extracting characteristics"
10727 .cindex "&%stat%& expansion item"
10728 The string, after expansion, must be a file path. A call to the &[stat()]&
10729 function is made for this path. If &[stat()]& fails, an error occurs and the
10730 expansion fails. If it succeeds, the data from the stat replaces the item, as a
10731 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
10732 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
10733 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
10734 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
10735 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
10736 can extract individual fields using the &%extract%& expansion item.
10737
10738 The use of the &%stat%& expansion in users' filter files can be locked out by
10739 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
10740 systems for files larger than 2GB.
10741
10742 .vitem &*${str2b64:*&<&'string'&>&*}*&
10743 .cindex "&%str2b64%& expansion item"
10744 Now deprecated, a synonym for the &%base64%& expansion operator.
10745
10746
10747
10748 .vitem &*${strlen:*&<&'string'&>&*}*&
10749 .cindex "expansion" "string length"
10750 .cindex "string" "length in expansion"
10751 .cindex "&%strlen%& expansion item"
10752 The item is replace by the length of the expanded string, expressed as a
10753 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
10754
10755
10756 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
10757 .cindex "&%substr%& expansion item"
10758 .cindex "substring extraction"
10759 .cindex "expansion" "substring expansion"
10760 The &%substr%& operator is a simpler interface to the &%substr%& function that
10761 can be used when the two parameters are fixed numbers (as opposed to strings
10762 that change when expanded). The effect is the same as
10763 .code
10764 ${substr{<start>}{<length>}{<string>}}
10765 .endd
10766 See the description of the general &%substr%& item above for details. The
10767 abbreviation &%s%& can be used when &%substr%& is used as an operator.
10768
10769 .vitem &*${time_eval:*&<&'string'&>&*}*&
10770 .cindex "&%time_eval%& expansion item"
10771 .cindex "time interval" "decoding"
10772 This item converts an Exim time interval such as &`2d4h5m`& into a number of
10773 seconds.
10774
10775 .vitem &*${time_interval:*&<&'string'&>&*}*&
10776 .cindex "&%time_interval%& expansion item"
10777 .cindex "time interval" "formatting"
10778 The argument (after sub-expansion) must be a sequence of decimal digits that
10779 represents an interval of time as a number of seconds. It is converted into a
10780 number of larger units and output in Exim's normal time format, for example,
10781 &`1w3d4h2m6s`&.
10782
10783 .vitem &*${uc:*&<&'string'&>&*}*&
10784 .cindex "case forcing in strings"
10785 .cindex "string" "case forcing"
10786 .cindex "upper casing"
10787 .cindex "expansion" "case forcing"
10788 .cindex "&%uc%& expansion item"
10789 This forces the letters in the string into upper-case.
10790
10791 .vitem &*${utf8clean:*&<&'string'&>&*}*&
10792 .cindex "correction of invalid utf-8 sequences in strings"
10793 .cindex "utf-8" "utf-8 sequences"
10794 .cindex "incorrect utf-8"
10795 .cindex "expansion" "utf-8 forcing"
10796 .cindex "&%utf8clean%& expansion item"
10797 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
10798
10799 .vitem "&*${utf8_domain_to_alabel:*&<&'string'&>&*}*&" &&&
10800        "&*${utf8_domain_from_alabel:*&<&'string'&>&*}*&" &&&
10801        "&*${utf8_localpart_to_alabel:*&<&'string'&>&*}*&" &&&
10802        "&*${utf8_localpart_from_alabel:*&<&'string'&>&*}*&"
10803 .cindex expansion UTF-8
10804 .cindex UTF-8 expansion
10805 .cindex EAI
10806 .cindex internationalisation
10807 .cindex "&%utf8_domain_to_alabel%& expansion item"
10808 .cindex "&%utf8_domain_from_alabel%& expansion item"
10809 .cindex "&%utf8_localpart_to_alabel%& expansion item"
10810 .cindex "&%utf8_localpart_from_alabel%& expansion item"
10811 These convert EAI mail name components between UTF-8 and a-label forms.
10812 For information on internationalisation support see &<<SECTi18nMTA>>&.
10813 .endlist
10814
10815
10816
10817
10818
10819
10820 .section "Expansion conditions" "SECTexpcond"
10821 .scindex IIDexpcond "expansion" "conditions"
10822 The following conditions are available for testing by the &%${if%& construct
10823 while expanding strings:
10824
10825 .vlist
10826 .vitem &*!*&<&'condition'&>
10827 .cindex "expansion" "negating a condition"
10828 .cindex "negation" "in expansion condition"
10829 Preceding any condition with an exclamation mark negates the result of the
10830 condition.
10831
10832 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10833 .cindex "numeric comparison"
10834 .cindex "expansion" "numeric comparison"
10835 There are a number of symbolic operators for doing numeric comparisons. They
10836 are:
10837 .display
10838 &`=   `&   equal
10839 &`==  `&   equal
10840 &`>   `&   greater
10841 &`>=  `&   greater or equal
10842 &`<   `&   less
10843 &`<=  `&   less or equal
10844 .endd
10845 For example:
10846 .code
10847 ${if >{$message_size}{10M} ...
10848 .endd
10849 Note that the general negation operator provides for inequality testing. The
10850 two strings must take the form of optionally signed decimal integers,
10851 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
10852 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
10853 As a special case, the numerical value of an empty string is taken as
10854 zero.
10855
10856 In all cases, a relative comparator OP is testing if <&'string1'&> OP
10857 <&'string2'&>; the above example is checking if &$message_size$& is larger than
10858 10M, not if 10M is larger than &$message_size$&.
10859
10860
10861 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
10862         {*&<&'arg2'&>&*}...}*&
10863 .cindex "expansion" "calling an acl"
10864 .cindex "&%acl%&" "expansion condition"
10865 The name and zero to nine argument strings are first expanded separately.  The expanded
10866 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
10867 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
10868 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
10869 and may use the variables; if another acl expansion is used the values
10870 are restored after it returns.  If the ACL sets
10871 a value using a "message =" modifier the variable $value becomes
10872 the result of the expansion, otherwise it is empty.
10873 If the ACL returns accept the condition is true; if deny, false.
10874 If the ACL returns defer the result is a forced-fail.
10875
10876 .vitem &*bool&~{*&<&'string'&>&*}*&
10877 .cindex "expansion" "boolean parsing"
10878 .cindex "&%bool%& expansion condition"
10879 This condition turns a string holding a true or false representation into
10880 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
10881 (case-insensitively); also integer numbers map to true if non-zero,
10882 false if zero.
10883 An empty string is treated as false.
10884 Leading and trailing whitespace is ignored;
10885 thus a string consisting only of whitespace is false.
10886 All other string values will result in expansion failure.
10887
10888 When combined with ACL variables, this expansion condition will let you
10889 make decisions in one place and act on those decisions in another place.
10890 For example:
10891 .code
10892 ${if bool{$acl_m_privileged_sender} ...
10893 .endd
10894
10895
10896 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
10897 .cindex "expansion" "boolean parsing"
10898 .cindex "&%bool_lax%& expansion condition"
10899 Like &%bool%&, this condition turns a string into a boolean state.  But
10900 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
10901 loose definition that the Router &%condition%& option uses.  The empty string
10902 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
10903 true.  Leading and trailing whitespace is ignored.
10904
10905 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
10906
10907 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10908 .cindex "expansion" "encrypted comparison"
10909 .cindex "encrypted strings, comparing"
10910 .cindex "&%crypteq%& expansion condition"
10911 This condition is included in the Exim binary if it is built to support any
10912 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
10913 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
10914 included in the binary.
10915
10916 The &%crypteq%& condition has two arguments. The first is encrypted and
10917 compared against the second, which is already encrypted. The second string may
10918 be in the LDAP form for storing encrypted strings, which starts with the
10919 encryption type in curly brackets, followed by the data. If the second string
10920 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
10921 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
10922 Typically this will be a field from a password file. An example of an encrypted
10923 string in LDAP form is:
10924 .code
10925 {md5}CY9rzUYh03PK3k6DJie09g==
10926 .endd
10927 If such a string appears directly in an expansion, the curly brackets have to
10928 be quoted, because they are part of the expansion syntax. For example:
10929 .code
10930 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
10931 .endd
10932 The following encryption types (whose names are matched case-independently) are
10933 supported:
10934
10935 .ilist
10936 .cindex "MD5 hash"
10937 .cindex "base64 encoding" "in encrypted password"
10938 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
10939 printable characters to compare with the remainder of the second string. If the
10940 length of the comparison string is 24, Exim assumes that it is base64 encoded
10941 (as in the above example). If the length is 32, Exim assumes that it is a
10942 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
10943 comparison fails.
10944
10945 .next
10946 .cindex "SHA-1 hash"
10947 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
10948 printable characters to compare with the remainder of the second string. If the
10949 length of the comparison string is 28, Exim assumes that it is base64 encoded.
10950 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
10951 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
10952
10953 .next
10954 .cindex "&[crypt()]&"
10955 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
10956 only the first eight characters of the password. However, in modern operating
10957 systems this is no longer true, and in many cases the entire password is used,
10958 whatever its length.
10959
10960 .next
10961 .cindex "&[crypt16()]&"
10962 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
10963 use up to 16 characters of the password in some operating systems. Again, in
10964 modern operating systems, more characters may be used.
10965 .endlist
10966 Exim has its own version of &[crypt16()]&, which is just a double call to
10967 &[crypt()]&. For operating systems that have their own version, setting
10968 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
10969 operating system version instead of its own. This option is set by default in
10970 the OS-dependent &_Makefile_& for those operating systems that are known to
10971 support &[crypt16()]&.
10972
10973 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
10974 it was not using the same algorithm as some operating systems' versions. It
10975 turns out that as well as &[crypt16()]& there is a function called
10976 &[bigcrypt()]& in some operating systems. This may or may not use the same
10977 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
10978
10979 However, since there is now a move away from the traditional &[crypt()]&
10980 functions towards using SHA1 and other algorithms, tidying up this area of
10981 Exim is seen as very low priority.
10982
10983 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
10984 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
10985 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
10986 default is &`{crypt}`&. Whatever the default, you can always use either
10987 function by specifying it explicitly in curly brackets.
10988
10989 .vitem &*def:*&<&'variable&~name'&>
10990 .cindex "expansion" "checking for empty variable"
10991 .cindex "&%def%& expansion condition"
10992 The &%def%& condition must be followed by the name of one of the expansion
10993 variables defined in section &<<SECTexpvar>>&. The condition is true if the
10994 variable does not contain the empty string. For example:
10995 .code
10996 ${if def:sender_ident {from $sender_ident}}
10997 .endd
10998 Note that the variable name is given without a leading &%$%& character. If the
10999 variable does not exist, the expansion fails.
11000
11001 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
11002         &~&*def:h_*&<&'header&~name'&>&*:*&"
11003 .cindex "expansion" "checking header line existence"
11004 This condition is true if a message is being processed and the named header
11005 exists in the message. For example,
11006 .code
11007 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
11008 .endd
11009 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
11010 the header name must be terminated by a colon if white space does not follow.
11011
11012 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11013        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11014 .cindex "string" "comparison"
11015 .cindex "expansion" "string comparison"
11016 .cindex "&%eq%& expansion condition"
11017 .cindex "&%eqi%& expansion condition"
11018 The two substrings are first expanded. The condition is true if the two
11019 resulting strings are identical. For &%eq%& the comparison includes the case of
11020 letters, whereas for &%eqi%& the comparison is case-independent.
11021
11022 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
11023 .cindex "expansion" "file existence test"
11024 .cindex "file" "existence test"
11025 .cindex "&%exists%&, expansion condition"
11026 The substring is first expanded and then interpreted as an absolute path. The
11027 condition is true if the named file (or directory) exists. The existence test
11028 is done by calling the &[stat()]& function. The use of the &%exists%& test in
11029 users' filter files may be locked out by the system administrator.
11030
11031 .vitem &*first_delivery*&
11032 .cindex "delivery" "first"
11033 .cindex "first delivery"
11034 .cindex "expansion" "first delivery test"
11035 .cindex "&%first_delivery%& expansion condition"
11036 This condition, which has no data, is true during a message's first delivery
11037 attempt. It is false during any subsequent delivery attempts.
11038
11039
11040 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
11041        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
11042 .cindex "list" "iterative conditions"
11043 .cindex "expansion" "&*forall*& condition"
11044 .cindex "expansion" "&*forany*& condition"
11045 .vindex "&$item$&"
11046 These conditions iterate over a list. The first argument is expanded to form
11047 the list. By default, the list separator is a colon, but it can be changed by
11048 the normal method. The second argument is interpreted as a condition that is to
11049 be applied to each item in the list in turn. During the interpretation of the
11050 condition, the current list item is placed in a variable called &$item$&.
11051 .ilist
11052 For &*forany*&, interpretation stops if the condition is true for any item, and
11053 the result of the whole condition is true. If the condition is false for all
11054 items in the list, the overall condition is false.
11055 .next
11056 For &*forall*&, interpretation stops if the condition is false for any item,
11057 and the result of the whole condition is false. If the condition is true for
11058 all items in the list, the overall condition is true.
11059 .endlist
11060 Note that negation of &*forany*& means that the condition must be false for all
11061 items for the overall condition to succeed, and negation of &*forall*& means
11062 that the condition must be false for at least one item. In this example, the
11063 list separator is changed to a comma:
11064 .code
11065 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
11066 .endd
11067 The value of &$item$& is saved and restored while &*forany*& or &*forall*& is
11068 being processed, to enable these expansion items to be nested.
11069
11070 To scan a named list, expand it with the &*listnamed*& operator.
11071
11072
11073 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11074        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11075 .cindex "string" "comparison"
11076 .cindex "expansion" "string comparison"
11077 .cindex "&%ge%& expansion condition"
11078 .cindex "&%gei%& expansion condition"
11079 The two substrings are first expanded. The condition is true if the first
11080 string is lexically greater than or equal to the second string. For &%ge%& the
11081 comparison includes the case of letters, whereas for &%gei%& the comparison is
11082 case-independent.
11083
11084 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11085        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11086 .cindex "string" "comparison"
11087 .cindex "expansion" "string comparison"
11088 .cindex "&%gt%& expansion condition"
11089 .cindex "&%gti%& expansion condition"
11090 The two substrings are first expanded. The condition is true if the first
11091 string is lexically greater than the second string. For &%gt%& the comparison
11092 includes the case of letters, whereas for &%gti%& the comparison is
11093 case-independent.
11094
11095 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11096        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11097 .cindex "string" "comparison"
11098 .cindex "list" "iterative conditions"
11099 Both strings are expanded; the second string is treated as a list of simple
11100 strings; if the first string is a member of the second, then the condition
11101 is true.
11102
11103 These are simpler to use versions of the more powerful &*forany*& condition.
11104 Examples, and the &*forany*& equivalents:
11105 .code
11106 ${if inlist{needle}{foo:needle:bar}}
11107   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
11108 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
11109   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
11110 .endd
11111
11112 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
11113        &*isip4&~{*&<&'string'&>&*}*& &&&
11114        &*isip6&~{*&<&'string'&>&*}*&
11115 .cindex "IP address" "testing string format"
11116 .cindex "string" "testing for IP address"
11117 .cindex "&%isip%& expansion condition"
11118 .cindex "&%isip4%& expansion condition"
11119 .cindex "&%isip6%& expansion condition"
11120 The substring is first expanded, and then tested to see if it has the form of
11121 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
11122 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
11123
11124 For an IPv4 address, the test is for four dot-separated components, each of
11125 which consists of from one to three digits. For an IPv6 address, up to eight
11126 colon-separated components are permitted, each containing from one to four
11127 hexadecimal digits. There may be fewer than eight components if an empty
11128 component (adjacent colons) is present. Only one empty component is permitted.
11129
11130 &*Note*&: The checks used to be just on the form of the address; actual numerical
11131 values were not considered. Thus, for example, 999.999.999.999 passed the IPv4
11132 check.
11133 This is no longer the case.
11134
11135 The main use of these tests is to distinguish between IP addresses and
11136 host names, or between IPv4 and IPv6 addresses. For example, you could use
11137 .code
11138 ${if isip4{$sender_host_address}...
11139 .endd
11140 to test which IP version an incoming SMTP connection is using.
11141
11142 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
11143 .cindex "LDAP" "use for authentication"
11144 .cindex "expansion" "LDAP authentication test"
11145 .cindex "&%ldapauth%& expansion condition"
11146 This condition supports user authentication using LDAP. See section
11147 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
11148 queries. For this use, the query must contain a user name and password. The
11149 query itself is not used, and can be empty. The condition is true if the
11150 password is not empty, and the user name and password are accepted by the LDAP
11151 server. An empty password is rejected without calling LDAP because LDAP binds
11152 with an empty password are considered anonymous regardless of the username, and
11153 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
11154 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
11155 this can be used.
11156
11157
11158 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11159        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11160 .cindex "string" "comparison"
11161 .cindex "expansion" "string comparison"
11162 .cindex "&%le%& expansion condition"
11163 .cindex "&%lei%& expansion condition"
11164 The two substrings are first expanded. The condition is true if the first
11165 string is lexically less than or equal to the second string. For &%le%& the
11166 comparison includes the case of letters, whereas for &%lei%& the comparison is
11167 case-independent.
11168
11169 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11170        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11171 .cindex "string" "comparison"
11172 .cindex "expansion" "string comparison"
11173 .cindex "&%lt%& expansion condition"
11174 .cindex "&%lti%& expansion condition"
11175 The two substrings are first expanded. The condition is true if the first
11176 string is lexically less than the second string. For &%lt%& the comparison
11177 includes the case of letters, whereas for &%lti%& the comparison is
11178 case-independent.
11179
11180
11181 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11182 .cindex "expansion" "regular expression comparison"
11183 .cindex "regular expressions" "match in expanded string"
11184 .cindex "&%match%& expansion condition"
11185 The two substrings are first expanded. The second is then treated as a regular
11186 expression and applied to the first. Because of the pre-expansion, if the
11187 regular expression contains dollar, or backslash characters, they must be
11188 escaped. Care must also be taken if the regular expression contains braces
11189 (curly brackets). A closing brace must be escaped so that it is not taken as a
11190 premature termination of <&'string2'&>. The easiest approach is to use the
11191 &`\N`& feature to disable expansion of the regular expression.
11192 For example,
11193 .code
11194 ${if match {$local_part}{\N^\d{3}\N} ...
11195 .endd
11196 If the whole expansion string is in double quotes, further escaping of
11197 backslashes is also required.
11198
11199 The condition is true if the regular expression match succeeds.
11200 The regular expression is not required to begin with a circumflex
11201 metacharacter, but if there is no circumflex, the expression is not anchored,
11202 and it may match anywhere in the subject, not just at the start. If you want
11203 the pattern to match at the end of the subject, you must include the &`$`&
11204 metacharacter at an appropriate point.
11205
11206 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
11207 At the start of an &%if%& expansion the values of the numeric variable
11208 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
11209 succeeds causes them to be reset to the substrings of that condition and they
11210 will have these values during the expansion of the success string. At the end
11211 of the &%if%& expansion, the previous values are restored. After testing a
11212 combination of conditions using &%or%&, the subsequent values of the numeric
11213 variables are those of the condition that succeeded.
11214
11215 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11216 .cindex "&%match_address%& expansion condition"
11217 See &*match_local_part*&.
11218
11219 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11220 .cindex "&%match_domain%& expansion condition"
11221 See &*match_local_part*&.
11222
11223 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11224 .cindex "&%match_ip%& expansion condition"
11225 This condition matches an IP address to a list of IP address patterns. It must
11226 be followed by two argument strings. The first (after expansion) must be an IP
11227 address or an empty string. The second (not expanded) is a restricted host
11228 list that can match only an IP address, not a host name. For example:
11229 .code
11230 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
11231 .endd
11232 The specific types of host list item that are permitted in the list are:
11233
11234 .ilist
11235 An IP address, optionally with a CIDR mask.
11236 .next
11237 A single asterisk, which matches any IP address.
11238 .next
11239 An empty item, which matches only if the IP address is empty. This could be
11240 useful for testing for a locally submitted message or one from specific hosts
11241 in a single test such as
11242 . ==== As this is a nested list, any displays it contains must be indented
11243 . ==== as otherwise they are too far to the left. This comment applies to
11244 . ==== the use of xmlto plus fop. There's no problem when formatting with
11245 . ==== sdop, with or without the extra indent.
11246 .code
11247   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
11248 .endd
11249 where the first item in the list is the empty string.
11250 .next
11251 The item @[] matches any of the local host's interface addresses.
11252 .next
11253 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
11254 even if &`net-`& is not specified. There is never any attempt to turn the IP
11255 address into a host name. The most common type of linear search for
11256 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
11257 masks. For example:
11258 .code
11259   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
11260 .endd
11261 It is of course possible to use other kinds of lookup, and in such a case, you
11262 do need to specify the &`net-`& prefix if you want to specify a specific
11263 address mask, for example:
11264 .code
11265   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
11266 .endd
11267 However, unless you are combining a &%match_ip%& condition with others, it is
11268 just as easy to use the fact that a lookup is itself a condition, and write:
11269 .code
11270   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
11271 .endd
11272 .endlist ilist
11273
11274 Note that <&'string2'&> is not itself subject to string expansion, unless
11275 Exim was built with the EXPAND_LISTMATCH_RHS option.
11276
11277 Consult section &<<SECThoslispatip>>& for further details of these patterns.
11278
11279 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11280 .cindex "domain list" "in expansion condition"
11281 .cindex "address list" "in expansion condition"
11282 .cindex "local part" "list, in expansion condition"
11283 .cindex "&%match_local_part%& expansion condition"
11284 This condition, together with &%match_address%& and &%match_domain%&, make it
11285 possible to test domain, address, and local part lists within expansions. Each
11286 condition requires two arguments: an item and a list to match. A trivial
11287 example is:
11288 .code
11289 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
11290 .endd
11291 In each case, the second argument may contain any of the allowable items for a
11292 list of the appropriate type. Also, because the second argument
11293 is a standard form of list, it is possible to refer to a named list.
11294 Thus, you can use conditions like this:
11295 .code
11296 ${if match_domain{$domain}{+local_domains}{...
11297 .endd
11298 .cindex "&`+caseful`&"
11299 For address lists, the matching starts off caselessly, but the &`+caseful`&
11300 item can be used, as in all address lists, to cause subsequent items to
11301 have their local parts matched casefully. Domains are always matched
11302 caselessly.
11303
11304 Note that <&'string2'&> is not itself subject to string expansion, unless
11305 Exim was built with the EXPAND_LISTMATCH_RHS option.
11306
11307 &*Note*&: Host lists are &'not'& supported in this way. This is because
11308 hosts have two identities: a name and an IP address, and it is not clear
11309 how to specify cleanly how such a test would work. However, IP addresses can be
11310 matched using &%match_ip%&.
11311
11312 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
11313 .cindex "PAM authentication"
11314 .cindex "AUTH" "with PAM"
11315 .cindex "Solaris" "PAM support"
11316 .cindex "expansion" "PAM authentication test"
11317 .cindex "&%pam%& expansion condition"
11318 &'Pluggable Authentication Modules'&
11319 (&url(http://www.kernel.org/pub/linux/libs/pam/)) are a facility that is
11320 available in the latest releases of Solaris and in some GNU/Linux
11321 distributions. The Exim support, which is intended for use in conjunction with
11322 the SMTP AUTH command, is available only if Exim is compiled with
11323 .code
11324 SUPPORT_PAM=yes
11325 .endd
11326 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
11327 in some releases of GNU/Linux &%-ldl%& is also needed.
11328
11329 The argument string is first expanded, and the result must be a
11330 colon-separated list of strings. Leading and trailing white space is ignored.
11331 The PAM module is initialized with the service name &"exim"& and the user name
11332 taken from the first item in the colon-separated data string (<&'string1'&>).
11333 The remaining items in the data string are passed over in response to requests
11334 from the authentication function. In the simple case there will only be one
11335 request, for a password, so the data consists of just two strings.
11336
11337 There can be problems if any of the strings are permitted to contain colon
11338 characters. In the usual way, these have to be doubled to avoid being taken as
11339 separators. If the data is being inserted from a variable, the &%sg%& expansion
11340 item can be used to double any existing colons. For example, the configuration
11341 of a LOGIN authenticator might contain this setting:
11342 .code
11343 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
11344 .endd
11345 For a PLAIN authenticator you could use:
11346 .code
11347 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
11348 .endd
11349 In some operating systems, PAM authentication can be done only from a process
11350 running as root. Since Exim is running as the Exim user when receiving
11351 messages, this means that PAM cannot be used directly in those systems.
11352 A patched version of the &'pam_unix'& module that comes with the
11353 Linux PAM package is available from &url(http://www.e-admin.de/pam_exim/).
11354 The patched module allows one special uid/gid combination, in addition to root,
11355 to authenticate. If you build the patched module to allow the Exim user and
11356 group, PAM can then be used from an Exim authenticator.
11357
11358
11359 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
11360 .cindex "&'pwcheck'& daemon"
11361 .cindex "Cyrus"
11362 .cindex "expansion" "&'pwcheck'& authentication test"
11363 .cindex "&%pwcheck%& expansion condition"
11364 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
11365 This is one way of making it possible for passwords to be checked by a process
11366 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
11367 deprecated. Its replacement is &'saslauthd'& (see below).
11368
11369 The pwcheck support is not included in Exim by default. You need to specify
11370 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
11371 building Exim. For example:
11372 .code
11373 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
11374 .endd
11375 You do not need to install the full Cyrus software suite in order to use
11376 the pwcheck daemon. You can compile and install just the daemon alone
11377 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
11378 access to the &_/var/pwcheck_& directory.
11379
11380 The &%pwcheck%& condition takes one argument, which must be the user name and
11381 password, separated by a colon. For example, in a LOGIN authenticator
11382 configuration, you might have this:
11383 .code
11384 server_condition = ${if pwcheck{$auth1:$auth2}}
11385 .endd
11386 Again, for a PLAIN authenticator configuration, this would be:
11387 .code
11388 server_condition = ${if pwcheck{$auth2:$auth3}}
11389 .endd
11390 .vitem &*queue_running*&
11391 .cindex "queue runner" "detecting when delivering from"
11392 .cindex "expansion" "queue runner test"
11393 .cindex "&%queue_running%& expansion condition"
11394 This condition, which has no data, is true during delivery attempts that are
11395 initiated by queue runner processes, and false otherwise.
11396
11397
11398 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
11399 .cindex "Radius"
11400 .cindex "expansion" "Radius authentication"
11401 .cindex "&%radius%& expansion condition"
11402 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
11403 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
11404 the Radius client configuration file in order to build Exim with Radius
11405 support.
11406
11407 With just that one setting, Exim expects to be linked with the &%radiusclient%&
11408 library, using the original API. If you are using release 0.4.0 or later of
11409 this library, you need to set
11410 .code
11411 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
11412 .endd
11413 in &_Local/Makefile_& when building Exim. You can also link Exim with the
11414 &%libradius%& library that comes with FreeBSD. To do this, set
11415 .code
11416 RADIUS_LIB_TYPE=RADLIB
11417 .endd
11418 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
11419 You may also have to supply a suitable setting in EXTRALIBS so that the
11420 Radius library can be found when Exim is linked.
11421
11422 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
11423 Radius client library, which calls the Radius server. The condition is true if
11424 the authentication is successful. For example:
11425 .code
11426 server_condition = ${if radius{<arguments>}}
11427 .endd
11428
11429
11430 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
11431         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
11432 .cindex "&'saslauthd'& daemon"
11433 .cindex "Cyrus"
11434 .cindex "expansion" "&'saslauthd'& authentication test"
11435 .cindex "&%saslauthd%& expansion condition"
11436 This condition supports user authentication using the Cyrus &'saslauthd'&
11437 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
11438 Using this daemon is one way of making it possible for passwords to be checked
11439 by a process that is not running as root.
11440
11441 The saslauthd support is not included in Exim by default. You need to specify
11442 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
11443 building Exim. For example:
11444 .code
11445 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
11446 .endd
11447 You do not need to install the full Cyrus software suite in order to use
11448 the saslauthd daemon. You can compile and install just the daemon alone
11449 from the Cyrus SASL library.
11450
11451 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
11452 two are mandatory. For example:
11453 .code
11454 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
11455 .endd
11456 The service and the realm are optional (which is why the arguments are enclosed
11457 in their own set of braces). For details of the meaning of the service and
11458 realm, and how to run the daemon, consult the Cyrus documentation.
11459 .endlist vlist
11460
11461
11462
11463 .section "Combining expansion conditions" "SECID84"
11464 .cindex "expansion" "combining conditions"
11465 Several conditions can be tested at once by combining them using the &%and%&
11466 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
11467 conditions on their own, and precede their lists of sub-conditions. Each
11468 sub-condition must be enclosed in braces within the overall braces that contain
11469 the list. No repetition of &%if%& is used.
11470
11471
11472 .vlist
11473 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11474 .cindex "&""or""& expansion condition"
11475 .cindex "expansion" "&""or""& of conditions"
11476 The sub-conditions are evaluated from left to right. The condition is true if
11477 any one of the sub-conditions is true.
11478 For example,
11479 .code
11480 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
11481 .endd
11482 When a true sub-condition is found, the following ones are parsed but not
11483 evaluated. If there are several &"match"& sub-conditions the values of the
11484 numeric variables afterwards are taken from the first one that succeeds.
11485
11486 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11487 .cindex "&""and""& expansion condition"
11488 .cindex "expansion" "&""and""& of conditions"
11489 The sub-conditions are evaluated from left to right. The condition is true if
11490 all of the sub-conditions are true. If there are several &"match"&
11491 sub-conditions, the values of the numeric variables afterwards are taken from
11492 the last one. When a false sub-condition is found, the following ones are
11493 parsed but not evaluated.
11494 .endlist
11495 .ecindex IIDexpcond
11496
11497
11498
11499
11500 .section "Expansion variables" "SECTexpvar"
11501 .cindex "expansion" "variables, list of"
11502 This section contains an alphabetical list of all the expansion variables. Some
11503 of them are available only when Exim is compiled with specific options such as
11504 support for TLS or the content scanning extension.
11505
11506 .vlist
11507 .vitem "&$0$&, &$1$&, etc"
11508 .cindex "numerical variables (&$1$& &$2$& etc)"
11509 When a &%match%& expansion condition succeeds, these variables contain the
11510 captured substrings identified by the regular expression during subsequent
11511 processing of the success string of the containing &%if%& expansion item.
11512 In the expansion condition case
11513 they do not retain their values afterwards; in fact, their previous
11514 values are restored at the end of processing an &%if%& item. The numerical
11515 variables may also be set externally by some other matching process which
11516 precedes the expansion of the string. For example, the commands available in
11517 Exim filter files include an &%if%& command with its own regular expression
11518 matching condition.
11519
11520 .vitem "&$acl_arg1$&, &$acl_arg2$&, etc"
11521 Within an acl condition, expansion condition or expansion item
11522 any arguments are copied to these variables,
11523 any unused variables being made empty.
11524
11525 .vitem "&$acl_c...$&"
11526 Values can be placed in these variables by the &%set%& modifier in an ACL. They
11527 can be given any name that starts with &$acl_c$& and is at least six characters
11528 long, but the sixth character must be either a digit or an underscore. For
11529 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
11530 variables persist throughout the lifetime of an SMTP connection. They can be
11531 used to pass information between ACLs and between different invocations of the
11532 same ACL. When a message is received, the values of these variables are saved
11533 with the message, and can be accessed by filters, routers, and transports
11534 during subsequent delivery.
11535
11536 .vitem "&$acl_m...$&"
11537 These variables are like the &$acl_c...$& variables, except that their values
11538 are reset after a message has been received. Thus, if several messages are
11539 received in one SMTP connection, &$acl_m...$& values are not passed on from one
11540 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
11541 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
11542 message is received, the values of these variables are saved with the message,
11543 and can be accessed by filters, routers, and transports during subsequent
11544 delivery.
11545
11546 .vitem &$acl_narg$&
11547 Within an acl condition, expansion condition or expansion item
11548 this variable has the number of arguments.
11549
11550 .vitem &$acl_verify_message$&
11551 .vindex "&$acl_verify_message$&"
11552 After an address verification has failed, this variable contains the failure
11553 message. It retains its value for use in subsequent modifiers. The message can
11554 be preserved by coding like this:
11555 .code
11556 warn !verify = sender
11557      set acl_m0 = $acl_verify_message
11558 .endd
11559 You can use &$acl_verify_message$& during the expansion of the &%message%& or
11560 &%log_message%& modifiers, to include information about the verification
11561 failure.
11562
11563 .vitem &$address_data$&
11564 .vindex "&$address_data$&"
11565 This variable is set by means of the &%address_data%& option in routers. The
11566 value then remains with the address while it is processed by subsequent routers
11567 and eventually a transport. If the transport is handling multiple addresses,
11568 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
11569 for more details. &*Note*&: The contents of &$address_data$& are visible in
11570 user filter files.
11571
11572 If &$address_data$& is set when the routers are called from an ACL to verify
11573 a recipient address, the final value is still in the variable for subsequent
11574 conditions and modifiers of the ACL statement. If routing the address caused it
11575 to be redirected to just one address, the child address is also routed as part
11576 of the verification, and in this case the final value of &$address_data$& is
11577 from the child's routing.
11578
11579 If &$address_data$& is set when the routers are called from an ACL to verify a
11580 sender address, the final value is also preserved, but this time in
11581 &$sender_address_data$&, to distinguish it from data from a recipient
11582 address.
11583
11584 In both cases (recipient and sender verification), the value does not persist
11585 after the end of the current ACL statement. If you want to preserve
11586 these values for longer, you can save them in ACL variables.
11587
11588 .vitem &$address_file$&
11589 .vindex "&$address_file$&"
11590 When, as a result of aliasing, forwarding, or filtering, a message is directed
11591 to a specific file, this variable holds the name of the file when the transport
11592 is running. At other times, the variable is empty. For example, using the
11593 default configuration, if user &%r2d2%& has a &_.forward_& file containing
11594 .code
11595 /home/r2d2/savemail
11596 .endd
11597 then when the &(address_file)& transport is running, &$address_file$&
11598 contains the text string &`/home/r2d2/savemail`&.
11599 .cindex "Sieve filter" "value of &$address_file$&"
11600 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
11601 then up to the transport configuration to generate an appropriate absolute path
11602 to the relevant file.
11603
11604 .vitem &$address_pipe$&
11605 .vindex "&$address_pipe$&"
11606 When, as a result of aliasing or forwarding, a message is directed to a pipe,
11607 this variable holds the pipe command when the transport is running.
11608
11609 .vitem "&$auth1$& &-- &$auth3$&"
11610 .vindex "&$auth1$&, &$auth2$&, etc"
11611 These variables are used in SMTP authenticators (see chapters
11612 &<<CHAPplaintext>>&&--&<<CHAPtlsauth>>&). Elsewhere, they are empty.
11613
11614 .vitem &$authenticated_id$&
11615 .cindex "authentication" "id"
11616 .vindex "&$authenticated_id$&"
11617 When a server successfully authenticates a client it may be configured to
11618 preserve some of the authentication information in the variable
11619 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
11620 user/password authenticator configuration might preserve the user name for use
11621 in the routers. Note that this is not the same information that is saved in
11622 &$sender_host_authenticated$&.
11623
11624 When a message is submitted locally (that is, not over a TCP connection)
11625 the value of &$authenticated_id$& is normally the login name of the calling
11626 process. However, a trusted user can override this by means of the &%-oMai%&
11627 command line option.
11628 .new
11629 This second case also sets up inforamtion used by the
11630 &$authresults$& expansion item.
11631 .wen
11632
11633 .vitem &$authenticated_fail_id$&
11634 .cindex "authentication" "fail" "id"
11635 .vindex "&$authenticated_fail_id$&"
11636 When an authentication attempt fails, the variable &$authenticated_fail_id$&
11637 will contain the failed authentication id. If more than one authentication
11638 id is attempted, it will contain only the last one. The variable is
11639 available for processing in the ACL's, generally the quit or notquit ACL.
11640 A message to a local recipient could still be accepted without requiring
11641 authentication, which means this variable could also be visible in all of
11642 the ACL's as well.
11643
11644
11645 .vitem &$authenticated_sender$&
11646 .cindex "sender" "authenticated"
11647 .cindex "authentication" "sender"
11648 .cindex "AUTH" "on MAIL command"
11649 .vindex "&$authenticated_sender$&"
11650 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
11651 SMTP MAIL command if it believes the sender is sufficiently trusted, as
11652 described in section &<<SECTauthparamail>>&. Unless the data is the string
11653 &"<>"&, it is set as the authenticated sender of the message, and the value is
11654 available during delivery in the &$authenticated_sender$& variable. If the
11655 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
11656
11657 .vindex "&$qualify_domain$&"
11658 When a message is submitted locally (that is, not over a TCP connection), the
11659 value of &$authenticated_sender$& is an address constructed from the login
11660 name of the calling process and &$qualify_domain$&, except that a trusted user
11661 can override this by means of the &%-oMas%& command line option.
11662
11663
11664 .vitem &$authentication_failed$&
11665 .cindex "authentication" "failure"
11666 .vindex "&$authentication_failed$&"
11667 This variable is set to &"1"& in an Exim server if a client issues an AUTH
11668 command that does not succeed. Otherwise it is set to &"0"&. This makes it
11669 possible to distinguish between &"did not try to authenticate"&
11670 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
11671 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
11672 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
11673 negative response to an AUTH command, including (for example) an attempt to use
11674 an undefined mechanism.
11675
11676 .vitem &$av_failed$&
11677 .cindex "content scanning" "AV scanner failure"
11678 This variable is available when Exim is compiled with the content-scanning
11679 extension. It is set to &"0"& by default, but will be set to &"1"& if any
11680 problem occurs with the virus scanner (specified by &%av_scanner%&) during
11681 the ACL malware condition.
11682
11683 .vitem &$body_linecount$&
11684 .cindex "message body" "line count"
11685 .cindex "body of message" "line count"
11686 .vindex "&$body_linecount$&"
11687 When a message is being received or delivered, this variable contains the
11688 number of lines in the message's body. See also &$message_linecount$&.
11689
11690 .vitem &$body_zerocount$&
11691 .cindex "message body" "binary zero count"
11692 .cindex "body of message" "binary zero count"
11693 .cindex "binary zero" "in message body"
11694 .vindex "&$body_zerocount$&"
11695 When a message is being received or delivered, this variable contains the
11696 number of binary zero bytes (ASCII NULs) in the message's body.
11697
11698 .vitem &$bounce_recipient$&
11699 .vindex "&$bounce_recipient$&"
11700 This is set to the recipient address of a bounce message while Exim is creating
11701 it. It is useful if a customized bounce message text file is in use (see
11702 chapter &<<CHAPemsgcust>>&).
11703
11704 .vitem &$bounce_return_size_limit$&
11705 .vindex "&$bounce_return_size_limit$&"
11706 This contains the value set in the &%bounce_return_size_limit%& option, rounded
11707 up to a multiple of 1000. It is useful when a customized error message text
11708 file is in use (see chapter &<<CHAPemsgcust>>&).
11709
11710 .vitem &$caller_gid$&
11711 .cindex "gid (group id)" "caller"
11712 .vindex "&$caller_gid$&"
11713 The real group id under which the process that called Exim was running. This is
11714 not the same as the group id of the originator of a message (see
11715 &$originator_gid$&). If Exim re-execs itself, this variable in the new
11716 incarnation normally contains the Exim gid.
11717
11718 .vitem &$caller_uid$&
11719 .cindex "uid (user id)" "caller"
11720 .vindex "&$caller_uid$&"
11721 The real user id under which the process that called Exim was running. This is
11722 not the same as the user id of the originator of a message (see
11723 &$originator_uid$&). If Exim re-execs itself, this variable in the new
11724 incarnation normally contains the Exim uid.
11725
11726 .vitem &$callout_address$&
11727 .vindex "&$callout_address$&"
11728 After a callout for verification, spamd or malware daemon service, the
11729 address that was connected to.
11730
11731 .vitem &$compile_number$&
11732 .vindex "&$compile_number$&"
11733 The building process for Exim keeps a count of the number
11734 of times it has been compiled. This serves to distinguish different
11735 compilations of the same version of the program.
11736
11737 .vitem &$config_dir$&
11738 .vindex "&$config_dir$&"
11739 The directory name of the main configuration file. That is, the content of
11740 &$config_file$& with the last component stripped. The value does not
11741 contain the trailing slash. If &$config_file$& does not contain a slash,
11742 &$config_dir$& is ".".
11743
11744 .vitem &$config_file$&
11745 .vindex "&$config_file$&"
11746 The name of the main configuration file Exim is using.
11747
11748 .vitem &$dkim_verify_status$&
11749 Results of DKIM verification.
11750 For details see section &<<SECDKIMVFY>>&.
11751
11752 .vitem &$dkim_cur_signer$& &&&
11753        &$dkim_verify_reason$& &&&
11754        &$dkim_domain$& &&&
11755        &$dkim_identity$& &&&
11756        &$dkim_selector$& &&&
11757        &$dkim_algo$& &&&
11758        &$dkim_canon_body$& &&&
11759        &$dkim_canon_headers$& &&&
11760        &$dkim_copiedheaders$& &&&
11761        &$dkim_bodylength$& &&&
11762        &$dkim_created$& &&&
11763        &$dkim_expires$& &&&
11764        &$dkim_headernames$& &&&
11765        &$dkim_key_testing$& &&&
11766        &$dkim_key_nosubdomains$& &&&
11767        &$dkim_key_srvtype$& &&&
11768        &$dkim_key_granularity$& &&&
11769        &$dkim_key_notes$& &&&
11770        &$dkim_key_length$&
11771 These variables are only available within the DKIM ACL.
11772 For details see section &<<SECDKIMVFY>>&.
11773
11774 .vitem &$dkim_signers$&
11775 .vindex &$dkim_signers$&
11776 When a message has been received this variable contains
11777 a colon-separated list of signer domains and identities for the message.
11778 For details see section &<<SECDKIMVFY>>&.
11779
11780 .vitem &$dnslist_domain$& &&&
11781        &$dnslist_matched$& &&&
11782        &$dnslist_text$& &&&
11783        &$dnslist_value$&
11784 .vindex "&$dnslist_domain$&"
11785 .vindex "&$dnslist_matched$&"
11786 .vindex "&$dnslist_text$&"
11787 .vindex "&$dnslist_value$&"
11788 .cindex "black list (DNS)"
11789 When a DNS (black) list lookup succeeds, these variables are set to contain
11790 the following data from the lookup: the list's domain name, the key that was
11791 looked up, the contents of any associated TXT record, and the value from the
11792 main A record. See section &<<SECID204>>& for more details.
11793
11794 .vitem &$domain$&
11795 .vindex "&$domain$&"
11796 When an address is being routed, or delivered on its own, this variable
11797 contains the domain. Uppercase letters in the domain are converted into lower
11798 case for &$domain$&.
11799
11800 Global address rewriting happens when a message is received, so the value of
11801 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
11802 is set during user filtering, but not during system filtering, because a
11803 message may have many recipients and the system filter is called just once.
11804
11805 When more than one address is being delivered at once (for example, several
11806 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
11807 have the same domain. Transports can be restricted to handling only one domain
11808 at a time if the value of &$domain$& is required at transport time &-- this is
11809 the default for local transports. For further details of the environment in
11810 which local transports are run, see chapter &<<CHAPenvironment>>&.
11811
11812 .oindex "&%delay_warning_condition%&"
11813 At the end of a delivery, if all deferred addresses have the same domain, it is
11814 set in &$domain$& during the expansion of &%delay_warning_condition%&.
11815
11816 The &$domain$& variable is also used in some other circumstances:
11817
11818 .ilist
11819 When an ACL is running for a RCPT command, &$domain$& contains the domain of
11820 the recipient address. The domain of the &'sender'& address is in
11821 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
11822 normally set during the running of the MAIL ACL. However, if the sender address
11823 is verified with a callout during the MAIL ACL, the sender domain is placed in
11824 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
11825 the &(smtp)& transport.
11826
11827 .next
11828 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11829 &$domain$& contains the domain portion of the address that is being rewritten;
11830 it can be used in the expansion of the replacement address, for example, to
11831 rewrite domains by file lookup.
11832
11833 .next
11834 With one important exception, whenever a domain list is being scanned,
11835 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
11836 a &%sender_domains%& condition in an ACL is being processed, the subject domain
11837 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
11838 that, in a RCPT ACL, the sender domain list can be dependent on the
11839 recipient domain (which is what is in &$domain$& at this time).
11840
11841 .next
11842 .cindex "ETRN" "value of &$domain$&"
11843 .oindex "&%smtp_etrn_command%&"
11844 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
11845 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
11846 .endlist
11847
11848
11849 .vitem &$domain_data$&
11850 .vindex "&$domain_data$&"
11851 When the &%domains%& option on a router matches a domain by
11852 means of a lookup, the data read by the lookup is available during the running
11853 of the router as &$domain_data$&. In addition, if the driver routes the
11854 address to a transport, the value is available in that transport. If the
11855 transport is handling multiple addresses, the value from the first address is
11856 used.
11857
11858 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
11859 domain by means of a lookup. The data read by the lookup is available during
11860 the rest of the ACL statement. In all other situations, this variable expands
11861 to nothing.
11862
11863 .vitem &$exim_gid$&
11864 .vindex "&$exim_gid$&"
11865 This variable contains the numerical value of the Exim group id.
11866
11867 .vitem &$exim_path$&
11868 .vindex "&$exim_path$&"
11869 This variable contains the path to the Exim binary.
11870
11871 .vitem &$exim_uid$&
11872 .vindex "&$exim_uid$&"
11873 This variable contains the numerical value of the Exim user id.
11874
11875 .vitem &$exim_version$&
11876 .vindex "&$exim_version$&"
11877 This variable contains the version string of the Exim build.
11878 The first character is a major version number, currently 4.
11879 Then after a dot, the next group of digits is a minor version number.
11880 There may be other characters following the minor version.
11881
11882 .vitem &$header_$&<&'name'&>
11883 This is not strictly an expansion variable. It is expansion syntax for
11884 inserting the message header line with the given name. Note that the name must
11885 be terminated by colon or white space, because it may contain a wide variety of
11886 characters. Note also that braces must &'not'& be used.
11887
11888 .vitem &$headers_added$&
11889 .vindex "&$headers_added$&"
11890 Within an ACL this variable contains the headers added so far by
11891 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
11892 The headers are a newline-separated list.
11893
11894 .vitem &$home$&
11895 .vindex "&$home$&"
11896 When the &%check_local_user%& option is set for a router, the user's home
11897 directory is placed in &$home$& when the check succeeds. In particular, this
11898 means it is set during the running of users' filter files. A router may also
11899 explicitly set a home directory for use by a transport; this can be overridden
11900 by a setting on the transport itself.
11901
11902 When running a filter test via the &%-bf%& option, &$home$& is set to the value
11903 of the environment variable HOME, which is subject to the
11904 &%keep_environment%& and &%add_environment%& main config options.
11905
11906 .vitem &$host$&
11907 .vindex "&$host$&"
11908 If a router assigns an address to a transport (any transport), and passes a
11909 list of hosts with the address, the value of &$host$& when the transport starts
11910 to run is the name of the first host on the list. Note that this applies both
11911 to local and remote transports.
11912
11913 .cindex "transport" "filter"
11914 .cindex "filter" "transport filter"
11915 For the &(smtp)& transport, if there is more than one host, the value of
11916 &$host$& changes as the transport works its way through the list. In
11917 particular, when the &(smtp)& transport is expanding its options for encryption
11918 using TLS, or for specifying a transport filter (see chapter
11919 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
11920 is connected.
11921
11922 When used in the client part of an authenticator configuration (see chapter
11923 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
11924 client is connected.
11925
11926
11927 .vitem &$host_address$&
11928 .vindex "&$host_address$&"
11929 This variable is set to the remote host's IP address whenever &$host$& is set
11930 for a remote connection. It is also set to the IP address that is being checked
11931 when the &%ignore_target_hosts%& option is being processed.
11932
11933 .vitem &$host_data$&
11934 .vindex "&$host_data$&"
11935 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
11936 result of the lookup is made available in the &$host_data$& variable. This
11937 allows you, for example, to do things like this:
11938 .code
11939 deny  hosts = net-lsearch;/some/file
11940 message = $host_data
11941 .endd
11942 .vitem &$host_lookup_deferred$&
11943 .cindex "host name" "lookup, failure of"
11944 .vindex "&$host_lookup_deferred$&"
11945 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
11946 message comes from a remote host and there is an attempt to look up the host's
11947 name from its IP address, and the attempt is not successful, one of these
11948 variables is set to &"1"&.
11949
11950 .ilist
11951 If the lookup receives a definite negative response (for example, a DNS lookup
11952 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
11953
11954 .next
11955 If there is any kind of problem during the lookup, such that Exim cannot
11956 tell whether or not the host name is defined (for example, a timeout for a DNS
11957 lookup), &$host_lookup_deferred$& is set to &"1"&.
11958 .endlist ilist
11959
11960 Looking up a host's name from its IP address consists of more than just a
11961 single reverse lookup. Exim checks that a forward lookup of at least one of the
11962 names it receives from a reverse lookup yields the original IP address. If this
11963 is not the case, Exim does not accept the looked up name(s), and
11964 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
11965 IP address (for example, the existence of a PTR record in the DNS) is not
11966 sufficient on its own for the success of a host name lookup. If the reverse
11967 lookup succeeds, but there is a lookup problem such as a timeout when checking
11968 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
11969 &"1"&. See also &$sender_host_name$&.
11970
11971 .new
11972 .cindex authentication "expansion item"
11973 Performing these checks sets up information used by the
11974 &$authresults$& expansion item.
11975 .wen
11976
11977
11978 .vitem &$host_lookup_failed$&
11979 .vindex "&$host_lookup_failed$&"
11980 See &$host_lookup_deferred$&.
11981
11982 .vitem &$host_port$&
11983 .vindex "&$host_port$&"
11984 This variable is set to the remote host's TCP port whenever &$host$& is set
11985 for an outbound connection.
11986
11987 .vitem &$initial_cwd$&
11988 .vindex "&$initial_cwd$&
11989 This variable contains the full path name of the initial working
11990 directory of the current Exim process. This may differ from the current
11991 working directory, as Exim changes this to "/" during early startup, and
11992 to &$spool_directory$& later.
11993
11994 .vitem &$inode$&
11995 .vindex "&$inode$&"
11996 The only time this variable is set is while expanding the &%directory_file%&
11997 option in the &(appendfile)& transport. The variable contains the inode number
11998 of the temporary file which is about to be renamed. It can be used to construct
11999 a unique name for the file.
12000
12001 .vitem &$interface_address$&
12002 .vindex "&$interface_address$&"
12003 This is an obsolete name for &$received_ip_address$&.
12004
12005 .vitem &$interface_port$&
12006 .vindex "&$interface_port$&"
12007 This is an obsolete name for &$received_port$&.
12008
12009 .vitem &$item$&
12010 .vindex "&$item$&"
12011 This variable is used during the expansion of &*forall*& and &*forany*&
12012 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
12013 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
12014 empty.
12015
12016 .vitem &$ldap_dn$&
12017 .vindex "&$ldap_dn$&"
12018 This variable, which is available only when Exim is compiled with LDAP support,
12019 contains the DN from the last entry in the most recently successful LDAP
12020 lookup.
12021
12022 .vitem &$load_average$&
12023 .vindex "&$load_average$&"
12024 This variable contains the system load average, multiplied by 1000 so that it
12025 is an integer. For example, if the load average is 0.21, the value of the
12026 variable is 210. The value is recomputed every time the variable is referenced.
12027
12028 .vitem &$local_part$&
12029 .vindex "&$local_part$&"
12030 When an address is being routed, or delivered on its own, this
12031 variable contains the local part. When a number of addresses are being
12032 delivered together (for example, multiple RCPT commands in an SMTP
12033 session), &$local_part$& is not set.
12034
12035 Global address rewriting happens when a message is received, so the value of
12036 &$local_part$& during routing and delivery is the value after rewriting.
12037 &$local_part$& is set during user filtering, but not during system filtering,
12038 because a message may have many recipients and the system filter is called just
12039 once.
12040
12041 .vindex "&$local_part_prefix$&"
12042 .vindex "&$local_part_suffix$&"
12043 If a local part prefix or suffix has been recognized, it is not included in the
12044 value of &$local_part$& during routing and subsequent delivery. The values of
12045 any prefix or suffix are in &$local_part_prefix$& and
12046 &$local_part_suffix$&, respectively.
12047
12048 When a message is being delivered to a file, pipe, or autoreply transport as a
12049 result of aliasing or forwarding, &$local_part$& is set to the local part of
12050 the parent address, not to the file name or command (see &$address_file$& and
12051 &$address_pipe$&).
12052
12053 When an ACL is running for a RCPT command, &$local_part$& contains the
12054 local part of the recipient address.
12055
12056 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12057 &$local_part$& contains the local part of the address that is being rewritten;
12058 it can be used in the expansion of the replacement address, for example.
12059
12060 In all cases, all quoting is removed from the local part. For example, for both
12061 the addresses
12062 .code
12063 "abc:xyz"@test.example
12064 abc\:xyz@test.example
12065 .endd
12066 the value of &$local_part$& is
12067 .code
12068 abc:xyz
12069 .endd
12070 If you use &$local_part$& to create another address, you should always wrap it
12071 inside a quoting operator. For example, in a &(redirect)& router you could
12072 have:
12073 .code
12074 data = ${quote_local_part:$local_part}@new.domain.example
12075 .endd
12076 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
12077 to process local parts in a case-dependent manner in a router, you can set the
12078 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
12079
12080 .vitem &$local_part_data$&
12081 .vindex "&$local_part_data$&"
12082 When the &%local_parts%& option on a router matches a local part by means of a
12083 lookup, the data read by the lookup is available during the running of the
12084 router as &$local_part_data$&. In addition, if the driver routes the address
12085 to a transport, the value is available in that transport. If the transport is
12086 handling multiple addresses, the value from the first address is used.
12087
12088 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
12089 matches a local part by means of a lookup. The data read by the lookup is
12090 available during the rest of the ACL statement. In all other situations, this
12091 variable expands to nothing.
12092
12093 .vitem &$local_part_prefix$&
12094 .vindex "&$local_part_prefix$&"
12095 When an address is being routed or delivered, and a
12096 specific prefix for the local part was recognized, it is available in this
12097 variable, having been removed from &$local_part$&.
12098
12099 .vitem &$local_part_suffix$&
12100 .vindex "&$local_part_suffix$&"
12101 When an address is being routed or delivered, and a
12102 specific suffix for the local part was recognized, it is available in this
12103 variable, having been removed from &$local_part$&.
12104
12105 .vitem &$local_scan_data$&
12106 .vindex "&$local_scan_data$&"
12107 This variable contains the text returned by the &[local_scan()]& function when
12108 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
12109
12110 .vitem &$local_user_gid$&
12111 .vindex "&$local_user_gid$&"
12112 See &$local_user_uid$&.
12113
12114 .vitem &$local_user_uid$&
12115 .vindex "&$local_user_uid$&"
12116 This variable and &$local_user_gid$& are set to the uid and gid after the
12117 &%check_local_user%& router precondition succeeds. This means that their values
12118 are available for the remaining preconditions (&%senders%&, &%require_files%&,
12119 and &%condition%&), for the &%address_data%& expansion, and for any
12120 router-specific expansions. At all other times, the values in these variables
12121 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
12122
12123 .vitem &$localhost_number$&
12124 .vindex "&$localhost_number$&"
12125 This contains the expanded value of the
12126 &%localhost_number%& option. The expansion happens after the main options have
12127 been read.
12128
12129 .vitem &$log_inodes$&
12130 .vindex "&$log_inodes$&"
12131 The number of free inodes in the disk partition where Exim's
12132 log files are being written. The value is recalculated whenever the variable is
12133 referenced. If the relevant file system does not have the concept of inodes,
12134 the value of is -1. See also the &%check_log_inodes%& option.
12135
12136 .vitem &$log_space$&
12137 .vindex "&$log_space$&"
12138 The amount of free space (as a number of kilobytes) in the disk
12139 partition where Exim's log files are being written. The value is recalculated
12140 whenever the variable is referenced. If the operating system does not have the
12141 ability to find the amount of free space (only true for experimental systems),
12142 the space value is -1. See also the &%check_log_space%& option.
12143
12144
12145 .vitem &$lookup_dnssec_authenticated$&
12146 .vindex "&$lookup_dnssec_authenticated$&"
12147 This variable is set after a DNS lookup done by
12148 a dnsdb lookup expansion, dnslookup router or smtp transport.
12149 .cindex "DNS" "DNSSEC"
12150 It will be empty if &(DNSSEC)& was not requested,
12151 &"no"& if the result was not labelled as authenticated data
12152 and &"yes"& if it was.
12153 Results that are labelled as authoritative answer that match
12154 the &%dns_trust_aa%& configuration variable count also
12155 as authenticated data.
12156
12157 .vitem &$mailstore_basename$&
12158 .vindex "&$mailstore_basename$&"
12159 This variable is set only when doing deliveries in &"mailstore"& format in the
12160 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
12161 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
12162 contains the basename of the files that are being written, that is, the name
12163 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
12164 variable is empty.
12165
12166 .vitem &$malware_name$&
12167 .vindex "&$malware_name$&"
12168 This variable is available when Exim is compiled with the
12169 content-scanning extension. It is set to the name of the virus that was found
12170 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
12171
12172 .vitem &$max_received_linelength$&
12173 .vindex "&$max_received_linelength$&"
12174 .cindex "maximum" "line length"
12175 .cindex "line length" "maximum"
12176 This variable contains the number of bytes in the longest line that was
12177 received as part of the message, not counting the line termination
12178 character(s).
12179 It is not valid if the &%spool_files_wireformat%& option is used.
12180
12181 .vitem &$message_age$&
12182 .cindex "message" "age of"
12183 .vindex "&$message_age$&"
12184 This variable is set at the start of a delivery attempt to contain the number
12185 of seconds since the message was received. It does not change during a single
12186 delivery attempt.
12187
12188 .vitem &$message_body$&
12189 .cindex "body of message" "expansion variable"
12190 .cindex "message body" "in expansion"
12191 .cindex "binary zero" "in message body"
12192 .vindex "&$message_body$&"
12193 .oindex "&%message_body_visible%&"
12194 This variable contains the initial portion of a message's body while it is
12195 being delivered, and is intended mainly for use in filter files. The maximum
12196 number of characters of the body that are put into the variable is set by the
12197 &%message_body_visible%& configuration option; the default is 500.
12198
12199 .oindex "&%message_body_newlines%&"
12200 By default, newlines are converted into spaces in &$message_body$&, to make it
12201 easier to search for phrases that might be split over a line break. However,
12202 this can be disabled by setting &%message_body_newlines%& to be true. Binary
12203 zeros are always converted into spaces.
12204
12205 .vitem &$message_body_end$&
12206 .cindex "body of message" "expansion variable"
12207 .cindex "message body" "in expansion"
12208 .vindex "&$message_body_end$&"
12209 This variable contains the final portion of a message's
12210 body while it is being delivered. The format and maximum size are as for
12211 &$message_body$&.
12212
12213 .vitem &$message_body_size$&
12214 .cindex "body of message" "size"
12215 .cindex "message body" "size"
12216 .vindex "&$message_body_size$&"
12217 When a message is being delivered, this variable contains the size of the body
12218 in bytes. The count starts from the character after the blank line that
12219 separates the body from the header. Newlines are included in the count. See
12220 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
12221
12222 If the spool file is wireformat
12223 (see the &%spool_files_wireformat%& main option)
12224 the CRLF line-terminators are included in the count.
12225
12226 .vitem &$message_exim_id$&
12227 .vindex "&$message_exim_id$&"
12228 When a message is being received or delivered, this variable contains the
12229 unique message id that is generated and used by Exim to identify the message.
12230 An id is not created for a message until after its header has been successfully
12231 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
12232 line; it is the local id that Exim assigns to the message, for example:
12233 &`1BXTIK-0001yO-VA`&.
12234
12235 .vitem &$message_headers$&
12236 .vindex &$message_headers$&
12237 This variable contains a concatenation of all the header lines when a message
12238 is being processed, except for lines added by routers or transports. The header
12239 lines are separated by newline characters. Their contents are decoded in the
12240 same way as a header line that is inserted by &%bheader%&.
12241
12242 .vitem &$message_headers_raw$&
12243 .vindex &$message_headers_raw$&
12244 This variable is like &$message_headers$& except that no processing of the
12245 contents of header lines is done.
12246
12247 .vitem &$message_id$&
12248 This is an old name for &$message_exim_id$&. It is now deprecated.
12249
12250 .vitem &$message_linecount$&
12251 .vindex "&$message_linecount$&"
12252 This variable contains the total number of lines in the header and body of the
12253 message. Compare &$body_linecount$&, which is the count for the body only.
12254 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
12255 number of lines received. Before delivery happens (that is, before filters,
12256 routers, and transports run) the count is increased to include the
12257 &'Received:'& header line that Exim standardly adds, and also any other header
12258 lines that are added by ACLs. The blank line that separates the message header
12259 from the body is not counted.
12260
12261 As with the special case of &$message_size$&, during the expansion of the
12262 appendfile transport's maildir_tag option in maildir format, the value of
12263 &$message_linecount$& is the precise size of the number of newlines in the
12264 file that has been written (minus one for the blank line between the
12265 header and the body).
12266
12267 Here is an example of the use of this variable in a DATA ACL:
12268 .code
12269 deny message   = Too many lines in message header
12270      condition = \
12271       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
12272 .endd
12273 In the MAIL and RCPT ACLs, the value is zero because at that stage the
12274 message has not yet been received.
12275
12276 This variable is not valid if the &%spool_files_wireformat%& option is used.
12277
12278 .vitem &$message_size$&
12279 .cindex "size" "of message"
12280 .cindex "message" "size"
12281 .vindex "&$message_size$&"
12282 When a message is being processed, this variable contains its size in bytes. In
12283 most cases, the size includes those headers that were received with the
12284 message, but not those (such as &'Envelope-to:'&) that are added to individual
12285 deliveries as they are written. However, there is one special case: during the
12286 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
12287 doing a delivery in maildir format, the value of &$message_size$& is the
12288 precise size of the file that has been written. See also
12289 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
12290
12291 .cindex "RCPT" "value of &$message_size$&"
12292 While running a per message ACL (mail/rcpt/predata), &$message_size$&
12293 contains the size supplied on the MAIL command, or -1 if no size was given. The
12294 value may not, of course, be truthful.
12295
12296 .vitem &$mime_$&&'xxx'&
12297 A number of variables whose names start with &$mime$& are
12298 available when Exim is compiled with the content-scanning extension. For
12299 details, see section &<<SECTscanmimepart>>&.
12300
12301 .vitem "&$n0$& &-- &$n9$&"
12302 These variables are counters that can be incremented by means
12303 of the &%add%& command in filter files.
12304
12305 .vitem &$original_domain$&
12306 .vindex "&$domain$&"
12307 .vindex "&$original_domain$&"
12308 When a top-level address is being processed for delivery, this contains the
12309 same value as &$domain$&. However, if a &"child"& address (for example,
12310 generated by an alias, forward, or filter file) is being processed, this
12311 variable contains the domain of the original address (lower cased). This
12312 differs from &$parent_domain$& only when there is more than one level of
12313 aliasing or forwarding. When more than one address is being delivered in a
12314 single transport run, &$original_domain$& is not set.
12315
12316 If a new address is created by means of a &%deliver%& command in a system
12317 filter, it is set up with an artificial &"parent"& address. This has the local
12318 part &'system-filter'& and the default qualify domain.
12319
12320 .vitem &$original_local_part$&
12321 .vindex "&$local_part$&"
12322 .vindex "&$original_local_part$&"
12323 When a top-level address is being processed for delivery, this contains the
12324 same value as &$local_part$&, unless a prefix or suffix was removed from the
12325 local part, because &$original_local_part$& always contains the full local
12326 part. When a &"child"& address (for example, generated by an alias, forward, or
12327 filter file) is being processed, this variable contains the full local part of
12328 the original address.
12329
12330 If the router that did the redirection processed the local part
12331 case-insensitively, the value in &$original_local_part$& is in lower case.
12332 This variable differs from &$parent_local_part$& only when there is more than
12333 one level of aliasing or forwarding. When more than one address is being
12334 delivered in a single transport run, &$original_local_part$& is not set.
12335
12336 If a new address is created by means of a &%deliver%& command in a system
12337 filter, it is set up with an artificial &"parent"& address. This has the local
12338 part &'system-filter'& and the default qualify domain.
12339
12340 .vitem &$originator_gid$&
12341 .cindex "gid (group id)" "of originating user"
12342 .cindex "sender" "gid"
12343 .vindex "&$caller_gid$&"
12344 .vindex "&$originator_gid$&"
12345 This variable contains the value of &$caller_gid$& that was set when the
12346 message was received. For messages received via the command line, this is the
12347 gid of the sending user. For messages received by SMTP over TCP/IP, this is
12348 normally the gid of the Exim user.
12349
12350 .vitem &$originator_uid$&
12351 .cindex "uid (user id)" "of originating user"
12352 .cindex "sender" "uid"
12353 .vindex "&$caller_uid$&"
12354 .vindex "&$originator_uid$&"
12355 The value of &$caller_uid$& that was set when the message was received. For
12356 messages received via the command line, this is the uid of the sending user.
12357 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
12358 user.
12359
12360 .vitem &$parent_domain$&
12361 .vindex "&$parent_domain$&"
12362 This variable is similar to &$original_domain$& (see
12363 above), except that it refers to the immediately preceding parent address.
12364
12365 .vitem &$parent_local_part$&
12366 .vindex "&$parent_local_part$&"
12367 This variable is similar to &$original_local_part$&
12368 (see above), except that it refers to the immediately preceding parent address.
12369
12370 .vitem &$pid$&
12371 .cindex "pid (process id)" "of current process"
12372 .vindex "&$pid$&"
12373 This variable contains the current process id.
12374
12375 .vitem &$pipe_addresses$&
12376 .cindex "filter" "transport filter"
12377 .cindex "transport" "filter"
12378 .vindex "&$pipe_addresses$&"
12379 This is not an expansion variable, but is mentioned here because the string
12380 &`$pipe_addresses`& is handled specially in the command specification for the
12381 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
12382 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
12383 It cannot be used in general expansion strings, and provokes an &"unknown
12384 variable"& error if encountered.
12385
12386 .vitem &$primary_hostname$&
12387 .vindex "&$primary_hostname$&"
12388 This variable contains the value set by &%primary_hostname%& in the
12389 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
12390 a single-component name, Exim calls &[gethostbyname()]& (or
12391 &[getipnodebyname()]& where available) in an attempt to acquire a fully
12392 qualified host name. See also &$smtp_active_hostname$&.
12393
12394
12395 .vitem &$proxy_external_address$& &&&
12396        &$proxy_external_port$& &&&
12397        &$proxy_local_address$& &&&
12398        &$proxy_local_port$& &&&
12399        &$proxy_session$&
12400 These variables are only available when built with Proxy Protocol
12401 or SOCKS5 support.
12402 For details see chapter &<<SECTproxyInbound>>&.
12403
12404 .vitem &$prdr_requested$&
12405 .cindex "PRDR" "variable for"
12406 This variable is set to &"yes"& if PRDR was requested by the client for the
12407 current message, otherwise &"no"&.
12408
12409 .vitem &$prvscheck_address$&
12410 This variable is used in conjunction with the &%prvscheck%& expansion item,
12411 which is described in sections &<<SECTexpansionitems>>& and
12412 &<<SECTverifyPRVS>>&.
12413
12414 .vitem &$prvscheck_keynum$&
12415 This variable is used in conjunction with the &%prvscheck%& expansion item,
12416 which is described in sections &<<SECTexpansionitems>>& and
12417 &<<SECTverifyPRVS>>&.
12418
12419 .vitem &$prvscheck_result$&
12420 This variable is used in conjunction with the &%prvscheck%& expansion item,
12421 which is described in sections &<<SECTexpansionitems>>& and
12422 &<<SECTverifyPRVS>>&.
12423
12424 .vitem &$qualify_domain$&
12425 .vindex "&$qualify_domain$&"
12426 The value set for the &%qualify_domain%& option in the configuration file.
12427
12428 .vitem &$qualify_recipient$&
12429 .vindex "&$qualify_recipient$&"
12430 The value set for the &%qualify_recipient%& option in the configuration file,
12431 or if not set, the value of &$qualify_domain$&.
12432
12433 .vitem &$queue_name$&
12434 .vindex &$queue_name$&
12435 .cindex "named queues"
12436 .cindex queues named
12437 The name of the spool queue in use; empty for the default queue.
12438
12439 .vitem &$rcpt_count$&
12440 .vindex "&$rcpt_count$&"
12441 When a message is being received by SMTP, this variable contains the number of
12442 RCPT commands received for the current message. If this variable is used in a
12443 RCPT ACL, its value includes the current command.
12444
12445 .vitem &$rcpt_defer_count$&
12446 .vindex "&$rcpt_defer_count$&"
12447 .cindex "4&'xx'& responses" "count of"
12448 When a message is being received by SMTP, this variable contains the number of
12449 RCPT commands in the current message that have previously been rejected with a
12450 temporary (4&'xx'&) response.
12451
12452 .vitem &$rcpt_fail_count$&
12453 .vindex "&$rcpt_fail_count$&"
12454 When a message is being received by SMTP, this variable contains the number of
12455 RCPT commands in the current message that have previously been rejected with a
12456 permanent (5&'xx'&) response.
12457
12458 .vitem &$received_count$&
12459 .vindex "&$received_count$&"
12460 This variable contains the number of &'Received:'& header lines in the message,
12461 including the one added by Exim (so its value is always greater than zero). It
12462 is available in the DATA ACL, the non-SMTP ACL, and while routing and
12463 delivering.
12464
12465 .vitem &$received_for$&
12466 .vindex "&$received_for$&"
12467 If there is only a single recipient address in an incoming message, this
12468 variable contains that address when the &'Received:'& header line is being
12469 built. The value is copied after recipient rewriting has happened, but before
12470 the &[local_scan()]& function is run.
12471
12472 .vitem &$received_ip_address$&
12473 .vindex "&$received_ip_address$&"
12474 As soon as an Exim server starts processing an incoming TCP/IP connection, this
12475 variable is set to the address of the local IP interface, and &$received_port$&
12476 is set to the local port number. (The remote IP address and port are in
12477 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
12478 the port value is -1 unless it has been set using the &%-oMi%& command line
12479 option.
12480
12481 As well as being useful in ACLs (including the &"connect"& ACL), these variable
12482 could be used, for example, to make the file name for a TLS certificate depend
12483 on which interface and/or port is being used for the incoming connection. The
12484 values of &$received_ip_address$& and &$received_port$& are saved with any
12485 messages that are received, thus making these variables available at delivery
12486 time.
12487 For outbound connections see &$sending_ip_address$&.
12488
12489 .vitem &$received_port$&
12490 .vindex "&$received_port$&"
12491 See &$received_ip_address$&.
12492
12493 .vitem &$received_protocol$&
12494 .vindex "&$received_protocol$&"
12495 When a message is being processed, this variable contains the name of the
12496 protocol by which it was received. Most of the names used by Exim are defined
12497 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
12498 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
12499 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
12500 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
12501 connection and the client was successfully authenticated.
12502
12503 Exim uses the protocol name &"smtps"& for the case when encryption is
12504 automatically set up on connection without the use of STARTTLS (see
12505 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
12506 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
12507 where the client initially uses EHLO, sets up an encrypted connection using
12508 STARTTLS, and then uses HELO afterwards.
12509
12510 The &%-oMr%& option provides a way of specifying a custom protocol name for
12511 messages that are injected locally by trusted callers. This is commonly used to
12512 identify messages that are being re-injected after some kind of scanning.
12513
12514 .vitem &$received_time$&
12515 .vindex "&$received_time$&"
12516 This variable contains the date and time when the current message was received,
12517 as a number of seconds since the start of the Unix epoch.
12518
12519 .vitem &$recipient_data$&
12520 .vindex "&$recipient_data$&"
12521 This variable is set after an indexing lookup success in an ACL &%recipients%&
12522 condition. It contains the data from the lookup, and the value remains set
12523 until the next &%recipients%& test. Thus, you can do things like this:
12524 .display
12525 &`require recipients  = cdb*@;/some/file`&
12526 &`deny    `&&'some further test involving'& &`$recipient_data`&
12527 .endd
12528 &*Warning*&: This variable is set only when a lookup is used as an indexing
12529 method in the address list, using the semicolon syntax as in the example above.
12530 The variable is not set for a lookup that is used as part of the string
12531 expansion that all such lists undergo before being interpreted.
12532
12533 .vitem &$recipient_verify_failure$&
12534 .vindex "&$recipient_verify_failure$&"
12535 In an ACL, when a recipient verification fails, this variable contains
12536 information about the failure. It is set to one of the following words:
12537
12538 .ilist
12539 &"qualify"&: The address was unqualified (no domain), and the message
12540 was neither local nor came from an exempted host.
12541
12542 .next
12543 &"route"&: Routing failed.
12544
12545 .next
12546 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
12547 or before the MAIL command (that is, on initial connection, HELO, or
12548 MAIL).
12549
12550 .next
12551 &"recipient"&: The RCPT command in a callout was rejected.
12552 .next
12553
12554 &"postmaster"&: The postmaster check in a callout was rejected.
12555 .endlist
12556
12557 The main use of this variable is expected to be to distinguish between
12558 rejections of MAIL and rejections of RCPT.
12559
12560 .vitem &$recipients$&
12561 .vindex "&$recipients$&"
12562 This variable contains a list of envelope recipients for a message. A comma and
12563 a space separate the addresses in the replacement text. However, the variable
12564 is not generally available, to prevent exposure of Bcc recipients in
12565 unprivileged users' filter files. You can use &$recipients$& only in these
12566 cases:
12567
12568 .olist
12569 In a system filter file.
12570 .next
12571 In the ACLs associated with the DATA command and with non-SMTP messages, that
12572 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
12573 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
12574 &%acl_not_smtp_mime%&.
12575 .next
12576 From within a &[local_scan()]& function.
12577 .endlist
12578
12579
12580 .vitem &$recipients_count$&
12581 .vindex "&$recipients_count$&"
12582 When a message is being processed, this variable contains the number of
12583 envelope recipients that came with the message. Duplicates are not excluded
12584 from the count. While a message is being received over SMTP, the number
12585 increases for each accepted recipient. It can be referenced in an ACL.
12586
12587
12588 .vitem &$regex_match_string$&
12589 .vindex "&$regex_match_string$&"
12590 This variable is set to contain the matching regular expression after a
12591 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
12592
12593 .vitem "&$regex1$&, &$regex2$&, etc"
12594 .cindex "regex submatch variables (&$1regex$& &$2regex$& etc)"
12595 When a &%regex%& or &%mime_regex%& ACL condition succeeds,
12596 these variables contain the
12597 captured substrings identified by the regular expression.
12598
12599
12600 .vitem &$reply_address$&
12601 .vindex "&$reply_address$&"
12602 When a message is being processed, this variable contains the contents of the
12603 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
12604 contents of the &'From:'& header line. Apart from the removal of leading
12605 white space, the value is not processed in any way. In particular, no RFC 2047
12606 decoding or character code translation takes place.
12607
12608 .vitem &$return_path$&
12609 .vindex "&$return_path$&"
12610 When a message is being delivered, this variable contains the return path &--
12611 the sender field that will be sent as part of the envelope. It is not enclosed
12612 in <> characters. At the start of routing an address, &$return_path$& has the
12613 same value as &$sender_address$&, but if, for example, an incoming message to a
12614 mailing list has been expanded by a router which specifies a different address
12615 for bounce messages, &$return_path$& subsequently contains the new bounce
12616 address, whereas &$sender_address$& always contains the original sender address
12617 that was received with the message. In other words, &$sender_address$& contains
12618 the incoming envelope sender, and &$return_path$& contains the outgoing
12619 envelope sender.
12620
12621 .vitem &$return_size_limit$&
12622 .vindex "&$return_size_limit$&"
12623 This is an obsolete name for &$bounce_return_size_limit$&.
12624
12625 .vitem &$router_name$&
12626 .cindex "router" "name"
12627 .cindex "name" "of router"
12628 .vindex "&$router_name$&"
12629 During the running of a router this variable contains its name.
12630
12631 .vitem &$runrc$&
12632 .cindex "return code" "from &%run%& expansion"
12633 .vindex "&$runrc$&"
12634 This variable contains the return code from a command that is run by the
12635 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
12636 assume the order in which option values are expanded, except for those
12637 preconditions whose order of testing is documented. Therefore, you cannot
12638 reliably expect to set &$runrc$& by the expansion of one option, and use it in
12639 another.
12640
12641 .vitem &$self_hostname$&
12642 .oindex "&%self%&" "value of host name"
12643 .vindex "&$self_hostname$&"
12644 When an address is routed to a supposedly remote host that turns out to be the
12645 local host, what happens is controlled by the &%self%& generic router option.
12646 One of its values causes the address to be passed to another router. When this
12647 happens, &$self_hostname$& is set to the name of the local host that the
12648 original router encountered. In other circumstances its contents are null.
12649
12650 .vitem &$sender_address$&
12651 .vindex "&$sender_address$&"
12652 When a message is being processed, this variable contains the sender's address
12653 that was received in the message's envelope. The case of letters in the address
12654 is retained, in both the local part and the domain. For bounce messages, the
12655 value of this variable is the empty string. See also &$return_path$&.
12656
12657 .vitem &$sender_address_data$&
12658 .vindex "&$address_data$&"
12659 .vindex "&$sender_address_data$&"
12660 If &$address_data$& is set when the routers are called from an ACL to verify a
12661 sender address, the final value is preserved in &$sender_address_data$&, to
12662 distinguish it from data from a recipient address. The value does not persist
12663 after the end of the current ACL statement. If you want to preserve it for
12664 longer, you can save it in an ACL variable.
12665
12666 .vitem &$sender_address_domain$&
12667 .vindex "&$sender_address_domain$&"
12668 The domain portion of &$sender_address$&.
12669
12670 .vitem &$sender_address_local_part$&
12671 .vindex "&$sender_address_local_part$&"
12672 The local part portion of &$sender_address$&.
12673
12674 .vitem &$sender_data$&
12675 .vindex "&$sender_data$&"
12676 This variable is set after a lookup success in an ACL &%senders%& condition or
12677 in a router &%senders%& option. It contains the data from the lookup, and the
12678 value remains set until the next &%senders%& test. Thus, you can do things like
12679 this:
12680 .display
12681 &`require senders      = cdb*@;/some/file`&
12682 &`deny    `&&'some further test involving'& &`$sender_data`&
12683 .endd
12684 &*Warning*&: This variable is set only when a lookup is used as an indexing
12685 method in the address list, using the semicolon syntax as in the example above.
12686 The variable is not set for a lookup that is used as part of the string
12687 expansion that all such lists undergo before being interpreted.
12688
12689 .vitem &$sender_fullhost$&
12690 .vindex "&$sender_fullhost$&"
12691 When a message is received from a remote host, this variable contains the host
12692 name and IP address in a single string. It ends with the IP address in square
12693 brackets, followed by a colon and a port number if the logging of ports is
12694 enabled. The format of the rest of the string depends on whether the host
12695 issued a HELO or EHLO SMTP command, and whether the host name was verified by
12696 looking up its IP address. (Looking up the IP address can be forced by the
12697 &%host_lookup%& option, independent of verification.) A plain host name at the
12698 start of the string is a verified host name; if this is not present,
12699 verification either failed or was not requested. A host name in parentheses is
12700 the argument of a HELO or EHLO command. This is omitted if it is identical to
12701 the verified host name or to the host's IP address in square brackets.
12702
12703 .vitem &$sender_helo_dnssec$&
12704 .vindex "&$sender_helo_dnssec$&"
12705 This boolean variable is true if a successful HELO verification was
12706 .cindex "DNS" "DNSSEC"
12707 done using DNS information the resolver library stated was authenticated data.
12708
12709 .vitem &$sender_helo_name$&
12710 .vindex "&$sender_helo_name$&"
12711 When a message is received from a remote host that has issued a HELO or EHLO
12712 command, the argument of that command is placed in this variable. It is also
12713 set if HELO or EHLO is used when a message is received using SMTP locally via
12714 the &%-bs%& or &%-bS%& options.
12715
12716 .vitem &$sender_host_address$&
12717 .vindex "&$sender_host_address$&"
12718 When a message is received from a remote host using SMTP,
12719 this variable contains that
12720 host's IP address. For locally non-SMTP submitted messages, it is empty.
12721
12722 .vitem &$sender_host_authenticated$&
12723 .vindex "&$sender_host_authenticated$&"
12724 This variable contains the name (not the public name) of the authenticator
12725 driver that successfully authenticated the client from which the message was
12726 received. It is empty if there was no successful authentication. See also
12727 &$authenticated_id$&.
12728
12729 .vitem &$sender_host_dnssec$&
12730 .vindex "&$sender_host_dnssec$&"
12731 If an attempt to populate &$sender_host_name$& has been made
12732 (by reference, &%hosts_lookup%& or
12733 otherwise) then this boolean will have been set true if, and only if, the
12734 resolver library states that both
12735 the reverse and forward DNS were authenticated data.  At all
12736 other times, this variable is false.
12737
12738 .cindex "DNS" "DNSSEC"
12739 It is likely that you will need to coerce DNSSEC support on in the resolver
12740 library, by setting:
12741 .code
12742 dns_dnssec_ok = 1
12743 .endd
12744
12745 Exim does not perform DNSSEC validation itself, instead leaving that to a
12746 validating resolver (e.g. unbound, or bind with suitable configuration).
12747
12748 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
12749 mechanism in the list, then this variable will be false.
12750
12751 This requires that your system resolver library support EDNS0 (and that
12752 DNSSEC flags exist in the system headers).  If the resolver silently drops
12753 all EDNS0 options, then this will have no effect.  OpenBSD's asr resolver
12754 is known to currently ignore EDNS0, documented in CAVEATS of asr_run(3).
12755
12756
12757 .vitem &$sender_host_name$&
12758 .vindex "&$sender_host_name$&"
12759 When a message is received from a remote host, this variable contains the
12760 host's name as obtained by looking up its IP address. For messages received by
12761 other means, this variable is empty.
12762
12763 .vindex "&$host_lookup_failed$&"
12764 If the host name has not previously been looked up, a reference to
12765 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
12766 A looked up name is accepted only if it leads back to the original IP address
12767 via a forward lookup. If either the reverse or the forward lookup fails to find
12768 any data, or if the forward lookup does not yield the original IP address,
12769 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
12770
12771 .vindex "&$host_lookup_deferred$&"
12772 However, if either of the lookups cannot be completed (for example, there is a
12773 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
12774 &$host_lookup_failed$& remains set to &"0"&.
12775
12776 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
12777 host name again if there is a subsequent reference to &$sender_host_name$&
12778 in the same Exim process, but it does try again if &$host_lookup_deferred$&
12779 is set to &"1"&.
12780
12781 Exim does not automatically look up every calling host's name. If you want
12782 maximum efficiency, you should arrange your configuration so that it avoids
12783 these lookups altogether. The lookup happens only if one or more of the
12784 following are true:
12785
12786 .ilist
12787 A string containing &$sender_host_name$& is expanded.
12788 .next
12789 The calling host matches the list in &%host_lookup%&. In the default
12790 configuration, this option is set to *, so it must be changed if lookups are
12791 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
12792 .next
12793 Exim needs the host name in order to test an item in a host list. The items
12794 that require this are described in sections &<<SECThoslispatnam>>& and
12795 &<<SECThoslispatnamsk>>&.
12796 .next
12797 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
12798 In this case, the host name is required to compare with the name quoted in any
12799 EHLO or HELO commands that the client issues.
12800 .next
12801 The remote host issues a EHLO or HELO command that quotes one of the
12802 domains in &%helo_lookup_domains%&. The default value of this option is
12803 . ==== As this is a nested list, any displays it contains must be indented
12804 . ==== as otherwise they are too far to the left.
12805 .code
12806   helo_lookup_domains = @ : @[]
12807 .endd
12808 which causes a lookup if a remote host (incorrectly) gives the server's name or
12809 IP address in an EHLO or HELO command.
12810 .endlist
12811
12812
12813 .vitem &$sender_host_port$&
12814 .vindex "&$sender_host_port$&"
12815 When a message is received from a remote host, this variable contains the port
12816 number that was used on the remote host.
12817
12818 .vitem &$sender_ident$&
12819 .vindex "&$sender_ident$&"
12820 When a message is received from a remote host, this variable contains the
12821 identification received in response to an RFC 1413 request. When a message has
12822 been received locally, this variable contains the login name of the user that
12823 called Exim.
12824
12825 .vitem &$sender_rate_$&&'xxx'&
12826 A number of variables whose names begin &$sender_rate_$& are set as part of the
12827 &%ratelimit%& ACL condition. Details are given in section
12828 &<<SECTratelimiting>>&.
12829
12830 .vitem &$sender_rcvhost$&
12831 .cindex "DNS" "reverse lookup"
12832 .cindex "reverse DNS lookup"
12833 .vindex "&$sender_rcvhost$&"
12834 This is provided specifically for use in &'Received:'& headers. It starts with
12835 either the verified host name (as obtained from a reverse DNS lookup) or, if
12836 there is no verified host name, the IP address in square brackets. After that
12837 there may be text in parentheses. When the first item is a verified host name,
12838 the first thing in the parentheses is the IP address in square brackets,
12839 followed by a colon and a port number if port logging is enabled. When the
12840 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
12841 the parentheses.
12842
12843 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
12844 was used and its argument was not identical to the real host name or IP
12845 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
12846 all three items are present in the parentheses, a newline and tab are inserted
12847 into the string, to improve the formatting of the &'Received:'& header.
12848
12849 .vitem &$sender_verify_failure$&
12850 .vindex "&$sender_verify_failure$&"
12851 In an ACL, when a sender verification fails, this variable contains information
12852 about the failure. The details are the same as for
12853 &$recipient_verify_failure$&.
12854
12855 .vitem &$sending_ip_address$&
12856 .vindex "&$sending_ip_address$&"
12857 This variable is set whenever an outgoing SMTP connection to another host has
12858 been set up. It contains the IP address of the local interface that is being
12859 used. This is useful if a host that has more than one IP address wants to take
12860 on different personalities depending on which one is being used. For incoming
12861 connections, see &$received_ip_address$&.
12862
12863 .vitem &$sending_port$&
12864 .vindex "&$sending_port$&"
12865 This variable is set whenever an outgoing SMTP connection to another host has
12866 been set up. It contains the local port that is being used. For incoming
12867 connections, see &$received_port$&.
12868
12869 .vitem &$smtp_active_hostname$&
12870 .vindex "&$smtp_active_hostname$&"
12871 During an incoming SMTP session, this variable contains the value of the active
12872 host name, as specified by the &%smtp_active_hostname%& option. The value of
12873 &$smtp_active_hostname$& is saved with any message that is received, so its
12874 value can be consulted during routing and delivery.
12875
12876 .vitem &$smtp_command$&
12877 .vindex "&$smtp_command$&"
12878 During the processing of an incoming SMTP command, this variable contains the
12879 entire command. This makes it possible to distinguish between HELO and EHLO in
12880 the HELO ACL, and also to distinguish between commands such as these:
12881 .code
12882 MAIL FROM:<>
12883 MAIL FROM: <>
12884 .endd
12885 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
12886 command, the address in &$smtp_command$& is the original address before any
12887 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
12888 the address after SMTP-time rewriting.
12889
12890 .vitem &$smtp_command_argument$&
12891 .cindex "SMTP" "command, argument for"
12892 .vindex "&$smtp_command_argument$&"
12893 While an ACL is running to check an SMTP command, this variable contains the
12894 argument, that is, the text that follows the command name, with leading white
12895 space removed. Following the introduction of &$smtp_command$&, this variable is
12896 somewhat redundant, but is retained for backwards compatibility.
12897
12898 .vitem &$smtp_command_history$&
12899 .cindex SMTP "command history"
12900 .vindex "&$smtp_command_history$&"
12901 A comma-separated list (with no whitespace) of the most-recent SMTP commands
12902 received, in time-order left to right.  Only a limited number of commands
12903 are remembered.
12904
12905 .vitem &$smtp_count_at_connection_start$&
12906 .vindex "&$smtp_count_at_connection_start$&"
12907 This variable is set greater than zero only in processes spawned by the Exim
12908 daemon for handling incoming SMTP connections. The name is deliberately long,
12909 in order to emphasize what the contents are. When the daemon accepts a new
12910 connection, it increments this variable. A copy of the variable is passed to
12911 the child process that handles the connection, but its value is fixed, and
12912 never changes. It is only an approximation of how many incoming connections
12913 there actually are, because many other connections may come and go while a
12914 single connection is being processed. When a child process terminates, the
12915 daemon decrements its copy of the variable.
12916
12917 .vitem "&$sn0$& &-- &$sn9$&"
12918 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
12919 that were current at the end of the system filter file. This allows a system
12920 filter file to set values that can be tested in users' filter files. For
12921 example, a system filter could set a value indicating how likely it is that a
12922 message is junk mail.
12923
12924 .vitem &$spam_$&&'xxx'&
12925 A number of variables whose names start with &$spam$& are available when Exim
12926 is compiled with the content-scanning extension. For details, see section
12927 &<<SECTscanspamass>>&.
12928
12929 .new
12930 .vitem &$spf_header_comment$& &&&
12931        &$spf_received$& &&&
12932        &$spf_result$& &&&
12933        &$spf_result_guessed$& &&&
12934        &$spf_smtp_comment$&
12935 These variables are only available if Exim is built with SPF support.
12936 For details see section &<<SECSPF>>&.
12937 .wen
12938
12939 .vitem &$spool_directory$&
12940 .vindex "&$spool_directory$&"
12941 The name of Exim's spool directory.
12942
12943 .vitem &$spool_inodes$&
12944 .vindex "&$spool_inodes$&"
12945 The number of free inodes in the disk partition where Exim's spool files are
12946 being written. The value is recalculated whenever the variable is referenced.
12947 If the relevant file system does not have the concept of inodes, the value of
12948 is -1. See also the &%check_spool_inodes%& option.
12949
12950 .vitem &$spool_space$&
12951 .vindex "&$spool_space$&"
12952 The amount of free space (as a number of kilobytes) in the disk partition where
12953 Exim's spool files are being written. The value is recalculated whenever the
12954 variable is referenced. If the operating system does not have the ability to
12955 find the amount of free space (only true for experimental systems), the space
12956 value is -1. For example, to check in an ACL that there is at least 50
12957 megabytes free on the spool, you could write:
12958 .code
12959 condition = ${if > {$spool_space}{50000}}
12960 .endd
12961 See also the &%check_spool_space%& option.
12962
12963
12964 .vitem &$thisaddress$&
12965 .vindex "&$thisaddress$&"
12966 This variable is set only during the processing of the &%foranyaddress%&
12967 command in a filter file. Its use is explained in the description of that
12968 command, which can be found in the separate document entitled &'Exim's
12969 interfaces to mail filtering'&.
12970
12971 .vitem &$tls_in_bits$&
12972 .vindex "&$tls_in_bits$&"
12973 Contains an approximation of the TLS cipher's bit-strength
12974 on the inbound connection; the meaning of
12975 this depends upon the TLS implementation used.
12976 If TLS has not been negotiated, the value will be 0.
12977 The value of this is automatically fed into the Cyrus SASL authenticator
12978 when acting as a server, to specify the "external SSF" (a SASL term).
12979
12980 The deprecated &$tls_bits$& variable refers to the inbound side
12981 except when used in the context of an outbound SMTP delivery, when it refers to
12982 the outbound.
12983
12984 .vitem &$tls_out_bits$&
12985 .vindex "&$tls_out_bits$&"
12986 Contains an approximation of the TLS cipher's bit-strength
12987 on an outbound SMTP connection; the meaning of
12988 this depends upon the TLS implementation used.
12989 If TLS has not been negotiated, the value will be 0.
12990
12991 .vitem &$tls_in_ourcert$&
12992 .vindex "&$tls_in_ourcert$&"
12993 .cindex certificate variables
12994 This variable refers to the certificate presented to the peer of an
12995 inbound connection when the message was received.
12996 It is only useful as the argument of a
12997 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12998 or a &%def%& condition.
12999
13000 &*Note*&: Under current versions of OpenSSL, when a list of more than one
13001 file is used for &%tls_certificate%&, this variable is not reliable.
13002
13003 .vitem &$tls_in_peercert$&
13004 .vindex "&$tls_in_peercert$&"
13005 This variable refers to the certificate presented by the peer of an
13006 inbound connection when the message was received.
13007 It is only useful as the argument of a
13008 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13009 or a &%def%& condition.
13010 If certificate verification fails it may refer to a failing chain element
13011 which is not the leaf.
13012
13013 .vitem &$tls_out_ourcert$&
13014 .vindex "&$tls_out_ourcert$&"
13015 This variable refers to the certificate presented to the peer of an
13016 outbound connection.  It is only useful as the argument of a
13017 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13018 or a &%def%& condition.
13019
13020 .vitem &$tls_out_peercert$&
13021 .vindex "&$tls_out_peercert$&"
13022 This variable refers to the certificate presented by the peer of an
13023 outbound connection.  It is only useful as the argument of a
13024 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13025 or a &%def%& condition.
13026 If certificate verification fails it may refer to a failing chain element
13027 which is not the leaf.
13028
13029 .vitem &$tls_in_certificate_verified$&
13030 .vindex "&$tls_in_certificate_verified$&"
13031 This variable is set to &"1"& if a TLS certificate was verified when the
13032 message was received, and &"0"& otherwise.
13033
13034 The deprecated &$tls_certificate_verified$& variable refers to the inbound side
13035 except when used in the context of an outbound SMTP delivery, when it refers to
13036 the outbound.
13037
13038 .vitem &$tls_out_certificate_verified$&
13039 .vindex "&$tls_out_certificate_verified$&"
13040 This variable is set to &"1"& if a TLS certificate was verified when an
13041 outbound SMTP connection was made,
13042 and &"0"& otherwise.
13043
13044 .vitem &$tls_in_cipher$&
13045 .vindex "&$tls_in_cipher$&"
13046 .vindex "&$tls_cipher$&"
13047 When a message is received from a remote host over an encrypted SMTP
13048 connection, this variable is set to the cipher suite that was negotiated, for
13049 example DES-CBC3-SHA. In other circumstances, in particular, for message
13050 received over unencrypted connections, the variable is empty. Testing
13051 &$tls_in_cipher$& for emptiness is one way of distinguishing between encrypted and
13052 non-encrypted connections during ACL processing.
13053
13054 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
13055 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
13056 becomes the same as &$tls_out_cipher$&.
13057
13058 .vitem &$tls_out_cipher$&
13059 .vindex "&$tls_out_cipher$&"
13060 This variable is
13061 cleared before any outgoing SMTP connection is made,
13062 and then set to the outgoing cipher suite if one is negotiated. See chapter
13063 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
13064 details of the &(smtp)& transport.
13065
13066 .vitem &$tls_out_dane$&
13067 .vindex &$tls_out_dane$&
13068 DANE active status.  See section &<<SECDANE>>&.
13069
13070 .vitem &$tls_in_ocsp$&
13071 .vindex "&$tls_in_ocsp$&"
13072 When a message is received from a remote client connection
13073 the result of any OCSP request from the client is encoded in this variable:
13074 .code
13075 0 OCSP proof was not requested (default value)
13076 1 No response to request
13077 2 Response not verified
13078 3 Verification failed
13079 4 Verification succeeded
13080 .endd
13081
13082 .vitem &$tls_out_ocsp$&
13083 .vindex "&$tls_out_ocsp$&"
13084 When a message is sent to a remote host connection
13085 the result of any OCSP request made is encoded in this variable.
13086 See &$tls_in_ocsp$& for values.
13087
13088 .vitem &$tls_in_peerdn$&
13089 .vindex "&$tls_in_peerdn$&"
13090 .vindex "&$tls_peerdn$&"
13091 .cindex certificate "extracting fields"
13092 When a message is received from a remote host over an encrypted SMTP
13093 connection, and Exim is configured to request a certificate from the client,
13094 the value of the Distinguished Name of the certificate is made available in the
13095 &$tls_in_peerdn$& during subsequent processing.
13096 If certificate verification fails it may refer to a failing chain element
13097 which is not the leaf.
13098
13099 The deprecated &$tls_peerdn$& variable refers to the inbound side
13100 except when used in the context of an outbound SMTP delivery, when it refers to
13101 the outbound.
13102
13103 .vitem &$tls_out_peerdn$&
13104 .vindex "&$tls_out_peerdn$&"
13105 When a message is being delivered to a remote host over an encrypted SMTP
13106 connection, and Exim is configured to request a certificate from the server,
13107 the value of the Distinguished Name of the certificate is made available in the
13108 &$tls_out_peerdn$& during subsequent processing.
13109 If certificate verification fails it may refer to a failing chain element
13110 which is not the leaf.
13111
13112 .vitem &$tls_in_sni$&
13113 .vindex "&$tls_in_sni$&"
13114 .vindex "&$tls_sni$&"
13115 .cindex "TLS" "Server Name Indication"
13116 When a TLS session is being established, if the client sends the Server
13117 Name Indication extension, the value will be placed in this variable.
13118 If the variable appears in &%tls_certificate%& then this option and
13119 some others, described in &<<SECTtlssni>>&,
13120 will be re-expanded early in the TLS session, to permit
13121 a different certificate to be presented (and optionally a different key to be
13122 used) to the client, based upon the value of the SNI extension.
13123
13124 The deprecated &$tls_sni$& variable refers to the inbound side
13125 except when used in the context of an outbound SMTP delivery, when it refers to
13126 the outbound.
13127
13128 .vitem &$tls_out_sni$&
13129 .vindex "&$tls_out_sni$&"
13130 .cindex "TLS" "Server Name Indication"
13131 During outbound
13132 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
13133 the transport.
13134
13135 .vitem &$tls_out_tlsa_usage$&
13136 .vindex &$tls_out_tlsa_usage$&
13137 Bitfield of TLSA record types found.  See section &<<SECDANE>>&.
13138
13139 .vitem &$tod_bsdinbox$&
13140 .vindex "&$tod_bsdinbox$&"
13141 The time of day and the date, in the format required for BSD-style mailbox
13142 files, for example: Thu Oct 17 17:14:09 1995.
13143
13144 .vitem &$tod_epoch$&
13145 .vindex "&$tod_epoch$&"
13146 The time and date as a number of seconds since the start of the Unix epoch.
13147
13148 .vitem &$tod_epoch_l$&
13149 .vindex "&$tod_epoch_l$&"
13150 The time and date as a number of microseconds since the start of the Unix epoch.
13151
13152 .vitem &$tod_full$&
13153 .vindex "&$tod_full$&"
13154 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
13155 +0100. The timezone is always given as a numerical offset from UTC, with
13156 positive values used for timezones that are ahead (east) of UTC, and negative
13157 values for those that are behind (west).
13158
13159 .vitem &$tod_log$&
13160 .vindex "&$tod_log$&"
13161 The time and date in the format used for writing Exim's log files, for example:
13162 1995-10-12 15:32:29, but without a timezone.
13163
13164 .vitem &$tod_logfile$&
13165 .vindex "&$tod_logfile$&"
13166 This variable contains the date in the format yyyymmdd. This is the format that
13167 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
13168 flag.
13169
13170 .vitem &$tod_zone$&
13171 .vindex "&$tod_zone$&"
13172 This variable contains the numerical value of the local timezone, for example:
13173 -0500.
13174
13175 .vitem &$tod_zulu$&
13176 .vindex "&$tod_zulu$&"
13177 This variable contains the UTC date and time in &"Zulu"& format, as specified
13178 by ISO 8601, for example: 20030221154023Z.
13179
13180 .vitem &$transport_name$&
13181 .cindex "transport" "name"
13182 .cindex "name" "of transport"
13183 .vindex "&$transport_name$&"
13184 During the running of a transport, this variable contains its name.
13185
13186 .vitem &$value$&
13187 .vindex "&$value$&"
13188 This variable contains the result of an expansion lookup, extraction operation,
13189 or external command, as described above. It is also used during a
13190 &*reduce*& expansion.
13191
13192 .vitem &$verify_mode$&
13193 .vindex "&$verify_mode$&"
13194 While a router or transport is being run in verify mode or for cutthrough delivery,
13195 contains "S" for sender-verification or "R" for recipient-verification.
13196 Otherwise, empty.
13197
13198 .vitem &$version_number$&
13199 .vindex "&$version_number$&"
13200 The version number of Exim.
13201
13202 .vitem &$warn_message_delay$&
13203 .vindex "&$warn_message_delay$&"
13204 This variable is set only during the creation of a message warning about a
13205 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
13206
13207 .vitem &$warn_message_recipients$&
13208 .vindex "&$warn_message_recipients$&"
13209 This variable is set only during the creation of a message warning about a
13210 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
13211 .endlist
13212 .ecindex IIDstrexp
13213
13214
13215
13216 . ////////////////////////////////////////////////////////////////////////////
13217 . ////////////////////////////////////////////////////////////////////////////
13218
13219 .chapter "Embedded Perl" "CHAPperl"
13220 .scindex IIDperl "Perl" "calling from Exim"
13221 Exim can be built to include an embedded Perl interpreter. When this is done,
13222 Perl subroutines can be called as part of the string expansion process. To make
13223 use of the Perl support, you need version 5.004 or later of Perl installed on
13224 your system. To include the embedded interpreter in the Exim binary, include
13225 the line
13226 .code
13227 EXIM_PERL = perl.o
13228 .endd
13229 in your &_Local/Makefile_& and then build Exim in the normal way.
13230
13231
13232 .section "Setting up so Perl can be used" "SECID85"
13233 .oindex "&%perl_startup%&"
13234 Access to Perl subroutines is via a global configuration option called
13235 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
13236 no &%perl_startup%& option in the Exim configuration file then no Perl
13237 interpreter is started and there is almost no overhead for Exim (since none of
13238 the Perl library will be paged in unless used). If there is a &%perl_startup%&
13239 option then the associated value is taken to be Perl code which is executed in
13240 a newly created Perl interpreter.
13241
13242 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
13243 need backslashes before any characters to escape special meanings. The option
13244 should usually be something like
13245 .code
13246 perl_startup = do '/etc/exim.pl'
13247 .endd
13248 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
13249 use from Exim. Exim can be configured either to start up a Perl interpreter as
13250 soon as it is entered, or to wait until the first time it is needed. Starting
13251 the interpreter at the beginning ensures that it is done while Exim still has
13252 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
13253 fact used in a particular run. Also, note that this does not mean that Exim is
13254 necessarily running as root when Perl is called at a later time. By default,
13255 the interpreter is started only when it is needed, but this can be changed in
13256 two ways:
13257
13258 .ilist
13259 .oindex "&%perl_at_start%&"
13260 Setting &%perl_at_start%& (a boolean option) in the configuration requests
13261 a startup when Exim is entered.
13262 .next
13263 The command line option &%-ps%& also requests a startup when Exim is entered,
13264 overriding the setting of &%perl_at_start%&.
13265 .endlist
13266
13267 There is also a command line option &%-pd%& (for delay) which suppresses the
13268 initial startup, even if &%perl_at_start%& is set.
13269
13270 .ilist
13271 .oindex "&%perl_taintmode%&"
13272 .cindex "Perl" "taintmode"
13273 To provide more security executing Perl code via the embedded Perl
13274 interpreter, the &%perl_taintmode%& option can be set. This enables the
13275 taint mode of the Perl interpreter. You are encouraged to set this
13276 option to a true value. To avoid breaking existing installations, it
13277 defaults to false.
13278
13279
13280 .section "Calling Perl subroutines" "SECID86"
13281 When the configuration file includes a &%perl_startup%& option you can make use
13282 of the string expansion item to call the Perl subroutines that are defined
13283 by the &%perl_startup%& code. The operator is used in any of the following
13284 forms:
13285 .code
13286 ${perl{foo}}
13287 ${perl{foo}{argument}}
13288 ${perl{foo}{argument1}{argument2} ... }
13289 .endd
13290 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
13291 arguments may be passed. Passing more than this results in an expansion failure
13292 with an error message of the form
13293 .code
13294 Too many arguments passed to Perl subroutine "foo" (max is 8)
13295 .endd
13296 The return value of the Perl subroutine is evaluated in a scalar context before
13297 it is passed back to Exim to be inserted into the expanded string. If the
13298 return value is &'undef'&, the expansion is forced to fail in the same way as
13299 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
13300 by obeying Perl's &%die%& function, the expansion fails with the error message
13301 that was passed to &%die%&.
13302
13303
13304 .section "Calling Exim functions from Perl" "SECID87"
13305 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
13306 is available to call back into Exim's string expansion function. For example,
13307 the Perl code
13308 .code
13309 my $lp = Exim::expand_string('$local_part');
13310 .endd
13311 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
13312 Note those are single quotes and not double quotes to protect against
13313 &$local_part$& being interpolated as a Perl variable.
13314
13315 If the string expansion is forced to fail by a &"fail"& item, the result of
13316 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
13317 expansion string, the Perl call from the original expansion string fails with
13318 an appropriate error message, in the same way as if &%die%& were used.
13319
13320 .cindex "debugging" "from embedded Perl"
13321 .cindex "log" "writing from embedded Perl"
13322 Two other Exim functions are available for use from within Perl code.
13323 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
13324 debugging is enabled. If you want a newline at the end, you must supply it.
13325 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
13326 timestamp. In this case, you should not supply a terminating newline.
13327
13328
13329 .section "Use of standard output and error by Perl" "SECID88"
13330 .cindex "Perl" "standard output and error"
13331 You should not write to the standard error or output streams from within your
13332 Perl code, as it is not defined how these are set up. In versions of Exim
13333 before 4.50, it is possible for the standard output or error to refer to the
13334 SMTP connection during message reception via the daemon. Writing to this stream
13335 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
13336 error streams are connected to &_/dev/null_& in the daemon. The chaos is
13337 avoided, but the output is lost.
13338
13339 .cindex "Perl" "use of &%warn%&"
13340 The Perl &%warn%& statement writes to the standard error stream by default.
13341 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
13342 you have no control. When Exim starts up the Perl interpreter, it arranges for
13343 output from the &%warn%& statement to be written to the Exim main log. You can
13344 change this by including appropriate Perl magic somewhere in your Perl code.
13345 For example, to discard &%warn%& output completely, you need this:
13346 .code
13347 $SIG{__WARN__} = sub { };
13348 .endd
13349 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
13350 example, the code for the subroutine is empty, so it does nothing, but you can
13351 include any Perl code that you like. The text of the &%warn%& message is passed
13352 as the first subroutine argument.
13353 .ecindex IIDperl
13354
13355
13356 . ////////////////////////////////////////////////////////////////////////////
13357 . ////////////////////////////////////////////////////////////////////////////
13358
13359 .chapter "Starting the daemon and the use of network interfaces" &&&
13360          "CHAPinterfaces" &&&
13361          "Starting the daemon"
13362 .cindex "daemon" "starting"
13363 .cindex "interface" "listening"
13364 .cindex "network interface"
13365 .cindex "interface" "network"
13366 .cindex "IP address" "for listening"
13367 .cindex "daemon" "listening IP addresses"
13368 .cindex "TCP/IP" "setting listening interfaces"
13369 .cindex "TCP/IP" "setting listening ports"
13370 A host that is connected to a TCP/IP network may have one or more physical
13371 hardware network interfaces. Each of these interfaces may be configured as one
13372 or more &"logical"& interfaces, which are the entities that a program actually
13373 works with. Each of these logical interfaces is associated with an IP address.
13374 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
13375 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
13376 knowledge about the host's interfaces for use in three different circumstances:
13377
13378 .olist
13379 When a listening daemon is started, Exim needs to know which interfaces
13380 and ports to listen on.
13381 .next
13382 When Exim is routing an address, it needs to know which IP addresses
13383 are associated with local interfaces. This is required for the correct
13384 processing of MX lists by removing the local host and others with the
13385 same or higher priority values. Also, Exim needs to detect cases
13386 when an address is routed to an IP address that in fact belongs to the
13387 local host. Unless the &%self%& router option or the &%allow_localhost%&
13388 option of the smtp transport is set (as appropriate), this is treated
13389 as an error situation.
13390 .next
13391 When Exim connects to a remote host, it may need to know which interface to use
13392 for the outgoing connection.
13393 .endlist
13394
13395
13396 Exim's default behaviour is likely to be appropriate in the vast majority
13397 of cases. If your host has only one interface, and you want all its IP
13398 addresses to be treated in the same way, and you are using only the
13399 standard SMTP port, you should not need to take any special action. The
13400 rest of this chapter does not apply to you.
13401
13402 In a more complicated situation you may want to listen only on certain
13403 interfaces, or on different ports, and for this reason there are a number of
13404 options that can be used to influence Exim's behaviour. The rest of this
13405 chapter describes how they operate.
13406
13407 When a message is received over TCP/IP, the interface and port that were
13408 actually used are set in &$received_ip_address$& and &$received_port$&.
13409
13410
13411
13412 .section "Starting a listening daemon" "SECID89"
13413 When a listening daemon is started (by means of the &%-bd%& command line
13414 option), the interfaces and ports on which it listens are controlled by the
13415 following options:
13416
13417 .ilist
13418 &%daemon_smtp_ports%& contains a list of default ports
13419 or service names.
13420 (For backward compatibility, this option can also be specified in the singular.)
13421 .next
13422 &%local_interfaces%& contains list of interface IP addresses on which to
13423 listen. Each item may optionally also specify a port.
13424 .endlist
13425
13426 The default list separator in both cases is a colon, but this can be changed as
13427 described in section &<<SECTlistconstruct>>&. When IPv6 addresses are involved,
13428 it is usually best to change the separator to avoid having to double all the
13429 colons. For example:
13430 .code
13431 local_interfaces = <; 127.0.0.1 ; \
13432                       192.168.23.65 ; \
13433                       ::1 ; \
13434                       3ffe:ffff:836f::fe86:a061
13435 .endd
13436 There are two different formats for specifying a port along with an IP address
13437 in &%local_interfaces%&:
13438
13439 .olist
13440 The port is added onto the address with a dot separator. For example, to listen
13441 on port 1234 on two different IP addresses:
13442 .code
13443 local_interfaces = <; 192.168.23.65.1234 ; \
13444                       3ffe:ffff:836f::fe86:a061.1234
13445 .endd
13446 .next
13447 The IP address is enclosed in square brackets, and the port is added
13448 with a colon separator, for example:
13449 .code
13450 local_interfaces = <; [192.168.23.65]:1234 ; \
13451                       [3ffe:ffff:836f::fe86:a061]:1234
13452 .endd
13453 .endlist
13454
13455 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
13456 default setting contains just one port:
13457 .code
13458 daemon_smtp_ports = smtp
13459 .endd
13460 If more than one port is listed, each interface that does not have its own port
13461 specified listens on all of them. Ports that are listed in
13462 &%daemon_smtp_ports%& can be identified either by name (defined in
13463 &_/etc/services_&) or by number. However, when ports are given with individual
13464 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
13465
13466
13467
13468 .section "Special IP listening addresses" "SECID90"
13469 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
13470 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
13471 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
13472 instead of setting up separate listening sockets for each interface. The
13473 default value of &%local_interfaces%& is
13474 .code
13475 local_interfaces = 0.0.0.0
13476 .endd
13477 when Exim is built without IPv6 support; otherwise it is:
13478 .code
13479 local_interfaces = <; ::0 ; 0.0.0.0
13480 .endd
13481 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
13482
13483
13484
13485 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
13486 The &%-oX%& command line option can be used to override the values of
13487 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
13488 instance. Another way of doing this would be to use macros and the &%-D%&
13489 option. However, &%-oX%& can be used by any admin user, whereas modification of
13490 the runtime configuration by &%-D%& is allowed only when the caller is root or
13491 exim.
13492
13493 The value of &%-oX%& is a list of items. The default colon separator can be
13494 changed in the usual way if required. If there are any items that do not
13495 contain dots or colons (that is, are not IP addresses), the value of
13496 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
13497 items that do contain dots or colons, the value of &%local_interfaces%& is
13498 replaced by those items. Thus, for example,
13499 .code
13500 -oX 1225
13501 .endd
13502 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
13503 whereas
13504 .code
13505 -oX 192.168.34.5.1125
13506 .endd
13507 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
13508 (However, since &%local_interfaces%& now contains no items without ports, the
13509 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
13510
13511
13512
13513 .section "Support for the submissions (aka SSMTP or SMTPS) protocol" "SECTsupobssmt"
13514 .cindex "submissions protocol"
13515 .cindex "ssmtp protocol"
13516 .cindex "smtps protocol"
13517 .cindex "SMTP" "ssmtp protocol"
13518 .cindex "SMTP" "smtps protocol"
13519 Exim supports the use of TLS-on-connect, used by mail clients in the
13520 &"submissions"& protocol, historically also known as SMTPS or SSMTP.
13521 For some years, IETF Standards Track documents only blessed the
13522 STARTTLS-based Submission service (port 587) while common practice was to support
13523 the same feature set on port 465, but using TLS-on-connect.
13524 If your installation needs to provide service to mail clients
13525 (Mail User Agents, MUAs) then you should provide service on both the 587 and
13526 the 465 TCP ports.
13527
13528 If the &%tls_on_connect_ports%& option is set to a list of port numbers or
13529 service names, connections to those ports must first establish TLS, before
13530 proceeding to the application layer use of the SMTP protocol.
13531
13532 The common use of this option is expected to be
13533 .code
13534 tls_on_connect_ports = 465
13535 .endd
13536 per RFC 8314.
13537 There is also a command line option &%-tls-on-connect%&, which forces all ports
13538 to behave in this way when a daemon is started.
13539
13540 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
13541 daemon to listen on those ports. You must still specify them in
13542 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
13543 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
13544 connections via the daemon.)
13545
13546
13547
13548
13549 .section "IPv6 address scopes" "SECID92"
13550 .cindex "IPv6" "address scopes"
13551 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
13552 can, in principle, have the same link-local IPv6 address on different
13553 interfaces. Thus, additional information is needed, over and above the IP
13554 address, to distinguish individual interfaces. A convention of using a
13555 percent sign followed by something (often the interface name) has been
13556 adopted in some cases, leading to addresses like this:
13557 .code
13558 fe80::202:b3ff:fe03:45c1%eth0
13559 .endd
13560 To accommodate this usage, a percent sign followed by an arbitrary string is
13561 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
13562 to convert a textual IPv6 address for actual use. This function recognizes the
13563 percent convention in operating systems that support it, and it processes the
13564 address appropriately. Unfortunately, some older libraries have problems with
13565 &[getaddrinfo()]&. If
13566 .code
13567 IPV6_USE_INET_PTON=yes
13568 .endd
13569 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
13570 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
13571 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
13572 function.) Of course, this means that the additional functionality of
13573 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
13574
13575 .section "Disabling IPv6" "SECID93"
13576 .cindex "IPv6" "disabling"
13577 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
13578 run on a host whose kernel does not support IPv6. The binary will fall back to
13579 using IPv4, but it may waste resources looking up AAAA records, and trying to
13580 connect to IPv6 addresses, causing delays to mail delivery. If you set the
13581 .oindex "&%disable_ipv6%&"
13582 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
13583 activities take place. AAAA records are never looked up, and any IPv6 addresses
13584 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
13585 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
13586 to handle IPv6 literal addresses.
13587
13588 On the other hand, when IPv6 is in use, there may be times when you want to
13589 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
13590 option to globally suppress the lookup of AAAA records for specified domains,
13591 and you can use the &%ignore_target_hosts%& generic router option to ignore
13592 IPv6 addresses in an individual router.
13593
13594
13595
13596 .section "Examples of starting a listening daemon" "SECID94"
13597 The default case in an IPv6 environment is
13598 .code
13599 daemon_smtp_ports = smtp
13600 local_interfaces = <; ::0 ; 0.0.0.0
13601 .endd
13602 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
13603 Either one or two sockets may be used, depending on the characteristics of
13604 the TCP/IP stack. (This is complicated and messy; for more information,
13605 read the comments in the &_daemon.c_& source file.)
13606
13607 To specify listening on ports 25 and 26 on all interfaces:
13608 .code
13609 daemon_smtp_ports = 25 : 26
13610 .endd
13611 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
13612 .code
13613 local_interfaces = <; ::0.25     ; ::0.26 \
13614                       0.0.0.0.25 ; 0.0.0.0.26
13615 .endd
13616 To listen on the default port on all IPv4 interfaces, and on port 26 on the
13617 IPv4 loopback address only:
13618 .code
13619 local_interfaces = 0.0.0.0 : 127.0.0.1.26
13620 .endd
13621 To specify listening on the default port on specific interfaces only:
13622 .code
13623 local_interfaces = 10.0.0.67 : 192.168.34.67
13624 .endd
13625 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
13626
13627
13628
13629 .section "Recognizing the local host" "SECTreclocipadd"
13630 The &%local_interfaces%& option is also used when Exim needs to determine
13631 whether or not an IP address refers to the local host. That is, the IP
13632 addresses of all the interfaces on which a daemon is listening are always
13633 treated as local.
13634
13635 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
13636 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
13637 available interfaces from the operating system, and extracts the relevant
13638 (that is, IPv4 or IPv6) addresses to use for checking.
13639
13640 Some systems set up large numbers of virtual interfaces in order to provide
13641 many virtual web servers. In this situation, you may want to listen for
13642 email on only a few of the available interfaces, but nevertheless treat all
13643 interfaces as local when routing. You can do this by setting
13644 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
13645 &"all"& wildcard values. These addresses are recognized as local, but are not
13646 used for listening. Consider this example:
13647 .code
13648 local_interfaces = <; 127.0.0.1 ; ::1 ; \
13649                       192.168.53.235 ; \
13650                       3ffe:2101:12:1:a00:20ff:fe86:a061
13651
13652 extra_local_interfaces = <; ::0 ; 0.0.0.0
13653 .endd
13654 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
13655 address, but all available interface addresses are treated as local when
13656 Exim is routing.
13657
13658 In some environments the local host name may be in an MX list, but with an IP
13659 address that is not assigned to any local interface. In other cases it may be
13660 desirable to treat other host names as if they referred to the local host. Both
13661 these cases can be handled by setting the &%hosts_treat_as_local%& option.
13662 This contains host names rather than IP addresses. When a host is referenced
13663 during routing, either via an MX record or directly, it is treated as the local
13664 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
13665 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
13666
13667
13668
13669 .section "Delivering to a remote host" "SECID95"
13670 Delivery to a remote host is handled by the smtp transport. By default, it
13671 allows the system's TCP/IP functions to choose which interface to use (if
13672 there is more than one) when connecting to a remote host. However, the
13673 &%interface%& option can be set to specify which interface is used. See the
13674 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
13675 details.
13676
13677
13678
13679
13680 . ////////////////////////////////////////////////////////////////////////////
13681 . ////////////////////////////////////////////////////////////////////////////
13682
13683 .chapter "Main configuration" "CHAPmainconfig"
13684 .scindex IIDconfima "configuration file" "main section"
13685 .scindex IIDmaiconf "main configuration"
13686 The first part of the run time configuration file contains three types of item:
13687
13688 .ilist
13689 Macro definitions: These lines start with an upper case letter. See section
13690 &<<SECTmacrodefs>>& for details of macro processing.
13691 .next
13692 Named list definitions: These lines start with one of the words &"domainlist"&,
13693 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
13694 section &<<SECTnamedlists>>&.
13695 .next
13696 Main configuration settings: Each setting occupies one line of the file
13697 (with possible continuations). If any setting is preceded by the word
13698 &"hide"&, the &%-bP%& command line option displays its value to admin users
13699 only. See section &<<SECTcos>>& for a description of the syntax of these option
13700 settings.
13701 .endlist
13702
13703 This chapter specifies all the main configuration options, along with their
13704 types and default values. For ease of finding a particular option, they appear
13705 in alphabetical order in section &<<SECTalomo>>& below. However, because there
13706 are now so many options, they are first listed briefly in functional groups, as
13707 an aid to finding the name of the option you are looking for. Some options are
13708 listed in more than one group.
13709
13710 .section "Miscellaneous" "SECID96"
13711 .table2
13712 .row &%bi_command%&                  "to run for &%-bi%& command line option"
13713 .row &%debug_store%&                 "do extra internal checks"
13714 .row &%disable_ipv6%&                "do no IPv6 processing"
13715 .row &%keep_malformed%&              "for broken files &-- should not happen"
13716 .row &%localhost_number%&            "for unique message ids in clusters"
13717 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
13718 .row &%message_body_visible%&        "how much to show in &$message_body$&"
13719 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
13720 .row &%print_topbitchars%&           "top-bit characters are printing"
13721 .row &%spool_wireformat%&            "use wire-format spool data files when possible"
13722 .row &%timezone%&                    "force time zone"
13723 .endtable
13724
13725
13726 .section "Exim parameters" "SECID97"
13727 .table2
13728 .row &%exim_group%&                  "override compiled-in value"
13729 .row &%exim_path%&                   "override compiled-in value"
13730 .row &%exim_user%&                   "override compiled-in value"
13731 .row &%primary_hostname%&            "default from &[uname()]&"
13732 .row &%split_spool_directory%&       "use multiple directories"
13733 .row &%spool_directory%&             "override compiled-in value"
13734 .endtable
13735
13736
13737
13738 .section "Privilege controls" "SECID98"
13739 .table2
13740 .row &%admin_groups%&                "groups that are Exim admin users"
13741 .row &%commandline_checks_require_admin%& "require admin for various checks"
13742 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
13743 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
13744 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
13745 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
13746 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
13747 .row &%never_users%&                 "do not run deliveries as these"
13748 .row &%prod_requires_admin%&         "forced delivery requires admin user"
13749 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
13750 .row &%trusted_groups%&              "groups that are trusted"
13751 .row &%trusted_users%&               "users that are trusted"
13752 .endtable
13753
13754
13755
13756 .section "Logging" "SECID99"
13757 .table2
13758 .row &%event_action%&                "custom logging"
13759 .row &%hosts_connection_nolog%&      "exemption from connect logging"
13760 .row &%log_file_path%&               "override compiled-in value"
13761 .row &%log_selector%&                "set/unset optional logging"
13762 .row &%log_timezone%&                "add timezone to log lines"
13763 .row &%message_logs%&                "create per-message logs"
13764 .row &%preserve_message_logs%&       "after message completion"
13765 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
13766 .row &%slow_lookup_log%&             "control logging of slow DNS lookups"
13767 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
13768 .row &%syslog_facility%&             "set syslog &""facility""& field"
13769 .row &%syslog_pid%&                  "pid in syslog lines"
13770 .row &%syslog_processname%&          "set syslog &""ident""& field"
13771 .row &%syslog_timestamp%&            "timestamp syslog lines"
13772 .row &%write_rejectlog%&             "control use of message log"
13773 .endtable
13774
13775
13776
13777 .section "Frozen messages" "SECID100"
13778 .table2
13779 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
13780 .row &%freeze_tell%&                 "send message when freezing"
13781 .row &%move_frozen_messages%&        "to another directory"
13782 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
13783 .endtable
13784
13785
13786
13787 .section "Data lookups" "SECID101"
13788 .table2
13789 .row &%ibase_servers%&               "InterBase servers"
13790 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
13791 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
13792 .row &%ldap_cert_file%&              "client cert file for LDAP"
13793 .row &%ldap_cert_key%&               "client key file for LDAP"
13794 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
13795 .row &%ldap_default_servers%&        "used if no server in query"
13796 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
13797 .row &%ldap_start_tls%&              "require TLS within LDAP"
13798 .row &%ldap_version%&                "set protocol version"
13799 .row &%lookup_open_max%&             "lookup files held open"
13800 .row &%mysql_servers%&               "default MySQL servers"
13801 .row &%oracle_servers%&              "Oracle servers"
13802 .row &%pgsql_servers%&               "default PostgreSQL servers"
13803 .row &%sqlite_lock_timeout%&         "as it says"
13804 .endtable
13805
13806
13807
13808 .section "Message ids" "SECID102"
13809 .table2
13810 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
13811 .row &%message_id_header_text%&      "ditto"
13812 .endtable
13813
13814
13815
13816 .section "Embedded Perl Startup" "SECID103"
13817 .table2
13818 .row &%perl_at_start%&               "always start the interpreter"
13819 .row &%perl_startup%&                "code to obey when starting Perl"
13820 .row &%perl_taintmode%&              "enable taint mode in Perl"
13821 .endtable
13822
13823
13824
13825 .section "Daemon" "SECID104"
13826 .table2
13827 .row &%daemon_smtp_ports%&           "default ports"
13828 .row &%daemon_startup_retries%&      "number of times to retry"
13829 .row &%daemon_startup_sleep%&        "time to sleep between tries"
13830 .row &%extra_local_interfaces%&      "not necessarily listened on"
13831 .row &%local_interfaces%&            "on which to listen, with optional ports"
13832 .row &%pid_file_path%&               "override compiled-in value"
13833 .row &%queue_run_max%&               "maximum simultaneous queue runners"
13834 .endtable
13835
13836
13837
13838 .section "Resource control" "SECID105"
13839 .table2
13840 .row &%check_log_inodes%&            "before accepting a message"
13841 .row &%check_log_space%&             "before accepting a message"
13842 .row &%check_spool_inodes%&          "before accepting a message"
13843 .row &%check_spool_space%&           "before accepting a message"
13844 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
13845 .row &%queue_only_load%&             "queue incoming if load high"
13846 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13847 .row &%queue_run_max%&               "maximum simultaneous queue runners"
13848 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13849 .row &%smtp_accept_max%&             "simultaneous incoming connections"
13850 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
13851 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
13852 .row &%smtp_accept_max_per_connection%& "messages per connection"
13853 .row &%smtp_accept_max_per_host%&    "connections from one host"
13854 .row &%smtp_accept_queue%&           "queue mail if more connections"
13855 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
13856                                            connection"
13857 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
13858 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
13859 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
13860 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
13861 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
13862 .endtable
13863
13864
13865
13866 .section "Policy controls" "SECID106"
13867 .table2
13868 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
13869 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
13870 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
13871 .row &%acl_smtp_auth%&               "ACL for AUTH"
13872 .row &%acl_smtp_connect%&            "ACL for connection"
13873 .row &%acl_smtp_data%&               "ACL for DATA"
13874 .row &%acl_smtp_data_prdr%&          "ACL for DATA, per-recipient"
13875 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
13876 .row &%acl_smtp_etrn%&               "ACL for ETRN"
13877 .row &%acl_smtp_expn%&               "ACL for EXPN"
13878 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
13879 .row &%acl_smtp_mail%&               "ACL for MAIL"
13880 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
13881 .row &%acl_smtp_mime%&               "ACL for MIME parts"
13882 .row &%acl_smtp_notquit%&            "ACL for non-QUIT terminations"
13883 .row &%acl_smtp_predata%&            "ACL for start of data"
13884 .row &%acl_smtp_quit%&               "ACL for QUIT"
13885 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
13886 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
13887 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
13888 .row &%av_scanner%&                  "specify virus scanner"
13889 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13890                                       words""&"
13891 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
13892 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
13893 .row &%header_maxsize%&              "total size of message header"
13894 .row &%header_line_maxsize%&         "individual header line limit"
13895 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
13896 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
13897 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
13898 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
13899 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
13900 .row &%host_lookup%&                 "host name looked up for these hosts"
13901 .row &%host_lookup_order%&           "order of DNS and local name lookups"
13902 .row &%hosts_proxy%&                 "use proxy protocol for these hosts"
13903 .row &%host_reject_connection%&      "reject connection from these hosts"
13904 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
13905 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
13906 .row &%message_size_limit%&          "for all messages"
13907 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
13908 .row &%spamd_address%&               "set interface to SpamAssassin"
13909 .row &%strict_acl_vars%&             "object to unset ACL variables"
13910 .endtable
13911
13912
13913
13914 .section "Callout cache" "SECID107"
13915 .table2
13916 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
13917                                          item"
13918 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
13919                                          item"
13920 .row &%callout_negative_expire%&     "timeout for negative address cache item"
13921 .row &%callout_positive_expire%&     "timeout for positive address cache item"
13922 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
13923 .endtable
13924
13925
13926
13927 .section "TLS" "SECID108"
13928 .table2
13929 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
13930 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
13931 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
13932 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13933 .row &%tls_certificate%&             "location of server certificate"
13934 .row &%tls_crl%&                     "certificate revocation list"
13935 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
13936 .row &%tls_dhparam%&                 "DH parameters for server"
13937 .row &%tls_eccurve%&                 "EC curve selection for server"
13938 .row &%tls_ocsp_file%&               "location of server certificate status proof"
13939 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
13940 .row &%tls_privatekey%&              "location of server private key"
13941 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
13942 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
13943 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
13944 .row &%tls_verify_certificates%&     "expected client certificates"
13945 .row &%tls_verify_hosts%&            "insist on client certificate verify"
13946 .endtable
13947
13948
13949
13950 .section "Local user handling" "SECID109"
13951 .table2
13952 .row &%finduser_retries%&            "useful in NIS environments"
13953 .row &%gecos_name%&                  "used when creating &'Sender:'&"
13954 .row &%gecos_pattern%&               "ditto"
13955 .row &%max_username_length%&         "for systems that truncate"
13956 .row &%unknown_login%&               "used when no login name found"
13957 .row &%unknown_username%&            "ditto"
13958 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
13959 .row &%uucp_from_sender%&            "ditto"
13960 .endtable
13961
13962
13963
13964 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
13965 .table2
13966 .row &%header_maxsize%&              "total size of message header"
13967 .row &%header_line_maxsize%&         "individual header line limit"
13968 .row &%message_size_limit%&          "applies to all messages"
13969 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
13970 .row &%received_header_text%&        "expanded to make &'Received:'&"
13971 .row &%received_headers_max%&        "for mail loop detection"
13972 .row &%recipients_max%&              "limit per message"
13973 .row &%recipients_max_reject%&       "permanently reject excess recipients"
13974 .endtable
13975
13976
13977
13978
13979 .section "Non-SMTP incoming messages" "SECID111"
13980 .table2
13981 .row &%receive_timeout%&             "for non-SMTP messages"
13982 .endtable
13983
13984
13985
13986
13987
13988 .section "Incoming SMTP messages" "SECID112"
13989 See also the &'Policy controls'& section above.
13990
13991 .table2
13992 .row &%dkim_verify_signers%&         "DKIM domain for which DKIM ACL is run"
13993 .row &%host_lookup%&                 "host name looked up for these hosts"
13994 .row &%host_lookup_order%&           "order of DNS and local name lookups"
13995 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
13996 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
13997 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
13998 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
13999 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
14000 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14001 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14002 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14003 .row &%smtp_accept_max_per_connection%& "messages per connection"
14004 .row &%smtp_accept_max_per_host%&    "connections from one host"
14005 .row &%smtp_accept_queue%&           "queue mail if more connections"
14006 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14007                                            connection"
14008 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14009 .row &%smtp_active_hostname%&        "host name to use in messages"
14010 .row &%smtp_banner%&                 "text for welcome banner"
14011 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14012 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14013 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
14014 .row &%smtp_etrn_command%&           "what to run for ETRN"
14015 .row &%smtp_etrn_serialize%&         "only one at once"
14016 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
14017 .row &%smtp_max_unknown_commands%&   "before dropping connection"
14018 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
14019 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
14020 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
14021 .row &%smtp_receive_timeout%&        "per command or data line"
14022 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14023 .row &%smtp_return_error_details%&   "give detail on rejections"
14024 .endtable
14025
14026
14027
14028 .section "SMTP extensions" "SECID113"
14029 .table2
14030 .row &%accept_8bitmime%&             "advertise 8BITMIME"
14031 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
14032 .row &%chunking_advertise_hosts%&    "advertise CHUNKING to these hosts"
14033 .row &%dsn_advertise_hosts%&         "advertise DSN extensions to these hosts"
14034 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
14035 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
14036 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
14037 .row &%prdr_enable%&                 "advertise PRDR to all hosts"
14038 .row &%smtputf8_advertise_hosts%&    "advertise SMTPUTF8 to these hosts"
14039 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14040 .endtable
14041
14042
14043
14044 .section "Processing messages" "SECID114"
14045 .table2
14046 .row &%allow_domain_literals%&       "recognize domain literal syntax"
14047 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
14048 .row &%allow_utf8_domains%&          "in addresses"
14049 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14050                                       words""&"
14051 .row &%delivery_date_remove%&        "from incoming messages"
14052 .row &%envelope_to_remove%&          "from incoming messages"
14053 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
14054 .row &%headers_charset%&             "default for translations"
14055 .row &%qualify_domain%&              "default for senders"
14056 .row &%qualify_recipient%&           "default for recipients"
14057 .row &%return_path_remove%&          "from incoming messages"
14058 .row &%strip_excess_angle_brackets%& "in addresses"
14059 .row &%strip_trailing_dot%&          "at end of addresses"
14060 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
14061 .endtable
14062
14063
14064
14065 .section "System filter" "SECID115"
14066 .table2
14067 .row &%system_filter%&               "locate system filter"
14068 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
14069                                             directory"
14070 .row &%system_filter_file_transport%& "transport for delivery to a file"
14071 .row &%system_filter_group%&         "group for filter running"
14072 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
14073 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
14074 .row &%system_filter_user%&          "user for filter running"
14075 .endtable
14076
14077
14078
14079 .section "Routing and delivery" "SECID116"
14080 .table2
14081 .row &%disable_ipv6%&                "do no IPv6 processing"
14082 .row &%dns_again_means_nonexist%&    "for broken domains"
14083 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
14084 .row &%dns_dnssec_ok%&               "parameter for resolver"
14085 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
14086 .row &%dns_retrans%&                 "parameter for resolver"
14087 .row &%dns_retry%&                   "parameter for resolver"
14088 .row &%dns_trust_aa%&                "DNS zones trusted as authentic"
14089 .row &%dns_use_edns0%&               "parameter for resolver"
14090 .row &%hold_domains%&                "hold delivery for these domains"
14091 .row &%local_interfaces%&            "for routing checks"
14092 .row &%queue_domains%&               "no immediate delivery for these"
14093 .row &%queue_only%&                  "no immediate delivery at all"
14094 .row &%queue_only_file%&             "no immediate delivery if file exists"
14095 .row &%queue_only_load%&             "no immediate delivery if load is high"
14096 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
14097 .row &%queue_only_override%&         "allow command line to override"
14098 .row &%queue_run_in_order%&          "order of arrival"
14099 .row &%queue_run_max%&               "of simultaneous queue runners"
14100 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
14101 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
14102 .row &%remote_sort_domains%&         "order of remote deliveries"
14103 .row &%retry_data_expire%&           "timeout for retry data"
14104 .row &%retry_interval_max%&          "safety net for retry rules"
14105 .endtable
14106
14107
14108
14109 .section "Bounce and warning messages" "SECID117"
14110 .table2
14111 .row &%bounce_message_file%&         "content of bounce"
14112 .row &%bounce_message_text%&         "content of bounce"
14113 .row &%bounce_return_body%&          "include body if returning message"
14114 .row &%bounce_return_linesize_limit%& "limit on returned message line length"
14115 .row &%bounce_return_message%&       "include original message in bounce"
14116 .row &%bounce_return_size_limit%&    "limit on returned message"
14117 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
14118 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
14119 .row &%errors_copy%&                 "copy bounce messages"
14120 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
14121 .row &%delay_warning%&               "time schedule"
14122 .row &%delay_warning_condition%&     "condition for warning messages"
14123 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
14124 .row &%smtp_return_error_details%&   "give detail on rejections"
14125 .row &%warn_message_file%&           "content of warning message"
14126 .endtable
14127
14128
14129
14130 .section "Alphabetical list of main options" "SECTalomo"
14131 Those options that undergo string expansion before use are marked with
14132 &dagger;.
14133
14134 .option accept_8bitmime main boolean true
14135 .cindex "8BITMIME"
14136 .cindex "8-bit characters"
14137 .cindex "log" "selectors"
14138 .cindex "log" "8BITMIME"
14139 This option causes Exim to send 8BITMIME in its response to an SMTP
14140 EHLO command, and to accept the BODY= parameter on MAIL commands.
14141 However, though Exim is 8-bit clean, it is not a protocol converter, and it
14142 takes no steps to do anything special with messages received by this route.
14143
14144 Historically Exim kept this option off by default, but the maintainers
14145 feel that in today's Internet, this causes more problems than it solves.
14146 It now defaults to true.
14147 A more detailed analysis of the issues is provided by Dan Bernstein:
14148 .display
14149 &url(http://cr.yp.to/smtp/8bitmime.html)
14150 .endd
14151
14152 To log received 8BITMIME status use
14153 .code
14154 log_selector = +8bitmime
14155 .endd
14156
14157 .option acl_not_smtp main string&!! unset
14158 .cindex "&ACL;" "for non-SMTP messages"
14159 .cindex "non-SMTP messages" "ACLs for"
14160 This option defines the ACL that is run when a non-SMTP message has been
14161 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
14162 further details.
14163
14164 .option acl_not_smtp_mime main string&!! unset
14165 This option defines the ACL that is run for individual MIME parts of non-SMTP
14166 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
14167 SMTP messages.
14168
14169 .option acl_not_smtp_start main string&!! unset
14170 .cindex "&ACL;" "at start of non-SMTP message"
14171 .cindex "non-SMTP messages" "ACLs for"
14172 This option defines the ACL that is run before Exim starts reading a
14173 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
14174
14175 .option acl_smtp_auth main string&!! unset
14176 .cindex "&ACL;" "setting up for SMTP commands"
14177 .cindex "AUTH" "ACL for"
14178 This option defines the ACL that is run when an SMTP AUTH command is
14179 received. See chapter &<<CHAPACL>>& for further details.
14180
14181 .option acl_smtp_connect main string&!! unset
14182 .cindex "&ACL;" "on SMTP connection"
14183 This option defines the ACL that is run when an SMTP connection is received.
14184 See chapter &<<CHAPACL>>& for further details.
14185
14186 .option acl_smtp_data main string&!! unset
14187 .cindex "DATA" "ACL for"
14188 This option defines the ACL that is run after an SMTP DATA command has been
14189 processed and the message itself has been received, but before the final
14190 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
14191
14192 .option acl_smtp_data_prdr main string&!! accept
14193 .cindex "PRDR" "ACL for"
14194 .cindex "DATA" "PRDR ACL for"
14195 .cindex "&ACL;" "PRDR-related"
14196 .cindex "&ACL;" "per-user data processing"
14197 This option defines the ACL that,
14198 if the PRDR feature has been negotiated,
14199 is run for each recipient after an SMTP DATA command has been
14200 processed and the message itself has been received, but before the
14201 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
14202
14203 .option acl_smtp_dkim main string&!! unset
14204 .cindex DKIM "ACL for"
14205 This option defines the ACL that is run for each DKIM signature
14206 (by default, or as specified in the dkim_verify_signers option)
14207 of a received message.
14208 See section &<<SECDKIMVFY>>& for further details.
14209
14210 .option acl_smtp_etrn main string&!! unset
14211 .cindex "ETRN" "ACL for"
14212 This option defines the ACL that is run when an SMTP ETRN command is
14213 received. See chapter &<<CHAPACL>>& for further details.
14214
14215 .option acl_smtp_expn main string&!! unset
14216 .cindex "EXPN" "ACL for"
14217 This option defines the ACL that is run when an SMTP EXPN command is
14218 received. See chapter &<<CHAPACL>>& for further details.
14219
14220 .option acl_smtp_helo main string&!! unset
14221 .cindex "EHLO" "ACL for"
14222 .cindex "HELO" "ACL for"
14223 This option defines the ACL that is run when an SMTP EHLO or HELO
14224 command is received. See chapter &<<CHAPACL>>& for further details.
14225
14226
14227 .option acl_smtp_mail main string&!! unset
14228 .cindex "MAIL" "ACL for"
14229 This option defines the ACL that is run when an SMTP MAIL command is
14230 received. See chapter &<<CHAPACL>>& for further details.
14231
14232 .option acl_smtp_mailauth main string&!! unset
14233 .cindex "AUTH" "on MAIL command"
14234 This option defines the ACL that is run when there is an AUTH parameter on
14235 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
14236 &<<CHAPSMTPAUTH>>& for details of authentication.
14237
14238 .option acl_smtp_mime main string&!! unset
14239 .cindex "MIME content scanning" "ACL for"
14240 This option is available when Exim is built with the content-scanning
14241 extension. It defines the ACL that is run for each MIME part in a message. See
14242 section &<<SECTscanmimepart>>& for details.
14243
14244 .option acl_smtp_notquit main string&!! unset
14245 .cindex "not-QUIT, ACL for"
14246 This option defines the ACL that is run when an SMTP session
14247 ends without a QUIT command being received.
14248 See chapter &<<CHAPACL>>& for further details.
14249
14250 .option acl_smtp_predata main string&!! unset
14251 This option defines the ACL that is run when an SMTP DATA command is
14252 received, before the message itself is received. See chapter &<<CHAPACL>>& for
14253 further details.
14254
14255 .option acl_smtp_quit main string&!! unset
14256 .cindex "QUIT, ACL for"
14257 This option defines the ACL that is run when an SMTP QUIT command is
14258 received. See chapter &<<CHAPACL>>& for further details.
14259
14260 .option acl_smtp_rcpt main string&!! unset
14261 .cindex "RCPT" "ACL for"
14262 This option defines the ACL that is run when an SMTP RCPT command is
14263 received. See chapter &<<CHAPACL>>& for further details.
14264
14265 .option acl_smtp_starttls main string&!! unset
14266 .cindex "STARTTLS, ACL for"
14267 This option defines the ACL that is run when an SMTP STARTTLS command is
14268 received. See chapter &<<CHAPACL>>& for further details.
14269
14270 .option acl_smtp_vrfy main string&!! unset
14271 .cindex "VRFY" "ACL for"
14272 This option defines the ACL that is run when an SMTP VRFY command is
14273 received. See chapter &<<CHAPACL>>& for further details.
14274
14275 .option add_environment main "string list" empty
14276 .cindex "environment" "set values"
14277 This option allows to set individual environment variables that the
14278 currently linked libraries and programs in child processes use.
14279 See &<<SECTpipeenv>>& for the environment of &(pipe)& transports.
14280
14281 .option admin_groups main "string list&!!" unset
14282 .cindex "admin user"
14283 This option is expanded just once, at the start of Exim's processing. If the
14284 current group or any of the supplementary groups of an Exim caller is in this
14285 colon-separated list, the caller has admin privileges. If all your system
14286 programmers are in a specific group, for example, you can give them all Exim
14287 admin privileges by putting that group in &%admin_groups%&. However, this does
14288 not permit them to read Exim's spool files (whose group owner is the Exim gid).
14289 To permit this, you have to add individuals to the Exim group.
14290
14291 .option allow_domain_literals main boolean false
14292 .cindex "domain literal"
14293 If this option is set, the RFC 2822 domain literal format is permitted in
14294 email addresses. The option is not set by default, because the domain literal
14295 format is not normally required these days, and few people know about it. It
14296 has, however, been exploited by mail abusers.
14297
14298 Unfortunately, it seems that some DNS black list maintainers are using this
14299 format to report black listing to postmasters. If you want to accept messages
14300 addressed to your hosts by IP address, you need to set
14301 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
14302 domains (defined in the named domain list &%local_domains%& in the default
14303 configuration). This &"magic string"& matches the domain literal form of all
14304 the local host's IP addresses.
14305
14306
14307 .option allow_mx_to_ip main boolean false
14308 .cindex "MX record" "pointing to IP address"
14309 It appears that more and more DNS zone administrators are breaking the rules
14310 and putting domain names that look like IP addresses on the right hand side of
14311 MX records. Exim follows the rules and rejects this, giving an error message
14312 that explains the misconfiguration. However, some other MTAs support this
14313 practice, so to avoid &"Why can't Exim do this?"& complaints,
14314 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
14315 recommended, except when you have no other choice.
14316
14317 .option allow_utf8_domains main boolean false
14318 .cindex "domain" "UTF-8 characters in"
14319 .cindex "UTF-8" "in domain name"
14320 Lots of discussion is going on about internationalized domain names. One
14321 camp is strongly in favour of just using UTF-8 characters, and it seems
14322 that at least two other MTAs permit this. This option allows Exim users to
14323 experiment if they wish.
14324
14325 If it is set true, Exim's domain parsing function allows valid
14326 UTF-8 multicharacters to appear in domain name components, in addition to
14327 letters, digits, and hyphens. However, just setting this option is not
14328 enough; if you want to look up these domain names in the DNS, you must also
14329 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
14330 suitable setting is:
14331 .code
14332 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
14333   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
14334 .endd
14335 Alternatively, you can just disable this feature by setting
14336 .code
14337 dns_check_names_pattern =
14338 .endd
14339 That is, set the option to an empty string so that no check is done.
14340
14341
14342 .option auth_advertise_hosts main "host list&!!" *
14343 .cindex "authentication" "advertising"
14344 .cindex "AUTH" "advertising"
14345 If any server authentication mechanisms are configured, Exim advertises them in
14346 response to an EHLO command only if the calling host matches this list.
14347 Otherwise, Exim does not advertise AUTH.
14348 Exim does not accept AUTH commands from clients to which it has not
14349 advertised the availability of AUTH. The advertising of individual
14350 authentication mechanisms can be controlled by the use of the
14351 &%server_advertise_condition%& generic authenticator option on the individual
14352 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
14353
14354 Certain mail clients (for example, Netscape) require the user to provide a name
14355 and password for authentication if AUTH is advertised, even though it may
14356 not be needed (the host may accept messages from hosts on its local LAN without
14357 authentication, for example). The &%auth_advertise_hosts%& option can be used
14358 to make these clients more friendly by excluding them from the set of hosts to
14359 which Exim advertises AUTH.
14360
14361 .cindex "AUTH" "advertising when encrypted"
14362 If you want to advertise the availability of AUTH only when the connection
14363 is encrypted using TLS, you can make use of the fact that the value of this
14364 option is expanded, with a setting like this:
14365 .code
14366 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
14367 .endd
14368 .vindex "&$tls_in_cipher$&"
14369 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
14370 the expansion is empty, thus matching no hosts. Otherwise, the result of the
14371 expansion is *, which matches all hosts.
14372
14373
14374 .option auto_thaw main time 0s
14375 .cindex "thawing messages"
14376 .cindex "unfreezing messages"
14377 If this option is set to a time greater than zero, a queue runner will try a
14378 new delivery attempt on any frozen message, other than a bounce message, if
14379 this much time has passed since it was frozen. This may result in the message
14380 being re-frozen if nothing has changed since the last attempt. It is a way of
14381 saying &"keep on trying, even though there are big problems"&.
14382
14383 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
14384 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
14385 thought to be very useful any more, and its use should probably be avoided.
14386
14387
14388 .option av_scanner main string "see below"
14389 This option is available if Exim is built with the content-scanning extension.
14390 It specifies which anti-virus scanner to use. The default value is:
14391 .code
14392 sophie:/var/run/sophie
14393 .endd
14394 If the value of &%av_scanner%& starts with a dollar character, it is expanded
14395 before use. See section &<<SECTscanvirus>>& for further details.
14396
14397
14398 .option bi_command main string unset
14399 .oindex "&%-bi%&"
14400 This option supplies the name of a command that is run when Exim is called with
14401 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
14402 just the command name, it is not a complete command line. If an argument is
14403 required, it must come from the &%-oA%& command line option.
14404
14405
14406 .option bounce_message_file main string unset
14407 .cindex "bounce message" "customizing"
14408 .cindex "customizing" "bounce message"
14409 This option defines a template file containing paragraphs of text to be used
14410 for constructing bounce messages.  Details of the file's contents are given in
14411 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
14412
14413
14414 .option bounce_message_text main string unset
14415 When this option is set, its contents are included in the default bounce
14416 message immediately after &"This message was created automatically by mail
14417 delivery software."& It is not used if &%bounce_message_file%& is set.
14418
14419 .option bounce_return_body main boolean true
14420 .cindex "bounce message" "including body"
14421 This option controls whether the body of an incoming message is included in a
14422 bounce message when &%bounce_return_message%& is true. The default setting
14423 causes the entire message, both header and body, to be returned (subject to the
14424 value of &%bounce_return_size_limit%&). If this option is false, only the
14425 message header is included. In the case of a non-SMTP message containing an
14426 error that is detected during reception, only those header lines preceding the
14427 point at which the error was detected are returned.
14428 .cindex "bounce message" "including original"
14429
14430 .option bounce_return_linesize_limit main integer 998
14431 .cindex "size" "of bounce lines, limit"
14432 .cindex "bounce message" "line length limit"
14433 .cindex "limit" "bounce message line length"
14434 This option sets a limit in bytes on the line length of messages
14435 that are returned to senders due to delivery problems,
14436 when &%bounce_return_message%& is true.
14437 The default value corresponds to RFC limits.
14438 If the message being returned has lines longer than this value it is
14439 treated as if the &%bounce_return_size_limit%& (below) restriction was exceeded.
14440
14441 The option also applies to bounces returned when an error is detected
14442 during reception of a message.
14443 In this case lines from the original are truncated.
14444
14445 The option does not apply to messages generated by an &(autoreply)& transport.
14446
14447
14448 .option bounce_return_message main boolean true
14449 If this option is set false, none of the original message is included in
14450 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
14451 &%bounce_return_body%&.
14452
14453
14454 .option bounce_return_size_limit main integer 100K
14455 .cindex "size" "of bounce, limit"
14456 .cindex "bounce message" "size limit"
14457 .cindex "limit" "bounce message size"
14458 This option sets a limit in bytes on the size of messages that are returned to
14459 senders as part of bounce messages when &%bounce_return_message%& is true. The
14460 limit should be less than the value of the global &%message_size_limit%& and of
14461 any &%message_size_limit%& settings on transports, to allow for the bounce text
14462 that Exim generates. If this option is set to zero there is no limit.
14463
14464 When the body of any message that is to be included in a bounce message is
14465 greater than the limit, it is truncated, and a comment pointing this out is
14466 added at the top. The actual cutoff may be greater than the value given, owing
14467 to the use of buffering for transferring the message in chunks (typically 8K in
14468 size). The idea is to save bandwidth on those undeliverable 15-megabyte
14469 messages.
14470
14471 .option bounce_sender_authentication main string unset
14472 .cindex "bounce message" "sender authentication"
14473 .cindex "authentication" "bounce message"
14474 .cindex "AUTH" "on bounce message"
14475 This option provides an authenticated sender address that is sent with any
14476 bounce messages generated by Exim that are sent over an authenticated SMTP
14477 connection. A typical setting might be:
14478 .code
14479 bounce_sender_authentication = mailer-daemon@my.domain.example
14480 .endd
14481 which would cause bounce messages to be sent using the SMTP command:
14482 .code
14483 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
14484 .endd
14485 The value of &%bounce_sender_authentication%& must always be a complete email
14486 address.
14487
14488 .option callout_domain_negative_expire main time 3h
14489 .cindex "caching" "callout timeouts"
14490 .cindex "callout" "caching timeouts"
14491 This option specifies the expiry time for negative callout cache data for a
14492 domain. See section &<<SECTcallver>>& for details of callout verification, and
14493 section &<<SECTcallvercache>>& for details of the caching.
14494
14495
14496 .option callout_domain_positive_expire main time 7d
14497 This option specifies the expiry time for positive callout cache data for a
14498 domain. See section &<<SECTcallver>>& for details of callout verification, and
14499 section &<<SECTcallvercache>>& for details of the caching.
14500
14501
14502 .option callout_negative_expire main time 2h
14503 This option specifies the expiry time for negative callout cache data for an
14504 address. See section &<<SECTcallver>>& for details of callout verification, and
14505 section &<<SECTcallvercache>>& for details of the caching.
14506
14507
14508 .option callout_positive_expire main time 24h
14509 This option specifies the expiry time for positive callout cache data for an
14510 address. See section &<<SECTcallver>>& for details of callout verification, and
14511 section &<<SECTcallvercache>>& for details of the caching.
14512
14513
14514 .option callout_random_local_part main string&!! "see below"
14515 This option defines the &"random"& local part that can be used as part of
14516 callout verification. The default value is
14517 .code
14518 $primary_hostname-$tod_epoch-testing
14519 .endd
14520 See section &<<CALLaddparcall>>& for details of how this value is used.
14521
14522
14523 .option check_log_inodes main integer 100
14524 See &%check_spool_space%& below.
14525
14526
14527 .option check_log_space main integer 10M
14528 See &%check_spool_space%& below.
14529
14530 .oindex "&%check_rfc2047_length%&"
14531 .cindex "RFC 2047" "disabling length check"
14532 .option check_rfc2047_length main boolean true
14533 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
14534 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
14535 word; strings to be encoded that exceed this length are supposed to use
14536 multiple encoded words. By default, Exim does not recognize encoded words that
14537 exceed the maximum length. However, it seems that some software, in violation
14538 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
14539 set false, Exim recognizes encoded words of any length.
14540
14541
14542 .option check_spool_inodes main integer 100
14543 See &%check_spool_space%& below.
14544
14545
14546 .option check_spool_space main integer 10M
14547 .cindex "checking disk space"
14548 .cindex "disk space, checking"
14549 .cindex "spool directory" "checking space"
14550 The four &%check_...%& options allow for checking of disk resources before a
14551 message is accepted.
14552
14553 .vindex "&$log_inodes$&"
14554 .vindex "&$log_space$&"
14555 .vindex "&$spool_inodes$&"
14556 .vindex "&$spool_space$&"
14557 When any of these options are nonzero, they apply to all incoming messages. If you
14558 want to apply different checks to different kinds of message, you can do so by
14559 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
14560 &$spool_space$& in an ACL with appropriate additional conditions.
14561
14562
14563 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
14564 either value is greater than zero, for example:
14565 .code
14566 check_spool_space = 100M
14567 check_spool_inodes = 100
14568 .endd
14569 The spool partition is the one that contains the directory defined by
14570 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
14571 transit.
14572
14573 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
14574 files are written if either is greater than zero. These should be set only if
14575 &%log_file_path%& and &%spool_directory%& refer to different partitions.
14576
14577 If there is less space or fewer inodes than requested, Exim refuses to accept
14578 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
14579 error response to the MAIL command. If ESMTP is in use and there was a
14580 SIZE parameter on the MAIL command, its value is added to the
14581 &%check_spool_space%& value, and the check is performed even if
14582 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
14583
14584 The values for &%check_spool_space%& and &%check_log_space%& are held as a
14585 number of kilobytes (though specified in bytes).
14586 If a non-multiple of 1024 is specified, it is rounded up.
14587
14588 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
14589 failure a message is written to stderr and Exim exits with a non-zero code, as
14590 it obviously cannot send an error message of any kind.
14591
14592 There is a slight performance penalty for these checks.
14593 Versions of Exim preceding 4.88 had these disabled by default;
14594 high-rate installations confident they will never run out of resources
14595 may wish to deliberately disable them.
14596
14597 .option chunking_advertise_hosts main "host list&!!" *
14598 .cindex CHUNKING advertisement
14599 .cindex "RFC 3030" "CHUNKING"
14600 The CHUNKING extension (RFC3030) will be advertised in the EHLO message to
14601 these hosts.
14602 Hosts may use the BDAT command as an alternate to DATA.
14603
14604 .option commandline_checks_require_admin main boolean &`false`&
14605 .cindex "restricting access to features"
14606 This option restricts various basic checking features to require an
14607 administrative user.
14608 This affects most of the &%-b*%& options, such as &%-be%&.
14609
14610 .option debug_store main boolean &`false`&
14611 .cindex debugging "memory corruption"
14612 .cindex memory debugging
14613 This option, when true, enables extra checking in Exim's internal memory
14614 management.  For use when a memory corruption issue is being investigated,
14615 it should normally be left as default.
14616
14617 .option daemon_smtp_ports main string &`smtp`&
14618 .cindex "port" "for daemon"
14619 .cindex "TCP/IP" "setting listening ports"
14620 This option specifies one or more default SMTP ports on which the Exim daemon
14621 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
14622 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
14623
14624 .option daemon_startup_retries main integer 9
14625 .cindex "daemon startup, retrying"
14626 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
14627 the daemon at startup when it cannot immediately bind a listening socket
14628 (typically because the socket is already in use): &%daemon_startup_retries%&
14629 defines the number of retries after the first failure, and
14630 &%daemon_startup_sleep%& defines the length of time to wait between retries.
14631
14632 .option daemon_startup_sleep main time 30s
14633 See &%daemon_startup_retries%&.
14634
14635 .option delay_warning main "time list" 24h
14636 .cindex "warning of delay"
14637 .cindex "delay warning, specifying"
14638 .cindex "queue" "delay warning"
14639 When a message is delayed, Exim sends a warning message to the sender at
14640 intervals specified by this option. The data is a colon-separated list of times
14641 after which to send warning messages. If the value of the option is an empty
14642 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
14643 message has been on the queue for longer than the last time, the last interval
14644 between the times is used to compute subsequent warning times. For example,
14645 with
14646 .code
14647 delay_warning = 4h:8h:24h
14648 .endd
14649 the first message is sent after 4 hours, the second after 8 hours, and
14650 the third one after 24 hours. After that, messages are sent every 16 hours,
14651 because that is the interval between the last two times on the list. If you set
14652 just one time, it specifies the repeat interval. For example, with:
14653 .code
14654 delay_warning = 6h
14655 .endd
14656 messages are repeated every six hours. To stop warnings after a given time, set
14657 a very large time at the end of the list. For example:
14658 .code
14659 delay_warning = 2h:12h:99d
14660 .endd
14661 Note that the option is only evaluated at the time a delivery attempt fails,
14662 which depends on retry and queue-runner configuration.
14663 Typically retries will be configured more frequently than warning messages.
14664
14665 .option delay_warning_condition main string&!! "see below"
14666 .vindex "&$domain$&"
14667 The string is expanded at the time a warning message might be sent. If all the
14668 deferred addresses have the same domain, it is set in &$domain$& during the
14669 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
14670 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
14671 &"false"& (the comparison being done caselessly) then the warning message is
14672 not sent. The default is:
14673 .code
14674 delay_warning_condition = ${if or {\
14675   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
14676   { match{$h_precedence:}{(?i)bulk|list|junk} }\
14677   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
14678   } {no}{yes}}
14679 .endd
14680 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
14681 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
14682 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
14683 &"auto-replied"& in an &'Auto-Submitted:'& header.
14684
14685 .option deliver_drop_privilege main boolean false
14686 .cindex "unprivileged delivery"
14687 .cindex "delivery" "unprivileged"
14688 If this option is set true, Exim drops its root privilege at the start of a
14689 delivery process, and runs as the Exim user throughout. This severely restricts
14690 the kinds of local delivery that are possible, but is viable in certain types
14691 of configuration. There is a discussion about the use of root privilege in
14692 chapter &<<CHAPsecurity>>&.
14693
14694 .option deliver_queue_load_max main fixed-point unset
14695 .cindex "load average"
14696 .cindex "queue runner" "abandoning"
14697 When this option is set, a queue run is abandoned if the system load average
14698 becomes greater than the value of the option. The option has no effect on
14699 ancient operating systems on which Exim cannot determine the load average.
14700 See also &%queue_only_load%& and &%smtp_load_reserve%&.
14701
14702
14703 .option delivery_date_remove main boolean true
14704 .cindex "&'Delivery-date:'& header line"
14705 Exim's transports have an option for adding a &'Delivery-date:'& header to a
14706 message when it is delivered, in exactly the same way as &'Return-path:'& is
14707 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
14708 should not be present in incoming messages, and this option causes them to be
14709 removed at the time the message is received, to avoid any problems that might
14710 occur when a delivered message is subsequently sent on to some other recipient.
14711
14712 .option disable_fsync main boolean false
14713 .cindex "&[fsync()]&, disabling"
14714 This option is available only if Exim was built with the compile-time option
14715 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
14716 a runtime configuration generates an &"unknown option"& error. You should not
14717 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
14718 really, really, really understand what you are doing. &'No pre-compiled
14719 distributions of Exim should ever make this option available.'&
14720
14721 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
14722 updated files' data to be written to disc before continuing. Unexpected events
14723 such as crashes and power outages may cause data to be lost or scrambled.
14724 Here be Dragons. &*Beware.*&
14725
14726
14727 .option disable_ipv6 main boolean false
14728 .cindex "IPv6" "disabling"
14729 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
14730 activities take place. AAAA records are never looked up, and any IPv6 addresses
14731 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
14732 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
14733 to handle IPv6 literal addresses.
14734
14735
14736 .option dkim_verify_signers main "domain list&!!" $dkim_signers
14737 .cindex DKIM "controlling calls to the ACL"
14738 This option gives a list of DKIM domains for which the DKIM ACL is run.
14739 It is expanded after the message is received; by default it runs
14740 the ACL once for each signature in the message.
14741 See section &<<SECDKIMVFY>>&.
14742
14743
14744 .option dns_again_means_nonexist main "domain list&!!" unset
14745 .cindex "DNS" "&""try again""& response; overriding"
14746 DNS lookups give a &"try again"& response for the DNS errors
14747 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
14748 keep trying to deliver a message, or to give repeated temporary errors to
14749 incoming mail. Sometimes the effect is caused by a badly set up name server and
14750 may persist for a long time. If a domain which exhibits this problem matches
14751 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
14752 This option should be used with care. You can make it apply to reverse lookups
14753 by a setting such as this:
14754 .code
14755 dns_again_means_nonexist = *.in-addr.arpa
14756 .endd
14757 This option applies to all DNS lookups that Exim does. It also applies when the
14758 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
14759 since these are most likely to be caused by DNS lookup problems. The
14760 &(dnslookup)& router has some options of its own for controlling what happens
14761 when lookups for MX or SRV records give temporary errors. These more specific
14762 options are applied after this global option.
14763
14764 .option dns_check_names_pattern main string "see below"
14765 .cindex "DNS" "pre-check of name syntax"
14766 When this option is set to a non-empty string, it causes Exim to check domain
14767 names for characters that are not allowed in host names before handing them to
14768 the DNS resolver, because some resolvers give temporary errors for names that
14769 contain unusual characters. If a domain name contains any unwanted characters,
14770 a &"not found"& result is forced, and the resolver is not called. The check is
14771 done by matching the domain name against a regular expression, which is the
14772 value of this option. The default pattern is
14773 .code
14774 dns_check_names_pattern = \
14775   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
14776 .endd
14777 which permits only letters, digits, slashes, and hyphens in components, but
14778 they must start and end with a letter or digit. Slashes are not, in fact,
14779 permitted in host names, but they are found in certain NS records (which can be
14780 accessed in Exim by using a &%dnsdb%& lookup). If you set
14781 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
14782 empty string.
14783
14784 .option dns_csa_search_limit main integer 5
14785 This option controls the depth of parental searching for CSA SRV records in the
14786 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
14787
14788 .option dns_csa_use_reverse main boolean true
14789 This option controls whether or not an IP address, given as a CSA domain, is
14790 reversed and looked up in the reverse DNS, as described in more detail in
14791 section &<<SECTverifyCSA>>&.
14792
14793
14794 .option dns_dnssec_ok main integer -1
14795 .cindex "DNS" "resolver options"
14796 .cindex "DNS" "DNSSEC"
14797 If this option is set to a non-negative number then Exim will initialise the
14798 DNS resolver library to either use or not use DNSSEC, overriding the system
14799 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
14800
14801 If the resolver library does not support DNSSEC then this option has no effect.
14802
14803
14804 .option dns_ipv4_lookup main "domain list&!!" unset
14805 .cindex "IPv6" "DNS lookup for AAAA records"
14806 .cindex "DNS" "IPv6 lookup for AAAA records"
14807 .cindex DNS "IPv6 disabling"
14808 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
14809 looks for IPv6 address records (AAAA records) as well as IPv4 address records
14810 (A records) when trying to find IP addresses for hosts, unless the host's
14811 domain matches this list.
14812
14813 This is a fudge to help with name servers that give big delays or otherwise do
14814 not work for the AAAA record type. In due course, when the world's name
14815 servers have all been upgraded, there should be no need for this option.
14816
14817
14818 .option dns_retrans main time 0s
14819 .cindex "DNS" "resolver options"
14820 .cindex timeout "dns lookup"
14821 .cindex "DNS" timeout
14822 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
14823 retransmission and retry parameters for DNS lookups. Values of zero (the
14824 defaults) leave the system default settings unchanged. The first value is the
14825 time between retries, and the second is the number of retries. It isn't
14826 totally clear exactly how these settings affect the total time a DNS lookup may
14827 take. I haven't found any documentation about timeouts on DNS lookups; these
14828 parameter values are available in the external resolver interface structure,
14829 but nowhere does it seem to describe how they are used or what you might want
14830 to set in them.
14831 See also the &%slow_lookup_log%& option.
14832
14833
14834 .option dns_retry main integer 0
14835 See &%dns_retrans%& above.
14836
14837
14838 .option dns_trust_aa main "domain list&!!" unset
14839 .cindex "DNS" "resolver options"
14840 .cindex "DNS" "DNSSEC"
14841 If this option is set then lookup results marked with the AA bit
14842 (Authoritative Answer) are trusted the same way as if they were
14843 DNSSEC-verified. The authority section's name of the answer must
14844 match with this expanded domain list.
14845
14846 Use this option only if you talk directly to a resolver that is
14847 authoritative for some zones and does not set the AD (Authentic Data)
14848 bit in the answer. Some DNS servers may have an configuration option to
14849 mark the answers from their own zones as verified (they set the AD bit).
14850 Others do not have this option. It is considered as poor practice using
14851 a resolver that is an authoritative server for some zones.
14852
14853 Use this option only if you really have to (e.g. if you want
14854 to use DANE for remote delivery to a server that is listed in the DNS
14855 zones that your resolver is authoritative for).
14856
14857 If the DNS answer packet has the AA bit set and contains resource record
14858 in the answer section, the name of the first NS record appearing in the
14859 authority section is compared against the list. If the answer packet is
14860 authoritative but the answer section is empty, the name of the first SOA
14861 record in the authoritative section is used instead.
14862
14863 .cindex "DNS" "resolver options"
14864 .option dns_use_edns0 main integer -1
14865 .cindex "DNS" "resolver options"
14866 .cindex "DNS" "EDNS0"
14867 .cindex "DNS" "OpenBSD
14868 If this option is set to a non-negative number then Exim will initialise the
14869 DNS resolver library to either use or not use EDNS0 extensions, overriding
14870 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
14871 on.
14872
14873 If the resolver library does not support EDNS0 then this option has no effect.
14874
14875 OpenBSD's asr resolver routines are known to ignore the EDNS0 option; this
14876 means that DNSSEC will not work with Exim on that platform either, unless Exim
14877 is linked against an alternative DNS client library.
14878
14879
14880 .option drop_cr main boolean false
14881 This is an obsolete option that is now a no-op. It used to affect the way Exim
14882 handled CR and LF characters in incoming messages. What happens now is
14883 described in section &<<SECTlineendings>>&.
14884
14885 .option dsn_advertise_hosts main "host list&!!" unset
14886 .cindex "bounce messages" "success"
14887 .cindex "DSN" "success"
14888 .cindex "Delivery Status Notification" "success"
14889 DSN extensions (RFC3461) will be advertised in the EHLO message to,
14890 and accepted from, these hosts.
14891 Hosts may use the NOTIFY and ENVID options on RCPT TO commands,
14892 and RET and ORCPT options on MAIL FROM commands.
14893 A NOTIFY=SUCCESS option requests success-DSN messages.
14894 A NOTIFY= option with no argument requests that no delay or failure DSNs
14895 are sent.
14896
14897 .option dsn_from main "string&!!" "see below"
14898 .cindex "&'From:'& header line" "in bounces"
14899 .cindex "bounce messages" "&'From:'& line, specifying"
14900 This option can be used to vary the contents of &'From:'& header lines in
14901 bounces and other automatically generated messages (&"Delivery Status
14902 Notifications"& &-- hence the name of the option). The default setting is:
14903 .code
14904 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
14905 .endd
14906 The value is expanded every time it is needed. If the expansion fails, a
14907 panic is logged, and the default value is used.
14908
14909 .option envelope_to_remove main boolean true
14910 .cindex "&'Envelope-to:'& header line"
14911 Exim's transports have an option for adding an &'Envelope-to:'& header to a
14912 message when it is delivered, in exactly the same way as &'Return-path:'& is
14913 handled. &'Envelope-to:'& records the original recipient address from the
14914 message's envelope that caused the delivery to happen. Such headers should not
14915 be present in incoming messages, and this option causes them to be removed at
14916 the time the message is received, to avoid any problems that might occur when a
14917 delivered message is subsequently sent on to some other recipient.
14918
14919
14920 .option errors_copy main "string list&!!" unset
14921 .cindex "bounce message" "copy to other address"
14922 .cindex "copy of bounce message"
14923 Setting this option causes Exim to send bcc copies of bounce messages that it
14924 generates to other addresses. &*Note*&: This does not apply to bounce messages
14925 coming from elsewhere. The value of the option is a colon-separated list of
14926 items. Each item consists of a pattern, terminated by white space, followed by
14927 a comma-separated list of email addresses. If a pattern contains spaces, it
14928 must be enclosed in double quotes.
14929
14930 Each pattern is processed in the same way as a single item in an address list
14931 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
14932 the bounce message, the message is copied to the addresses on the list. The
14933 items are scanned in order, and once a matching one is found, no further items
14934 are examined. For example:
14935 .code
14936 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
14937               rqps@mydomain   hostmaster@mydomain.example,\
14938                               postmaster@mydomain.example
14939 .endd
14940 .vindex "&$domain$&"
14941 .vindex "&$local_part$&"
14942 The address list is expanded before use. The expansion variables &$local_part$&
14943 and &$domain$& are set from the original recipient of the error message, and if
14944 there was any wildcard matching in the pattern, the expansion
14945 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
14946 variables &$0$&, &$1$&, etc. are set in the normal way.
14947
14948
14949 .option errors_reply_to main string unset
14950 .cindex "bounce message" "&'Reply-to:'& in"
14951 By default, Exim's bounce and delivery warning messages contain the header line
14952 .display
14953 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
14954 .endd
14955 .oindex &%quota_warn_message%&
14956 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
14957 A warning message that is generated by the &%quota_warn_message%& option in an
14958 &(appendfile)& transport may contain its own &'From:'& header line that
14959 overrides the default.
14960
14961 Experience shows that people reply to bounce messages. If the
14962 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
14963 and warning messages. For example:
14964 .code
14965 errors_reply_to = postmaster@my.domain.example
14966 .endd
14967 The value of the option is not expanded. It must specify a valid RFC 2822
14968 address. However, if a warning message that is generated by the
14969 &%quota_warn_message%& option in an &(appendfile)& transport contain its
14970 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
14971 not used.
14972
14973
14974 .option event_action main string&!! unset
14975 .cindex events
14976 This option declares a string to be expanded for Exim's events mechanism.
14977 For details see chapter &<<CHAPevents>>&.
14978
14979
14980 .option exim_group main string "compile-time configured"
14981 .cindex "gid (group id)" "Exim's own"
14982 .cindex "Exim group"
14983 This option changes the gid under which Exim runs when it gives up root
14984 privilege. The default value is compiled into the binary. The value of this
14985 option is used only when &%exim_user%& is also set. Unless it consists entirely
14986 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
14987 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
14988 security issues.
14989
14990
14991 .option exim_path main string "see below"
14992 .cindex "Exim binary, path name"
14993 This option specifies the path name of the Exim binary, which is used when Exim
14994 needs to re-exec itself. The default is set up to point to the file &'exim'& in
14995 the directory configured at compile time by the BIN_DIRECTORY setting. It
14996 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
14997 other place.
14998 &*Warning*&: Do not use a macro to define the value of this option, because
14999 you will break those Exim utilities that scan the configuration file to find
15000 where the binary is. (They then use the &%-bP%& option to extract option
15001 settings such as the value of &%spool_directory%&.)
15002
15003
15004 .option exim_user main string "compile-time configured"
15005 .cindex "uid (user id)" "Exim's own"
15006 .cindex "Exim user"
15007 This option changes the uid under which Exim runs when it gives up root
15008 privilege. The default value is compiled into the binary. Ownership of the run
15009 time configuration file and the use of the &%-C%& and &%-D%& command line
15010 options is checked against the values in the binary, not what is set here.
15011
15012 Unless it consists entirely of digits, the string is looked up using
15013 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
15014 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
15015 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
15016
15017
15018 .option extra_local_interfaces main "string list" unset
15019 This option defines network interfaces that are to be considered local when
15020 routing, but which are not used for listening by the daemon. See section
15021 &<<SECTreclocipadd>>& for details.
15022
15023
15024 . Allow this long option name to split; give it unsplit as a fifth argument
15025 . for the automatic .oindex that is generated by .option.
15026
15027 .option "extract_addresses_remove_arguments" main boolean true &&&
15028          extract_addresses_remove_arguments
15029 .oindex "&%-t%&"
15030 .cindex "command line" "addresses with &%-t%&"
15031 .cindex "Sendmail compatibility" "&%-t%& option"
15032 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
15033 are present on the command line when the &%-t%& option is used to build an
15034 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
15035 line addresses are removed from the recipients list. This is also how Smail
15036 behaves. However, other Sendmail documentation (the O'Reilly book) states that
15037 command line addresses are added to those obtained from the header lines. When
15038 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
15039 argument headers. If it is set false, Exim adds rather than removes argument
15040 addresses.
15041
15042
15043 .option finduser_retries main integer 0
15044 .cindex "NIS, retrying user lookups"
15045 On systems running NIS or other schemes in which user and group information is
15046 distributed from a remote system, there can be times when &[getpwnam()]& and
15047 related functions fail, even when given valid data, because things time out.
15048 Unfortunately these failures cannot be distinguished from genuine &"not found"&
15049 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
15050 many extra times to find a user or a group, waiting for one second between
15051 retries.
15052
15053 .cindex "&_/etc/passwd_&" "multiple reading of"
15054 You should not set this option greater than zero if your user information is in
15055 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
15056 search the file multiple times for non-existent users, and also cause delay.
15057
15058
15059
15060 .option freeze_tell main "string list, comma separated" unset
15061 .cindex "freezing messages" "sending a message when freezing"
15062 On encountering certain errors, or when configured to do so in a system filter,
15063 ACL, or special router, Exim freezes a message. This means that no further
15064 delivery attempts take place until an administrator thaws the message, or the
15065 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
15066 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
15067 warning message whenever it freezes something, unless the message it is
15068 freezing is a locally-generated bounce message. (Without this exception there
15069 is the possibility of looping.) The warning message is sent to the addresses
15070 supplied as the comma-separated value of this option. If several of the
15071 message's addresses cause freezing, only a single message is sent. If the
15072 freezing was automatic, the reason(s) for freezing can be found in the message
15073 log. If you configure freezing in a filter or ACL, you must arrange for any
15074 logging that you require.
15075
15076
15077 .option gecos_name main string&!! unset
15078 .cindex "HP-UX"
15079 .cindex "&""gecos""& field, parsing"
15080 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
15081 password file to hold other information in addition to users' real names. Exim
15082 looks up this field for use when it is creating &'Sender:'& or &'From:'&
15083 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
15084 of the field are used unchanged, except that, if an ampersand is encountered,
15085 it is replaced by the user's login name with the first character forced to
15086 upper case, since this is a convention that is observed on many systems.
15087
15088 When these options are set, &%gecos_pattern%& is treated as a regular
15089 expression that is to be applied to the field (again with && replaced by the
15090 login name), and if it matches, &%gecos_name%& is expanded and used as the
15091 user's name.
15092
15093 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
15094 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
15095 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
15096 name terminates at the first comma, the following can be used:
15097 .code
15098 gecos_pattern = ([^,]*)
15099 gecos_name = $1
15100 .endd
15101
15102 .option gecos_pattern main string unset
15103 See &%gecos_name%& above.
15104
15105
15106 .option gnutls_compat_mode main boolean unset
15107 This option controls whether GnuTLS is used in compatibility mode in an Exim
15108 server. This reduces security slightly, but improves interworking with older
15109 implementations of TLS.
15110
15111
15112 option gnutls_allow_auto_pkcs11 main boolean unset
15113 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
15114 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
15115
15116 See
15117 &url(http://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
15118 for documentation.
15119
15120
15121
15122 .option headers_charset main string "see below"
15123 This option sets a default character set for translating from encoded MIME
15124 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
15125 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
15126 ultimate default is ISO-8859-1. For more details see the description of header
15127 insertions in section &<<SECTexpansionitems>>&.
15128
15129
15130
15131 .option header_maxsize main integer "see below"
15132 .cindex "header section" "maximum size of"
15133 .cindex "limit" "size of message header section"
15134 This option controls the overall maximum size of a message's header
15135 section. The default is the value of HEADER_MAXSIZE in
15136 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
15137 sections are rejected.
15138
15139
15140 .option header_line_maxsize main integer 0
15141 .cindex "header lines" "maximum size of"
15142 .cindex "limit" "size of one header line"
15143 This option limits the length of any individual header line in a message, after
15144 all the continuations have been joined together. Messages with individual
15145 header lines that are longer than the limit are rejected. The default value of
15146 zero means &"no limit"&.
15147
15148
15149
15150
15151 .option helo_accept_junk_hosts main "host list&!!" unset
15152 .cindex "HELO" "accepting junk data"
15153 .cindex "EHLO" "accepting junk data"
15154 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
15155 mail, and gives an error response for invalid data. Unfortunately, there are
15156 some SMTP clients that send syntactic junk. They can be accommodated by setting
15157 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
15158 if you want to do semantic checking.
15159 See also &%helo_allow_chars%& for a way of extending the permitted character
15160 set.
15161
15162
15163 .option helo_allow_chars main string unset
15164 .cindex "HELO" "underscores in"
15165 .cindex "EHLO" "underscores in"
15166 .cindex "underscore in EHLO/HELO"
15167 This option can be set to a string of rogue characters that are permitted in
15168 all EHLO and HELO names in addition to the standard letters, digits,
15169 hyphens, and dots. If you really must allow underscores, you can set
15170 .code
15171 helo_allow_chars = _
15172 .endd
15173 Note that the value is one string, not a list.
15174
15175
15176 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
15177 .cindex "HELO" "forcing reverse lookup"
15178 .cindex "EHLO" "forcing reverse lookup"
15179 If the domain given by a client in a HELO or EHLO command matches this
15180 list, a reverse lookup is done in order to establish the host's true name. The
15181 default forces a lookup if the client host gives the server's name or any of
15182 its IP addresses (in brackets), something that broken clients have been seen to
15183 do.
15184
15185
15186 .option helo_try_verify_hosts main "host list&!!" unset
15187 .cindex "HELO verifying" "optional"
15188 .cindex "EHLO" "verifying, optional"
15189 By default, Exim just checks the syntax of HELO and EHLO commands (see
15190 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
15191 to do more extensive checking of the data supplied by these commands. The ACL
15192 condition &`verify = helo`& is provided to make this possible.
15193 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
15194 to force the check to occur. From release 4.53 onwards, this is no longer
15195 necessary. If the check has not been done before &`verify = helo`& is
15196 encountered, it is done at that time. Consequently, this option is obsolete.
15197 Its specification is retained here for backwards compatibility.
15198
15199 When an EHLO or HELO command is received, if the calling host matches
15200 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
15201 EHLO command either:
15202
15203 .ilist
15204 is an IP literal matching the calling address of the host, or
15205 .next
15206 .cindex "DNS" "reverse lookup"
15207 .cindex "reverse DNS lookup"
15208 matches the host name that Exim obtains by doing a reverse lookup of the
15209 calling host address, or
15210 .next
15211 when looked up in DNS yields the calling host address.
15212 .endlist
15213
15214 However, the EHLO or HELO command is not rejected if any of the checks
15215 fail. Processing continues, but the result of the check is remembered, and can
15216 be detected later in an ACL by the &`verify = helo`& condition.
15217
15218 If DNS was used for successful verification, the variable
15219 .cindex "DNS" "DNSSEC"
15220 &$helo_verify_dnssec$& records the DNSSEC status of the lookups.
15221
15222 .option helo_verify_hosts main "host list&!!" unset
15223 .cindex "HELO verifying" "mandatory"
15224 .cindex "EHLO" "verifying, mandatory"
15225 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
15226 backwards compatibility. For hosts that match this option, Exim checks the host
15227 name given in the HELO or EHLO in the same way as for
15228 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
15229 rejected with a 550 error, and entries are written to the main and reject logs.
15230 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
15231 error.
15232
15233 .option hold_domains main "domain list&!!" unset
15234 .cindex "domain" "delaying delivery"
15235 .cindex "delivery" "delaying certain domains"
15236 This option allows mail for particular domains to be held on the queue
15237 manually. The option is overridden if a message delivery is forced with the
15238 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
15239 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
15240 item in &%hold_domains%&, no routing or delivery for that address is done, and
15241 it is deferred every time the message is looked at.
15242
15243 This option is intended as a temporary operational measure for delaying the
15244 delivery of mail while some problem is being sorted out, or some new
15245 configuration tested. If you just want to delay the processing of some
15246 domains until a queue run occurs, you should use &%queue_domains%& or
15247 &%queue_smtp_domains%&, not &%hold_domains%&.
15248
15249 A setting of &%hold_domains%& does not override Exim's code for removing
15250 messages from the queue if they have been there longer than the longest retry
15251 time in any retry rule. If you want to hold messages for longer than the normal
15252 retry times, insert a dummy retry rule with a long retry time.
15253
15254
15255 .option host_lookup main "host list&!!" unset
15256 .cindex "host name" "lookup, forcing"
15257 Exim does not look up the name of a calling host from its IP address unless it
15258 is required to compare against some host list, or the host matches
15259 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
15260 option (which normally contains IP addresses rather than host names). The
15261 default configuration file contains
15262 .code
15263 host_lookup = *
15264 .endd
15265 which causes a lookup to happen for all hosts. If the expense of these lookups
15266 is felt to be too great, the setting can be changed or removed.
15267
15268 After a successful reverse lookup, Exim does a forward lookup on the name it
15269 has obtained, to verify that it yields the IP address that it started with. If
15270 this check fails, Exim behaves as if the name lookup failed.
15271
15272 .vindex "&$host_lookup_failed$&"
15273 .vindex "&$sender_host_name$&"
15274 After any kind of failure, the host name (in &$sender_host_name$&) remains
15275 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
15276 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
15277 &`verify = reverse_host_lookup`& in ACLs.
15278
15279
15280 .option host_lookup_order main "string list" &`bydns:byaddr`&
15281 This option specifies the order of different lookup methods when Exim is trying
15282 to find a host name from an IP address. The default is to do a DNS lookup
15283 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
15284 if that fails. You can change the order of these lookups, or omit one entirely,
15285 if you want.
15286
15287 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
15288 multiple PTR records in the DNS and the IP address is not listed in
15289 &_/etc/hosts_&. Different operating systems give different results in this
15290 case. That is why the default tries a DNS lookup first.
15291
15292
15293
15294 .option host_reject_connection main "host list&!!" unset
15295 .cindex "host" "rejecting connections from"
15296 If this option is set, incoming SMTP calls from the hosts listed are rejected
15297 as soon as the connection is made.
15298 This option is obsolete, and retained only for backward compatibility, because
15299 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
15300 connections immediately.
15301
15302 The ability to give an immediate rejection (either by this option or using an
15303 ACL) is provided for use in unusual cases. Many hosts will just try again,
15304 sometimes without much delay. Normally, it is better to use an ACL to reject
15305 incoming messages at a later stage, such as after RCPT commands. See
15306 chapter &<<CHAPACL>>&.
15307
15308
15309 .option hosts_connection_nolog main "host list&!!" unset
15310 .cindex "host" "not logging connections from"
15311 This option defines a list of hosts for which connection logging does not
15312 happen, even though the &%smtp_connection%& log selector is set. For example,
15313 you might want not to log SMTP connections from local processes, or from
15314 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
15315 the daemon; you should therefore strive to restrict its value to a short inline
15316 list of IP addresses and networks. To disable logging SMTP connections from
15317 local processes, you must create a host list with an empty item. For example:
15318 .code
15319 hosts_connection_nolog = :
15320 .endd
15321 If the &%smtp_connection%& log selector is not set, this option has no effect.
15322
15323
15324
15325 .option hosts_proxy main "host list&!!" unset
15326 .cindex proxy "proxy protocol"
15327 This option enables use of Proxy Protocol proxies for incoming
15328 connections.  For details see section &<<SECTproxyInbound>>&.
15329
15330
15331 .option hosts_treat_as_local main "domain list&!!" unset
15332 .cindex "local host" "domains treated as"
15333 .cindex "host" "treated as local"
15334 If this option is set, any host names that match the domain list are treated as
15335 if they were the local host when Exim is scanning host lists obtained from MX
15336 records
15337 or other sources. Note that the value of this option is a domain list, not a
15338 host list, because it is always used to check host names, not IP addresses.
15339
15340 This option also applies when Exim is matching the special items
15341 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
15342 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
15343 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
15344 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
15345 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
15346 interfaces and recognizing the local host.
15347
15348
15349 .option ibase_servers main "string list" unset
15350 .cindex "InterBase" "server list"
15351 This option provides a list of InterBase servers and associated connection data,
15352 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
15353 The option is available only if Exim has been built with InterBase support.
15354
15355
15356
15357 .option ignore_bounce_errors_after main time 10w
15358 .cindex "bounce message" "discarding"
15359 .cindex "discarding bounce message"
15360 This option affects the processing of bounce messages that cannot be delivered,
15361 that is, those that suffer a permanent delivery failure. (Bounce messages that
15362 suffer temporary delivery failures are of course retried in the usual way.)
15363
15364 After a permanent delivery failure, bounce messages are frozen,
15365 because there is no sender to whom they can be returned. When a frozen bounce
15366 message has been on the queue for more than the given time, it is unfrozen at
15367 the next queue run, and a further delivery is attempted. If delivery fails
15368 again, the bounce message is discarded. This makes it possible to keep failed
15369 bounce messages around for a shorter time than the normal maximum retry time
15370 for frozen messages. For example,
15371 .code
15372 ignore_bounce_errors_after = 12h
15373 .endd
15374 retries failed bounce message deliveries after 12 hours, discarding any further
15375 failures. If the value of this option is set to a zero time period, bounce
15376 failures are discarded immediately. Setting a very long time (as in the default
15377 value) has the effect of disabling this option. For ways of automatically
15378 dealing with other kinds of frozen message, see &%auto_thaw%& and
15379 &%timeout_frozen_after%&.
15380
15381
15382 .option ignore_fromline_hosts main "host list&!!" unset
15383 .cindex "&""From""& line"
15384 .cindex "UUCP" "&""From""& line"
15385 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
15386 the headers of a message. By default this is treated as the start of the
15387 message's body, which means that any following headers are not recognized as
15388 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
15389 match those hosts that insist on sending it. If the sender is actually a local
15390 process rather than a remote host, and is using &%-bs%& to inject the messages,
15391 &%ignore_fromline_local%& must be set to achieve this effect.
15392
15393
15394 .option ignore_fromline_local main boolean false
15395 See &%ignore_fromline_hosts%& above.
15396
15397 .option keep_environment main "string list" unset
15398 .cindex "environment" "values from"
15399 This option contains a string list of environment variables to keep.
15400 You have to trust these variables or you have to be sure that
15401 these variables do not impose any security risk. Keep in mind that
15402 during the startup phase Exim is running with an effective UID 0 in most
15403 installations. As the default value is an empty list, the default
15404 environment for using libraries, running embedded Perl code, or running
15405 external binaries is empty, and does not not even contain PATH or HOME.
15406
15407 Actually the list is interpreted as a list of patterns
15408 (&<<SECTlistexpand>>&), except that it is not expanded first.
15409
15410 WARNING: Macro substitution is still done first, so having a macro
15411 FOO and having FOO_HOME in your &%keep_environment%& option may have
15412 unexpected results. You may work around this using a regular expression
15413 that does not match the macro name: ^[F]OO_HOME$.
15414
15415 Current versions of Exim issue a warning during startup if you do not mention
15416 &%keep_environment%& in your runtime configuration file and if your
15417 current environment is not empty. Future versions may not issue that warning
15418 anymore.
15419
15420 See the &%add_environment%& main config option for a way to set
15421 environment variables to a fixed value.  The environment for &(pipe)&
15422 transports is handled separately, see section &<<SECTpipeenv>>& for
15423 details.
15424
15425
15426 .option keep_malformed main time 4d
15427 This option specifies the length of time to keep messages whose spool files
15428 have been corrupted in some way. This should, of course, never happen. At the
15429 next attempt to deliver such a message, it gets removed. The incident is
15430 logged.
15431
15432
15433 .option ldap_ca_cert_dir main string unset
15434 .cindex "LDAP", "TLS CA certificate directory"
15435 .cindex certificate "directory for LDAP"
15436 This option indicates which directory contains CA certificates for verifying
15437 a TLS certificate presented by an LDAP server.
15438 While Exim does not provide a default value, your SSL library may.
15439 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
15440 and constrained to be a directory.
15441
15442
15443 .option ldap_ca_cert_file main string unset
15444 .cindex "LDAP", "TLS CA certificate file"
15445 .cindex certificate "file for LDAP"
15446 This option indicates which file contains CA certificates for verifying
15447 a TLS certificate presented by an LDAP server.
15448 While Exim does not provide a default value, your SSL library may.
15449 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
15450 and constrained to be a file.
15451
15452
15453 .option ldap_cert_file main string unset
15454 .cindex "LDAP" "TLS client certificate file"
15455 .cindex certificate "file for LDAP"
15456 This option indicates which file contains an TLS client certificate which
15457 Exim should present to the LDAP server during TLS negotiation.
15458 Should be used together with &%ldap_cert_key%&.
15459
15460
15461 .option ldap_cert_key main string unset
15462 .cindex "LDAP" "TLS client key file"
15463 .cindex certificate "key for LDAP"
15464 This option indicates which file contains the secret/private key to use
15465 to prove identity to the LDAP server during TLS negotiation.
15466 Should be used together with &%ldap_cert_file%&, which contains the
15467 identity to be proven.
15468
15469
15470 .option ldap_cipher_suite main string unset
15471 .cindex "LDAP" "TLS cipher suite"
15472 This controls the TLS cipher-suite negotiation during TLS negotiation with
15473 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
15474 cipher-suite options with OpenSSL (as used by LDAP client libraries).
15475
15476
15477 .option ldap_default_servers main "string list" unset
15478 .cindex "LDAP" "default servers"
15479 This option provides a list of LDAP servers which are tried in turn when an
15480 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
15481 details of LDAP queries. This option is available only when Exim has been built
15482 with LDAP support.
15483
15484
15485 .option ldap_require_cert main string unset.
15486 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
15487 This should be one of the values "hard", "demand", "allow", "try" or "never".
15488 A value other than one of these is interpreted as "never".
15489 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
15490 Although Exim does not set a default, the LDAP library probably defaults
15491 to hard/demand.
15492
15493
15494 .option ldap_start_tls main boolean false
15495 .cindex "LDAP" "whether or not to negotiate TLS"
15496 If set, Exim will attempt to negotiate TLS with the LDAP server when
15497 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
15498 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
15499 of SSL-on-connect.
15500 In the event of failure to negotiate TLS, the action taken is controlled
15501 by &%ldap_require_cert%&.
15502 This option is ignored for &`ldapi`& connections.
15503
15504
15505 .option ldap_version main integer unset
15506 .cindex "LDAP" "protocol version, forcing"
15507 This option can be used to force Exim to set a specific protocol version for
15508 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
15509 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
15510 the LDAP headers; otherwise it is 2. This option is available only when Exim
15511 has been built with LDAP support.
15512
15513
15514
15515 .option local_from_check main boolean true
15516 .cindex "&'Sender:'& header line" "disabling addition of"
15517 .cindex "&'From:'& header line" "disabling checking of"
15518 When a message is submitted locally (that is, not over a TCP/IP connection) by
15519 an untrusted user, Exim removes any existing &'Sender:'& header line, and
15520 checks that the &'From:'& header line matches the login of the calling user and
15521 the domain specified by &%qualify_domain%&.
15522
15523 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
15524 locally submitted message is automatically qualified by Exim, unless the
15525 &%-bnq%& command line option is used.
15526
15527 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
15528 on the local part. If the &'From:'& header line does not match, Exim adds a
15529 &'Sender:'& header with an address constructed from the calling user's login
15530 and the default qualify domain.
15531
15532 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
15533 and no &'Sender:'& header is ever added. If, in addition, you want to retain
15534 &'Sender:'& header lines supplied by untrusted users, you must also set
15535 &%local_sender_retain%& to be true.
15536
15537 .cindex "envelope sender"
15538 These options affect only the header lines in the message. The envelope sender
15539 is still forced to be the login id at the qualify domain unless
15540 &%untrusted_set_sender%& permits the user to supply an envelope sender.
15541
15542 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
15543 request similar header line checking. See section &<<SECTthesenhea>>&, which
15544 has more details about &'Sender:'& processing.
15545
15546
15547
15548
15549 .option local_from_prefix main string unset
15550 When Exim checks the &'From:'& header line of locally submitted messages for
15551 matching the login id (see &%local_from_check%& above), it can be configured to
15552 ignore certain prefixes and suffixes in the local part of the address. This is
15553 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
15554 appropriate lists, in the same form as the &%local_part_prefix%& and
15555 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
15556 example, if
15557 .code
15558 local_from_prefix = *-
15559 .endd
15560 is set, a &'From:'& line containing
15561 .code
15562 From: anything-user@your.domain.example
15563 .endd
15564 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
15565 matches the actual sender address that is constructed from the login name and
15566 qualify domain.
15567
15568
15569 .option local_from_suffix main string unset
15570 See &%local_from_prefix%& above.
15571
15572
15573 .option local_interfaces main "string list" "see below"
15574 This option controls which network interfaces are used by the daemon for
15575 listening; they are also used to identify the local host when routing. Chapter
15576 &<<CHAPinterfaces>>& contains a full description of this option and the related
15577 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
15578 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
15579 &%local_interfaces%& is
15580 .code
15581 local_interfaces = 0.0.0.0
15582 .endd
15583 when Exim is built without IPv6 support; otherwise it is
15584 .code
15585 local_interfaces = <; ::0 ; 0.0.0.0
15586 .endd
15587
15588 .option local_scan_timeout main time 5m
15589 .cindex "timeout" "for &[local_scan()]& function"
15590 .cindex "&[local_scan()]& function" "timeout"
15591 This timeout applies to the &[local_scan()]& function (see chapter
15592 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
15593 the incoming message is rejected with a temporary error if it is an SMTP
15594 message. For a non-SMTP message, the message is dropped and Exim ends with a
15595 non-zero code. The incident is logged on the main and reject logs.
15596
15597
15598
15599 .option local_sender_retain main boolean false
15600 .cindex "&'Sender:'& header line" "retaining from local submission"
15601 When a message is submitted locally (that is, not over a TCP/IP connection) by
15602 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
15603 do not want this to happen, you must set &%local_sender_retain%&, and you must
15604 also set &%local_from_check%& to be false (Exim will complain if you do not).
15605 See also the ACL modifier &`control = suppress_local_fixups`&. Section
15606 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
15607
15608
15609
15610
15611 .option localhost_number main string&!! unset
15612 .cindex "host" "locally unique number for"
15613 .cindex "message ids" "with multiple hosts"
15614 .vindex "&$localhost_number$&"
15615 Exim's message ids are normally unique only within the local host. If
15616 uniqueness among a set of hosts is required, each host must set a different
15617 value for the &%localhost_number%& option. The string is expanded immediately
15618 after reading the configuration file (so that a number can be computed from the
15619 host name, for example) and the result of the expansion must be a number in the
15620 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
15621 systems). This is available in subsequent string expansions via the variable
15622 &$localhost_number$&. When &%localhost_number is set%&, the final two
15623 characters of the message id, instead of just being a fractional part of the
15624 time, are computed from the time and the local host number as described in
15625 section &<<SECTmessiden>>&.
15626
15627
15628
15629 .option log_file_path main "string list&!!" "set at compile time"
15630 .cindex "log" "file path for"
15631 This option sets the path which is used to determine the names of Exim's log
15632 files, or indicates that logging is to be to syslog, or both. It is expanded
15633 when Exim is entered, so it can, for example, contain a reference to the host
15634 name. If no specific path is set for the log files at compile or run time,
15635 or if the option is unset at run time (i.e.  &`log_file_path = `&)
15636 they are written in a sub-directory called &_log_& in Exim's spool directory.
15637 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
15638 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
15639 used. If this string is fixed at your installation (contains no expansion
15640 variables) it is recommended that you do not set this option in the
15641 configuration file, but instead supply the path using LOG_FILE_PATH in
15642 &_Local/Makefile_& so that it is available to Exim for logging errors detected
15643 early on &-- in particular, failure to read the configuration file.
15644
15645
15646 .option log_selector main string unset
15647 .cindex "log" "selectors"
15648 This option can be used to reduce or increase the number of things that Exim
15649 writes to its log files. Its argument is made up of names preceded by plus or
15650 minus characters. For example:
15651 .code
15652 log_selector = +arguments -retry_defer
15653 .endd
15654 A list of possible names and what they control is given in the chapter on
15655 logging, in section &<<SECTlogselector>>&.
15656
15657
15658 .option log_timezone main boolean false
15659 .cindex "log" "timezone for entries"
15660 .vindex "&$tod_log$&"
15661 .vindex "&$tod_zone$&"
15662 By default, the timestamps on log lines are in local time without the
15663 timezone. This means that if your timezone changes twice a year, the timestamps
15664 in log lines are ambiguous for an hour when the clocks go back. One way of
15665 avoiding this problem is to set the timezone to UTC. An alternative is to set
15666 &%log_timezone%& true. This turns on the addition of the timezone offset to
15667 timestamps in log lines. Turning on this option can add quite a lot to the size
15668 of log files because each line is extended by 6 characters. Note that the
15669 &$tod_log$& variable contains the log timestamp without the zone, but there is
15670 another variable called &$tod_zone$& that contains just the timezone offset.
15671
15672
15673 .option lookup_open_max main integer 25
15674 .cindex "too many open files"
15675 .cindex "open files, too many"
15676 .cindex "file" "too many open"
15677 .cindex "lookup" "maximum open files"
15678 .cindex "limit" "open files for lookups"
15679 This option limits the number of simultaneously open files for single-key
15680 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
15681 Exim normally keeps these files open during routing, because often the same
15682 file is required several times. If the limit is reached, Exim closes the least
15683 recently used file. Note that if you are using the &'ndbm'& library, it
15684 actually opens two files for each logical DBM database, though it still counts
15685 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
15686 open files"& errors with NDBM, you need to reduce the value of
15687 &%lookup_open_max%&.
15688
15689
15690 .option max_username_length main integer 0
15691 .cindex "length of login name"
15692 .cindex "user name" "maximum length"
15693 .cindex "limit" "user name length"
15694 Some operating systems are broken in that they truncate long arguments to
15695 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
15696 this option is set greater than zero, any attempt to call &[getpwnam()]& with
15697 an argument that is longer behaves as if &[getpwnam()]& failed.
15698
15699
15700 .option message_body_newlines main bool false
15701 .cindex "message body" "newlines in variables"
15702 .cindex "newline" "in message body variables"
15703 .vindex "&$message_body$&"
15704 .vindex "&$message_body_end$&"
15705 By default, newlines in the message body are replaced by spaces when setting
15706 the &$message_body$& and &$message_body_end$& expansion variables. If this
15707 option is set true, this no longer happens.
15708
15709
15710 .option message_body_visible main integer 500
15711 .cindex "body of message" "visible size"
15712 .cindex "message body" "visible size"
15713 .vindex "&$message_body$&"
15714 .vindex "&$message_body_end$&"
15715 This option specifies how much of a message's body is to be included in the
15716 &$message_body$& and &$message_body_end$& expansion variables.
15717
15718
15719 .option message_id_header_domain main string&!! unset
15720 .cindex "&'Message-ID:'& header line"
15721 If this option is set, the string is expanded and used as the right hand side
15722 (domain) of the &'Message-ID:'& header that Exim creates if a
15723 locally-originated incoming message does not have one. &"Locally-originated"&
15724 means &"not received over TCP/IP."&
15725 Otherwise, the primary host name is used.
15726 Only letters, digits, dot and hyphen are accepted; any other characters are
15727 replaced by hyphens. If the expansion is forced to fail, or if the result is an
15728 empty string, the option is ignored.
15729
15730
15731 .option message_id_header_text main string&!! unset
15732 If this variable is set, the string is expanded and used to augment the text of
15733 the &'Message-id:'& header that Exim creates if a locally-originated incoming
15734 message does not have one. The text of this header is required by RFC 2822 to
15735 take the form of an address. By default, Exim uses its internal message id as
15736 the local part, and the primary host name as the domain. If this option is set,
15737 it is expanded, and provided the expansion is not forced to fail, and does not
15738 yield an empty string, the result is inserted into the header immediately
15739 before the @, separated from the internal message id by a dot. Any characters
15740 that are illegal in an address are automatically converted into hyphens. This
15741 means that variables such as &$tod_log$& can be used, because the spaces and
15742 colons will become hyphens.
15743
15744
15745 .option message_logs main boolean true
15746 .cindex "message logs" "disabling"
15747 .cindex "log" "message log; disabling"
15748 If this option is turned off, per-message log files are not created in the
15749 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
15750 Exim, by reducing the number of files involved in handling a message from a
15751 minimum of four (header spool file, body spool file, delivery journal, and
15752 per-message log) to three. The other major I/O activity is Exim's main log,
15753 which is not affected by this option.
15754
15755
15756 .option message_size_limit main string&!! 50M
15757 .cindex "message" "size limit"
15758 .cindex "limit" "message size"
15759 .cindex "size" "of message, limit"
15760 This option limits the maximum size of message that Exim will process. The
15761 value is expanded for each incoming connection so, for example, it can be made
15762 to depend on the IP address of the remote host for messages arriving via
15763 TCP/IP. After expansion, the value must be a sequence of decimal digits,
15764 optionally followed by K or M.
15765
15766 &*Note*&: This limit cannot be made to depend on a message's sender or any
15767 other properties of an individual message, because it has to be advertised in
15768 the server's response to EHLO. String expansion failure causes a temporary
15769 error. A value of zero means no limit, but its use is not recommended. See also
15770 &%bounce_return_size_limit%&.
15771
15772 Incoming SMTP messages are failed with a 552 error if the limit is
15773 exceeded; locally-generated messages either get a stderr message or a delivery
15774 failure message to the sender, depending on the &%-oe%& setting. Rejection of
15775 an oversized message is logged in both the main and the reject logs. See also
15776 the generic transport option &%message_size_limit%&, which limits the size of
15777 message that an individual transport can process.
15778
15779 If you use a virus-scanner and set this option to to a value larger than the
15780 maximum size that your virus-scanner is configured to support, you may get
15781 failures triggered by large mails.  The right size to configure for the
15782 virus-scanner depends upon what data is passed and the options in use but it's
15783 probably safest to just set it to a little larger than this value.  E.g., with a
15784 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
15785 some problems may result.
15786
15787 A value of 0 will disable size limit checking; Exim will still advertise the
15788 SIZE extension in an EHLO response, but without a limit, so as to permit
15789 SMTP clients to still indicate the message size along with the MAIL verb.
15790
15791
15792 .option move_frozen_messages main boolean false
15793 .cindex "frozen messages" "moving"
15794 This option, which is available only if Exim has been built with the setting
15795 .code
15796 SUPPORT_MOVE_FROZEN_MESSAGES=yes
15797 .endd
15798 in &_Local/Makefile_&, causes frozen messages and their message logs to be
15799 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
15800 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
15801 standard utilities for handling such moved messages, and they do not show up in
15802 lists generated by &%-bp%& or by the Exim monitor.
15803
15804
15805 .option mua_wrapper main boolean false
15806 Setting this option true causes Exim to run in a very restrictive mode in which
15807 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
15808 contains a full description of this facility.
15809
15810
15811
15812 .option mysql_servers main "string list" unset
15813 .cindex "MySQL" "server list"
15814 This option provides a list of MySQL servers and associated connection data, to
15815 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
15816 option is available only if Exim has been built with MySQL support.
15817
15818
15819 .option never_users main "string list&!!" unset
15820 This option is expanded just once, at the start of Exim's processing. Local
15821 message deliveries are normally run in processes that are setuid to the
15822 recipient, and remote deliveries are normally run under Exim's own uid and gid.
15823 It is usually desirable to prevent any deliveries from running as root, as a
15824 safety precaution.
15825
15826 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
15827 list of users that must not be used for local deliveries. This list is fixed in
15828 the binary and cannot be overridden by the configuration file. By default, it
15829 contains just the single user name &"root"&. The &%never_users%& runtime option
15830 can be used to add more users to the fixed list.
15831
15832 If a message is to be delivered as one of the users on the fixed list or the
15833 &%never_users%& list, an error occurs, and delivery is deferred. A common
15834 example is
15835 .code
15836 never_users = root:daemon:bin
15837 .endd
15838 Including root is redundant if it is also on the fixed list, but it does no
15839 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
15840 transport driver.
15841
15842
15843 .option openssl_options main "string list" "+no_sslv2 +single_dh_use +no_ticket"
15844 .cindex "OpenSSL "compatibility options"
15845 This option allows an administrator to adjust the SSL options applied
15846 by OpenSSL to connections.  It is given as a space-separated list of items,
15847 each one to be +added or -subtracted from the current value.
15848
15849 This option is only available if Exim is built against OpenSSL.  The values
15850 available for this option vary according to the age of your OpenSSL install.
15851 The &"all"& value controls a subset of flags which are available, typically
15852 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
15853 list the values known on your system and Exim should support all the
15854 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
15855 names lose the leading &"SSL_OP_"& and are lower-cased.
15856
15857 Note that adjusting the options can have severe impact upon the security of
15858 SSL as used by Exim.  It is possible to disable safety checks and shoot
15859 yourself in the foot in various unpleasant ways.  This option should not be
15860 adjusted lightly.  An unrecognised item will be detected at startup, by
15861 invoking Exim with the &%-bV%& flag.
15862
15863 The option affects Exim operating both as a server and as a client.
15864
15865 Historical note: prior to release 4.80, Exim defaulted this value to
15866 "+dont_insert_empty_fragments", which may still be needed for compatibility
15867 with some clients, but which lowers security by increasing exposure to
15868 some now infamous attacks.
15869
15870 Examples:
15871 .code
15872 # Make both old MS and old Eudora happy:
15873 openssl_options = -all +microsoft_big_sslv3_buffer \
15874                        +dont_insert_empty_fragments
15875
15876 # Disable older protocol versions:
15877 openssl_options = +no_sslv2 +no_sslv3
15878 .endd
15879
15880 Possible options may include:
15881 .ilist
15882 &`all`&
15883 .next
15884 &`allow_unsafe_legacy_renegotiation`&
15885 .next
15886 &`cipher_server_preference`&
15887 .next
15888 &`dont_insert_empty_fragments`&
15889 .next
15890 &`ephemeral_rsa`&
15891 .next
15892 &`legacy_server_connect`&
15893 .next
15894 &`microsoft_big_sslv3_buffer`&
15895 .next
15896 &`microsoft_sess_id_bug`&
15897 .next
15898 &`msie_sslv2_rsa_padding`&
15899 .next
15900 &`netscape_challenge_bug`&
15901 .next
15902 &`netscape_reuse_cipher_change_bug`&
15903 .next
15904 &`no_compression`&
15905 .next
15906 &`no_session_resumption_on_renegotiation`&
15907 .next
15908 &`no_sslv2`&
15909 .next
15910 &`no_sslv3`&
15911 .next
15912 &`no_ticket`&
15913 .next
15914 &`no_tlsv1`&
15915 .next
15916 &`no_tlsv1_1`&
15917 .next
15918 &`no_tlsv1_2`&
15919 .next
15920 &`safari_ecdhe_ecdsa_bug`&
15921 .next
15922 &`single_dh_use`&
15923 .next
15924 &`single_ecdh_use`&
15925 .next
15926 &`ssleay_080_client_dh_bug`&
15927 .next
15928 &`sslref2_reuse_cert_type_bug`&
15929 .next
15930 &`tls_block_padding_bug`&
15931 .next
15932 &`tls_d5_bug`&
15933 .next
15934 &`tls_rollback_bug`&
15935 .endlist
15936
15937 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
15938 all clients connecting using the MacOS SecureTransport TLS facility prior
15939 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
15940 to negotiate TLS then this option value might help, provided that your OpenSSL
15941 release is new enough to contain this work-around.  This may be a situation
15942 where you have to upgrade OpenSSL to get buggy clients working.
15943
15944
15945 .option oracle_servers main "string list" unset
15946 .cindex "Oracle" "server list"
15947 This option provides a list of Oracle servers and associated connection data,
15948 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
15949 The option is available only if Exim has been built with Oracle support.
15950
15951
15952 .option percent_hack_domains main "domain list&!!" unset
15953 .cindex "&""percent hack""&"
15954 .cindex "source routing" "in email address"
15955 .cindex "address" "source-routed"
15956 The &"percent hack"& is the convention whereby a local part containing a
15957 percent sign is re-interpreted as a new email address, with the percent
15958 replaced by @. This is sometimes called &"source routing"&, though that term is
15959 also applied to RFC 2822 addresses that begin with an @ character. If this
15960 option is set, Exim implements the percent facility for those domains listed,
15961 but no others. This happens before an incoming SMTP address is tested against
15962 an ACL.
15963
15964 &*Warning*&: The &"percent hack"& has often been abused by people who are
15965 trying to get round relaying restrictions. For this reason, it is best avoided
15966 if at all possible. Unfortunately, a number of less security-conscious MTAs
15967 implement it unconditionally. If you are running Exim on a gateway host, and
15968 routing mail through to internal MTAs without processing the local parts, it is
15969 a good idea to reject recipient addresses with percent characters in their
15970 local parts. Exim's default configuration does this.
15971
15972
15973 .option perl_at_start main boolean false
15974 .cindex "Perl"
15975 This option is available only when Exim is built with an embedded Perl
15976 interpreter. See chapter &<<CHAPperl>>& for details of its use.
15977
15978
15979 .option perl_startup main string unset
15980 .cindex "Perl"
15981 This option is available only when Exim is built with an embedded Perl
15982 interpreter. See chapter &<<CHAPperl>>& for details of its use.
15983
15984 .option perl_startup main boolean false
15985 .cindex "Perl"
15986 This Option enables the taint mode of the embedded Perl interpreter.
15987
15988
15989 .option pgsql_servers main "string list" unset
15990 .cindex "PostgreSQL lookup type" "server list"
15991 This option provides a list of PostgreSQL servers and associated connection
15992 data, to be used in conjunction with &(pgsql)& lookups (see section
15993 &<<SECID72>>&). The option is available only if Exim has been built with
15994 PostgreSQL support.
15995
15996
15997 .option pid_file_path main string&!! "set at compile time"
15998 .cindex "daemon" "pid file path"
15999 .cindex "pid file, path for"
16000 This option sets the name of the file to which the Exim daemon writes its
16001 process id. The string is expanded, so it can contain, for example, references
16002 to the host name:
16003 .code
16004 pid_file_path = /var/log/$primary_hostname/exim.pid
16005 .endd
16006 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
16007 spool directory.
16008 The value set by the option can be overridden by the &%-oP%& command line
16009 option. A pid file is not written if a &"non-standard"& daemon is run by means
16010 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
16011
16012
16013 .option pipelining_advertise_hosts main "host list&!!" *
16014 .cindex "PIPELINING" "suppressing advertising"
16015 This option can be used to suppress the advertisement of the SMTP
16016 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
16017 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
16018 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
16019 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
16020 that clients will use it; &"out of order"& commands that are &"expected"& do
16021 not count as protocol errors (see &%smtp_max_synprot_errors%&).
16022
16023
16024 .option prdr_enable main boolean false
16025 .cindex "PRDR" "enabling on server"
16026 This option can be used to enable the Per-Recipient Data Response extension
16027 to SMTP, defined by Eric Hall.
16028 If the option is set, PRDR is advertised by Exim when operating as a server.
16029 If the client requests PRDR, and more than one recipient, for a message
16030 an additional ACL is called for each recipient after the message content
16031 is received.  See section &<<SECTPRDRACL>>&.
16032
16033 .option preserve_message_logs main boolean false
16034 .cindex "message logs" "preserving"
16035 If this option is set, message log files are not deleted when messages are
16036 completed. Instead, they are moved to a sub-directory of the spool directory
16037 called &_msglog.OLD_&, where they remain available for statistical or debugging
16038 purposes. This is a dangerous option to set on systems with any appreciable
16039 volume of mail. Use with care!
16040
16041
16042 .option primary_hostname main string "see below"
16043 .cindex "name" "of local host"
16044 .cindex "host" "name of local"
16045 .cindex "local host" "name of"
16046 .vindex "&$primary_hostname$&"
16047 This specifies the name of the current host. It is used in the default EHLO or
16048 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
16049 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
16050 The value is also used by default in some SMTP response messages from an Exim
16051 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
16052
16053 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
16054 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
16055 contains only one component, Exim passes it to &[gethostbyname()]& (or
16056 &[getipnodebyname()]& when available) in order to obtain the fully qualified
16057 version. The variable &$primary_hostname$& contains the host name, whether set
16058 explicitly by this option, or defaulted.
16059
16060
16061 .option print_topbitchars main boolean false
16062 .cindex "printing characters"
16063 .cindex "8-bit characters"
16064 By default, Exim considers only those characters whose codes lie in the range
16065 32&--126 to be printing characters. In a number of circumstances (for example,
16066 when writing log entries) non-printing characters are converted into escape
16067 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
16068 is set, code values of 128 and above are also considered to be printing
16069 characters.
16070
16071 This option also affects the header syntax checks performed by the
16072 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
16073 the user's full name when constructing From: and Sender: addresses (as
16074 described in section &<<SECTconstr>>&). Setting this option can cause
16075 Exim to generate eight bit message headers that do not conform to the
16076 standards.
16077
16078
16079 .option process_log_path main string unset
16080 .cindex "process log path"
16081 .cindex "log" "process log"
16082 .cindex "&'exiwhat'&"
16083 This option sets the name of the file to which an Exim process writes its
16084 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
16085 utility script. If this option is unset, the file called &_exim-process.info_&
16086 in Exim's spool directory is used. The ability to specify the name explicitly
16087 can be useful in environments where two different Exims are running, using
16088 different spool directories.
16089
16090
16091 .option prod_requires_admin main boolean true
16092 .cindex "restricting access to features"
16093 .oindex "&%-M%&"
16094 .oindex "&%-R%&"
16095 .oindex "&%-q%&"
16096 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
16097 admin user unless &%prod_requires_admin%& is set false. See also
16098 &%queue_list_requires_admin%& and &%commandline_checks_require_admin%&.
16099
16100
16101 .option qualify_domain main string "see below"
16102 .cindex "domain" "for qualifying addresses"
16103 .cindex "address" "qualification"
16104 This option specifies the domain name that is added to any envelope sender
16105 addresses that do not have a domain qualification. It also applies to
16106 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
16107 are accepted by default only for locally-generated messages. Qualification is
16108 also applied to addresses in header lines such as &'From:'& and &'To:'& for
16109 locally-generated messages, unless the &%-bnq%& command line option is used.
16110
16111 Messages from external sources must always contain fully qualified addresses,
16112 unless the sending host matches &%sender_unqualified_hosts%& or
16113 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
16114 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
16115 necessary. Internally, Exim always works with fully qualified envelope
16116 addresses. If &%qualify_domain%& is not set, it defaults to the
16117 &%primary_hostname%& value.
16118
16119
16120 .option qualify_recipient main string "see below"
16121 This option allows you to specify a different domain for qualifying recipient
16122 addresses to the one that is used for senders. See &%qualify_domain%& above.
16123
16124
16125
16126 .option queue_domains main "domain list&!!" unset
16127 .cindex "domain" "specifying non-immediate delivery"
16128 .cindex "queueing incoming messages"
16129 .cindex "message" "queueing certain domains"
16130 This option lists domains for which immediate delivery is not required.
16131 A delivery process is started whenever a message is received, but only those
16132 domains that do not match are processed. All other deliveries wait until the
16133 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
16134
16135
16136 .option queue_list_requires_admin main boolean true
16137 .cindex "restricting access to features"
16138 .oindex "&%-bp%&"
16139 The &%-bp%& command-line option, which lists the messages that are on the
16140 queue, requires the caller to be an admin user unless
16141 &%queue_list_requires_admin%& is set false.
16142 See also &%prod_requires_admin%& and &%commandline_checks_require_admin%&.
16143
16144
16145 .option queue_only main boolean false
16146 .cindex "queueing incoming messages"
16147 .cindex "message" "queueing unconditionally"
16148 If &%queue_only%& is set, a delivery process is not automatically started
16149 whenever a message is received. Instead, the message waits on the queue for the
16150 next queue run. Even if &%queue_only%& is false, incoming messages may not get
16151 delivered immediately when certain conditions (such as heavy load) occur.
16152
16153 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
16154 and &%-odi%& command line options override &%queue_only%& unless
16155 &%queue_only_override%& is set false. See also &%queue_only_file%&,
16156 &%queue_only_load%&, and &%smtp_accept_queue%&.
16157
16158
16159 .option queue_only_file main string unset
16160 .cindex "queueing incoming messages"
16161 .cindex "message" "queueing by file existence"
16162 This option can be set to a colon-separated list of absolute path names, each
16163 one optionally preceded by &"smtp"&. When Exim is receiving a message,
16164 it tests for the existence of each listed path using a call to &[stat()]&. For
16165 each path that exists, the corresponding queueing option is set.
16166 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
16167 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
16168 .code
16169 queue_only_file = smtp/some/file
16170 .endd
16171 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
16172 &_/some/file_& exists.
16173
16174
16175 .option queue_only_load main fixed-point unset
16176 .cindex "load average"
16177 .cindex "queueing incoming messages"
16178 .cindex "message" "queueing by load"
16179 If the system load average is higher than this value, incoming messages from
16180 all sources are queued, and no automatic deliveries are started. If this
16181 happens during local or remote SMTP input, all subsequent messages received on
16182 the same SMTP connection are queued by default, whatever happens to the load in
16183 the meantime, but this can be changed by setting &%queue_only_load_latch%&
16184 false.
16185
16186 Deliveries will subsequently be performed by queue runner processes. This
16187 option has no effect on ancient operating systems on which Exim cannot
16188 determine the load average. See also &%deliver_queue_load_max%& and
16189 &%smtp_load_reserve%&.
16190
16191
16192 .option queue_only_load_latch main boolean true
16193 .cindex "load average" "re-evaluating per message"
16194 When this option is true (the default), once one message has been queued
16195 because the load average is higher than the value set by &%queue_only_load%&,
16196 all subsequent messages received on the same SMTP connection are also queued.
16197 This is a deliberate choice; even though the load average may fall below the
16198 threshold, it doesn't seem right to deliver later messages on the same
16199 connection when not delivering earlier ones. However, there are special
16200 circumstances such as very long-lived connections from scanning appliances
16201 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
16202 should be set false. This causes the value of the load average to be
16203 re-evaluated for each message.
16204
16205
16206 .option queue_only_override main boolean true
16207 .cindex "queueing incoming messages"
16208 When this option is true, the &%-od%&&'x'& command line options override the
16209 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
16210 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
16211 to override; they are accepted, but ignored.
16212
16213
16214 .option queue_run_in_order main boolean false
16215 .cindex "queue runner" "processing messages in order"
16216 If this option is set, queue runs happen in order of message arrival instead of
16217 in an arbitrary order. For this to happen, a complete list of the entire queue
16218 must be set up before the deliveries start. When the queue is all held in a
16219 single directory (the default), a single list is created for both the ordered
16220 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
16221 single list is not created when &%queue_run_in_order%& is false. In this case,
16222 the sub-directories are processed one at a time (in a random order), and this
16223 avoids setting up one huge list for the whole queue. Thus, setting
16224 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
16225 when the queue is large, because of the extra work in setting up the single,
16226 large list. In most situations, &%queue_run_in_order%& should not be set.
16227
16228
16229
16230 .option queue_run_max main integer&!! 5
16231 .cindex "queue runner" "maximum number of"
16232 This controls the maximum number of queue runner processes that an Exim daemon
16233 can run simultaneously. This does not mean that it starts them all at once,
16234 but rather that if the maximum number are still running when the time comes to
16235 start another one, it refrains from starting another one. This can happen with
16236 very large queues and/or very sluggish deliveries. This option does not,
16237 however, interlock with other processes, so additional queue runners can be
16238 started by other means, or by killing and restarting the daemon.
16239
16240 Setting this option to zero does not suppress queue runs; rather, it disables
16241 the limit, allowing any number of simultaneous queue runner processes to be
16242 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
16243 the daemon's command line.
16244
16245 .cindex queues named
16246 .cindex "named queues"
16247 To set limits for different named queues use
16248 an expansion depending on the &$queue_name$& variable.
16249
16250 .option queue_smtp_domains main "domain list&!!" unset
16251 .cindex "queueing incoming messages"
16252 .cindex "message" "queueing remote deliveries"
16253 When this option is set, a delivery process is started whenever a message is
16254 received, routing is performed, and local deliveries take place.
16255 However, if any SMTP deliveries are required for domains that match
16256 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
16257 message waits on the queue for the next queue run. Since routing of the message
16258 has taken place, Exim knows to which remote hosts it must be delivered, and so
16259 when the queue run happens, multiple messages for the same host are delivered
16260 over a single SMTP connection. The &%-odqs%& command line option causes all
16261 SMTP deliveries to be queued in this way, and is equivalent to setting
16262 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
16263 &%queue_domains%&.
16264
16265
16266 .option receive_timeout main time 0s
16267 .cindex "timeout" "for non-SMTP input"
16268 This option sets the timeout for accepting a non-SMTP message, that is, the
16269 maximum time that Exim waits when reading a message on the standard input. If
16270 the value is zero, it will wait for ever. This setting is overridden by the
16271 &%-or%& command line option. The timeout for incoming SMTP messages is
16272 controlled by &%smtp_receive_timeout%&.
16273
16274 .option received_header_text main string&!! "see below"
16275 .cindex "customizing" "&'Received:'& header"
16276 .cindex "&'Received:'& header line" "customizing"
16277 This string defines the contents of the &'Received:'& message header that is
16278 added to each message, except for the timestamp, which is automatically added
16279 on at the end (preceded by a semicolon). The string is expanded each time it is
16280 used. If the expansion yields an empty string, no &'Received:'& header line is
16281 added to the message. Otherwise, the string should start with the text
16282 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
16283 header lines. The default setting is:
16284
16285 .code
16286 received_header_text = Received: \
16287   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
16288   {${if def:sender_ident \
16289   {from ${quote_local_part:$sender_ident} }}\
16290   ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
16291   by $primary_hostname \
16292   ${if def:received_protocol {with $received_protocol}} \
16293   ${if def:tls_in_cipher {($tls_in_cipher)\n\t}}\
16294   (Exim $version_number)\n\t\
16295   ${if def:sender_address \
16296   {(envelope-from <$sender_address>)\n\t}}\
16297   id $message_exim_id\
16298   ${if def:received_for {\n\tfor $received_for}}
16299 .endd
16300
16301 The reference to the TLS cipher is omitted when Exim is built without TLS
16302 support. The use of conditional expansions ensures that this works for both
16303 locally generated messages and messages received from remote hosts, giving
16304 header lines such as the following:
16305 .code
16306 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
16307 by marley.carol.example with esmtp (Exim 4.00)
16308 (envelope-from <bob@carol.example>)
16309 id 16IOWa-00019l-00
16310 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
16311 Received: by scrooge.carol.example with local (Exim 4.00)
16312 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
16313 .endd
16314 Until the body of the message has been received, the timestamp is the time when
16315 the message started to be received. Once the body has arrived, and all policy
16316 checks have taken place, the timestamp is updated to the time at which the
16317 message was accepted.
16318
16319
16320 .option received_headers_max main integer 30
16321 .cindex "loop" "prevention"
16322 .cindex "mail loop prevention"
16323 .cindex "&'Received:'& header line" "counting"
16324 When a message is to be delivered, the number of &'Received:'& headers is
16325 counted, and if it is greater than this parameter, a mail loop is assumed to
16326 have occurred, the delivery is abandoned, and an error message is generated.
16327 This applies to both local and remote deliveries.
16328
16329
16330 .option recipient_unqualified_hosts main "host list&!!" unset
16331 .cindex "unqualified addresses"
16332 .cindex "host" "unqualified addresses from"
16333 This option lists those hosts from which Exim is prepared to accept unqualified
16334 recipient addresses in message envelopes. The addresses are made fully
16335 qualified by the addition of the &%qualify_recipient%& value. This option also
16336 affects message header lines. Exim does not reject unqualified recipient
16337 addresses in headers, but it qualifies them only if the message came from a
16338 host that matches &%recipient_unqualified_hosts%&,
16339 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
16340 option was not set.
16341
16342
16343 .option recipients_max main integer 0
16344 .cindex "limit" "number of recipients"
16345 .cindex "recipient" "maximum number"
16346 If this option is set greater than zero, it specifies the maximum number of
16347 original recipients for any message. Additional recipients that are generated
16348 by aliasing or forwarding do not count. SMTP messages get a 452 response for
16349 all recipients over the limit; earlier recipients are delivered as normal.
16350 Non-SMTP messages with too many recipients are failed, and no deliveries are
16351 done.
16352
16353 .cindex "RCPT" "maximum number of incoming"
16354 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
16355 RCPT commands in a single message.
16356
16357
16358 .option recipients_max_reject main boolean false
16359 If this option is set true, Exim rejects SMTP messages containing too many
16360 recipients by giving 552 errors to the surplus RCPT commands, and a 554
16361 error to the eventual DATA command. Otherwise (the default) it gives a 452
16362 error to the surplus RCPT commands and accepts the message on behalf of the
16363 initial set of recipients. The remote server should then re-send the message
16364 for the remaining recipients at a later time.
16365
16366
16367 .option remote_max_parallel main integer 2
16368 .cindex "delivery" "parallelism for remote"
16369 This option controls parallel delivery of one message to a number of remote
16370 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
16371 does all the remote deliveries for a message one by one. Otherwise, if a single
16372 message has to be delivered to more than one remote host, or if several copies
16373 have to be sent to the same remote host, up to &%remote_max_parallel%&
16374 deliveries are done simultaneously. If more than &%remote_max_parallel%&
16375 deliveries are required, the maximum number of processes are started, and as
16376 each one finishes, another is begun. The order of starting processes is the
16377 same as if sequential delivery were being done, and can be controlled by the
16378 &%remote_sort_domains%& option. If parallel delivery takes place while running
16379 with debugging turned on, the debugging output from each delivery process is
16380 tagged with its process id.
16381
16382 This option controls only the maximum number of parallel deliveries for one
16383 message in one Exim delivery process. Because Exim has no central queue
16384 manager, there is no way of controlling the total number of simultaneous
16385 deliveries if the configuration allows a delivery attempt as soon as a message
16386 is received.
16387
16388 .cindex "number of deliveries"
16389 .cindex "delivery" "maximum number of"
16390 If you want to control the total number of deliveries on the system, you
16391 need to set the &%queue_only%& option. This ensures that all incoming messages
16392 are added to the queue without starting a delivery process. Then set up an Exim
16393 daemon to start queue runner processes at appropriate intervals (probably
16394 fairly often, for example, every minute), and limit the total number of queue
16395 runners by setting the &%queue_run_max%& parameter. Because each queue runner
16396 delivers only one message at a time, the maximum number of deliveries that can
16397 then take place at once is &%queue_run_max%& multiplied by
16398 &%remote_max_parallel%&.
16399
16400 If it is purely remote deliveries you want to control, use
16401 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
16402 doing the SMTP routing before queueing, so that several messages for the same
16403 host will eventually get delivered down the same connection.
16404
16405
16406 .option remote_sort_domains main "domain list&!!" unset
16407 .cindex "sorting remote deliveries"
16408 .cindex "delivery" "sorting remote"
16409 When there are a number of remote deliveries for a message, they are sorted by
16410 domain into the order given by this list. For example,
16411 .code
16412 remote_sort_domains = *.cam.ac.uk:*.uk
16413 .endd
16414 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
16415 then to those in the &%uk%& domain, then to any others.
16416
16417
16418 .option retry_data_expire main time 7d
16419 .cindex "hints database" "data expiry"
16420 This option sets a &"use before"& time on retry information in Exim's hints
16421 database. Any older retry data is ignored. This means that, for example, once a
16422 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
16423 past failures.
16424
16425
16426 .option retry_interval_max main time 24h
16427 .cindex "retry" "limit on interval"
16428 .cindex "limit" "on retry interval"
16429 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
16430 intervals between delivery attempts for messages that cannot be delivered
16431 straight away. This option sets an overall limit to the length of time between
16432 retries. It cannot be set greater than 24 hours; any attempt to do so forces
16433 the default value.
16434
16435
16436 .option return_path_remove main boolean true
16437 .cindex "&'Return-path:'& header line" "removing"
16438 RFC 2821, section 4.4, states that an SMTP server must insert a
16439 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
16440 The &'Return-path:'& header preserves the sender address as received in the
16441 MAIL command. This description implies that this header should not be present
16442 in an incoming message. If &%return_path_remove%& is true, any existing
16443 &'Return-path:'& headers are removed from messages at the time they are
16444 received. Exim's transports have options for adding &'Return-path:'& headers at
16445 the time of delivery. They are normally used only for final local deliveries.
16446
16447
16448 .option return_size_limit main integer 100K
16449 This option is an obsolete synonym for &%bounce_return_size_limit%&.
16450
16451
16452 .option rfc1413_hosts main "host list&!!" @[]
16453 .cindex "RFC 1413"
16454 .cindex "host" "for RFC 1413 calls"
16455 RFC 1413 identification calls are made to any client host which matches
16456 an item in the list.
16457 The default value specifies just this host, being any local interface
16458 for the system.
16459
16460 .option rfc1413_query_timeout main time 0s
16461 .cindex "RFC 1413" "query timeout"
16462 .cindex "timeout" "for RFC 1413 call"
16463 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
16464 no RFC 1413 calls are ever made.
16465
16466
16467 .option sender_unqualified_hosts main "host list&!!" unset
16468 .cindex "unqualified addresses"
16469 .cindex "host" "unqualified addresses from"
16470 This option lists those hosts from which Exim is prepared to accept unqualified
16471 sender addresses. The addresses are made fully qualified by the addition of
16472 &%qualify_domain%&. This option also affects message header lines. Exim does
16473 not reject unqualified addresses in headers that contain sender addresses, but
16474 it qualifies them only if the message came from a host that matches
16475 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
16476 using TCP/IP), and the &%-bnq%& option was not set.
16477
16478 .option set_environment main "string list" empty
16479 .cindex "environment"
16480 This option allows to set individual environment variables that the
16481 currently linked libraries and programs in child processes use. The
16482 default list is empty,
16483
16484
16485 .option slow_lookup_log main integer 0
16486 .cindex "logging" "slow lookups"
16487 .cindex "dns" "logging slow lookups"
16488 This option controls logging of slow lookups.
16489 If the value is nonzero it is taken as a number of milliseconds
16490 and lookups taking longer than this are logged.
16491 Currently this applies only to DNS lookups.
16492
16493
16494
16495 .option smtp_accept_keepalive main boolean true
16496 .cindex "keepalive" "on incoming connection"
16497 This option controls the setting of the SO_KEEPALIVE option on incoming
16498 TCP/IP socket connections. When set, it causes the kernel to probe idle
16499 connections periodically, by sending packets with &"old"& sequence numbers. The
16500 other end of the connection should send an acknowledgment if the connection is
16501 still okay or a reset if the connection has been aborted. The reason for doing
16502 this is that it has the beneficial effect of freeing up certain types of
16503 connection that can get stuck when the remote host is disconnected without
16504 tidying up the TCP/IP call properly. The keepalive mechanism takes several
16505 hours to detect unreachable hosts.
16506
16507
16508
16509 .option smtp_accept_max main integer 20
16510 .cindex "limit" "incoming SMTP connections"
16511 .cindex "SMTP" "incoming connection count"
16512 .cindex "inetd"
16513 This option specifies the maximum number of simultaneous incoming SMTP calls
16514 that Exim will accept. It applies only to the listening daemon; there is no
16515 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
16516 value is set to zero, no limit is applied. However, it is required to be
16517 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
16518 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
16519
16520 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
16521 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
16522 that limit has not been reached for the client host, &%smtp_accept_reserve%&
16523 and &%smtp_load_reserve%& are then checked before accepting the connection.
16524
16525
16526 .option smtp_accept_max_nonmail main integer 10
16527 .cindex "limit" "non-mail SMTP commands"
16528 .cindex "SMTP" "limiting non-mail commands"
16529 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
16530 the connection if there are too many. This option defines &"too many"&. The
16531 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
16532 client looping sending EHLO, for example. The check is applied only if the
16533 client host matches &%smtp_accept_max_nonmail_hosts%&.
16534
16535 When a new message is expected, one occurrence of RSET is not counted. This
16536 allows a client to send one RSET between messages (this is not necessary,
16537 but some clients do it). Exim also allows one uncounted occurrence of HELO
16538 or EHLO, and one occurrence of STARTTLS between messages. After
16539 starting up a TLS session, another EHLO is expected, and so it too is not
16540 counted. The first occurrence of AUTH in a connection, or immediately
16541 following STARTTLS is not counted. Otherwise, all commands other than
16542 MAIL, RCPT, DATA, and QUIT are counted.
16543
16544
16545 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
16546 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
16547 check by setting this option. The default value makes it apply to all hosts. By
16548 changing the value, you can exclude any badly-behaved hosts that you have to
16549 live with.
16550
16551
16552 . Allow this long option name to split; give it unsplit as a fifth argument
16553 . for the automatic .oindex that is generated by .option.
16554 . We insert " &~&~" which is both pretty nasty visually and results in
16555 . non-searchable text.  HowItWorks.txt mentions an option for inserting
16556 . zero-width-space, which would be nicer visually and results in (at least)
16557 . html that Firefox will split on when it's forced to reflow (rather than
16558 . inserting a horizontal scrollbar).  However, the text is still not
16559 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
16560 . the option name to split.
16561
16562 .option "smtp_accept_max_per_connection" main integer 1000 &&&
16563          smtp_accept_max_per_connection
16564 .cindex "SMTP" "limiting incoming message count"
16565 .cindex "limit" "messages per SMTP connection"
16566 The value of this option limits the number of MAIL commands that Exim is
16567 prepared to accept over a single SMTP connection, whether or not each command
16568 results in the transfer of a message. After the limit is reached, a 421
16569 response is given to subsequent MAIL commands. This limit is a safety
16570 precaution against a client that goes mad (incidents of this type have been
16571 seen).
16572
16573
16574 .option smtp_accept_max_per_host main string&!! unset
16575 .cindex "limit" "SMTP connections from one host"
16576 .cindex "host" "limiting SMTP connections from"
16577 This option restricts the number of simultaneous IP connections from a single
16578 host (strictly, from a single IP address) to the Exim daemon. The option is
16579 expanded, to enable different limits to be applied to different hosts by
16580 reference to &$sender_host_address$&. Once the limit is reached, additional
16581 connection attempts from the same host are rejected with error code 421. This
16582 is entirely independent of &%smtp_accept_reserve%&. The option's default value
16583 of zero imposes no limit. If this option is set greater than zero, it is
16584 required that &%smtp_accept_max%& be non-zero.
16585
16586 &*Warning*&: When setting this option you should not use any expansion
16587 constructions that take an appreciable amount of time. The expansion and test
16588 happen in the main daemon loop, in order to reject additional connections
16589 without forking additional processes (otherwise a denial-of-service attack
16590 could cause a vast number or processes to be created). While the daemon is
16591 doing this processing, it cannot accept any other incoming connections.
16592
16593
16594
16595 .option smtp_accept_queue main integer 0
16596 .cindex "SMTP" "incoming connection count"
16597 .cindex "queueing incoming messages"
16598 .cindex "message" "queueing by SMTP connection count"
16599 If the number of simultaneous incoming SMTP connections being handled via the
16600 listening daemon exceeds this value, messages received by SMTP are just placed
16601 on the queue; no delivery processes are started automatically. The count is
16602 fixed at the start of an SMTP connection. It cannot be updated in the
16603 subprocess that receives messages, and so the queueing or not queueing applies
16604 to all messages received in the same connection.
16605
16606 A value of zero implies no limit, and clearly any non-zero value is useful only
16607 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
16608 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
16609 various &%-od%&&'x'& command line options.
16610
16611
16612 . See the comment on smtp_accept_max_per_connection
16613
16614 .option "smtp_accept_queue_per_connection" main integer 10 &&&
16615          smtp_accept_queue_per_connection
16616 .cindex "queueing incoming messages"
16617 .cindex "message" "queueing by message count"
16618 This option limits the number of delivery processes that Exim starts
16619 automatically when receiving messages via SMTP, whether via the daemon or by
16620 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
16621 and the number of messages received in a single SMTP session exceeds this
16622 number, subsequent messages are placed on the queue, but no delivery processes
16623 are started. This helps to limit the number of Exim processes when a server
16624 restarts after downtime and there is a lot of mail waiting for it on other
16625 systems. On large systems, the default should probably be increased, and on
16626 dial-in client systems it should probably be set to zero (that is, disabled).
16627
16628
16629 .option smtp_accept_reserve main integer 0
16630 .cindex "SMTP" "incoming call count"
16631 .cindex "host" "reserved"
16632 When &%smtp_accept_max%& is set greater than zero, this option specifies a
16633 number of SMTP connections that are reserved for connections from the hosts
16634 that are specified in &%smtp_reserve_hosts%&. The value set in
16635 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
16636 restricted to this number of connections; the option specifies a minimum number
16637 of connection slots for them, not a maximum. It is a guarantee that this group
16638 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
16639 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
16640 individual host.
16641
16642 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
16643 set to 5, once there are 45 active connections (from any hosts), new
16644 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
16645 provided the other criteria for acceptance are met.
16646
16647
16648 .option smtp_active_hostname main string&!! unset
16649 .cindex "host" "name in SMTP responses"
16650 .cindex "SMTP" "host name in responses"
16651 .vindex "&$primary_hostname$&"
16652 This option is provided for multi-homed servers that want to masquerade as
16653 several different hosts. At the start of an incoming SMTP connection, its value
16654 is expanded and used instead of the value of &$primary_hostname$& in SMTP
16655 responses. For example, it is used as domain name in the response to an
16656 incoming HELO or EHLO command.
16657
16658 .vindex "&$smtp_active_hostname$&"
16659 The active hostname is placed in the &$smtp_active_hostname$& variable, which
16660 is saved with any messages that are received. It is therefore available for use
16661 in routers and transports when the message is later delivered.
16662
16663 If this option is unset, or if its expansion is forced to fail, or if the
16664 expansion results in an empty string, the value of &$primary_hostname$& is
16665 used. Other expansion failures cause a message to be written to the main and
16666 panic logs, and the SMTP command receives a temporary error. Typically, the
16667 value of &%smtp_active_hostname%& depends on the incoming interface address.
16668 For example:
16669 .code
16670 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
16671   {cox.mydomain}{box.mydomain}}
16672 .endd
16673
16674 Although &$smtp_active_hostname$& is primarily concerned with incoming
16675 messages, it is also used as the default for HELO commands in callout
16676 verification if there is no remote transport from which to obtain a
16677 &%helo_data%& value.
16678
16679 .option smtp_banner main string&!! "see below"
16680 .cindex "SMTP" "welcome banner"
16681 .cindex "banner for SMTP"
16682 .cindex "welcome banner for SMTP"
16683 .cindex "customizing" "SMTP banner"
16684 This string, which is expanded every time it is used, is output as the initial
16685 positive response to an SMTP connection. The default setting is:
16686 .code
16687 smtp_banner = $smtp_active_hostname ESMTP Exim \
16688   $version_number $tod_full
16689 .endd
16690 Failure to expand the string causes a panic error. If you want to create a
16691 multiline response to the initial SMTP connection, use &"\n"& in the string at
16692 appropriate points, but not at the end. Note that the 220 code is not included
16693 in this string. Exim adds it automatically (several times in the case of a
16694 multiline response).
16695
16696
16697 .option smtp_check_spool_space main boolean true
16698 .cindex "checking disk space"
16699 .cindex "disk space, checking"
16700 .cindex "spool directory" "checking space"
16701 When this option is set, if an incoming SMTP session encounters the SIZE
16702 option on a MAIL command, it checks that there is enough space in the
16703 spool directory's partition to accept a message of that size, while still
16704 leaving free the amount specified by &%check_spool_space%& (even if that value
16705 is zero). If there isn't enough space, a temporary error code is returned.
16706
16707
16708 .option smtp_connect_backlog main integer 20
16709 .cindex "connection backlog"
16710 .cindex "SMTP" "connection backlog"
16711 .cindex "backlog of connections"
16712 This option specifies a maximum number of waiting SMTP connections. Exim passes
16713 this value to the TCP/IP system when it sets up its listener. Once this number
16714 of connections are waiting for the daemon's attention, subsequent connection
16715 attempts are refused at the TCP/IP level. At least, that is what the manuals
16716 say; in some circumstances such connection attempts have been observed to time
16717 out instead. For large systems it is probably a good idea to increase the
16718 value (to 50, say). It also gives some protection against denial-of-service
16719 attacks by SYN flooding.
16720
16721
16722 .option smtp_enforce_sync main boolean true
16723 .cindex "SMTP" "synchronization checking"
16724 .cindex "synchronization checking in SMTP"
16725 The SMTP protocol specification requires the client to wait for a response from
16726 the server at certain points in the dialogue. Without PIPELINING these
16727 synchronization points are after every command; with PIPELINING they are
16728 fewer, but they still exist.
16729
16730 Some spamming sites send out a complete set of SMTP commands without waiting
16731 for any response. Exim protects against this by rejecting a message if the
16732 client has sent further input when it should not have. The error response &"554
16733 SMTP synchronization error"& is sent, and the connection is dropped. Testing
16734 for this error cannot be perfect because of transmission delays (unexpected
16735 input may be on its way but not yet received when Exim checks). However, it
16736 does detect many instances.
16737
16738 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
16739 If you want to disable the check selectively (for example, only for certain
16740 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
16741 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
16742
16743
16744
16745 .option smtp_etrn_command main string&!! unset
16746 .cindex "ETRN" "command to be run"
16747 .vindex "&$domain$&"
16748 If this option is set, the given command is run whenever an SMTP ETRN
16749 command is received from a host that is permitted to issue such commands (see
16750 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
16751 are independently expanded. The expansion variable &$domain$& is set to the
16752 argument of the ETRN command, and no syntax checking is done on it. For
16753 example:
16754 .code
16755 smtp_etrn_command = /etc/etrn_command $domain \
16756                     $sender_host_address
16757 .endd
16758 A new process is created to run the command, but Exim does not wait for it to
16759 complete. Consequently, its status cannot be checked. If the command cannot be
16760 run, a line is written to the panic log, but the ETRN caller still receives
16761 a 250 success response. Exim is normally running under its own uid when
16762 receiving SMTP, so it is not possible for it to change the uid before running
16763 the command.
16764
16765
16766 .option smtp_etrn_serialize main boolean true
16767 .cindex "ETRN" "serializing"
16768 When this option is set, it prevents the simultaneous execution of more than
16769 one identical command as a result of ETRN in an SMTP connection. See
16770 section &<<SECTETRN>>& for details.
16771
16772
16773 .option smtp_load_reserve main fixed-point unset
16774 .cindex "load average"
16775 If the system load average ever gets higher than this, incoming SMTP calls are
16776 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
16777 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
16778 the load is over the limit. The option has no effect on ancient operating
16779 systems on which Exim cannot determine the load average. See also
16780 &%deliver_queue_load_max%& and &%queue_only_load%&.
16781
16782
16783
16784 .option smtp_max_synprot_errors main integer 3
16785 .cindex "SMTP" "limiting syntax and protocol errors"
16786 .cindex "limit" "SMTP syntax and protocol errors"
16787 Exim rejects SMTP commands that contain syntax or protocol errors. In
16788 particular, a syntactically invalid email address, as in this command:
16789 .code
16790 RCPT TO:<abc xyz@a.b.c>
16791 .endd
16792 causes immediate rejection of the command, before any other tests are done.
16793 (The ACL cannot be run if there is no valid address to set up for it.) An
16794 example of a protocol error is receiving RCPT before MAIL. If there are
16795 too many syntax or protocol errors in one SMTP session, the connection is
16796 dropped. The limit is set by this option.
16797
16798 .cindex "PIPELINING" "expected errors"
16799 When the PIPELINING extension to SMTP is in use, some protocol errors are
16800 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
16801 Exim assumes that PIPELINING will be used if it advertises it (see
16802 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
16803 not count towards the limit.
16804
16805
16806
16807 .option smtp_max_unknown_commands main integer 3
16808 .cindex "SMTP" "limiting unknown commands"
16809 .cindex "limit" "unknown SMTP commands"
16810 If there are too many unrecognized commands in an incoming SMTP session, an
16811 Exim server drops the connection. This is a defence against some kinds of abuse
16812 that subvert web
16813 clients
16814 into making connections to SMTP ports; in these circumstances, a number of
16815 non-SMTP command lines are sent first.
16816
16817
16818
16819 .option smtp_ratelimit_hosts main "host list&!!" unset
16820 .cindex "SMTP" "rate limiting"
16821 .cindex "limit" "rate of message arrival"
16822 .cindex "RCPT" "rate limiting"
16823 Some sites find it helpful to be able to limit the rate at which certain hosts
16824 can send them messages, and the rate at which an individual message can specify
16825 recipients.
16826
16827 Exim has two rate-limiting facilities. This section describes the older
16828 facility, which can limit rates within a single connection. The newer
16829 &%ratelimit%& ACL condition can limit rates across all connections. See section
16830 &<<SECTratelimiting>>& for details of the newer facility.
16831
16832 When a host matches &%smtp_ratelimit_hosts%&, the values of
16833 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
16834 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
16835 respectively. Each option, if set, must contain a set of four comma-separated
16836 values:
16837
16838 .ilist
16839 A threshold, before which there is no rate limiting.
16840 .next
16841 An initial time delay. Unlike other times in Exim, numbers with decimal
16842 fractional parts are allowed here.
16843 .next
16844 A factor by which to increase the delay each time.
16845 .next
16846 A maximum value for the delay. This should normally be less than 5 minutes,
16847 because after that time, the client is liable to timeout the SMTP command.
16848 .endlist
16849
16850 For example, these settings have been used successfully at the site which
16851 first suggested this feature, for controlling mail from their customers:
16852 .code
16853 smtp_ratelimit_mail = 2,0.5s,1.05,4m
16854 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
16855 .endd
16856 The first setting specifies delays that are applied to MAIL commands after
16857 two have been received over a single connection. The initial delay is 0.5
16858 seconds, increasing by a factor of 1.05 each time. The second setting applies
16859 delays to RCPT commands when more than four occur in a single message.
16860
16861
16862 .option smtp_ratelimit_mail main string unset
16863 See &%smtp_ratelimit_hosts%& above.
16864
16865
16866 .option smtp_ratelimit_rcpt main string unset
16867 See &%smtp_ratelimit_hosts%& above.
16868
16869
16870 .option smtp_receive_timeout main time&!! 5m
16871 .cindex "timeout" "for SMTP input"
16872 .cindex "SMTP" "input timeout"
16873 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
16874 input, including batch SMTP. If a line of input (either an SMTP command or a
16875 data line) is not received within this time, the SMTP connection is dropped and
16876 the message is abandoned.
16877 A line is written to the log containing one of the following messages:
16878 .code
16879 SMTP command timeout on connection from...
16880 SMTP data timeout on connection from...
16881 .endd
16882 The former means that Exim was expecting to read an SMTP command; the latter
16883 means that it was in the DATA phase, reading the contents of a message.
16884
16885 If the first character of the option is a &"$"& the option is
16886 expanded before use and may depend on
16887 &$sender_host_name$&, &$sender_host_address$& and &$sender_host_port$&.
16888
16889
16890 .oindex "&%-os%&"
16891 The value set by this option can be overridden by the
16892 &%-os%& command-line option. A setting of zero time disables the timeout, but
16893 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
16894 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
16895 timeout is controlled by &%receive_timeout%& and &%-or%&.
16896
16897
16898 .option smtp_reserve_hosts main "host list&!!" unset
16899 This option defines hosts for which SMTP connections are reserved; see
16900 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
16901
16902
16903 .option smtp_return_error_details main boolean false
16904 .cindex "SMTP" "details policy failures"
16905 .cindex "policy control" "rejection, returning details"
16906 In the default state, Exim uses bland messages such as
16907 &"Administrative prohibition"& when it rejects SMTP commands for policy
16908 reasons. Many sysadmins like this because it gives away little information
16909 to spammers. However, some other sysadmins who are applying strict checking
16910 policies want to give out much fuller information about failures. Setting
16911 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
16912 example, instead of &"Administrative prohibition"&, it might give:
16913 .code
16914 550-Rejected after DATA: '>' missing at end of address:
16915 550 failing address in "From" header is: <user@dom.ain
16916 .endd
16917
16918
16919 .option smtputf8_advertise_hosts main "host list&!!" *
16920 .cindex "SMTPUTF8" "advertising"
16921 When Exim is built with support for internationalised mail names,
16922 the availability thereof is advertised in
16923 response to EHLO only to those client hosts that match this option. See
16924 chapter &<<CHAPi18n>>& for details of Exim's support for internationalisation.
16925
16926
16927 .option spamd_address main string "127.0.0.1 783"
16928 This option is available when Exim is compiled with the content-scanning
16929 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
16930 See section &<<SECTscanspamass>>& for more details.
16931
16932
16933
16934 .new
16935 .option spf_guess main string "v=spf1 a/24 mx/24 ptr ?all"
16936 This option is available when Exim is compiled with SPF support.
16937 See section &<<SECSPF>>& for more details.
16938 .wen
16939
16940
16941
16942 .option split_spool_directory main boolean false
16943 .cindex "multiple spool directories"
16944 .cindex "spool directory" "split"
16945 .cindex "directories, multiple"
16946 If this option is set, it causes Exim to split its input directory into 62
16947 subdirectories, each with a single alphanumeric character as its name. The
16948 sixth character of the message id is used to allocate messages to
16949 subdirectories; this is the least significant base-62 digit of the time of
16950 arrival of the message.
16951
16952 Splitting up the spool in this way may provide better performance on systems
16953 where there are long mail queues, by reducing the number of files in any one
16954 directory. The msglog directory is also split up in a similar way to the input
16955 directory; however, if &%preserve_message_logs%& is set, all old msglog files
16956 are still placed in the single directory &_msglog.OLD_&.
16957
16958 It is not necessary to take any special action for existing messages when
16959 changing &%split_spool_directory%&. Exim notices messages that are in the
16960 &"wrong"& place, and continues to process them. If the option is turned off
16961 after a period of being on, the subdirectories will eventually empty and be
16962 automatically deleted.
16963
16964 When &%split_spool_directory%& is set, the behaviour of queue runner processes
16965 changes. Instead of creating a list of all messages in the queue, and then
16966 trying to deliver each one in turn, it constructs a list of those in one
16967 sub-directory and tries to deliver them, before moving on to the next
16968 sub-directory. The sub-directories are processed in a random order. This
16969 spreads out the scanning of the input directories, and uses less memory. It is
16970 particularly beneficial when there are lots of messages on the queue. However,
16971 if &%queue_run_in_order%& is set, none of this new processing happens. The
16972 entire queue has to be scanned and sorted before any deliveries can start.
16973
16974
16975 .option spool_directory main string&!! "set at compile time"
16976 .cindex "spool directory" "path to"
16977 This defines the directory in which Exim keeps its spool, that is, the messages
16978 it is waiting to deliver. The default value is taken from the compile-time
16979 configuration setting, if there is one. If not, this option must be set. The
16980 string is expanded, so it can contain, for example, a reference to
16981 &$primary_hostname$&.
16982
16983 If the spool directory name is fixed on your installation, it is recommended
16984 that you set it at build time rather than from this option, particularly if the
16985 log files are being written to the spool directory (see &%log_file_path%&).
16986 Otherwise log files cannot be used for errors that are detected early on, such
16987 as failures in the configuration file.
16988
16989 By using this option to override the compiled-in path, it is possible to run
16990 tests of Exim without using the standard spool.
16991
16992 .option spool_wireformat main boolean false
16993 .cindex "spool directory" "file formats"
16994 If this option is set, Exim may for some messages use an alternate format
16995 for data-files in the spool which matches the wire format.
16996 Doing this permits more efficient message reception and transmission.
16997 Currently it is only done for messages received using the EMSTP CHUNKING
16998 option.
16999
17000 The following variables will not have useful values:
17001 .code
17002 $max_received_linelength
17003 $body_linecount
17004 $body_zerocount
17005 .endd
17006
17007 Users of the local_scan() API (see &<<CHAPlocalscan>>&),
17008 and any external programs which are passed a reference to a message data file
17009 (except via the &"regex"&, &"malware"& or &"spam"&) ACL conditions)
17010 will need to be aware of the potential different format.
17011
17012 Using any of the ACL conditions noted will negate the reception benefit
17013 (as a Unix-mbox-format file is constructed for them).
17014 The transmission benefit is maintained.
17015
17016 .option sqlite_lock_timeout main time 5s
17017 .cindex "sqlite lookup type" "lock timeout"
17018 This option controls the timeout that the &(sqlite)& lookup uses when trying to
17019 access an SQLite database. See section &<<SECTsqlite>>& for more details.
17020
17021 .option strict_acl_vars main boolean false
17022 .cindex "&ACL;" "variables, handling unset"
17023 This option controls what happens if a syntactically valid but undefined ACL
17024 variable is referenced. If it is false (the default), an empty string
17025 is substituted; if it is true, an error is generated. See section
17026 &<<SECTaclvariables>>& for details of ACL variables.
17027
17028 .option strip_excess_angle_brackets main boolean false
17029 .cindex "angle brackets, excess"
17030 If this option is set, redundant pairs of angle brackets round &"route-addr"&
17031 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
17032 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
17033 passed on to another MTA, the excess angle brackets are not passed on. If this
17034 option is not set, multiple pairs of angle brackets cause a syntax error.
17035
17036
17037 .option strip_trailing_dot main boolean false
17038 .cindex "trailing dot on domain"
17039 .cindex "dot" "trailing on domain"
17040 If this option is set, a trailing dot at the end of a domain in an address is
17041 ignored. If this is in the envelope and the message is passed on to another
17042 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
17043 domain causes a syntax error.
17044 However, addresses in header lines are checked only when an ACL requests header
17045 syntax checking.
17046
17047
17048 .option syslog_duplication main boolean true
17049 .cindex "syslog" "duplicate log lines; suppressing"
17050 When Exim is logging to syslog, it writes the log lines for its three
17051 separate logs at different syslog priorities so that they can in principle
17052 be separated on the logging hosts. Some installations do not require this
17053 separation, and in those cases, the duplication of certain log lines is a
17054 nuisance. If &%syslog_duplication%& is set false, only one copy of any
17055 particular log line is written to syslog. For lines that normally go to
17056 both the main log and the reject log, the reject log version (possibly
17057 containing message header lines) is written, at LOG_NOTICE priority.
17058 Lines that normally go to both the main and the panic log are written at
17059 the LOG_ALERT priority.
17060
17061
17062 .option syslog_facility main string unset
17063 .cindex "syslog" "facility; setting"
17064 This option sets the syslog &"facility"& name, used when Exim is logging to
17065 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
17066 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
17067 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
17068 details of Exim's logging.
17069
17070
17071 .option syslog_pid main boolean true
17072 .cindex "syslog" "pid"
17073 If &%syslog_pid%& is set false, the PID on Exim's log lines are
17074 omitted when these lines are sent to syslog. (Syslog normally prefixes
17075 the log lines with the PID of the logging process automatically.) You need
17076 to enable the &`+pid`& log selector item, if you want Exim to write it's PID
17077 into the logs.) See chapter &<<CHAPlog>>& for details of Exim's logging.
17078
17079
17080
17081 .option syslog_processname main string &`exim`&
17082 .cindex "syslog" "process name; setting"
17083 This option sets the syslog &"ident"& name, used when Exim is logging to
17084 syslog. The value must be no longer than 32 characters. See chapter
17085 &<<CHAPlog>>& for details of Exim's logging.
17086
17087
17088
17089 .option syslog_timestamp main boolean true
17090 .cindex "syslog" "timestamps"
17091 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
17092 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
17093 details of Exim's logging.
17094
17095
17096 .option system_filter main string&!! unset
17097 .cindex "filter" "system filter"
17098 .cindex "system filter" "specifying"
17099 .cindex "Sieve filter" "not available for system filter"
17100 This option specifies an Exim filter file that is applied to all messages at
17101 the start of each delivery attempt, before any routing is done. System filters
17102 must be Exim filters; they cannot be Sieve filters. If the system filter
17103 generates any deliveries to files or pipes, or any new mail messages, the
17104 appropriate &%system_filter_..._transport%& option(s) must be set, to define
17105 which transports are to be used. Details of this facility are given in chapter
17106 &<<CHAPsystemfilter>>&.
17107 A forced expansion failure results in no filter operation.
17108
17109
17110 .option system_filter_directory_transport main string&!! unset
17111 .vindex "&$address_file$&"
17112 This sets the name of the transport driver that is to be used when the
17113 &%save%& command in a system message filter specifies a path ending in &"/"&,
17114 implying delivery of each message into a separate file in some directory.
17115 During the delivery, the variable &$address_file$& contains the path name.
17116
17117
17118 .option system_filter_file_transport main string&!! unset
17119 .cindex "file" "transport for system filter"
17120 This sets the name of the transport driver that is to be used when the &%save%&
17121 command in a system message filter specifies a path not ending in &"/"&. During
17122 the delivery, the variable &$address_file$& contains the path name.
17123
17124 .option system_filter_group main string unset
17125 .cindex "gid (group id)" "system filter"
17126 This option is used only when &%system_filter_user%& is also set. It sets the
17127 gid under which the system filter is run, overriding any gid that is associated
17128 with the user. The value may be numerical or symbolic.
17129
17130 .option system_filter_pipe_transport main string&!! unset
17131 .cindex "&(pipe)& transport" "for system filter"
17132 .vindex "&$address_pipe$&"
17133 This specifies the transport driver that is to be used when a &%pipe%& command
17134 is used in a system filter. During the delivery, the variable &$address_pipe$&
17135 contains the pipe command.
17136
17137
17138 .option system_filter_reply_transport main string&!! unset
17139 .cindex "&(autoreply)& transport" "for system filter"
17140 This specifies the transport driver that is to be used when a &%mail%& command
17141 is used in a system filter.
17142
17143
17144 .option system_filter_user main string unset
17145 .cindex "uid (user id)" "system filter"
17146 If this option is set to root, the system filter is run in the main Exim
17147 delivery process, as root.  Otherwise, the system filter runs in a separate
17148 process, as the given user, defaulting to the Exim run-time user.
17149 Unless the string consists entirely of digits, it
17150 is looked up in the password data. Failure to find the named user causes a
17151 configuration error. The gid is either taken from the password data, or
17152 specified by &%system_filter_group%&. When the uid is specified numerically,
17153 &%system_filter_group%& is required to be set.
17154
17155 If the system filter generates any pipe, file, or reply deliveries, the uid
17156 under which the filter is run is used when transporting them, unless a
17157 transport option overrides.
17158
17159
17160 .option tcp_nodelay main boolean true
17161 .cindex "daemon" "TCP_NODELAY on sockets"
17162 .cindex "Nagle algorithm"
17163 .cindex "TCP_NODELAY on listening sockets"
17164 If this option is set false, it stops the Exim daemon setting the
17165 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
17166 turns off the &"Nagle algorithm"&, which is a way of improving network
17167 performance in interactive (character-by-character) situations. Turning it off
17168 should improve Exim's performance a bit, so that is what happens by default.
17169 However, it appears that some broken clients cannot cope, and time out. Hence
17170 this option. It affects only those sockets that are set up for listening by the
17171 daemon. Sockets created by the smtp transport for delivering mail always set
17172 TCP_NODELAY.
17173
17174
17175 .option timeout_frozen_after main time 0s
17176 .cindex "frozen messages" "timing out"
17177 .cindex "timeout" "frozen messages"
17178 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
17179 message of any kind that has been on the queue for longer than the given time
17180 is automatically cancelled at the next queue run. If the frozen message is a
17181 bounce message, it is just discarded; otherwise, a bounce is sent to the
17182 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
17183 If you want to timeout frozen bounce messages earlier than other kinds of
17184 frozen message, see &%ignore_bounce_errors_after%&.
17185
17186 &*Note:*& the default value of zero means no timeouts; with this setting,
17187 frozen messages remain on the queue forever (except for any frozen bounce
17188 messages that are released by &%ignore_bounce_errors_after%&).
17189
17190
17191 .option timezone main string unset
17192 .cindex "timezone, setting"
17193 .cindex "environment" "values from"
17194 The value of &%timezone%& is used to set the environment variable TZ while
17195 running Exim (if it is different on entry). This ensures that all timestamps
17196 created by Exim are in the required timezone. If you want all your timestamps
17197 to be in UTC (aka GMT) you should set
17198 .code
17199 timezone = UTC
17200 .endd
17201 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
17202 or, if that is not set, from the value of the TZ environment variable when Exim
17203 is built. If &%timezone%& is set to the empty string, either at build or run
17204 time, any existing TZ variable is removed from the environment when Exim
17205 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
17206 unfortunately not all, operating systems.
17207
17208
17209 .option tls_advertise_hosts main "host list&!!" *
17210 .cindex "TLS" "advertising"
17211 .cindex "encryption" "on SMTP connection"
17212 .cindex "SMTP" "encrypted connection"
17213 When Exim is built with support for TLS encrypted connections, the availability
17214 of the STARTTLS command to set up an encrypted session is advertised in
17215 response to EHLO only to those client hosts that match this option. See
17216 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
17217 Note that the default value requires that a certificate be supplied
17218 using the &%tls_certificate%& option.  If TLS support for incoming connections
17219 is not required the &%tls_advertise_hosts%& option should be set empty.
17220
17221
17222 .option tls_certificate main string list&!! unset
17223 .cindex "TLS" "server certificate; location of"
17224 .cindex "certificate" "server, location of"
17225 The value of this option is expanded, and must then be a list of absolute paths to
17226 files which contains the server's certificates.  Commonly only one file is
17227 needed.
17228 The server's private key is also
17229 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
17230 &<<CHAPTLS>>& for further details.
17231
17232 &*Note*&: The certificates defined by this option are used only when Exim is
17233 receiving incoming messages as a server. If you want to supply certificates for
17234 use when sending messages as a client, you must set the &%tls_certificate%&
17235 option in the relevant &(smtp)& transport.
17236
17237 &*Note*&: If you use filenames based on IP addresses, change the list
17238 separator in the usual way to avoid confusion under IPv6.
17239
17240 &*Note*&: Under current versions of OpenSSL, when a list of more than one
17241 file is used, the &$tls_in_ourcert$& variable is unreliable.
17242
17243 &*Note*&: OCSP stapling is not usable under OpenSSL
17244 when a list of more than one file is used.
17245
17246 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
17247 if the OpenSSL build supports TLS extensions and the TLS client sends the
17248 Server Name Indication extension, then this option and others documented in
17249 &<<SECTtlssni>>& will be re-expanded.
17250
17251 If this option is unset or empty a fresh self-signed certificate will be
17252 generated for every connection.
17253
17254 .option tls_crl main string&!! unset
17255 .cindex "TLS" "server certificate revocation list"
17256 .cindex "certificate" "revocation list for server"
17257 This option specifies a certificate revocation list. The expanded value must
17258 be the name of a file that contains CRLs in PEM format.
17259
17260 .new
17261 Under OpenSSL the option can specify a directory with CRL files.
17262
17263 &*Note:*& Under OpenSSL the option must, if given, supply a CRL
17264 for each signing element of the certificate chain (i.e. all but the leaf).
17265 For the file variant this can be multiple PEM blocks in the one file.
17266 .wen
17267
17268 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17269
17270
17271 .option tls_dh_max_bits main integer 2236
17272 .cindex "TLS" "D-H bit count"
17273 The number of bits used for Diffie-Hellman key-exchange may be suggested by
17274 the chosen TLS library.  That value might prove to be too high for
17275 interoperability.  This option provides a maximum clamp on the value
17276 suggested, trading off security for interoperability.
17277
17278 The value must be at least 1024.
17279
17280 The value 2236 was chosen because, at time of adding the option, it was the
17281 hard-coded maximum value supported by the NSS cryptographic library, as used
17282 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
17283
17284 If you prefer more security and are willing to break some clients, raise this
17285 number.
17286
17287 Note that the value passed to GnuTLS for *generating* a new prime may be a
17288 little less than this figure, because GnuTLS is inexact and may produce a
17289 larger prime than requested.
17290
17291
17292 .option tls_dhparam main string&!! unset
17293 .cindex "TLS" "D-H parameters for server"
17294 The value of this option is expanded and indicates the source of DH parameters
17295 to be used by Exim.
17296
17297 &*Note: The Exim Maintainers strongly recommend using a filename with site-generated
17298 local DH parameters*&, which has been supported across all versions of Exim.  The
17299 other specific constants available are a fallback so that even when
17300 "unconfigured", Exim can offer Perfect Forward Secrecy in older ciphersuites in TLS.
17301
17302 If &%tls_dhparam%& is a filename starting with a &`/`&,
17303 then it names a file from which DH
17304 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
17305 PKCS#3 representation of the DH prime.  If the file does not exist, for
17306 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
17307 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
17308 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
17309 and treated as though the &%tls_dhparam%& were set to "none".
17310
17311 If this option expands to the string "none", then no DH parameters will be
17312 loaded by Exim.
17313
17314 If this option expands to the string "historic" and Exim is using GnuTLS, then
17315 Exim will attempt to load a file from inside the spool directory.  If the file
17316 does not exist, Exim will attempt to create it.
17317 See section &<<SECTgnutlsparam>>& for further details.
17318
17319 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
17320 a default DH prime; the default is Exim-specific but lacks verifiable provenance.
17321
17322 In older versions of Exim the default was the 2048 bit prime described in section
17323 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
17324 in IKE is assigned number 23.
17325
17326 Otherwise, the option must expand to the name used by Exim for any of a number
17327 of DH primes specified in RFC 2409, RFC 3526, RFC 5114, RFC 7919, or from other
17328 sources.  As names, Exim uses a standard specified name, else "ike" followed by
17329 the number used by IKE, or "default" which corresponds to
17330 &`exim.dev.20160529.3`&.
17331
17332 The available standard primes are:
17333 &`ffdhe2048`&, &`ffdhe3072`&, &`ffdhe4096`&, &`ffdhe6144`&, &`ffdhe8192`&,
17334 &`ike1`&, &`ike2`&, &`ike5`&,
17335 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
17336 &`ike22`&, &`ike23`& and &`ike24`&.
17337
17338 The available additional primes are:
17339 &`exim.dev.20160529.1`&, &`exim.dev.20160529.2`& and &`exim.dev.20160529.3`&.
17340
17341 Some of these will be too small to be accepted by clients.
17342 Some may be too large to be accepted by clients.
17343 The open cryptographic community has suspicions about the integrity of some
17344 of the later IKE values, which led into RFC7919 providing new fixed constants
17345 (the "ffdhe" identifiers).
17346
17347 At this point, all of the "ike" values should be considered obsolete;
17348 they're still in Exim to avoid breaking unusual configurations, but are
17349 candidates for removal the next time we have backwards-incompatible changes.
17350
17351 The TLS protocol does not negotiate an acceptable size for this; clients tend
17352 to hard-drop connections if what is offered by the server is unacceptable,
17353 whether too large or too small, and there's no provision for the client to
17354 tell the server what these constraints are.  Thus, as a server operator, you
17355 need to make an educated guess as to what is most likely to work for your
17356 userbase.
17357
17358 Some known size constraints suggest that a bit-size in the range 2048 to 2236
17359 is most likely to maximise interoperability.  The upper bound comes from
17360 applications using the Mozilla Network Security Services (NSS) library, which
17361 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
17362 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
17363 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
17364 acceptable bound from 1024 to 2048.
17365
17366
17367 .option tls_eccurve main string&!! &`auto`&
17368 .cindex TLS "EC cryptography"
17369 This option selects a EC curve for use by Exim when used with OpenSSL.
17370 It has no effect when Exim is used with GnuTLS.
17371
17372 After expansion it must contain a valid EC curve parameter, such as
17373 &`prime256v1`&, &`secp384r1`&, or &`P-512`&. Consult your OpenSSL manual
17374 for valid selections.
17375
17376 For OpenSSL versions before (and not including) 1.0.2, the string
17377 &`auto`& selects &`prime256v1`&. For more recent OpenSSL versions
17378 &`auto`& tells the library to choose.
17379
17380 If the option expands to an empty string, no EC curves will be enabled.
17381
17382
17383 .option tls_ocsp_file main string&!! unset
17384 .cindex TLS "certificate status"
17385 .cindex TLS "OCSP proof file"
17386 This option
17387 must if set expand to the absolute path to a file which contains a current
17388 status proof for the server's certificate, as obtained from the
17389 Certificate Authority.
17390
17391 Usable for GnuTLS 3.4.4 or 3.3.17 or OpenSSL 1.1.0 (or later).
17392
17393 .new
17394 For GnuTLS 3.5.6 or later the expanded value of this option can be a list
17395 of files, to match a list given for the &%tls_certificate%& option.
17396 The ordering of the two lists must match.
17397 .wen
17398
17399
17400 .option tls_on_connect_ports main "string list" unset
17401 .cindex SSMTP
17402 .cindex SMTPS
17403 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
17404 operate the obsolete SSMTP (SMTPS) protocol, where a TLS session is immediately
17405 set up without waiting for the client to issue a STARTTLS command. For
17406 further details, see section &<<SECTsupobssmt>>&.
17407
17408
17409
17410 .option tls_privatekey main string list&!! unset
17411 .cindex "TLS" "server private key; location of"
17412 The value of this option is expanded, and must then be a list of absolute paths to
17413 files which contains the server's private keys.
17414 If this option is unset, or if
17415 the expansion is forced to fail, or the result is an empty string, the private
17416 key is assumed to be in the same file as the server's certificates. See chapter
17417 &<<CHAPTLS>>& for further details.
17418
17419 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17420
17421
17422 .option tls_remember_esmtp main boolean false
17423 .cindex "TLS" "esmtp state; remembering"
17424 .cindex "TLS" "broken clients"
17425 If this option is set true, Exim violates the RFCs by remembering that it is in
17426 &"esmtp"& state after successfully negotiating a TLS session. This provides
17427 support for broken clients that fail to send a new EHLO after starting a
17428 TLS session.
17429
17430
17431 .option tls_require_ciphers main string&!! unset
17432 .cindex "TLS" "requiring specific ciphers"
17433 .cindex "cipher" "requiring specific"
17434 This option controls which ciphers can be used for incoming TLS connections.
17435 The &(smtp)& transport has an option of the same name for controlling outgoing
17436 connections. This option is expanded for each connection, so can be varied for
17437 different clients if required. The value of this option must be a list of
17438 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
17439 in somewhat different ways. If GnuTLS is being used, the client controls the
17440 preference order of the available ciphers. Details are given in sections
17441 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
17442
17443
17444 .option tls_try_verify_hosts main "host list&!!" unset
17445 .cindex "TLS" "client certificate verification"
17446 .cindex "certificate" "verification of client"
17447 See &%tls_verify_hosts%& below.
17448
17449
17450 .option tls_verify_certificates main string&!! system
17451 .cindex "TLS" "client certificate verification"
17452 .cindex "certificate" "verification of client"
17453 The value of this option is expanded, and must then be either the
17454 word "system"
17455 or the absolute path to
17456 a file or directory containing permitted certificates for clients that
17457 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&.
17458
17459 The "system" value for the option will use a
17460 system default location compiled into the SSL library.
17461 This is not available for GnuTLS versions preceding 3.0.20,
17462 and will be taken as empty; an explicit location
17463 must be specified.
17464
17465 The use of a directory for the option value is not available for GnuTLS versions
17466 preceding 3.3.6 and a single file must be used.
17467
17468 With OpenSSL the certificates specified
17469 explicitly
17470 either by file or directory
17471 are added to those given by the system default location.
17472
17473 These certificates should be for the certificate authorities trusted, rather
17474 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
17475 the value is a file then the certificates are sent by Exim as a server to
17476 connecting clients, defining the list of accepted certificate authorities.
17477 Thus the values defined should be considered public data.  To avoid this,
17478 use the explicit directory version.
17479
17480 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17481
17482 A forced expansion failure or setting to an empty string is equivalent to
17483 being unset.
17484
17485
17486 .option tls_verify_hosts main "host list&!!" unset
17487 .cindex "TLS" "client certificate verification"
17488 .cindex "certificate" "verification of client"
17489 This option, along with &%tls_try_verify_hosts%&, controls the checking of
17490 certificates from clients. The expected certificates are defined by
17491 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
17492 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
17493 &%tls_verify_certificates%& is not set.
17494
17495 Any client that matches &%tls_verify_hosts%& is constrained by
17496 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
17497 present one of the listed certificates. If it does not, the connection is
17498 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
17499 the host to use TLS. It can still send SMTP commands through unencrypted
17500 connections. Forcing a client to use TLS has to be done separately using an
17501 ACL to reject inappropriate commands when the connection is not encrypted.
17502
17503 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
17504 matches this option (but not &%tls_verify_hosts%&), Exim requests a
17505 certificate and checks it against &%tls_verify_certificates%&, but does not
17506 abort the connection if there is no certificate or if it does not match. This
17507 state can be detected in an ACL, which makes it possible to implement policies
17508 such as &"accept for relay only if a verified certificate has been received,
17509 but accept for local delivery if encrypted, even without a verified
17510 certificate"&.
17511
17512 Client hosts that match neither of these lists are not asked to present
17513 certificates.
17514
17515
17516 .option trusted_groups main "string list&!!" unset
17517 .cindex "trusted groups"
17518 .cindex "groups" "trusted"
17519 This option is expanded just once, at the start of Exim's processing. If this
17520 option is set, any process that is running in one of the listed groups, or
17521 which has one of them as a supplementary group, is trusted. The groups can be
17522 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
17523 details of what trusted callers are permitted to do. If neither
17524 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
17525 are trusted.
17526
17527 .option trusted_users main "string list&!!" unset
17528 .cindex "trusted users"
17529 .cindex "user" "trusted"
17530 This option is expanded just once, at the start of Exim's processing. If this
17531 option is set, any process that is running as one of the listed users is
17532 trusted. The users can be specified numerically or by name. See section
17533 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
17534 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
17535 Exim user are trusted.
17536
17537 .option unknown_login main string&!! unset
17538 .cindex "uid (user id)" "unknown caller"
17539 .vindex "&$caller_uid$&"
17540 This is a specialized feature for use in unusual configurations. By default, if
17541 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
17542 gives up. The &%unknown_login%& option can be used to set a login name to be
17543 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
17544 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
17545 is used for the user's real name (gecos field), unless this has been set by the
17546 &%-F%& option.
17547
17548 .option unknown_username main string unset
17549 See &%unknown_login%&.
17550
17551 .option untrusted_set_sender main "address list&!!" unset
17552 .cindex "trusted users"
17553 .cindex "sender" "setting by untrusted user"
17554 .cindex "untrusted user setting sender"
17555 .cindex "user" "untrusted setting sender"
17556 .cindex "envelope sender"
17557 When an untrusted user submits a message to Exim using the standard input, Exim
17558 normally creates an envelope sender address from the user's login and the
17559 default qualification domain. Data from the &%-f%& option (for setting envelope
17560 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
17561 is used) is ignored.
17562
17563 However, untrusted users are permitted to set an empty envelope sender address,
17564 to declare that a message should never generate any bounces. For example:
17565 .code
17566 exim -f '<>' user@domain.example
17567 .endd
17568 .vindex "&$sender_ident$&"
17569 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
17570 other envelope sender addresses in a controlled way. When it is set, untrusted
17571 users are allowed to set envelope sender addresses that match any of the
17572 patterns in the list. Like all address lists, the string is expanded. The
17573 identity of the user is in &$sender_ident$&, so you can, for example, restrict
17574 users to setting senders that start with their login ids
17575 followed by a hyphen
17576 by a setting like this:
17577 .code
17578 untrusted_set_sender = ^$sender_ident-
17579 .endd
17580 If you want to allow untrusted users to set envelope sender addresses without
17581 restriction, you can use
17582 .code
17583 untrusted_set_sender = *
17584 .endd
17585 The &%untrusted_set_sender%& option applies to all forms of local input, but
17586 only to the setting of the envelope sender. It does not permit untrusted users
17587 to use the other options which trusted user can use to override message
17588 parameters. Furthermore, it does not stop Exim from removing an existing
17589 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
17590 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
17591 overriding these actions. The handling of the &'Sender:'& header is also
17592 described in section &<<SECTthesenhea>>&.
17593
17594 The log line for a message's arrival shows the envelope sender following
17595 &"<="&. For local messages, the user's login always follows, after &"U="&. In
17596 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
17597 envelope sender address, the user's login is shown in parentheses after the
17598 sender address.
17599
17600
17601 .option uucp_from_pattern main string "see below"
17602 .cindex "&""From""& line"
17603 .cindex "UUCP" "&""From""& line"
17604 Some applications that pass messages to an MTA via a command line interface use
17605 an initial line starting with &"From&~"& to pass the envelope sender. In
17606 particular, this is used by UUCP software. Exim recognizes such a line by means
17607 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
17608 matches, the sender address is constructed by expanding the contents of
17609 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
17610 default pattern recognizes lines in the following two forms:
17611 .code
17612 From ph10 Fri Jan  5 12:35 GMT 1996
17613 From ph10 Fri, 7 Jan 97 14:00:00 GMT
17614 .endd
17615 The pattern can be seen by running
17616 .code
17617 exim -bP uucp_from_pattern
17618 .endd
17619 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
17620 year in the second case. The first word after &"From&~"& is matched in the
17621 regular expression by a parenthesized subpattern. The default value for
17622 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
17623 (&"ph10"& in the example above) as the message's sender. See also
17624 &%ignore_fromline_hosts%&.
17625
17626
17627 .option uucp_from_sender main string&!! &`$1`&
17628 See &%uucp_from_pattern%& above.
17629
17630
17631 .option warn_message_file main string unset
17632 .cindex "warning of delay" "customizing the message"
17633 .cindex "customizing" "warning message"
17634 This option defines a template file containing paragraphs of text to be used
17635 for constructing the warning message which is sent by Exim when a message has
17636 been on the queue for a specified amount of time, as specified by
17637 &%delay_warning%&. Details of the file's contents are given in chapter
17638 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
17639
17640
17641 .option write_rejectlog main boolean true
17642 .cindex "reject log" "disabling"
17643 If this option is set false, Exim no longer writes anything to the reject log.
17644 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
17645 .ecindex IIDconfima
17646 .ecindex IIDmaiconf
17647
17648
17649
17650
17651 . ////////////////////////////////////////////////////////////////////////////
17652 . ////////////////////////////////////////////////////////////////////////////
17653
17654 .chapter "Generic options for routers" "CHAProutergeneric"
17655 .scindex IIDgenoprou1 "options" "generic; for routers"
17656 .scindex IIDgenoprou2 "generic options" "router"
17657 This chapter describes the generic options that apply to all routers.
17658 Those that are preconditions are marked with &Dagger; in the &"use"& field.
17659
17660 For a general description of how a router operates, see sections
17661 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
17662 which the preconditions are tested. The order of expansion of the options that
17663 provide data for a transport is: &%errors_to%&, &%headers_add%&,
17664 &%headers_remove%&, &%transport%&.
17665
17666
17667
17668 .option address_data routers string&!! unset
17669 .cindex "router" "data attached to address"
17670 The string is expanded just before the router is run, that is, after all the
17671 precondition tests have succeeded. If the expansion is forced to fail, the
17672 router declines, the value of &%address_data%& remains unchanged, and the
17673 &%more%& option controls what happens next. Other expansion failures cause
17674 delivery of the address to be deferred.
17675
17676 .vindex "&$address_data$&"
17677 When the expansion succeeds, the value is retained with the address, and can be
17678 accessed using the variable &$address_data$& in the current router, subsequent
17679 routers, and the eventual transport.
17680
17681 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
17682 that runs a user's filter file, the contents of &$address_data$& are accessible
17683 in the filter. This is not normally a problem, because such data is usually
17684 either not confidential or it &"belongs"& to the current user, but if you do
17685 put confidential data into &$address_data$& you need to remember this point.
17686
17687 Even if the router declines or passes, the value of &$address_data$& remains
17688 with the address, though it can be changed by another &%address_data%& setting
17689 on a subsequent router. If a router generates child addresses, the value of
17690 &$address_data$& propagates to them. This also applies to the special kind of
17691 &"child"& that is generated by a router with the &%unseen%& option.
17692
17693 The idea of &%address_data%& is that you can use it to look up a lot of data
17694 for the address once, and then pick out parts of the data later. For example,
17695 you could use a single LDAP lookup to return a string of the form
17696 .code
17697 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
17698 .endd
17699 In the transport you could pick out the mailbox by a setting such as
17700 .code
17701 file = ${extract{mailbox}{$address_data}}
17702 .endd
17703 This makes the configuration file less messy, and also reduces the number of
17704 lookups (though Exim does cache lookups).
17705
17706 .vindex "&$sender_address_data$&"
17707 .vindex "&$address_data$&"
17708 The &%address_data%& facility is also useful as a means of passing information
17709 from one router to another, and from a router to a transport. In addition, if
17710 &$address_data$& is set by a router when verifying a recipient address from an
17711 ACL, it remains available for use in the rest of the ACL statement. After
17712 verifying a sender, the value is transferred to &$sender_address_data$&.
17713
17714
17715
17716 .option address_test routers&!? boolean true
17717 .oindex "&%-bt%&"
17718 .cindex "router" "skipping when address testing"
17719 If this option is set false, the router is skipped when routing is being tested
17720 by means of the &%-bt%& command line option. This can be a convenience when
17721 your first router sends messages to an external scanner, because it saves you
17722 having to set the &"already scanned"& indicator when testing real address
17723 routing.
17724
17725
17726
17727 .option cannot_route_message routers string&!! unset
17728 .cindex "router" "customizing &""cannot route""& message"
17729 .cindex "customizing" "&""cannot route""& message"
17730 This option specifies a text message that is used when an address cannot be
17731 routed because Exim has run out of routers. The default message is
17732 &"Unrouteable address"&. This option is useful only on routers that have
17733 &%more%& set false, or on the very last router in a configuration, because the
17734 value that is used is taken from the last router that is considered. This
17735 includes a router that is skipped because its preconditions are not met, as
17736 well as a router that declines. For example, using the default configuration,
17737 you could put:
17738 .code
17739 cannot_route_message = Remote domain not found in DNS
17740 .endd
17741 on the first router, which is a &(dnslookup)& router with &%more%& set false,
17742 and
17743 .code
17744 cannot_route_message = Unknown local user
17745 .endd
17746 on the final router that checks for local users. If string expansion fails for
17747 this option, the default message is used. Unless the expansion failure was
17748 explicitly forced, a message about the failure is written to the main and panic
17749 logs, in addition to the normal message about the routing failure.
17750
17751
17752 .option caseful_local_part routers boolean false
17753 .cindex "case of local parts"
17754 .cindex "router" "case of local parts"
17755 By default, routers handle the local parts of addresses in a case-insensitive
17756 manner, though the actual case is preserved for transmission with the message.
17757 If you want the case of letters to be significant in a router, you must set
17758 this option true. For individual router options that contain address or local
17759 part lists (for example, &%local_parts%&), case-sensitive matching can be
17760 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
17761 more details.
17762
17763 .vindex "&$local_part$&"
17764 .vindex "&$original_local_part$&"
17765 .vindex "&$parent_local_part$&"
17766 The value of the &$local_part$& variable is forced to lower case while a
17767 router is running unless &%caseful_local_part%& is set. When a router assigns
17768 an address to a transport, the value of &$local_part$& when the transport runs
17769 is the same as it was in the router. Similarly, when a router generates child
17770 addresses by aliasing or forwarding, the values of &$original_local_part$&
17771 and &$parent_local_part$& are those that were used by the redirecting router.
17772
17773 This option applies to the processing of an address by a router. When a
17774 recipient address is being processed in an ACL, there is a separate &%control%&
17775 modifier that can be used to specify case-sensitive processing within the ACL
17776 (see section &<<SECTcontrols>>&).
17777
17778
17779
17780 .option check_local_user routers&!? boolean false
17781 .cindex "local user, checking in router"
17782 .cindex "router" "checking for local user"
17783 .cindex "&_/etc/passwd_&"
17784 .vindex "&$home$&"
17785 When this option is true, Exim checks that the local part of the recipient
17786 address (with affixes removed if relevant) is the name of an account on the
17787 local system. The check is done by calling the &[getpwnam()]& function rather
17788 than trying to read &_/etc/passwd_& directly. This means that other methods of
17789 holding password data (such as NIS) are supported. If the local part is a local
17790 user, &$home$& is set from the password data, and can be tested in other
17791 preconditions that are evaluated after this one (the order of evaluation is
17792 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
17793 overridden by &%router_home_directory%&. If the local part is not a local user,
17794 the router is skipped.
17795
17796 If you want to check that the local part is either the name of a local user
17797 or matches something else, you cannot combine &%check_local_user%& with a
17798 setting of &%local_parts%&, because that specifies the logical &'and'& of the
17799 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
17800 setting to achieve this. For example:
17801 .code
17802 local_parts = passwd;$local_part : lsearch;/etc/other/users
17803 .endd
17804 Note, however, that the side effects of &%check_local_user%& (such as setting
17805 up a home directory) do not occur when a &(passwd)& lookup is used in a
17806 &%local_parts%& (or any other) precondition.
17807
17808
17809
17810 .option condition routers&!? string&!! unset
17811 .cindex "router" "customized precondition"
17812 This option specifies a general precondition test that has to succeed for the
17813 router to be called. The &%condition%& option is the last precondition to be
17814 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
17815 result is a forced failure, or an empty string, or one of the strings &"0"& or
17816 &"no"& or &"false"& (checked without regard to the case of the letters), the
17817 router is skipped, and the address is offered to the next one.
17818
17819 If the result is any other value, the router is run (as this is the last
17820 precondition to be evaluated, all the other preconditions must be true).
17821
17822 This option is unusual in that multiple &%condition%& options may be present.
17823 All &%condition%& options must succeed.
17824
17825 The &%condition%& option provides a means of applying custom conditions to the
17826 running of routers. Note that in the case of a simple conditional expansion,
17827 the default expansion values are exactly what is wanted. For example:
17828 .code
17829 condition = ${if >{$message_age}{600}}
17830 .endd
17831 Because of the default behaviour of the string expansion, this is equivalent to
17832 .code
17833 condition = ${if >{$message_age}{600}{true}{}}
17834 .endd
17835
17836 A multiple condition example, which succeeds:
17837 .code
17838 condition = ${if >{$message_age}{600}}
17839 condition = ${if !eq{${lc:$local_part}}{postmaster}}
17840 condition = foobar
17841 .endd
17842
17843 If the expansion fails (other than forced failure) delivery is deferred. Some
17844 of the other precondition options are common special cases that could in fact
17845 be specified using &%condition%&.
17846
17847 Historical note: We have &%condition%& on ACLs and on Routers.  Routers
17848 are far older, and use one set of semantics.  ACLs are newer and when
17849 they were created, the ACL &%condition%& process was given far stricter
17850 parse semantics.  The &%bool{}%& expansion condition uses the same rules as
17851 ACLs.  The &%bool_lax{}%& expansion condition uses the same rules as
17852 Routers.  More pointedly, the &%bool_lax{}%& was written to match the existing
17853 Router rules processing behavior.
17854
17855 This is best illustrated in an example:
17856 .code
17857 # If used in an ACL condition will fail with a syntax error, but
17858 # in a router condition any extra characters are treated as a string
17859
17860 $ exim -be '${if eq {${lc:GOOGLE.com}} {google.com}} {yes} {no}}'
17861 true {yes} {no}}
17862
17863 $ exim -be '${if eq {${lc:WHOIS.com}} {google.com}} {yes} {no}}'
17864  {yes} {no}}
17865 .endd
17866 In each example above, the &%if%& statement actually ends after
17867 &"{google.com}}"&.  Since no true or false braces were defined, the
17868 default &%if%& behavior is to return a boolean true or a null answer
17869 (which evaluates to false). The rest of the line is then treated as a
17870 string. So the first example resulted in the boolean answer &"true"&
17871 with the string &" {yes} {no}}"& appended to it. The second example
17872 resulted in the null output (indicating false) with the string
17873 &" {yes} {no}}"& appended to it.
17874
17875 In fact you can put excess forward braces in too.  In the router
17876 &%condition%&, Exim's parser only looks for &"{"& symbols when they
17877 mean something, like after a &"$"& or when required as part of a
17878 conditional.  But otherwise &"{"& and &"}"& are treated as ordinary
17879 string characters.
17880
17881 Thus, in a Router, the above expansion strings will both always evaluate
17882 true, as the result of expansion is a non-empty string which doesn't
17883 match an explicit false value.  This can be tricky to debug.  By
17884 contrast, in an ACL either of those strings will always result in an
17885 expansion error because the result doesn't look sufficiently boolean.
17886
17887
17888 .option debug_print routers string&!! unset
17889 .cindex "testing" "variables in drivers"
17890 If this option is set and debugging is enabled (see the &%-d%& command line
17891 option) or in address-testing mode (see the &%-bt%& command line option),
17892 the string is expanded and included in the debugging output.
17893 If expansion of the string fails, the error message is written to the debugging
17894 output, and Exim carries on processing.
17895 This option is provided to help with checking out the values of variables and
17896 so on when debugging router configurations. For example, if a &%condition%&
17897 option appears not to be working, &%debug_print%& can be used to output the
17898 variables it references. The output happens after checks for &%domains%&,
17899 &%local_parts%&, and &%check_local_user%& but before any other preconditions
17900 are tested. A newline is added to the text if it does not end with one.
17901 The variable &$router_name$& contains the name of the router.
17902
17903
17904
17905 .option disable_logging routers boolean false
17906 If this option is set true, nothing is logged for any routing errors
17907 or for any deliveries caused by this router. You should not set this option
17908 unless you really, really know what you are doing. See also the generic
17909 transport option of the same name.
17910
17911 .option dnssec_request_domains routers "domain list&!!" unset
17912 .cindex "MX record" "security"
17913 .cindex "DNSSEC" "MX lookup"
17914 .cindex "security" "MX lookup"
17915 .cindex "DNS" "DNSSEC"
17916 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
17917 the dnssec request bit set.
17918 This applies to all of the SRV, MX, AAAA, A lookup sequence.
17919
17920 .option dnssec_require_domains routers "domain list&!!" unset
17921 .cindex "MX record" "security"
17922 .cindex "DNSSEC" "MX lookup"
17923 .cindex "security" "MX lookup"
17924 .cindex "DNS" "DNSSEC"
17925 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
17926 the dnssec request bit set.  Any returns not having the Authenticated Data bit
17927 (AD bit) set will be ignored and logged as a host-lookup failure.
17928 This applies to all of the SRV, MX, AAAA, A lookup sequence.
17929
17930
17931 .option domains routers&!? "domain list&!!" unset
17932 .cindex "router" "restricting to specific domains"
17933 .vindex "&$domain_data$&"
17934 If this option is set, the router is skipped unless the current domain matches
17935 the list. If the match is achieved by means of a file lookup, the data that the
17936 lookup returned for the domain is placed in &$domain_data$& for use in string
17937 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
17938 a list of the order in which preconditions are evaluated.
17939
17940
17941
17942 .option driver routers string unset
17943 This option must always be set. It specifies which of the available routers is
17944 to be used.
17945
17946
17947 .option dsn_lasthop routers boolean false
17948 .cindex "DSN" "success"
17949 .cindex "Delivery Status Notification" "success"
17950 If this option is set true, and extended DSN (RFC3461) processing is in effect,
17951 Exim will not pass on DSN requests to downstream DSN-aware hosts but will
17952 instead send a success DSN as if the next hop does not support DSN.
17953 Not effective on redirect routers.
17954
17955
17956
17957 .option errors_to routers string&!! unset
17958 .cindex "envelope sender"
17959 .cindex "router" "changing address for errors"
17960 If a router successfully handles an address, it may assign the address to a
17961 transport for delivery or it may generate child addresses. In both cases, if
17962 there is a delivery problem during later processing, the resulting bounce
17963 message is sent to the address that results from expanding this string,
17964 provided that the address verifies successfully. The &%errors_to%& option is
17965 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
17966
17967 The &%errors_to%& setting associated with an address can be overridden if it
17968 subsequently passes through other routers that have their own &%errors_to%&
17969 settings, or if the message is delivered by a transport with a &%return_path%&
17970 setting.
17971
17972 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
17973 the expansion fails to verify, the errors address associated with the incoming
17974 address is used. At top level, this is the envelope sender. A non-forced
17975 expansion failure causes delivery to be deferred.
17976
17977 If an address for which &%errors_to%& has been set ends up being delivered over
17978 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
17979 any bounces that are generated by other MTAs on the delivery route are also
17980 sent there. You can set &%errors_to%& to the empty string by either of these
17981 settings:
17982 .code
17983 errors_to =
17984 errors_to = ""
17985 .endd
17986 An expansion item that yields an empty string has the same effect. If you do
17987 this, a locally detected delivery error for addresses processed by this router
17988 no longer gives rise to a bounce message; the error is discarded. If the
17989 address is delivered to a remote host, the return path is set to &`<>`&, unless
17990 overridden by the &%return_path%& option on the transport.
17991
17992 .vindex "&$address_data$&"
17993 If for some reason you want to discard local errors, but use a non-empty
17994 MAIL command for remote delivery, you can preserve the original return
17995 path in &$address_data$& in the router, and reinstate it in the transport by
17996 setting &%return_path%&.
17997
17998 The most common use of &%errors_to%& is to direct mailing list bounces to the
17999 manager of the list, as described in section &<<SECTmailinglists>>&, or to
18000 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
18001
18002
18003
18004 .option expn routers&!? boolean true
18005 .cindex "address" "testing"
18006 .cindex "testing" "addresses"
18007 .cindex "EXPN" "router skipping"
18008 .cindex "router" "skipping for EXPN"
18009 If this option is turned off, the router is skipped when testing an address
18010 as a result of processing an SMTP EXPN command. You might, for example,
18011 want to turn it off on a router for users' &_.forward_& files, while leaving it
18012 on for the system alias file.
18013 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18014 are evaluated.
18015
18016 The use of the SMTP EXPN command is controlled by an ACL (see chapter
18017 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
18018 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
18019
18020
18021
18022 .option fail_verify routers boolean false
18023 .cindex "router" "forcing verification failure"
18024 Setting this option has the effect of setting both &%fail_verify_sender%& and
18025 &%fail_verify_recipient%& to the same value.
18026
18027
18028
18029 .option fail_verify_recipient routers boolean false
18030 If this option is true and an address is accepted by this router when
18031 verifying a recipient, verification fails.
18032
18033
18034
18035 .option fail_verify_sender routers boolean false
18036 If this option is true and an address is accepted by this router when
18037 verifying a sender, verification fails.
18038
18039
18040
18041 .option fallback_hosts routers "string list" unset
18042 .cindex "router" "fallback hosts"
18043 .cindex "fallback" "hosts specified on router"
18044 String expansion is not applied to this option. The argument must be a
18045 colon-separated list of host names or IP addresses. The list separator can be
18046 changed (see section &<<SECTlistconstruct>>&), and a port can be specified with
18047 each name or address. In fact, the format of each item is exactly the same as
18048 defined for the list of hosts in a &(manualroute)& router (see section
18049 &<<SECTformatonehostitem>>&).
18050
18051 If a router queues an address for a remote transport, this host list is
18052 associated with the address, and used instead of the transport's fallback host
18053 list. If &%hosts_randomize%& is set on the transport, the order of the list is
18054 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
18055 transport for further details.
18056
18057
18058 .option group routers string&!! "see below"
18059 .cindex "gid (group id)" "local delivery"
18060 .cindex "local transports" "uid and gid"
18061 .cindex "transport" "local"
18062 .cindex "router" "setting group"
18063 When a router queues an address for a transport, and the transport does not
18064 specify a group, the group given here is used when running the delivery
18065 process.
18066 The group may be specified numerically or by name. If expansion fails, the
18067 error is logged and delivery is deferred.
18068 The default is unset, unless &%check_local_user%& is set, when the default
18069 is taken from the password information. See also &%initgroups%& and &%user%&
18070 and the discussion in chapter &<<CHAPenvironment>>&.
18071
18072
18073
18074 .option headers_add routers list&!! unset
18075 .cindex "header lines" "adding"
18076 .cindex "router" "adding header lines"
18077 This option specifies a list of text headers,
18078 newline-separated (by default, changeable in the usual way),
18079 that is associated with any addresses that are accepted by the router.
18080 Each item is separately expanded, at routing time.  However, this
18081 option has no effect when an address is just being verified. The way in which
18082 the text is used to add header lines at transport time is described in section
18083 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
18084 message is in the process of being transported. This means that references to
18085 header lines in string expansions in the transport's configuration do not
18086 &"see"& the added header lines.
18087
18088 The &%headers_add%& option is expanded after &%errors_to%&, but before
18089 &%headers_remove%& and &%transport%&. If an item is empty, or if
18090 an item expansion is forced to fail, the item has no effect. Other expansion
18091 failures are treated as configuration errors.
18092
18093 Unlike most options, &%headers_add%& can be specified multiple times
18094 for a router; all listed headers are added.
18095
18096 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
18097 router that has the &%one_time%& option set.
18098
18099 .cindex "duplicate addresses"
18100 .oindex "&%unseen%&"
18101 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
18102 additions are deleted when the address is passed on to subsequent routers.
18103 For a &%redirect%& router, if a generated address is the same as the incoming
18104 address, this can lead to duplicate addresses with different header
18105 modifications. Exim does not do duplicate deliveries (except, in certain
18106 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
18107 which of the duplicates is discarded, so this ambiguous situation should be
18108 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
18109
18110
18111
18112 .option headers_remove routers list&!! unset
18113 .cindex "header lines" "removing"
18114 .cindex "router" "removing header lines"
18115 This option specifies a list of text headers,
18116 colon-separated (by default, changeable in the usual way),
18117 that is associated with any addresses that are accepted by the router.
18118 Each item is separately expanded, at routing time.  However, this
18119 option has no effect when an address is just being verified. The way in which
18120 the text is used to remove header lines at transport time is described in
18121 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
18122 the message is in the process of being transported. This means that references
18123 to header lines in string expansions in the transport's configuration still
18124 &"see"& the original header lines.
18125
18126 The &%headers_remove%& option is expanded after &%errors_to%& and
18127 &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail,
18128 the item has no effect. Other expansion failures are treated as configuration
18129 errors.
18130
18131 Unlike most options, &%headers_remove%& can be specified multiple times
18132 for a router; all listed headers are removed.
18133
18134 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
18135 router that has the &%one_time%& option set.
18136
18137 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
18138 removal requests are deleted when the address is passed on to subsequent
18139 routers, and this can lead to problems with duplicates -- see the similar
18140 warning for &%headers_add%& above.
18141
18142 &*Warning 3*&: Because of the separate expansion of the list items,
18143 items that contain a list separator must have it doubled.
18144 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
18145
18146
18147
18148 .option ignore_target_hosts routers "host list&!!" unset
18149 .cindex "IP address" "discarding"
18150 .cindex "router" "discarding IP addresses"
18151 Although this option is a host list, it should normally contain IP address
18152 entries rather than names. If any host that is looked up by the router has an
18153 IP address that matches an item in this list, Exim behaves as if that IP
18154 address did not exist. This option allows you to cope with rogue DNS entries
18155 like
18156 .code
18157 remote.domain.example.  A  127.0.0.1
18158 .endd
18159 by setting
18160 .code
18161 ignore_target_hosts = 127.0.0.1
18162 .endd
18163 on the relevant router. If all the hosts found by a &(dnslookup)& router are
18164 discarded in this way, the router declines. In a conventional configuration, an
18165 attempt to mail to such a domain would normally provoke the &"unrouteable
18166 domain"& error, and an attempt to verify an address in the domain would fail.
18167 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
18168 router declines if presented with one of the listed addresses.
18169
18170 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
18171 means of the first or the second of the following settings, respectively:
18172 .code
18173 ignore_target_hosts = 0.0.0.0/0
18174 ignore_target_hosts = <; 0::0/0
18175 .endd
18176 The pattern in the first line matches all IPv4 addresses, whereas the pattern
18177 in the second line matches all IPv6 addresses.
18178
18179 This option may also be useful for ignoring link-local and site-local IPv6
18180 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
18181 is expanded before use as a list, it is possible to make it dependent on the
18182 domain that is being routed.
18183
18184 .vindex "&$host_address$&"
18185 During its expansion, &$host_address$& is set to the IP address that is being
18186 checked.
18187
18188 .option initgroups routers boolean false
18189 .cindex "additional groups"
18190 .cindex "groups" "additional"
18191 .cindex "local transports" "uid and gid"
18192 .cindex "transport" "local"
18193 If the router queues an address for a transport, and this option is true, and
18194 the uid supplied by the router is not overridden by the transport, the
18195 &[initgroups()]& function is called when running the transport to ensure that
18196 any additional groups associated with the uid are set up. See also &%group%&
18197 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
18198
18199
18200
18201 .option local_part_prefix routers&!? "string list" unset
18202 .cindex "router" "prefix for local part"
18203 .cindex "prefix" "for local part, used in router"
18204 If this option is set, the router is skipped unless the local part starts with
18205 one of the given strings, or &%local_part_prefix_optional%& is true. See
18206 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
18207 evaluated.
18208
18209 The list is scanned from left to right, and the first prefix that matches is
18210 used. A limited form of wildcard is available; if the prefix begins with an
18211 asterisk, it matches the longest possible sequence of arbitrary characters at
18212 the start of the local part. An asterisk should therefore always be followed by
18213 some character that does not occur in normal local parts.
18214 .cindex "multiple mailboxes"
18215 .cindex "mailbox" "multiple"
18216 Wildcarding can be used to set up multiple user mailboxes, as described in
18217 section &<<SECTmulbox>>&.
18218
18219 .vindex "&$local_part$&"
18220 .vindex "&$local_part_prefix$&"
18221 During the testing of the &%local_parts%& option, and while the router is
18222 running, the prefix is removed from the local part, and is available in the
18223 expansion variable &$local_part_prefix$&. When a message is being delivered, if
18224 the router accepts the address, this remains true during subsequent delivery by
18225 a transport. In particular, the local part that is transmitted in the RCPT
18226 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
18227 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
18228 the relevant transport.
18229
18230 When an address is being verified, &%local_part_prefix%& affects only the
18231 behaviour of the router. If the callout feature of verification is in use, this
18232 means that the full address, including the prefix, will be used during the
18233 callout.
18234
18235 The prefix facility is commonly used to handle local parts of the form
18236 &%owner-something%&. Another common use is to support local parts of the form
18237 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
18238 to tell a user their forwarding is broken &-- by placing a router like this one
18239 immediately before the router that handles &_.forward_& files:
18240 .code
18241 real_localuser:
18242   driver = accept
18243   local_part_prefix = real-
18244   check_local_user
18245   transport = local_delivery
18246 .endd
18247 For security, it would probably be a good idea to restrict the use of this
18248 router to locally-generated messages, using a condition such as this:
18249 .code
18250   condition = ${if match {$sender_host_address}\
18251                          {\N^(|127\.0\.0\.1)$\N}}
18252 .endd
18253
18254 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
18255 both conditions must be met if not optional. Care must be taken if wildcards
18256 are used in both a prefix and a suffix on the same router. Different
18257 separator characters must be used to avoid ambiguity.
18258
18259
18260 .option local_part_prefix_optional routers boolean false
18261 See &%local_part_prefix%& above.
18262
18263
18264
18265 .option local_part_suffix routers&!? "string list" unset
18266 .cindex "router" "suffix for local part"
18267 .cindex "suffix for local part" "used in router"
18268 This option operates in the same way as &%local_part_prefix%&, except that the
18269 local part must end (rather than start) with the given string, the
18270 &%local_part_suffix_optional%& option determines whether the suffix is
18271 mandatory, and the wildcard * character, if present, must be the last
18272 character of the suffix. This option facility is commonly used to handle local
18273 parts of the form &%something-request%& and multiple user mailboxes of the form
18274 &%username-foo%&.
18275
18276
18277 .option local_part_suffix_optional routers boolean false
18278 See &%local_part_suffix%& above.
18279
18280
18281
18282 .option local_parts routers&!? "local part list&!!" unset
18283 .cindex "router" "restricting to specific local parts"
18284 .cindex "local part" "checking in router"
18285 The router is run only if the local part of the address matches the list.
18286 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18287 are evaluated, and
18288 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
18289 string is expanded, it is possible to make it depend on the domain, for
18290 example:
18291 .code
18292 local_parts = dbm;/usr/local/specials/$domain
18293 .endd
18294 .vindex "&$local_part_data$&"
18295 If the match is achieved by a lookup, the data that the lookup returned
18296 for the local part is placed in the variable &$local_part_data$& for use in
18297 expansions of the router's private options. You might use this option, for
18298 example, if you have a large number of local virtual domains, and you want to
18299 send all postmaster mail to the same place without having to set up an alias in
18300 each virtual domain:
18301 .code
18302 postmaster:
18303   driver = redirect
18304   local_parts = postmaster
18305   data = postmaster@real.domain.example
18306 .endd
18307
18308
18309 .option log_as_local routers boolean "see below"
18310 .cindex "log" "delivery line"
18311 .cindex "delivery" "log line format"
18312 Exim has two logging styles for delivery, the idea being to make local
18313 deliveries stand out more visibly from remote ones. In the &"local"& style, the
18314 recipient address is given just as the local part, without a domain. The use of
18315 this style is controlled by this option. It defaults to true for the &(accept)&
18316 router, and false for all the others. This option applies only when a
18317 router assigns an address to a transport. It has no effect on routers that
18318 redirect addresses.
18319
18320
18321
18322 .option more routers boolean&!! true
18323 The result of string expansion for this option must be a valid boolean value,
18324 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
18325 result causes an error, and delivery is deferred. If the expansion is forced to
18326 fail, the default value for the option (true) is used. Other failures cause
18327 delivery to be deferred.
18328
18329 If this option is set false, and the router declines to handle the address, no
18330 further routers are tried, routing fails, and the address is bounced.
18331 .oindex "&%self%&"
18332 However, if the router explicitly passes an address to the following router by
18333 means of the setting
18334 .code
18335 self = pass
18336 .endd
18337 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
18338 does not affect the behaviour if one of the precondition tests fails. In that
18339 case, the address is always passed to the next router.
18340
18341 Note that &%address_data%& is not considered to be a precondition. If its
18342 expansion is forced to fail, the router declines, and the value of &%more%&
18343 controls what happens next.
18344
18345
18346 .option pass_on_timeout routers boolean false
18347 .cindex "timeout" "of router"
18348 .cindex "router" "timeout"
18349 If a router times out during a host lookup, it normally causes deferral of the
18350 address. If &%pass_on_timeout%& is set, the address is passed on to the next
18351 router, overriding &%no_more%&. This may be helpful for systems that are
18352 intermittently connected to the Internet, or those that want to pass to a smart
18353 host any messages that cannot immediately be delivered.
18354
18355 There are occasional other temporary errors that can occur while doing DNS
18356 lookups. They are treated in the same way as a timeout, and this option
18357 applies to all of them.
18358
18359
18360
18361 .option pass_router routers string unset
18362 .cindex "router" "go to after &""pass""&"
18363 Routers that recognize the generic &%self%& option (&(dnslookup)&,
18364 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
18365 routing to continue, and overriding a false setting of &%more%&. When one of
18366 these routers returns &"pass"&, the address is normally handed on to the next
18367 router in sequence. This can be changed by setting &%pass_router%& to the name
18368 of another router. However (unlike &%redirect_router%&) the named router must
18369 be below the current router, to avoid loops. Note that this option applies only
18370 to the special case of &"pass"&. It does not apply when a router returns
18371 &"decline"& because it cannot handle an address.
18372
18373
18374
18375 .option redirect_router routers string unset
18376 .cindex "router" "start at after redirection"
18377 Sometimes an administrator knows that it is pointless to reprocess addresses
18378 generated from alias or forward files with the same router again. For
18379 example, if an alias file translates real names into login ids there is no
18380 point searching the alias file a second time, especially if it is a large file.
18381
18382 The &%redirect_router%& option can be set to the name of any router instance.
18383 It causes the routing of any generated addresses to start at the named router
18384 instead of at the first router. This option has no effect if the router in
18385 which it is set does not generate new addresses.
18386
18387
18388
18389 .option require_files routers&!? "string list&!!" unset
18390 .cindex "file" "requiring for router"
18391 .cindex "router" "requiring file existence"
18392 This option provides a general mechanism for predicating the running of a
18393 router on the existence or non-existence of certain files or directories.
18394 Before running a router, as one of its precondition tests, Exim works its way
18395 through the &%require_files%& list, expanding each item separately.
18396
18397 Because the list is split before expansion, any colons in expansion items must
18398 be doubled, or the facility for using a different list separator must be used.
18399 If any expansion is forced to fail, the item is ignored. Other expansion
18400 failures cause routing of the address to be deferred.
18401
18402 If any expanded string is empty, it is ignored. Otherwise, except as described
18403 below, each string must be a fully qualified file path, optionally preceded by
18404 &"!"&. The paths are passed to the &[stat()]& function to test for the
18405 existence of the files or directories. The router is skipped if any paths not
18406 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
18407
18408 .cindex "NFS"
18409 If &[stat()]& cannot determine whether a file exists or not, delivery of
18410 the message is deferred. This can happen when NFS-mounted filesystems are
18411 unavailable.
18412
18413 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
18414 options, so you cannot use it to check for the existence of a file in which to
18415 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
18416 full list of the order in which preconditions are evaluated.) However, as
18417 these options are all expanded, you can use the &%exists%& expansion condition
18418 to make such tests. The &%require_files%& option is intended for checking files
18419 that the router may be going to use internally, or which are needed by a
18420 transport (for example &_.procmailrc_&).
18421
18422 During delivery, the &[stat()]& function is run as root, but there is a
18423 facility for some checking of the accessibility of a file by another user.
18424 This is not a proper permissions check, but just a &"rough"& check that
18425 operates as follows:
18426
18427 If an item in a &%require_files%& list does not contain any forward slash
18428 characters, it is taken to be the user (and optional group, separated by a
18429 comma) to be checked for subsequent files in the list. If no group is specified
18430 but the user is specified symbolically, the gid associated with the uid is
18431 used. For example:
18432 .code
18433 require_files = mail:/some/file
18434 require_files = $local_part:$home/.procmailrc
18435 .endd
18436 If a user or group name in a &%require_files%& list does not exist, the
18437 &%require_files%& condition fails.
18438
18439 Exim performs the check by scanning along the components of the file path, and
18440 checking the access for the given uid and gid. It checks for &"x"& access on
18441 directories, and &"r"& access on the final file. Note that this means that file
18442 access control lists, if the operating system has them, are ignored.
18443
18444 &*Warning 1*&: When the router is being run to verify addresses for an
18445 incoming SMTP message, Exim is not running as root, but under its own uid. This
18446 may affect the result of a &%require_files%& check. In particular, &[stat()]&
18447 may yield the error EACCES (&"Permission denied"&). This means that the Exim
18448 user is not permitted to read one of the directories on the file's path.
18449
18450 &*Warning 2*&: Even when Exim is running as root while delivering a message,
18451 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
18452 without root access. In this case, if a check for access by a particular user
18453 is requested, Exim creates a subprocess that runs as that user, and tries the
18454 check again in that process.
18455
18456 The default action for handling an unresolved EACCES is to consider it to
18457 be caused by a configuration error, and routing is deferred because the
18458 existence or non-existence of the file cannot be determined. However, in some
18459 circumstances it may be desirable to treat this condition as if the file did
18460 not exist. If the file name (or the exclamation mark that precedes the file
18461 name for non-existence) is preceded by a plus sign, the EACCES error is treated
18462 as if the file did not exist. For example:
18463 .code
18464 require_files = +/some/file
18465 .endd
18466 If the router is not an essential part of verification (for example, it
18467 handles users' &_.forward_& files), another solution is to set the &%verify%&
18468 option false so that the router is skipped when verifying.
18469
18470
18471
18472 .option retry_use_local_part routers boolean "see below"
18473 .cindex "hints database" "retry keys"
18474 .cindex "local part" "in retry keys"
18475 When a delivery suffers a temporary routing failure, a retry record is created
18476 in Exim's hints database. For addresses whose routing depends only on the
18477 domain, the key for the retry record should not involve the local part, but for
18478 other addresses, both the domain and the local part should be included.
18479 Usually, remote routing is of the former kind, and local routing is of the
18480 latter kind.
18481
18482 This option controls whether the local part is used to form the key for retry
18483 hints for addresses that suffer temporary errors while being handled by this
18484 router. The default value is true for any router that has &%check_local_user%&
18485 set, and false otherwise. Note that this option does not apply to hints keys
18486 for transport delays; they are controlled by a generic transport option of the
18487 same name.
18488
18489 The setting of &%retry_use_local_part%& applies only to the router on which it
18490 appears. If the router generates child addresses, they are routed
18491 independently; this setting does not become attached to them.
18492
18493
18494
18495 .option router_home_directory routers string&!! unset
18496 .cindex "router" "home directory for"
18497 .cindex "home directory" "for router"
18498 .vindex "&$home$&"
18499 This option sets a home directory for use while the router is running. (Compare
18500 &%transport_home_directory%&, which sets a home directory for later
18501 transporting.) In particular, if used on a &(redirect)& router, this option
18502 sets a value for &$home$& while a filter is running. The value is expanded;
18503 forced expansion failure causes the option to be ignored &-- other failures
18504 cause the router to defer.
18505
18506 Expansion of &%router_home_directory%& happens immediately after the
18507 &%check_local_user%& test (if configured), before any further expansions take
18508 place.
18509 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18510 are evaluated.)
18511 While the router is running, &%router_home_directory%& overrides the value of
18512 &$home$& that came from &%check_local_user%&.
18513
18514 When a router accepts an address and assigns it to a local transport (including
18515 the cases when a &(redirect)& router generates a pipe, file, or autoreply
18516 delivery), the home directory setting for the transport is taken from the first
18517 of these values that is set:
18518
18519 .ilist
18520 The &%home_directory%& option on the transport;
18521 .next
18522 The &%transport_home_directory%& option on the router;
18523 .next
18524 The password data if &%check_local_user%& is set on the router;
18525 .next
18526 The &%router_home_directory%& option on the router.
18527 .endlist
18528
18529 In other words, &%router_home_directory%& overrides the password data for the
18530 router, but not for the transport.
18531
18532
18533
18534 .option self routers string freeze
18535 .cindex "MX record" "pointing to local host"
18536 .cindex "local host" "MX pointing to"
18537 This option applies to those routers that use a recipient address to find a
18538 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
18539 and &(manualroute)& routers.
18540 Certain configurations of the &(queryprogram)& router can also specify a list
18541 of remote hosts.
18542 Usually such routers are configured to send the message to a remote host via an
18543 &(smtp)& transport. The &%self%& option specifies what happens when the first
18544 host on the list turns out to be the local host.
18545 The way in which Exim checks for the local host is described in section
18546 &<<SECTreclocipadd>>&.
18547
18548 Normally this situation indicates either an error in Exim's configuration (for
18549 example, the router should be configured not to process this domain), or an
18550 error in the DNS (for example, the MX should not point to this host). For this
18551 reason, the default action is to log the incident, defer the address, and
18552 freeze the message. The following alternatives are provided for use in special
18553 cases:
18554
18555 .vlist
18556 .vitem &%defer%&
18557 Delivery of the message is tried again later, but the message is not frozen.
18558
18559 .vitem "&%reroute%&: <&'domain'&>"
18560 The domain is changed to the given domain, and the address is passed back to
18561 be reprocessed by the routers. No rewriting of headers takes place. This
18562 behaviour is essentially a redirection.
18563
18564 .vitem "&%reroute: rewrite:%& <&'domain'&>"
18565 The domain is changed to the given domain, and the address is passed back to be
18566 reprocessed by the routers. Any headers that contain the original domain are
18567 rewritten.
18568
18569 .vitem &%pass%&
18570 .oindex "&%more%&"
18571 .vindex "&$self_hostname$&"
18572 The router passes the address to the next router, or to the router named in the
18573 &%pass_router%& option if it is set. This overrides &%no_more%&. During
18574 subsequent routing and delivery, the variable &$self_hostname$& contains the
18575 name of the local host that the router encountered. This can be used to
18576 distinguish between different cases for hosts with multiple names. The
18577 combination
18578 .code
18579 self = pass
18580 no_more
18581 .endd
18582 ensures that only those addresses that routed to the local host are passed on.
18583 Without &%no_more%&, addresses that were declined for other reasons would also
18584 be passed to the next router.
18585
18586 .vitem &%fail%&
18587 Delivery fails and an error report is generated.
18588
18589 .vitem &%send%&
18590 .cindex "local host" "sending to"
18591 The anomaly is ignored and the address is queued for the transport. This
18592 setting should be used with extreme caution. For an &(smtp)& transport, it
18593 makes sense only in cases where the program that is listening on the SMTP port
18594 is not this version of Exim. That is, it must be some other MTA, or Exim with a
18595 different configuration file that handles the domain in another way.
18596 .endlist
18597
18598
18599
18600 .option senders routers&!? "address list&!!" unset
18601 .cindex "router" "checking senders"
18602 If this option is set, the router is skipped unless the message's sender
18603 address matches something on the list.
18604 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18605 are evaluated.
18606
18607 There are issues concerning verification when the running of routers is
18608 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
18609 setting, it sets the sender to the null string. When using the &%-bt%& option
18610 to check a configuration file, it is necessary also to use the &%-f%& option to
18611 set an appropriate sender. For incoming mail, the sender is unset when
18612 verifying the sender, but is available when verifying any recipients. If the
18613 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
18614 matters.
18615
18616
18617 .option translate_ip_address routers string&!! unset
18618 .cindex "IP address" "translating"
18619 .cindex "packet radio"
18620 .cindex "router" "IP address translation"
18621 There exist some rare networking situations (for example, packet radio) where
18622 it is helpful to be able to translate IP addresses generated by normal routing
18623 mechanisms into other IP addresses, thus performing a kind of manual IP
18624 routing. This should be done only if the normal IP routing of the TCP/IP stack
18625 is inadequate or broken. Because this is an extremely uncommon requirement, the
18626 code to support this option is not included in the Exim binary unless
18627 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
18628
18629 .vindex "&$host_address$&"
18630 The &%translate_ip_address%& string is expanded for every IP address generated
18631 by the router, with the generated address set in &$host_address$&. If the
18632 expansion is forced to fail, no action is taken.
18633 For any other expansion error, delivery of the message is deferred.
18634 If the result of the expansion is an IP address, that replaces the original
18635 address; otherwise the result is assumed to be a host name &-- this is looked
18636 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
18637 produce one or more replacement IP addresses. For example, to subvert all IP
18638 addresses in some specific networks, this could be added to a router:
18639 .code
18640 translate_ip_address = \
18641   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
18642     {$value}fail}}
18643 .endd
18644 The file would contain lines like
18645 .code
18646 10.2.3.128/26    some.host
18647 10.8.4.34/26     10.44.8.15
18648 .endd
18649 You should not make use of this facility unless you really understand what you
18650 are doing.
18651
18652
18653
18654 .option transport routers string&!! unset
18655 This option specifies the transport to be used when a router accepts an address
18656 and sets it up for delivery. A transport is never needed if a router is used
18657 only for verification. The value of the option is expanded at routing time,
18658 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
18659 and result must be the name of one of the configured transports. If it is not,
18660 delivery is deferred.
18661
18662 The &%transport%& option is not used by the &(redirect)& router, but it does
18663 have some private options that set up transports for pipe and file deliveries
18664 (see chapter &<<CHAPredirect>>&).
18665
18666
18667
18668 .option transport_current_directory routers string&!! unset
18669 .cindex "current directory for local transport"
18670 This option associates a current directory with any address that is routed
18671 to a local transport. This can happen either because a transport is
18672 explicitly configured for the router, or because it generates a delivery to a
18673 file or a pipe. During the delivery process (that is, at transport time), this
18674 option string is expanded and is set as the current directory, unless
18675 overridden by a setting on the transport.
18676 If the expansion fails for any reason, including forced failure, an error is
18677 logged, and delivery is deferred.
18678 See chapter &<<CHAPenvironment>>& for details of the local delivery
18679 environment.
18680
18681
18682
18683
18684 .option transport_home_directory routers string&!! "see below"
18685 .cindex "home directory" "for local transport"
18686 This option associates a home directory with any address that is routed to a
18687 local transport. This can happen either because a transport is explicitly
18688 configured for the router, or because it generates a delivery to a file or a
18689 pipe. During the delivery process (that is, at transport time), the option
18690 string is expanded and is set as the home directory, unless overridden by a
18691 setting of &%home_directory%& on the transport.
18692 If the expansion fails for any reason, including forced failure, an error is
18693 logged, and delivery is deferred.
18694
18695 If the transport does not specify a home directory, and
18696 &%transport_home_directory%& is not set for the router, the home directory for
18697 the transport is taken from the password data if &%check_local_user%& is set for
18698 the router. Otherwise it is taken from &%router_home_directory%& if that option
18699 is set; if not, no home directory is set for the transport.
18700
18701 See chapter &<<CHAPenvironment>>& for further details of the local delivery
18702 environment.
18703
18704
18705
18706
18707 .option unseen routers boolean&!! false
18708 .cindex "router" "carrying on after success"
18709 The result of string expansion for this option must be a valid boolean value,
18710 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
18711 result causes an error, and delivery is deferred. If the expansion is forced to
18712 fail, the default value for the option (false) is used. Other failures cause
18713 delivery to be deferred.
18714
18715 When this option is set true, routing does not cease if the router accepts the
18716 address. Instead, a copy of the incoming address is passed to the next router,
18717 overriding a false setting of &%more%&. There is little point in setting
18718 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
18719 the value of &%unseen%& contains expansion items (and therefore, presumably, is
18720 sometimes true and sometimes false).
18721
18722 .cindex "copy of message (&%unseen%& option)"
18723 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
18724 qualifier in filter files. It can be used to cause copies of messages to be
18725 delivered to some other destination, while also carrying out a normal delivery.
18726 In effect, the current address is made into a &"parent"& that has two children
18727 &-- one that is delivered as specified by this router, and a clone that goes on
18728 to be routed further. For this reason, &%unseen%& may not be combined with the
18729 &%one_time%& option in a &(redirect)& router.
18730
18731 &*Warning*&: Header lines added to the address (or specified for removal) by
18732 this router or by previous routers affect the &"unseen"& copy of the message
18733 only. The clone that continues to be processed by further routers starts with
18734 no added headers and none specified for removal. For a &%redirect%& router, if
18735 a generated address is the same as the incoming address, this can lead to
18736 duplicate addresses with different header modifications. Exim does not do
18737 duplicate deliveries (except, in certain circumstances, to pipes -- see section
18738 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
18739 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
18740 &%redirect%& router may be of help.
18741
18742 Unlike the handling of header modifications, any data that was set by the
18743 &%address_data%& option in the current or previous routers &'is'& passed on to
18744 subsequent routers.
18745
18746
18747 .option user routers string&!! "see below"
18748 .cindex "uid (user id)" "local delivery"
18749 .cindex "local transports" "uid and gid"
18750 .cindex "transport" "local"
18751 .cindex "router" "user for filter processing"
18752 .cindex "filter" "user for processing"
18753 When a router queues an address for a transport, and the transport does not
18754 specify a user, the user given here is used when running the delivery process.
18755 The user may be specified numerically or by name. If expansion fails, the
18756 error is logged and delivery is deferred.
18757 This user is also used by the &(redirect)& router when running a filter file.
18758 The default is unset, except when &%check_local_user%& is set. In this case,
18759 the default is taken from the password information. If the user is specified as
18760 a name, and &%group%& is not set, the group associated with the user is used.
18761 See also &%initgroups%& and &%group%& and the discussion in chapter
18762 &<<CHAPenvironment>>&.
18763
18764
18765
18766 .option verify routers&!? boolean true
18767 Setting this option has the effect of setting &%verify_sender%& and
18768 &%verify_recipient%& to the same value.
18769
18770
18771 .option verify_only routers&!? boolean false
18772 .cindex "EXPN" "with &%verify_only%&"
18773 .oindex "&%-bv%&"
18774 .cindex "router" "used only when verifying"
18775 If this option is set, the router is used only when verifying an address,
18776 delivering in cutthrough mode or
18777 testing with the &%-bv%& option, not when actually doing a delivery, testing
18778 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
18779 restricted to verifying only senders or recipients by means of
18780 &%verify_sender%& and &%verify_recipient%&.
18781
18782 &*Warning*&: When the router is being run to verify addresses for an incoming
18783 SMTP message, Exim is not running as root, but under its own uid. If the router
18784 accesses any files, you need to make sure that they are accessible to the Exim
18785 user or group.
18786
18787
18788 .option verify_recipient routers&!? boolean true
18789 If this option is false, the router is skipped when verifying recipient
18790 addresses,
18791 delivering in cutthrough mode
18792 or testing recipient verification using &%-bv%&.
18793 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18794 are evaluated.
18795 See also the &$verify_mode$& variable.
18796
18797
18798 .option verify_sender routers&!? boolean true
18799 If this option is false, the router is skipped when verifying sender addresses
18800 or testing sender verification using &%-bvs%&.
18801 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18802 are evaluated.
18803 See also the &$verify_mode$& variable.
18804 .ecindex IIDgenoprou1
18805 .ecindex IIDgenoprou2
18806
18807
18808
18809
18810
18811
18812 . ////////////////////////////////////////////////////////////////////////////
18813 . ////////////////////////////////////////////////////////////////////////////
18814
18815 .chapter "The accept router" "CHID4"
18816 .cindex "&(accept)& router"
18817 .cindex "routers" "&(accept)&"
18818 The &(accept)& router has no private options of its own. Unless it is being
18819 used purely for verification (see &%verify_only%&) a transport is required to
18820 be defined by the generic &%transport%& option. If the preconditions that are
18821 specified by generic options are met, the router accepts the address and queues
18822 it for the given transport. The most common use of this router is for setting
18823 up deliveries to local mailboxes. For example:
18824 .code
18825 localusers:
18826   driver = accept
18827   domains = mydomain.example
18828   check_local_user
18829   transport = local_delivery
18830 .endd
18831 The &%domains%& condition in this example checks the domain of the address, and
18832 &%check_local_user%& checks that the local part is the login of a local user.
18833 When both preconditions are met, the &(accept)& router runs, and queues the
18834 address for the &(local_delivery)& transport.
18835
18836
18837
18838
18839
18840
18841 . ////////////////////////////////////////////////////////////////////////////
18842 . ////////////////////////////////////////////////////////////////////////////
18843
18844 .chapter "The dnslookup router" "CHAPdnslookup"
18845 .scindex IIDdnsrou1 "&(dnslookup)& router"
18846 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
18847 The &(dnslookup)& router looks up the hosts that handle mail for the
18848 recipient's domain in the DNS. A transport must always be set for this router,
18849 unless &%verify_only%& is set.
18850
18851 If SRV support is configured (see &%check_srv%& below), Exim first searches for
18852 SRV records. If none are found, or if SRV support is not configured,
18853 MX records are looked up. If no MX records exist, address records are sought.
18854 However, &%mx_domains%& can be set to disable the direct use of address
18855 records.
18856
18857 MX records of equal priority are sorted by Exim into a random order. Exim then
18858 looks for address records for the host names obtained from MX or SRV records.
18859 When a host has more than one IP address, they are sorted into a random order,
18860 .new
18861 except that IPv6 addresses are sorted before IPv4 addresses. If all the
18862 .wen
18863 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
18864 generic option, the router declines.
18865
18866 Unless they have the highest priority (lowest MX value), MX records that point
18867 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
18868 are discarded, together with any other MX records of equal or lower priority.
18869
18870 .cindex "MX record" "pointing to local host"
18871 .cindex "local host" "MX pointing to"
18872 .oindex "&%self%&" "in &(dnslookup)& router"
18873 If the host pointed to by the highest priority MX record, or looked up as an
18874 address record, is the local host, or matches &%hosts_treat_as_local%&, what
18875 happens is controlled by the generic &%self%& option.
18876
18877
18878 .section "Problems with DNS lookups" "SECTprowitdnsloo"
18879 There have been problems with DNS servers when SRV records are looked up.
18880 Some misbehaving servers return a DNS error or timeout when a non-existent
18881 SRV record is sought. Similar problems have in the past been reported for
18882 MX records. The global &%dns_again_means_nonexist%& option can help with this
18883 problem, but it is heavy-handed because it is a global option.
18884
18885 For this reason, there are two options, &%srv_fail_domains%& and
18886 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
18887 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
18888 an attempt to look up an SRV or MX record causes one of these results, and the
18889 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
18890 such record"&. In the case of an SRV lookup, this means that the router
18891 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
18892 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
18893 case routing fails.
18894
18895
18896 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
18897 .cindex "&(dnslookup)& router" "declines"
18898 There are a few cases where a &(dnslookup)& router will decline to accept
18899 an address; if such a router is expected to handle "all remaining non-local
18900 domains", then it is important to set &%no_more%&.
18901
18902 The router will defer rather than decline if the domain
18903 is found in the &%fail_defer_domains%& router option.
18904
18905 Reasons for a &(dnslookup)& router to decline currently include:
18906 .ilist
18907 The domain does not exist in DNS
18908 .next
18909 The domain exists but the MX record's host part is just "."; this is a common
18910 convention (borrowed from SRV) used to indicate that there is no such service
18911 for this domain and to not fall back to trying A/AAAA records.
18912 .next
18913 Ditto, but for SRV records, when &%check_srv%& is set on this router.
18914 .next
18915 MX record points to a non-existent host.
18916 .next
18917 MX record points to an IP address and the main section option
18918 &%allow_mx_to_ip%& is not set.
18919 .next
18920 MX records exist and point to valid hosts, but all hosts resolve only to
18921 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
18922 .next
18923 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
18924 &%dns_check_names_pattern%& for handling one variant of this)
18925 .next
18926 &%check_secondary_mx%& is set on this router but the local host can
18927 not be found in the MX records (see below)
18928 .endlist
18929
18930
18931
18932
18933 .section "Private options for dnslookup" "SECID118"
18934 .cindex "options" "&(dnslookup)& router"
18935 The private options for the &(dnslookup)& router are as follows:
18936
18937 .option check_secondary_mx dnslookup boolean false
18938 .cindex "MX record" "checking for secondary"
18939 If this option is set, the router declines unless the local host is found in
18940 (and removed from) the list of hosts obtained by MX lookup. This can be used to
18941 process domains for which the local host is a secondary mail exchanger
18942 differently to other domains. The way in which Exim decides whether a host is
18943 the local host is described in section &<<SECTreclocipadd>>&.
18944
18945
18946 .option check_srv dnslookup string&!! unset
18947 .cindex "SRV record" "enabling use of"
18948 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
18949 addition to MX and address records. The support is disabled by default. To
18950 enable SRV support, set the &%check_srv%& option to the name of the service
18951 required. For example,
18952 .code
18953 check_srv = smtp
18954 .endd
18955 looks for SRV records that refer to the normal smtp service. The option is
18956 expanded, so the service name can vary from message to message or address
18957 to address. This might be helpful if SRV records are being used for a
18958 submission service. If the expansion is forced to fail, the &%check_srv%&
18959 option is ignored, and the router proceeds to look for MX records in the
18960 normal way.
18961
18962 When the expansion succeeds, the router searches first for SRV records for
18963 the given service (it assumes TCP protocol). A single SRV record with a
18964 host name that consists of just a single dot indicates &"no such service for
18965 this domain"&; if this is encountered, the router declines. If other kinds of
18966 SRV record are found, they are used to construct a host list for delivery
18967 according to the rules of RFC 2782. MX records are not sought in this case.
18968
18969 When no SRV records are found, MX records (and address records) are sought in
18970 the traditional way. In other words, SRV records take precedence over MX
18971 records, just as MX records take precedence over address records. Note that
18972 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
18973 defined it. It is apparently believed that MX records are sufficient for email
18974 and that SRV records should not be used for this purpose. However, SRV records
18975 have an additional &"weight"& feature which some people might find useful when
18976 trying to split an SMTP load between hosts of different power.
18977
18978 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
18979 when there is a DNS lookup error.
18980
18981
18982
18983
18984 .option fail_defer_domains dnslookup "domain list&!!" unset
18985 .cindex "MX record" "not found"
18986 DNS lookups for domains matching &%fail_defer_domains%&
18987 which find no matching record will cause the router to defer
18988 rather than the default behaviour of decline.
18989 This maybe be useful for queueing messages for a newly created
18990 domain while the DNS configuration is not ready.
18991 However, it will result in any message with mistyped domains
18992 also being queued.
18993
18994
18995 .new
18996 .option ipv4_only "string&!!" unset
18997 .cindex IPv6 disabling
18998 .cindex DNS "IPv6 disabling"
18999 The string is expanded, and if the result is anything but a forced failure,
19000 or an empty string, or one of the strings “0” or “no” or “false”
19001 (checked without regard to the case of the letters),
19002 only A records are used.
19003
19004 .option ipv4_prefer "string&!!" unset
19005 .cindex IPv4 preference
19006 .cindex DNS "IPv4 preference"
19007 The string is expanded, and if the result is anything but a forced failure,
19008 or an empty string, or one of the strings “0” or “no” or “false”
19009 (checked without regard to the case of the letters),
19010 A records are sorted before AAAA records (inverting the default).
19011 .wen
19012
19013 .option mx_domains dnslookup "domain list&!!" unset
19014 .cindex "MX record" "required to exist"
19015 .cindex "SRV record" "required to exist"
19016 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
19017 record in order to be recognized. (The name of this option could be improved.)
19018 For example, if all the mail hosts in &'fict.example'& are known to have MX
19019 records, except for those in &'discworld.fict.example'&, you could use this
19020 setting:
19021 .code
19022 mx_domains = ! *.discworld.fict.example : *.fict.example
19023 .endd
19024 This specifies that messages addressed to a domain that matches the list but
19025 has no MX record should be bounced immediately instead of being routed using
19026 the address record.
19027
19028
19029 .option mx_fail_domains dnslookup "domain list&!!" unset
19030 If the DNS lookup for MX records for one of the domains in this list causes a
19031 DNS lookup error, Exim behaves as if no MX records were found. See section
19032 &<<SECTprowitdnsloo>>& for more discussion.
19033
19034
19035
19036
19037 .option qualify_single dnslookup boolean true
19038 .cindex "DNS" "resolver options"
19039 .cindex "DNS" "qualifying single-component names"
19040 When this option is true, the resolver option RES_DEFNAMES is set for DNS
19041 lookups. Typically, but not standardly, this causes the resolver to qualify
19042 single-component names with the default domain. For example, on a machine
19043 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
19044 &'thesaurus.ref.example'& inside the resolver. For details of what your
19045 resolver actually does, consult your man pages for &'resolver'& and
19046 &'resolv.conf'&.
19047
19048
19049
19050 .option rewrite_headers dnslookup boolean true
19051 .cindex "rewriting" "header lines"
19052 .cindex "header lines" "rewriting"
19053 If the domain name in the address that is being processed is not fully
19054 qualified, it may be expanded to its full form by a DNS lookup. For example, if
19055 an address is specified as &'dormouse@teaparty'&, the domain might be
19056 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
19057 occur as a result of setting the &%widen_domains%& option. If
19058 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
19059 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
19060 header lines of the message are rewritten with the full domain name.
19061
19062 This option should be turned off only when it is known that no message is
19063 ever going to be sent outside an environment where the abbreviation makes
19064 sense.
19065
19066 When an MX record is looked up in the DNS and matches a wildcard record, name
19067 servers normally return a record containing the name that has been looked up,
19068 making it impossible to detect whether a wildcard was present or not. However,
19069 some name servers have recently been seen to return the wildcard entry. If the
19070 name returned by a DNS lookup begins with an asterisk, it is not used for
19071 header rewriting.
19072
19073
19074 .option same_domain_copy_routing dnslookup boolean false
19075 .cindex "address" "copying routing"
19076 Addresses with the same domain are normally routed by the &(dnslookup)& router
19077 to the same list of hosts. However, this cannot be presumed, because the router
19078 options and preconditions may refer to the local part of the address. By
19079 default, therefore, Exim routes each address in a message independently. DNS
19080 servers run caches, so repeated DNS lookups are not normally expensive, and in
19081 any case, personal messages rarely have more than a few recipients.
19082
19083 If you are running mailing lists with large numbers of subscribers at the same
19084 domain, and you are using a &(dnslookup)& router which is independent of the
19085 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
19086 lookups for identical domains in one message. In this case, when &(dnslookup)&
19087 routes an address to a remote transport, any other unrouted addresses in the
19088 message that have the same domain are automatically given the same routing
19089 without processing them independently,
19090 provided the following conditions are met:
19091
19092 .ilist
19093 No router that processed the address specified &%headers_add%& or
19094 &%headers_remove%&.
19095 .next
19096 The router did not change the address in any way, for example, by &"widening"&
19097 the domain.
19098 .endlist
19099
19100
19101
19102
19103 .option search_parents dnslookup boolean false
19104 .cindex "DNS" "resolver options"
19105 When this option is true, the resolver option RES_DNSRCH is set for DNS
19106 lookups. This is different from the &%qualify_single%& option in that it
19107 applies to domains containing dots. Typically, but not standardly, it causes
19108 the resolver to search for the name in the current domain and in parent
19109 domains. For example, on a machine in the &'fict.example'& domain, if looking
19110 up &'teaparty.wonderland'& failed, the resolver would try
19111 &'teaparty.wonderland.fict.example'&. For details of what your resolver
19112 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
19113
19114 Setting this option true can cause problems in domains that have a wildcard MX
19115 record, because any domain that does not have its own MX record matches the
19116 local wildcard.
19117
19118
19119
19120 .option srv_fail_domains dnslookup "domain list&!!" unset
19121 If the DNS lookup for SRV records for one of the domains in this list causes a
19122 DNS lookup error, Exim behaves as if no SRV records were found. See section
19123 &<<SECTprowitdnsloo>>& for more discussion.
19124
19125
19126
19127
19128 .option widen_domains dnslookup "string list" unset
19129 .cindex "domain" "partial; widening"
19130 If a DNS lookup fails and this option is set, each of its strings in turn is
19131 added onto the end of the domain, and the lookup is tried again. For example,
19132 if
19133 .code
19134 widen_domains = fict.example:ref.example
19135 .endd
19136 is set and a lookup of &'klingon.dictionary'& fails,
19137 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
19138 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
19139 and &%search_parents%& options can cause some widening to be undertaken inside
19140 the DNS resolver. &%widen_domains%& is not applied to sender addresses
19141 when verifying, unless &%rewrite_headers%& is false (not the default).
19142
19143
19144 .section "Effect of qualify_single and search_parents" "SECID119"
19145 When a domain from an envelope recipient is changed by the resolver as a result
19146 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
19147 corresponding address in the message's header lines unless &%rewrite_headers%&
19148 is set false. Exim then re-routes the address, using the full domain.
19149
19150 These two options affect only the DNS lookup that takes place inside the router
19151 for the domain of the address that is being routed. They do not affect lookups
19152 such as that implied by
19153 .code
19154 domains = @mx_any
19155 .endd
19156 that may happen while processing a router precondition before the router is
19157 entered. No widening ever takes place for these lookups.
19158 .ecindex IIDdnsrou1
19159 .ecindex IIDdnsrou2
19160
19161
19162
19163
19164
19165
19166
19167
19168
19169 . ////////////////////////////////////////////////////////////////////////////
19170 . ////////////////////////////////////////////////////////////////////////////
19171
19172 .chapter "The ipliteral router" "CHID5"
19173 .cindex "&(ipliteral)& router"
19174 .cindex "domain literal" "routing"
19175 .cindex "routers" "&(ipliteral)&"
19176 This router has no private options. Unless it is being used purely for
19177 verification (see &%verify_only%&) a transport is required to be defined by the
19178 generic &%transport%& option. The router accepts the address if its domain part
19179 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
19180 router handles the address
19181 .code
19182 root@[192.168.1.1]
19183 .endd
19184 by setting up delivery to the host with that IP address. IPv4 domain literals
19185 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
19186 are similar, but the address is preceded by &`ipv6:`&. For example:
19187 .code
19188 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
19189 .endd
19190 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
19191 grounds that sooner or later somebody will try it.
19192
19193 .oindex "&%self%&" "in &(ipliteral)& router"
19194 If the IP address matches something in &%ignore_target_hosts%&, the router
19195 declines. If an IP literal turns out to refer to the local host, the generic
19196 &%self%& option determines what happens.
19197
19198 The RFCs require support for domain literals; however, their use is
19199 controversial in today's Internet. If you want to use this router, you must
19200 also set the main configuration option &%allow_domain_literals%&. Otherwise,
19201 Exim will not recognize the domain literal syntax in addresses.
19202
19203
19204
19205 . ////////////////////////////////////////////////////////////////////////////
19206 . ////////////////////////////////////////////////////////////////////////////
19207
19208 .chapter "The iplookup router" "CHID6"
19209 .cindex "&(iplookup)& router"
19210 .cindex "routers" "&(iplookup)&"
19211 The &(iplookup)& router was written to fulfil a specific requirement in
19212 Cambridge University (which in fact no longer exists). For this reason, it is
19213 not included in the binary of Exim by default. If you want to include it, you
19214 must set
19215 .code
19216 ROUTER_IPLOOKUP=yes
19217 .endd
19218 in your &_Local/Makefile_& configuration file.
19219
19220 The &(iplookup)& router routes an address by sending it over a TCP or UDP
19221 connection to one or more specific hosts. The host can then return the same or
19222 a different address &-- in effect rewriting the recipient address in the
19223 message's envelope. The new address is then passed on to subsequent routers. If
19224 this process fails, the address can be passed on to other routers, or delivery
19225 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
19226 must not be specified for it.
19227
19228 .cindex "options" "&(iplookup)& router"
19229 .option hosts iplookup string unset
19230 This option must be supplied. Its value is a colon-separated list of host
19231 names. The hosts are looked up using &[gethostbyname()]&
19232 (or &[getipnodebyname()]& when available)
19233 and are tried in order until one responds to the query. If none respond, what
19234 happens is controlled by &%optional%&.
19235
19236
19237 .option optional iplookup boolean false
19238 If &%optional%& is true, if no response is obtained from any host, the address
19239 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
19240 delivery to the address is deferred.
19241
19242
19243 .option port iplookup integer 0
19244 .cindex "port" "&(iplookup)& router"
19245 This option must be supplied. It specifies the port number for the TCP or UDP
19246 call.
19247
19248
19249 .option protocol iplookup string udp
19250 This option can be set to &"udp"& or &"tcp"& to specify which of the two
19251 protocols is to be used.
19252
19253
19254 .option query iplookup string&!! "see below"
19255 This defines the content of the query that is sent to the remote hosts. The
19256 default value is:
19257 .code
19258 $local_part@$domain $local_part@$domain
19259 .endd
19260 The repetition serves as a way of checking that a response is to the correct
19261 query in the default case (see &%response_pattern%& below).
19262
19263
19264 .option reroute iplookup string&!! unset
19265 If this option is not set, the rerouted address is precisely the byte string
19266 returned by the remote host, up to the first white space, if any. If set, the
19267 string is expanded to form the rerouted address. It can include parts matched
19268 in the response by &%response_pattern%& by means of numeric variables such as
19269 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
19270 whether or not a pattern is in use. In all cases, the rerouted address must end
19271 up in the form &'local_part@domain'&.
19272
19273
19274 .option response_pattern iplookup string unset
19275 This option can be set to a regular expression that is applied to the string
19276 returned from the remote host. If the pattern does not match the response, the
19277 router declines. If &%response_pattern%& is not set, no checking of the
19278 response is done, unless the query was defaulted, in which case there is a
19279 check that the text returned after the first white space is the original
19280 address. This checks that the answer that has been received is in response to
19281 the correct question. For example, if the response is just a new domain, the
19282 following could be used:
19283 .code
19284 response_pattern = ^([^@]+)$
19285 reroute = $local_part@$1
19286 .endd
19287
19288 .option timeout iplookup time 5s
19289 This specifies the amount of time to wait for a response from the remote
19290 machine. The same timeout is used for the &[connect()]& function for a TCP
19291 call. It does not apply to UDP.
19292
19293
19294
19295
19296 . ////////////////////////////////////////////////////////////////////////////
19297 . ////////////////////////////////////////////////////////////////////////////
19298
19299 .chapter "The manualroute router" "CHID7"
19300 .scindex IIDmanrou1 "&(manualroute)& router"
19301 .scindex IIDmanrou2 "routers" "&(manualroute)&"
19302 .cindex "domain" "manually routing"
19303 The &(manualroute)& router is so-called because it provides a way of manually
19304 routing an address according to its domain. It is mainly used when you want to
19305 route addresses to remote hosts according to your own rules, bypassing the
19306 normal DNS routing that looks up MX records. However, &(manualroute)& can also
19307 route to local transports, a facility that may be useful if you want to save
19308 messages for dial-in hosts in local files.
19309
19310 The &(manualroute)& router compares a list of domain patterns with the domain
19311 it is trying to route. If there is no match, the router declines. Each pattern
19312 has associated with it a list of hosts and some other optional data, which may
19313 include a transport. The combination of a pattern and its data is called a
19314 &"routing rule"&. For patterns that do not have an associated transport, the
19315 generic &%transport%& option must specify a transport, unless the router is
19316 being used purely for verification (see &%verify_only%&).
19317
19318 .vindex "&$host$&"
19319 In the case of verification, matching the domain pattern is sufficient for the
19320 router to accept the address. When actually routing an address for delivery,
19321 an address that matches a domain pattern is queued for the associated
19322 transport. If the transport is not a local one, a host list must be associated
19323 with the pattern; IP addresses are looked up for the hosts, and these are
19324 passed to the transport along with the mail address. For local transports, a
19325 host list is optional. If it is present, it is passed in &$host$& as a single
19326 text string.
19327
19328 The list of routing rules can be provided as an inline string in
19329 &%route_list%&, or the data can be obtained by looking up the domain in a file
19330 or database by setting &%route_data%&. Only one of these settings may appear in
19331 any one instance of &(manualroute)&. The format of routing rules is described
19332 below, following the list of private options.
19333
19334
19335 .section "Private options for manualroute" "SECTprioptman"
19336
19337 .cindex "options" "&(manualroute)& router"
19338 The private options for the &(manualroute)& router are as follows:
19339
19340 .option host_all_ignored manualroute string defer
19341 See &%host_find_failed%&.
19342
19343 .option host_find_failed manualroute string freeze
19344 This option controls what happens when &(manualroute)& tries to find an IP
19345 address for a host, and the host does not exist. The option can be set to one
19346 of the following values:
19347 .code
19348 decline
19349 defer
19350 fail
19351 freeze
19352 ignore
19353 pass
19354 .endd
19355 The default (&"freeze"&) assumes that this state is a serious configuration
19356 error. The difference between &"pass"& and &"decline"& is that the former
19357 forces the address to be passed to the next router (or the router defined by
19358 &%pass_router%&),
19359 .oindex "&%more%&"
19360 overriding &%no_more%&, whereas the latter passes the address to the next
19361 router only if &%more%& is true.
19362
19363 The value &"ignore"& causes Exim to completely ignore a host whose IP address
19364 cannot be found. If all the hosts in the list are ignored, the behaviour is
19365 controlled by the &%host_all_ignored%& option. This takes the same values
19366 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
19367
19368 The &%host_find_failed%& option applies only to a definite &"does not exist"&
19369 state; if a host lookup gets a temporary error, delivery is deferred unless the
19370 generic &%pass_on_timeout%& option is set.
19371
19372
19373 .option hosts_randomize manualroute boolean false
19374 .cindex "randomized host list"
19375 .cindex "host" "list of; randomized"
19376 If this option is set, the order of the items in a host list in a routing rule
19377 is randomized each time the list is used, unless an option in the routing rule
19378 overrides (see below). Randomizing the order of a host list can be used to do
19379 crude load sharing. However, if more than one mail address is routed by the
19380 same router to the same host list, the host lists are considered to be the same
19381 (even though they may be randomized into different orders) for the purpose of
19382 deciding whether to batch the deliveries into a single SMTP transaction.
19383
19384 When &%hosts_randomize%& is true, a host list may be split
19385 into groups whose order is separately randomized. This makes it possible to
19386 set up MX-like behaviour. The boundaries between groups are indicated by an
19387 item that is just &`+`& in the host list. For example:
19388 .code
19389 route_list = * host1:host2:host3:+:host4:host5
19390 .endd
19391 The order of the first three hosts and the order of the last two hosts is
19392 randomized for each use, but the first three always end up before the last two.
19393 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
19394 randomized host list is passed to an &(smtp)& transport that also has
19395 &%hosts_randomize set%&, the list is not re-randomized.
19396
19397
19398 .option route_data manualroute string&!! unset
19399 If this option is set, it must expand to yield the data part of a routing rule.
19400 Typically, the expansion string includes a lookup based on the domain. For
19401 example:
19402 .code
19403 route_data = ${lookup{$domain}dbm{/etc/routes}}
19404 .endd
19405 If the expansion is forced to fail, or the result is an empty string, the
19406 router declines. Other kinds of expansion failure cause delivery to be
19407 deferred.
19408
19409
19410 .option route_list manualroute "string list" unset
19411 This string is a list of routing rules, in the form defined below. Note that,
19412 unlike most string lists, the items are separated by semicolons. This is so
19413 that they may contain colon-separated host lists.
19414
19415
19416 .option same_domain_copy_routing manualroute boolean false
19417 .cindex "address" "copying routing"
19418 Addresses with the same domain are normally routed by the &(manualroute)&
19419 router to the same list of hosts. However, this cannot be presumed, because the
19420 router options and preconditions may refer to the local part of the address. By
19421 default, therefore, Exim routes each address in a message independently. DNS
19422 servers run caches, so repeated DNS lookups are not normally expensive, and in
19423 any case, personal messages rarely have more than a few recipients.
19424
19425 If you are running mailing lists with large numbers of subscribers at the same
19426 domain, and you are using a &(manualroute)& router which is independent of the
19427 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
19428 lookups for identical domains in one message. In this case, when
19429 &(manualroute)& routes an address to a remote transport, any other unrouted
19430 addresses in the message that have the same domain are automatically given the
19431 same routing without processing them independently. However, this is only done
19432 if &%headers_add%& and &%headers_remove%& are unset.
19433
19434
19435
19436
19437 .section "Routing rules in route_list" "SECID120"
19438 The value of &%route_list%& is a string consisting of a sequence of routing
19439 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
19440 entered as two semicolons. Alternatively, the list separator can be changed as
19441 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
19442 Empty rules are ignored. The format of each rule is
19443 .display
19444 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
19445 .endd
19446 The following example contains two rules, each with a simple domain pattern and
19447 no options:
19448 .code
19449 route_list = \
19450   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
19451   thes.ref.example  mail-3.ref.example:mail-4.ref.example
19452 .endd
19453 The three parts of a rule are separated by white space. The pattern and the
19454 list of hosts can be enclosed in quotes if necessary, and if they are, the
19455 usual quoting rules apply. Each rule in a &%route_list%& must start with a
19456 single domain pattern, which is the only mandatory item in the rule. The
19457 pattern is in the same format as one item in a domain list (see section
19458 &<<SECTdomainlist>>&),
19459 except that it may not be the name of an interpolated file.
19460 That is, it may be wildcarded, or a regular expression, or a file or database
19461 lookup (with semicolons doubled, because of the use of semicolon as a separator
19462 in a &%route_list%&).
19463
19464 The rules in &%route_list%& are searched in order until one of the patterns
19465 matches the domain that is being routed. The list of hosts and then options are
19466 then used as described below. If there is no match, the router declines. When
19467 &%route_list%& is set, &%route_data%& must not be set.
19468
19469
19470
19471 .section "Routing rules in route_data" "SECID121"
19472 The use of &%route_list%& is convenient when there are only a small number of
19473 routing rules. For larger numbers, it is easier to use a file or database to
19474 hold the routing information, and use the &%route_data%& option instead.
19475 The value of &%route_data%& is a list of hosts, followed by (optional) options.
19476 Most commonly, &%route_data%& is set as a string that contains an
19477 expansion lookup. For example, suppose we place two routing rules in a file
19478 like this:
19479 .code
19480 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
19481 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
19482 .endd
19483 This data can be accessed by setting
19484 .code
19485 route_data = ${lookup{$domain}lsearch{/the/file/name}}
19486 .endd
19487 Failure of the lookup results in an empty string, causing the router to
19488 decline. However, you do not have to use a lookup in &%route_data%&. The only
19489 requirement is that the result of expanding the string is a list of hosts,
19490 possibly followed by options, separated by white space. The list of hosts must
19491 be enclosed in quotes if it contains white space.
19492
19493
19494
19495
19496 .section "Format of the list of hosts" "SECID122"
19497 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
19498 always separately expanded before use. If the expansion fails, the router
19499 declines. The result of the expansion must be a colon-separated list of names
19500 and/or IP addresses, optionally also including ports. The format of each item
19501 in the list is described in the next section. The list separator can be changed
19502 as described in section &<<SECTlistconstruct>>&.
19503
19504 If the list of hosts was obtained from a &%route_list%& item, the following
19505 variables are set during its expansion:
19506
19507 .ilist
19508 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
19509 If the domain was matched against a regular expression, the numeric variables
19510 &$1$&, &$2$&, etc. may be set. For example:
19511 .code
19512 route_list = ^domain(\d+)   host-$1.text.example
19513 .endd
19514 .next
19515 &$0$& is always set to the entire domain.
19516 .next
19517 &$1$& is also set when partial matching is done in a file lookup.
19518
19519 .next
19520 .vindex "&$value$&"
19521 If the pattern that matched the domain was a lookup item, the data that was
19522 looked up is available in the expansion variable &$value$&. For example:
19523 .code
19524 route_list = lsearch;;/some/file.routes  $value
19525 .endd
19526 .endlist
19527
19528 Note the doubling of the semicolon in the pattern that is necessary because
19529 semicolon is the default route list separator.
19530
19531
19532
19533 .section "Format of one host item" "SECTformatonehostitem"
19534 Each item in the list of hosts is either a host name or an IP address,
19535 optionally with an attached port number. When no port is given, an IP address
19536 is not enclosed in brackets. When a port is specified, it overrides the port
19537 specification on the transport. The port is separated from the name or address
19538 by a colon. This leads to some complications:
19539
19540 .ilist
19541 Because colon is the default separator for the list of hosts, either
19542 the colon that specifies a port must be doubled, or the list separator must
19543 be changed. The following two examples have the same effect:
19544 .code
19545 route_list = * "host1.tld::1225 : host2.tld::1226"
19546 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
19547 .endd
19548 .next
19549 When IPv6 addresses are involved, it gets worse, because they contain
19550 colons of their own. To make this case easier, it is permitted to
19551 enclose an IP address (either v4 or v6) in square brackets if a port
19552 number follows. For example:
19553 .code
19554 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
19555 .endd
19556 .endlist
19557
19558 .section "How the list of hosts is used" "SECThostshowused"
19559 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
19560 the hosts is tried, in the order specified, when carrying out the SMTP
19561 delivery. However, the order can be changed by setting the &%hosts_randomize%&
19562 option, either on the router (see section &<<SECTprioptman>>& above), or on the
19563 transport.
19564
19565 Hosts may be listed by name or by IP address. An unadorned name in the list of
19566 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
19567 interpreted as an indirection to a sublist of hosts obtained by looking up MX
19568 records in the DNS. For example:
19569 .code
19570 route_list = *  x.y.z:p.q.r/MX:e.f.g
19571 .endd
19572 If this feature is used with a port specifier, the port must come last. For
19573 example:
19574 .code
19575 route_list = *  dom1.tld/mx::1225
19576 .endd
19577 If the &%hosts_randomize%& option is set, the order of the items in the list is
19578 randomized before any lookups are done. Exim then scans the list; for any name
19579 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
19580 be an interface on the local host and the item is not the first in the list,
19581 Exim discards it and any subsequent items. If it is the first item, what
19582 happens is controlled by the
19583 .oindex "&%self%&" "in &(manualroute)& router"
19584 &%self%& option of the router.
19585
19586 A name on the list that is followed by &`/MX`& is replaced with the list of
19587 hosts obtained by looking up MX records for the name. This is always a DNS
19588 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
19589 below) are not relevant here. The order of these hosts is determined by the
19590 preference values in the MX records, according to the usual rules. Because
19591 randomizing happens before the MX lookup, it does not affect the order that is
19592 defined by MX preferences.
19593
19594 If the local host is present in the sublist obtained from MX records, but is
19595 not the most preferred host in that list, it and any equally or less
19596 preferred hosts are removed before the sublist is inserted into the main list.
19597
19598 If the local host is the most preferred host in the MX list, what happens
19599 depends on where in the original list of hosts the &`/MX`& item appears. If it
19600 is not the first item (that is, there are previous hosts in the main list),
19601 Exim discards this name and any subsequent items in the main list.
19602
19603 If the MX item is first in the list of hosts, and the local host is the
19604 most preferred host, what happens is controlled by the &%self%& option of the
19605 router.
19606
19607 DNS failures when lookup up the MX records are treated in the same way as DNS
19608 failures when looking up IP addresses: &%pass_on_timeout%& and
19609 &%host_find_failed%& are used when relevant.
19610
19611 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
19612 whether obtained from an MX lookup or not.
19613
19614
19615
19616 .section "How the options are used" "SECThowoptused"
19617 The options are a sequence of words, space-separated.
19618 One of the words can be the name of a transport; this overrides the
19619 &%transport%& option on the router for this particular routing rule only. The
19620 other words (if present) control randomization of the list of hosts on a
19621 per-rule basis, and how the IP addresses of the hosts are to be found when
19622 routing to a remote transport. These options are as follows:
19623
19624 .ilist
19625 &%randomize%&: randomize the order of the hosts in this list, overriding the
19626 setting of &%hosts_randomize%& for this routing rule only.
19627 .next
19628 &%no_randomize%&: do not randomize the order of the hosts in this list,
19629 overriding the setting of &%hosts_randomize%& for this routing rule only.
19630 .next
19631 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
19632 find IP addresses. This function may ultimately cause a DNS lookup, but it may
19633 also look in &_/etc/hosts_& or other sources of information.
19634 .next
19635 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
19636 no address records are found. If there is a temporary DNS error (such as a
19637 timeout), delivery is deferred.
19638 .new
19639 .next
19640 &%ipv4_only%&: in direct DNS lookups, look up only A records.
19641 .next
19642 &%ipv4_prefer%&: in direct DNS lookups, sort A records before AAAA records.
19643 .wen
19644 .endlist
19645
19646 For example:
19647 .code
19648 route_list = domain1  host1:host2:host3  randomize bydns;\
19649              domain2  host4:host5
19650 .endd
19651 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
19652 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
19653 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
19654 or &[gethostbyname()]&, and the result of the lookup is the result of that
19655 call.
19656
19657 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
19658 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
19659 instead of TRY_AGAIN. That is why the default action is to try a DNS
19660 lookup first. Only if that gives a definite &"no such host"& is the local
19661 function called.
19662
19663 &*Compatibility*&: From Exim 4.85 until fixed for 4.90, there was an
19664 inadvertent constraint that a transport name as an option had to be the last
19665 option specified.
19666
19667
19668
19669 If no IP address for a host can be found, what happens is controlled by the
19670 &%host_find_failed%& option.
19671
19672 .vindex "&$host$&"
19673 When an address is routed to a local transport, IP addresses are not looked up.
19674 The host list is passed to the transport in the &$host$& variable.
19675
19676
19677
19678 .section "Manualroute examples" "SECID123"
19679 In some of the examples that follow, the presence of the &%remote_smtp%&
19680 transport, as defined in the default configuration file, is assumed:
19681
19682 .ilist
19683 .cindex "smart host" "example router"
19684 The &(manualroute)& router can be used to forward all external mail to a
19685 &'smart host'&. If you have set up, in the main part of the configuration, a
19686 named domain list that contains your local domains, for example:
19687 .code
19688 domainlist local_domains = my.domain.example
19689 .endd
19690 You can arrange for all other domains to be routed to a smart host by making
19691 your first router something like this:
19692 .code
19693 smart_route:
19694   driver = manualroute
19695   domains = !+local_domains
19696   transport = remote_smtp
19697   route_list = * smarthost.ref.example
19698 .endd
19699 This causes all non-local addresses to be sent to the single host
19700 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
19701 they are tried in order
19702 (but you can use &%hosts_randomize%& to vary the order each time).
19703 Another way of configuring the same thing is this:
19704 .code
19705 smart_route:
19706   driver = manualroute
19707   transport = remote_smtp
19708   route_list = !+local_domains  smarthost.ref.example
19709 .endd
19710 There is no difference in behaviour between these two routers as they stand.
19711 However, they behave differently if &%no_more%& is added to them. In the first
19712 example, the router is skipped if the domain does not match the &%domains%&
19713 precondition; the following router is always tried. If the router runs, it
19714 always matches the domain and so can never decline. Therefore, &%no_more%&
19715 would have no effect. In the second case, the router is never skipped; it
19716 always runs. However, if it doesn't match the domain, it declines. In this case
19717 &%no_more%& would prevent subsequent routers from running.
19718
19719 .next
19720 .cindex "mail hub example"
19721 A &'mail hub'& is a host which receives mail for a number of domains via MX
19722 records in the DNS and delivers it via its own private routing mechanism. Often
19723 the final destinations are behind a firewall, with the mail hub being the one
19724 machine that can connect to machines both inside and outside the firewall. The
19725 &(manualroute)& router is usually used on a mail hub to route incoming messages
19726 to the correct hosts. For a small number of domains, the routing can be inline,
19727 using the &%route_list%& option, but for a larger number a file or database
19728 lookup is easier to manage.
19729
19730 If the domain names are in fact the names of the machines to which the mail is
19731 to be sent by the mail hub, the configuration can be quite simple. For
19732 example:
19733 .code
19734 hub_route:
19735   driver = manualroute
19736   transport = remote_smtp
19737   route_list = *.rhodes.tvs.example  $domain
19738 .endd
19739 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
19740 whose names are the same as the mail domains. A similar approach can be taken
19741 if the host name can be obtained from the domain name by a string manipulation
19742 that the expansion facilities can handle. Otherwise, a lookup based on the
19743 domain can be used to find the host:
19744 .code
19745 through_firewall:
19746   driver = manualroute
19747   transport = remote_smtp
19748   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
19749 .endd
19750 The result of the lookup must be the name or IP address of the host (or
19751 hosts) to which the address is to be routed. If the lookup fails, the route
19752 data is empty, causing the router to decline. The address then passes to the
19753 next router.
19754
19755 .next
19756 .cindex "batched SMTP output example"
19757 .cindex "SMTP" "batched outgoing; example"
19758 You can use &(manualroute)& to deliver messages to pipes or files in batched
19759 SMTP format for onward transportation by some other means. This is one way of
19760 storing mail for a dial-up host when it is not connected. The route list entry
19761 can be as simple as a single domain name in a configuration like this:
19762 .code
19763 save_in_file:
19764   driver = manualroute
19765   transport = batchsmtp_appendfile
19766   route_list = saved.domain.example
19767 .endd
19768 though often a pattern is used to pick up more than one domain. If there are
19769 several domains or groups of domains with different transport requirements,
19770 different transports can be listed in the routing information:
19771 .code
19772 save_in_file:
19773   driver = manualroute
19774   route_list = \
19775     *.saved.domain1.example  $domain  batch_appendfile; \
19776     *.saved.domain2.example  \
19777       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
19778       batch_pipe
19779 .endd
19780 .vindex "&$domain$&"
19781 .vindex "&$host$&"
19782 The first of these just passes the domain in the &$host$& variable, which
19783 doesn't achieve much (since it is also in &$domain$&), but the second does a
19784 file lookup to find a value to pass, causing the router to decline to handle
19785 the address if the lookup fails.
19786
19787 .next
19788 .cindex "UUCP" "example of router for"
19789 Routing mail directly to UUCP software is a specific case of the use of
19790 &(manualroute)& in a gateway to another mail environment. This is an example of
19791 one way it can be done:
19792 .code
19793 # Transport
19794 uucp:
19795   driver = pipe
19796   user = nobody
19797   command = /usr/local/bin/uux -r - \
19798     ${substr_-5:$host}!rmail ${local_part}
19799   return_fail_output = true
19800
19801 # Router
19802 uucphost:
19803   transport = uucp
19804   driver = manualroute
19805   route_data = \
19806     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
19807 .endd
19808 The file &_/usr/local/exim/uucphosts_& contains entries like
19809 .code
19810 darksite.ethereal.example:           darksite.UUCP
19811 .endd
19812 It can be set up more simply without adding and removing &".UUCP"& but this way
19813 makes clear the distinction between the domain name
19814 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
19815 .endlist
19816 .ecindex IIDmanrou1
19817 .ecindex IIDmanrou2
19818
19819
19820
19821
19822
19823
19824
19825
19826 . ////////////////////////////////////////////////////////////////////////////
19827 . ////////////////////////////////////////////////////////////////////////////
19828
19829 .chapter "The queryprogram router" "CHAPdriverlast"
19830 .scindex IIDquerou1 "&(queryprogram)& router"
19831 .scindex IIDquerou2 "routers" "&(queryprogram)&"
19832 .cindex "routing" "by external program"
19833 The &(queryprogram)& router routes an address by running an external command
19834 and acting on its output. This is an expensive way to route, and is intended
19835 mainly for use in lightly-loaded systems, or for performing experiments.
19836 However, if it is possible to use the precondition options (&%domains%&,
19837 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
19838 be used in special cases, even on a busy host. There are the following private
19839 options:
19840 .cindex "options" "&(queryprogram)& router"
19841
19842 .option command queryprogram string&!! unset
19843 This option must be set. It specifies the command that is to be run. The
19844 command is split up into a command name and arguments, and then each is
19845 expanded separately (exactly as for a &(pipe)& transport, described in chapter
19846 &<<CHAPpipetransport>>&).
19847
19848
19849 .option command_group queryprogram string unset
19850 .cindex "gid (group id)" "in &(queryprogram)& router"
19851 This option specifies a gid to be set when running the command while routing an
19852 address for deliver. It must be set if &%command_user%& specifies a numerical
19853 uid. If it begins with a digit, it is interpreted as the numerical value of the
19854 gid. Otherwise it is looked up using &[getgrnam()]&.
19855
19856
19857 .option command_user queryprogram string unset
19858 .cindex "uid (user id)" "for &(queryprogram)&"
19859 This option must be set. It specifies the uid which is set when running the
19860 command while routing an address for delivery. If the value begins with a digit,
19861 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
19862 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
19863 not set, a value for the gid also.
19864
19865 &*Warning:*& Changing uid and gid is possible only when Exim is running as
19866 root, which it does during a normal delivery in a conventional configuration.
19867 However, when an address is being verified during message reception, Exim is
19868 usually running as the Exim user, not as root. If the &(queryprogram)& router
19869 is called from a non-root process, Exim cannot change uid or gid before running
19870 the command. In this circumstance the command runs under the current uid and
19871 gid.
19872
19873
19874 .option current_directory queryprogram string /
19875 This option specifies an absolute path which is made the current directory
19876 before running the command.
19877
19878
19879 .option timeout queryprogram time 1h
19880 If the command does not complete within the timeout period, its process group
19881 is killed and the message is frozen. A value of zero time specifies no
19882 timeout.
19883
19884
19885 The standard output of the command is connected to a pipe, which is read when
19886 the command terminates. It should consist of a single line of output,
19887 containing up to five fields, separated by white space. The maximum length of
19888 the line is 1023 characters. Longer lines are silently truncated. The first
19889 field is one of the following words (case-insensitive):
19890
19891 .ilist
19892 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
19893 below).
19894 .next
19895 &'Decline'&: the router declines; pass the address to the next router, unless
19896 &%no_more%& is set.
19897 .next
19898 &'Fail'&: routing failed; do not pass the address to any more routers. Any
19899 subsequent text on the line is an error message. If the router is run as part
19900 of address verification during an incoming SMTP message, the message is
19901 included in the SMTP response.
19902 .next
19903 &'Defer'&: routing could not be completed at this time; try again later. Any
19904 subsequent text on the line is an error message which is logged. It is not
19905 included in any SMTP response.
19906 .next
19907 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
19908 .next
19909 &'Pass'&: pass the address to the next router (or the router specified by
19910 &%pass_router%&), overriding &%no_more%&.
19911 .next
19912 &'Redirect'&: the message is redirected. The remainder of the line is a list of
19913 new addresses, which are routed independently, starting with the first router,
19914 or the router specified by &%redirect_router%&, if set.
19915 .endlist
19916
19917 When the first word is &'accept'&, the remainder of the line consists of a
19918 number of keyed data values, as follows (split into two lines here, to fit on
19919 the page):
19920 .code
19921 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
19922 LOOKUP=byname|bydns DATA=<text>
19923 .endd
19924 The data items can be given in any order, and all are optional. If no transport
19925 is included, the transport specified by the generic &%transport%& option is
19926 used. The list of hosts and the lookup type are needed only if the transport is
19927 an &(smtp)& transport that does not itself supply a list of hosts.
19928
19929 The format of the list of hosts is the same as for the &(manualroute)& router.
19930 As well as host names and IP addresses with optional port numbers, as described
19931 in section &<<SECTformatonehostitem>>&, it may contain names followed by
19932 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
19933 (see section &<<SECThostshowused>>&).
19934
19935 If the lookup type is not specified, Exim behaves as follows when trying to
19936 find an IP address for each host: First, a DNS lookup is done. If this yields
19937 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
19938 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
19939 result of the lookup is the result of that call.
19940
19941 .vindex "&$address_data$&"
19942 If the DATA field is set, its value is placed in the &$address_data$&
19943 variable. For example, this return line
19944 .code
19945 accept hosts=x1.y.example:x2.y.example data="rule1"
19946 .endd
19947 routes the address to the default transport, passing a list of two hosts. When
19948 the transport runs, the string &"rule1"& is in &$address_data$&.
19949 .ecindex IIDquerou1
19950 .ecindex IIDquerou2
19951
19952
19953
19954
19955 . ////////////////////////////////////////////////////////////////////////////
19956 . ////////////////////////////////////////////////////////////////////////////
19957
19958 .chapter "The redirect router" "CHAPredirect"
19959 .scindex IIDredrou1 "&(redirect)& router"
19960 .scindex IIDredrou2 "routers" "&(redirect)&"
19961 .cindex "alias file" "in a &(redirect)& router"
19962 .cindex "address redirection" "&(redirect)& router"
19963 The &(redirect)& router handles several kinds of address redirection. Its most
19964 common uses are for resolving local part aliases from a central alias file
19965 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
19966 files, but it has many other potential uses. The incoming address can be
19967 redirected in several different ways:
19968
19969 .ilist
19970 It can be replaced by one or more new addresses which are themselves routed
19971 independently.
19972 .next
19973 It can be routed to be delivered to a given file or directory.
19974 .next
19975 It can be routed to be delivered to a specified pipe command.
19976 .next
19977 It can cause an automatic reply to be generated.
19978 .next
19979 It can be forced to fail, optionally with a custom error message.
19980 .next
19981 It can be temporarily deferred, optionally with a custom message.
19982 .next
19983 It can be discarded.
19984 .endlist
19985
19986 The generic &%transport%& option must not be set for &(redirect)& routers.
19987 However, there are some private options which define transports for delivery to
19988 files and pipes, and for generating autoreplies. See the &%file_transport%&,
19989 &%pipe_transport%& and &%reply_transport%& descriptions below.
19990
19991 If success DSNs have been requested
19992 .cindex "DSN" "success"
19993 .cindex "Delivery Status Notification" "success"
19994 redirection triggers one and the DSN options are not passed any further.
19995
19996
19997
19998 .section "Redirection data" "SECID124"
19999 The router operates by interpreting a text string which it obtains either by
20000 expanding the contents of the &%data%& option, or by reading the entire
20001 contents of a file whose name is given in the &%file%& option. These two
20002 options are mutually exclusive. The first is commonly used for handling system
20003 aliases, in a configuration like this:
20004 .code
20005 system_aliases:
20006   driver = redirect
20007   data = ${lookup{$local_part}lsearch{/etc/aliases}}
20008 .endd
20009 If the lookup fails, the expanded string in this example is empty. When the
20010 expansion of &%data%& results in an empty string, the router declines. A forced
20011 expansion failure also causes the router to decline; other expansion failures
20012 cause delivery to be deferred.
20013
20014 A configuration using &%file%& is commonly used for handling users'
20015 &_.forward_& files, like this:
20016 .code
20017 userforward:
20018   driver = redirect
20019   check_local_user
20020   file = $home/.forward
20021   no_verify
20022 .endd
20023 If the file does not exist, or causes no action to be taken (for example, it is
20024 empty or consists only of comments), the router declines. &*Warning*&: This
20025 is not the case when the file contains syntactically valid items that happen to
20026 yield empty addresses, for example, items containing only RFC 2822 address
20027 comments.
20028
20029
20030
20031 .section "Forward files and address verification" "SECID125"
20032 .cindex "address redirection" "while verifying"
20033 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
20034 &_.forward_& files, as in the example above. There are two reasons for this:
20035
20036 .ilist
20037 When Exim is receiving an incoming SMTP message from a remote host, it is
20038 running under the Exim uid, not as root. Exim is unable to change uid to read
20039 the file as the user, and it may not be able to read it as the Exim user. So in
20040 practice the router may not be able to operate.
20041 .next
20042 However, even when the router can operate, the existence of a &_.forward_& file
20043 is unimportant when verifying an address. What should be checked is whether the
20044 local part is a valid user name or not. Cutting out the redirection processing
20045 saves some resources.
20046 .endlist
20047
20048
20049
20050
20051
20052
20053 .section "Interpreting redirection data" "SECID126"
20054 .cindex "Sieve filter" "specifying in redirection data"
20055 .cindex "filter" "specifying in redirection data"
20056 The contents of the data string, whether obtained from &%data%& or &%file%&,
20057 can be interpreted in two different ways:
20058
20059 .ilist
20060 If the &%allow_filter%& option is set true, and the data begins with the text
20061 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
20062 &'filtering'& instructions in the form of an Exim or Sieve filter file,
20063 respectively. Details of the syntax and semantics of filter files are described
20064 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
20065 document is intended for use by end users.
20066 .next
20067 Otherwise, the data must be a comma-separated list of redirection items, as
20068 described in the next section.
20069 .endlist
20070
20071 When a message is redirected to a file (a &"mail folder"&), the file name given
20072 in a non-filter redirection list must always be an absolute path. A filter may
20073 generate a relative path &-- how this is handled depends on the transport's
20074 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
20075 for the &(appendfile)& transport.
20076
20077
20078
20079 .section "Items in a non-filter redirection list" "SECTitenonfilred"
20080 .cindex "address redirection" "non-filter list items"
20081 When the redirection data is not an Exim or Sieve filter, for example, if it
20082 comes from a conventional alias or forward file, it consists of a list of
20083 addresses, file names, pipe commands, or certain special items (see section
20084 &<<SECTspecitredli>>& below). The special items can be individually enabled or
20085 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
20086 depending on their default values. The items in the list are separated by
20087 commas or newlines.
20088 If a comma is required in an item, the entire item must be enclosed in double
20089 quotes.
20090
20091 Lines starting with a # character are comments, and are ignored, and # may
20092 also appear following a comma, in which case everything between the # and the
20093 next newline character is ignored.
20094
20095 If an item is entirely enclosed in double quotes, these are removed. Otherwise
20096 double quotes are retained because some forms of mail address require their use
20097 (but never to enclose the entire address). In the following description,
20098 &"item"& refers to what remains after any surrounding double quotes have been
20099 removed.
20100
20101 .vindex "&$local_part$&"
20102 &*Warning*&: If you use an Exim expansion to construct a redirection address,
20103 and the expansion contains a reference to &$local_part$&, you should make use
20104 of the &%quote_local_part%& expansion operator, in case the local part contains
20105 special characters. For example, to redirect all mail for the domain
20106 &'obsolete.example'&, retaining the existing local part, you could use this
20107 setting:
20108 .code
20109 data = ${quote_local_part:$local_part}@newdomain.example
20110 .endd
20111
20112
20113 .section "Redirecting to a local mailbox" "SECTredlocmai"
20114 .cindex "routing" "loops in"
20115 .cindex "loop" "while routing, avoidance of"
20116 .cindex "address redirection" "to local mailbox"
20117 A redirection item may safely be the same as the address currently under
20118 consideration. This does not cause a routing loop, because a router is
20119 automatically skipped if any ancestor of the address that is being processed
20120 is the same as the current address and was processed by the current router.
20121 Such an address is therefore passed to the following routers, so it is handled
20122 as if there were no redirection. When making this loop-avoidance test, the
20123 complete local part, including any prefix or suffix, is used.
20124
20125 .cindex "address redirection" "local part without domain"
20126 Specifying the same local part without a domain is a common usage in personal
20127 filter files when the user wants to have messages delivered to the local
20128 mailbox and also forwarded elsewhere. For example, the user whose login is
20129 &'cleo'& might have a &_.forward_& file containing this:
20130 .code
20131 cleo, cleopatra@egypt.example
20132 .endd
20133 .cindex "backslash in alias file"
20134 .cindex "alias file" "backslash in"
20135 For compatibility with other MTAs, such unqualified local parts may be
20136 preceded by &"\"&, but this is not a requirement for loop prevention. However,
20137 it does make a difference if more than one domain is being handled
20138 synonymously.
20139
20140 If an item begins with &"\"& and the rest of the item parses as a valid RFC
20141 2822 address that does not include a domain, the item is qualified using the
20142 domain of the incoming address. In the absence of a leading &"\"&, unqualified
20143 addresses are qualified using the value in &%qualify_recipient%&, but you can
20144 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
20145
20146 Care must be taken if there are alias names for local users.
20147 Consider an MTA handling a single local domain where the system alias file
20148 contains:
20149 .code
20150 Sam.Reman: spqr
20151 .endd
20152 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
20153 messages in the local mailbox, and also forward copies elsewhere. He creates
20154 this forward file:
20155 .code
20156 Sam.Reman, spqr@reme.elsewhere.example
20157 .endd
20158 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
20159 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
20160 second time round, because it has previously routed it,
20161 and the following routers presumably cannot handle the alias. The forward file
20162 should really contain
20163 .code
20164 spqr, spqr@reme.elsewhere.example
20165 .endd
20166 but because this is such a common error, the &%check_ancestor%& option (see
20167 below) exists to provide a way to get round it. This is normally set on a
20168 &(redirect)& router that is handling users' &_.forward_& files.
20169
20170
20171
20172 .section "Special items in redirection lists" "SECTspecitredli"
20173 In addition to addresses, the following types of item may appear in redirection
20174 lists (that is, in non-filter redirection data):
20175
20176 .ilist
20177 .cindex "pipe" "in redirection list"
20178 .cindex "address redirection" "to pipe"
20179 An item is treated as a pipe command if it begins with &"|"& and does not parse
20180 as a valid RFC 2822 address that includes a domain. A transport for running the
20181 command must be specified by the &%pipe_transport%& option.
20182 Normally, either the router or the transport specifies a user and a group under
20183 which to run the delivery. The default is to use the Exim user and group.
20184
20185 Single or double quotes can be used for enclosing the individual arguments of
20186 the pipe command; no interpretation of escapes is done for single quotes. If
20187 the command contains a comma character, it is necessary to put the whole item
20188 in double quotes, for example:
20189 .code
20190 "|/some/command ready,steady,go"
20191 .endd
20192 since items in redirection lists are terminated by commas. Do not, however,
20193 quote just the command. An item such as
20194 .code
20195 |"/some/command ready,steady,go"
20196 .endd
20197 is interpreted as a pipe with a rather strange command name, and no arguments.
20198
20199 Note that the above example assumes that the text comes from a lookup source
20200 of some sort, so that the quotes are part of the data.  If composing a
20201 redirect router with a &%data%& option directly specifying this command, the
20202 quotes will be used by the configuration parser to define the extent of one
20203 string, but will not be passed down into the redirect router itself.  There
20204 are two main approaches to get around this: escape quotes to be part of the
20205 data itself, or avoid using this mechanism and instead create a custom
20206 transport with the &%command%& option set and reference that transport from
20207 an &%accept%& router.
20208
20209 .next
20210 .cindex "file" "in redirection list"
20211 .cindex "address redirection" "to file"
20212 An item is interpreted as a path name if it begins with &"/"& and does not
20213 parse as a valid RFC 2822 address that includes a domain. For example,
20214 .code
20215 /home/world/minbari
20216 .endd
20217 is treated as a file name, but
20218 .code
20219 /s=molari/o=babylon/@x400gate.way
20220 .endd
20221 is treated as an address. For a file name, a transport must be specified using
20222 the &%file_transport%& option. However, if the generated path name ends with a
20223 forward slash character, it is interpreted as a directory name rather than a
20224 file name, and &%directory_transport%& is used instead.
20225
20226 Normally, either the router or the transport specifies a user and a group under
20227 which to run the delivery. The default is to use the Exim user and group.
20228
20229 .cindex "&_/dev/null_&"
20230 However, if a redirection item is the path &_/dev/null_&, delivery to it is
20231 bypassed at a high level, and the log entry shows &"**bypassed**"&
20232 instead of a transport name. In this case the user and group are not used.
20233
20234 .next
20235 .cindex "included address list"
20236 .cindex "address redirection" "included external list"
20237 If an item is of the form
20238 .code
20239 :include:<path name>
20240 .endd
20241 a list of further items is taken from the given file and included at that
20242 point. &*Note*&: Such a file can not be a filter file; it is just an
20243 out-of-line addition to the list. The items in the included list are separated
20244 by commas or newlines and are not subject to expansion. If this is the first
20245 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
20246 the alias name. This example is incorrect:
20247 .code
20248 list1    :include:/opt/lists/list1
20249 .endd
20250 It must be given as
20251 .code
20252 list1:   :include:/opt/lists/list1
20253 .endd
20254 .next
20255 .cindex "address redirection" "to black hole"
20256 .cindex "delivery" "discard"
20257 .cindex "delivery" "blackhole"
20258 .cindex "black hole"
20259 .cindex "abandoning mail"
20260 Sometimes you want to throw away mail to a particular local part.  Making the
20261 &%data%& option expand to an empty string does not work, because that causes
20262 the router to decline. Instead, the alias item
20263 .code
20264 :blackhole:
20265 .endd
20266 can be used. It does what its name implies. No delivery is
20267 done, and no error message is generated. This has the same effect as specifying
20268 &_/dev/null_& as a destination, but it can be independently disabled.
20269
20270 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
20271 delivery is done for the original local part, even if other redirection items
20272 are present. If you are generating a multi-item list (for example, by reading a
20273 database) and need the ability to provide a no-op item, you must use
20274 &_/dev/null_&.
20275
20276 .next
20277 .cindex "delivery" "forcing failure"
20278 .cindex "delivery" "forcing deferral"
20279 .cindex "failing delivery" "forcing"
20280 .cindex "deferred delivery, forcing"
20281 .cindex "customizing" "failure message"
20282 An attempt to deliver a particular address can be deferred or forced to fail by
20283 redirection items of the form
20284 .code
20285 :defer:
20286 :fail:
20287 .endd
20288 respectively. When a redirection list contains such an item, it applies
20289 to the entire redirection; any other items in the list are ignored. Any
20290 text following &':fail:'& or &':defer:'& is placed in the error text
20291 associated with the failure. For example, an alias file might contain:
20292 .code
20293 X.Employee:  :fail: Gone away, no forwarding address
20294 .endd
20295 In the case of an address that is being verified from an ACL or as the subject
20296 of a
20297 .cindex "VRFY" "error text, display of"
20298 VRFY command, the text is included in the SMTP error response by
20299 default.
20300 .cindex "EXPN" "error text, display of"
20301 The text is not included in the response to an EXPN command. In non-SMTP cases
20302 the text is included in the error message that Exim generates.
20303
20304 .cindex "SMTP" "error codes"
20305 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
20306 &':fail:'&. However, if the message starts with three digits followed by a
20307 space, optionally followed by an extended code of the form &'n.n.n'&, also
20308 followed by a space, and the very first digit is the same as the default error
20309 code, the code from the message is used instead. If the very first digit is
20310 incorrect, a panic error is logged, and the default code is used. You can
20311 suppress the use of the supplied code in a redirect router by setting the
20312 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
20313 ignored.
20314
20315 .vindex "&$acl_verify_message$&"
20316 In an ACL, an explicitly provided message overrides the default, but the
20317 default message is available in the variable &$acl_verify_message$& and can
20318 therefore be included in a custom message if this is desired.
20319
20320 Normally the error text is the rest of the redirection list &-- a comma does
20321 not terminate it &-- but a newline does act as a terminator. Newlines are not
20322 normally present in alias expansions. In &(lsearch)& lookups they are removed
20323 as part of the continuation process, but they may exist in other kinds of
20324 lookup and in &':include:'& files.
20325
20326 During routing for message delivery (as opposed to verification), a redirection
20327 containing &':fail:'& causes an immediate failure of the incoming address,
20328 whereas &':defer:'& causes the message to remain on the queue so that a
20329 subsequent delivery attempt can happen at a later time. If an address is
20330 deferred for too long, it will ultimately fail, because the normal retry
20331 rules still apply.
20332
20333 .next
20334 .cindex "alias file" "exception to default"
20335 Sometimes it is useful to use a single-key search type with a default (see
20336 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
20337 for exceptions to the default. These can be handled by aliasing them to
20338 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
20339 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
20340 results in an empty redirection list has the same effect.
20341 .endlist
20342
20343
20344 .section "Duplicate addresses" "SECTdupaddr"
20345 .cindex "duplicate addresses"
20346 .cindex "address duplicate, discarding"
20347 .cindex "pipe" "duplicated"
20348 Exim removes duplicate addresses from the list to which it is delivering, so as
20349 to deliver just one copy to each address. This does not apply to deliveries
20350 routed to pipes by different immediate parent addresses, but an indirect
20351 aliasing scheme of the type
20352 .code
20353 pipe:       |/some/command $local_part
20354 localpart1: pipe
20355 localpart2: pipe
20356 .endd
20357 does not work with a message that is addressed to both local parts, because
20358 when the second is aliased to the intermediate local part &"pipe"& it gets
20359 discarded as being the same as a previously handled address. However, a scheme
20360 such as
20361 .code
20362 localpart1: |/some/command $local_part
20363 localpart2: |/some/command $local_part
20364 .endd
20365 does result in two different pipe deliveries, because the immediate parents of
20366 the pipes are distinct.
20367
20368
20369
20370 .section "Repeated redirection expansion" "SECID128"
20371 .cindex "repeated redirection expansion"
20372 .cindex "address redirection" "repeated for each delivery attempt"
20373 When a message cannot be delivered to all of its recipients immediately,
20374 leading to two or more delivery attempts, redirection expansion is carried out
20375 afresh each time for those addresses whose children were not all previously
20376 delivered. If redirection is being used as a mailing list, this can lead to new
20377 members of the list receiving copies of old messages. The &%one_time%& option
20378 can be used to avoid this.
20379
20380
20381 .section "Errors in redirection lists" "SECID129"
20382 .cindex "address redirection" "errors"
20383 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
20384 error is skipped, and an entry is written to the main log. This may be useful
20385 for mailing lists that are automatically managed. Otherwise, if an error is
20386 detected while generating the list of new addresses, the original address is
20387 deferred. See also &%syntax_errors_to%&.
20388
20389
20390
20391 .section "Private options for the redirect router" "SECID130"
20392
20393 .cindex "options" "&(redirect)& router"
20394 The private options for the &(redirect)& router are as follows:
20395
20396
20397 .option allow_defer redirect boolean false
20398 Setting this option allows the use of &':defer:'& in non-filter redirection
20399 data, or the &%defer%& command in an Exim filter file.
20400
20401
20402 .option allow_fail redirect boolean false
20403 .cindex "failing delivery" "from filter"
20404 If this option is true, the &':fail:'& item can be used in a redirection list,
20405 and the &%fail%& command may be used in an Exim filter file.
20406
20407
20408 .option allow_filter redirect boolean false
20409 .cindex "filter" "enabling use of"
20410 .cindex "Sieve filter" "enabling use of"
20411 Setting this option allows Exim to interpret redirection data that starts with
20412 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
20413 are some features of Exim filter files that some administrators may wish to
20414 lock out; see the &%forbid_filter_%&&'xxx'& options below.
20415
20416 It is also possible to lock out Exim filters or Sieve filters while allowing
20417 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
20418
20419
20420 The filter is run using the uid and gid set by the generic &%user%& and
20421 &%group%& options. These take their defaults from the password data if
20422 &%check_local_user%& is set, so in the normal case of users' personal filter
20423 files, the filter is run as the relevant user. When &%allow_filter%& is set
20424 true, Exim insists that either &%check_local_user%& or &%user%& is set.
20425
20426
20427
20428 .option allow_freeze redirect boolean false
20429 .cindex "freezing messages" "allowing in filter"
20430 Setting this option allows the use of the &%freeze%& command in an Exim filter.
20431 This command is more normally encountered in system filters, and is disabled by
20432 default for redirection filters because it isn't something you usually want to
20433 let ordinary users do.
20434
20435
20436
20437 .option check_ancestor redirect boolean false
20438 This option is concerned with handling generated addresses that are the same
20439 as some address in the list of redirection ancestors of the current address.
20440 Although it is turned off by default in the code, it is set in the default
20441 configuration file for handling users' &_.forward_& files. It is recommended
20442 for this use of the &(redirect)& router.
20443
20444 When &%check_ancestor%& is set, if a generated address (including the domain)
20445 is the same as any ancestor of the current address, it is replaced by a copy of
20446 the current address. This helps in the case where local part A is aliased to B,
20447 and B has a &_.forward_& file pointing back to A. For example, within a single
20448 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
20449 &_&~jb/.forward_& contains:
20450 .code
20451 \Joe.Bloggs, <other item(s)>
20452 .endd
20453 Without the &%check_ancestor%& setting, either local part (&"jb"& or
20454 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
20455 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
20456 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
20457 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
20458 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
20459 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
20460 original address. See also the &%repeat_use%& option below.
20461
20462
20463 .option check_group redirect boolean "see below"
20464 When the &%file%& option is used, the group owner of the file is checked only
20465 when this option is set. The permitted groups are those listed in the
20466 &%owngroups%& option, together with the user's default group if
20467 &%check_local_user%& is set. If the file has the wrong group, routing is
20468 deferred. The default setting for this option is true if &%check_local_user%&
20469 is set and the &%modemask%& option permits the group write bit, or if the
20470 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
20471
20472
20473
20474 .option check_owner redirect boolean "see below"
20475 When the &%file%& option is used, the owner of the file is checked only when
20476 this option is set. If &%check_local_user%& is set, the local user is
20477 permitted; otherwise the owner must be one of those listed in the &%owners%&
20478 option. The default value for this option is true if &%check_local_user%& or
20479 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
20480
20481
20482 .option data redirect string&!! unset
20483 This option is mutually exclusive with &%file%&. One or other of them must be
20484 set, but not both. The contents of &%data%& are expanded, and then used as the
20485 list of forwarding items, or as a set of filtering instructions. If the
20486 expansion is forced to fail, or the result is an empty string or a string that
20487 has no effect (consists entirely of comments), the router declines.
20488
20489 When filtering instructions are used, the string must begin with &"#Exim
20490 filter"&, and all comments in the string, including this initial one, must be
20491 terminated with newline characters. For example:
20492 .code
20493 data = #Exim filter\n\
20494        if $h_to: contains Exim then save $home/mail/exim endif
20495 .endd
20496 If you are reading the data from a database where newlines cannot be included,
20497 you can use the &${sg}$& expansion item to turn the escape string of your
20498 choice into a newline.
20499
20500
20501 .option directory_transport redirect string&!! unset
20502 A &(redirect)& router sets up a direct delivery to a directory when a path name
20503 ending with a slash is specified as a new &"address"&. The transport used is
20504 specified by this option, which, after expansion, must be the name of a
20505 configured transport. This should normally be an &(appendfile)& transport.
20506
20507
20508 .option file redirect string&!! unset
20509 This option specifies the name of a file that contains the redirection data. It
20510 is mutually exclusive with the &%data%& option. The string is expanded before
20511 use; if the expansion is forced to fail, the router declines. Other expansion
20512 failures cause delivery to be deferred. The result of a successful expansion
20513 must be an absolute path. The entire file is read and used as the redirection
20514 data. If the data is an empty string or a string that has no effect (consists
20515 entirely of comments), the router declines.
20516
20517 .cindex "NFS" "checking for file existence"
20518 If the attempt to open the file fails with a &"does not exist"& error, Exim
20519 runs a check on the containing directory,
20520 unless &%ignore_enotdir%& is true (see below).
20521 If the directory does not appear to exist, delivery is deferred. This can
20522 happen when users' &_.forward_& files are in NFS-mounted directories, and there
20523 is a mount problem. If the containing directory does exist, but the file does
20524 not, the router declines.
20525
20526
20527 .option file_transport redirect string&!! unset
20528 .vindex "&$address_file$&"
20529 A &(redirect)& router sets up a direct delivery to a file when a path name not
20530 ending in a slash is specified as a new &"address"&. The transport used is
20531 specified by this option, which, after expansion, must be the name of a
20532 configured transport. This should normally be an &(appendfile)& transport. When
20533 it is running, the file name is in &$address_file$&.
20534
20535
20536 .option filter_prepend_home redirect boolean true
20537 When this option is true, if a &(save)& command in an Exim filter specifies a
20538 relative path, and &$home$& is defined, it is automatically prepended to the
20539 relative path. If this option is set false, this action does not happen. The
20540 relative path is then passed to the transport unmodified.
20541
20542
20543 .option forbid_blackhole redirect boolean false
20544 .cindex "restricting access to features"
20545 .cindex "filter" "locking out certain features"
20546 If this option is true, the &':blackhole:'& item may not appear in a
20547 redirection list.
20548
20549
20550 .option forbid_exim_filter redirect boolean false
20551 .cindex "restricting access to features"
20552 .cindex "filter" "locking out certain features"
20553 If this option is set true, only Sieve filters are permitted when
20554 &%allow_filter%& is true.
20555
20556
20557
20558
20559 .option forbid_file redirect boolean false
20560 .cindex "restricting access to features"
20561 .cindex "delivery" "to file; forbidding"
20562 .cindex "filter" "locking out certain features"
20563 .cindex "Sieve filter" "forbidding delivery to a file"
20564 .cindex "Sieve filter" "&""keep""& facility; disabling"
20565 If this option is true, this router may not generate a new address that
20566 specifies delivery to a local file or directory, either from a filter or from a
20567 conventional forward file. This option is forced to be true if &%one_time%& is
20568 set. It applies to Sieve filters as well as to Exim filters, but if true, it
20569 locks out the Sieve's &"keep"& facility.
20570
20571
20572 .option forbid_filter_dlfunc redirect boolean false
20573 .cindex "restricting access to features"
20574 .cindex "filter" "locking out certain features"
20575 If this option is true, string expansions in Exim filters are not allowed to
20576 make use of the &%dlfunc%& expansion facility to run dynamically loaded
20577 functions.
20578
20579 .option forbid_filter_existstest redirect boolean false
20580 .cindex "restricting access to features"
20581 .cindex "filter" "locking out certain features"
20582 .cindex "expansion" "statting a file"
20583 If this option is true, string expansions in Exim filters are not allowed to
20584 make use of the &%exists%& condition or the &%stat%& expansion item.
20585
20586 .option forbid_filter_logwrite redirect boolean false
20587 .cindex "restricting access to features"
20588 .cindex "filter" "locking out certain features"
20589 If this option is true, use of the logging facility in Exim filters is not
20590 permitted. Logging is in any case available only if the filter is being run
20591 under some unprivileged uid (which is normally the case for ordinary users'
20592 &_.forward_& files).
20593
20594
20595 .option forbid_filter_lookup redirect boolean false
20596 .cindex "restricting access to features"
20597 .cindex "filter" "locking out certain features"
20598 If this option is true, string expansions in Exim filter files are not allowed
20599 to make use of &%lookup%& items.
20600
20601
20602 .option forbid_filter_perl redirect boolean false
20603 .cindex "restricting access to features"
20604 .cindex "filter" "locking out certain features"
20605 This option has an effect only if Exim is built with embedded Perl support. If
20606 it is true, string expansions in Exim filter files are not allowed to make use
20607 of the embedded Perl support.
20608
20609
20610 .option forbid_filter_readfile redirect boolean false
20611 .cindex "restricting access to features"
20612 .cindex "filter" "locking out certain features"
20613 If this option is true, string expansions in Exim filter files are not allowed
20614 to make use of &%readfile%& items.
20615
20616
20617 .option forbid_filter_readsocket redirect boolean false
20618 .cindex "restricting access to features"
20619 .cindex "filter" "locking out certain features"
20620 If this option is true, string expansions in Exim filter files are not allowed
20621 to make use of &%readsocket%& items.
20622
20623
20624 .option forbid_filter_reply redirect boolean false
20625 .cindex "restricting access to features"
20626 .cindex "filter" "locking out certain features"
20627 If this option is true, this router may not generate an automatic reply
20628 message. Automatic replies can be generated only from Exim or Sieve filter
20629 files, not from traditional forward files. This option is forced to be true if
20630 &%one_time%& is set.
20631
20632
20633 .option forbid_filter_run redirect boolean false
20634 .cindex "restricting access to features"
20635 .cindex "filter" "locking out certain features"
20636 If this option is true, string expansions in Exim filter files are not allowed
20637 to make use of &%run%& items.
20638
20639
20640 .option forbid_include redirect boolean false
20641 .cindex "restricting access to features"
20642 .cindex "filter" "locking out certain features"
20643 If this option is true, items of the form
20644 .code
20645 :include:<path name>
20646 .endd
20647 are not permitted in non-filter redirection lists.
20648
20649
20650 .option forbid_pipe redirect boolean false
20651 .cindex "restricting access to features"
20652 .cindex "filter" "locking out certain features"
20653 .cindex "delivery" "to pipe; forbidding"
20654 If this option is true, this router may not generate a new address which
20655 specifies delivery to a pipe, either from an Exim filter or from a conventional
20656 forward file. This option is forced to be true if &%one_time%& is set.
20657
20658
20659 .option forbid_sieve_filter redirect boolean false
20660 .cindex "restricting access to features"
20661 .cindex "filter" "locking out certain features"
20662 If this option is set true, only Exim filters are permitted when
20663 &%allow_filter%& is true.
20664
20665
20666 .cindex "SMTP" "error codes"
20667 .option forbid_smtp_code redirect boolean false
20668 If this option is set true, any SMTP error codes that are present at the start
20669 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
20670 the default codes (451 and 550, respectively) are always used.
20671
20672
20673
20674
20675 .option hide_child_in_errmsg redirect boolean false
20676 .cindex "bounce message" "redirection details; suppressing"
20677 If this option is true, it prevents Exim from quoting a child address if it
20678 generates a bounce or delay message for it. Instead it says &"an address
20679 generated from <&'the top level address'&>"&. Of course, this applies only to
20680 bounces generated locally. If a message is forwarded to another host, &'its'&
20681 bounce may well quote the generated address.
20682
20683
20684 .option ignore_eacces redirect boolean false
20685 .cindex "EACCES"
20686 If this option is set and an attempt to open a redirection file yields the
20687 EACCES error (permission denied), the &(redirect)& router behaves as if the
20688 file did not exist.
20689
20690
20691 .option ignore_enotdir redirect boolean false
20692 .cindex "ENOTDIR"
20693 If this option is set and an attempt to open a redirection file yields the
20694 ENOTDIR error (something on the path is not a directory), the &(redirect)&
20695 router behaves as if the file did not exist.
20696
20697 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
20698 router that has the &%file%& option set discovers that the file does not exist
20699 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
20700 against unmounted NFS directories. If the parent can not be statted, delivery
20701 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
20702 is set, because that option tells Exim to ignore &"something on the path is not
20703 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
20704 that some operating systems give ENOENT where others give ENOTDIR.
20705
20706
20707
20708 .option include_directory redirect string unset
20709 If this option is set, the path names of any &':include:'& items in a
20710 redirection list must start with this directory.
20711
20712
20713 .option modemask redirect "octal integer" 022
20714 This specifies mode bits which must not be set for a file specified by the
20715 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
20716
20717
20718 .option one_time redirect boolean false
20719 .cindex "one-time aliasing/forwarding expansion"
20720 .cindex "alias file" "one-time expansion"
20721 .cindex "forward file" "one-time expansion"
20722 .cindex "mailing lists" "one-time expansion"
20723 .cindex "address redirection" "one-time expansion"
20724 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
20725 files each time it tries to deliver a message causes a problem when one or more
20726 of the generated addresses fails be delivered at the first attempt. The problem
20727 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
20728 but of what happens when the redirection list changes during the time that the
20729 message is on Exim's queue. This is particularly true in the case of mailing
20730 lists, where new subscribers might receive copies of messages that were posted
20731 before they subscribed.
20732
20733 If &%one_time%& is set and any addresses generated by the router fail to
20734 deliver at the first attempt, the failing addresses are added to the message as
20735 &"top level"& addresses, and the parent address that generated them is marked
20736 &"delivered"&. Thus, redirection does not happen again at the next delivery
20737 attempt.
20738
20739 &*Warning 1*&: Any header line addition or removal that is specified by this
20740 router would be lost if delivery did not succeed at the first attempt. For this
20741 reason, the &%headers_add%& and &%headers_remove%& generic options are not
20742 permitted when &%one_time%& is set.
20743
20744 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
20745 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
20746 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
20747
20748 &*Warning 3*&: The &%unseen%& generic router option may not be set with
20749 &%one_time%&.
20750
20751 The original top-level address is remembered with each of the generated
20752 addresses, and is output in any log messages. However, any intermediate parent
20753 addresses are not recorded. This makes a difference to the log only if
20754 &%all_parents%& log selector is set. It is expected that &%one_time%& will
20755 typically be used for mailing lists, where there is normally just one level of
20756 expansion.
20757
20758
20759 .option owners redirect "string list" unset
20760 .cindex "ownership" "alias file"
20761 .cindex "ownership" "forward file"
20762 .cindex "alias file" "ownership"
20763 .cindex "forward file" "ownership"
20764 This specifies a list of permitted owners for the file specified by &%file%&.
20765 This list is in addition to the local user when &%check_local_user%& is set.
20766 See &%check_owner%& above.
20767
20768
20769 .option owngroups redirect "string list" unset
20770 This specifies a list of permitted groups for the file specified by &%file%&.
20771 The list is in addition to the local user's primary group when
20772 &%check_local_user%& is set. See &%check_group%& above.
20773
20774
20775 .option pipe_transport redirect string&!! unset
20776 .vindex "&$address_pipe$&"
20777 A &(redirect)& router sets up a direct delivery to a pipe when a string
20778 starting with a vertical bar character is specified as a new &"address"&. The
20779 transport used is specified by this option, which, after expansion, must be the
20780 name of a configured transport. This should normally be a &(pipe)& transport.
20781 When the transport is run, the pipe command is in &$address_pipe$&.
20782
20783
20784 .option qualify_domain redirect string&!! unset
20785 .vindex "&$qualify_recipient$&"
20786 If this option is set, and an unqualified address (one without a domain) is
20787 generated, and that address would normally be qualified by the global setting
20788 in &%qualify_recipient%&, it is instead qualified with the domain specified by
20789 expanding this string. If the expansion fails, the router declines. If you want
20790 to revert to the default, you can have the expansion generate
20791 &$qualify_recipient$&.
20792
20793 This option applies to all unqualified addresses generated by Exim filters,
20794 but for traditional &_.forward_& files, it applies only to addresses that are
20795 not preceded by a backslash. Sieve filters cannot generate unqualified
20796 addresses.
20797
20798 .option qualify_preserve_domain redirect boolean false
20799 .cindex "domain" "in redirection; preserving"
20800 .cindex "preserving domain in redirection"
20801 .cindex "address redirection" "domain; preserving"
20802 If this option is set, the router's local &%qualify_domain%& option must not be
20803 set (a configuration error occurs if it is). If an unqualified address (one
20804 without a domain) is generated, it is qualified with the domain of the parent
20805 address (the immediately preceding ancestor) instead of the global
20806 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
20807 this applies whether or not the address is preceded by a backslash.
20808
20809
20810 .option repeat_use redirect boolean true
20811 If this option is set false, the router is skipped for a child address that has
20812 any ancestor that was routed by this router. This test happens before any of
20813 the other preconditions are tested. Exim's default anti-looping rules skip
20814 only when the ancestor is the same as the current address. See also
20815 &%check_ancestor%& above and the generic &%redirect_router%& option.
20816
20817
20818 .option reply_transport redirect string&!! unset
20819 A &(redirect)& router sets up an automatic reply when a &%mail%& or
20820 &%vacation%& command is used in a filter file. The transport used is specified
20821 by this option, which, after expansion, must be the name of a configured
20822 transport. This should normally be an &(autoreply)& transport. Other transports
20823 are unlikely to do anything sensible or useful.
20824
20825
20826 .option rewrite redirect boolean true
20827 .cindex "address redirection" "disabling rewriting"
20828 If this option is set false, addresses generated by the router are not
20829 subject to address rewriting. Otherwise, they are treated like new addresses
20830 and are rewritten according to the global rewriting rules.
20831
20832
20833 .option sieve_subaddress redirect string&!! unset
20834 The value of this option is passed to a Sieve filter to specify the
20835 :subaddress part of an address.
20836
20837 .option sieve_useraddress redirect string&!! unset
20838 The value of this option is passed to a Sieve filter to specify the :user part
20839 of an address. However, if it is unset, the entire original local part
20840 (including any prefix or suffix) is used for :user.
20841
20842
20843 .option sieve_vacation_directory redirect string&!! unset
20844 .cindex "Sieve filter" "vacation directory"
20845 To enable the &"vacation"& extension for Sieve filters, you must set
20846 &%sieve_vacation_directory%& to the directory where vacation databases are held
20847 (do not put anything else in that directory), and ensure that the
20848 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
20849 needs their own directory; Exim will create it if necessary.
20850
20851
20852
20853 .option skip_syntax_errors redirect boolean false
20854 .cindex "forward file" "broken"
20855 .cindex "address redirection" "broken files"
20856 .cindex "alias file" "broken"
20857 .cindex "broken alias or forward files"
20858 .cindex "ignoring faulty addresses"
20859 .cindex "skipping faulty addresses"
20860 .cindex "error" "skipping bad syntax"
20861 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
20862 non-filter redirection data are skipped, and each failing address is logged. If
20863 &%syntax_errors_to%& is set, a message is sent to the address it defines,
20864 giving details of the failures. If &%syntax_errors_text%& is set, its contents
20865 are expanded and placed at the head of the error message generated by
20866 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
20867 be the same address as the generic &%errors_to%& option. The
20868 &%skip_syntax_errors%& option is often used when handling mailing lists.
20869
20870 If all the addresses in a redirection list are skipped because of syntax
20871 errors, the router declines to handle the original address, and it is passed to
20872 the following routers.
20873
20874 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
20875 error in the filter causes filtering to be abandoned without any action being
20876 taken. The incident is logged, and the router declines to handle the address,
20877 so it is passed to the following routers.
20878
20879 .cindex "Sieve filter" "syntax errors in"
20880 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
20881 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
20882 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
20883
20884 &%skip_syntax_errors%& can be used to specify that errors in users' forward
20885 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
20886 option, used with an address that does not get redirected, can be used to
20887 notify users of these errors, by means of a router like this:
20888 .code
20889 userforward:
20890   driver = redirect
20891   allow_filter
20892   check_local_user
20893   file = $home/.forward
20894   file_transport = address_file
20895   pipe_transport = address_pipe
20896   reply_transport = address_reply
20897   no_verify
20898   skip_syntax_errors
20899   syntax_errors_to = real-$local_part@$domain
20900   syntax_errors_text = \
20901    This is an automatically generated message. An error has\n\
20902    been found in your .forward file. Details of the error are\n\
20903    reported below. While this error persists, you will receive\n\
20904    a copy of this message for every message that is addressed\n\
20905    to you. If your .forward file is a filter file, or if it is\n\
20906    a non-filter file containing no valid forwarding addresses,\n\
20907    a copy of each incoming message will be put in your normal\n\
20908    mailbox. If a non-filter file contains at least one valid\n\
20909    forwarding address, forwarding to the valid addresses will\n\
20910    happen, and those will be the only deliveries that occur.
20911 .endd
20912 You also need a router to ensure that local addresses that are prefixed by
20913 &`real-`& are recognized, but not forwarded or filtered. For example, you could
20914 put this immediately before the &(userforward)& router:
20915 .code
20916 real_localuser:
20917   driver = accept
20918   check_local_user
20919   local_part_prefix = real-
20920   transport = local_delivery
20921 .endd
20922 For security, it would probably be a good idea to restrict the use of this
20923 router to locally-generated messages, using a condition such as this:
20924 .code
20925   condition = ${if match {$sender_host_address}\
20926                          {\N^(|127\.0\.0\.1)$\N}}
20927 .endd
20928
20929
20930 .option syntax_errors_text redirect string&!! unset
20931 See &%skip_syntax_errors%& above.
20932
20933
20934 .option syntax_errors_to redirect string unset
20935 See &%skip_syntax_errors%& above.
20936 .ecindex IIDredrou1
20937 .ecindex IIDredrou2
20938
20939
20940
20941
20942
20943
20944 . ////////////////////////////////////////////////////////////////////////////
20945 . ////////////////////////////////////////////////////////////////////////////
20946
20947 .chapter "Environment for running local transports" "CHAPenvironment" &&&
20948          "Environment for local transports"
20949 .scindex IIDenvlotra1 "local transports" "environment for"
20950 .scindex IIDenvlotra2 "environment" "local transports"
20951 .scindex IIDenvlotra3 "transport" "local; environment for"
20952 Local transports handle deliveries to files and pipes. (The &(autoreply)&
20953 transport can be thought of as similar to a pipe.) Exim always runs transports
20954 in subprocesses, under specified uids and gids. Typical deliveries to local
20955 mailboxes run under the uid and gid of the local user.
20956
20957 Exim also sets a specific current directory while running the transport; for
20958 some transports a home directory setting is also relevant. The &(pipe)&
20959 transport is the only one that sets up environment variables; see section
20960 &<<SECTpipeenv>>& for details.
20961
20962 The values used for the uid, gid, and the directories may come from several
20963 different places. In many cases, the router that handles the address associates
20964 settings with that address as a result of its &%check_local_user%&, &%group%&,
20965 or &%user%& options. However, values may also be given in the transport's own
20966 configuration, and these override anything that comes from the router.
20967
20968
20969
20970 .section "Concurrent deliveries" "SECID131"
20971 .cindex "concurrent deliveries"
20972 .cindex "simultaneous deliveries"
20973 If two different messages for the same local recipient arrive more or less
20974 simultaneously, the two delivery processes are likely to run concurrently. When
20975 the &(appendfile)& transport is used to write to a file, Exim applies locking
20976 rules to stop concurrent processes from writing to the same file at the same
20977 time.
20978
20979 However, when you use a &(pipe)& transport, it is up to you to arrange any
20980 locking that is needed. Here is a silly example:
20981 .code
20982 my_transport:
20983   driver = pipe
20984   command = /bin/sh -c 'cat >>/some/file'
20985 .endd
20986 This is supposed to write the message at the end of the file. However, if two
20987 messages arrive at the same time, the file will be scrambled. You can use the
20988 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
20989 file using the same algorithm that Exim itself uses.
20990
20991
20992
20993
20994 .section "Uids and gids" "SECTenvuidgid"
20995 .cindex "local transports" "uid and gid"
20996 .cindex "transport" "local; uid and gid"
20997 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
20998 overrides any group that the router set in the address, even if &%user%& is not
20999 set for the transport. This makes it possible, for example, to run local mail
21000 delivery under the uid of the recipient (set by the router), but in a special
21001 group (set by the transport). For example:
21002 .code
21003 # Routers ...
21004 # User/group are set by check_local_user in this router
21005 local_users:
21006   driver = accept
21007   check_local_user
21008   transport = group_delivery
21009
21010 # Transports ...
21011 # This transport overrides the group
21012 group_delivery:
21013   driver = appendfile
21014   file = /var/spool/mail/$local_part
21015   group = mail
21016 .endd
21017 If &%user%& is set for a transport, its value overrides what is set in the
21018 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
21019 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
21020 set.
21021
21022 .oindex "&%initgroups%&"
21023 When the uid is taken from the transport's configuration, the &[initgroups()]&
21024 function is called for the groups associated with that uid if the
21025 &%initgroups%& option is set for the transport. When the uid is not specified
21026 by the transport, but is associated with the address by a router, the option
21027 for calling &[initgroups()]& is taken from the router configuration.
21028
21029 .cindex "&(pipe)& transport" "uid for"
21030 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
21031 is set and &%user%& is not set, the uid of the process that called Exim to
21032 receive the message is used, and if &%group%& is not set, the corresponding
21033 original gid is also used.
21034
21035 This is the detailed preference order for obtaining a gid; the first of the
21036 following that is set is used:
21037
21038 .ilist
21039 A &%group%& setting of the transport;
21040 .next
21041 A &%group%& setting of the router;
21042 .next
21043 A gid associated with a user setting of the router, either as a result of
21044 &%check_local_user%& or an explicit non-numeric &%user%& setting;
21045 .next
21046 The group associated with a non-numeric &%user%& setting of the transport;
21047 .next
21048 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
21049 the uid is the creator's uid;
21050 .next
21051 The Exim gid if the Exim uid is being used as a default.
21052 .endlist
21053
21054 If, for example, the user is specified numerically on the router and there are
21055 no group settings, no gid is available. In this situation, an error occurs.
21056 This is different for the uid, for which there always is an ultimate default.
21057 The first of the following that is set is used:
21058
21059 .ilist
21060 A &%user%& setting of the transport;
21061 .next
21062 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
21063 .next
21064 A &%user%& setting of the router;
21065 .next
21066 A &%check_local_user%& setting of the router;
21067 .next
21068 The Exim uid.
21069 .endlist
21070
21071 Of course, an error will still occur if the uid that is chosen is on the
21072 &%never_users%& list.
21073
21074
21075
21076
21077
21078 .section "Current and home directories" "SECID132"
21079 .cindex "current directory for local transport"
21080 .cindex "home directory" "for local transport"
21081 .cindex "transport" "local; home directory for"
21082 .cindex "transport" "local; current directory for"
21083 Routers may set current and home directories for local transports by means of
21084 the &%transport_current_directory%& and &%transport_home_directory%& options.
21085 However, if the transport's &%current_directory%& or &%home_directory%& options
21086 are set, they override the router's values. In detail, the home directory
21087 for a local transport is taken from the first of these values that is set:
21088
21089 .ilist
21090 The &%home_directory%& option on the transport;
21091 .next
21092 The &%transport_home_directory%& option on the router;
21093 .next
21094 The password data if &%check_local_user%& is set on the router;
21095 .next
21096 The &%router_home_directory%& option on the router.
21097 .endlist
21098
21099 The current directory is taken from the first of these values that is set:
21100
21101 .ilist
21102 The &%current_directory%& option on the transport;
21103 .next
21104 The &%transport_current_directory%& option on the router.
21105 .endlist
21106
21107
21108 If neither the router nor the transport sets a current directory, Exim uses the
21109 value of the home directory, if it is set. Otherwise it sets the current
21110 directory to &_/_& before running a local transport.
21111
21112
21113
21114 .section "Expansion variables derived from the address" "SECID133"
21115 .vindex "&$domain$&"
21116 .vindex "&$local_part$&"
21117 .vindex "&$original_domain$&"
21118 Normally a local delivery is handling a single address, and in that case the
21119 variables such as &$domain$& and &$local_part$& are set during local
21120 deliveries. However, in some circumstances more than one address may be handled
21121 at once (for example, while writing batch SMTP for onward transmission by some
21122 other means). In this case, the variables associated with the local part are
21123 never set, &$domain$& is set only if all the addresses have the same domain,
21124 and &$original_domain$& is never set.
21125 .ecindex IIDenvlotra1
21126 .ecindex IIDenvlotra2
21127 .ecindex IIDenvlotra3
21128
21129
21130
21131
21132
21133
21134
21135 . ////////////////////////////////////////////////////////////////////////////
21136 . ////////////////////////////////////////////////////////////////////////////
21137
21138 .chapter "Generic options for transports" "CHAPtransportgeneric"
21139 .scindex IIDgenoptra1 "generic options" "transport"
21140 .scindex IIDgenoptra2 "options" "generic; for transports"
21141 .scindex IIDgenoptra3 "transport" "generic options for"
21142 The following generic options apply to all transports:
21143
21144
21145 .option body_only transports boolean false
21146 .cindex "transport" "body only"
21147 .cindex "message" "transporting body only"
21148 .cindex "body of message" "transporting"
21149 If this option is set, the message's headers are not transported. It is
21150 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
21151 or &(pipe)& transports, the settings of &%message_prefix%& and
21152 &%message_suffix%& should be checked, because this option does not
21153 automatically suppress them.
21154
21155
21156 .option current_directory transports string&!! unset
21157 .cindex "transport" "current directory for"
21158 This specifies the current directory that is to be set while running the
21159 transport, overriding any value that may have been set by the router.
21160 If the expansion fails for any reason, including forced failure, an error is
21161 logged, and delivery is deferred.
21162
21163
21164 .option disable_logging transports boolean false
21165 If this option is set true, nothing is logged for any
21166 deliveries by the transport or for any
21167 transport errors. You should not set this option unless you really, really know
21168 what you are doing.
21169
21170
21171 .option debug_print transports string&!! unset
21172 .cindex "testing" "variables in drivers"
21173 If this option is set and debugging is enabled (see the &%-d%& command line
21174 option), the string is expanded and included in the debugging output when the
21175 transport is run.
21176 If expansion of the string fails, the error message is written to the debugging
21177 output, and Exim carries on processing.
21178 This facility is provided to help with checking out the values of variables and
21179 so on when debugging driver configurations. For example, if a &%headers_add%&
21180 option is not working properly, &%debug_print%& could be used to output the
21181 variables it references. A newline is added to the text if it does not end with
21182 one.
21183 The variables &$transport_name$& and &$router_name$& contain the name of the
21184 transport and the router that called it.
21185
21186 .option delivery_date_add transports boolean false
21187 .cindex "&'Delivery-date:'& header line"
21188 If this option is true, a &'Delivery-date:'& header is added to the message.
21189 This gives the actual time the delivery was made. As this is not a standard
21190 header, Exim has a configuration option (&%delivery_date_remove%&) which
21191 requests its removal from incoming messages, so that delivered messages can
21192 safely be resent to other recipients.
21193
21194
21195 .option driver transports string unset
21196 This specifies which of the available transport drivers is to be used.
21197 There is no default, and this option must be set for every transport.
21198
21199
21200 .option envelope_to_add transports boolean false
21201 .cindex "&'Envelope-to:'& header line"
21202 If this option is true, an &'Envelope-to:'& header is added to the message.
21203 This gives the original address(es) in the incoming envelope that caused this
21204 delivery to happen. More than one address may be present if the transport is
21205 configured to handle several addresses at once, or if more than one original
21206 address was redirected to the same final address. As this is not a standard
21207 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
21208 its removal from incoming messages, so that delivered messages can safely be
21209 resent to other recipients.
21210
21211
21212 .option event_action transports string&!! unset
21213 .cindex events
21214 This option declares a string to be expanded for Exim's events mechanism.
21215 For details see chapter &<<CHAPevents>>&.
21216
21217
21218 .option group transports string&!! "Exim group"
21219 .cindex "transport" "group; specifying"
21220 This option specifies a gid for running the transport process, overriding any
21221 value that the router supplies, and also overriding any value associated with
21222 &%user%& (see below).
21223
21224
21225 .option headers_add transports list&!! unset
21226 .cindex "header lines" "adding in transport"
21227 .cindex "transport" "header lines; adding"
21228 This option specifies a list of text headers,
21229 newline-separated (by default, changeable in the usual way),
21230 which are (separately) expanded and added to the header
21231 portion of a message as it is transported, as described in section
21232 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
21233 routers. If the result of the expansion is an empty string, or if the expansion
21234 is forced to fail, no action is taken. Other expansion failures are treated as
21235 errors and cause the delivery to be deferred.
21236
21237 Unlike most options, &%headers_add%& can be specified multiple times
21238 for a transport; all listed headers are added.
21239
21240
21241 .option headers_only transports boolean false
21242 .cindex "transport" "header lines only"
21243 .cindex "message" "transporting headers only"
21244 .cindex "header lines" "transporting"
21245 If this option is set, the message's body is not transported. It is mutually
21246 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
21247 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
21248 checked, since this option does not automatically suppress them.
21249
21250
21251 .option headers_remove transports list&!! unset
21252 .cindex "header lines" "removing"
21253 .cindex "transport" "header lines; removing"
21254 This option specifies a list of header names,
21255 colon-separated (by default, changeable in the usual way);
21256 these headers are omitted from the message as it is transported, as described
21257 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
21258 routers.
21259 Each list item is separately expanded.
21260 If the result of the expansion is an empty string, or if the expansion
21261 is forced to fail, no action is taken. Other expansion failures are treated as
21262 errors and cause the delivery to be deferred.
21263
21264 Unlike most options, &%headers_remove%& can be specified multiple times
21265 for a transport; all listed headers are removed.
21266
21267 &*Warning*&: Because of the separate expansion of the list items,
21268 items that contain a list separator must have it doubled.
21269 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
21270
21271
21272
21273 .option headers_rewrite transports string unset
21274 .cindex "transport" "header lines; rewriting"
21275 .cindex "rewriting" "at transport time"
21276 This option allows addresses in header lines to be rewritten at transport time,
21277 that is, as the message is being copied to its destination. The contents of the
21278 option are a colon-separated list of rewriting rules. Each rule is in exactly
21279 the same form as one of the general rewriting rules that are applied when a
21280 message is received. These are described in chapter &<<CHAPrewrite>>&. For
21281 example,
21282 .code
21283 headers_rewrite = a@b c@d f : \
21284                   x@y w@z
21285 .endd
21286 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
21287 &'w@z'& in all address-bearing header lines. The rules are applied to the
21288 header lines just before they are written out at transport time, so they affect
21289 only those copies of the message that pass through the transport. However, only
21290 the message's original header lines, and any that were added by a system
21291 filter, are rewritten. If a router or transport adds header lines, they are not
21292 affected by this option. These rewriting rules are &'not'& applied to the
21293 envelope. You can change the return path using &%return_path%&, but you cannot
21294 change envelope recipients at this time.
21295
21296
21297 .option home_directory transports string&!! unset
21298 .cindex "transport" "home directory for"
21299 .vindex "&$home$&"
21300 This option specifies a home directory setting for a local transport,
21301 overriding any value that may be set by the router. The home directory is
21302 placed in &$home$& while expanding the transport's private options. It is also
21303 used as the current directory if no current directory is set by the
21304 &%current_directory%& option on the transport or the
21305 &%transport_current_directory%& option on the router. If the expansion fails
21306 for any reason, including forced failure, an error is logged, and delivery is
21307 deferred.
21308
21309
21310 .option initgroups transports boolean false
21311 .cindex "additional groups"
21312 .cindex "groups" "additional"
21313 .cindex "transport" "group; additional"
21314 If this option is true and the uid for the delivery process is provided by the
21315 transport, the &[initgroups()]& function is called when running the transport
21316 to ensure that any additional groups associated with the uid are set up.
21317
21318
21319 .option max_parallel transports integer&!! unset
21320 .cindex limit "transport parallelism"
21321 .cindex transport "parallel processes"
21322 .cindex transport "concurrency limit"
21323 .cindex "delivery" "parallelism for transport"
21324 If this option is set and expands to an integer greater than zero
21325 it limits the number of concurrent runs of the transport.
21326 The control does not apply to shadow transports.
21327
21328 .cindex "hints database" "transport concurrency control"
21329 Exim implements this control by means of a hints database in which a record is
21330 incremented whenever a transport process is being created. The record
21331 is decremented and possibly removed when the process terminates.
21332 Obviously there is scope for
21333 records to get left lying around if there is a system or program crash. To
21334 guard against this, Exim ignores any records that are more than six hours old.
21335
21336 If you use this option, you should also arrange to delete the
21337 relevant hints database whenever your system reboots. The names of the files
21338 start with &_misc_& and they are kept in the &_spool/db_& directory. There
21339 may be one or two files, depending on the type of DBM in use. The same files
21340 are used for ETRN and smtp transport serialization.
21341
21342
21343 .option message_size_limit transports string&!! 0
21344 .cindex "limit" "message size per transport"
21345 .cindex "size" "of message, limit"
21346 .cindex "transport" "message size; limiting"
21347 This option controls the size of messages passed through the transport. It is
21348 expanded before use; the result of the expansion must be a sequence of decimal
21349 digits, optionally followed by K or M. If the expansion fails for any reason,
21350 including forced failure, or if the result is not of the required form,
21351 delivery is deferred. If the value is greater than zero and the size of a
21352 message exceeds this limit, the address is failed. If there is any chance that
21353 the resulting bounce message could be routed to the same transport, you should
21354 ensure that &%return_size_limit%& is less than the transport's
21355 &%message_size_limit%&, as otherwise the bounce message will fail to get
21356 delivered.
21357
21358
21359
21360 .option rcpt_include_affixes transports boolean false
21361 .cindex "prefix" "for local part, including in envelope"
21362 .cindex "suffix for local part" "including in envelope"
21363 .cindex "local part" "prefix"
21364 .cindex "local part" "suffix"
21365 When this option is false (the default), and an address that has had any
21366 affixes (prefixes or suffixes) removed from the local part is delivered by any
21367 form of SMTP or LMTP, the affixes are not included. For example, if a router
21368 that contains
21369 .code
21370 local_part_prefix = *-
21371 .endd
21372 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
21373 is delivered with
21374 .code
21375 RCPT TO:<xyz@some.domain>
21376 .endd
21377 This is also the case when an ACL-time callout is being used to verify a
21378 recipient address. However, if &%rcpt_include_affixes%& is set true, the
21379 whole local part is included in the RCPT command. This option applies to BSMTP
21380 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
21381 &(lmtp)& and &(smtp)& transports.
21382
21383
21384 .option retry_use_local_part transports boolean "see below"
21385 .cindex "hints database" "retry keys"
21386 When a delivery suffers a temporary failure, a retry record is created
21387 in Exim's hints database. For remote deliveries, the key for the retry record
21388 is based on the name and/or IP address of the failing remote host. For local
21389 deliveries, the key is normally the entire address, including both the local
21390 part and the domain. This is suitable for most common cases of local delivery
21391 temporary failure &-- for example, exceeding a mailbox quota should delay only
21392 deliveries to that mailbox, not to the whole domain.
21393
21394 However, in some special cases you may want to treat a temporary local delivery
21395 as a failure associated with the domain, and not with a particular local part.
21396 (For example, if you are storing all mail for some domain in files.) You can do
21397 this by setting &%retry_use_local_part%& false.
21398
21399 For all the local transports, its default value is true. For remote transports,
21400 the default value is false for tidiness, but changing the value has no effect
21401 on a remote transport in the current implementation.
21402
21403
21404 .option return_path transports string&!! unset
21405 .cindex "envelope sender"
21406 .cindex "transport" "return path; changing"
21407 .cindex "return path" "changing in transport"
21408 If this option is set, the string is expanded at transport time and replaces
21409 the existing return path (envelope sender) value in the copy of the message
21410 that is being delivered. An empty return path is permitted. This feature is
21411 designed for remote deliveries, where the value of this option is used in the
21412 SMTP MAIL command. If you set &%return_path%& for a local transport, the
21413 only effect is to change the address that is placed in the &'Return-path:'&
21414 header line, if one is added to the message (see the next option).
21415
21416 &*Note:*& A changed return path is not logged unless you add
21417 &%return_path_on_delivery%& to the log selector.
21418
21419 .vindex "&$return_path$&"
21420 The expansion can refer to the existing value via &$return_path$&. This is
21421 either the message's envelope sender, or an address set by the
21422 &%errors_to%& option on a router. If the expansion is forced to fail, no
21423 replacement occurs; if it fails for another reason, delivery is deferred. This
21424 option can be used to support VERP (Variable Envelope Return Paths) &-- see
21425 section &<<SECTverp>>&.
21426
21427 &*Note*&: If a delivery error is detected locally, including the case when a
21428 remote server rejects a message at SMTP time, the bounce message is not sent to
21429 the value of this option. It is sent to the previously set errors address.
21430 This defaults to the incoming sender address, but can be changed by setting
21431 &%errors_to%& in a router.
21432
21433
21434
21435 .option return_path_add transports boolean false
21436 .cindex "&'Return-path:'& header line"
21437 If this option is true, a &'Return-path:'& header is added to the message.
21438 Although the return path is normally available in the prefix line of BSD
21439 mailboxes, this is commonly not displayed by MUAs, and so the user does not
21440 have easy access to it.
21441
21442 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
21443 the delivery SMTP server makes the final delivery"&. This implies that this
21444 header should not be present in incoming messages. Exim has a configuration
21445 option, &%return_path_remove%&, which requests removal of this header from
21446 incoming messages, so that delivered messages can safely be resent to other
21447 recipients.
21448
21449
21450 .option shadow_condition transports string&!! unset
21451 See &%shadow_transport%& below.
21452
21453
21454 .option shadow_transport transports string unset
21455 .cindex "shadow transport"
21456 .cindex "transport" "shadow"
21457 A local transport may set the &%shadow_transport%& option to the name of
21458 another local transport. Shadow remote transports are not supported.
21459
21460 Whenever a delivery to the main transport succeeds, and either
21461 &%shadow_condition%& is unset, or its expansion does not result in the empty
21462 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
21463 passed to the shadow transport, with the same delivery address or addresses. If
21464 expansion fails, no action is taken except that non-forced expansion failures
21465 cause a log line to be written.
21466
21467 The result of the shadow transport is discarded and does not affect the
21468 subsequent processing of the message. Only a single level of shadowing is
21469 provided; the &%shadow_transport%& option is ignored on any transport when it
21470 is running as a shadow. Options concerned with output from pipes are also
21471 ignored. The log line for the successful delivery has an item added on the end,
21472 of the form
21473 .code
21474 ST=<shadow transport name>
21475 .endd
21476 If the shadow transport did not succeed, the error message is put in
21477 parentheses afterwards. Shadow transports can be used for a number of different
21478 purposes, including keeping more detailed log information than Exim normally
21479 provides, and implementing automatic acknowledgment policies based on message
21480 headers that some sites insist on.
21481
21482
21483 .option transport_filter transports string&!! unset
21484 .cindex "transport" "filter"
21485 .cindex "filter" "transport filter"
21486 This option sets up a filtering (in the Unix shell sense) process for messages
21487 at transport time. It should not be confused with mail filtering as set up by
21488 individual users or via a system filter.
21489 If unset, or expanding to an empty string, no filtering is done.
21490
21491 When the message is about to be written out, the command specified by
21492 &%transport_filter%& is started up in a separate, parallel process, and
21493 the entire message, including the header lines, is passed to it on its standard
21494 input (this in fact is done from a third process, to avoid deadlock). The
21495 command must be specified as an absolute path.
21496
21497 The lines of the message that are written to the transport filter are
21498 terminated by newline (&"\n"&). The message is passed to the filter before any
21499 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
21500 lines beginning with a dot, and also before any processing implied by the
21501 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
21502 &(pipe)& transports.
21503
21504 The standard error for the filter process is set to the same destination as its
21505 standard output; this is read and written to the message's ultimate
21506 destination. The process that writes the message to the filter, the
21507 filter itself, and the original process that reads the result and delivers it
21508 are all run in parallel, like a shell pipeline.
21509
21510 The filter can perform any transformations it likes, but of course should take
21511 care not to break RFC 2822 syntax. Exim does not check the result, except to
21512 test for a final newline when SMTP is in use. All messages transmitted over
21513 SMTP must end with a newline, so Exim supplies one if it is missing.
21514
21515 .cindex "content scanning" "per user"
21516 A transport filter can be used to provide content-scanning on a per-user basis
21517 at delivery time if the only required effect of the scan is to modify the
21518 message. For example, a content scan could insert a new header line containing
21519 a spam score. This could be interpreted by a filter in the user's MUA. It is
21520 not possible to discard a message at this stage.
21521
21522 .cindex "SMTP" "SIZE"
21523 A problem might arise if the filter increases the size of a message that is
21524 being sent down an SMTP connection. If the receiving SMTP server has indicated
21525 support for the SIZE parameter, Exim will have sent the size of the message
21526 at the start of the SMTP session. If what is actually sent is substantially
21527 more, the server might reject the message. This can be worked round by setting
21528 the &%size_addition%& option on the &(smtp)& transport, either to allow for
21529 additions to the message, or to disable the use of SIZE altogether.
21530
21531 .vindex "&$pipe_addresses$&"
21532 The value of the &%transport_filter%& option is the command string for starting
21533 the filter, which is run directly from Exim, not under a shell. The string is
21534 parsed by Exim in the same way as a command string for the &(pipe)& transport:
21535 Exim breaks it up into arguments and then expands each argument separately (see
21536 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
21537 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
21538 of arguments, one for each address that applies to this delivery. (This isn't
21539 an ideal name for this feature here, but as it was already implemented for the
21540 &(pipe)& transport, it seemed sensible not to change it.)
21541
21542 .vindex "&$host$&"
21543 .vindex "&$host_address$&"
21544 The expansion variables &$host$& and &$host_address$& are available when the
21545 transport is a remote one. They contain the name and IP address of the host to
21546 which the message is being sent. For example:
21547 .code
21548 transport_filter = /some/directory/transport-filter.pl \
21549   $host $host_address $sender_address $pipe_addresses
21550 .endd
21551
21552 Two problems arise if you want to use more complicated expansion items to
21553 generate transport filter commands, both of which due to the fact that the
21554 command is split up &'before'& expansion.
21555 .ilist
21556 If an expansion item contains white space, you must quote it, so that it is all
21557 part of the same command item. If the entire option setting is one such
21558 expansion item, you have to take care what kind of quoting you use. For
21559 example:
21560 .code
21561 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
21562 .endd
21563 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
21564 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
21565 stripped by Exim when it read the option's value. When the value is used, if
21566 the single quotes were missing, the line would be split into two items,
21567 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
21568 Exim tried to expand the first one.
21569 .next
21570 Except for the special case of &$pipe_addresses$& that is mentioned above, an
21571 expansion cannot generate multiple arguments, or a command name followed by
21572 arguments. Consider this example:
21573 .code
21574 transport_filter = ${lookup{$host}lsearch{/a/file}\
21575                     {$value}{/bin/cat}}
21576 .endd
21577 The result of the lookup is interpreted as the name of the command, even
21578 if it contains white space. The simplest way round this is to use a shell:
21579 .code
21580 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
21581                                {$value}{/bin/cat}}
21582 .endd
21583 .endlist
21584
21585 The filter process is run under the same uid and gid as the normal delivery.
21586 For remote deliveries this is the Exim uid/gid by default. The command should
21587 normally yield a zero return code. Transport filters are not supposed to fail.
21588 A non-zero code is taken to mean that the transport filter encountered some
21589 serious problem. Delivery of the message is deferred; the message remains on
21590 the queue and is tried again later. It is not possible to cause a message to be
21591 bounced from a transport filter.
21592
21593 If a transport filter is set on an autoreply transport, the original message is
21594 passed through the filter as it is being copied into the newly generated
21595 message, which happens if the &%return_message%& option is set.
21596
21597
21598 .option transport_filter_timeout transports time 5m
21599 .cindex "transport" "filter, timeout"
21600 When Exim is reading the output of a transport filter, it applies a timeout
21601 that can be set by this option. Exceeding the timeout is normally treated as a
21602 temporary delivery failure. However, if a transport filter is used with a
21603 &(pipe)& transport, a timeout in the transport filter is treated in the same
21604 way as a timeout in the pipe command itself. By default, a timeout is a hard
21605 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
21606 becomes a temporary error.
21607
21608
21609 .option user transports string&!! "Exim user"
21610 .cindex "uid (user id)" "local delivery"
21611 .cindex "transport" "user, specifying"
21612 This option specifies the user under whose uid the delivery process is to be
21613 run, overriding any uid that may have been set by the router. If the user is
21614 given as a name, the uid is looked up from the password data, and the
21615 associated group is taken as the value of the gid to be used if the &%group%&
21616 option is not set.
21617
21618 For deliveries that use local transports, a user and group are normally
21619 specified explicitly or implicitly (for example, as a result of
21620 &%check_local_user%&) by the router or transport.
21621
21622 .cindex "hints database" "access by remote transport"
21623 For remote transports, you should leave this option unset unless you really are
21624 sure you know what you are doing. When a remote transport is running, it needs
21625 to be able to access Exim's hints databases, because each host may have its own
21626 retry data.
21627 .ecindex IIDgenoptra1
21628 .ecindex IIDgenoptra2
21629 .ecindex IIDgenoptra3
21630
21631
21632
21633
21634
21635
21636 . ////////////////////////////////////////////////////////////////////////////
21637 . ////////////////////////////////////////////////////////////////////////////
21638
21639 .chapter "Address batching in local transports" "CHAPbatching" &&&
21640          "Address batching"
21641 .cindex "transport" "local; address batching in"
21642 The only remote transport (&(smtp)&) is normally configured to handle more than
21643 one address at a time, so that when several addresses are routed to the same
21644 remote host, just one copy of the message is sent. Local transports, however,
21645 normally handle one address at a time. That is, a separate instance of the
21646 transport is run for each address that is routed to the transport. A separate
21647 copy of the message is delivered each time.
21648
21649 .cindex "batched local delivery"
21650 .oindex "&%batch_max%&"
21651 .oindex "&%batch_id%&"
21652 In special cases, it may be desirable to handle several addresses at once in a
21653 local transport, for example:
21654
21655 .ilist
21656 In an &(appendfile)& transport, when storing messages in files for later
21657 delivery by some other means, a single copy of the message with multiple
21658 recipients saves space.
21659 .next
21660 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
21661 a single copy saves time, and is the normal way LMTP is expected to work.
21662 .next
21663 In a &(pipe)& transport, when passing the message
21664 to a scanner program or
21665 to some other delivery mechanism such as UUCP, multiple recipients may be
21666 acceptable.
21667 .endlist
21668
21669 These three local transports all have the same options for controlling multiple
21670 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
21671 repeating the information for each transport, these options are described here.
21672
21673 The &%batch_max%& option specifies the maximum number of addresses that can be
21674 delivered together in a single run of the transport. Its default value is one
21675 (no batching). When more than one address is routed to a transport that has a
21676 &%batch_max%& value greater than one, the addresses are delivered in a batch
21677 (that is, in a single run of the transport with multiple recipients), subject
21678 to certain conditions:
21679
21680 .ilist
21681 .vindex "&$local_part$&"
21682 If any of the transport's options contain a reference to &$local_part$&, no
21683 batching is possible.
21684 .next
21685 .vindex "&$domain$&"
21686 If any of the transport's options contain a reference to &$domain$&, only
21687 addresses with the same domain are batched.
21688 .next
21689 .cindex "customizing" "batching condition"
21690 If &%batch_id%& is set, it is expanded for each address, and only those
21691 addresses with the same expanded value are batched. This allows you to specify
21692 customized batching conditions. Failure of the expansion for any reason,
21693 including forced failure, disables batching, but it does not stop the delivery
21694 from taking place.
21695 .next
21696 Batched addresses must also have the same errors address (where to send
21697 delivery errors), the same header additions and removals, the same user and
21698 group for the transport, and if a host list is present, the first host must
21699 be the same.
21700 .endlist
21701
21702 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
21703 both when the file or pipe command is specified in the transport, and when it
21704 is specified by a &(redirect)& router, but all the batched addresses must of
21705 course be routed to the same file or pipe command. These two transports have an
21706 option called &%use_bsmtp%&, which causes them to deliver the message in
21707 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
21708 &%check_string%& and &%escape_string%& options are forced to the values
21709 .code
21710 check_string = "."
21711 escape_string = ".."
21712 .endd
21713 when batched SMTP is in use. A full description of the batch SMTP mechanism is
21714 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
21715 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
21716
21717 .cindex "&'Envelope-to:'& header line"
21718 If the generic &%envelope_to_add%& option is set for a batching transport, the
21719 &'Envelope-to:'& header that is added to the message contains all the addresses
21720 that are being processed together. If you are using a batching &(appendfile)&
21721 transport without &%use_bsmtp%&, the only way to preserve the recipient
21722 addresses is to set the &%envelope_to_add%& option.
21723
21724 .cindex "&(pipe)& transport" "with multiple addresses"
21725 .vindex "&$pipe_addresses$&"
21726 If you are using a &(pipe)& transport without BSMTP, and setting the
21727 transport's &%command%& option, you can include &$pipe_addresses$& as part of
21728 the command. This is not a true variable; it is a bit of magic that causes each
21729 of the recipient addresses to be inserted into the command as a separate
21730 argument. This provides a way of accessing all the addresses that are being
21731 delivered in the batch. &*Note:*& This is not possible for pipe commands that
21732 are specified by a &(redirect)& router.
21733
21734
21735
21736
21737 . ////////////////////////////////////////////////////////////////////////////
21738 . ////////////////////////////////////////////////////////////////////////////
21739
21740 .chapter "The appendfile transport" "CHAPappendfile"
21741 .scindex IIDapptra1 "&(appendfile)& transport"
21742 .scindex IIDapptra2 "transports" "&(appendfile)&"
21743 .cindex "directory creation"
21744 .cindex "creating directories"
21745 The &(appendfile)& transport delivers a message by appending it to an existing
21746 file, or by creating an entirely new file in a specified directory. Single
21747 files to which messages are appended can be in the traditional Unix mailbox
21748 format, or optionally in the MBX format supported by the Pine MUA and
21749 University of Washington IMAP daemon, &'inter alia'&. When each message is
21750 being delivered as a separate file, &"maildir"& format can optionally be used
21751 to give added protection against failures that happen part-way through the
21752 delivery. A third form of separate-file delivery known as &"mailstore"& is also
21753 supported. For all file formats, Exim attempts to create as many levels of
21754 directory as necessary, provided that &%create_directory%& is set.
21755
21756 The code for the optional formats is not included in the Exim binary by
21757 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
21758 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
21759 included.
21760
21761 .cindex "quota" "system"
21762 Exim recognizes system quota errors, and generates an appropriate message. Exim
21763 also supports its own quota control within the transport, for use when the
21764 system facility is unavailable or cannot be used for some reason.
21765
21766 If there is an error while appending to a file (for example, quota exceeded or
21767 partition filled), Exim attempts to reset the file's length and last
21768 modification time back to what they were before. If there is an error while
21769 creating an entirely new file, the new file is removed.
21770
21771 Before appending to a file, a number of security checks are made, and the
21772 file is locked. A detailed description is given below, after the list of
21773 private options.
21774
21775 The &(appendfile)& transport is most commonly used for local deliveries to
21776 users' mailboxes. However, it can also be used as a pseudo-remote transport for
21777 putting messages into files for remote delivery by some means other than Exim.
21778 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
21779 option).
21780
21781
21782
21783 .section "The file and directory options" "SECTfildiropt"
21784 The &%file%& option specifies a single file, to which the message is appended;
21785 the &%directory%& option specifies a directory, in which a new file containing
21786 the message is created. Only one of these two options can be set, and for
21787 normal deliveries to mailboxes, one of them &'must'& be set.
21788
21789 .vindex "&$address_file$&"
21790 .vindex "&$local_part$&"
21791 However, &(appendfile)& is also used for delivering messages to files or
21792 directories whose names (or parts of names) are obtained from alias,
21793 forwarding, or filtering operations (for example, a &%save%& command in a
21794 user's Exim filter). When such a transport is running, &$local_part$& contains
21795 the local part that was aliased or forwarded, and &$address_file$& contains the
21796 name (or partial name) of the file or directory generated by the redirection
21797 operation. There are two cases:
21798
21799 .ilist
21800 If neither &%file%& nor &%directory%& is set, the redirection operation
21801 must specify an absolute path (one that begins with &`/`&). This is the most
21802 common case when users with local accounts use filtering to sort mail into
21803 different folders. See for example, the &(address_file)& transport in the
21804 default configuration. If the path ends with a slash, it is assumed to be the
21805 name of a directory. A delivery to a directory can also be forced by setting
21806 &%maildir_format%& or &%mailstore_format%&.
21807 .next
21808 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
21809 used to determine the file or directory name for the delivery. Normally, the
21810 contents of &$address_file$& are used in some way in the string expansion.
21811 .endlist
21812
21813
21814 .cindex "Sieve filter" "configuring &(appendfile)&"
21815 .cindex "Sieve filter" "relative mailbox path handling"
21816 As an example of the second case, consider an environment where users do not
21817 have home directories. They may be permitted to use Exim filter commands of the
21818 form:
21819 .code
21820 save folder23
21821 .endd
21822 or Sieve filter commands of the form:
21823 .code
21824 require "fileinto";
21825 fileinto "folder23";
21826 .endd
21827 In this situation, the expansion of &%file%& or &%directory%& in the transport
21828 must transform the relative path into an appropriate absolute file name. In the
21829 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
21830 is used as a result of a &"keep"& action in the filter. This example shows one
21831 way of handling this requirement:
21832 .code
21833 file = ${if eq{$address_file}{inbox} \
21834             {/var/mail/$local_part} \
21835             {${if eq{${substr_0_1:$address_file}}{/} \
21836                   {$address_file} \
21837                   {$home/mail/$address_file} \
21838             }} \
21839        }
21840 .endd
21841 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
21842 location, absolute paths are used without change, and other folders are in the
21843 &_mail_& directory within the home directory.
21844
21845 &*Note 1*&: While processing an Exim filter, a relative path such as
21846 &_folder23_& is turned into an absolute path if a home directory is known to
21847 the router. In particular, this is the case if &%check_local_user%& is set. If
21848 you want to prevent this happening at routing time, you can set
21849 &%router_home_directory%& empty. This forces the router to pass the relative
21850 path to the transport.
21851
21852 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
21853 the &%file%& or &%directory%& option is still used if it is set.
21854
21855
21856
21857
21858 .section "Private options for appendfile" "SECID134"
21859 .cindex "options" "&(appendfile)& transport"
21860
21861
21862
21863 .option allow_fifo appendfile boolean false
21864 .cindex "fifo (named pipe)"
21865 .cindex "named pipe (fifo)"
21866 .cindex "pipe" "named (fifo)"
21867 Setting this option permits delivery to named pipes (FIFOs) as well as to
21868 regular files. If no process is reading the named pipe at delivery time, the
21869 delivery is deferred.
21870
21871
21872 .option allow_symlink appendfile boolean false
21873 .cindex "symbolic link" "to mailbox"
21874 .cindex "mailbox" "symbolic link"
21875 By default, &(appendfile)& will not deliver if the path name for the file is
21876 that of a symbolic link. Setting this option relaxes that constraint, but there
21877 are security issues involved in the use of symbolic links. Be sure you know
21878 what you are doing if you set this. Details of exactly what this option affects
21879 are included in the discussion which follows this list of options.
21880
21881
21882 .option batch_id appendfile string&!! unset
21883 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21884 However, batching is automatically disabled for &(appendfile)& deliveries that
21885 happen as a result of forwarding or aliasing or other redirection directly to a
21886 file.
21887
21888
21889 .option batch_max appendfile integer 1
21890 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21891
21892
21893 .option check_group appendfile boolean false
21894 When this option is set, the group owner of the file defined by the &%file%&
21895 option is checked to see that it is the same as the group under which the
21896 delivery process is running. The default setting is false because the default
21897 file mode is 0600, which means that the group is irrelevant.
21898
21899
21900 .option check_owner appendfile boolean true
21901 When this option is set, the owner of the file defined by the &%file%& option
21902 is checked to ensure that it is the same as the user under which the delivery
21903 process is running.
21904
21905
21906 .option check_string appendfile string "see below"
21907 .cindex "&""From""& line"
21908 As &(appendfile)& writes the message, the start of each line is tested for
21909 matching &%check_string%&, and if it does, the initial matching characters are
21910 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
21911 a literal string, not a regular expression, and the case of any letters it
21912 contains is significant.
21913
21914 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
21915 are forced to &"."& and &".."& respectively, and any settings in the
21916 configuration are ignored. Otherwise, they default to &"From&~"& and
21917 &">From&~"& when the &%file%& option is set, and unset when any of the
21918 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
21919
21920 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
21921 suitable for traditional &"BSD"& mailboxes, where a line beginning with
21922 &"From&~"& indicates the start of a new message. All four options need changing
21923 if another format is used. For example, to deliver to mailboxes in MMDF format:
21924 .cindex "MMDF format mailbox"
21925 .cindex "mailbox" "MMDF format"
21926 .code
21927 check_string = "\1\1\1\1\n"
21928 escape_string = "\1\1\1\1 \n"
21929 message_prefix = "\1\1\1\1\n"
21930 message_suffix = "\1\1\1\1\n"
21931 .endd
21932 .option create_directory appendfile boolean true
21933 .cindex "directory creation"
21934 When this option is true, Exim attempts to create any missing superior
21935 directories for the file that it is about to write. A created directory's mode
21936 is given by the &%directory_mode%& option.
21937
21938 The group ownership of a newly created directory is highly dependent on the
21939 operating system (and possibly the file system) that is being used. For
21940 example, in Solaris, if the parent directory has the setgid bit set, its group
21941 is propagated to the child; if not, the currently set group is used. However,
21942 in FreeBSD, the parent's group is always used.
21943
21944
21945
21946 .option create_file appendfile string anywhere
21947 This option constrains the location of files and directories that are created
21948 by this transport. It applies to files defined by the &%file%& option and
21949 directories defined by the &%directory%& option. In the case of maildir
21950 delivery, it applies to the top level directory, not the maildir directories
21951 beneath.
21952
21953 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
21954 &"belowhome"&. In the second and third cases, a home directory must have been
21955 set for the transport. This option is not useful when an explicit file name is
21956 given for normal mailbox deliveries. It is intended for the case when file
21957 names are generated from users' &_.forward_& files. These are usually handled
21958 by an &(appendfile)& transport called &%address_file%&. See also
21959 &%file_must_exist%&.
21960
21961
21962 .option directory appendfile string&!! unset
21963 This option is mutually exclusive with the &%file%& option, but one of &%file%&
21964 or &%directory%& must be set, unless the delivery is the direct result of a
21965 redirection (see section &<<SECTfildiropt>>&).
21966
21967 When &%directory%& is set, the string is expanded, and the message is delivered
21968 into a new file or files in or below the given directory, instead of being
21969 appended to a single mailbox file. A number of different formats are provided
21970 (see &%maildir_format%& and &%mailstore_format%&), and see section
21971 &<<SECTopdir>>& for further details of this form of delivery.
21972
21973
21974 .option directory_file appendfile string&!! "see below"
21975 .cindex "base62"
21976 .vindex "&$inode$&"
21977 When &%directory%& is set, but neither &%maildir_format%& nor
21978 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
21979 whose name is obtained by expanding this string. The default value is:
21980 .code
21981 q${base62:$tod_epoch}-$inode
21982 .endd
21983 This generates a unique name from the current time, in base 62 form, and the
21984 inode of the file. The variable &$inode$& is available only when expanding this
21985 option.
21986
21987
21988 .option directory_mode appendfile "octal integer" 0700
21989 If &(appendfile)& creates any directories as a result of the
21990 &%create_directory%& option, their mode is specified by this option.
21991
21992
21993 .option escape_string appendfile string "see description"
21994 See &%check_string%& above.
21995
21996
21997 .option file appendfile string&!! unset
21998 This option is mutually exclusive with the &%directory%& option, but one of
21999 &%file%& or &%directory%& must be set, unless the delivery is the direct result
22000 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
22001 specifies a single file, to which the message is appended. One or more of
22002 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
22003 &%file%&.
22004
22005 .cindex "NFS" "lock file"
22006 .cindex "locking files"
22007 .cindex "lock files"
22008 If you are using more than one host to deliver over NFS into the same
22009 mailboxes, you should always use lock files.
22010
22011 The string value is expanded for each delivery, and must yield an absolute
22012 path. The most common settings of this option are variations on one of these
22013 examples:
22014 .code
22015 file = /var/spool/mail/$local_part
22016 file = /home/$local_part/inbox
22017 file = $home/inbox
22018 .endd
22019 .cindex "&""sticky""& bit"
22020 In the first example, all deliveries are done into the same directory. If Exim
22021 is configured to use lock files (see &%use_lockfile%& below) it must be able to
22022 create a file in the directory, so the &"sticky"& bit must be turned on for
22023 deliveries to be possible, or alternatively the &%group%& option can be used to
22024 run the delivery under a group id which has write access to the directory.
22025
22026
22027
22028 .option file_format appendfile string unset
22029 .cindex "file" "mailbox; checking existing format"
22030 This option requests the transport to check the format of an existing file
22031 before adding to it. The check consists of matching a specific string at the
22032 start of the file. The value of the option consists of an even number of
22033 colon-separated strings. The first of each pair is the test string, and the
22034 second is the name of a transport. If the transport associated with a matched
22035 string is not the current transport, control is passed over to the other
22036 transport. For example, suppose the standard &(local_delivery)& transport has
22037 this added to it:
22038 .code
22039 file_format = "From       : local_delivery :\
22040                \1\1\1\1\n : local_mmdf_delivery"
22041 .endd
22042 Mailboxes that begin with &"From"& are still handled by this transport, but if
22043 a mailbox begins with four binary ones followed by a newline, control is passed
22044 to a transport called &%local_mmdf_delivery%&, which presumably is configured
22045 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
22046 is assumed to match the current transport. If the start of a mailbox doesn't
22047 match any string, or if the transport named for a given string is not defined,
22048 delivery is deferred.
22049
22050
22051 .option file_must_exist appendfile boolean false
22052 If this option is true, the file specified by the &%file%& option must exist.
22053 A temporary error occurs if it does not, causing delivery to be deferred.
22054 If this option is false, the file is created if it does not exist.
22055
22056
22057 .option lock_fcntl_timeout appendfile time 0s
22058 .cindex "timeout" "mailbox locking"
22059 .cindex "mailbox" "locking, blocking and non-blocking"
22060 .cindex "locking files"
22061 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
22062 when locking an open mailbox file. If the call fails, the delivery process
22063 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
22064 Non-blocking calls are used so that the file is not kept open during the wait
22065 for the lock; the reason for this is to make it as safe as possible for
22066 deliveries over NFS in the case when processes might be accessing an NFS
22067 mailbox without using a lock file. This should not be done, but
22068 misunderstandings and hence misconfigurations are not unknown.
22069
22070 On a busy system, however, the performance of a non-blocking lock approach is
22071 not as good as using a blocking lock with a timeout. In this case, the waiting
22072 is done inside the system call, and Exim's delivery process acquires the lock
22073 and can proceed as soon as the previous lock holder releases it.
22074
22075 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
22076 timeout, are used. There may still be some retrying: the maximum number of
22077 retries is
22078 .code
22079 (lock_retries * lock_interval) / lock_fcntl_timeout
22080 .endd
22081 rounded up to the next whole number. In other words, the total time during
22082 which &(appendfile)& is trying to get a lock is roughly the same, unless
22083 &%lock_fcntl_timeout%& is set very large.
22084
22085 You should consider setting this option if you are getting a lot of delayed
22086 local deliveries because of errors of the form
22087 .code
22088 failed to lock mailbox /some/file (fcntl)
22089 .endd
22090
22091 .option lock_flock_timeout appendfile time 0s
22092 This timeout applies to file locking when using &[flock()]& (see
22093 &%use_flock%&); the timeout operates in a similar manner to
22094 &%lock_fcntl_timeout%&.
22095
22096
22097 .option lock_interval appendfile time 3s
22098 This specifies the time to wait between attempts to lock the file. See below
22099 for details of locking.
22100
22101
22102 .option lock_retries appendfile integer 10
22103 This specifies the maximum number of attempts to lock the file. A value of zero
22104 is treated as 1. See below for details of locking.
22105
22106
22107 .option lockfile_mode appendfile "octal integer" 0600
22108 This specifies the mode of the created lock file, when a lock file is being
22109 used (see &%use_lockfile%& and &%use_mbx_lock%&).
22110
22111
22112 .option lockfile_timeout appendfile time 30m
22113 .cindex "timeout" "mailbox locking"
22114 When a lock file is being used (see &%use_lockfile%&), if a lock file already
22115 exists and is older than this value, it is assumed to have been left behind by
22116 accident, and Exim attempts to remove it.
22117
22118
22119 .option mailbox_filecount appendfile string&!! unset
22120 .cindex "mailbox" "specifying size of"
22121 .cindex "size" "of mailbox"
22122 If this option is set, it is expanded, and the result is taken as the current
22123 number of files in the mailbox. It must be a decimal number, optionally
22124 followed by K or M. This provides a way of obtaining this information from an
22125 external source that maintains the data.
22126
22127
22128 .option mailbox_size appendfile string&!! unset
22129 .cindex "mailbox" "specifying size of"
22130 .cindex "size" "of mailbox"
22131 If this option is set, it is expanded, and the result is taken as the current
22132 size the mailbox. It must be a decimal number, optionally followed by K or M.
22133 This provides a way of obtaining this information from an external source that
22134 maintains the data. This is likely to be helpful for maildir deliveries where
22135 it is computationally expensive to compute the size of a mailbox.
22136
22137
22138
22139 .option maildir_format appendfile boolean false
22140 .cindex "maildir format" "specifying"
22141 If this option is set with the &%directory%& option, the delivery is into a new
22142 file, in the &"maildir"& format that is used by other mail software. When the
22143 transport is activated directly from a &(redirect)& router (for example, the
22144 &(address_file)& transport in the default configuration), setting
22145 &%maildir_format%& causes the path received from the router to be treated as a
22146 directory, whether or not it ends with &`/`&. This option is available only if
22147 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
22148 &<<SECTmaildirdelivery>>& below for further details.
22149
22150
22151 .option maildir_quota_directory_regex appendfile string "See below"
22152 .cindex "maildir format" "quota; directories included in"
22153 .cindex "quota" "maildir; directories included in"
22154 This option is relevant only when &%maildir_use_size_file%& is set. It defines
22155 a regular expression for specifying directories, relative to the quota
22156 directory (see &%quota_directory%&), that should be included in the quota
22157 calculation. The default value is:
22158 .code
22159 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
22160 .endd
22161 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
22162 (directories whose names begin with a dot). If you want to exclude the
22163 &_Trash_&
22164 folder from the count (as some sites do), you need to change this setting to
22165 .code
22166 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
22167 .endd
22168 This uses a negative lookahead in the regular expression to exclude the
22169 directory whose name is &_.Trash_&. When a directory is excluded from quota
22170 calculations, quota processing is bypassed for any messages that are delivered
22171 directly into that directory.
22172
22173
22174 .option maildir_retries appendfile integer 10
22175 This option specifies the number of times to retry when writing a file in
22176 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
22177
22178
22179 .option maildir_tag appendfile string&!! unset
22180 This option applies only to deliveries in maildir format, and is described in
22181 section &<<SECTmaildirdelivery>>& below.
22182
22183
22184 .option maildir_use_size_file appendfile&!! boolean false
22185 .cindex "maildir format" "&_maildirsize_& file"
22186 The result of string expansion for this option must be a valid boolean value.
22187 If it is true, it enables support for &_maildirsize_& files. Exim
22188 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
22189 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
22190 value is zero. See &%maildir_quota_directory_regex%& above and section
22191 &<<SECTmaildirdelivery>>& below for further details.
22192
22193 .option maildirfolder_create_regex appendfile string unset
22194 .cindex "maildir format" "&_maildirfolder_& file"
22195 .cindex "&_maildirfolder_&, creating"
22196 The value of this option is a regular expression. If it is unset, it has no
22197 effect. Otherwise, before a maildir delivery takes place, the pattern is
22198 matched against the name of the maildir directory, that is, the directory
22199 containing the &_new_& and &_tmp_& subdirectories that will be used for the
22200 delivery. If there is a match, Exim checks for the existence of a file called
22201 &_maildirfolder_& in the directory, and creates it if it does not exist.
22202 See section &<<SECTmaildirdelivery>>& for more details.
22203
22204
22205 .option mailstore_format appendfile boolean false
22206 .cindex "mailstore format" "specifying"
22207 If this option is set with the &%directory%& option, the delivery is into two
22208 new files in  &"mailstore"& format. The option is available only if
22209 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
22210 below for further details.
22211
22212
22213 .option mailstore_prefix appendfile string&!! unset
22214 This option applies only to deliveries in mailstore format, and is described in
22215 section &<<SECTopdir>>& below.
22216
22217
22218 .option mailstore_suffix appendfile string&!! unset
22219 This option applies only to deliveries in mailstore format, and is described in
22220 section &<<SECTopdir>>& below.
22221
22222
22223 .option mbx_format appendfile boolean false
22224 .cindex "locking files"
22225 .cindex "file" "locking"
22226 .cindex "file" "MBX format"
22227 .cindex "MBX format, specifying"
22228 This option is available only if Exim has been compiled with SUPPORT_MBX
22229 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
22230 the message is appended to the mailbox file in MBX format instead of
22231 traditional Unix format. This format is supported by Pine4 and its associated
22232 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
22233
22234 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
22235 automatically changed by the use of &%mbx_format%&. They should normally be set
22236 empty when using MBX format, so this option almost always appears in this
22237 combination:
22238 .code
22239 mbx_format = true
22240 message_prefix =
22241 message_suffix =
22242 .endd
22243 If none of the locking options are mentioned in the configuration,
22244 &%use_mbx_lock%& is assumed and the other locking options default to false. It
22245 is possible to specify the other kinds of locking with &%mbx_format%&, but
22246 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
22247 interworks with &'c-client'&, providing for shared access to the mailbox. It
22248 should not be used if any program that does not use this form of locking is
22249 going to access the mailbox, nor should it be used if the mailbox file is NFS
22250 mounted, because it works only when the mailbox is accessed from a single host.
22251
22252 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
22253 the standard version of &'c-client'&, because as long as it has a mailbox open
22254 (this means for the whole of a Pine or IMAP session), Exim will not be able to
22255 append messages to it.
22256
22257
22258 .option message_prefix appendfile string&!! "see below"
22259 .cindex "&""From""& line"
22260 The string specified here is expanded and output at the start of every message.
22261 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
22262 in which case it is:
22263 .code
22264 message_prefix = "From ${if def:return_path{$return_path}\
22265   {MAILER-DAEMON}} $tod_bsdinbox\n"
22266 .endd
22267 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22268 &`\n`& to &`\r\n`& in &%message_prefix%&.
22269
22270 .option message_suffix appendfile string&!! "see below"
22271 The string specified here is expanded and output at the end of every message.
22272 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
22273 in which case it is a single newline character. The suffix can be suppressed by
22274 setting
22275 .code
22276 message_suffix =
22277 .endd
22278 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22279 &`\n`& to &`\r\n`& in &%message_suffix%&.
22280
22281 .option mode appendfile "octal integer" 0600
22282 If the output file is created, it is given this mode. If it already exists and
22283 has wider permissions, they are reduced to this mode. If it has narrower
22284 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
22285 if the delivery is the result of a &%save%& command in a filter file specifying
22286 a particular mode, the mode of the output file is always forced to take that
22287 value, and this option is ignored.
22288
22289
22290 .option mode_fail_narrower appendfile boolean true
22291 This option applies in the case when an existing mailbox file has a narrower
22292 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
22293 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
22294 continues with the delivery attempt, using the existing mode of the file.
22295
22296
22297 .option notify_comsat appendfile boolean false
22298 If this option is true, the &'comsat'& daemon is notified after every
22299 successful delivery to a user mailbox. This is the daemon that notifies logged
22300 on users about incoming mail.
22301
22302
22303 .option quota appendfile string&!! unset
22304 .cindex "quota" "imposed by Exim"
22305 This option imposes a limit on the size of the file to which Exim is appending,
22306 or to the total space used in the directory tree when the &%directory%& option
22307 is set. In the latter case, computation of the space used is expensive, because
22308 all the files in the directory (and any sub-directories) have to be
22309 individually inspected and their sizes summed. (See &%quota_size_regex%& and
22310 &%maildir_use_size_file%& for ways to avoid this in environments where users
22311 have no shell access to their mailboxes).
22312
22313 As there is no interlock against two simultaneous deliveries into a
22314 multi-file mailbox, it is possible for the quota to be overrun in this case.
22315 For single-file mailboxes, of course, an interlock is a necessity.
22316
22317 A file's size is taken as its &'used'& value. Because of blocking effects, this
22318 may be a lot less than the actual amount of disk space allocated to the file.
22319 If the sizes of a number of files are being added up, the rounding effect can
22320 become quite noticeable, especially on systems that have large block sizes.
22321 Nevertheless, it seems best to stick to the &'used'& figure, because this is
22322 the obvious value which users understand most easily.
22323
22324 The value of the option is expanded, and must then be a numerical value
22325 (decimal point allowed), optionally followed by one of the letters K, M, or G,
22326 for kilobytes, megabytes, or gigabytes, optionally followed by a slash
22327 and further option modifiers. If Exim is running on a system with
22328 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
22329 be handled.
22330
22331 The option modifier &%no_check%& can be used to force delivery even if the over
22332 quota condition is met. The quota gets updated as usual.
22333
22334 &*Note*&: A value of zero is interpreted as &"no quota"&.
22335
22336 The expansion happens while Exim is running as root, before it changes uid for
22337 the delivery. This means that files that are inaccessible to the end user can
22338 be used to hold quota values that are looked up in the expansion. When delivery
22339 fails because this quota is exceeded, the handling of the error is as for
22340 system quota failures.
22341
22342 By default, Exim's quota checking mimics system quotas, and restricts the
22343 mailbox to the specified maximum size, though the value is not accurate to the
22344 last byte, owing to separator lines and additional headers that may get added
22345 during message delivery. When a mailbox is nearly full, large messages may get
22346 refused even though small ones are accepted, because the size of the current
22347 message is added to the quota when the check is made. This behaviour can be
22348 changed by setting &%quota_is_inclusive%& false. When this is done, the check
22349 for exceeding the quota does not include the current message. Thus, deliveries
22350 continue until the quota has been exceeded; thereafter, no further messages are
22351 delivered. See also &%quota_warn_threshold%&.
22352
22353
22354 .option quota_directory appendfile string&!! unset
22355 This option defines the directory to check for quota purposes when delivering
22356 into individual files. The default is the delivery directory, or, if a file
22357 called &_maildirfolder_& exists in a maildir directory, the parent of the
22358 delivery directory.
22359
22360
22361 .option quota_filecount appendfile string&!! 0
22362 This option applies when the &%directory%& option is set. It limits the total
22363 number of files in the directory (compare the inode limit in system quotas). It
22364 can only be used if &%quota%& is also set. The value is expanded; an expansion
22365 failure causes delivery to be deferred. A value of zero is interpreted as
22366 &"no quota"&.
22367
22368 The option modifier &%no_check%& can be used to force delivery even if the over
22369 quota condition is met. The quota gets updated as usual.
22370
22371 .option quota_is_inclusive appendfile boolean true
22372 See &%quota%& above.
22373
22374
22375 .option quota_size_regex appendfile string unset
22376 This option applies when one of the delivery modes that writes a separate file
22377 for each message is being used. When Exim wants to find the size of one of
22378 these files in order to test the quota, it first checks &%quota_size_regex%&.
22379 If this is set to a regular expression that matches the file name, and it
22380 captures one string, that string is interpreted as a representation of the
22381 file's size. The value of &%quota_size_regex%& is not expanded.
22382
22383 This feature is useful only when users have no shell access to their mailboxes
22384 &-- otherwise they could defeat the quota simply by renaming the files. This
22385 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
22386 the file length to the file name. For example:
22387 .code
22388 maildir_tag = ,S=$message_size
22389 quota_size_regex = ,S=(\d+)
22390 .endd
22391 An alternative to &$message_size$& is &$message_linecount$&, which contains the
22392 number of lines in the message.
22393
22394 The regular expression should not assume that the length is at the end of the
22395 file name (even though &%maildir_tag%& puts it there) because maildir MUAs
22396 sometimes add other information onto the ends of message file names.
22397
22398 Section &<<SECID136>>& contains further information.
22399
22400
22401 .option quota_warn_message appendfile string&!! "see below"
22402 See below for the use of this option. If it is not set when
22403 &%quota_warn_threshold%& is set, it defaults to
22404 .code
22405 quota_warn_message = "\
22406   To: $local_part@$domain\n\
22407   Subject: Your mailbox\n\n\
22408   This message is automatically created \
22409   by mail delivery software.\n\n\
22410   The size of your mailbox has exceeded \
22411   a warning threshold that is\n\
22412   set by the system administrator.\n"
22413 .endd
22414
22415
22416 .option quota_warn_threshold appendfile string&!! 0
22417 .cindex "quota" "warning threshold"
22418 .cindex "mailbox" "size warning"
22419 .cindex "size" "of mailbox"
22420 This option is expanded in the same way as &%quota%& (see above). If the
22421 resulting value is greater than zero, and delivery of the message causes the
22422 size of the file or total space in the directory tree to cross the given
22423 threshold, a warning message is sent. If &%quota%& is also set, the threshold
22424 may be specified as a percentage of it by following the value with a percent
22425 sign. For example:
22426 .code
22427 quota = 10M
22428 quota_warn_threshold = 75%
22429 .endd
22430 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
22431 percent sign is ignored.
22432
22433 The warning message itself is specified by the &%quota_warn_message%& option,
22434 and it must start with a &'To:'& header line containing the recipient(s) of the
22435 warning message. These do not necessarily have to include the recipient(s) of
22436 the original message. A &'Subject:'& line should also normally be supplied. You
22437 can include any other header lines that you want. If you do not include a
22438 &'From:'& line, the default is:
22439 .code
22440 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
22441 .endd
22442 .oindex &%errors_reply_to%&
22443 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
22444 option.
22445
22446 The &%quota%& option does not have to be set in order to use this option; they
22447 are independent of one another except when the threshold is specified as a
22448 percentage.
22449
22450
22451 .option use_bsmtp appendfile boolean false
22452 .cindex "envelope sender"
22453 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
22454 format, with the envelope sender and recipient(s) included as SMTP commands. If
22455 you want to include a leading HELO command with such messages, you can do
22456 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
22457 for details of batch SMTP.
22458
22459
22460 .option use_crlf appendfile boolean false
22461 .cindex "carriage return"
22462 .cindex "linefeed"
22463 This option causes lines to be terminated with the two-character CRLF sequence
22464 (carriage return, linefeed) instead of just a linefeed character. In the case
22465 of batched SMTP, the byte sequence written to the file is then an exact image
22466 of what would be sent down a real SMTP connection.
22467
22468 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
22469 (which are used to supply the traditional &"From&~"& and blank line separators
22470 in Berkeley-style mailboxes) are written verbatim, so must contain their own
22471 carriage return characters if these are needed. In cases where these options
22472 have non-empty defaults, the values end with a single linefeed, so they must be
22473 changed to end with &`\r\n`& if &%use_crlf%& is set.
22474
22475
22476 .option use_fcntl_lock appendfile boolean "see below"
22477 This option controls the use of the &[fcntl()]& function to lock a file for
22478 exclusive use when a message is being appended. It is set by default unless
22479 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
22480 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
22481 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
22482
22483
22484 .option use_flock_lock appendfile boolean false
22485 This option is provided to support the use of &[flock()]& for file locking, for
22486 the few situations where it is needed. Most modern operating systems support
22487 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
22488 each other. Exim uses &[fcntl()]& locking by default.
22489
22490 This option is required only if you are using an operating system where
22491 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
22492 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
22493 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
22494
22495 .cindex "Solaris" "&[flock()]& support"
22496 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
22497 have it (and some, I think, provide a not quite right version built on top of
22498 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
22499 the ability to use it, and any attempt to do so will cause a configuration
22500 error.
22501
22502 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
22503 is just being mapped onto &[fcntl()]& by the OS).
22504
22505
22506 .option use_lockfile appendfile boolean "see below"
22507 If this option is turned off, Exim does not attempt to create a lock file when
22508 appending to a mailbox file. In this situation, the only locking is by
22509 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
22510 sure that every MUA that is ever going to look at your users' mailboxes uses
22511 &[fcntl()]& rather than a lock file, and even then only when you are not
22512 delivering over NFS from more than one host.
22513
22514 .cindex "NFS" "lock file"
22515 In order to append to an NFS file safely from more than one host, it is
22516 necessary to take out a lock &'before'& opening the file, and the lock file
22517 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
22518 file corruption.
22519
22520 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
22521 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
22522 except when &%mbx_format%& is set.
22523
22524
22525 .option use_mbx_lock appendfile boolean "see below"
22526 This option is available only if Exim has been compiled with SUPPORT_MBX
22527 set in &_Local/Makefile_&. Setting the option specifies that special MBX
22528 locking rules be used. It is set by default if &%mbx_format%& is set and none
22529 of the locking options are mentioned in the configuration. The locking rules
22530 are the same as are used by the &'c-client'& library that underlies Pine and
22531 the IMAP4 and POP daemons that come with it (see the discussion below). The
22532 rules allow for shared access to the mailbox. However, this kind of locking
22533 does not work when the mailbox is NFS mounted.
22534
22535 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
22536 &%use_flock_lock%& to control what kind of locking is used in implementing the
22537 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
22538 without &%use_fcntl_lock%& or &%use_flock_lock%&.
22539
22540
22541
22542
22543 .section "Operational details for appending" "SECTopappend"
22544 .cindex "appending to a file"
22545 .cindex "file" "appending"
22546 Before appending to a file, the following preparations are made:
22547
22548 .ilist
22549 If the name of the file is &_/dev/null_&, no action is taken, and a success
22550 return is given.
22551
22552 .next
22553 .cindex "directory creation"
22554 If any directories on the file's path are missing, Exim creates them if the
22555 &%create_directory%& option is set. A created directory's mode is given by the
22556 &%directory_mode%& option.
22557
22558 .next
22559 If &%file_format%& is set, the format of an existing file is checked. If this
22560 indicates that a different transport should be used, control is passed to that
22561 transport.
22562
22563 .next
22564 .cindex "file" "locking"
22565 .cindex "locking files"
22566 .cindex "NFS" "lock file"
22567 If &%use_lockfile%& is set, a lock file is built in a way that will work
22568 reliably over NFS, as follows:
22569
22570 .olist
22571 Create a &"hitching post"& file whose name is that of the lock file with the
22572 current time, primary host name, and process id added, by opening for writing
22573 as a new file. If this fails with an access error, delivery is deferred.
22574 .next
22575 Close the hitching post file, and hard link it to the lock file name.
22576 .next
22577 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
22578 Unlink the hitching post name.
22579 .next
22580 Otherwise, use &[stat()]& to get information about the hitching post file, and
22581 then unlink hitching post name. If the number of links is exactly two, creation
22582 of the lock file succeeded but something (for example, an NFS server crash and
22583 restart) caused this fact not to be communicated to the &[link()]& call.
22584 .next
22585 If creation of the lock file failed, wait for &%lock_interval%& and try again,
22586 up to &%lock_retries%& times. However, since any program that writes to a
22587 mailbox should complete its task very quickly, it is reasonable to time out old
22588 lock files that are normally the result of user agent and system crashes. If an
22589 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
22590 it before trying again.
22591 .endlist olist
22592
22593 .next
22594 A call is made to &[lstat()]& to discover whether the main file exists, and if
22595 so, what its characteristics are. If &[lstat()]& fails for any reason other
22596 than non-existence, delivery is deferred.
22597
22598 .next
22599 .cindex "symbolic link" "to mailbox"
22600 .cindex "mailbox" "symbolic link"
22601 If the file does exist and is a symbolic link, delivery is deferred, unless the
22602 &%allow_symlink%& option is set, in which case the ownership of the link is
22603 checked, and then &[stat()]& is called to find out about the real file, which
22604 is then subjected to the checks below. The check on the top-level link
22605 ownership prevents one user creating a link for another's mailbox in a sticky
22606 directory, though allowing symbolic links in this case is definitely not a good
22607 idea. If there is a chain of symbolic links, the intermediate ones are not
22608 checked.
22609
22610 .next
22611 If the file already exists but is not a regular file, or if the file's owner
22612 and group (if the group is being checked &-- see &%check_group%& above) are
22613 different from the user and group under which the delivery is running,
22614 delivery is deferred.
22615
22616 .next
22617 If the file's permissions are more generous than specified, they are reduced.
22618 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
22619 is set false, in which case the delivery is tried using the existing
22620 permissions.
22621
22622 .next
22623 The file's inode number is saved, and the file is then opened for appending.
22624 If this fails because the file has vanished, &(appendfile)& behaves as if it
22625 hadn't existed (see below). For any other failures, delivery is deferred.
22626
22627 .next
22628 If the file is opened successfully, check that the inode number hasn't
22629 changed, that it is still a regular file, and that the owner and permissions
22630 have not changed. If anything is wrong, defer delivery and freeze the message.
22631
22632 .next
22633 If the file did not exist originally, defer delivery if the &%file_must_exist%&
22634 option is set. Otherwise, check that the file is being created in a permitted
22635 directory if the &%create_file%& option is set (deferring on failure), and then
22636 open for writing as a new file, with the O_EXCL and O_CREAT options,
22637 except when dealing with a symbolic link (the &%allow_symlink%& option must be
22638 set). In this case, which can happen if the link points to a non-existent file,
22639 the file is opened for writing using O_CREAT but not O_EXCL, because
22640 that prevents link following.
22641
22642 .next
22643 .cindex "loop" "while file testing"
22644 If opening fails because the file exists, obey the tests given above for
22645 existing files. However, to avoid looping in a situation where the file is
22646 being continuously created and destroyed, the exists/not-exists loop is broken
22647 after 10 repetitions, and the message is then frozen.
22648
22649 .next
22650 If opening fails with any other error, defer delivery.
22651
22652 .next
22653 .cindex "file" "locking"
22654 .cindex "locking files"
22655 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
22656 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
22657 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
22658 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
22659 file, and an exclusive lock on the file whose name is
22660 .code
22661 /tmp/.<device-number>.<inode-number>
22662 .endd
22663 using the device and inode numbers of the open mailbox file, in accordance with
22664 the MBX locking rules. This file is created with a mode that is specified by
22665 the &%lockfile_mode%& option.
22666
22667 If Exim fails to lock the file, there are two possible courses of action,
22668 depending on the value of the locking timeout. This is obtained from
22669 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
22670
22671 If the timeout value is zero, the file is closed, Exim waits for
22672 &%lock_interval%&, and then goes back and re-opens the file as above and tries
22673 to lock it again. This happens up to &%lock_retries%& times, after which the
22674 delivery is deferred.
22675
22676 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
22677 &[flock()]& are used (with the given timeout), so there has already been some
22678 waiting involved by the time locking fails. Nevertheless, Exim does not give up
22679 immediately. It retries up to
22680 .code
22681 (lock_retries * lock_interval) / <timeout>
22682 .endd
22683 times (rounded up).
22684 .endlist
22685
22686 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
22687 and/or &[flock()]& locks) and then deletes the lock file if one was created.
22688
22689
22690 .section "Operational details for delivery to a new file" "SECTopdir"
22691 .cindex "delivery" "to single file"
22692 .cindex "&""From""& line"
22693 When the &%directory%& option is set instead of &%file%&, each message is
22694 delivered into a newly-created file or set of files. When &(appendfile)& is
22695 activated directly from a &(redirect)& router, neither &%file%& nor
22696 &%directory%& is normally set, because the path for delivery is supplied by the
22697 router. (See for example, the &(address_file)& transport in the default
22698 configuration.) In this case, delivery is to a new file if either the path name
22699 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
22700
22701 No locking is required while writing the message to a new file, so the various
22702 locking options of the transport are ignored. The &"From"& line that by default
22703 separates messages in a single file is not normally needed, nor is the escaping
22704 of message lines that start with &"From"&, and there is no need to ensure a
22705 newline at the end of each message. Consequently, the default values for
22706 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
22707 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
22708
22709 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
22710 the files in the delivery directory by default. However, you can specify a
22711 different directory by setting &%quota_directory%&. Also, for maildir
22712 deliveries (see below) the &_maildirfolder_& convention is honoured.
22713
22714
22715 .cindex "maildir format"
22716 .cindex "mailstore format"
22717 There are three different ways in which delivery to individual files can be
22718 done, controlled by the settings of the &%maildir_format%& and
22719 &%mailstore_format%& options. Note that code to support maildir or mailstore
22720 formats is not included in the binary unless SUPPORT_MAILDIR or
22721 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
22722
22723 .cindex "directory creation"
22724 In all three cases an attempt is made to create the directory and any necessary
22725 sub-directories if they do not exist, provided that the &%create_directory%&
22726 option is set (the default). The location of a created directory can be
22727 constrained by setting &%create_file%&. A created directory's mode is given by
22728 the &%directory_mode%& option. If creation fails, or if the
22729 &%create_directory%& option is not set when creation is required, delivery is
22730 deferred.
22731
22732
22733
22734 .section "Maildir delivery" "SECTmaildirdelivery"
22735 .cindex "maildir format" "description of"
22736 If the &%maildir_format%& option is true, Exim delivers each message by writing
22737 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
22738 directory that is defined by the &%directory%& option (the &"delivery
22739 directory"&). If the delivery is successful, the file is renamed into the
22740 &_new_& subdirectory.
22741
22742 In the file name, <&'stime'&> is the current time of day in seconds, and
22743 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
22744 Exim checks that the time-of-day clock has moved on by at least one microsecond
22745 before terminating the delivery process. This guarantees uniqueness for the
22746 file name. However, as a precaution, Exim calls &[stat()]& for the file before
22747 opening it. If any response other than ENOENT (does not exist) is given,
22748 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
22749
22750 Before Exim carries out a maildir delivery, it ensures that subdirectories
22751 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
22752 do not exist, Exim tries to create them and any superior directories in their
22753 path, subject to the &%create_directory%& and &%create_file%& options. If the
22754 &%maildirfolder_create_regex%& option is set, and the regular expression it
22755 contains matches the delivery directory, Exim also ensures that a file called
22756 &_maildirfolder_& exists in the delivery directory. If a missing directory or
22757 &_maildirfolder_& file cannot be created, delivery is deferred.
22758
22759 These features make it possible to use Exim to create all the necessary files
22760 and directories in a maildir mailbox, including subdirectories for maildir++
22761 folders. Consider this example:
22762 .code
22763 maildir_format = true
22764 directory = /var/mail/$local_part\
22765            ${if eq{$local_part_suffix}{}{}\
22766            {/.${substr_1:$local_part_suffix}}}
22767 maildirfolder_create_regex = /\.[^/]+$
22768 .endd
22769 If &$local_part_suffix$& is empty (there was no suffix for the local part),
22770 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
22771 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
22772 not match this name, so Exim will not look for or create the file
22773 &_/var/mail/pimbo/maildirfolder_&, though it will create
22774 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
22775
22776 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
22777 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
22778 does match &%maildirfolder_create_regex%&. In this case, Exim will create
22779 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
22780 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
22781
22782 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
22783 not inadvertently match the toplevel maildir directory, because a
22784 &_maildirfolder_& file at top level would completely break quota calculations.
22785
22786 .cindex "quota" "in maildir delivery"
22787 .cindex "maildir++"
22788 If Exim is required to check a &%quota%& setting before a maildir delivery, and
22789 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
22790 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
22791 Exim assumes the directory is a maildir++ folder directory, which is one level
22792 down from the user's top level mailbox directory. This causes it to start at
22793 the parent directory instead of the current directory when calculating the
22794 amount of space used.
22795
22796 One problem with delivering into a multi-file mailbox is that it is
22797 computationally expensive to compute the size of the mailbox for quota
22798 checking. Various approaches have been taken to reduce the amount of work
22799 needed. The next two sections describe two of them. A third alternative is to
22800 use some external process for maintaining the size data, and use the expansion
22801 of the &%mailbox_size%& option as a way of importing it into Exim.
22802
22803
22804
22805
22806 .section "Using tags to record message sizes" "SECID135"
22807 If &%maildir_tag%& is set, the string is expanded for each delivery.
22808 When the maildir file is renamed into the &_new_& sub-directory, the
22809 tag is added to its name. However, if adding the tag takes the length of the
22810 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
22811 the tag is dropped and the maildir file is created with no tag.
22812
22813
22814 .vindex "&$message_size$&"
22815 Tags can be used to encode the size of files in their names; see
22816 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
22817 happens after the message has been written. The value of the &$message_size$&
22818 variable is set to the number of bytes actually written. If the expansion is
22819 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
22820 be deferred. The expanded tag may contain any printing characters except &"/"&.
22821 Non-printing characters in the string are ignored; if the resulting string is
22822 empty, it is ignored. If it starts with an alphanumeric character, a leading
22823 colon is inserted; this default has not proven to be the path that popular
22824 maildir implementations have chosen (but changing it in Exim would break
22825 backwards compatibility).
22826
22827 For one common implementation, you might set:
22828 .code
22829 maildir_tag = ,S=${message_size}
22830 .endd
22831 but you should check the documentation of the other software to be sure.
22832
22833 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
22834 as this allows Exim to extract the size from your tag, instead of having to
22835 &[stat()]& each message file.
22836
22837
22838 .section "Using a maildirsize file" "SECID136"
22839 .cindex "quota" "in maildir delivery"
22840 .cindex "maildir format" "&_maildirsize_& file"
22841 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
22842 storing quota and message size information in a file called &_maildirsize_&
22843 within the toplevel maildir directory. If this file does not exist, Exim
22844 creates it, setting the quota from the &%quota%& option of the transport. If
22845 the maildir directory itself does not exist, it is created before any attempt
22846 to write a &_maildirsize_& file.
22847
22848 The &_maildirsize_& file is used to hold information about the sizes of
22849 messages in the maildir, thus speeding up quota calculations. The quota value
22850 in the file is just a cache; if the quota is changed in the transport, the new
22851 value overrides the cached value when the next message is delivered. The cache
22852 is maintained for the benefit of other programs that access the maildir and
22853 need to know the quota.
22854
22855 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
22856 file is maintained (with a zero quota setting), but no quota is imposed.
22857
22858 A regular expression is available for controlling which directories in the
22859 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
22860 See the description of the &%maildir_quota_directory_regex%& option above for
22861 details.
22862
22863
22864 .section "Mailstore delivery" "SECID137"
22865 .cindex "mailstore format" "description of"
22866 If the &%mailstore_format%& option is true, each message is written as two
22867 files in the given directory. A unique base name is constructed from the
22868 message id and the current delivery process, and the files that are written use
22869 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
22870 contains the message's envelope, and the &_.msg_& file contains the message
22871 itself. The base name is placed in the variable &$mailstore_basename$&.
22872
22873 During delivery, the envelope is first written to a file with the suffix
22874 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
22875 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
22876 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
22877 file before accessing either of them. An alternative approach is to wait for
22878 the absence of a &_.tmp_& file.
22879
22880 The envelope file starts with any text defined by the &%mailstore_prefix%&
22881 option, expanded and terminated by a newline if there isn't one. Then follows
22882 the sender address on one line, then all the recipient addresses, one per line.
22883 There can be more than one recipient only if the &%batch_max%& option is set
22884 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
22885 appended to the file, followed by a newline if it does not end with one.
22886
22887 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
22888 failure, it is ignored. Other expansion errors are treated as serious
22889 configuration errors, and delivery is deferred. The variable
22890 &$mailstore_basename$& is available for use during these expansions.
22891
22892
22893 .section "Non-special new file delivery" "SECID138"
22894 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
22895 file is created directly in the named directory. For example, when delivering
22896 messages into files in batched SMTP format for later delivery to some host (see
22897 section &<<SECTbatchSMTP>>&), a setting such as
22898 .code
22899 directory = /var/bsmtp/$host
22900 .endd
22901 might be used. A message is written to a file with a temporary name, which is
22902 then renamed when the delivery is complete. The final name is obtained by
22903 expanding the contents of the &%directory_file%& option.
22904 .ecindex IIDapptra1
22905 .ecindex IIDapptra2
22906
22907
22908
22909
22910
22911
22912 . ////////////////////////////////////////////////////////////////////////////
22913 . ////////////////////////////////////////////////////////////////////////////
22914
22915 .chapter "The autoreply transport" "CHID8"
22916 .scindex IIDauttra1 "transports" "&(autoreply)&"
22917 .scindex IIDauttra2 "&(autoreply)& transport"
22918 The &(autoreply)& transport is not a true transport in that it does not cause
22919 the message to be transmitted. Instead, it generates a new mail message as an
22920 automatic reply to the incoming message. &'References:'& and
22921 &'Auto-Submitted:'& header lines are included. These are constructed according
22922 to the rules in RFCs 2822 and 3834, respectively.
22923
22924 If the router that passes the message to this transport does not have the
22925 &%unseen%& option set, the original message (for the current recipient) is not
22926 delivered anywhere. However, when the &%unseen%& option is set on the router
22927 that passes the message to this transport, routing of the address continues, so
22928 another router can set up a normal message delivery.
22929
22930
22931 The &(autoreply)& transport is usually run as the result of mail filtering, a
22932 &"vacation"& message being the standard example. However, it can also be run
22933 directly from a router like any other transport. To reduce the possibility of
22934 message cascades, messages created by the &(autoreply)& transport always have
22935 empty envelope sender addresses, like bounce messages.
22936
22937 The parameters of the message to be sent can be specified in the configuration
22938 by options described below. However, these are used only when the address
22939 passed to the transport does not contain its own reply information. When the
22940 transport is run as a consequence of a
22941 &%mail%&
22942 or &%vacation%& command in a filter file, the parameters of the message are
22943 supplied by the filter, and passed with the address. The transport's options
22944 that define the message are then ignored (so they are not usually set in this
22945 case). The message is specified entirely by the filter or by the transport; it
22946 is never built from a mixture of options. However, the &%file_optional%&,
22947 &%mode%&, and &%return_message%& options apply in all cases.
22948
22949 &(Autoreply)& is implemented as a local transport. When used as a result of a
22950 command in a user's filter file, &(autoreply)& normally runs under the uid and
22951 gid of the user, and with appropriate current and home directories (see chapter
22952 &<<CHAPenvironment>>&).
22953
22954 There is a subtle difference between routing a message to a &(pipe)& transport
22955 that generates some text to be returned to the sender, and routing it to an
22956 &(autoreply)& transport. This difference is noticeable only if more than one
22957 address from the same message is so handled. In the case of a pipe, the
22958 separate outputs from the different addresses are gathered up and returned to
22959 the sender in a single message, whereas if &(autoreply)& is used, a separate
22960 message is generated for each address that is passed to it.
22961
22962 Non-printing characters are not permitted in the header lines generated for the
22963 message that &(autoreply)& creates, with the exception of newlines that are
22964 immediately followed by white space. If any non-printing characters are found,
22965 the transport defers.
22966 Whether characters with the top bit set count as printing characters or not is
22967 controlled by the &%print_topbitchars%& global option.
22968
22969 If any of the generic options for manipulating headers (for example,
22970 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
22971 of the original message that is included in the generated message when
22972 &%return_message%& is set. They do not apply to the generated message itself.
22973
22974 .vindex "&$sender_address$&"
22975 If the &(autoreply)& transport receives return code 2 from Exim when it submits
22976 the message, indicating that there were no recipients, it does not treat this
22977 as an error. This means that autoreplies sent to &$sender_address$& when this
22978 is empty (because the incoming message is a bounce message) do not cause
22979 problems. They are just discarded.
22980
22981
22982
22983 .section "Private options for autoreply" "SECID139"
22984 .cindex "options" "&(autoreply)& transport"
22985
22986 .option bcc autoreply string&!! unset
22987 This specifies the addresses that are to receive &"blind carbon copies"& of the
22988 message when the message is specified by the transport.
22989
22990
22991 .option cc autoreply string&!! unset
22992 This specifies recipients of the message and the contents of the &'Cc:'& header
22993 when the message is specified by the transport.
22994
22995
22996 .option file autoreply string&!! unset
22997 The contents of the file are sent as the body of the message when the message
22998 is specified by the transport. If both &%file%& and &%text%& are set, the text
22999 string comes first.
23000
23001
23002 .option file_expand autoreply boolean false
23003 If this is set, the contents of the file named by the &%file%& option are
23004 subjected to string expansion as they are added to the message.
23005
23006
23007 .option file_optional autoreply boolean false
23008 If this option is true, no error is generated if the file named by the &%file%&
23009 option or passed with the address does not exist or cannot be read.
23010
23011
23012 .option from autoreply string&!! unset
23013 This specifies the contents of the &'From:'& header when the message is
23014 specified by the transport.
23015
23016
23017 .option headers autoreply string&!! unset
23018 This specifies additional RFC 2822 headers that are to be added to the message
23019 when the message is specified by the transport. Several can be given by using
23020 &"\n"& to separate them. There is no check on the format.
23021
23022
23023 .option log autoreply string&!! unset
23024 This option names a file in which a record of every message sent is logged when
23025 the message is specified by the transport.
23026
23027
23028 .option mode autoreply "octal integer" 0600
23029 If either the log file or the &"once"& file has to be created, this mode is
23030 used.
23031
23032
23033 .option never_mail autoreply "address list&!!" unset
23034 If any run of the transport creates a message with a recipient that matches any
23035 item in the list, that recipient is quietly discarded. If all recipients are
23036 discarded, no message is created. This applies both when the recipients are
23037 generated by a filter and when they are specified in the transport.
23038
23039
23040
23041 .option once autoreply string&!! unset
23042 This option names a file or DBM database in which a record of each &'To:'&
23043 recipient is kept when the message is specified by the transport. &*Note*&:
23044 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
23045
23046 If &%once%& is unset, or is set to an empty string, the message is always sent.
23047 By default, if &%once%& is set to a non-empty file name, the message
23048 is not sent if a potential recipient is already listed in the database.
23049 However, if the &%once_repeat%& option specifies a time greater than zero, the
23050 message is sent if that much time has elapsed since a message was last sent to
23051 this recipient. A setting of zero time for &%once_repeat%& (the default)
23052 prevents a message from being sent a second time &-- in this case, zero means
23053 infinity.
23054
23055 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
23056 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
23057 greater than zero, it changes the way Exim implements the &%once%& option.
23058 Instead of using a DBM file to record every recipient it sends to, it uses a
23059 regular file, whose size will never get larger than the given value.
23060
23061 In the file, Exim keeps a linear list of recipient addresses and the times at
23062 which they were sent messages. If the file is full when a new address needs to
23063 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
23064 means that a given recipient may receive multiple messages, but at
23065 unpredictable intervals that depend on the rate of turnover of addresses in the
23066 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
23067
23068
23069 .option once_file_size autoreply integer 0
23070 See &%once%& above.
23071
23072
23073 .option once_repeat autoreply time&!! 0s
23074 See &%once%& above.
23075 After expansion, the value of this option must be a valid time value.
23076
23077
23078 .option reply_to autoreply string&!! unset
23079 This specifies the contents of the &'Reply-To:'& header when the message is
23080 specified by the transport.
23081
23082
23083 .option return_message autoreply boolean false
23084 If this is set, a copy of the original message is returned with the new
23085 message, subject to the maximum size set in the &%return_size_limit%& global
23086 configuration option.
23087
23088
23089 .option subject autoreply string&!! unset
23090 This specifies the contents of the &'Subject:'& header when the message is
23091 specified by the transport. It is tempting to quote the original subject in
23092 automatic responses. For example:
23093 .code
23094 subject = Re: $h_subject:
23095 .endd
23096 There is a danger in doing this, however. It may allow a third party to
23097 subscribe your users to an opt-in mailing list, provided that the list accepts
23098 bounce messages as subscription confirmations. Well-managed lists require a
23099 non-bounce message to confirm a subscription, so the danger is relatively
23100 small.
23101
23102
23103
23104 .option text autoreply string&!! unset
23105 This specifies a single string to be used as the body of the message when the
23106 message is specified by the transport. If both &%text%& and &%file%& are set,
23107 the text comes first.
23108
23109
23110 .option to autoreply string&!! unset
23111 This specifies recipients of the message and the contents of the &'To:'& header
23112 when the message is specified by the transport.
23113 .ecindex IIDauttra1
23114 .ecindex IIDauttra2
23115
23116
23117
23118
23119 . ////////////////////////////////////////////////////////////////////////////
23120 . ////////////////////////////////////////////////////////////////////////////
23121
23122 .chapter "The lmtp transport" "CHAPLMTP"
23123 .cindex "transports" "&(lmtp)&"
23124 .cindex "&(lmtp)& transport"
23125 .cindex "LMTP" "over a pipe"
23126 .cindex "LMTP" "over a socket"
23127 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
23128 specified command
23129 or by interacting with a Unix domain socket.
23130 This transport is something of a cross between the &(pipe)& and &(smtp)&
23131 transports. Exim also has support for using LMTP over TCP/IP; this is
23132 implemented as an option for the &(smtp)& transport. Because LMTP is expected
23133 to be of minority interest, the default build-time configure in &_src/EDITME_&
23134 has it commented out. You need to ensure that
23135 .code
23136 TRANSPORT_LMTP=yes
23137 .endd
23138 .cindex "options" "&(lmtp)& transport"
23139 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
23140 included in the Exim binary. The private options of the &(lmtp)& transport are
23141 as follows:
23142
23143 .option batch_id lmtp string&!! unset
23144 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23145
23146
23147 .option batch_max lmtp integer 1
23148 This limits the number of addresses that can be handled in a single delivery.
23149 Most LMTP servers can handle several addresses at once, so it is normally a
23150 good idea to increase this value. See the description of local delivery
23151 batching in chapter &<<CHAPbatching>>&.
23152
23153
23154 .option command lmtp string&!! unset
23155 This option must be set if &%socket%& is not set. The string is a command which
23156 is run in a separate process. It is split up into a command name and list of
23157 arguments, each of which is separately expanded (so expansion cannot change the
23158 number of arguments). The command is run directly, not via a shell. The message
23159 is passed to the new process using the standard input and output to operate the
23160 LMTP protocol.
23161
23162 .option ignore_quota lmtp boolean false
23163 .cindex "LMTP" "ignoring quota errors"
23164 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
23165 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
23166 in its response to the LHLO command.
23167
23168 .option socket lmtp string&!! unset
23169 This option must be set if &%command%& is not set. The result of expansion must
23170 be the name of a Unix domain socket. The transport connects to the socket and
23171 delivers the message to it using the LMTP protocol.
23172
23173
23174 .option timeout lmtp time 5m
23175 The transport is aborted if the created process or Unix domain socket does not
23176 respond to LMTP commands or message input within this timeout. Delivery
23177 is deferred, and will be tried again later. Here is an example of a typical
23178 LMTP transport:
23179 .code
23180 lmtp:
23181   driver = lmtp
23182   command = /some/local/lmtp/delivery/program
23183   batch_max = 20
23184   user = exim
23185 .endd
23186 This delivers up to 20 addresses at a time, in a mixture of domains if
23187 necessary, running as the user &'exim'&.
23188
23189
23190
23191 . ////////////////////////////////////////////////////////////////////////////
23192 . ////////////////////////////////////////////////////////////////////////////
23193
23194 .chapter "The pipe transport" "CHAPpipetransport"
23195 .scindex IIDpiptra1 "transports" "&(pipe)&"
23196 .scindex IIDpiptra2 "&(pipe)& transport"
23197 The &(pipe)& transport is used to deliver messages via a pipe to a command
23198 running in another process. One example is the use of &(pipe)& as a
23199 pseudo-remote transport for passing messages to some other delivery mechanism
23200 (such as UUCP). Another is the use by individual users to automatically process
23201 their incoming messages. The &(pipe)& transport can be used in one of the
23202 following ways:
23203
23204 .ilist
23205 .vindex "&$local_part$&"
23206 A router routes one address to a transport in the normal way, and the
23207 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
23208 contains the local part of the address (as usual), and the command that is run
23209 is specified by the &%command%& option on the transport.
23210 .next
23211 .vindex "&$pipe_addresses$&"
23212 If the &%batch_max%& option is set greater than 1 (the default is 1), the
23213 transport can handle more than one address in a single run. In this case, when
23214 more than one address is routed to the transport, &$local_part$& is not set
23215 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
23216 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
23217 that are routed to the transport.
23218 .next
23219 .vindex "&$address_pipe$&"
23220 A router redirects an address directly to a pipe command (for example, from an
23221 alias or forward file). In this case, &$address_pipe$& contains the text of the
23222 pipe command, and the &%command%& option on the transport is ignored unless
23223 &%force_command%& is set. If only one address is being transported
23224 (&%batch_max%& is not greater than one, or only one address was redirected to
23225 this pipe command), &$local_part$& contains the local part that was redirected.
23226 .endlist
23227
23228
23229 The &(pipe)& transport is a non-interactive delivery method. Exim can also
23230 deliver messages over pipes using the LMTP interactive protocol. This is
23231 implemented by the &(lmtp)& transport.
23232
23233 In the case when &(pipe)& is run as a consequence of an entry in a local user's
23234 &_.forward_& file, the command runs under the uid and gid of that user. In
23235 other cases, the uid and gid have to be specified explicitly, either on the
23236 transport or on the router that handles the address. Current and &"home"&
23237 directories are also controllable. See chapter &<<CHAPenvironment>>& for
23238 details of the local delivery environment and chapter &<<CHAPbatching>>&
23239 for a discussion of local delivery batching.
23240
23241
23242 .section "Concurrent delivery" "SECID140"
23243 If two messages arrive at almost the same time, and both are routed to a pipe
23244 delivery, the two pipe transports may be run concurrently. You must ensure that
23245 any pipe commands you set up are robust against this happening. If the commands
23246 write to a file, the &%exim_lock%& utility might be of use.
23247 Alternatively the &%max_parallel%& option could be used with a value
23248 of "1" to enforce serialization.
23249
23250
23251
23252
23253 .section "Returned status and data" "SECID141"
23254 .cindex "&(pipe)& transport" "returned data"
23255 If the command exits with a non-zero return code, the delivery is deemed to
23256 have failed, unless either the &%ignore_status%& option is set (in which case
23257 the return code is treated as zero), or the return code is one of those listed
23258 in the &%temp_errors%& option, which are interpreted as meaning &"try again
23259 later"&. In this case, delivery is deferred. Details of a permanent failure are
23260 logged, but are not included in the bounce message, which merely contains
23261 &"local delivery failed"&.
23262
23263 If the command exits on a signal and the &%freeze_signal%& option is set then
23264 the message will be frozen in the queue. If that option is not set, a bounce
23265 will be sent as normal.
23266
23267 If the return code is greater than 128 and the command being run is a shell
23268 script, it normally means that the script was terminated by a signal whose
23269 value is the return code minus 128. The &%freeze_signal%& option does not
23270 apply in this case.
23271
23272 If Exim is unable to run the command (that is, if &[execve()]& fails), the
23273 return code is set to 127. This is the value that a shell returns if it is
23274 asked to run a non-existent command. The wording for the log line suggests that
23275 a non-existent command may be the problem.
23276
23277 The &%return_output%& option can affect the result of a pipe delivery. If it is
23278 set and the command produces any output on its standard output or standard
23279 error streams, the command is considered to have failed, even if it gave a zero
23280 return code or if &%ignore_status%& is set. The output from the command is
23281 included as part of the bounce message. The &%return_fail_output%& option is
23282 similar, except that output is returned only when the command exits with a
23283 failure return code, that is, a value other than zero or a code that matches
23284 &%temp_errors%&.
23285
23286
23287
23288 .section "How the command is run" "SECThowcommandrun"
23289 .cindex "&(pipe)& transport" "path for command"
23290 The command line is (by default) broken down into a command name and arguments
23291 by the &(pipe)& transport itself. The &%allow_commands%& and
23292 &%restrict_to_path%& options can be used to restrict the commands that may be
23293 run.
23294
23295 .cindex "quoting" "in pipe command"
23296 Unquoted arguments are delimited by white space. If an argument appears in
23297 double quotes, backslash is interpreted as an escape character in the usual
23298 way. If an argument appears in single quotes, no escaping is done.
23299
23300 String expansion is applied to the command line except when it comes from a
23301 traditional &_.forward_& file (commands from a filter file are expanded). The
23302 expansion is applied to each argument in turn rather than to the whole line.
23303 For this reason, any string expansion item that contains white space must be
23304 quoted so as to be contained within a single argument. A setting such as
23305 .code
23306 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
23307 .endd
23308 will not work, because the expansion item gets split between several
23309 arguments. You have to write
23310 .code
23311 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
23312 .endd
23313 to ensure that it is all in one argument. The expansion is done in this way,
23314 argument by argument, so that the number of arguments cannot be changed as a
23315 result of expansion, and quotes or backslashes in inserted variables do not
23316 interact with external quoting. However, this leads to problems if you want to
23317 generate multiple arguments (or the command name plus arguments) from a single
23318 expansion. In this situation, the simplest solution is to use a shell. For
23319 example:
23320 .code
23321 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
23322 .endd
23323
23324 .cindex "transport" "filter"
23325 .cindex "filter" "transport filter"
23326 .vindex "&$pipe_addresses$&"
23327 Special handling takes place when an argument consists of precisely the text
23328 &`$pipe_addresses`&. This is not a general expansion variable; the only
23329 place this string is recognized is when it appears as an argument for a pipe or
23330 transport filter command. It causes each address that is being handled to be
23331 inserted in the argument list at that point &'as a separate argument'&. This
23332 avoids any problems with spaces or shell metacharacters, and is of use when a
23333 &(pipe)& transport is handling groups of addresses in a batch.
23334
23335 If &%force_command%& is enabled on the transport, Special handling takes place
23336 for an argument that consists of precisely the text &`$address_pipe`&.  It
23337 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
23338 argument is inserted in the argument list at that point
23339 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
23340 the only item in the argument; in fact, if it were then &%force_command%&
23341 should behave as a no-op.  Rather, it should be used to adjust the command
23342 run while preserving the argument vector separation.
23343
23344 After splitting up into arguments and expansion, the resulting command is run
23345 in a subprocess directly from the transport, &'not'& under a shell. The
23346 message that is being delivered is supplied on the standard input, and the
23347 standard output and standard error are both connected to a single pipe that is
23348 read by Exim. The &%max_output%& option controls how much output the command
23349 may produce, and the &%return_output%& and &%return_fail_output%& options
23350 control what is done with it.
23351
23352 Not running the command under a shell (by default) lessens the security risks
23353 in cases when a command from a user's filter file is built out of data that was
23354 taken from an incoming message. If a shell is required, it can of course be
23355 explicitly specified as the command to be run. However, there are circumstances
23356 where existing commands (for example, in &_.forward_& files) expect to be run
23357 under a shell and cannot easily be modified. To allow for these cases, there is
23358 an option called &%use_shell%&, which changes the way the &(pipe)& transport
23359 works. Instead of breaking up the command line as just described, it expands it
23360 as a single string and passes the result to &_/bin/sh_&. The
23361 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
23362 with &%use_shell%&, and the whole mechanism is inherently less secure.
23363
23364
23365
23366 .section "Environment variables" "SECTpipeenv"
23367 .cindex "&(pipe)& transport" "environment for command"
23368 .cindex "environment" "&(pipe)& transport"
23369 The environment variables listed below are set up when the command is invoked.
23370 This list is a compromise for maximum compatibility with other MTAs. Note that
23371 the &%environment%& option can be used to add additional variables to this
23372 environment. The environment for the &(pipe)& transport is not subject
23373 to the &%add_environment%& and &%keep_environment%& main config options.
23374 .display
23375 &`DOMAIN            `&   the domain of the address
23376 &`HOME              `&   the home directory, if set
23377 &`HOST              `&   the host name when called from a router (see below)
23378 &`LOCAL_PART        `&   see below
23379 &`LOCAL_PART_PREFIX `&   see below
23380 &`LOCAL_PART_SUFFIX `&   see below
23381 &`LOGNAME           `&   see below
23382 &`MESSAGE_ID        `&   Exim's local ID for the message
23383 &`PATH              `&   as specified by the &%path%& option below
23384 &`QUALIFY_DOMAIN    `&   the sender qualification domain
23385 &`RECIPIENT         `&   the complete recipient address
23386 &`SENDER            `&   the sender of the message (empty if a bounce)
23387 &`SHELL             `&   &`/bin/sh`&
23388 &`TZ                `&   the value of the &%timezone%& option, if set
23389 &`USER              `&   see below
23390 .endd
23391 When a &(pipe)& transport is called directly from (for example) an &(accept)&
23392 router, LOCAL_PART is set to the local part of the address. When it is
23393 called as a result of a forward or alias expansion, LOCAL_PART is set to
23394 the local part of the address that was expanded. In both cases, any affixes are
23395 removed from the local part, and made available in LOCAL_PART_PREFIX and
23396 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
23397 same value as LOCAL_PART for compatibility with other MTAs.
23398
23399 .cindex "HOST"
23400 HOST is set only when a &(pipe)& transport is called from a router that
23401 associates hosts with an address, typically when using &(pipe)& as a
23402 pseudo-remote transport. HOST is set to the first host name specified by
23403 the router.
23404
23405 .cindex "HOME"
23406 If the transport's generic &%home_directory%& option is set, its value is used
23407 for the HOME environment variable. Otherwise, a home directory may be set
23408 by the router's &%transport_home_directory%& option, which defaults to the
23409 user's home directory if &%check_local_user%& is set.
23410
23411
23412 .section "Private options for pipe" "SECID142"
23413 .cindex "options" "&(pipe)& transport"
23414
23415
23416
23417 .option allow_commands pipe "string list&!!" unset
23418 .cindex "&(pipe)& transport" "permitted commands"
23419 The string is expanded, and is then interpreted as a colon-separated list of
23420 permitted commands. If &%restrict_to_path%& is not set, the only commands
23421 permitted are those in the &%allow_commands%& list. They need not be absolute
23422 paths; the &%path%& option is still used for relative paths. If
23423 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
23424 in the &%allow_commands%& list, or a name without any slashes that is found on
23425 the path. In other words, if neither &%allow_commands%& nor
23426 &%restrict_to_path%& is set, there is no restriction on the command, but
23427 otherwise only commands that are permitted by one or the other are allowed. For
23428 example, if
23429 .code
23430 allow_commands = /usr/bin/vacation
23431 .endd
23432 and &%restrict_to_path%& is not set, the only permitted command is
23433 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
23434 &%use_shell%& is set.
23435
23436
23437 .option batch_id pipe string&!! unset
23438 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23439
23440
23441 .option batch_max pipe integer 1
23442 This limits the number of addresses that can be handled in a single delivery.
23443 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23444
23445
23446 .option check_string pipe string unset
23447 As &(pipe)& writes the message, the start of each line is tested for matching
23448 &%check_string%&, and if it does, the initial matching characters are replaced
23449 by the contents of &%escape_string%&, provided both are set. The value of
23450 &%check_string%& is a literal string, not a regular expression, and the case of
23451 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
23452 of &%check_string%& and &%escape_string%& are forced to values that implement
23453 the SMTP escaping protocol. Any settings made in the configuration file are
23454 ignored.
23455
23456
23457 .option command pipe string&!! unset
23458 This option need not be set when &(pipe)& is being used to deliver to pipes
23459 obtained directly from address redirections. In other cases, the option must be
23460 set, to provide a command to be run. It need not yield an absolute path (see
23461 the &%path%& option below). The command is split up into separate arguments by
23462 Exim, and each argument is separately expanded, as described in section
23463 &<<SECThowcommandrun>>& above.
23464
23465
23466 .option environment pipe string&!! unset
23467 .cindex "&(pipe)& transport" "environment for command"
23468 .cindex "environment" "&(pipe)& transport"
23469 This option is used to add additional variables to the environment in which the
23470 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
23471 a string which is expanded, and then interpreted as a colon-separated list of
23472 environment settings of the form <&'name'&>=<&'value'&>.
23473
23474
23475 .option escape_string pipe string unset
23476 See &%check_string%& above.
23477
23478
23479 .option freeze_exec_fail pipe boolean false
23480 .cindex "exec failure"
23481 .cindex "failure of exec"
23482 .cindex "&(pipe)& transport" "failure of exec"
23483 Failure to exec the command in a pipe transport is by default treated like
23484 any other failure while running the command. However, if &%freeze_exec_fail%&
23485 is set, failure to exec is treated specially, and causes the message to be
23486 frozen, whatever the setting of &%ignore_status%&.
23487
23488
23489 .option freeze_signal pipe boolean false
23490 .cindex "signal exit"
23491 .cindex "&(pipe)& transport", "signal exit"
23492 Normally if the process run by a command in a pipe transport exits on a signal,
23493 a bounce message is sent. If &%freeze_signal%& is set, the message will be
23494 frozen in Exim's queue instead.
23495
23496
23497 .option force_command pipe boolean false
23498 .cindex "force command"
23499 .cindex "&(pipe)& transport", "force command"
23500 Normally when a router redirects an address directly to a pipe command
23501 the &%command%& option on the transport is ignored.  If &%force_command%&
23502 is set, the &%command%& option will used. This is especially
23503 useful for forcing a wrapper or additional argument to be added to the
23504 command. For example:
23505 .code
23506 command = /usr/bin/remote_exec myhost -- $address_pipe
23507 force_command
23508 .endd
23509
23510 Note that &$address_pipe$& is handled specially in &%command%& when
23511 &%force_command%& is set, expanding out to the original argument vector as
23512 separate items, similarly to a Unix shell &`"$@"`& construct.
23513
23514
23515 .option ignore_status pipe boolean false
23516 If this option is true, the status returned by the subprocess that is set up to
23517 run the command is ignored, and Exim behaves as if zero had been returned.
23518 Otherwise, a non-zero status or termination by signal causes an error return
23519 from the transport unless the status value is one of those listed in
23520 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
23521
23522 &*Note*&: This option does not apply to timeouts, which do not return a status.
23523 See the &%timeout_defer%& option for how timeouts are handled.
23524
23525
23526 .option log_defer_output pipe boolean false
23527 .cindex "&(pipe)& transport" "logging output"
23528 If this option is set, and the status returned by the command is
23529 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
23530 and any output was produced on stdout or stderr, the first line of it is
23531 written to the main log.
23532
23533
23534 .option log_fail_output pipe boolean false
23535 If this option is set, and the command returns any output on stdout or
23536 stderr, and also ends with a return code that is neither zero nor one of
23537 the return codes listed in &%temp_errors%& (that is, the delivery
23538 failed), the first line of output is written to the main log. This
23539 option and &%log_output%& are mutually exclusive.  Only one of them may
23540 be set.
23541
23542
23543 .option log_output pipe boolean false
23544 If this option is set and the command returns any output on stdout or
23545 stderr, the first line of output is written to the main log, whatever
23546 the return code. This option and &%log_fail_output%& are mutually
23547 exclusive. Only one of them may be set.
23548
23549
23550 .option max_output pipe integer 20K
23551 This specifies the maximum amount of output that the command may produce on its
23552 standard output and standard error file combined. If the limit is exceeded, the
23553 process running the command is killed. This is intended as a safety measure to
23554 catch runaway processes. The limit is applied independently of the settings of
23555 the options that control what is done with such output (for example,
23556 &%return_output%&). Because of buffering effects, the amount of output may
23557 exceed the limit by a small amount before Exim notices.
23558
23559
23560 .option message_prefix pipe string&!! "see below"
23561 The string specified here is expanded and output at the start of every message.
23562 The default is unset if &%use_bsmtp%& is set. Otherwise it is
23563 .code
23564 message_prefix = \
23565   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
23566   ${tod_bsdinbox}\n
23567 .endd
23568 .cindex "Cyrus"
23569 .cindex "&%tmail%&"
23570 .cindex "&""From""& line"
23571 This is required by the commonly used &_/usr/bin/vacation_& program.
23572 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
23573 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
23574 setting
23575 .code
23576 message_prefix =
23577 .endd
23578 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23579 &`\n`& to &`\r\n`& in &%message_prefix%&.
23580
23581
23582 .option message_suffix pipe string&!! "see below"
23583 The string specified here is expanded and output at the end of every message.
23584 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
23585 The suffix can be suppressed by setting
23586 .code
23587 message_suffix =
23588 .endd
23589 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23590 &`\n`& to &`\r\n`& in &%message_suffix%&.
23591
23592
23593 .option path pipe string&!! "/bin:/usr/bin"
23594 This option is expanded and
23595 specifies the string that is set up in the PATH environment
23596 variable of the subprocess.
23597 If the &%command%& option does not yield an absolute path name, the command is
23598 sought in the PATH directories, in the usual way. &*Warning*&: This does not
23599 apply to a command specified as a transport filter.
23600
23601
23602 .option permit_coredump pipe boolean false
23603 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
23604 a core-dump of a pipe command, enable this command.  This enables core-dumps
23605 during delivery and affects both the Exim binary and the pipe command run.
23606 It is recommended that this option remain off unless and until you have a need
23607 for it and that this only be enabled when needed, as the risk of excessive
23608 resource consumption can be quite high.  Note also that Exim is typically
23609 installed as a setuid binary and most operating systems will inhibit coredumps
23610 of these by default, so further OS-specific action may be required.
23611
23612
23613 .option pipe_as_creator pipe boolean false
23614 .cindex "uid (user id)" "local delivery"
23615 If the generic &%user%& option is not set and this option is true, the delivery
23616 process is run under the uid that was in force when Exim was originally called
23617 to accept the message. If the group id is not otherwise set (via the generic
23618 &%group%& option), the gid that was in force when Exim was originally called to
23619 accept the message is used.
23620
23621
23622 .option restrict_to_path pipe boolean false
23623 When this option is set, any command name not listed in &%allow_commands%& must
23624 contain no slashes. The command is searched for only in the directories listed
23625 in the &%path%& option. This option is intended for use in the case when a pipe
23626 command has been generated from a user's &_.forward_& file. This is usually
23627 handled by a &(pipe)& transport called &%address_pipe%&.
23628
23629
23630 .option return_fail_output pipe boolean false
23631 If this option is true, and the command produced any output and ended with a
23632 return code other than zero or one of the codes listed in &%temp_errors%& (that
23633 is, the delivery failed), the output is returned in the bounce message.
23634 However, if the message has a null sender (that is, it is itself a bounce
23635 message), output from the command is discarded. This option and
23636 &%return_output%& are mutually exclusive. Only one of them may be set.
23637
23638
23639
23640 .option return_output pipe boolean false
23641 If this option is true, and the command produced any output, the delivery is
23642 deemed to have failed whatever the return code from the command, and the output
23643 is returned in the bounce message. Otherwise, the output is just discarded.
23644 However, if the message has a null sender (that is, it is a bounce message),
23645 output from the command is always discarded, whatever the setting of this
23646 option. This option and &%return_fail_output%& are mutually exclusive. Only one
23647 of them may be set.
23648
23649
23650
23651 .option temp_errors pipe "string list" "see below"
23652 .cindex "&(pipe)& transport" "temporary failure"
23653 This option contains either a colon-separated list of numbers, or a single
23654 asterisk. If &%ignore_status%& is false
23655 and &%return_output%& is not set,
23656 and the command exits with a non-zero return code, the failure is treated as
23657 temporary and the delivery is deferred if the return code matches one of the
23658 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
23659 codes are treated as permanent errors. The default setting contains the codes
23660 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
23661 compiled on a system that does not define these macros, it assumes values of 75
23662 and 73, respectively.
23663
23664
23665 .option timeout pipe time 1h
23666 If the command fails to complete within this time, it is killed. This normally
23667 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
23668 specifies no timeout. In order to ensure that any subprocesses created by the
23669 command are also killed, Exim makes the initial process a process group leader,
23670 and kills the whole process group on a timeout. However, this can be defeated
23671 if one of the processes starts a new process group.
23672
23673 .option timeout_defer pipe boolean false
23674 A timeout in a &(pipe)& transport, either in the command that the transport
23675 runs, or in a transport filter that is associated with it, is by default
23676 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
23677 is set true, both kinds of timeout become temporary errors, causing the
23678 delivery to be deferred.
23679
23680 .option umask pipe "octal integer" 022
23681 This specifies the umask setting for the subprocess that runs the command.
23682
23683
23684 .option use_bsmtp pipe boolean false
23685 .cindex "envelope sender"
23686 If this option is set true, the &(pipe)& transport writes messages in &"batch
23687 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
23688 commands. If you want to include a leading HELO command with such messages,
23689 you can do so by setting the &%message_prefix%& option. See section
23690 &<<SECTbatchSMTP>>& for details of batch SMTP.
23691
23692 .option use_classresources pipe boolean false
23693 .cindex "class resources (BSD)"
23694 This option is available only when Exim is running on FreeBSD, NetBSD, or
23695 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
23696 resource limits when a &(pipe)& transport is run to perform a delivery. The
23697 limits for the uid under which the pipe is to run are obtained from the login
23698 class database.
23699
23700
23701 .option use_crlf pipe boolean false
23702 .cindex "carriage return"
23703 .cindex "linefeed"
23704 This option causes lines to be terminated with the two-character CRLF sequence
23705 (carriage return, linefeed) instead of just a linefeed character. In the case
23706 of batched SMTP, the byte sequence written to the pipe is then an exact image
23707 of what would be sent down a real SMTP connection.
23708
23709 The contents of the &%message_prefix%& and &%message_suffix%& options are
23710 written verbatim, so must contain their own carriage return characters if these
23711 are needed. When &%use_bsmtp%& is not set, the default values for both
23712 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
23713 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
23714
23715
23716 .option use_shell pipe boolean false
23717 .vindex "&$pipe_addresses$&"
23718 If this option is set, it causes the command to be passed to &_/bin/sh_&
23719 instead of being run directly from the transport, as described in section
23720 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
23721 where the command is expected to be run under a shell and cannot easily be
23722 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
23723 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
23724 command is expanded as a single string, and handed to &_/bin/sh_& as data for
23725 its &%-c%& option.
23726
23727
23728
23729 .section "Using an external local delivery agent" "SECID143"
23730 .cindex "local delivery" "using an external agent"
23731 .cindex "&'procmail'&"
23732 .cindex "external local delivery"
23733 .cindex "delivery" "&'procmail'&"
23734 .cindex "delivery" "by external agent"
23735 The &(pipe)& transport can be used to pass all messages that require local
23736 delivery to a separate local delivery agent such as &%procmail%&. When doing
23737 this, care must be taken to ensure that the pipe is run under an appropriate
23738 uid and gid. In some configurations one wants this to be a uid that is trusted
23739 by the delivery agent to supply the correct sender of the message. It may be
23740 necessary to recompile or reconfigure the delivery agent so that it trusts an
23741 appropriate user. The following is an example transport and router
23742 configuration for &%procmail%&:
23743 .code
23744 # transport
23745 procmail_pipe:
23746   driver = pipe
23747   command = /usr/local/bin/procmail -d $local_part
23748   return_path_add
23749   delivery_date_add
23750   envelope_to_add
23751   check_string = "From "
23752   escape_string = ">From "
23753   umask = 077
23754   user = $local_part
23755   group = mail
23756
23757 # router
23758 procmail:
23759   driver = accept
23760   check_local_user
23761   transport = procmail_pipe
23762 .endd
23763 In this example, the pipe is run as the local user, but with the group set to
23764 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
23765 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
23766 user to supply a correct sender address. If you do not specify either a
23767 &%group%& or a &%user%& option, the pipe command is run as the local user. The
23768 home directory is the user's home directory by default.
23769
23770 &*Note*&: The command that the pipe transport runs does &'not'& begin with
23771 .code
23772 IFS=" "
23773 .endd
23774 as shown in some &%procmail%& documentation, because Exim does not by default
23775 use a shell to run pipe commands.
23776
23777 .cindex "Cyrus"
23778 The next example shows a transport and a router for a system where local
23779 deliveries are handled by the Cyrus IMAP server.
23780 .code
23781 # transport
23782 local_delivery_cyrus:
23783   driver = pipe
23784   command = /usr/cyrus/bin/deliver \
23785             -m ${substr_1:$local_part_suffix} -- $local_part
23786   user = cyrus
23787   group = mail
23788   return_output
23789   log_output
23790   message_prefix =
23791   message_suffix =
23792
23793 # router
23794 local_user_cyrus:
23795   driver = accept
23796   check_local_user
23797   local_part_suffix = .*
23798   transport = local_delivery_cyrus
23799 .endd
23800 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
23801 &%return_output%& to cause any text written by Cyrus to be returned to the
23802 sender.
23803 .ecindex IIDpiptra1
23804 .ecindex IIDpiptra2
23805
23806
23807 . ////////////////////////////////////////////////////////////////////////////
23808 . ////////////////////////////////////////////////////////////////////////////
23809
23810 .chapter "The smtp transport" "CHAPsmtptrans"
23811 .scindex IIDsmttra1 "transports" "&(smtp)&"
23812 .scindex IIDsmttra2 "&(smtp)& transport"
23813 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
23814 or LMTP protocol. The list of hosts to try can either be taken from the address
23815 that is being processed (having been set up by the router), or specified
23816 explicitly for the transport. Timeout and retry processing (see chapter
23817 &<<CHAPretry>>&) is applied to each IP address independently.
23818
23819
23820 .section "Multiple messages on a single connection" "SECID144"
23821 The sending of multiple messages over a single TCP/IP connection can arise in
23822 two ways:
23823
23824 .ilist
23825 If a message contains more than &%max_rcpt%& (see below) addresses that are
23826 routed to the same host, more than one copy of the message has to be sent to
23827 that host. In this situation, multiple copies may be sent in a single run of
23828 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
23829 does when it has too many addresses to send in one message also depends on the
23830 value of the global &%remote_max_parallel%& option. Details are given in
23831 section &<<SECToutSMTPTCP>>&.)
23832 .next
23833 .cindex "hints database" "remembering routing"
23834 When a message has been successfully delivered over a TCP/IP connection, Exim
23835 looks in its hints database to see if there are any other messages awaiting a
23836 connection to the same host. If there are, a new delivery process is started
23837 for one of them, and the current TCP/IP connection is passed on to it. The new
23838 process may in turn send multiple copies and possibly create yet another
23839 process.
23840 .endlist
23841
23842
23843 For each copy sent over the same TCP/IP connection, a sequence counter is
23844 incremented, and if it ever gets to the value of &%connection_max_messages%&,
23845 no further messages are sent over that connection.
23846
23847
23848
23849 .section "Use of the $host and $host_address variables" "SECID145"
23850 .vindex "&$host$&"
23851 .vindex "&$host_address$&"
23852 At the start of a run of the &(smtp)& transport, the values of &$host$& and
23853 &$host_address$& are the name and IP address of the first host on the host list
23854 passed by the router. However, when the transport is about to connect to a
23855 specific host, and while it is connected to that host, &$host$& and
23856 &$host_address$& are set to the values for that host. These are the values
23857 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
23858 &%serialize_hosts%&, and the various TLS options are expanded.
23859
23860
23861 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
23862 .vindex &$tls_bits$&
23863 .vindex &$tls_cipher$&
23864 .vindex &$tls_peerdn$&
23865 .vindex &$tls_sni$&
23866 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
23867 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
23868 are the values that were set when the message was received.
23869 These are the values that are used for options that are expanded before any
23870 SMTP connections are made. Just before each connection is made, these four
23871 variables are emptied. If TLS is subsequently started, they are set to the
23872 appropriate values for the outgoing connection, and these are the values that
23873 are in force when any authenticators are run and when the
23874 &%authenticated_sender%& option is expanded.
23875
23876 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
23877 and will be removed in a future release.
23878
23879
23880 .section "Private options for smtp" "SECID146"
23881 .cindex "options" "&(smtp)& transport"
23882 The private options of the &(smtp)& transport are as follows:
23883
23884
23885 .option address_retry_include_sender smtp boolean true
23886 .cindex "4&'xx'& responses" "retrying after"
23887 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
23888 is the combination of sender and recipient that is delayed in subsequent queue
23889 runs until the retry time is reached. You can delay the recipient without
23890 reference to the sender (which is what earlier versions of Exim did), by
23891 setting &%address_retry_include_sender%& false. However, this can lead to
23892 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
23893
23894 .option allow_localhost smtp boolean false
23895 .cindex "local host" "sending to"
23896 .cindex "fallback" "hosts specified on transport"
23897 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
23898 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
23899 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
23900 the delivery anyway. This should be used only in special cases when the
23901 configuration ensures that no looping will result (for example, a differently
23902 configured Exim is listening on the port to which the message is sent).
23903
23904
23905 .option authenticated_sender smtp string&!! unset
23906 .cindex "Cyrus"
23907 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
23908 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
23909 overriding any existing authenticated sender value. If the string expansion is
23910 forced to fail, the option is ignored. Other expansion failures cause delivery
23911 to be deferred. If the result of expansion is an empty string, that is also
23912 ignored.
23913
23914 The expansion happens after the outgoing connection has been made and TLS
23915 started, if required. This means that the &$host$&, &$host_address$&,
23916 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
23917 particular connection.
23918
23919 If the SMTP session is not authenticated, the expansion of
23920 &%authenticated_sender%& still happens (and can cause the delivery to be
23921 deferred if it fails), but no AUTH= item is added to MAIL commands
23922 unless &%authenticated_sender_force%& is true.
23923
23924 This option allows you to use the &(smtp)& transport in LMTP mode to
23925 deliver mail to Cyrus IMAP and provide the proper local part as the
23926 &"authenticated sender"&, via a setting such as:
23927 .code
23928 authenticated_sender = $local_part
23929 .endd
23930 This removes the need for IMAP subfolders to be assigned special ACLs to
23931 allow direct delivery to those subfolders.
23932
23933 Because of expected uses such as that just described for Cyrus (when no
23934 domain is involved), there is no checking on the syntax of the provided
23935 value.
23936
23937
23938 .option authenticated_sender_force smtp boolean false
23939 If this option is set true, the &%authenticated_sender%& option's value
23940 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
23941 authenticated as a client.
23942
23943
23944 .option command_timeout smtp time 5m
23945 This sets a timeout for receiving a response to an SMTP command that has been
23946 sent out. It is also used when waiting for the initial banner line from the
23947 remote host. Its value must not be zero.
23948
23949
23950 .option connect_timeout smtp time 5m
23951 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
23952 to a remote host. A setting of zero allows the system timeout (typically
23953 several minutes) to act. To have any effect, the value of this option must be
23954 less than the system timeout. However, it has been observed that on some
23955 systems there is no system timeout, which is why the default value for this
23956 option is 5 minutes, a value recommended by RFC 1123.
23957
23958
23959 .option connection_max_messages smtp integer 500
23960 .cindex "SMTP" "passed connection"
23961 .cindex "SMTP" "multiple deliveries"
23962 .cindex "multiple SMTP deliveries"
23963 This controls the maximum number of separate message deliveries that are sent
23964 over a single TCP/IP connection. If the value is zero, there is no limit.
23965 For testing purposes, this value can be overridden by the &%-oB%& command line
23966 option.
23967
23968
23969 .new
23970 .option dane_require_tls_ciphers smtp string&!! unset
23971 .cindex "TLS" "requiring specific ciphers for DANE"
23972 .cindex "cipher" "requiring specific"
23973 .cindex DANE "TLS ciphers"
23974 This option may be used to override &%tls_require_ciphers%& for connections
23975 where DANE has been determined to be in effect.
23976 If not set, then &%tls_require_ciphers%& will be used.
23977 Normal SMTP delivery is not able to make strong demands of TLS cipher
23978 configuration, because delivery will fall back to plaintext.  Once DANE has
23979 been determined to be in effect, there is no plaintext fallback and making the
23980 TLS cipherlist configuration stronger will increase security, rather than
23981 counter-intuitively decreasing it.
23982 If the option expands to be empty or is forced to fail, then it will
23983 be treated as unset and &%tls_require_ciphers%& will be used instead.
23984 .wen
23985
23986
23987 .option data_timeout smtp time 5m
23988 This sets a timeout for the transmission of each block in the data portion of
23989 the message. As a result, the overall timeout for a message depends on the size
23990 of the message. Its value must not be zero. See also &%final_timeout%&.
23991
23992
23993 .option dkim_domain smtp string list&!! unset
23994 .option dkim_selector smtp string&!! unset
23995 .option dkim_private_key smtp string&!! unset
23996 .option dkim_canon smtp string&!! unset
23997 .option dkim_strict smtp string&!! unset
23998 .option dkim_sign_headers smtp string&!! "per RFC"
23999 .option dkim_hash smtp string&!! sha256
24000 .option dkim_identity smtp string&!! unset
24001 DKIM signing options.  For details see section &<<SECDKIMSIGN>>&.
24002
24003
24004 .option delay_after_cutoff smtp boolean true
24005 This option controls what happens when all remote IP addresses for a given
24006 domain have been inaccessible for so long that they have passed their retry
24007 cutoff times.
24008
24009 In the default state, if the next retry time has not been reached for any of
24010 them, the address is bounced without trying any deliveries. In other words,
24011 Exim delays retrying an IP address after the final cutoff time until a new
24012 retry time is reached, and can therefore bounce an address without ever trying
24013 a delivery, when machines have been down for a long time. Some people are
24014 unhappy at this prospect, so...
24015
24016 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
24017 addresses are past their final cutoff time, Exim tries to deliver to those
24018 IP addresses that have not been tried since the message arrived. If there are
24019 none, of if they all fail, the address is bounced. In other words, it does not
24020 delay when a new message arrives, but immediately tries those expired IP
24021 addresses that haven't been tried since the message arrived. If there is a
24022 continuous stream of messages for the dead hosts, unsetting
24023 &%delay_after_cutoff%& means that there will be many more attempts to deliver
24024 to them.
24025
24026
24027 .option dns_qualify_single smtp boolean true
24028 If the &%hosts%& or &%fallback_hosts%& option is being used,
24029 and the &%gethostbyname%& option is false,
24030 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
24031 in chapter &<<CHAPdnslookup>>& for more details.
24032
24033
24034 .option dns_search_parents smtp boolean false
24035 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
24036 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
24037 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
24038 details.
24039
24040
24041 .option dnssec_request_domains smtp "domain list&!!" unset
24042 .cindex "MX record" "security"
24043 .cindex "DNSSEC" "MX lookup"
24044 .cindex "security" "MX lookup"
24045 .cindex "DNS" "DNSSEC"
24046 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
24047 the dnssec request bit set.
24048 This applies to all of the SRV, MX, AAAA, A lookup sequence.
24049
24050
24051
24052 .option dnssec_require_domains smtp "domain list&!!" unset
24053 .cindex "MX record" "security"
24054 .cindex "DNSSEC" "MX lookup"
24055 .cindex "security" "MX lookup"
24056 .cindex "DNS" "DNSSEC"
24057 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
24058 the dnssec request bit set.  Any returns not having the Authenticated Data bit
24059 (AD bit) set will be ignored and logged as a host-lookup failure.
24060 This applies to all of the SRV, MX, AAAA, A lookup sequence.
24061
24062
24063
24064 .option dscp smtp string&!! unset
24065 .cindex "DCSP" "outbound"
24066 This option causes the DSCP value associated with a socket to be set to one
24067 of a number of fixed strings or to numeric value.
24068 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
24069 Common values include &`throughput`&, &`mincost`&, and on newer systems
24070 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
24071
24072 The outbound packets from Exim will be marked with this value in the header
24073 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
24074 that these values will have any effect, not be stripped by networking
24075 equipment, or do much of anything without cooperation with your Network
24076 Engineer and those of all network operators between the source and destination.
24077
24078
24079 .option fallback_hosts smtp "string list" unset
24080 .cindex "fallback" "hosts specified on transport"
24081 String expansion is not applied to this option. The argument must be a
24082 colon-separated list of host names or IP addresses, optionally also including
24083 port numbers, though the separator can be changed, as described in section
24084 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
24085 item in a &%route_list%& setting for the &(manualroute)& router, as described
24086 in section &<<SECTformatonehostitem>>&.
24087
24088 Fallback hosts can also be specified on routers, which associate them with the
24089 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
24090 &%fallback_hosts%& specified on the transport is used only if the address does
24091 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
24092 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
24093 However, &%hosts_randomize%& does apply to fallback host lists.
24094
24095 If Exim is unable to deliver to any of the hosts for a particular address, and
24096 the errors are not permanent rejections, the address is put on a separate
24097 transport queue with its host list replaced by the fallback hosts, unless the
24098 address was routed via MX records and the current host was in the original MX
24099 list. In that situation, the fallback host list is not used.
24100
24101 Once normal deliveries are complete, the fallback queue is delivered by
24102 re-running the same transports with the new host lists. If several failing
24103 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
24104 copy of the message is sent.
24105
24106 The resolution of the host names on the fallback list is controlled by the
24107 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
24108 both to cases when the host list comes with the address and when it is taken
24109 from &%hosts%&. This option provides a &"use a smart host only if delivery
24110 fails"& facility.
24111
24112
24113 .option final_timeout smtp time 10m
24114 This is the timeout that applies while waiting for the response to the final
24115 line containing just &"."& that terminates a message. Its value must not be
24116 zero.
24117
24118 .option gethostbyname smtp boolean false
24119 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
24120 being used, names are looked up using &[gethostbyname()]&
24121 (or &[getipnodebyname()]& when available)
24122 instead of using the DNS. Of course, that function may in fact use the DNS, but
24123 it may also consult other sources of information such as &_/etc/hosts_&.
24124
24125 .option gnutls_compat_mode smtp boolean unset
24126 This option controls whether GnuTLS is used in compatibility mode in an Exim
24127 server. This reduces security slightly, but improves interworking with older
24128 implementations of TLS.
24129
24130 .option helo_data smtp string&!! "see below"
24131 .cindex "HELO" "argument, setting"
24132 .cindex "EHLO" "argument, setting"
24133 .cindex "LHLO argument setting"
24134 The value of this option is expanded after a connection to a another host has
24135 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
24136 command that starts the outgoing SMTP or LMTP session. The default value of the
24137 option is:
24138 .code
24139 $primary_hostname
24140 .endd
24141 During the expansion, the variables &$host$& and &$host_address$& are set to
24142 the identity of the remote host, and the variables &$sending_ip_address$& and
24143 &$sending_port$& are set to the local IP address and port number that are being
24144 used. These variables can be used to generate different values for different
24145 servers or different local IP addresses. For example, if you want the string
24146 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
24147 interface address, you could use this:
24148 .code
24149 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
24150   {$primary_hostname}}
24151 .endd
24152 The use of &%helo_data%& applies both to sending messages and when doing
24153 callouts.
24154
24155 .option hosts smtp "string list&!!" unset
24156 Hosts are associated with an address by a router such as &(dnslookup)&, which
24157 finds the hosts by looking up the address domain in the DNS, or by
24158 &(manualroute)&, which has lists of hosts in its configuration. However,
24159 email addresses can be passed to the &(smtp)& transport by any router, and not
24160 all of them can provide an associated list of hosts.
24161
24162 The &%hosts%& option specifies a list of hosts to be used if the address being
24163 processed does not have any hosts associated with it. The hosts specified by
24164 &%hosts%& are also used, whether or not the address has its own hosts, if
24165 &%hosts_override%& is set.
24166
24167 The string is first expanded, before being interpreted as a colon-separated
24168 list of host names or IP addresses, possibly including port numbers. The
24169 separator may be changed to something other than colon, as described in section
24170 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
24171 item in a &%route_list%& setting for the &(manualroute)& router, as described
24172 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
24173 of the &(manualroute)& router is not available here.
24174
24175 If the expansion fails, delivery is deferred. Unless the failure was caused by
24176 the inability to complete a lookup, the error is logged to the panic log as
24177 well as the main log. Host names are looked up either by searching directly for
24178 address records in the DNS or by calling &[gethostbyname()]& (or
24179 &[getipnodebyname()]& when available), depending on the setting of the
24180 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
24181 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
24182 address are used.
24183
24184 During delivery, the hosts are tried in order, subject to their retry status,
24185 unless &%hosts_randomize%& is set.
24186
24187
24188 .option hosts_avoid_esmtp smtp "host list&!!" unset
24189 .cindex "ESMTP, avoiding use of"
24190 .cindex "HELO" "forcing use of"
24191 .cindex "EHLO" "avoiding use of"
24192 .cindex "PIPELINING" "avoiding the use of"
24193 This option is for use with broken hosts that announce ESMTP facilities (for
24194 example, PIPELINING) and then fail to implement them properly. When a host
24195 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
24196 start of the SMTP session. This means that it cannot use any of the ESMTP
24197 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
24198
24199
24200 .option hosts_avoid_pipelining smtp "host list&!!" unset
24201 .cindex "PIPELINING" "avoiding the use of"
24202 Exim will not use the SMTP PIPELINING extension when delivering to any host
24203 that matches this list, even if the server host advertises PIPELINING support.
24204
24205
24206 .option hosts_avoid_tls smtp "host list&!!" unset
24207 .cindex "TLS" "avoiding for certain hosts"
24208 Exim will not try to start a TLS session when delivering to any host that
24209 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
24210
24211 .option hosts_verify_avoid_tls smtp "host list&!!" unset
24212 .cindex "TLS" "avoiding for certain hosts"
24213 Exim will not try to start a TLS session for a verify callout,
24214 or when delivering in cutthrough mode,
24215 to any host that matches this list.
24216
24217
24218 .option hosts_max_try smtp integer 5
24219 .cindex "host" "maximum number to try"
24220 .cindex "limit" "number of hosts tried"
24221 .cindex "limit" "number of MX tried"
24222 .cindex "MX record" "maximum tried"
24223 This option limits the number of IP addresses that are tried for any one
24224 delivery in cases where there are temporary delivery errors. Section
24225 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
24226
24227
24228 .option hosts_max_try_hardlimit smtp integer 50
24229 This is an additional check on the maximum number of IP addresses that Exim
24230 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
24231 why it exists.
24232
24233
24234
24235 .option hosts_nopass_tls smtp "host list&!!" unset
24236 .cindex "TLS" "passing connection"
24237 .cindex "multiple SMTP deliveries"
24238 .cindex "TLS" "multiple message deliveries"
24239 For any host that matches this list, a connection on which a TLS session has
24240 been started will not be passed to a new delivery process for sending another
24241 message on the same connection. See section &<<SECTmulmessam>>& for an
24242 explanation of when this might be needed.
24243
24244 .option hosts_noproxy_tls smtp "host list&!!" *
24245 .cindex "TLS" "passing connection"
24246 .cindex "multiple SMTP deliveries"
24247 .cindex "TLS" "multiple message deliveries"
24248 For any host that matches this list, a TLS session which has
24249 been started will not be passed to a new delivery process for sending another
24250 message on the same session.
24251
24252 The traditional implementation closes down TLS and re-starts it in the new
24253 process, on the same open TCP connection, for each successive message
24254 sent.  If permitted by this option a pipe to to the new process is set up
24255 instead, and the original process maintains the TLS connection and proxies
24256 the SMTP connection from and to the new process and any subsequents.
24257 The new process has no access to TLS information, so cannot include it in
24258 logging.
24259
24260
24261
24262 .option hosts_override smtp boolean false
24263 If this option is set and the &%hosts%& option is also set, any hosts that are
24264 attached to the address are ignored, and instead the hosts specified by the
24265 &%hosts%& option are always used. This option does not apply to
24266 &%fallback_hosts%&.
24267
24268
24269 .option hosts_randomize smtp boolean false
24270 .cindex "randomized host list"
24271 .cindex "host" "list of; randomized"
24272 .cindex "fallback" "randomized hosts"
24273 If this option is set, and either the list of hosts is taken from the
24274 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
24275 were not obtained from MX records (this includes fallback hosts from the
24276 router), and were not randomized by the router, the order of trying the hosts
24277 is randomized each time the transport runs. Randomizing the order of a host
24278 list can be used to do crude load sharing.
24279
24280 When &%hosts_randomize%& is true, a host list may be split into groups whose
24281 order is separately randomized. This makes it possible to set up MX-like
24282 behaviour. The boundaries between groups are indicated by an item that is just
24283 &`+`& in the host list. For example:
24284 .code
24285 hosts = host1:host2:host3:+:host4:host5
24286 .endd
24287 The order of the first three hosts and the order of the last two hosts is
24288 randomized for each use, but the first three always end up before the last two.
24289 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
24290
24291 .option hosts_require_auth smtp "host list&!!" unset
24292 .cindex "authentication" "required by client"
24293 This option provides a list of servers for which authentication must succeed
24294 before Exim will try to transfer a message. If authentication fails for
24295 servers which are not in this list, Exim tries to send unauthenticated. If
24296 authentication fails for one of these servers, delivery is deferred. This
24297 temporary error is detectable in the retry rules, so it can be turned into a
24298 hard failure if required. See also &%hosts_try_auth%&, and chapter
24299 &<<CHAPSMTPAUTH>>& for details of authentication.
24300
24301
24302 .option hosts_request_ocsp smtp "host list&!!" *
24303 .cindex "TLS" "requiring for certain servers"
24304 Exim will request a Certificate Status on a
24305 TLS session for any host that matches this list.
24306 &%tls_verify_certificates%& should also be set for the transport.
24307
24308 .new
24309 .option hosts_require_dane smtp "host list&!!" unset
24310 .cindex DANE "transport options"
24311 .cindex DANE "requiring for certain servers"
24312 If built with DANE support, Exim  will require that a DNSSEC-validated
24313 TLSA record is present for any host matching the list,
24314 and that a DANE-verified TLS connection is made.
24315 There will be no fallback to in-clear communication.
24316 See section &<<SECDANE>>&.
24317 .wen
24318
24319 .option hosts_require_ocsp smtp "host list&!!" unset
24320 .cindex "TLS" "requiring for certain servers"
24321 Exim will request, and check for a valid Certificate Status being given, on a
24322 TLS session for any host that matches this list.
24323 &%tls_verify_certificates%& should also be set for the transport.
24324
24325 .option hosts_require_tls smtp "host list&!!" unset
24326 .cindex "TLS" "requiring for certain servers"
24327 Exim will insist on using a TLS session when delivering to any host that
24328 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
24329 &*Note*&: This option affects outgoing mail only. To insist on TLS for
24330 incoming messages, use an appropriate ACL.
24331
24332 .option hosts_try_auth smtp "host list&!!" unset
24333 .cindex "authentication" "optional in client"
24334 This option provides a list of servers to which, provided they announce
24335 authentication support, Exim will attempt to authenticate as a client when it
24336 connects. If authentication fails, Exim will try to transfer the message
24337 unauthenticated. See also &%hosts_require_auth%&, and chapter
24338 &<<CHAPSMTPAUTH>>& for details of authentication.
24339
24340 .option hosts_try_chunking smtp "host list&!!" *
24341 .cindex CHUNKING "enabling, in client"
24342 .cindex BDAT "SMTP command"
24343 .cindex "RFC 3030" "CHUNKING"
24344 This option provides a list of servers to which, provided they announce
24345 CHUNKING support, Exim will attempt to use BDAT commands rather than DATA.
24346 BDAT will not be used in conjunction with a transport filter.
24347
24348 .new
24349 .option hosts_try_dane smtp "host list&!!" unset
24350 .cindex DANE "transport options"
24351 .cindex DANE "attempting for certain servers"
24352 If built with DANE support, Exim  will lookup a
24353 TLSA record for any host matching the list.
24354 If found and verified by DNSSEC,
24355 a DANE-verified TLS connection is made to that host;
24356 there will be no fallback to in-clear communication.
24357 See section &<<SECDANE>>&.
24358 .wen
24359
24360 .option hosts_try_fastopen smtp "host list&!!" unset
24361 .cindex "fast open, TCP" "enabling, in client"
24362 .cindex "TCP Fast Open" "enabling, in client"
24363 .cindex "RFC 7413" "TCP Fast Open"
24364 This option provides a list of servers to which, provided
24365 the facility is supported by this system, Exim will attempt to
24366 perform a TCP Fast Open.
24367 No data is sent on the SYN segment but, if the remote server also
24368 supports the facility, it can send its SMTP banner immediately after
24369 the SYN,ACK segment.  This can save up to one round-trip time.
24370
24371 The facility is only active for previously-contacted servers,
24372 as the initiator must present a cookie in the SYN segment.
24373
24374 On (at least some) current Linux distributions the facility must be enabled
24375 in the kernel by the sysadmin before the support is usable.
24376 There is no option for control of the server side; if the system supports
24377 it it is always enabled.  Note that lengthy operations in the connect ACL,
24378 such as DNSBL lookups, will still delay the emission of the SMTP banner.
24379
24380 .option hosts_try_prdr smtp "host list&!!" *
24381 .cindex "PRDR" "enabling, optional in client"
24382 This option provides a list of servers to which, provided they announce
24383 PRDR support, Exim will attempt to negotiate PRDR
24384 for multi-recipient messages.
24385 The option can usually be left as default.
24386
24387 .option interface smtp "string list&!!" unset
24388 .cindex "bind IP address"
24389 .cindex "IP address" "binding"
24390 .vindex "&$host$&"
24391 .vindex "&$host_address$&"
24392 This option specifies which interface to bind to when making an outgoing SMTP
24393 call. The value is an IP address, not an interface name such as
24394 &`eth0`&. Do not confuse this with the interface address that was used when a
24395 message was received, which is in &$received_ip_address$&, formerly known as
24396 &$interface_address$&. The name was changed to minimize confusion with the
24397 outgoing interface address. There is no variable that contains an outgoing
24398 interface address because, unless it is set by this option, its value is
24399 unknown.
24400
24401 During the expansion of the &%interface%& option the variables &$host$& and
24402 &$host_address$& refer to the host to which a connection is about to be made
24403 during the expansion of the string. Forced expansion failure, or an empty
24404 string result causes the option to be ignored. Otherwise, after expansion, the
24405 string must be a list of IP addresses, colon-separated by default, but the
24406 separator can be changed in the usual way. For example:
24407 .code
24408 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
24409 .endd
24410 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
24411 connection. If none of them are the correct type, the option is ignored. If
24412 &%interface%& is not set, or is ignored, the system's IP functions choose which
24413 interface to use if the host has more than one.
24414
24415
24416 .option keepalive smtp boolean true
24417 .cindex "keepalive" "on outgoing connection"
24418 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
24419 connections. When set, it causes the kernel to probe idle connections
24420 periodically, by sending packets with &"old"& sequence numbers. The other end
24421 of the connection should send a acknowledgment if the connection is still okay
24422 or a reset if the connection has been aborted. The reason for doing this is
24423 that it has the beneficial effect of freeing up certain types of connection
24424 that can get stuck when the remote host is disconnected without tidying up the
24425 TCP/IP call properly. The keepalive mechanism takes several hours to detect
24426 unreachable hosts.
24427
24428
24429 .option lmtp_ignore_quota smtp boolean false
24430 .cindex "LMTP" "ignoring quota errors"
24431 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
24432 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
24433 has advertised support for IGNOREQUOTA in its response to the LHLO command.
24434
24435 .option max_rcpt smtp integer 100
24436 .cindex "RCPT" "maximum number of outgoing"
24437 This option limits the number of RCPT commands that are sent in a single
24438 SMTP message transaction. Each set of addresses is treated independently, and
24439 so can cause parallel connections to the same host if &%remote_max_parallel%&
24440 permits this.
24441
24442
24443 .option multi_domain smtp boolean&!! true
24444 .vindex "&$domain$&"
24445 When this option is set, the &(smtp)& transport can handle a number of
24446 addresses containing a mixture of different domains provided they all resolve
24447 to the same list of hosts. Turning the option off restricts the transport to
24448 handling only one domain at a time. This is useful if you want to use
24449 &$domain$& in an expansion for the transport, because it is set only when there
24450 is a single domain involved in a remote delivery.
24451
24452 It is expanded per-address and can depend on any of
24453 &$address_data$&, &$domain_data$&, &$local_part_data$&,
24454 &$host$&, &$host_address$& and &$host_port$&.
24455
24456 .option port smtp string&!! "see below"
24457 .cindex "port" "sending TCP/IP"
24458 .cindex "TCP/IP" "setting outgoing port"
24459 This option specifies the TCP/IP port on the server to which Exim connects.
24460 &*Note:*& Do not confuse this with the port that was used when a message was
24461 received, which is in &$received_port$&, formerly known as &$interface_port$&.
24462 The name was changed to minimize confusion with the outgoing port. There is no
24463 variable that contains an outgoing port.
24464
24465 If the value of this option begins with a digit it is taken as a port number;
24466 otherwise it is looked up using &[getservbyname()]&. The default value is
24467 normally &"smtp"&, but if &%protocol%& is set to &"lmtp"&, the default is
24468 &"lmtp"&. If the expansion fails, or if a port number cannot be found, delivery
24469 is deferred.
24470
24471
24472
24473 .option protocol smtp string smtp
24474 .cindex "LMTP" "over TCP/IP"
24475 .cindex "ssmtp protocol" "outbound"
24476 .cindex "TLS" "SSL-on-connect outbound"
24477 .vindex "&$port$&"
24478 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
24479 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
24480 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
24481 deliveries into closed message stores. Exim also has support for running LMTP
24482 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
24483
24484 If this option is set to &"smtps"&, the default value for the &%port%& option
24485 changes to &"smtps"&, and the transport initiates TLS immediately after
24486 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
24487 The Internet standards bodies strongly discourage use of this mode.
24488
24489
24490 .option retry_include_ip_address smtp boolean&!! true
24491 Exim normally includes both the host name and the IP address in the key it
24492 constructs for indexing retry data after a temporary delivery failure. This
24493 means that when one of several IP addresses for a host is failing, it gets
24494 tried periodically (controlled by the retry rules), but use of the other IP
24495 addresses is not affected.
24496
24497 However, in some dialup environments hosts are assigned a different IP address
24498 each time they connect. In this situation the use of the IP address as part of
24499 the retry key leads to undesirable behaviour. Setting this option false causes
24500 Exim to use only the host name.
24501 Since it is expanded it can be made to depend on the host or domain.
24502
24503
24504 .option serialize_hosts smtp "host list&!!" unset
24505 .cindex "serializing connections"
24506 .cindex "host" "serializing connections"
24507 Because Exim operates in a distributed manner, if several messages for the same
24508 host arrive at around the same time, more than one simultaneous connection to
24509 the remote host can occur. This is not usually a problem except when there is a
24510 slow link between the hosts. In that situation it may be helpful to restrict
24511 Exim to one connection at a time. This can be done by setting
24512 &%serialize_hosts%& to match the relevant hosts.
24513
24514 .cindex "hints database" "serializing deliveries to a host"
24515 Exim implements serialization by means of a hints database in which a record is
24516 written whenever a process connects to one of the restricted hosts. The record
24517 is deleted when the connection is completed. Obviously there is scope for
24518 records to get left lying around if there is a system or program crash. To
24519 guard against this, Exim ignores any records that are more than six hours old.
24520
24521 If you set up this kind of serialization, you should also arrange to delete the
24522 relevant hints database whenever your system reboots. The names of the files
24523 start with &_misc_& and they are kept in the &_spool/db_& directory. There
24524 may be one or two files, depending on the type of DBM in use. The same files
24525 are used for ETRN serialization.
24526
24527 See also the &%max_parallel%& generic transport option.
24528
24529
24530 .option size_addition smtp integer 1024
24531 .cindex "SMTP" "SIZE"
24532 .cindex "message" "size issue for transport filter"
24533 .cindex "size" "of message"
24534 .cindex "transport" "filter"
24535 .cindex "filter" "transport filter"
24536 If a remote SMTP server indicates that it supports the SIZE option of the
24537 MAIL command, Exim uses this to pass over the message size at the start of
24538 an SMTP transaction. It adds the value of &%size_addition%& to the value it
24539 sends, to allow for headers and other text that may be added during delivery by
24540 configuration options or in a transport filter. It may be necessary to increase
24541 this if a lot of text is added to messages.
24542
24543 Alternatively, if the value of &%size_addition%& is set negative, it disables
24544 the use of the SIZE option altogether.
24545
24546
24547 .option socks_proxy smtp string&!! unset
24548 .cindex proxy SOCKS
24549 This option enables use of SOCKS proxies for connections made by the
24550 transport.  For details see section &<<SECTproxySOCKS>>&.
24551
24552
24553 .option tls_certificate smtp string&!! unset
24554 .cindex "TLS" "client certificate, location of"
24555 .cindex "certificate" "client, location of"
24556 .vindex "&$host$&"
24557 .vindex "&$host_address$&"
24558 The value of this option must be the absolute path to a file which contains the
24559 client's certificate, for possible use when sending a message over an encrypted
24560 connection. The values of &$host$& and &$host_address$& are set to the name and
24561 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
24562 details of TLS.
24563
24564 &*Note*&: This option must be set if you want Exim to be able to use a TLS
24565 certificate when sending messages as a client. The global option of the same
24566 name specifies the certificate for Exim as a server; it is not automatically
24567 assumed that the same certificate should be used when Exim is operating as a
24568 client.
24569
24570
24571 .option tls_crl smtp string&!! unset
24572 .cindex "TLS" "client certificate revocation list"
24573 .cindex "certificate" "revocation list for client"
24574 This option specifies a certificate revocation list. The expanded value must
24575 be the name of a file that contains a CRL in PEM format.
24576
24577
24578 .option tls_dh_min_bits smtp integer 1024
24579 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
24580 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
24581 key agreement is negotiated, the server will provide a large prime number
24582 for use.  This option establishes the minimum acceptable size of that number.
24583 If the parameter offered by the server is too small, then the TLS handshake
24584 will fail.
24585
24586 Only supported when using GnuTLS.
24587
24588
24589 .option tls_privatekey smtp string&!! unset
24590 .cindex "TLS" "client private key, location of"
24591 .vindex "&$host$&"
24592 .vindex "&$host_address$&"
24593 The value of this option must be the absolute path to a file which contains the
24594 client's private key. This is used when sending a message over an encrypted
24595 connection using a client certificate. The values of &$host$& and
24596 &$host_address$& are set to the name and address of the server during the
24597 expansion. If this option is unset, or the expansion is forced to fail, or the
24598 result is an empty string, the private key is assumed to be in the same file as
24599 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
24600
24601
24602 .option tls_require_ciphers smtp string&!! unset
24603 .cindex "TLS" "requiring specific ciphers"
24604 .cindex "cipher" "requiring specific"
24605 .vindex "&$host$&"
24606 .vindex "&$host_address$&"
24607 The value of this option must be a list of permitted cipher suites, for use
24608 when setting up an outgoing encrypted connection. (There is a global option of
24609 the same name for controlling incoming connections.) The values of &$host$& and
24610 &$host_address$& are set to the name and address of the server during the
24611 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
24612 is used in different ways by OpenSSL and GnuTLS (see sections
24613 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
24614 ciphers is a preference order.
24615
24616
24617
24618 .option tls_sni smtp string&!! unset
24619 .cindex "TLS" "Server Name Indication"
24620 .vindex "&$tls_sni$&"
24621 If this option is set then it sets the $tls_out_sni variable and causes any
24622 TLS session to pass this value as the Server Name Indication extension to
24623 the remote side, which can be used by the remote side to select an appropriate
24624 certificate and private key for the session.
24625
24626 See &<<SECTtlssni>>& for more information.
24627
24628 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
24629 TLS extensions.
24630
24631
24632
24633
24634 .option tls_tempfail_tryclear smtp boolean true
24635 .cindex "4&'xx'& responses" "to STARTTLS"
24636 When the server host is not in &%hosts_require_tls%&, and there is a problem in
24637 setting up a TLS session, this option determines whether or not Exim should try
24638 to deliver the message unencrypted. If it is set false, delivery to the
24639 current host is deferred; if there are other hosts, they are tried. If this
24640 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
24641 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
24642 TLS negotiation fails, Exim closes the current connection (because it is in an
24643 unknown state), opens a new one to the same host, and then tries the delivery
24644 in clear.
24645
24646
24647 .option tls_try_verify_hosts smtp "host list&!!" *
24648 .cindex "TLS" "server certificate verification"
24649 .cindex "certificate" "verification of server"
24650 This option gives a list of hosts for which, on encrypted connections,
24651 certificate verification will be tried but need not succeed.
24652 The &%tls_verify_certificates%& option must also be set.
24653 Note that unless the host is in this list
24654 TLS connections will be denied to hosts using self-signed certificates
24655 when &%tls_verify_certificates%& is matched.
24656 The &$tls_out_certificate_verified$& variable is set when
24657 certificate verification succeeds.
24658
24659
24660 .option tls_verify_cert_hostnames smtp "host list&!!" *
24661 .cindex "TLS" "server certificate hostname verification"
24662 .cindex "certificate" "verification of server"
24663 This option give a list of hosts for which,
24664 while verifying the server certificate,
24665 checks will be included on the host name
24666 (note that this will generally be the result of a DNS MX lookup)
24667 versus Subject and Subject-Alternate-Name fields.  Wildcard names are permitted
24668 limited to being the initial component of a 3-or-more component FQDN.
24669
24670 There is no equivalent checking on client certificates.
24671
24672
24673 .option tls_verify_certificates smtp string&!! system
24674 .cindex "TLS" "server certificate verification"
24675 .cindex "certificate" "verification of server"
24676 .vindex "&$host$&"
24677 .vindex "&$host_address$&"
24678 The value of this option must be either the
24679 word "system"
24680 or the absolute path to
24681 a file or directory containing permitted certificates for servers,
24682 for use when setting up an encrypted connection.
24683
24684 The "system" value for the option will use a location compiled into the SSL library.
24685 This is not available for GnuTLS versions preceding 3.0.20; a value of "system"
24686 is taken as empty and an explicit location
24687 must be specified.
24688
24689 The use of a directory for the option value is not available for GnuTLS versions
24690 preceding 3.3.6 and a single file must be used.
24691
24692 With OpenSSL the certificates specified
24693 explicitly
24694 either by file or directory
24695 are added to those given by the system default location.
24696
24697 The values of &$host$& and
24698 &$host_address$& are set to the name and address of the server during the
24699 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
24700
24701 For back-compatibility,
24702 if neither tls_verify_hosts nor tls_try_verify_hosts are set
24703 (a single-colon empty list counts as being set)
24704 and certificate verification fails the TLS connection is closed.
24705
24706
24707 .option tls_verify_hosts smtp "host list&!!" unset
24708 .cindex "TLS" "server certificate verification"
24709 .cindex "certificate" "verification of server"
24710 This option gives a list of hosts for which, on encrypted connections,
24711 certificate verification must succeed.
24712 The &%tls_verify_certificates%& option must also be set.
24713 If both this option and &%tls_try_verify_hosts%& are unset
24714 operation is as if this option selected all hosts.
24715
24716
24717
24718
24719 .section "How the limits for the number of hosts to try are used" &&&
24720          "SECTvalhosmax"
24721 .cindex "host" "maximum number to try"
24722 .cindex "limit" "hosts; maximum number tried"
24723 There are two options that are concerned with the number of hosts that are
24724 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
24725 &%hosts_max_try_hardlimit%&.
24726
24727
24728 The &%hosts_max_try%& option limits the number of hosts that are tried
24729 for a single delivery. However, despite the term &"host"& in its name, the
24730 option actually applies to each IP address independently. In other words, a
24731 multihomed host is treated as several independent hosts, just as it is for
24732 retrying.
24733
24734 Many of the larger ISPs have multiple MX records which often point to
24735 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
24736 created as a result of routing one of these domains.
24737
24738 Trying every single IP address on such a long list does not seem sensible; if
24739 several at the top of the list fail, it is reasonable to assume there is some
24740 problem that is likely to affect all of them. Roughly speaking, the value of
24741 &%hosts_max_try%& is the maximum number that are tried before deferring the
24742 delivery. However, the logic cannot be quite that simple.
24743
24744 Firstly, IP addresses that are skipped because their retry times have not
24745 arrived do not count, and in addition, addresses that are past their retry
24746 limits are also not counted, even when they are tried. This means that when
24747 some IP addresses are past their retry limits, more than the value of
24748 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
24749 that all IP addresses are considered before timing out an email address (but
24750 see below for an exception).
24751
24752 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
24753 list to see if there is a subsequent host with a different (higher valued) MX.
24754 If there is, that host is considered next, and the current IP address is used
24755 but not counted. This behaviour helps in the case of a domain with a retry rule
24756 that hardly ever delays any hosts, as is now explained:
24757
24758 Consider the case of a long list of hosts with one MX value, and a few with a
24759 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
24760 hosts at the top of the list are tried at first. With the default retry rule,
24761 which specifies increasing retry times, the higher MX hosts are eventually
24762 tried when those at the top of the list are skipped because they have not
24763 reached their retry times.
24764
24765 However, it is common practice to put a fixed short retry time on domains for
24766 large ISPs, on the grounds that their servers are rarely down for very long.
24767 Unfortunately, these are exactly the domains that tend to resolve to long lists
24768 of hosts. The short retry time means that the lowest MX hosts are tried every
24769 time. The attempts may be in a different order because of random sorting, but
24770 without the special MX check, the higher MX hosts would never be tried until
24771 all the lower MX hosts had timed out (which might be several days), because
24772 there are always some lower MX hosts that have reached their retry times. With
24773 the special check, Exim considers at least one IP address from each MX value at
24774 every delivery attempt, even if the &%hosts_max_try%& limit has already been
24775 reached.
24776
24777 The above logic means that &%hosts_max_try%& is not a hard limit, and in
24778 particular, Exim normally eventually tries all the IP addresses before timing
24779 out an email address. When &%hosts_max_try%& was implemented, this seemed a
24780 reasonable thing to do. Recently, however, some lunatic DNS configurations have
24781 been set up with hundreds of IP addresses for some domains. It can
24782 take a very long time indeed for an address to time out in these cases.
24783
24784 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
24785 Exim never tries more than this number of IP addresses; if it hits this limit
24786 and they are all timed out, the email address is bounced, even though not all
24787 possible IP addresses have been tried.
24788 .ecindex IIDsmttra1
24789 .ecindex IIDsmttra2
24790
24791
24792
24793
24794
24795 . ////////////////////////////////////////////////////////////////////////////
24796 . ////////////////////////////////////////////////////////////////////////////
24797
24798 .chapter "Address rewriting" "CHAPrewrite"
24799 .scindex IIDaddrew "rewriting" "addresses"
24800 There are some circumstances in which Exim automatically rewrites domains in
24801 addresses. The two most common are when an address is given without a domain
24802 (referred to as an &"unqualified address"&) or when an address contains an
24803 abbreviated domain that is expanded by DNS lookup.
24804
24805 Unqualified envelope addresses are accepted only for locally submitted
24806 messages, or for messages that are received from hosts matching
24807 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
24808 appropriate. Unqualified addresses in header lines are qualified if they are in
24809 locally submitted messages, or messages from hosts that are permitted to send
24810 unqualified envelope addresses. Otherwise, unqualified addresses in header
24811 lines are neither qualified nor rewritten.
24812
24813 One situation in which Exim does &'not'& automatically rewrite a domain is
24814 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
24815 such a domain should be rewritten using the &"canonical"& name, and some MTAs
24816 do this. The new RFCs do not contain this suggestion.
24817
24818
24819 .section "Explicitly configured address rewriting" "SECID147"
24820 This chapter describes the rewriting rules that can be used in the
24821 main rewrite section of the configuration file, and also in the generic
24822 &%headers_rewrite%& option that can be set on any transport.
24823
24824 Some people believe that configured address rewriting is a Mortal Sin.
24825 Others believe that life is not possible without it. Exim provides the
24826 facility; you do not have to use it.
24827
24828 The main rewriting rules that appear in the &"rewrite"& section of the
24829 configuration file are applied to addresses in incoming messages, both envelope
24830 addresses and addresses in header lines. Each rule specifies the types of
24831 address to which it applies.
24832
24833 Whether or not addresses in header lines are rewritten depends on the origin of
24834 the headers and the type of rewriting. Global rewriting, that is, rewriting
24835 rules from the rewrite section of the configuration file, is applied only to
24836 those headers that were received with the message. Header lines that are added
24837 by ACLs or by a system filter or by individual routers or transports (which
24838 are specific to individual recipient addresses) are not rewritten by the global
24839 rules.
24840
24841 Rewriting at transport time, by means of the &%headers_rewrite%& option,
24842 applies all headers except those added by routers and transports. That is, as
24843 well as the headers that were received with the message, it also applies to
24844 headers that were added by an ACL or a system filter.
24845
24846
24847 In general, rewriting addresses from your own system or domain has some
24848 legitimacy. Rewriting other addresses should be done only with great care and
24849 in special circumstances. The author of Exim believes that rewriting should be
24850 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
24851 Although it can sometimes be used as a routing tool, this is very strongly
24852 discouraged.
24853
24854 There are two commonly encountered circumstances where rewriting is used, as
24855 illustrated by these examples:
24856
24857 .ilist
24858 The company whose domain is &'hitch.fict.example'& has a number of hosts that
24859 exchange mail with each other behind a firewall, but there is only a single
24860 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
24861 &'hitch.fict.example'& when sending mail off-site.
24862 .next
24863 A host rewrites the local parts of its own users so that, for example,
24864 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
24865 .endlist
24866
24867
24868
24869 .section "When does rewriting happen?" "SECID148"
24870 .cindex "rewriting" "timing of"
24871 .cindex "&ACL;" "rewriting addresses in"
24872 Configured address rewriting can take place at several different stages of a
24873 message's processing.
24874
24875 .vindex "&$sender_address$&"
24876 At the start of an ACL for MAIL, the sender address may have been rewritten
24877 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
24878 ordinary rewrite rules have yet been applied. If, however, the sender address
24879 is verified in the ACL, it is rewritten before verification, and remains
24880 rewritten thereafter. The subsequent value of &$sender_address$& is the
24881 rewritten address. This also applies if sender verification happens in a
24882 RCPT ACL. Otherwise, when the sender address is not verified, it is
24883 rewritten as soon as a message's header lines have been received.
24884
24885 .vindex "&$domain$&"
24886 .vindex "&$local_part$&"
24887 Similarly, at the start of an ACL for RCPT, the current recipient's address
24888 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
24889 rewrite rules have yet been applied to it. However, the behaviour is different
24890 from the sender address when a recipient is verified. The address is rewritten
24891 for the verification, but the rewriting is not remembered at this stage. The
24892 value of &$local_part$& and &$domain$& after verification are always the same
24893 as they were before (that is, they contain the unrewritten &-- except for
24894 SMTP-time rewriting &-- address).
24895
24896 As soon as a message's header lines have been received, all the envelope
24897 recipient addresses are permanently rewritten, and rewriting is also applied to
24898 the addresses in the header lines (if configured). This happens before adding
24899 any header lines that were specified in MAIL or RCPT ACLs, and
24900 .cindex "&[local_scan()]& function" "address rewriting; timing of"
24901 before the DATA ACL and &[local_scan()]& functions are run.
24902
24903 When an address is being routed, either for delivery or for verification,
24904 rewriting is applied immediately to child addresses that are generated by
24905 redirection, unless &%no_rewrite%& is set on the router.
24906
24907 .cindex "envelope sender" "rewriting at transport time"
24908 .cindex "rewriting" "at transport time"
24909 .cindex "header lines" "rewriting at transport time"
24910 At transport time, additional rewriting of addresses in header lines can be
24911 specified by setting the generic &%headers_rewrite%& option on a transport.
24912 This option contains rules that are identical in form to those in the rewrite
24913 section of the configuration file. They are applied to the original message
24914 header lines and any that were added by ACLs or a system filter. They are not
24915 applied to header lines that are added by routers or the transport.
24916
24917 The outgoing envelope sender can be rewritten by means of the &%return_path%&
24918 transport option. However, it is not possible to rewrite envelope recipients at
24919 transport time.
24920
24921
24922
24923
24924 .section "Testing the rewriting rules that apply on input" "SECID149"
24925 .cindex "rewriting" "testing"
24926 .cindex "testing" "rewriting"
24927 Exim's input rewriting configuration appears in a part of the run time
24928 configuration file headed by &"begin rewrite"&. It can be tested by the
24929 &%-brw%& command line option. This takes an address (which can be a full RFC
24930 2822 address) as its argument. The output is a list of how the address would be
24931 transformed by the rewriting rules for each of the different places it might
24932 appear in an incoming message, that is, for each different header and for the
24933 envelope sender and recipient fields. For example,
24934 .code
24935 exim -brw ph10@exim.workshop.example
24936 .endd
24937 might produce the output
24938 .code
24939 sender: Philip.Hazel@exim.workshop.example
24940 from: Philip.Hazel@exim.workshop.example
24941 to: ph10@exim.workshop.example
24942 cc: ph10@exim.workshop.example
24943 bcc: ph10@exim.workshop.example
24944 reply-to: Philip.Hazel@exim.workshop.example
24945 env-from: Philip.Hazel@exim.workshop.example
24946 env-to: ph10@exim.workshop.example
24947 .endd
24948 which shows that rewriting has been set up for that address when used in any of
24949 the source fields, but not when it appears as a recipient address. At the
24950 present time, there is no equivalent way of testing rewriting rules that are
24951 set for a particular transport.
24952
24953
24954 .section "Rewriting rules" "SECID150"
24955 .cindex "rewriting" "rules"
24956 The rewrite section of the configuration file consists of lines of rewriting
24957 rules in the form
24958 .display
24959 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
24960 .endd
24961 Rewriting rules that are specified for the &%headers_rewrite%& generic
24962 transport option are given as a colon-separated list. Each item in the list
24963 takes the same form as a line in the main rewriting configuration (except that
24964 any colons must be doubled, of course).
24965
24966 The formats of source patterns and replacement strings are described below.
24967 Each is terminated by white space, unless enclosed in double quotes, in which
24968 case normal quoting conventions apply inside the quotes. The flags are single
24969 characters which may appear in any order. Spaces and tabs between them are
24970 ignored.
24971
24972 For each address that could potentially be rewritten, the rules are scanned in
24973 order, and replacements for the address from earlier rules can themselves be
24974 replaced by later rules (but see the &"q"& and &"R"& flags).
24975
24976 The order in which addresses are rewritten is undefined, may change between
24977 releases, and must not be relied on, with one exception: when a message is
24978 received, the envelope sender is always rewritten first, before any header
24979 lines are rewritten. For example, the replacement string for a rewrite of an
24980 address in &'To:'& must not assume that the message's address in &'From:'& has
24981 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
24982 that the envelope sender has already been rewritten.
24983
24984 .vindex "&$domain$&"
24985 .vindex "&$local_part$&"
24986 The variables &$local_part$& and &$domain$& can be used in the replacement
24987 string to refer to the address that is being rewritten. Note that lookup-driven
24988 rewriting can be done by a rule of the form
24989 .code
24990 *@*   ${lookup ...
24991 .endd
24992 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
24993 refer to the address that is being rewritten.
24994
24995
24996 .section "Rewriting patterns" "SECID151"
24997 .cindex "rewriting" "patterns"
24998 .cindex "address list" "in a rewriting pattern"
24999 The source pattern in a rewriting rule is any item which may appear in an
25000 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
25001 single-item address list, which means that it is expanded before being tested
25002 against the address. As always, if you use a regular expression as a pattern,
25003 you must take care to escape dollar and backslash characters, or use the &`\N`&
25004 facility to suppress string expansion within the regular expression.
25005
25006 Domains in patterns should be given in lower case. Local parts in patterns are
25007 case-sensitive. If you want to do case-insensitive matching of local parts, you
25008 can use a regular expression that starts with &`^(?i)`&.
25009
25010 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
25011 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
25012 depending on the type of match which occurred. These can be used in the
25013 replacement string to insert portions of the incoming address. &$0$& always
25014 refers to the complete incoming address. When a regular expression is used, the
25015 numerical variables are set from its capturing subexpressions. For other types
25016 of pattern they are set as follows:
25017
25018 .ilist
25019 If a local part or domain starts with an asterisk, the numerical variables
25020 refer to the character strings matched by asterisks, with &$1$& associated with
25021 the first asterisk, and &$2$& with the second, if present. For example, if the
25022 pattern
25023 .code
25024 *queen@*.fict.example
25025 .endd
25026 is matched against the address &'hearts-queen@wonderland.fict.example'& then
25027 .code
25028 $0 = hearts-queen@wonderland.fict.example
25029 $1 = hearts-
25030 $2 = wonderland
25031 .endd
25032 Note that if the local part does not start with an asterisk, but the domain
25033 does, it is &$1$& that contains the wild part of the domain.
25034
25035 .next
25036 If the domain part of the pattern is a partial lookup, the wild and fixed parts
25037 of the domain are placed in the next available numerical variables. Suppose,
25038 for example, that the address &'foo@bar.baz.example'& is processed by a
25039 rewriting rule of the form
25040 .display
25041 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
25042 .endd
25043 and the key in the file that matches the domain is &`*.baz.example`&. Then
25044 .code
25045 $1 = foo
25046 $2 = bar
25047 $3 = baz.example
25048 .endd
25049 If the address &'foo@baz.example'& is looked up, this matches the same
25050 wildcard file entry, and in this case &$2$& is set to the empty string, but
25051 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
25052 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
25053 whole domain. For non-partial domain lookups, no numerical variables are set.
25054 .endlist
25055
25056
25057 .section "Rewriting replacements" "SECID152"
25058 .cindex "rewriting" "replacements"
25059 If the replacement string for a rule is a single asterisk, addresses that
25060 match the pattern and the flags are &'not'& rewritten, and no subsequent
25061 rewriting rules are scanned. For example,
25062 .code
25063 hatta@lookingglass.fict.example  *  f
25064 .endd
25065 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
25066 &'From:'& headers.
25067
25068 .vindex "&$domain$&"
25069 .vindex "&$local_part$&"
25070 If the replacement string is not a single asterisk, it is expanded, and must
25071 yield a fully qualified address. Within the expansion, the variables
25072 &$local_part$& and &$domain$& refer to the address that is being rewritten.
25073 Any letters they contain retain their original case &-- they are not lower
25074 cased. The numerical variables are set up according to the type of pattern that
25075 matched the address, as described above. If the expansion is forced to fail by
25076 the presence of &"fail"& in a conditional or lookup item, rewriting by the
25077 current rule is abandoned, but subsequent rules may take effect. Any other
25078 expansion failure causes the entire rewriting operation to be abandoned, and an
25079 entry written to the panic log.
25080
25081
25082
25083 .section "Rewriting flags" "SECID153"
25084 There are three different kinds of flag that may appear on rewriting rules:
25085
25086 .ilist
25087 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
25088 c, f, h, r, s, t.
25089 .next
25090 A flag that specifies rewriting at SMTP time: S.
25091 .next
25092 Flags that control the rewriting process: Q, q, R, w.
25093 .endlist
25094
25095 For rules that are part of the &%headers_rewrite%& generic transport option,
25096 E, F, T, and S are not permitted.
25097
25098
25099
25100 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
25101          "SECID154"
25102 .cindex "rewriting" "flags"
25103 If none of the following flag letters, nor the &"S"& flag (see section
25104 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
25105 and to both the sender and recipient fields of the envelope, whereas a
25106 transport-time rewriting rule just applies to all headers. Otherwise, the
25107 rewriting rule is skipped unless the relevant addresses are being processed.
25108 .display
25109 &`E`&       rewrite all envelope fields
25110 &`F`&       rewrite the envelope From field
25111 &`T`&       rewrite the envelope To field
25112 &`b`&       rewrite the &'Bcc:'& header
25113 &`c`&       rewrite the &'Cc:'& header
25114 &`f`&       rewrite the &'From:'& header
25115 &`h`&       rewrite all headers
25116 &`r`&       rewrite the &'Reply-To:'& header
25117 &`s`&       rewrite the &'Sender:'& header
25118 &`t`&       rewrite the &'To:'& header
25119 .endd
25120 "All headers" means all of the headers listed above that can be selected
25121 individually, plus their &'Resent-'& versions. It does not include
25122 other headers such as &'Subject:'& etc.
25123
25124 You should be particularly careful about rewriting &'Sender:'& headers, and
25125 restrict this to special known cases in your own domains.
25126
25127
25128 .section "The SMTP-time rewriting flag" "SECTrewriteS"
25129 .cindex "SMTP" "rewriting malformed addresses"
25130 .cindex "RCPT" "rewriting argument of"
25131 .cindex "MAIL" "rewriting argument of"
25132 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
25133 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
25134 before any other processing; even before syntax checking. The pattern is
25135 required to be a regular expression, and it is matched against the whole of the
25136 data for the command, including any surrounding angle brackets.
25137
25138 .vindex "&$domain$&"
25139 .vindex "&$local_part$&"
25140 This form of rewrite rule allows for the handling of addresses that are not
25141 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
25142 input). Because the input is not required to be a syntactically valid address,
25143 the variables &$local_part$& and &$domain$& are not available during the
25144 expansion of the replacement string. The result of rewriting replaces the
25145 original address in the MAIL or RCPT command.
25146
25147
25148 .section "Flags controlling the rewriting process" "SECID155"
25149 There are four flags which control the way the rewriting process works. These
25150 take effect only when a rule is invoked, that is, when the address is of the
25151 correct type (matches the flags) and matches the pattern:
25152
25153 .ilist
25154 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
25155 unqualified local part. It is qualified with &%qualify_recipient%&. In the
25156 absence of &"Q"& the rewritten address must always include a domain.
25157 .next
25158 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
25159 even if no rewriting actually takes place because of a &"fail"& in the
25160 expansion. The &"q"& flag is not effective if the address is of the wrong type
25161 (does not match the flags) or does not match the pattern.
25162 .next
25163 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
25164 address, up to ten times. It can be combined with the &"q"& flag, to stop
25165 rewriting once it fails to match (after at least one successful rewrite).
25166 .next
25167 .cindex "rewriting" "whole addresses"
25168 When an address in a header is rewritten, the rewriting normally applies only
25169 to the working part of the address, with any comments and RFC 2822 &"phrase"&
25170 left unchanged. For example, rewriting might change
25171 .code
25172 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
25173 .endd
25174 into
25175 .code
25176 From: Ford Prefect <prefectf@hitch.fict.example>
25177 .endd
25178 .cindex "RFC 2047"
25179 Sometimes there is a need to replace the whole address item, and this can be
25180 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
25181 causes an address in a header line to be rewritten, the entire address is
25182 replaced, not just the working part. The replacement must be a complete RFC
25183 2822 address, including the angle brackets if necessary. If text outside angle
25184 brackets contains a character whose value is greater than 126 or less than 32
25185 (except for tab), the text is encoded according to RFC 2047. The character set
25186 is taken from &%headers_charset%&, which gets its default at build time.
25187
25188 When the &"w"& flag is set on a rule that causes an envelope address to be
25189 rewritten, all but the working part of the replacement address is discarded.
25190 .endlist
25191
25192
25193 .section "Rewriting examples" "SECID156"
25194 Here is an example of the two common rewriting paradigms:
25195 .code
25196 *@*.hitch.fict.example  $1@hitch.fict.example
25197 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
25198                      {$value}fail}@hitch.fict.example bctfrF
25199 .endd
25200 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
25201 the string expansion to fail if the lookup does not succeed. In this context it
25202 has the effect of leaving the original address unchanged, but Exim goes on to
25203 consider subsequent rewriting rules, if any, because the &"q"& flag is not
25204 present in that rule. An alternative to &"fail"& would be to supply &$1$&
25205 explicitly, which would cause the rewritten address to be the same as before,
25206 at the cost of a small bit of processing. Not supplying either of these is an
25207 error, since the rewritten address would then contain no local part.
25208
25209 The first example above replaces the domain with a superior, more general
25210 domain. This may not be desirable for certain local parts. If the rule
25211 .code
25212 root@*.hitch.fict.example  *
25213 .endd
25214 were inserted before the first rule, rewriting would be suppressed for the
25215 local part &'root'& at any domain ending in &'hitch.fict.example'&.
25216
25217 Rewriting can be made conditional on a number of tests, by making use of
25218 &${if$& in the expansion item. For example, to apply a rewriting rule only to
25219 messages that originate outside the local host:
25220 .code
25221 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
25222                          {$1@hitch.fict.example}fail}"
25223 .endd
25224 The replacement string is quoted in this example because it contains white
25225 space.
25226
25227 .cindex "rewriting" "bang paths"
25228 .cindex "bang paths" "rewriting"
25229 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
25230 an address it treats it as an unqualified local part which it qualifies with
25231 the local qualification domain (if the source of the message is local or if the
25232 remote host is permitted to send unqualified addresses). Rewriting can
25233 sometimes be used to handle simple bang paths with a fixed number of
25234 components. For example, the rule
25235 .code
25236 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
25237 .endd
25238 rewrites a two-component bang path &'host.name!user'& as the domain address
25239 &'user@host.name'&. However, there is a security implication in using this as
25240 a global rewriting rule for envelope addresses. It can provide a backdoor
25241 method for using your system as a relay, because the incoming addresses appear
25242 to be local. If the bang path addresses are received via SMTP, it is safer to
25243 use the &"S"& flag to rewrite them as they are received, so that relay checking
25244 can be done on the rewritten addresses.
25245 .ecindex IIDaddrew
25246
25247
25248
25249
25250
25251 . ////////////////////////////////////////////////////////////////////////////
25252 . ////////////////////////////////////////////////////////////////////////////
25253
25254 .chapter "Retry configuration" "CHAPretry"
25255 .scindex IIDretconf1 "retry" "configuration, description of"
25256 .scindex IIDregconf2 "configuration file" "retry section"
25257 The &"retry"& section of the runtime configuration file contains a list of
25258 retry rules that control how often Exim tries to deliver messages that cannot
25259 be delivered at the first attempt. If there are no retry rules (the section is
25260 empty or not present), there are no retries. In this situation, temporary
25261 errors are treated as permanent. The default configuration contains a single,
25262 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
25263 line option can be used to test which retry rule will be used for a given
25264 address, domain and error.
25265
25266 The most common cause of retries is temporary failure to deliver to a remote
25267 host because the host is down, or inaccessible because of a network problem.
25268 Exim's retry processing in this case is applied on a per-host (strictly, per IP
25269 address) basis, not on a per-message basis. Thus, if one message has recently
25270 been delayed, delivery of a new message to the same host is not immediately
25271 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
25272 log selector is set, the message
25273 .cindex "retry" "time not reached"
25274 &"retry time not reached"& is written to the main log whenever a delivery is
25275 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
25276 the handling of errors during remote deliveries.
25277
25278 Retry processing applies to routing as well as to delivering, except as covered
25279 in the next paragraph. The retry rules do not distinguish between these
25280 actions. It is not possible, for example, to specify different behaviour for
25281 failures to route the domain &'snark.fict.example'& and failures to deliver to
25282 the host &'snark.fict.example'&. I didn't think anyone would ever need this
25283 added complication, so did not implement it. However, although they share the
25284 same retry rule, the actual retry times for routing and transporting a given
25285 domain are maintained independently.
25286
25287 When a delivery is not part of a queue run (typically an immediate delivery on
25288 receipt of a message), the routers are always run, and local deliveries are
25289 always attempted, even if retry times are set for them. This makes for better
25290 behaviour if one particular message is causing problems (for example, causing
25291 quota overflow, or provoking an error in a filter file). If such a delivery
25292 suffers a temporary failure, the retry data is updated as normal, and
25293 subsequent delivery attempts from queue runs occur only when the retry time for
25294 the local address is reached.
25295
25296 .section "Changing retry rules" "SECID157"
25297 If you change the retry rules in your configuration, you should consider
25298 whether or not to delete the retry data that is stored in Exim's spool area in
25299 files with names like &_db/retry_&. Deleting any of Exim's hints files is
25300 always safe; that is why they are called &"hints"&.
25301
25302 The hints retry data contains suggested retry times based on the previous
25303 rules. In the case of a long-running problem with a remote host, it might
25304 record the fact that the host has timed out. If your new rules increase the
25305 timeout time for such a host, you should definitely remove the old retry data
25306 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
25307 messages that it should now be retaining.
25308
25309
25310
25311 .section "Format of retry rules" "SECID158"
25312 .cindex "retry" "rules"
25313 Each retry rule occupies one line and consists of three or four parts,
25314 separated by white space: a pattern, an error name, an optional list of sender
25315 addresses, and a list of retry parameters. The pattern and sender lists must be
25316 enclosed in double quotes if they contain white space. The rules are searched
25317 in order until one is found where the pattern, error name, and sender list (if
25318 present) match the failing host or address, the error that occurred, and the
25319 message's sender, respectively.
25320
25321
25322 The pattern is any single item that may appear in an address list (see section
25323 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
25324 which means that it is expanded before being tested against the address that
25325 has been delayed. A negated address list item is permitted. Address
25326 list processing treats a plain domain name as if it were preceded by &"*@"&,
25327 which makes it possible for many retry rules to start with just a domain. For
25328 example,
25329 .code
25330 lookingglass.fict.example        *  F,24h,30m;
25331 .endd
25332 provides a rule for any address in the &'lookingglass.fict.example'& domain,
25333 whereas
25334 .code
25335 alice@lookingglass.fict.example  *  F,24h,30m;
25336 .endd
25337 applies only to temporary failures involving the local part &%alice%&.
25338 In practice, almost all rules start with a domain name pattern without a local
25339 part.
25340
25341 .cindex "regular expressions" "in retry rules"
25342 &*Warning*&: If you use a regular expression in a retry rule pattern, it
25343 must match a complete address, not just a domain, because that is how regular
25344 expressions work in address lists.
25345 .display
25346 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
25347 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
25348 .endd
25349
25350
25351 .section "Choosing which retry rule to use for address errors" "SECID159"
25352 When Exim is looking for a retry rule after a routing attempt has failed (for
25353 example, after a DNS timeout), each line in the retry configuration is tested
25354 against the complete address only if &%retry_use_local_part%& is set for the
25355 router. Otherwise, only the domain is used, except when matching against a
25356 regular expression, when the local part of the address is replaced with &"*"&.
25357 A domain on its own can match a domain pattern, or a pattern that starts with
25358 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
25359 &%check_local_user%& is true, and false for other routers.
25360
25361 Similarly, when Exim is looking for a retry rule after a local delivery has
25362 failed (for example, after a mailbox full error), each line in the retry
25363 configuration is tested against the complete address only if
25364 &%retry_use_local_part%& is set for the transport (it defaults true for all
25365 local transports).
25366
25367 .cindex "4&'xx'& responses" "retry rules for"
25368 However, when Exim is looking for a retry rule after a remote delivery attempt
25369 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
25370 whole address is always used as the key when searching the retry rules. The
25371 rule that is found is used to create a retry time for the combination of the
25372 failing address and the message's sender. It is the combination of sender and
25373 recipient that is delayed in subsequent queue runs until its retry time is
25374 reached. You can delay the recipient without regard to the sender by setting
25375 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
25376 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
25377 commands.
25378
25379
25380
25381 .section "Choosing which retry rule to use for host and message errors" &&&
25382          "SECID160"
25383 For a temporary error that is not related to an individual address (for
25384 example, a connection timeout), each line in the retry configuration is checked
25385 twice. First, the name of the remote host is used as a domain name (preceded by
25386 &"*@"& when matching a regular expression). If this does not match the line,
25387 the domain from the email address is tried in a similar fashion. For example,
25388 suppose the MX records for &'a.b.c.example'& are
25389 .code
25390 a.b.c.example  MX  5  x.y.z.example
25391                MX  6  p.q.r.example
25392                MX  7  m.n.o.example
25393 .endd
25394 and the retry rules are
25395 .code
25396 p.q.r.example    *      F,24h,30m;
25397 a.b.c.example    *      F,4d,45m;
25398 .endd
25399 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
25400 first rule matches neither the host nor the domain, so Exim looks at the second
25401 rule. This does not match the host, but it does match the domain, so it is used
25402 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
25403 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
25404 first retry rule is used, because it matches the host.
25405
25406 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
25407 first rule to determine retry times, but for all the other hosts for the domain
25408 &'a.b.c.example'&, the second rule is used. The second rule is also used if
25409 routing to &'a.b.c.example'& suffers a temporary failure.
25410
25411 &*Note*&: The host name is used when matching the patterns, not its IP address.
25412 However, if a message is routed directly to an IP address without the use of a
25413 host name, for example, if a &(manualroute)& router contains a setting such as:
25414 .code
25415 route_list = *.a.example  192.168.34.23
25416 .endd
25417 then the &"host name"& that is used when searching for a retry rule is the
25418 textual form of the IP address.
25419
25420 .section "Retry rules for specific errors" "SECID161"
25421 .cindex "retry" "specific errors; specifying"
25422 The second field in a retry rule is the name of a particular error, or an
25423 asterisk, which matches any error. The errors that can be tested for are:
25424
25425 .vlist
25426 .vitem &%auth_failed%&
25427 Authentication failed when trying to send to a host in the
25428 &%hosts_require_auth%& list in an &(smtp)& transport.
25429
25430 .vitem &%data_4xx%&
25431 A 4&'xx'& error was received for an outgoing DATA command, either immediately
25432 after the command, or after sending the message's data.
25433
25434 .vitem &%mail_4xx%&
25435 A 4&'xx'& error was received for an outgoing MAIL command.
25436
25437 .vitem &%rcpt_4xx%&
25438 A 4&'xx'& error was received for an outgoing RCPT command.
25439 .endlist
25440
25441 For the three 4&'xx'& errors, either the first or both of the x's can be given
25442 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
25443 recognize 452 errors given to RCPT commands for addresses in a certain domain,
25444 and have retries every ten minutes with a one-hour timeout, you could set up a
25445 retry rule of this form:
25446 .code
25447 the.domain.name  rcpt_452   F,1h,10m
25448 .endd
25449 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
25450 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
25451
25452 .vlist
25453 .vitem &%lost_connection%&
25454 A server unexpectedly closed the SMTP connection. There may, of course,
25455 legitimate reasons for this (host died, network died), but if it repeats a lot
25456 for the same host, it indicates something odd.
25457
25458 .vitem &%lookup%&
25459 A DNS lookup for a host failed.
25460 Note that a &%dnslookup%& router will need to have matched
25461 its &%fail_defer_domains%& option for this retry type to be usable.
25462 Also note that a &%manualroute%& router will probably need
25463 its &%host_find_failed%& option set to &%defer%&.
25464
25465 .vitem &%refused_MX%&
25466 A connection to a host obtained from an MX record was refused.
25467
25468 .vitem &%refused_A%&
25469 A connection to a host not obtained from an MX record was refused.
25470
25471 .vitem &%refused%&
25472 A connection was refused.
25473
25474 .vitem &%timeout_connect_MX%&
25475 A connection attempt to a host obtained from an MX record timed out.
25476
25477 .vitem &%timeout_connect_A%&
25478 A connection attempt to a host not obtained from an MX record timed out.
25479
25480 .vitem &%timeout_connect%&
25481 A connection attempt timed out.
25482
25483 .vitem &%timeout_MX%&
25484 There was a timeout while connecting or during an SMTP session with a host
25485 obtained from an MX record.
25486
25487 .vitem &%timeout_A%&
25488 There was a timeout while connecting or during an SMTP session with a host not
25489 obtained from an MX record.
25490
25491 .vitem &%timeout%&
25492 There was a timeout while connecting or during an SMTP session.
25493
25494 .vitem &%tls_required%&
25495 The server was required to use TLS (it matched &%hosts_require_tls%& in the
25496 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
25497 to STARTTLS, or there was a problem setting up the TLS connection.
25498
25499 .vitem &%quota%&
25500 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
25501 transport.
25502
25503 .vitem &%quota_%&<&'time'&>
25504 .cindex "quota" "error testing in retry rule"
25505 .cindex "retry" "quota error testing"
25506 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
25507 transport, and the mailbox has not been accessed for <&'time'&>. For example,
25508 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
25509 for four days.
25510 .endlist
25511
25512 .cindex "mailbox" "time of last read"
25513 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
25514 timeouts when the mailbox is full and is not being read by its owner. Ideally,
25515 it should be based on the last time that the user accessed the mailbox.
25516 However, it is not always possible to determine this. Exim uses the following
25517 heuristic rules:
25518
25519 .ilist
25520 If the mailbox is a single file, the time of last access (the &"atime"&) is
25521 used. As no new messages are being delivered (because the mailbox is over
25522 quota), Exim does not access the file, so this is the time of last user access.
25523 .next
25524 .cindex "maildir format" "time of last read"
25525 For a maildir delivery, the time of last modification of the &_new_&
25526 subdirectory is used. As the mailbox is over quota, no new files are created in
25527 the &_new_& subdirectory, because no new messages are being delivered. Any
25528 change to the &_new_& subdirectory is therefore assumed to be the result of an
25529 MUA moving a new message to the &_cur_& directory when it is first read. The
25530 time that is used is therefore the last time that the user read a new message.
25531 .next
25532 For other kinds of multi-file mailbox, the time of last access cannot be
25533 obtained, so a retry rule that uses this type of error field is never matched.
25534 .endlist
25535
25536 The quota errors apply both to system-enforced quotas and to Exim's own quota
25537 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
25538 when a local delivery is deferred because a partition is full (the ENOSPC
25539 error).
25540
25541
25542
25543 .section "Retry rules for specified senders" "SECID162"
25544 .cindex "retry" "rules; sender-specific"
25545 You can specify retry rules that apply only when the failing message has a
25546 specific sender. In particular, this can be used to define retry rules that
25547 apply only to bounce messages. The third item in a retry rule can be of this
25548 form:
25549 .display
25550 &`senders=`&<&'address list'&>
25551 .endd
25552 The retry timings themselves are then the fourth item. For example:
25553 .code
25554 *   rcpt_4xx   senders=:   F,1h,30m
25555 .endd
25556 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
25557 host. If the address list contains white space, it must be enclosed in quotes.
25558 For example:
25559 .code
25560 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
25561 .endd
25562 &*Warning*&: This facility can be unhelpful if it is used for host errors
25563 (which do not depend on the recipient). The reason is that the sender is used
25564 only to match the retry rule. Once the rule has been found for a host error,
25565 its contents are used to set a retry time for the host, and this will apply to
25566 all messages, not just those with specific senders.
25567
25568 When testing retry rules using &%-brt%&, you can supply a sender using the
25569 &%-f%& command line option, like this:
25570 .code
25571 exim -f "" -brt user@dom.ain
25572 .endd
25573 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
25574 list is never matched.
25575
25576
25577
25578
25579
25580 .section "Retry parameters" "SECID163"
25581 .cindex "retry" "parameters in rules"
25582 The third (or fourth, if a senders list is present) field in a retry rule is a
25583 sequence of retry parameter sets, separated by semicolons. Each set consists of
25584 .display
25585 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
25586 .endd
25587 The letter identifies the algorithm for computing a new retry time; the cutoff
25588 time is the time beyond which this algorithm no longer applies, and the
25589 arguments vary the algorithm's action. The cutoff time is measured from the
25590 time that the first failure for the domain (combined with the local part if
25591 relevant) was detected, not from the time the message was received.
25592
25593 .cindex "retry" "algorithms"
25594 .cindex "retry" "fixed intervals"
25595 .cindex "retry" "increasing intervals"
25596 .cindex "retry" "random intervals"
25597 The available algorithms are:
25598
25599 .ilist
25600 &'F'&: retry at fixed intervals. There is a single time parameter specifying
25601 the interval.
25602 .next
25603 &'G'&: retry at geometrically increasing intervals. The first argument
25604 specifies a starting value for the interval, and the second a multiplier, which
25605 is used to increase the size of the interval at each retry.
25606 .next
25607 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
25608 retry, the previous interval is multiplied by the factor in order to get a
25609 maximum for the next interval. The minimum interval is the first argument of
25610 the parameter, and an actual interval is chosen randomly between them. Such a
25611 rule has been found to be helpful in cluster configurations when all the
25612 members of the cluster restart at once, and may therefore synchronize their
25613 queue processing times.
25614 .endlist
25615
25616 When computing the next retry time, the algorithm definitions are scanned in
25617 order until one whose cutoff time has not yet passed is reached. This is then
25618 used to compute a new retry time that is later than the current time. In the
25619 case of fixed interval retries, this simply means adding the interval to the
25620 current time. For geometrically increasing intervals, retry intervals are
25621 computed from the rule's parameters until one that is greater than the previous
25622 interval is found. The main configuration variable
25623 .cindex "limit" "retry interval"
25624 .cindex "retry" "interval, maximum"
25625 .oindex "&%retry_interval_max%&"
25626 &%retry_interval_max%& limits the maximum interval between retries. It
25627 cannot be set greater than &`24h`&, which is its default value.
25628
25629 A single remote domain may have a number of hosts associated with it, and each
25630 host may have more than one IP address. Retry algorithms are selected on the
25631 basis of the domain name, but are applied to each IP address independently. If,
25632 for example, a host has two IP addresses and one is unusable, Exim will
25633 generate retry times for it and will not try to use it until its next retry
25634 time comes. Thus the good IP address is likely to be tried first most of the
25635 time.
25636
25637 .cindex "hints database" "use for retrying"
25638 Retry times are hints rather than promises. Exim does not make any attempt to
25639 run deliveries exactly at the computed times. Instead, a queue runner process
25640 starts delivery processes for delayed messages periodically, and these attempt
25641 new deliveries only for those addresses that have passed their next retry time.
25642 If a new message arrives for a deferred address, an immediate delivery attempt
25643 occurs only if the address has passed its retry time. In the absence of new
25644 messages, the minimum time between retries is the interval between queue runner
25645 processes. There is not much point in setting retry times of five minutes if
25646 your queue runners happen only once an hour, unless there are a significant
25647 number of incoming messages (which might be the case on a system that is
25648 sending everything to a smart host, for example).
25649
25650 The data in the retry hints database can be inspected by using the
25651 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
25652 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
25653 &'exinext'& utility script can be used to find out what the next retry times
25654 are for the hosts associated with a particular mail domain, and also for local
25655 deliveries that have been deferred.
25656
25657
25658 .section "Retry rule examples" "SECID164"
25659 Here are some example retry rules:
25660 .code
25661 alice@wonderland.fict.example quota_5d  F,7d,3h
25662 wonderland.fict.example       quota_5d
25663 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
25664 lookingglass.fict.example     *         F,24h,30m;
25665 *                 refused_A   F,2h,20m;
25666 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
25667 .endd
25668 The first rule sets up special handling for mail to
25669 &'alice@wonderland.fict.example'& when there is an over-quota error and the
25670 mailbox has not been read for at least 5 days. Retries continue every three
25671 hours for 7 days. The second rule handles over-quota errors for all other local
25672 parts at &'wonderland.fict.example'&; the absence of a local part has the same
25673 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
25674 fail are bounced immediately if the mailbox has not been read for at least 5
25675 days.
25676
25677 The third rule handles all other errors at &'wonderland.fict.example'&; retries
25678 happen every 15 minutes for an hour, then with geometrically increasing
25679 intervals until two days have passed since a delivery first failed. After the
25680 first hour there is a delay of one hour, then two hours, then four hours, and
25681 so on (this is a rather extreme example).
25682
25683 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
25684 They happen every 30 minutes for 24 hours only. The remaining two rules handle
25685 all other domains, with special action for connection refusal from hosts that
25686 were not obtained from an MX record.
25687
25688 The final rule in a retry configuration should always have asterisks in the
25689 first two fields so as to provide a general catch-all for any addresses that do
25690 not have their own special handling. This example tries every 15 minutes for 2
25691 hours, then with intervals starting at one hour and increasing by a factor of
25692 1.5 up to 16 hours, then every 8 hours up to 5 days.
25693
25694
25695
25696 .section "Timeout of retry data" "SECID165"
25697 .cindex "timeout" "of retry data"
25698 .oindex "&%retry_data_expire%&"
25699 .cindex "hints database" "data expiry"
25700 .cindex "retry" "timeout of data"
25701 Exim timestamps the data that it writes to its retry hints database. When it
25702 consults the data during a delivery it ignores any that is older than the value
25703 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
25704 been tried for 7 days, Exim will try to deliver to it immediately a message
25705 arrives, and if that fails, it will calculate a retry time as if it were
25706 failing for the first time.
25707
25708 This improves the behaviour for messages routed to rarely-used hosts such as MX
25709 backups. If such a host was down at one time, and happens to be down again when
25710 Exim tries a month later, using the old retry data would imply that it had been
25711 down all the time, which is not a justified assumption.
25712
25713 If a host really is permanently dead, this behaviour causes a burst of retries
25714 every now and again, but only if messages routed to it are rare. If there is a
25715 message at least once every 7 days the retry data never expires.
25716
25717
25718
25719
25720 .section "Long-term failures" "SECID166"
25721 .cindex "delivery failure, long-term"
25722 .cindex "retry" "after long-term failure"
25723 Special processing happens when an email address has been failing for so long
25724 that the cutoff time for the last algorithm is reached. For example, using the
25725 default retry rule:
25726 .code
25727 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
25728 .endd
25729 the cutoff time is four days. Reaching the retry cutoff is independent of how
25730 long any specific message has been failing; it is the length of continuous
25731 failure for the recipient address that counts.
25732
25733 When the cutoff time is reached for a local delivery, or for all the IP
25734 addresses associated with a remote delivery, a subsequent delivery failure
25735 causes Exim to give up on the address, and a bounce message is generated.
25736 In order to cater for new messages that use the failing address, a next retry
25737 time is still computed from the final algorithm, and is used as follows:
25738
25739 For local deliveries, one delivery attempt is always made for any subsequent
25740 messages. If this delivery fails, the address fails immediately. The
25741 post-cutoff retry time is not used.
25742
25743 If the delivery is remote, there are two possibilities, controlled by the
25744 .oindex "&%delay_after_cutoff%&"
25745 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
25746 default. Until the post-cutoff retry time for one of the IP addresses is
25747 reached, the failing email address is bounced immediately, without a delivery
25748 attempt taking place. After that time, one new delivery attempt is made to
25749 those IP addresses that are past their retry times, and if that still fails,
25750 the address is bounced and new retry times are computed.
25751
25752 In other words, when all the hosts for a given email address have been failing
25753 for a long time, Exim bounces rather then defers until one of the hosts' retry
25754 times is reached. Then it tries once, and bounces if that attempt fails. This
25755 behaviour ensures that few resources are wasted in repeatedly trying to deliver
25756 to a broken destination, but if the host does recover, Exim will eventually
25757 notice.
25758
25759 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
25760 addresses are past their final cutoff time, Exim tries to deliver to those IP
25761 addresses that have not been tried since the message arrived. If there are
25762 no suitable IP addresses, or if they all fail, the address is bounced. In other
25763 words, it does not delay when a new message arrives, but tries the expired
25764 addresses immediately, unless they have been tried since the message arrived.
25765 If there is a continuous stream of messages for the failing domains, setting
25766 &%delay_after_cutoff%& false means that there will be many more attempts to
25767 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
25768 true.
25769
25770 .section "Deliveries that work intermittently" "SECID167"
25771 .cindex "retry" "intermittently working deliveries"
25772 Some additional logic is needed to cope with cases where a host is
25773 intermittently available, or when a message has some attribute that prevents
25774 its delivery when others to the same address get through. In this situation,
25775 because some messages are successfully delivered, the &"retry clock"& for the
25776 host or address keeps getting reset by the successful deliveries, and so
25777 failing messages remain on the queue for ever because the cutoff time is never
25778 reached.
25779
25780 Two exceptional actions are applied to prevent this happening. The first
25781 applies to errors that are related to a message rather than a remote host.
25782 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
25783 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
25784 commands, and quota failures. For this type of error, if a message's arrival
25785 time is earlier than the &"first failed"& time for the error, the earlier time
25786 is used when scanning the retry rules to decide when to try next and when to
25787 time out the address.
25788
25789 The exceptional second action applies in all cases. If a message has been on
25790 the queue for longer than the cutoff time of any applicable retry rule for a
25791 given address, a delivery is attempted for that address, even if it is not yet
25792 time, and if this delivery fails, the address is timed out. A new retry time is
25793 not computed in this case, so that other messages for the same address are
25794 considered immediately.
25795 .ecindex IIDretconf1
25796 .ecindex IIDregconf2
25797
25798
25799
25800
25801
25802
25803 . ////////////////////////////////////////////////////////////////////////////
25804 . ////////////////////////////////////////////////////////////////////////////
25805
25806 .chapter "SMTP authentication" "CHAPSMTPAUTH"
25807 .scindex IIDauthconf1 "SMTP" "authentication configuration"
25808 .scindex IIDauthconf2 "authentication"
25809 The &"authenticators"& section of Exim's run time configuration is concerned
25810 with SMTP authentication. This facility is an extension to the SMTP protocol,
25811 described in RFC 2554, which allows a client SMTP host to authenticate itself
25812 to a server. This is a common way for a server to recognize clients that are
25813 permitted to use it as a relay. SMTP authentication is not of relevance to the
25814 transfer of mail between servers that have no managerial connection with each
25815 other.
25816
25817 .cindex "AUTH" "description of"
25818 Very briefly, the way SMTP authentication works is as follows:
25819
25820 .ilist
25821 The server advertises a number of authentication &'mechanisms'& in response to
25822 the client's EHLO command.
25823 .next
25824 The client issues an AUTH command, naming a specific mechanism. The command
25825 may, optionally, contain some authentication data.
25826 .next
25827 The server may issue one or more &'challenges'&, to which the client must send
25828 appropriate responses. In simple authentication mechanisms, the challenges are
25829 just prompts for user names and passwords. The server does not have to issue
25830 any challenges &-- in some mechanisms the relevant data may all be transmitted
25831 with the AUTH command.
25832 .next
25833 The server either accepts or denies authentication.
25834 .next
25835 If authentication succeeds, the client may optionally make use of the AUTH
25836 option on the MAIL command to pass an authenticated sender in subsequent
25837 mail transactions. Authentication lasts for the remainder of the SMTP
25838 connection.
25839 .next
25840 If authentication fails, the client may give up, or it may try a different
25841 authentication mechanism, or it may try transferring mail over the
25842 unauthenticated connection.
25843 .endlist
25844
25845 If you are setting up a client, and want to know which authentication
25846 mechanisms the server supports, you can use Telnet to connect to port 25 (the
25847 SMTP port) on the server, and issue an EHLO command. The response to this
25848 includes the list of supported mechanisms. For example:
25849 .display
25850 &`$ `&&*&`telnet server.example 25`&*&
25851 &`Trying 192.168.34.25...`&
25852 &`Connected to server.example.`&
25853 &`Escape character is &#x0027;^]&#x0027;.`&
25854 &`220 server.example ESMTP Exim 4.20 ...`&
25855 &*&`ehlo client.example`&*&
25856 &`250-server.example Hello client.example [10.8.4.5]`&
25857 &`250-SIZE 52428800`&
25858 &`250-PIPELINING`&
25859 &`250-AUTH PLAIN`&
25860 &`250 HELP`&
25861 .endd
25862 The second-last line of this example output shows that the server supports
25863 authentication using the PLAIN mechanism. In Exim, the different authentication
25864 mechanisms are configured by specifying &'authenticator'& drivers. Like the
25865 routers and transports, which authenticators are included in the binary is
25866 controlled by build-time definitions. The following are currently available,
25867 included by setting
25868 .code
25869 AUTH_CRAM_MD5=yes
25870 AUTH_CYRUS_SASL=yes
25871 AUTH_DOVECOT=yes
25872 AUTH_GSASL=yes
25873 AUTH_HEIMDAL_GSSAPI=yes
25874 AUTH_PLAINTEXT=yes
25875 AUTH_SPA=yes
25876 AUTH_TLS=yes
25877 .endd
25878 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
25879 authentication mechanism (RFC 2195), and the second provides an interface to
25880 the Cyrus SASL authentication library.
25881 The third is an interface to Dovecot's authentication system, delegating the
25882 work via a socket interface.
25883 The fourth provides an interface to the GNU SASL authentication library, which
25884 provides mechanisms but typically not data sources.
25885 The fifth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
25886 supporting setting a server keytab.
25887 The sixth can be configured to support
25888 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
25889 not formally documented, but used by several MUAs. The seventh authenticator
25890 supports Microsoft's &'Secure Password Authentication'& mechanism.
25891 The eighth is an Exim authenticator but not an SMTP one;
25892 instead it can use information from a TLS negotiation.
25893
25894 The authenticators are configured using the same syntax as other drivers (see
25895 section &<<SECTfordricon>>&). If no authenticators are required, no
25896 authentication section need be present in the configuration file. Each
25897 authenticator can in principle have both server and client functions. When Exim
25898 is receiving SMTP mail, it is acting as a server; when it is sending out
25899 messages over SMTP, it is acting as a client. Authenticator configuration
25900 options are provided for use in both these circumstances.
25901
25902 To make it clear which options apply to which situation, the prefixes
25903 &%server_%& and &%client_%& are used on option names that are specific to
25904 either the server or the client function, respectively. Server and client
25905 functions are disabled if none of their options are set. If an authenticator is
25906 to be used for both server and client functions, a single definition, using
25907 both sets of options, is required. For example:
25908 .code
25909 cram:
25910   driver = cram_md5
25911   public_name = CRAM-MD5
25912   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
25913   client_name = ph10
25914   client_secret = secret2
25915 .endd
25916 The &%server_%& option is used when Exim is acting as a server, and the
25917 &%client_%& options when it is acting as a client.
25918
25919 Descriptions of the individual authenticators are given in subsequent chapters.
25920 The remainder of this chapter covers the generic options for the
25921 authenticators, followed by general discussion of the way authentication works
25922 in Exim.
25923
25924 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
25925 per-mechanism basis.  Please read carefully to determine which variables hold
25926 account labels such as usercodes and which hold passwords or other
25927 authenticating data.
25928
25929 Note that some mechanisms support two different identifiers for accounts: the
25930 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
25931 and &'authz'& are commonly encountered.  The American spelling is standard here.
25932 Conceptually, authentication data such as passwords are tied to the identifier
25933 used to authenticate; servers may have rules to permit one user to act as a
25934 second user, so that after login the session is treated as though that second
25935 user had logged in.  That second user is the &'authorization id'&.  A robust
25936 configuration might confirm that the &'authz'& field is empty or matches the
25937 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
25938 as verified data, the &'authz'& as an unverified request which the server might
25939 choose to honour.
25940
25941 A &'realm'& is a text string, typically a domain name, presented by a server
25942 to a client to help it select an account and credentials to use.  In some
25943 mechanisms, the client and server provably agree on the realm, but clients
25944 typically can not treat the realm as secure data to be blindly trusted.
25945
25946
25947
25948 .section "Generic options for authenticators" "SECID168"
25949 .cindex "authentication" "generic options"
25950 .cindex "options" "generic; for authenticators"
25951
25952 .option client_condition authenticators string&!! unset
25953 When Exim is authenticating as a client, it skips any authenticator whose
25954 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
25955 used, for example, to skip plain text authenticators when the connection is not
25956 encrypted by a setting such as:
25957 .code
25958 client_condition = ${if !eq{$tls_out_cipher}{}}
25959 .endd
25960
25961
25962 .option client_set_id authenticators string&!! unset
25963 When client authentication succeeds, this condition is expanded; the
25964 result is used in the log lines for outbound messages.
25965 Typically it will be the user name used for authentication.
25966
25967
25968 .option driver authenticators string unset
25969 This option must always be set. It specifies which of the available
25970 authenticators is to be used.
25971
25972
25973 .option public_name authenticators string unset
25974 This option specifies the name of the authentication mechanism that the driver
25975 implements, and by which it is known to the outside world. These names should
25976 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
25977 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
25978 defaults to the driver's instance name.
25979
25980
25981 .option server_advertise_condition authenticators string&!! unset
25982 When a server is about to advertise an authentication mechanism, the condition
25983 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
25984 mechanism is not advertised.
25985 If the expansion fails, the mechanism is not advertised. If the failure was not
25986 forced, and was not caused by a lookup defer, the incident is logged.
25987 See section &<<SECTauthexiser>>& below for further discussion.
25988
25989
25990 .option server_condition authenticators string&!! unset
25991 This option must be set for a &%plaintext%& server authenticator, where it
25992 is used directly to control authentication. See section &<<SECTplainserver>>&
25993 for details.
25994
25995 For the &(gsasl)& authenticator, this option is required for various
25996 mechanisms; see chapter &<<CHAPgsasl>>& for details.
25997
25998 For the other authenticators, &%server_condition%& can be used as an additional
25999 authentication or authorization mechanism that is applied after the other
26000 authenticator conditions succeed. If it is set, it is expanded when the
26001 authenticator would otherwise return a success code. If the expansion is forced
26002 to fail, authentication fails. Any other expansion failure causes a temporary
26003 error code to be returned. If the result of a successful expansion is an empty
26004 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
26005 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
26006 other result, a temporary error code is returned, with the expanded string as
26007 the error text.
26008
26009
26010 .option server_debug_print authenticators string&!! unset
26011 If this option is set and authentication debugging is enabled (see the &%-d%&
26012 command line option), the string is expanded and included in the debugging
26013 output when the authenticator is run as a server. This can help with checking
26014 out the values of variables.
26015 If expansion of the string fails, the error message is written to the debugging
26016 output, and Exim carries on processing.
26017
26018
26019 .option server_set_id authenticators string&!! unset
26020 .vindex "&$authenticated_id$&"
26021 When an Exim server successfully authenticates a client, this string is
26022 expanded using data from the authentication, and preserved for any incoming
26023 messages in the variable &$authenticated_id$&. It is also included in the log
26024 lines for incoming messages. For example, a user/password authenticator
26025 configuration might preserve the user name that was used to authenticate, and
26026 refer to it subsequently during delivery of the message.
26027 If expansion fails, the option is ignored.
26028
26029
26030 .option server_mail_auth_condition authenticators string&!! unset
26031 This option allows a server to discard authenticated sender addresses supplied
26032 as part of MAIL commands in SMTP connections that are authenticated by the
26033 driver on which &%server_mail_auth_condition%& is set. The option is not used
26034 as part of the authentication process; instead its (unexpanded) value is
26035 remembered for later use.
26036 How it is used is described in the following section.
26037
26038
26039
26040
26041
26042 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
26043 .cindex "authentication" "sender; authenticated"
26044 .cindex "AUTH" "on MAIL command"
26045 When a client supplied an AUTH= item on a MAIL command, Exim applies
26046 the following checks before accepting it as the authenticated sender of the
26047 message:
26048
26049 .ilist
26050 If the connection is not using extended SMTP (that is, HELO was used rather
26051 than EHLO), the use of AUTH= is a syntax error.
26052 .next
26053 If the value of the AUTH= parameter is &"<>"&, it is ignored.
26054 .next
26055 .vindex "&$authenticated_sender$&"
26056 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
26057 running, the value of &$authenticated_sender$& is set to the value obtained
26058 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
26059 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
26060 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
26061 given for the MAIL command.
26062 .next
26063 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
26064 is accepted and placed in &$authenticated_sender$& only if the client has
26065 authenticated.
26066 .next
26067 If the AUTH= value was accepted by either of the two previous rules, and
26068 the client has authenticated, and the authenticator has a setting for the
26069 &%server_mail_auth_condition%&, the condition is checked at this point. The
26070 valued that was saved from the authenticator is expanded. If the expansion
26071 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
26072 &$authenticated_sender$& is deleted. If the expansion yields any other value,
26073 the value of &$authenticated_sender$& is retained and passed on with the
26074 message.
26075 .endlist
26076
26077
26078 When &$authenticated_sender$& is set for a message, it is passed on to other
26079 hosts to which Exim authenticates as a client. Do not confuse this value with
26080 &$authenticated_id$&, which is a string obtained from the authentication
26081 process, and which is not usually a complete email address.
26082
26083 .vindex "&$sender_address$&"
26084 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
26085 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
26086 therefore make use of &$authenticated_sender$&. The converse is not true: the
26087 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
26088 ACL is run.
26089
26090
26091
26092 .section "Authentication on an Exim server" "SECTauthexiser"
26093 .cindex "authentication" "on an Exim server"
26094 When Exim receives an EHLO command, it advertises the public names of those
26095 authenticators that are configured as servers, subject to the following
26096 conditions:
26097
26098 .ilist
26099 The client host must match &%auth_advertise_hosts%& (default *).
26100 .next
26101 It the &%server_advertise_condition%& option is set, its expansion must not
26102 yield the empty string, &"0"&, &"no"&, or &"false"&.
26103 .endlist
26104
26105 The order in which the authenticators are defined controls the order in which
26106 the mechanisms are advertised.
26107
26108 Some mail clients (for example, some versions of Netscape) require the user to
26109 provide a name and password for authentication whenever AUTH is advertised,
26110 even though authentication may not in fact be needed (for example, Exim may be
26111 set up to allow unconditional relaying from the client by an IP address check).
26112 You can make such clients more friendly by not advertising AUTH to them.
26113 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
26114 that runs for RCPT) to relay without authentication, you should set
26115 .code
26116 auth_advertise_hosts = ! 10.9.8.0/24
26117 .endd
26118 so that no authentication mechanisms are advertised to them.
26119
26120 The &%server_advertise_condition%& controls the advertisement of individual
26121 authentication mechanisms. For example, it can be used to restrict the
26122 advertisement of a particular mechanism to encrypted connections, by a setting
26123 such as:
26124 .code
26125 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
26126 .endd
26127 .vindex "&$tls_in_cipher$&"
26128 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
26129 yields &"yes"&, which allows the advertisement to happen.
26130
26131 When an Exim server receives an AUTH command from a client, it rejects it
26132 immediately if AUTH was not advertised in response to an earlier EHLO
26133 command. This is the case if
26134
26135 .ilist
26136 The client host does not match &%auth_advertise_hosts%&; or
26137 .next
26138 No authenticators are configured with server options; or
26139 .next
26140 Expansion of &%server_advertise_condition%& blocked the advertising of all the
26141 server authenticators.
26142 .endlist
26143
26144
26145 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
26146 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
26147 AUTH is accepted from any client host.
26148
26149 If AUTH is not rejected by the ACL, Exim searches its configuration for a
26150 server authentication mechanism that was advertised in response to EHLO and
26151 that matches the one named in the AUTH command. If it finds one, it runs
26152 the appropriate authentication protocol, and authentication either succeeds or
26153 fails. If there is no matching advertised mechanism, the AUTH command is
26154 rejected with a 504 error.
26155
26156 .vindex "&$received_protocol$&"
26157 .vindex "&$sender_host_authenticated$&"
26158 When a message is received from an authenticated host, the value of
26159 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
26160 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
26161 public name) of the authenticator driver that successfully authenticated the
26162 client from which the message was received. This variable is empty if there was
26163 no successful authentication.
26164
26165 .new
26166 .cindex authentication "expansion item"
26167 Successful authentication sets up information used by the
26168 &$authresults$& expansion item.
26169 .wen
26170
26171
26172
26173
26174 .section "Testing server authentication" "SECID169"
26175 .cindex "authentication" "testing a server"
26176 .cindex "AUTH" "testing a server"
26177 .cindex "base64 encoding" "creating authentication test data"
26178 Exim's &%-bh%& option can be useful for testing server authentication
26179 configurations. The data for the AUTH command has to be sent using base64
26180 encoding. A quick way to produce such data for testing is the following Perl
26181 script:
26182 .code
26183 use MIME::Base64;
26184 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
26185 .endd
26186 .cindex "binary zero" "in authentication data"
26187 This interprets its argument as a Perl string, and then encodes it. The
26188 interpretation as a Perl string allows binary zeros, which are required for
26189 some kinds of authentication, to be included in the data. For example, a
26190 command line to run this script on such data might be
26191 .code
26192 encode '\0user\0password'
26193 .endd
26194 Note the use of single quotes to prevent the shell interpreting the
26195 backslashes, so that they can be interpreted by Perl to specify characters
26196 whose code value is zero.
26197
26198 &*Warning 1*&: If either of the user or password strings starts with an octal
26199 digit, you must use three zeros instead of one after the leading backslash. If
26200 you do not, the octal digit that starts your string will be incorrectly
26201 interpreted as part of the code for the first character.
26202
26203 &*Warning 2*&: If there are characters in the strings that Perl interprets
26204 specially, you must use a Perl escape to prevent them being misinterpreted. For
26205 example, a command such as
26206 .code
26207 encode '\0user@domain.com\0pas$$word'
26208 .endd
26209 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
26210
26211 If you have the &%mimencode%& command installed, another way to do produce
26212 base64-encoded strings is to run the command
26213 .code
26214 echo -e -n `\0user\0password' | mimencode
26215 .endd
26216 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
26217 in the argument, and the &%-n%& option specifies no newline at the end of its
26218 output. However, not all versions of &%echo%& recognize these options, so you
26219 should check your version before relying on this suggestion.
26220
26221
26222
26223 .section "Authentication by an Exim client" "SECID170"
26224 .cindex "authentication" "on an Exim client"
26225 The &(smtp)& transport has two options called &%hosts_require_auth%& and
26226 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
26227 announces support for authentication, and the host matches an entry in either
26228 of these options, Exim (as a client) tries to authenticate as follows:
26229
26230 .ilist
26231 For each authenticator that is configured as a client, in the order in which
26232 they are defined in the configuration, it searches the authentication
26233 mechanisms announced by the server for one whose name matches the public name
26234 of the authenticator.
26235 .next
26236 .vindex "&$host$&"
26237 .vindex "&$host_address$&"
26238 When it finds one that matches, it runs the authenticator's client code. The
26239 variables &$host$& and &$host_address$& are available for any string expansions
26240 that the client might do. They are set to the server's name and IP address. If
26241 any expansion is forced to fail, the authentication attempt is abandoned, and
26242 Exim moves on to the next authenticator. Otherwise an expansion failure causes
26243 delivery to be deferred.
26244 .next
26245 If the result of the authentication attempt is a temporary error or a timeout,
26246 Exim abandons trying to send the message to the host for the moment. It will
26247 try again later. If there are any backup hosts available, they are tried in the
26248 usual way.
26249 .next
26250 If the response to authentication is a permanent error (5&'xx'& code), Exim
26251 carries on searching the list of authenticators and tries another one if
26252 possible. If all authentication attempts give permanent errors, or if there are
26253 no attempts because no mechanisms match (or option expansions force failure),
26254 what happens depends on whether the host matches &%hosts_require_auth%& or
26255 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
26256 delivery is deferred. The error can be detected in the retry rules, and thereby
26257 turned into a permanent error if you wish. In the second case, Exim tries to
26258 deliver the message unauthenticated.
26259 .endlist
26260
26261 Note that the hostlist test for whether to do authentication can be
26262 confused if name-IP lookups change between the time the peer is decided
26263 on and the transport running.  For example, with a manualroute
26264 router given a host name, and DNS "round-robin" use by that name: if
26265 the local resolver cache times out between the router and the transport
26266 running, the transport may get an IP for the name for its authentication
26267 check which does not match the connection peer IP.
26268 No authentication will then be done, despite the names being identical.
26269
26270 For such cases use a separate transport which always authenticates.
26271
26272 .cindex "AUTH" "on MAIL command"
26273 When Exim has authenticated itself to a remote server, it adds the AUTH
26274 parameter to the MAIL commands it sends, if it has an authenticated sender for
26275 the message. If the message came from a remote host, the authenticated sender
26276 is the one that was receiving on an incoming MAIL command, provided that the
26277 incoming connection was authenticated and the &%server_mail_auth%& condition
26278 allowed the authenticated sender to be retained. If a local process calls Exim
26279 to send a message, the sender address that is built from the login name and
26280 &%qualify_domain%& is treated as authenticated. However, if the
26281 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
26282 the authenticated sender that was received with the message.
26283 .ecindex IIDauthconf1
26284 .ecindex IIDauthconf2
26285
26286
26287
26288
26289
26290
26291 . ////////////////////////////////////////////////////////////////////////////
26292 . ////////////////////////////////////////////////////////////////////////////
26293
26294 .chapter "The plaintext authenticator" "CHAPplaintext"
26295 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
26296 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
26297 The &(plaintext)& authenticator can be configured to support the PLAIN and
26298 LOGIN authentication mechanisms, both of which transfer authentication data as
26299 plain (unencrypted) text (though base64 encoded). The use of plain text is a
26300 security risk; you are strongly advised to insist on the use of SMTP encryption
26301 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
26302 use unencrypted plain text, you should not use the same passwords for SMTP
26303 connections as you do for login accounts.
26304
26305 .section "Plaintext options" "SECID171"
26306 .cindex "options" "&(plaintext)& authenticator (server)"
26307 When configured as a server, &(plaintext)& uses the following options:
26308
26309 .option server_condition authenticators string&!! unset
26310 This is actually a global authentication option, but it must be set in order to
26311 configure the &(plaintext)& driver as a server. Its use is described below.
26312
26313 .option server_prompts plaintext string&!! unset
26314 The contents of this option, after expansion, must be a colon-separated list of
26315 prompt strings. If expansion fails, a temporary authentication rejection is
26316 given.
26317
26318 .section "Using plaintext in a server" "SECTplainserver"
26319 .cindex "AUTH" "in &(plaintext)& authenticator"
26320 .cindex "binary zero" "in &(plaintext)& authenticator"
26321 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
26322         "in &(plaintext)& authenticator"
26323 .vindex "&$auth1$&, &$auth2$&, etc"
26324 .cindex "base64 encoding" "in &(plaintext)& authenticator"
26325
26326 When running as a server, &(plaintext)& performs the authentication test by
26327 expanding a string. The data sent by the client with the AUTH command, or in
26328 response to subsequent prompts, is base64 encoded, and so may contain any byte
26329 values when decoded. If any data is supplied with the command, it is treated as
26330 a list of strings, separated by NULs (binary zeros), the first three of which
26331 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
26332 (neither LOGIN nor PLAIN uses more than three strings).
26333
26334 For compatibility with previous releases of Exim, the values are also placed in
26335 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
26336 variables for this purpose is now deprecated, as it can lead to confusion in
26337 string expansions that also use them for other things.
26338
26339 If there are more strings in &%server_prompts%& than the number of strings
26340 supplied with the AUTH command, the remaining prompts are used to obtain more
26341 data. Each response from the client may be a list of NUL-separated strings.
26342
26343 .vindex "&$authenticated_id$&"
26344 Once a sufficient number of data strings have been received,
26345 &%server_condition%& is expanded. If the expansion is forced to fail,
26346 authentication fails. Any other expansion failure causes a temporary error code
26347 to be returned. If the result of a successful expansion is an empty string,
26348 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
26349 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
26350 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
26351 For any other result, a temporary error code is returned, with the expanded
26352 string as the error text
26353
26354 &*Warning*&: If you use a lookup in the expansion to find the user's
26355 password, be sure to make the authentication fail if the user is unknown.
26356 There are good and bad examples at the end of the next section.
26357
26358
26359
26360 .section "The PLAIN authentication mechanism" "SECID172"
26361 .cindex "PLAIN authentication mechanism"
26362 .cindex "authentication" "PLAIN mechanism"
26363 .cindex "binary zero" "in &(plaintext)& authenticator"
26364 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
26365 sent as one item of data (that is, one combined string containing two NUL
26366 separators). The data is sent either as part of the AUTH command, or
26367 subsequently in response to an empty prompt from the server.
26368
26369 The second and third strings are a user name and a corresponding password.
26370 Using a single fixed user name and password as an example, this could be
26371 configured as follows:
26372 .code
26373 fixed_plain:
26374   driver = plaintext
26375   public_name = PLAIN
26376   server_prompts = :
26377   server_condition = \
26378     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
26379   server_set_id = $auth2
26380 .endd
26381 Note that the default result strings from &%if%& (&"true"& or an empty string)
26382 are exactly what we want here, so they need not be specified. Obviously, if the
26383 password contains expansion-significant characters such as dollar, backslash,
26384 or closing brace, they have to be escaped.
26385
26386 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
26387 the end of a string list are ignored). If all the data comes as part of the
26388 AUTH command, as is commonly the case, the prompt is not used. This
26389 authenticator is advertised in the response to EHLO as
26390 .code
26391 250-AUTH PLAIN
26392 .endd
26393 and a client host can authenticate itself by sending the command
26394 .code
26395 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
26396 .endd
26397 As this contains three strings (more than the number of prompts), no further
26398 data is required from the client. Alternatively, the client may just send
26399 .code
26400 AUTH PLAIN
26401 .endd
26402 to initiate authentication, in which case the server replies with an empty
26403 prompt. The client must respond with the combined data string.
26404
26405 The data string is base64 encoded, as required by the RFC. This example,
26406 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
26407 represents a zero byte. This is split up into three strings, the first of which
26408 is empty. The &%server_condition%& option in the authenticator checks that the
26409 second two are &`username`& and &`mysecret`& respectively.
26410
26411 Having just one fixed user name and password, as in this example, is not very
26412 realistic, though for a small organization with only a handful of
26413 authenticating clients it could make sense.
26414
26415 A more sophisticated instance of this authenticator could use the user name in
26416 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
26417 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
26418 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
26419 This is an incorrect example:
26420 .code
26421 server_condition = \
26422   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
26423 .endd
26424 The expansion uses the user name (&$auth2$&) as the key to look up a password,
26425 which it then compares to the supplied password (&$auth3$&). Why is this example
26426 incorrect? It works fine for existing users, but consider what happens if a
26427 non-existent user name is given. The lookup fails, but as no success/failure
26428 strings are given for the lookup, it yields an empty string. Thus, to defeat
26429 the authentication, all a client has to do is to supply a non-existent user
26430 name and an empty password. The correct way of writing this test is:
26431 .code
26432 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
26433   {${if eq{$value}{$auth3}}} {false}}
26434 .endd
26435 In this case, if the lookup succeeds, the result is checked; if the lookup
26436 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
26437 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
26438 always fails if its second argument is empty. However, the second way of
26439 writing the test makes the logic clearer.
26440
26441
26442 .section "The LOGIN authentication mechanism" "SECID173"
26443 .cindex "LOGIN authentication mechanism"
26444 .cindex "authentication" "LOGIN mechanism"
26445 The LOGIN authentication mechanism is not documented in any RFC, but is in use
26446 in a number of programs. No data is sent with the AUTH command. Instead, a
26447 user name and password are supplied separately, in response to prompts. The
26448 plaintext authenticator can be configured to support this as in this example:
26449 .code
26450 fixed_login:
26451   driver = plaintext
26452   public_name = LOGIN
26453   server_prompts = User Name : Password
26454   server_condition = \
26455     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
26456   server_set_id = $auth1
26457 .endd
26458 Because of the way plaintext operates, this authenticator accepts data supplied
26459 with the AUTH command (in contravention of the specification of LOGIN), but
26460 if the client does not supply it (as is the case for LOGIN clients), the prompt
26461 strings are used to obtain two data items.
26462
26463 Some clients are very particular about the precise text of the prompts. For
26464 example, Outlook Express is reported to recognize only &"Username:"& and
26465 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
26466 strings. It uses the &%ldapauth%& expansion condition to check the user
26467 name and password by binding to an LDAP server:
26468 .code
26469 login:
26470   driver = plaintext
26471   public_name = LOGIN
26472   server_prompts = Username:: : Password::
26473   server_condition = ${if and{{ \
26474     !eq{}{$auth1} }{ \
26475     ldapauth{\
26476       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
26477       pass=${quote:$auth2} \
26478       ldap://ldap.example.org/} }} }
26479   server_set_id = uid=$auth1,ou=people,o=example.org
26480 .endd
26481 We have to check that the username is not empty before using it, because LDAP
26482 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
26483 operator to correctly quote the DN for authentication. However, the basic
26484 &%quote%& operator, rather than any of the LDAP quoting operators, is the
26485 correct one to use for the password, because quoting is needed only to make
26486 the password conform to the Exim syntax. At the LDAP level, the password is an
26487 uninterpreted string.
26488
26489
26490 .section "Support for different kinds of authentication" "SECID174"
26491 A number of string expansion features are provided for the purpose of
26492 interfacing to different ways of user authentication. These include checking
26493 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
26494 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
26495 &<<SECTexpcond>>&.
26496
26497
26498
26499
26500 .section "Using plaintext in a client" "SECID175"
26501 .cindex "options" "&(plaintext)& authenticator (client)"
26502 The &(plaintext)& authenticator has two client options:
26503
26504 .option client_ignore_invalid_base64 plaintext boolean false
26505 If the client receives a server prompt that is not a valid base64 string,
26506 authentication is abandoned by default. However, if this option is set true,
26507 the error in the challenge is ignored and the client sends the response as
26508 usual.
26509
26510 .option client_send plaintext string&!! unset
26511 The string is a colon-separated list of authentication data strings. Each
26512 string is independently expanded before being sent to the server. The first
26513 string is sent with the AUTH command; any more strings are sent in response
26514 to prompts from the server. Before each string is expanded, the value of the
26515 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
26516 with &$auth1$& for the first prompt. Up to three prompts are stored in this
26517 way. Thus, the prompt that is received in response to sending the first string
26518 (with the AUTH command) can be used in the expansion of the second string, and
26519 so on. If an invalid base64 string is received when
26520 &%client_ignore_invalid_base64%& is set, an empty string is put in the
26521 &$auth$&<&'n'&> variable.
26522
26523 &*Note*&: You cannot use expansion to create multiple strings, because
26524 splitting takes priority and happens first.
26525
26526 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
26527 the data, further processing is applied to each string before it is sent. If
26528 there are any single circumflex characters in the string, they are converted to
26529 NULs. Should an actual circumflex be required as data, it must be doubled in
26530 the string.
26531
26532 This is an example of a client configuration that implements the PLAIN
26533 authentication mechanism with a fixed user name and password:
26534 .code
26535 fixed_plain:
26536   driver = plaintext
26537   public_name = PLAIN
26538   client_send = ^username^mysecret
26539 .endd
26540 The lack of colons means that the entire text is sent with the AUTH
26541 command, with the circumflex characters converted to NULs. A similar example
26542 that uses the LOGIN mechanism is:
26543 .code
26544 fixed_login:
26545   driver = plaintext
26546   public_name = LOGIN
26547   client_send = : username : mysecret
26548 .endd
26549 The initial colon means that the first string is empty, so no data is sent with
26550 the AUTH command itself. The remaining strings are sent in response to
26551 prompts.
26552 .ecindex IIDplaiauth1
26553 .ecindex IIDplaiauth2
26554
26555
26556
26557
26558 . ////////////////////////////////////////////////////////////////////////////
26559 . ////////////////////////////////////////////////////////////////////////////
26560
26561 .chapter "The cram_md5 authenticator" "CHID9"
26562 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
26563 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
26564 .cindex "CRAM-MD5 authentication mechanism"
26565 .cindex "authentication" "CRAM-MD5 mechanism"
26566 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
26567 sends a challenge string to the client, and the response consists of a user
26568 name and the CRAM-MD5 digest of the challenge string combined with a secret
26569 string (password) which is known to both server and client. Thus, the secret
26570 is not sent over the network as plain text, which makes this authenticator more
26571 secure than &(plaintext)&. However, the downside is that the secret has to be
26572 available in plain text at either end.
26573
26574
26575 .section "Using cram_md5 as a server" "SECID176"
26576 .cindex "options" "&(cram_md5)& authenticator (server)"
26577 This authenticator has one server option, which must be set to configure the
26578 authenticator as a server:
26579
26580 .option server_secret cram_md5 string&!! unset
26581 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
26582 When the server receives the client's response, the user name is placed in
26583 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
26584 obtain the password for that user. The server then computes the CRAM-MD5 digest
26585 that the client should have sent, and checks that it received the correct
26586 string. If the expansion of &%server_secret%& is forced to fail, authentication
26587 fails. If the expansion fails for some other reason, a temporary error code is
26588 returned to the client.
26589
26590 For compatibility with previous releases of Exim, the user name is also placed
26591 in &$1$&. However, the use of this variables for this purpose is now
26592 deprecated, as it can lead to confusion in string expansions that also use
26593 numeric variables for other things.
26594
26595 For example, the following authenticator checks that the user name given by the
26596 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
26597 user name, authentication fails.
26598 .code
26599 fixed_cram:
26600   driver = cram_md5
26601   public_name = CRAM-MD5
26602   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
26603   server_set_id = $auth1
26604 .endd
26605 .vindex "&$authenticated_id$&"
26606 If authentication succeeds, the setting of &%server_set_id%& preserves the user
26607 name in &$authenticated_id$&. A more typical configuration might look up the
26608 secret string in a file, using the user name as the key. For example:
26609 .code
26610 lookup_cram:
26611   driver = cram_md5
26612   public_name = CRAM-MD5
26613   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
26614                   {$value}fail}
26615   server_set_id = $auth1
26616 .endd
26617 Note that this expansion explicitly forces failure if the lookup fails
26618 because &$auth1$& contains an unknown user name.
26619
26620 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
26621 using the relevant libraries, you need to know the realm to specify in the
26622 lookup and then ask for the &"userPassword"& attribute for that user in that
26623 realm, with:
26624 .code
26625 cyrusless_crammd5:
26626   driver = cram_md5
26627   public_name = CRAM-MD5
26628   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
26629                   dbmjz{/etc/sasldb2}{$value}fail}
26630   server_set_id = $auth1
26631 .endd
26632
26633 .section "Using cram_md5 as a client" "SECID177"
26634 .cindex "options" "&(cram_md5)& authenticator (client)"
26635 When used as a client, the &(cram_md5)& authenticator has two options:
26636
26637
26638
26639 .option client_name cram_md5 string&!! "the primary host name"
26640 This string is expanded, and the result used as the user name data when
26641 computing the response to the server's challenge.
26642
26643
26644 .option client_secret cram_md5 string&!! unset
26645 This option must be set for the authenticator to work as a client. Its value is
26646 expanded and the result used as the secret string when computing the response.
26647
26648
26649 .vindex "&$host$&"
26650 .vindex "&$host_address$&"
26651 Different user names and secrets can be used for different servers by referring
26652 to &$host$& or &$host_address$& in the options. Forced failure of either
26653 expansion string is treated as an indication that this authenticator is not
26654 prepared to handle this case. Exim moves on to the next configured client
26655 authenticator. Any other expansion failure causes Exim to give up trying to
26656 send the message to the current server.
26657
26658 A simple example configuration of a &(cram_md5)& authenticator, using fixed
26659 strings, is:
26660 .code
26661 fixed_cram:
26662   driver = cram_md5
26663   public_name = CRAM-MD5
26664   client_name = ph10
26665   client_secret = secret
26666 .endd
26667 .ecindex IIDcramauth1
26668 .ecindex IIDcramauth2
26669
26670
26671
26672 . ////////////////////////////////////////////////////////////////////////////
26673 . ////////////////////////////////////////////////////////////////////////////
26674
26675 .chapter "The cyrus_sasl authenticator" "CHID10"
26676 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
26677 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
26678 .cindex "Cyrus" "SASL library"
26679 .cindex "Kerberos"
26680 The code for this authenticator was provided by Matthew Byng-Maddick of A L
26681 Digital Ltd (&url(http://www.aldigital.co.uk)).
26682
26683 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
26684 library implementation of the RFC 2222 (&"Simple Authentication and Security
26685 Layer"&). This library supports a number of authentication mechanisms,
26686 including PLAIN and LOGIN, but also several others that Exim does not support
26687 directly. In particular, there is support for Kerberos authentication.
26688
26689 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
26690 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
26691 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
26692 name of the driver to determine which mechanism to support.
26693
26694 Where access to some kind of secret file is required, for example in GSSAPI
26695 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
26696 user, and that the Cyrus SASL library has no way of escalating privileges
26697 by default. You may also find you need to set environment variables,
26698 depending on the driver you are using.
26699
26700 The application name provided by Exim is &"exim"&, so various SASL options may
26701 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
26702 Kerberos, note that because of limitations in the GSSAPI interface,
26703 changing the server keytab might need to be communicated down to the Kerberos
26704 layer independently. The mechanism for doing so is dependent upon the Kerberos
26705 implementation.
26706
26707 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
26708 may be set to point to an alternative keytab file. Exim will pass this
26709 variable through from its own inherited environment when started as root or the
26710 Exim user. The keytab file needs to be readable by the Exim user.
26711 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
26712 environment variable.  In practice, for those releases, the Cyrus authenticator
26713 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
26714 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
26715
26716
26717 .section "Using cyrus_sasl as a server" "SECID178"
26718 The &(cyrus_sasl)& authenticator has four private options. It puts the username
26719 (on a successful authentication) into &$auth1$&. For compatibility with
26720 previous releases of Exim, the username is also placed in &$1$&. However, the
26721 use of this variable for this purpose is now deprecated, as it can lead to
26722 confusion in string expansions that also use numeric variables for other
26723 things.
26724
26725
26726 .option server_hostname cyrus_sasl string&!! "see below"
26727 This option selects the hostname that is used when communicating with the
26728 library. The default value is &`$primary_hostname`&. It is up to the underlying
26729 SASL plug-in what it does with this data.
26730
26731
26732 .option server_mech cyrus_sasl string "see below"
26733 This option selects the authentication mechanism this driver should use. The
26734 default is the value of the generic &%public_name%& option. This option allows
26735 you to use a different underlying mechanism from the advertised name. For
26736 example:
26737 .code
26738 sasl:
26739   driver = cyrus_sasl
26740   public_name = X-ANYTHING
26741   server_mech = CRAM-MD5
26742   server_set_id = $auth1
26743 .endd
26744
26745 .option server_realm cyrus_sasl string&!! unset
26746 This specifies the SASL realm that the server claims to be in.
26747
26748
26749 .option server_service cyrus_sasl string &`smtp`&
26750 This is the SASL service that the server claims to implement.
26751
26752
26753 For straightforward cases, you do not need to set any of the authenticator's
26754 private options. All you need to do is to specify an appropriate mechanism as
26755 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
26756 PLAIN, you could have two authenticators as follows:
26757 .code
26758 sasl_cram_md5:
26759   driver = cyrus_sasl
26760   public_name = CRAM-MD5
26761   server_set_id = $auth1
26762
26763 sasl_plain:
26764   driver = cyrus_sasl
26765   public_name = PLAIN
26766   server_set_id = $auth2
26767 .endd
26768 Cyrus SASL does implement the LOGIN authentication method, even though it is
26769 not a standard method. It is disabled by default in the source distribution,
26770 but it is present in many binary distributions.
26771 .ecindex IIDcyrauth1
26772 .ecindex IIDcyrauth2
26773
26774
26775
26776
26777 . ////////////////////////////////////////////////////////////////////////////
26778 . ////////////////////////////////////////////////////////////////////////////
26779 .chapter "The dovecot authenticator" "CHAPdovecot"
26780 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
26781 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
26782 This authenticator is an interface to the authentication facility of the
26783 Dovecot POP/IMAP server, which can support a number of authentication methods.
26784 Note that Dovecot must be configured to use auth-client not auth-userdb.
26785 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
26786 to use the same mechanisms for SMTP authentication. This is a server
26787 authenticator only. There is only one option:
26788
26789 .option server_socket dovecot string unset
26790
26791 This option must specify the socket that is the interface to Dovecot
26792 authentication. The &%public_name%& option must specify an authentication
26793 mechanism that Dovecot is configured to support. You can have several
26794 authenticators for different mechanisms. For example:
26795 .code
26796 dovecot_plain:
26797   driver = dovecot
26798   public_name = PLAIN
26799   server_socket = /var/run/dovecot/auth-client
26800   server_set_id = $auth1
26801
26802 dovecot_ntlm:
26803   driver = dovecot
26804   public_name = NTLM
26805   server_socket = /var/run/dovecot/auth-client
26806   server_set_id = $auth1
26807 .endd
26808 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
26809 &$received_ip_address$& (that is, the connection is local), the &"secured"&
26810 option is passed in the Dovecot authentication command. If, for a TLS
26811 connection, a client certificate has been verified, the &"valid-client-cert"&
26812 option is passed. When authentication succeeds, the identity of the user
26813 who authenticated is placed in &$auth1$&.
26814 .ecindex IIDdcotauth1
26815 .ecindex IIDdcotauth2
26816
26817
26818 . ////////////////////////////////////////////////////////////////////////////
26819 . ////////////////////////////////////////////////////////////////////////////
26820 .chapter "The gsasl authenticator" "CHAPgsasl"
26821 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
26822 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
26823 .cindex "authentication" "GNU SASL"
26824 .cindex "authentication" "SASL"
26825 .cindex "authentication" "EXTERNAL"
26826 .cindex "authentication" "ANONYMOUS"
26827 .cindex "authentication" "PLAIN"
26828 .cindex "authentication" "LOGIN"
26829 .cindex "authentication" "DIGEST-MD5"
26830 .cindex "authentication" "CRAM-MD5"
26831 .cindex "authentication" "SCRAM-SHA-1"
26832 The &(gsasl)& authenticator provides server integration for the GNU SASL
26833 library and the mechanisms it provides.  This is new as of the 4.80 release
26834 and there are a few areas where the library does not let Exim smoothly
26835 scale to handle future authentication mechanisms, so no guarantee can be
26836 made that any particular new authentication mechanism will be supported
26837 without code changes in Exim.
26838
26839
26840 .option server_channelbinding gsasl boolean false
26841 Some authentication mechanisms are able to use external context at both ends
26842 of the session to bind the authentication to that context, and fail the
26843 authentication process if that context differs.  Specifically, some TLS
26844 ciphersuites can provide identifying information about the cryptographic
26845 context.
26846
26847 This means that certificate identity and verification becomes a non-issue,
26848 as a man-in-the-middle attack will cause the correct client and server to
26849 see different identifiers and authentication will fail.
26850
26851 This is currently only supported when using the GnuTLS library.  This is
26852 only usable by mechanisms which support "channel binding"; at time of
26853 writing, that's the SCRAM family.
26854
26855 This defaults off to ensure smooth upgrade across Exim releases, in case
26856 this option causes some clients to start failing.  Some future release
26857 of Exim may switch the default to be true.
26858
26859
26860 .option server_hostname gsasl string&!! "see below"
26861 This option selects the hostname that is used when communicating with the
26862 library. The default value is &`$primary_hostname`&.
26863 Some mechanisms will use this data.
26864
26865
26866 .option server_mech gsasl string "see below"
26867 This option selects the authentication mechanism this driver should use. The
26868 default is the value of the generic &%public_name%& option. This option allows
26869 you to use a different underlying mechanism from the advertised name. For
26870 example:
26871 .code
26872 sasl:
26873   driver = gsasl
26874   public_name = X-ANYTHING
26875   server_mech = CRAM-MD5
26876   server_set_id = $auth1
26877 .endd
26878
26879
26880 .option server_password gsasl string&!! unset
26881 Various mechanisms need access to the cleartext password on the server, so
26882 that proof-of-possession can be demonstrated on the wire, without sending
26883 the password itself.
26884
26885 The data available for lookup varies per mechanism.
26886 In all cases, &$auth1$& is set to the &'authentication id'&.
26887 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
26888 if available, else the empty string.
26889 The &$auth3$& variable will always be the &'realm'& if available,
26890 else the empty string.
26891
26892 A forced failure will cause authentication to defer.
26893
26894 If using this option, it may make sense to set the &%server_condition%&
26895 option to be simply "true".
26896
26897
26898 .option server_realm gsasl string&!! unset
26899 This specifies the SASL realm that the server claims to be in.
26900 Some mechanisms will use this data.
26901
26902
26903 .option server_scram_iter gsasl string&!! unset
26904 This option provides data for the SCRAM family of mechanisms.
26905 &$auth1$& is not available at evaluation time.
26906 (This may change, as we receive feedback on use)
26907
26908
26909 .option server_scram_salt gsasl string&!! unset
26910 This option provides data for the SCRAM family of mechanisms.
26911 &$auth1$& is not available at evaluation time.
26912 (This may change, as we receive feedback on use)
26913
26914
26915 .option server_service gsasl string &`smtp`&
26916 This is the SASL service that the server claims to implement.
26917 Some mechanisms will use this data.
26918
26919
26920 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
26921 .vindex "&$auth1$&, &$auth2$&, etc"
26922 These may be set when evaluating specific options, as detailed above.
26923 They will also be set when evaluating &%server_condition%&.
26924
26925 Unless otherwise stated below, the &(gsasl)& integration will use the following
26926 meanings for these variables:
26927
26928 .ilist
26929 .vindex "&$auth1$&"
26930 &$auth1$&: the &'authentication id'&
26931 .next
26932 .vindex "&$auth2$&"
26933 &$auth2$&: the &'authorization id'&
26934 .next
26935 .vindex "&$auth3$&"
26936 &$auth3$&: the &'realm'&
26937 .endlist
26938
26939 On a per-mechanism basis:
26940
26941 .ilist
26942 .cindex "authentication" "EXTERNAL"
26943 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
26944 the &%server_condition%& option must be present.
26945 .next
26946 .cindex "authentication" "ANONYMOUS"
26947 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
26948 the &%server_condition%& option must be present.
26949 .next
26950 .cindex "authentication" "GSSAPI"
26951 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
26952 &$auth2$& will be set to the &'authorization id'&,
26953 the &%server_condition%& option must be present.
26954 .endlist
26955
26956 An &'anonymous token'& is something passed along as an unauthenticated
26957 identifier; this is analogous to FTP anonymous authentication passing an
26958 email address, or software-identifier@, as the "password".
26959
26960
26961 An example showing the password having the realm specified in the callback
26962 and demonstrating a Cyrus SASL to GSASL migration approach is:
26963 .code
26964 gsasl_cyrusless_crammd5:
26965   driver = gsasl
26966   public_name = CRAM-MD5
26967   server_realm = imap.example.org
26968   server_password = ${lookup{$auth1:$auth3:userPassword}\
26969                     dbmjz{/etc/sasldb2}{$value}fail}
26970   server_set_id = ${quote:$auth1}
26971   server_condition = yes
26972 .endd
26973
26974
26975 . ////////////////////////////////////////////////////////////////////////////
26976 . ////////////////////////////////////////////////////////////////////////////
26977
26978 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
26979 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
26980 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
26981 .cindex "authentication" "GSSAPI"
26982 .cindex "authentication" "Kerberos"
26983 The &(heimdal_gssapi)& authenticator provides server integration for the
26984 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
26985 reliably.
26986
26987 .option server_hostname heimdal_gssapi string&!! "see below"
26988 This option selects the hostname that is used, with &%server_service%&,
26989 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
26990 identifier.  The default value is &`$primary_hostname`&.
26991
26992 .option server_keytab heimdal_gssapi string&!! unset
26993 If set, then Heimdal will not use the system default keytab (typically
26994 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
26995 The value should be a pathname, with no &"file:"& prefix.
26996
26997 .option server_service heimdal_gssapi string&!! "smtp"
26998 This option specifies the service identifier used, in conjunction with
26999 &%server_hostname%&, for building the identifier for finding credentials
27000 from the keytab.
27001
27002
27003 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
27004 Beware that these variables will typically include a realm, thus will appear
27005 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
27006 not verified, so a malicious client can set it to anything.
27007
27008 The &$auth1$& field should be safely trustable as a value from the Key
27009 Distribution Center.  Note that these are not quite email addresses.
27010 Each identifier is for a role, and so the left-hand-side may include a
27011 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
27012
27013 .vindex "&$auth1$&, &$auth2$&, etc"
27014 .ilist
27015 .vindex "&$auth1$&"
27016 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
27017 .next
27018 .vindex "&$auth2$&"
27019 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
27020 authentication.  If that was empty, this will also be set to the
27021 GSS Display Name.
27022 .endlist
27023
27024
27025 . ////////////////////////////////////////////////////////////////////////////
27026 . ////////////////////////////////////////////////////////////////////////////
27027
27028 .chapter "The spa authenticator" "CHAPspa"
27029 .scindex IIDspaauth1 "&(spa)& authenticator"
27030 .scindex IIDspaauth2 "authenticators" "&(spa)&"
27031 .cindex "authentication" "Microsoft Secure Password"
27032 .cindex "authentication" "NTLM"
27033 .cindex "Microsoft Secure Password Authentication"
27034 .cindex "NTLM authentication"
27035 The &(spa)& authenticator provides client support for Microsoft's &'Secure
27036 Password Authentication'& mechanism,
27037 which is also sometimes known as NTLM (NT LanMan). The code for client side of
27038 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
27039 taken from the Samba project (&url(http://www.samba.org)). The code for the
27040 server side was subsequently contributed by Tom Kistner. The mechanism works as
27041 follows:
27042
27043 .ilist
27044 After the AUTH command has been accepted, the client sends an SPA
27045 authentication request based on the user name and optional domain.
27046 .next
27047 The server sends back a challenge.
27048 .next
27049 The client builds a challenge response which makes use of the user's password
27050 and sends it to the server, which then accepts or rejects it.
27051 .endlist
27052
27053 Encryption is used to protect the password in transit.
27054
27055
27056
27057 .section "Using spa as a server" "SECID179"
27058 .cindex "options" "&(spa)& authenticator (server)"
27059 The &(spa)& authenticator has just one server option:
27060
27061 .option server_password spa string&!! unset
27062 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
27063 This option is expanded, and the result must be the cleartext password for the
27064 authenticating user, whose name is at this point in &$auth1$&. For
27065 compatibility with previous releases of Exim, the user name is also placed in
27066 &$1$&. However, the use of this variable for this purpose is now deprecated, as
27067 it can lead to confusion in string expansions that also use numeric variables
27068 for other things. For example:
27069 .code
27070 spa:
27071   driver = spa
27072   public_name = NTLM
27073   server_password = \
27074     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
27075 .endd
27076 If the expansion is forced to fail, authentication fails. Any other expansion
27077 failure causes a temporary error code to be returned.
27078
27079
27080
27081
27082
27083 .section "Using spa as a client" "SECID180"
27084 .cindex "options" "&(spa)& authenticator (client)"
27085 The &(spa)& authenticator has the following client options:
27086
27087
27088
27089 .option client_domain spa string&!! unset
27090 This option specifies an optional domain for the authentication.
27091
27092
27093 .option client_password spa string&!! unset
27094 This option specifies the user's password, and must be set.
27095
27096
27097 .option client_username spa string&!! unset
27098 This option specifies the user name, and must be set. Here is an example of a
27099 configuration of this authenticator for use with the mail servers at
27100 &'msn.com'&:
27101 .code
27102 msn:
27103   driver = spa
27104   public_name = MSN
27105   client_username = msn/msn_username
27106   client_password = msn_plaintext_password
27107   client_domain = DOMAIN_OR_UNSET
27108 .endd
27109 .ecindex IIDspaauth1
27110 .ecindex IIDspaauth2
27111
27112
27113
27114
27115
27116 . ////////////////////////////////////////////////////////////////////////////
27117 . ////////////////////////////////////////////////////////////////////////////
27118
27119 .chapter "The tls authenticator" "CHAPtlsauth"
27120 .scindex IIDtlsauth1 "&(tls)& authenticator"
27121 .scindex IIDtlsauth2 "authenticators" "&(tls)&"
27122 .cindex "authentication" "Client Certificate"
27123 .cindex "authentication" "X509"
27124 .cindex "Certificate-based authentication"
27125 The &(tls)& authenticator provides server support for
27126 authentication based on client certificates.
27127
27128 It is not an SMTP authentication mechanism and is not
27129 advertised by the server as part of the SMTP EHLO response.
27130 It is an Exim authenticator in the sense that it affects
27131 the protocol element of the log line, can be tested for
27132 by the &%authenticated%& ACL condition, and can set
27133 the &$authenticated_id$& variable.
27134
27135 The client must present a verifiable certificate,
27136 for which it must have been requested via the
27137 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
27138 (see &<<CHAPTLS>>&).
27139
27140 If an authenticator of this type is configured it is
27141 run before any SMTP-level communication is done,
27142 and can authenticate the connection.
27143 If it does, SMTP authentication is not offered.
27144
27145 A maximum of one authenticator of this type may be present.
27146
27147
27148 .cindex "options" "&(tls)& authenticator (server)"
27149 The &(tls)& authenticator has three server options:
27150
27151 .option server_param1 tls string&!! unset
27152 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(tls)& authenticator"
27153 This option is expanded after the TLS negotiation and
27154 the result is placed in &$auth1$&.
27155 If the expansion is forced to fail, authentication fails. Any other expansion
27156 failure causes a temporary error code to be returned.
27157
27158 .option server_param2 tls string&!! unset
27159 .option server_param3 tls string&!! unset
27160 As above, for &$auth2$& and &$auth3$&.
27161
27162 &%server_param1%& may also be spelled &%server_param%&.
27163
27164
27165 Example:
27166 .code
27167 tls:
27168   driver = tls
27169   server_param1 =     ${certextract {subj_altname,mail,>:} \
27170                                     {$tls_in_peercert}}
27171   server_condition =  ${if forany {$auth1} \
27172                             {!= {0} \
27173                                 {${lookup ldap{ldap:///\
27174                          mailname=${quote_ldap_dn:${lc:$item}},\
27175                          ou=users,LDAP_DC?mailid} {$value}{0} \
27176                        }    }   } }
27177   server_set_id =     ${if = {1}{${listcount:$auth1}} {$auth1}{}}
27178 .endd
27179 This accepts a client certificate that is verifiable against any
27180 of your configured trust-anchors
27181 (which usually means the full set of public CAs)
27182 and which has a SAN with a good account name.
27183 Note that the client cert is on the wire in-clear, including the SAN,
27184 whereas a plaintext SMTP AUTH done inside TLS is not.
27185
27186 . An alternative might use
27187 . .code
27188 .   server_param1 = ${sha256:$tls_in_peercert}
27189 . .endd
27190 . to require one of a set of specific certs that define a given account
27191 . (the verification is still required, but mostly irrelevant).
27192 . This would help for per-device use.
27193 .
27194 . However, for the future we really need support for checking a
27195 . user cert in LDAP - which probably wants a base-64 DER.
27196
27197 .ecindex IIDtlsauth1
27198 .ecindex IIDtlsauth2
27199
27200
27201 Note that because authentication is traditionally an SMTP operation,
27202 the &%authenticated%& ACL condition cannot be used in
27203 a connect- or helo-ACL.
27204
27205
27206
27207 . ////////////////////////////////////////////////////////////////////////////
27208 . ////////////////////////////////////////////////////////////////////////////
27209
27210 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
27211          "Encrypted SMTP connections"
27212 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
27213 .scindex IIDencsmtp2 "SMTP" "encryption"
27214 .cindex "TLS" "on SMTP connection"
27215 .cindex "OpenSSL"
27216 .cindex "GnuTLS"
27217 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
27218 Sockets Layer), is implemented by making use of the OpenSSL library or the
27219 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
27220 cryptographic code in the Exim distribution itself for implementing TLS. In
27221 order to use this feature you must install OpenSSL or GnuTLS, and then build a
27222 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
27223 You also need to understand the basic concepts of encryption at a managerial
27224 level, and in particular, the way that public keys, private keys, and
27225 certificates are used.
27226
27227 RFC 3207 defines how SMTP connections can make use of encryption. Once a
27228 connection is established, the client issues a STARTTLS command. If the
27229 server accepts this, the client and the server negotiate an encryption
27230 mechanism. If the negotiation succeeds, the data that subsequently passes
27231 between them is encrypted.
27232
27233 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
27234 and if so, what cipher suite is in use, whether the client supplied a
27235 certificate, and whether or not that certificate was verified. This makes it
27236 possible for an Exim server to deny or accept certain commands based on the
27237 encryption state.
27238
27239 &*Warning*&: Certain types of firewall and certain anti-virus products can
27240 disrupt TLS connections. You need to turn off SMTP scanning for these products
27241 in order to get TLS to work.
27242
27243
27244
27245 .section "Support for the &""submissions""& (aka &""ssmtp""& and &""smtps""&) protocol" &&&
27246          "SECID284"
27247 .cindex "submissions protocol"
27248 .cindex "ssmtp protocol"
27249 .cindex "smtps protocol"
27250 .cindex "SMTP" "submissions protocol"
27251 .cindex "SMTP" "ssmtp protocol"
27252 .cindex "SMTP" "smtps protocol"
27253 The history of port numbers for TLS in SMTP is a little messy and has been
27254 contentious.  As of RFC 8314, the common practice of using the historically
27255 allocated port 465 for "email submission but with TLS immediately upon connect
27256 instead of using STARTTLS" is officially blessed by the IETF, and recommended
27257 in preference to STARTTLS.
27258
27259 The name originally assigned to the port was &"ssmtp"& or &"smtps"&, but as
27260 clarity emerged over the dual roles of SMTP, for MX delivery and Email
27261 Submission, nomenclature has shifted.  The modern name is now &"submissions"&.
27262
27263 This approach was, for a while, officially abandoned when encrypted SMTP was
27264 standardized, but many clients kept using it, even as the TCP port number was
27265 reassigned for other use.
27266 Thus you may encounter guidance claiming that you shouldn't enable use of
27267 this port.
27268 In practice, a number of mail-clients have only supported submissions, not
27269 submission with STARTTLS upgrade.
27270 Ideally, offer both submission (587) and submissions (465) service.
27271
27272 Exim supports TLS-on-connect by means of the &%tls_on_connect_ports%&
27273 global option. Its value must be a list of port numbers;
27274 the most common use is expected to be:
27275 .code
27276 tls_on_connect_ports = 465
27277 .endd
27278 The port numbers specified by this option apply to all SMTP connections, both
27279 via the daemon and via &'inetd'&. You still need to specify all the ports that
27280 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
27281 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
27282 an extra port &-- rather, it specifies different behaviour on a port that is
27283 defined elsewhere.
27284
27285 There is also a &%-tls-on-connect%& command line option. This overrides
27286 &%tls_on_connect_ports%&; it forces the TLS-only behaviour for all ports.
27287
27288
27289
27290
27291
27292
27293 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
27294 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
27295 The first TLS support in Exim was implemented using OpenSSL. Support for GnuTLS
27296 followed later, when the first versions of GnuTLS were released. To build Exim
27297 to use GnuTLS, you need to set
27298 .code
27299 USE_GNUTLS=yes
27300 .endd
27301 in Local/Makefile, in addition to
27302 .code
27303 SUPPORT_TLS=yes
27304 .endd
27305 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
27306 include files and libraries for GnuTLS can be found.
27307
27308 There are some differences in usage when using GnuTLS instead of OpenSSL:
27309
27310 .ilist
27311 The &%tls_verify_certificates%& option
27312 cannot be the path of a directory
27313 for GnuTLS versions before 3.3.6
27314 (for later versions, or OpenSSL, it can be either).
27315 .next
27316 The default value for &%tls_dhparam%& differs for historical reasons.
27317 .next
27318 .vindex "&$tls_in_peerdn$&"
27319 .vindex "&$tls_out_peerdn$&"
27320 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
27321 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
27322 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
27323 .next
27324 OpenSSL identifies cipher suites using hyphens as separators, for example:
27325 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
27326 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
27327 in a cipher list. To make life simpler, Exim changes underscores to hyphens
27328 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
27329 to handle its own older variants) when processing lists of cipher suites in the
27330 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
27331 option).
27332 .next
27333 The &%tls_require_ciphers%& options operate differently, as described in the
27334 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
27335 .next
27336 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
27337 When using OpenSSL, this option is ignored.
27338 (If an API is found to let OpenSSL be configured in this way,
27339 let the Exim Maintainers know and we'll likely use it).
27340 .next
27341 With GnuTLS, if an explicit list is used for the &%tls_privatekey%& main option
27342 main option, it must be ordered to match the &%tls_certificate%& list.
27343 .next
27344 Some other recently added features may only be available in one or the other.
27345 This should be documented with the feature.  If the documentation does not
27346 explicitly state that the feature is infeasible in the other TLS
27347 implementation, then patches are welcome.
27348 .endlist
27349
27350
27351 .section "GnuTLS parameter computation" "SECTgnutlsparam"
27352 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
27353 an explicit path; if the latter, then the text about generation still applies,
27354 but not the chosen filename.
27355 By default, as of Exim 4.80 a hard-coded D-H prime is used.
27356 See the documentation of &%tls_dhparam%& for more information.
27357
27358 GnuTLS uses D-H parameters that may take a substantial amount of time
27359 to compute. It is unreasonable to re-compute them for every TLS session.
27360 Therefore, Exim keeps this data in a file in its spool directory, called
27361 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
27362 of bits requested.
27363 The file is owned by the Exim user and is readable only by
27364 its owner. Every Exim process that start up GnuTLS reads the D-H
27365 parameters from this file. If the file does not exist, the first Exim process
27366 that needs it computes the data and writes it to a temporary file which is
27367 renamed once it is complete. It does not matter if several Exim processes do
27368 this simultaneously (apart from wasting a few resources). Once a file is in
27369 place, new Exim processes immediately start using it.
27370
27371 For maximum security, the parameters that are stored in this file should be
27372 recalculated periodically, the frequency depending on your paranoia level.
27373 If you are avoiding using the fixed D-H primes published in RFCs, then you
27374 are concerned about some advanced attacks and will wish to do this; if you do
27375 not regenerate then you might as well stick to the standard primes.
27376
27377 Arranging this is easy in principle; just delete the file when you want new
27378 values to be computed. However, there may be a problem. The calculation of new
27379 parameters needs random numbers, and these are obtained from &_/dev/random_&.
27380 If the system is not very active, &_/dev/random_& may delay returning data
27381 until enough randomness (entropy) is available. This may cause Exim to hang for
27382 a substantial amount of time, causing timeouts on incoming connections.
27383
27384 The solution is to generate the parameters externally to Exim. They are stored
27385 in &_gnutls-params-N_& in PEM format, which means that they can be
27386 generated externally using the &(certtool)& command that is part of GnuTLS.
27387
27388 To replace the parameters with new ones, instead of deleting the file
27389 and letting Exim re-create it, you can generate new parameters using
27390 &(certtool)& and, when this has been done, replace Exim's cache file by
27391 renaming. The relevant commands are something like this:
27392 .code
27393 # ls
27394 [ look for file; assume gnutls-params-2236 is the most recent ]
27395 # rm -f new-params
27396 # touch new-params
27397 # chown exim:exim new-params
27398 # chmod 0600 new-params
27399 # certtool --generate-dh-params --bits 2236 >>new-params
27400 # openssl dhparam -noout -text -in new-params | head
27401 [ check the first line, make sure it's not more than 2236;
27402   if it is, then go back to the start ("rm") and repeat
27403   until the size generated is at most the size requested ]
27404 # chmod 0400 new-params
27405 # mv new-params gnutls-params-2236
27406 .endd
27407 If Exim never has to generate the parameters itself, the possibility of
27408 stalling is removed.
27409
27410 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
27411 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
27412 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
27413 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
27414 and Exim does so.  This attempt to remove Exim from TLS policy decisions
27415 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
27416 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
27417 which applies to all D-H usage, client or server.  If the value returned by
27418 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
27419 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
27420 limit, which is still much higher than Exim historically used.
27421
27422 The filename and bits used will change as the GnuTLS maintainers change the
27423 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
27424 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
27425 2432 bits, while NSS is limited to 2236 bits.
27426
27427 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
27428 increase the chance of the generated prime actually being within acceptable
27429 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
27430 procedure above.  There is no sane procedure available to Exim to double-check
27431 the size of the generated prime, so it might still be too large.
27432
27433
27434 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
27435 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
27436 .oindex "&%tls_require_ciphers%&" "OpenSSL"
27437 There is a function in the OpenSSL library that can be passed a list of cipher
27438 suites before the cipher negotiation takes place. This specifies which ciphers
27439 are acceptable. The list is colon separated and may contain names like
27440 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
27441 directly to this function call.
27442 Many systems will install the OpenSSL manual-pages, so you may have
27443 &'ciphers(1)'& available to you.
27444 The following quotation from the OpenSSL
27445 documentation specifies what forms of item are allowed in the cipher string:
27446
27447 .ilist
27448 It can consist of a single cipher suite such as RC4-SHA.
27449 .next
27450 It can represent a list of cipher suites containing a certain algorithm,
27451 or cipher suites of a certain type. For example SHA1 represents all
27452 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
27453 SSL v3 algorithms.
27454 .next
27455 Lists of cipher suites can be combined in a single cipher string using
27456 the + character. This is used as a logical and operation. For example
27457 SHA1+DES represents all cipher suites containing the SHA1 and the DES
27458 algorithms.
27459 .endlist
27460
27461 Each cipher string can be optionally preceded by one of the characters &`!`&,
27462 &`-`& or &`+`&.
27463 .ilist
27464 If &`!`& is used, the ciphers are permanently deleted from the list. The
27465 ciphers deleted can never reappear in the list even if they are explicitly
27466 stated.
27467 .next
27468 If &`-`& is used, the ciphers are deleted from the list, but some or all
27469 of the ciphers can be added again by later options.
27470 .next
27471 If &`+`& is used, the ciphers are moved to the end of the list. This
27472 option does not add any new ciphers; it just moves matching existing ones.
27473 .endlist
27474
27475 If none of these characters is present, the string is interpreted as
27476 a list of ciphers to be appended to the current preference list. If the list
27477 includes any ciphers already present they will be ignored: that is, they will
27478 not be moved to the end of the list.
27479 .endlist
27480
27481 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
27482 string:
27483 .code
27484 # note single-quotes to get ! past any shell history expansion
27485 $ openssl ciphers 'HIGH:!MD5:!SHA1'
27486 .endd
27487
27488 This example will let the library defaults be permitted on the MX port, where
27489 there's probably no identity verification anyway, but ups the ante on the
27490 submission ports where the administrator might have some influence on the
27491 choice of clients used:
27492 .code
27493 # OpenSSL variant; see man ciphers(1)
27494 tls_require_ciphers = ${if =={$received_port}{25}\
27495                            {DEFAULT}\
27496                            {HIGH:!MD5:!SHA1}}
27497 .endd
27498
27499 This example will prefer ECDSA-authenticated ciphers over RSA ones:
27500 .code
27501 tls_require_ciphers = ECDSA:RSA:!COMPLEMENTOFDEFAULT
27502 .endd
27503
27504
27505 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
27506          "SECTreqciphgnu"
27507 .cindex "GnuTLS" "specifying parameters for"
27508 .cindex "TLS" "specifying ciphers (GnuTLS)"
27509 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
27510 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
27511 .cindex "TLS" "specifying protocols (GnuTLS)"
27512 .cindex "TLS" "specifying priority string (GnuTLS)"
27513 .oindex "&%tls_require_ciphers%&" "GnuTLS"
27514 The GnuTLS library allows the caller to provide a "priority string", documented
27515 as part of the &[gnutls_priority_init]& function.  This is very similar to the
27516 ciphersuite specification in OpenSSL.
27517
27518 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string
27519 and controls both protocols and ciphers.
27520
27521 The &%tls_require_ciphers%& option is available both as an global option,
27522 controlling how Exim behaves as a server, and also as an option of the
27523 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
27524 the value is string expanded.  The resulting string is not an Exim list and
27525 the string is given to the GnuTLS library, so that Exim does not need to be
27526 aware of future feature enhancements of GnuTLS.
27527
27528 Documentation of the strings accepted may be found in the GnuTLS manual, under
27529 "Priority strings".  This is online as
27530 &url(http://www.gnutls.org/manual/html_node/Priority-Strings.html),
27531 but beware that this relates to GnuTLS 3, which may be newer than the version
27532 installed on your system.  If you are using GnuTLS 3,
27533 then the example code
27534 &url(http://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string)
27535 on that site can be used to test a given string.
27536
27537 For example:
27538 .code
27539 # Disable older versions of protocols
27540 tls_require_ciphers = NORMAL:%LATEST_RECORD_VERSION:-VERS-SSL3.0
27541 .endd
27542
27543 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
27544 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
27545 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
27546
27547 This example will let the library defaults be permitted on the MX port, where
27548 there's probably no identity verification anyway, and lowers security further
27549 by increasing compatibility; but this ups the ante on the submission ports
27550 where the administrator might have some influence on the choice of clients
27551 used:
27552 .code
27553 # GnuTLS variant
27554 tls_require_ciphers = ${if =={$received_port}{25}\
27555                            {NORMAL:%COMPAT}\
27556                            {SECURE128}}
27557 .endd
27558
27559
27560 .section "Configuring an Exim server to use TLS" "SECID182"
27561 .cindex "TLS" "configuring an Exim server"
27562 When Exim has been built with TLS support, it advertises the availability of
27563 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
27564 but not to any others. The default value of this option is *, which means
27565 that STARTTLS is always advertised.  Set it to blank to never advertise;
27566 this is reasonable for systems that want to use TLS only as a client.
27567
27568 If STARTTLS is to be used you
27569 need to set some other options in order to make TLS available.
27570
27571 If a client issues a STARTTLS command and there is some configuration
27572 problem in the server, the command is rejected with a 454 error. If the client
27573 persists in trying to issue SMTP commands, all except QUIT are rejected
27574 with the error
27575 .code
27576 554 Security failure
27577 .endd
27578 If a STARTTLS command is issued within an existing TLS session, it is
27579 rejected with a 554 error code.
27580
27581 To enable TLS operations on a server, the &%tls_advertise_hosts%& option
27582 must be set to match some hosts. The default is * which matches all hosts.
27583
27584 If this is all you do, TLS encryption will be enabled but not authentication -
27585 meaning that the peer has no assurance it is actually you he is talking to.
27586 You gain protection from a passive sniffer listening on the wire but not
27587 from someone able to intercept the communication.
27588
27589 Further protection requires some further configuration at the server end.
27590
27591 To make TLS work you need to set, in the server,
27592 .code
27593 tls_certificate = /some/file/name
27594 tls_privatekey = /some/file/name
27595 .endd
27596 These options are, in fact, expanded strings, so you can make them depend on
27597 the identity of the client that is connected if you wish. The first file
27598 contains the server's X509 certificate, and the second contains the private key
27599 that goes with it. These files need to be
27600 PEM format and readable by the Exim user, and must
27601 always be given as full path names.
27602 The key must not be password-protected.
27603 They can be the same file if both the
27604 certificate and the key are contained within it. If &%tls_privatekey%& is not
27605 set, or if its expansion is forced to fail or results in an empty string, this
27606 is assumed to be the case. The certificate file may also contain intermediate
27607 certificates that need to be sent to the client to enable it to authenticate
27608 the server's certificate.
27609
27610 For dual-stack (eg. RSA and ECDSA) configurations, these options can be
27611 colon-separated lists of file paths.  Ciphers using given authentication
27612 algorithms require the presence of a suitable certificate to supply the
27613 public-key.  The server selects among the certificates to present to the
27614 client depending on the selected cipher, hence the priority ordering for
27615 ciphers will affect which certificate is used.
27616
27617 If you do not understand about certificates and keys, please try to find a
27618 source of this background information, which is not Exim-specific. (There are a
27619 few comments below in section &<<SECTcerandall>>&.)
27620
27621 &*Note*&: These options do not apply when Exim is operating as a client &--
27622 they apply only in the case of a server. If you need to use a certificate in an
27623 Exim client, you must set the options of the same names in an &(smtp)&
27624 transport.
27625
27626 With just these options, an Exim server will be able to use TLS. It does not
27627 require the client to have a certificate (but see below for how to insist on
27628 this). There is one other option that may be needed in other situations. If
27629 .code
27630 tls_dhparam = /some/file/name
27631 .endd
27632 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
27633 with the parameters contained in the file.
27634 Set this to &`none`& to disable use of DH entirely, by making no prime
27635 available:
27636 .code
27637 tls_dhparam = none
27638 .endd
27639 This may also be set to a string identifying a standard prime to be used for
27640 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
27641 used is &`ike23`&.  There are a few standard primes available, see the
27642 documentation for &%tls_dhparam%& for the complete list.
27643
27644 See the command
27645 .code
27646 openssl dhparam
27647 .endd
27648 for a way of generating file data.
27649
27650 The strings supplied for these three options are expanded every time a client
27651 host connects. It is therefore possible to use different certificates and keys
27652 for different hosts, if you so wish, by making use of the client's IP address
27653 in &$sender_host_address$& to control the expansion. If a string expansion is
27654 forced to fail, Exim behaves as if the option is not set.
27655
27656 .cindex "cipher" "logging"
27657 .cindex "log" "TLS cipher"
27658 .vindex "&$tls_in_cipher$&"
27659 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
27660 an incoming TLS connection. It is included in the &'Received:'& header of an
27661 incoming message (by default &-- you can, of course, change this), and it is
27662 also included in the log line that records a message's arrival, keyed by
27663 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
27664 condition can be used to test for specific cipher suites in ACLs.
27665
27666 Once TLS has been established, the ACLs that run for subsequent SMTP commands
27667 can check the name of the cipher suite and vary their actions accordingly. The
27668 cipher suite names vary, depending on which TLS library is being used. For
27669 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
27670 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
27671 documentation for more details.
27672
27673 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
27674 (again depending on the &%tls_cipher%& log selector).
27675
27676
27677 .section "Requesting and verifying client certificates" "SECID183"
27678 .cindex "certificate" "verification of client"
27679 .cindex "TLS" "client certificate verification"
27680 If you want an Exim server to request a certificate when negotiating a TLS
27681 session with a client, you must set either &%tls_verify_hosts%& or
27682 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
27683 apply to all TLS connections. For any host that matches one of these options,
27684 Exim requests a certificate as part of the setup of the TLS session. The
27685 contents of the certificate are verified by comparing it with a list of
27686 expected certificates.
27687 These may be the system default set (depending on library version),
27688 an explicit file or,
27689 depending on library version, a directory, identified by
27690 &%tls_verify_certificates%&.
27691
27692 A file can contain multiple certificates, concatenated end to end. If a
27693 directory is used
27694 (OpenSSL only),
27695 each certificate must be in a separate file, with a name (or a symbolic link)
27696 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
27697 certificate. You can compute the relevant hash by running the command
27698 .code
27699 openssl x509 -hash -noout -in /cert/file
27700 .endd
27701 where &_/cert/file_& contains a single certificate.
27702
27703 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
27704 what happens if the client does not supply a certificate, or if the certificate
27705 does not match any of the certificates in the collection named by
27706 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
27707 attempt to set up a TLS session is aborted, and the incoming connection is
27708 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
27709 session continues. ACLs that run for subsequent SMTP commands can detect the
27710 fact that no certificate was verified, and vary their actions accordingly. For
27711 example, you can insist on a certificate before accepting a message for
27712 relaying, but not when the message is destined for local delivery.
27713
27714 .vindex "&$tls_in_peerdn$&"
27715 When a client supplies a certificate (whether it verifies or not), the value of
27716 the Distinguished Name of the certificate is made available in the variable
27717 &$tls_in_peerdn$& during subsequent processing of the message.
27718
27719 .cindex "log" "distinguished name"
27720 Because it is often a long text string, it is not included in the log line or
27721 &'Received:'& header by default. You can arrange for it to be logged, keyed by
27722 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
27723 &%received_header_text%& to change the &'Received:'& header. When no
27724 certificate is supplied, &$tls_in_peerdn$& is empty.
27725
27726
27727 .section "Revoked certificates" "SECID184"
27728 .cindex "TLS" "revoked certificates"
27729 .cindex "revocation list"
27730 .cindex "certificate" "revocation list"
27731 .cindex "OCSP" "stapling"
27732 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
27733 certificates are revoked. If you have such a list, you can pass it to an Exim
27734 server using the global option called &%tls_crl%& and to an Exim client using
27735 an identically named option for the &(smtp)& transport. In each case, the value
27736 of the option is expanded and must then be the name of a file that contains a
27737 CRL in PEM format.
27738 The downside is that clients have to periodically re-download a potentially huge
27739 file from every certificate authority they know of.
27740
27741 The way with most moving parts at query time is Online Certificate
27742 Status Protocol (OCSP), where the client verifies the certificate
27743 against an OCSP server run by the CA.  This lets the CA track all
27744 usage of the certs.  It requires running software with access to the
27745 private key of the CA, to sign the responses to the OCSP queries.  OCSP
27746 is based on HTTP and can be proxied accordingly.
27747
27748 The only widespread OCSP server implementation (known to this writer)
27749 comes as part of OpenSSL and aborts on an invalid request, such as
27750 connecting to the port and then disconnecting.  This requires
27751 re-entering the passphrase each time some random client does this.
27752
27753 The third way is OCSP Stapling; in this, the server using a certificate
27754 issued by the CA periodically requests an OCSP proof of validity from
27755 the OCSP server, then serves it up inline as part of the TLS
27756 negotiation.   This approach adds no extra round trips, does not let the
27757 CA track users, scales well with number of certs issued by the CA and is
27758 resilient to temporary OCSP server failures, as long as the server
27759 starts retrying to fetch an OCSP proof some time before its current
27760 proof expires.  The downside is that it requires server support.
27761
27762 Unless Exim is built with the support disabled,
27763 or with GnuTLS earlier than version 3.3.16 / 3.4.8
27764 support for OCSP stapling is included.
27765
27766 There is a global option called &%tls_ocsp_file%&.
27767 The file specified therein is expected to be in DER format, and contain
27768 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
27769 option will be re-expanded for SNI, if the &%tls_certificate%& option
27770 contains &`tls_in_sni`&, as per other TLS options.
27771
27772 Exim does not at this time implement any support for fetching a new OCSP
27773 proof.  The burden is on the administrator to handle this, outside of
27774 Exim.  The file specified should be replaced atomically, so that the
27775 contents are always valid.  Exim will expand the &%tls_ocsp_file%& option
27776 on each connection, so a new file will be handled transparently on the
27777 next connection.
27778
27779 When built with OpenSSL Exim will check for a valid next update timestamp
27780 in the OCSP proof; if not present, or if the proof has expired, it will be
27781 ignored.
27782
27783 For the client to be able to verify the stapled OCSP the server must
27784 also supply, in its stapled information, any intermediate
27785 certificates for the chain leading to the OCSP proof from the signer
27786 of the server certificate.  There may be zero or one such. These
27787 intermediate certificates should be added to the server OCSP stapling
27788 file named by &%tls_ocsp_file%&.
27789
27790 Note that the proof only covers the terminal server certificate,
27791 not any of the chain from CA to it.
27792
27793 There is no current way to staple a proof for a client certificate.
27794
27795 .code
27796   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
27797   OCSP server is supplied.  The server URL may be included in the
27798   server certificate, if the CA is helpful.
27799
27800   One failure mode seen was the OCSP Signer cert expiring before the end
27801   of validity of the OCSP proof. The checking done by Exim/OpenSSL
27802   noted this as invalid overall, but the re-fetch script did not.
27803 .endd
27804
27805
27806
27807
27808 .section "Configuring an Exim client to use TLS" "SECID185"
27809 .cindex "cipher" "logging"
27810 .cindex "log" "TLS cipher"
27811 .cindex "log" "distinguished name"
27812 .cindex "TLS" "configuring an Exim client"
27813 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
27814 deliveries as well as to incoming, the latter one causing logging of the
27815 server certificate's DN. The remaining client configuration for TLS is all
27816 within the &(smtp)& transport.
27817
27818 It is not necessary to set any options to have TLS work in the &(smtp)&
27819 transport. If Exim is built with TLS support, and TLS is advertised by a
27820 server, the &(smtp)& transport always tries to start a TLS session. However,
27821 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
27822 transport) to a list of server hosts for which TLS should not be used.
27823
27824 If you do not want Exim to attempt to send messages unencrypted when an attempt
27825 to set up an encrypted connection fails in any way, you can set
27826 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
27827 those hosts, delivery is always deferred if an encrypted connection cannot be
27828 set up. If there are any other hosts for the address, they are tried in the
27829 usual way.
27830
27831 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
27832 the message unencrypted. It always does this if the response to STARTTLS is
27833 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
27834 session after a success response code, what happens is controlled by the
27835 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
27836 delivery to this host is deferred, and other hosts (if available) are tried. If
27837 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
27838 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
27839 negotiation fails, Exim closes the current connection (because it is in an
27840 unknown state), opens a new one to the same host, and then tries the delivery
27841 unencrypted.
27842
27843 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
27844 transport provide the client with a certificate, which is passed to the server
27845 if it requests it. If the server is Exim, it will request a certificate only if
27846 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
27847
27848 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
27849 specifies a collection of expected server certificates.
27850 These may be
27851 the system default set (depending on library version),
27852 a file,
27853 or (depending on library version) a directory.
27854 The client verifies the server's certificate
27855 against this collection, taking into account any revoked certificates that are
27856 in the list defined by &%tls_crl%&.
27857 Failure to verify fails the TLS connection unless either of the
27858 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
27859
27860 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
27861 certificate verification to the listed servers.  Verification either must
27862 or need not succeed respectively.
27863
27864 The &(smtp)& transport has two OCSP-related options:
27865 &%hosts_require_ocsp%&; a host-list for which a Certificate Status
27866 is requested and required for the connection to proceed.  The default
27867 value is empty.
27868 &%hosts_request_ocsp%&; a host-list for which (additionally)
27869 a Certificate Status is requested (but not necessarily verified).  The default
27870 value is "*" meaning that requests are made unless configured
27871 otherwise.
27872
27873 The host(s) should also be in &%hosts_require_tls%&, and
27874 &%tls_verify_certificates%& configured for the transport,
27875 for OCSP to be relevant.
27876
27877 If
27878 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
27879 list of permitted cipher suites. If either of these checks fails, delivery to
27880 the current host is abandoned, and the &(smtp)& transport tries to deliver to
27881 alternative hosts, if any.
27882
27883  &*Note*&:
27884 These options must be set in the &(smtp)& transport for Exim to use TLS when it
27885 is operating as a client. Exim does not assume that a server certificate (set
27886 by the global options of the same name) should also be used when operating as a
27887 client.
27888
27889 .vindex "&$host$&"
27890 .vindex "&$host_address$&"
27891 All the TLS options in the &(smtp)& transport are expanded before use, with
27892 &$host$& and &$host_address$& containing the name and address of the server to
27893 which the client is connected. Forced failure of an expansion causes Exim to
27894 behave as if the relevant option were unset.
27895
27896 .vindex &$tls_out_bits$&
27897 .vindex &$tls_out_cipher$&
27898 .vindex &$tls_out_peerdn$&
27899 .vindex &$tls_out_sni$&
27900 Before an SMTP connection is established, the
27901 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
27902 variables are emptied. (Until the first connection, they contain the values
27903 that were set when the message was received.) If STARTTLS is subsequently
27904 successfully obeyed, these variables are set to the relevant values for the
27905 outgoing connection.
27906
27907
27908
27909 .section "Use of TLS Server Name Indication" "SECTtlssni"
27910 .cindex "TLS" "Server Name Indication"
27911 .vindex "&$tls_in_sni$&"
27912 .oindex "&%tls_in_sni%&"
27913 With TLS1.0 or above, there is an extension mechanism by which extra
27914 information can be included at various points in the protocol.  One of these
27915 extensions, documented in RFC 6066 (and before that RFC 4366) is
27916 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
27917 client in the initial handshake, so that the server can examine the servername
27918 within and possibly choose to use different certificates and keys (and more)
27919 for this session.
27920
27921 This is analogous to HTTP's &"Host:"& header, and is the main mechanism by
27922 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
27923 address.
27924
27925 With SMTP to MX, there are the same problems here as in choosing the identity
27926 against which to validate a certificate: you can't rely on insecure DNS to
27927 provide the identity which you then cryptographically verify.  So this will
27928 be of limited use in that environment.
27929
27930 With SMTP to Submission, there is a well-defined hostname which clients are
27931 connecting to and can validate certificates against.  Thus clients &*can*&
27932 choose to include this information in the TLS negotiation.  If this becomes
27933 wide-spread, then hosters can choose to present different certificates to
27934 different clients.  Or even negotiate different cipher suites.
27935
27936 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
27937 if not empty, will be sent on a TLS session as part of the handshake.  There's
27938 nothing more to it.  Choosing a sensible value not derived insecurely is the
27939 only point of caution.  The &$tls_out_sni$& variable will be set to this string
27940 for the lifetime of the client connection (including during authentication).
27941
27942 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
27943 received from a client.
27944 It can be logged with the &%log_selector%& item &`+tls_sni`&.
27945
27946 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
27947 option (prior to expansion) then the following options will be re-expanded
27948 during TLS session handshake, to permit alternative values to be chosen:
27949
27950 .ilist
27951 &%tls_certificate%&
27952 .next
27953 &%tls_crl%&
27954 .next
27955 &%tls_privatekey%&
27956 .next
27957 &%tls_verify_certificates%&
27958 .next
27959 &%tls_ocsp_file%&
27960 .endlist
27961
27962 Great care should be taken to deal with matters of case, various injection
27963 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
27964 can always be referenced; it is important to remember that &$tls_in_sni$& is
27965 arbitrary unverified data provided prior to authentication.
27966 Further, the initial certificate is loaded before SNI is arrived, so
27967 an expansion for &%tls_certificate%& must have a default which is used
27968 when &$tls_in_sni$& is empty.
27969
27970 The Exim developers are proceeding cautiously and so far no other TLS options
27971 are re-expanded.
27972
27973 When Exim is built against OpenSSL, OpenSSL must have been built with support
27974 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
27975 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
27976 see &`-servername`& in the output, then OpenSSL has support.
27977
27978 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
27979 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
27980 built, then you have SNI support).
27981
27982
27983
27984 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
27985          "SECTmulmessam"
27986 .cindex "multiple SMTP deliveries with TLS"
27987 .cindex "TLS" "multiple message deliveries"
27988 Exim sends multiple messages down the same TCP/IP connection by starting up
27989 an entirely new delivery process for each message, passing the socket from
27990 one process to the next. This implementation does not fit well with the use
27991 of TLS, because there is quite a lot of state information associated with a TLS
27992 connection, not just a socket identification. Passing all the state information
27993 to a new process is not feasible. Consequently, for sending using TLS Exim
27994 starts an additional proxy process for handling the encryption, piping the
27995 unencrypted data stream from and to the delivery processes.
27996
27997 An older mode of operation can be enabled on a per-host basis by the
27998 &%hosts_noproxy_tls%& option on the &(smtp)& transport.  If the host matches
27999 this list the proxy process described above is not used; instead Exim
28000 shuts down an existing TLS session being run by the delivery process
28001 before passing the socket to a new process. The new process may then
28002 try to start a new TLS session, and if successful, may try to re-authenticate
28003 if AUTH is in use, before sending the next message.
28004
28005 The RFC is not clear as to whether or not an SMTP session continues in clear
28006 after TLS has been shut down, or whether TLS may be restarted again later, as
28007 just described. However, if the server is Exim, this shutdown and
28008 reinitialization works. It is not known which (if any) other servers operate
28009 successfully if the client closes a TLS session and continues with unencrypted
28010 SMTP, but there are certainly some that do not work. For such servers, Exim
28011 should not pass the socket to another process, because the failure of the
28012 subsequent attempt to use it would cause Exim to record a temporary host error,
28013 and delay other deliveries to that host.
28014
28015 To test for this case, Exim sends an EHLO command to the server after
28016 closing down the TLS session. If this fails in any way, the connection is
28017 closed instead of being passed to a new delivery process, but no retry
28018 information is recorded.
28019
28020 There is also a manual override; you can set &%hosts_nopass_tls%& on the
28021 &(smtp)& transport to match those hosts for which Exim should not pass
28022 connections to new processes if TLS has been used.
28023
28024
28025
28026
28027 .section "Certificates and all that" "SECTcerandall"
28028 .cindex "certificate" "references to discussion"
28029 In order to understand fully how TLS works, you need to know about
28030 certificates, certificate signing, and certificate authorities. This is not the
28031 place to give a tutorial, especially as I do not know very much about it
28032 myself. Some helpful introduction can be found in the FAQ for the SSL addition
28033 to Apache, currently at
28034 .display
28035 &url(http://www.modssl.org/docs/2.7/ssl_faq.html#ToC24)
28036 .endd
28037 Other parts of the &'modssl'& documentation are also helpful, and have
28038 links to further files.
28039 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
28040 0-201-61598-3), contains both introductory and more in-depth descriptions.
28041 Some sample programs taken from the book are available from
28042 .display
28043 &url(http://www.rtfm.com/openssl-examples/)
28044 .endd
28045
28046
28047 .section "Certificate chains" "SECID186"
28048 The file named by &%tls_certificate%& may contain more than one
28049 certificate. This is useful in the case where the certificate that is being
28050 sent is validated by an intermediate certificate which the other end does
28051 not have. Multiple certificates must be in the correct order in the file.
28052 First the host's certificate itself, then the first intermediate
28053 certificate to validate the issuer of the host certificate, then the next
28054 intermediate certificate to validate the issuer of the first intermediate
28055 certificate, and so on, until finally (optionally) the root certificate.
28056 The root certificate must already be trusted by the recipient for
28057 validation to succeed, of course, but if it's not preinstalled, sending the
28058 root certificate along with the rest makes it available for the user to
28059 install if the receiving end is a client MUA that can interact with a user.
28060
28061 Note that certificates using MD5 are unlikely to work on today's Internet;
28062 even if your libraries allow loading them for use in Exim when acting as a
28063 server, increasingly clients will not accept such certificates.  The error
28064 diagnostics in such a case can be frustratingly vague.
28065
28066
28067
28068 .section "Self-signed certificates" "SECID187"
28069 .cindex "certificate" "self-signed"
28070 You can create a self-signed certificate using the &'req'& command provided
28071 with OpenSSL, like this:
28072 . ==== Do not shorten the duration here without reading and considering
28073 . ==== the text below.  Please leave it at 9999 days.
28074 .code
28075 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
28076             -days 9999 -nodes
28077 .endd
28078 &_file1_& and &_file2_& can be the same file; the key and the certificate are
28079 delimited and so can be identified independently. The &%-days%& option
28080 specifies a period for which the certificate is valid. The &%-nodes%& option is
28081 important: if you do not set it, the key is encrypted with a passphrase
28082 that you are prompted for, and any use that is made of the key causes more
28083 prompting for the passphrase. This is not helpful if you are going to use
28084 this certificate and key in an MTA, where prompting is not possible.
28085
28086 . ==== I expect to still be working 26 years from now.  The less technical
28087 . ==== debt I create, in terms of storing up trouble for my later years, the
28088 . ==== happier I will be then.  We really have reached the point where we
28089 . ==== should start, at the very least, provoking thought and making folks
28090 . ==== pause before proceeding, instead of leaving all the fixes until two
28091 . ==== years before 2^31 seconds after the 1970 Unix epoch.
28092 . ==== -pdp, 2012
28093 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
28094 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
28095 the above command might produce a date in the past.  Think carefully about
28096 the lifetime of the systems you're deploying, and either reduce the duration
28097 of the certificate or reconsider your platform deployment.  (At time of
28098 writing, reducing the duration is the most likely choice, but the inexorable
28099 progression of time takes us steadily towards an era where this will not
28100 be a sensible resolution).
28101
28102 A self-signed certificate made in this way is sufficient for testing, and
28103 may be adequate for all your requirements if you are mainly interested in
28104 encrypting transfers, and not in secure identification.
28105
28106 However, many clients require that the certificate presented by the server be a
28107 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
28108 certificate. In this situation, the self-signed certificate described above
28109 must be installed on the client host as a trusted root &'certification
28110 authority'& (CA), and the certificate used by Exim must be a user certificate
28111 signed with that self-signed certificate.
28112
28113 For information on creating self-signed CA certificates and using them to sign
28114 user certificates, see the &'General implementation overview'& chapter of the
28115 Open-source PKI book, available online at
28116 &url(http://ospkibook.sourceforge.net/).
28117 .ecindex IIDencsmtp1
28118 .ecindex IIDencsmtp2
28119
28120
28121
28122 .new
28123 .section DANE "SECDANE"
28124 .cindex DANE
28125 DNS-based Authentication of Named Entities, as applied to SMTP over TLS, provides assurance to a client that
28126 it is actually talking to the server it wants to rather than some attacker operating a Man In The Middle (MITM)
28127 operation.  The latter can terminate the TLS connection you make, and make another one to the server (so both
28128 you and the server still think you have an encrypted connection) and, if one of the "well known" set of
28129 Certificate Authorities has been suborned - something which *has* been seen already (2014), a verifiable
28130 certificate (if you're using normal root CAs, eg. the Mozilla set, as your trust anchors).
28131
28132 What DANE does is replace the CAs with the DNS as the trust anchor.  The assurance is limited to a) the possibility
28133 that the DNS has been suborned, b) mistakes made by the admins of the target server.   The attack surface presented
28134 by (a) is thought to be smaller than that of the set of root CAs.
28135
28136 It also allows the server to declare (implicitly) that connections to it should use TLS.  An MITM could simply
28137 fail to pass on a server's STARTTLS.
28138
28139 DANE scales better than having to maintain (and side-channel communicate) copies of server certificates
28140 for every possible target server.  It also scales (slightly) better than having to maintain on an SMTP
28141 client a copy of the standard CAs bundle.  It also means not having to pay a CA for certificates.
28142
28143 DANE requires a server operator to do three things: 1) run DNSSEC.  This provides assurance to clients
28144 that DNS lookups they do for the server have not been tampered with.  The domain MX record applying
28145 to this server, its A record, its TLSA record and any associated CNAME records must all be covered by
28146 DNSSEC.
28147 2) add TLSA DNS records.  These say what the server certificate for a TLS connection should be.
28148 3) offer a server certificate, or certificate chain, in TLS connections which is is anchored by one of the TLSA records.
28149
28150 There are no changes to Exim specific to server-side operation of DANE.
28151 Support for client-side operation of DANE can be included at compile time by defining SUPPORT_DANE=yes
28152 in &_Local/Makefile_&.
28153 If it has been included, the macro "_HAVE_DANE" will be defined.
28154
28155 The TLSA record for the server may have "certificate usage" of DANE-TA(2) or DANE-EE(3).  The latter specifies
28156 the End Entity directly, i.e. the certificate involved is that of the server (and should be the sole one transmitted
28157 during the TLS handshake); this is appropriate for a single system, using a self-signed certificate.
28158 DANE-TA usage is effectively declaring a specific CA to be used; this might be a private CA or a public,
28159 well-known one.  A private CA at simplest is just a self-signed certificate which is used to sign
28160 cerver certificates, but running one securely does require careful arrangement.  If a private CA is used
28161 then either all clients must be primed with it, or (probably simpler) the server TLS handshake must transmit
28162 the entire certificate chain from CA to server-certificate.  If a public CA is used then all clients must be primed with it
28163 (losing one advantage of DANE) - but the attack surface is reduced from all public CAs to that single CA.
28164 DANE-TA is commonly used for several services and/or servers, each having a TLSA query-domain CNAME record,
28165 all of which point to a single TLSA record.
28166
28167 The TLSA record should have a Selector field of SPKI(1) and a Matching Type field of SHA2-512(2).
28168
28169 At the time of writing, &url(https://www.huque.com/bin/gen_tlsa)
28170 is useful for quickly generating TLSA records; and commands like
28171
28172 .code
28173   openssl x509 -in -pubkey -noout <certificate.pem \
28174   | openssl rsa -outform der -pubin 2>/dev/null \
28175   | openssl sha512 \
28176   | awk '{print $2}'
28177 .endd
28178
28179 are workable for 4th-field hashes.
28180
28181 For use with the DANE-TA model, server certificates must have a correct name (SubjectName or SubjectAltName).
28182
28183 The use of OCSP-stapling should be considered, allowing for fast revocation of certificates (which would otherwise
28184 be limited by the DNS TTL on the TLSA records).  However, this is likely to only be usable with DANE-TA.  NOTE: the
28185 default of requesting OCSP for all hosts is modified iff DANE is in use, to:
28186
28187 .code
28188   hosts_request_ocsp = ${if or { {= {0}{$tls_out_tlsa_usage}} \
28189                                  {= {4}{$tls_out_tlsa_usage}} } \
28190                          {*}{}}
28191 .endd
28192
28193 The (new) variable &$tls_out_tlsa_usage$& is a bitfield with numbered bits set for TLSA record usage codes.
28194 The zero above means DANE was not in use, the four means that only DANE-TA usage TLSA records were
28195 found. If the definition of &%hosts_request_ocsp%& includes the
28196 string "tls_out_tlsa_usage", they are re-expanded in time to
28197 control the OCSP request.
28198
28199 This modification of hosts_request_ocsp is only done if it has the default value of "*".  Admins who change it, and
28200 those who use &%hosts_require_ocsp%&, should consider the interaction with DANE in their OCSP settings.
28201
28202
28203 For client-side DANE there are three new smtp transport options, &%hosts_try_dane%&, &%hosts_require_dane%&
28204 and &%dane_require_tls_ciphers%&.
28205 The require variant will result in failure if the target host is not DNSSEC-secured.
28206
28207 DANE will only be usable if the target host has DNSSEC-secured MX, A and TLSA records.
28208
28209 A TLSA lookup will be done if either of the above options match and the host-lookup succeeded using dnssec.
28210 If a TLSA lookup is done and succeeds, a DANE-verified TLS connection
28211 will be required for the host.  If it does not, the host will not
28212 be used; there is no fallback to non-DANE or non-TLS.
28213
28214 If DANE is requested and usable, then the TLS cipher list configuration
28215 prefers to use the option &%dane_require_tls_ciphers%& and falls
28216 back to &%tls_require_ciphers%& only if that is unset.
28217 This lets you configure "decent crypto" for DANE and "better than nothing
28218 crypto" as the default.  Note though that while GnuTLS lets the string control
28219 which versions of TLS/SSL will be negotiated, OpenSSL does not and you're
28220 limited to ciphersuite constraints.
28221
28222 If DANE is requested and useable (see above) the following transport options are ignored:
28223 .code
28224   hosts_require_tls
28225   tls_verify_hosts
28226   tls_try_verify_hosts
28227   tls_verify_certificates
28228   tls_crl
28229   tls_verify_cert_hostnames
28230 .endd
28231
28232 If DANE is not usable, whether requested or not, and CA-anchored
28233 verification evaluation is wanted, the above variables should be set appropriately.
28234
28235 Currently the &%dnssec_request_domains%& must be active and &%dnssec_require_domains%& is ignored.
28236
28237 If verification was successful using DANE then the "CV" item in the delivery log line will show as "CV=dane".
28238
28239 There is a new variable &$tls_out_dane$& which will have "yes" if
28240 verification succeeded using DANE and "no" otherwise (only useful
28241 in combination with events; see &<<CHAPevents>>&),
28242 and a new variable &$tls_out_tlsa_usage$& (detailed above).
28243
28244 .cindex DANE reporting
28245 An event (see &<<CHAPevents>>&) of type "dane:fail" will be raised on failures
28246 to achieve DANE-verified connection, if one was either requested and offered, or
28247 required.  This is intended to support TLS-reporting as defined in
28248 &url(https://tools.ietf.org/html/draft-ietf-uta-smtp-tlsrpt-17).
28249 The &$event_data$& will be one of the Result Types defined in
28250 Section 4.3 of that document.
28251
28252 Under GnuTLS, DANE is only supported from version 3.0.0 onwards.
28253 .wen
28254
28255
28256
28257 . ////////////////////////////////////////////////////////////////////////////
28258 . ////////////////////////////////////////////////////////////////////////////
28259
28260 .chapter "Access control lists" "CHAPACL"
28261 .scindex IIDacl "&ACL;" "description"
28262 .cindex "control of incoming mail"
28263 .cindex "message" "controlling incoming"
28264 .cindex "policy control" "access control lists"
28265 Access Control Lists (ACLs) are defined in a separate section of the run time
28266 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
28267 name, terminated by a colon. Here is a complete ACL section that contains just
28268 one very small ACL:
28269 .code
28270 begin acl
28271 small_acl:
28272   accept   hosts = one.host.only
28273 .endd
28274 You can have as many lists as you like in the ACL section, and the order in
28275 which they appear does not matter. The lists are self-terminating.
28276
28277 The majority of ACLs are used to control Exim's behaviour when it receives
28278 certain SMTP commands. This applies both to incoming TCP/IP connections, and
28279 when a local process submits a message using SMTP by specifying the &%-bs%&
28280 option. The most common use is for controlling which recipients are accepted
28281 in incoming messages. In addition, you can define an ACL that is used to check
28282 local non-SMTP messages. The default configuration file contains an example of
28283 a realistic ACL for checking RCPT commands. This is discussed in chapter
28284 &<<CHAPdefconfil>>&.
28285
28286
28287 .section "Testing ACLs" "SECID188"
28288 The &%-bh%& command line option provides a way of testing your ACL
28289 configuration locally by running a fake SMTP session with which you interact.
28290
28291
28292 .section "Specifying when ACLs are used" "SECID189"
28293 .cindex "&ACL;" "options for specifying"
28294 In order to cause an ACL to be used, you have to name it in one of the relevant
28295 options in the main part of the configuration. These options are:
28296 .cindex "AUTH" "ACL for"
28297 .cindex "DATA" "ACLs for"
28298 .cindex "ETRN" "ACL for"
28299 .cindex "EXPN" "ACL for"
28300 .cindex "HELO" "ACL for"
28301 .cindex "EHLO" "ACL for"
28302 .cindex "DKIM" "ACL for"
28303 .cindex "MAIL" "ACL for"
28304 .cindex "QUIT, ACL for"
28305 .cindex "RCPT" "ACL for"
28306 .cindex "STARTTLS, ACL for"
28307 .cindex "VRFY" "ACL for"
28308 .cindex "SMTP" "connection, ACL for"
28309 .cindex "non-SMTP messages" "ACLs for"
28310 .cindex "MIME content scanning" "ACL for"
28311 .cindex "PRDR" "ACL for"
28312
28313 .table2 140pt
28314 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
28315 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
28316 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
28317 .irow &%acl_smtp_auth%&        "ACL for AUTH"
28318 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
28319 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
28320 .irow &%acl_smtp_data_prdr%&   "ACL for each recipient, after DATA is complete"
28321 .irow &%acl_smtp_dkim%&        "ACL for each DKIM signer"
28322 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
28323 .irow &%acl_smtp_expn%&        "ACL for EXPN"
28324 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
28325 .irow &%acl_smtp_mail%&        "ACL for MAIL"
28326 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
28327 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
28328 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
28329 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
28330 .irow &%acl_smtp_quit%&        "ACL for QUIT"
28331 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
28332 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
28333 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
28334 .endtable
28335
28336 For example, if you set
28337 .code
28338 acl_smtp_rcpt = small_acl
28339 .endd
28340 the little ACL defined above is used whenever Exim receives a RCPT command
28341 in an SMTP dialogue. The majority of policy tests on incoming messages can be
28342 done when RCPT commands arrive. A rejection of RCPT should cause the
28343 sending MTA to give up on the recipient address contained in the RCPT
28344 command, whereas rejection at other times may cause the client MTA to keep on
28345 trying to deliver the message. It is therefore recommended that you do as much
28346 testing as possible at RCPT time.
28347
28348
28349 .section "The non-SMTP ACLs" "SECID190"
28350 .cindex "non-SMTP messages" "ACLs for"
28351 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
28352 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
28353 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
28354 the state of the SMTP connection such as encryption and authentication) are not
28355 relevant and are forbidden in these ACLs. However, the sender and recipients
28356 are known, so the &%senders%& and &%sender_domains%& conditions and the
28357 &$sender_address$& and &$recipients$& variables can be used. Variables such as
28358 &$authenticated_sender$& are also available. You can specify added header lines
28359 in any of these ACLs.
28360
28361 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
28362 non-SMTP message, before any of the message has been read. (This is the
28363 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
28364 batched SMTP input, it runs after the DATA command has been reached. The
28365 result of this ACL is ignored; it cannot be used to reject a message. If you
28366 really need to, you could set a value in an ACL variable here and reject based
28367 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
28368 controls, and in particular, it can be used to set
28369 .code
28370 control = suppress_local_fixups
28371 .endd
28372 This cannot be used in the other non-SMTP ACLs because by the time they are
28373 run, it is too late.
28374
28375 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
28376 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
28377
28378 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
28379 kind of rejection is treated as permanent, because there is no way of sending a
28380 temporary error for these kinds of message.
28381
28382
28383 .section "The SMTP connect ACL" "SECID191"
28384 .cindex "SMTP" "connection, ACL for"
28385 .oindex &%smtp_banner%&
28386 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
28387 session, after the test specified by &%host_reject_connection%& (which is now
28388 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
28389 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
28390 the message override the banner message that is otherwise specified by the
28391 &%smtp_banner%& option.
28392
28393
28394 .section "The EHLO/HELO ACL" "SECID192"
28395 .cindex "EHLO" "ACL for"
28396 .cindex "HELO" "ACL for"
28397 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
28398 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
28399 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
28400 Note that a client may issue more than one EHLO or HELO command in an SMTP
28401 session, and indeed is required to issue a new EHLO or HELO after successfully
28402 setting up encryption following a STARTTLS command.
28403
28404 Note also that a deny neither forces the client to go away nor means that
28405 mail will be refused on the connection.  Consider checking for
28406 &$sender_helo_name$& being defined in a MAIL or RCPT ACL to do that.
28407
28408 If the command is accepted by an &%accept%& verb that has a &%message%&
28409 modifier, the message may not contain more than one line (it will be truncated
28410 at the first newline and a panic logged if it does). Such a message cannot
28411 affect the EHLO options that are listed on the second and subsequent lines of
28412 an EHLO response.
28413
28414
28415 .section "The DATA ACLs" "SECID193"
28416 .cindex "DATA" "ACLs for"
28417 Two ACLs are associated with the DATA command, because it is two-stage
28418 command, with two responses being sent to the client.
28419 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
28420 is obeyed. This gives you control after all the RCPT commands, but before
28421 the message itself is received. It offers the opportunity to give a negative
28422 response to the DATA command before the data is transmitted. Header lines
28423 added by MAIL or RCPT ACLs are not visible at this time, but any that
28424 are defined here are visible when the &%acl_smtp_data%& ACL is run.
28425
28426 You cannot test the contents of the message, for example, to verify addresses
28427 in the headers, at RCPT time or when the DATA command is received. Such
28428 tests have to appear in the ACL that is run after the message itself has been
28429 received, before the final response to the DATA command is sent. This is
28430 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
28431 associated with the DATA command.
28432
28433 .cindex CHUNKING "BDAT command"
28434 .cindex BDAT "SMTP command"
28435 .cindex "RFC 3030" CHUNKING
28436 If CHUNKING was advertised and a BDAT command sequence is received,
28437 the &%acl_smtp_predata%& ACL is not run.
28438 . XXX why not?  It should be possible, for the first BDAT.
28439 The &%acl_smtp_data%& is run after the last BDAT command and all of
28440 the data specified is received.
28441
28442 For both of these ACLs, it is not possible to reject individual recipients. An
28443 error response rejects the entire message. Unfortunately, it is known that some
28444 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
28445 before or after the data) correctly &-- they keep the message on their queues
28446 and try again later, but that is their problem, though it does waste some of
28447 your resources.
28448
28449 The &%acl_smtp_data%& ACL is run after
28450 the &%acl_smtp_data_prdr%&,
28451 the &%acl_smtp_dkim%&
28452 and the &%acl_smtp_mime%& ACLs.
28453
28454 .section "The SMTP DKIM ACL" "SECTDKIMACL"
28455 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
28456 enabled (which is the default).
28457
28458 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
28459 received, and is executed for each DKIM signature found in a message.  If not
28460 otherwise specified, the default action is to accept.
28461
28462 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
28463
28464 For details on the operation of DKIM, see section &<<SECDKIM>>&.
28465
28466
28467 .section "The SMTP MIME ACL" "SECID194"
28468 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
28469 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
28470
28471 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
28472
28473
28474 .section "The SMTP PRDR ACL" "SECTPRDRACL"
28475 .cindex "PRDR" "ACL for"
28476 .oindex "&%prdr_enable%&"
28477 The &%acl_smtp_data_prdr%& ACL is available only when Exim is compiled
28478 with PRDR support enabled (which is the default).
28479 It becomes active only when the PRDR feature is negotiated between
28480 client and server for a message, and more than one recipient
28481 has been accepted.
28482
28483 The ACL test specified by &%acl_smtp_data_prdr%& happens after a message
28484 has been received, and is executed once for each recipient of the message
28485 with &$local_part$& and &$domain$& valid.
28486 The test may accept, defer or deny for individual recipients.
28487 The &%acl_smtp_data%& will still be called after this ACL and
28488 can reject the message overall, even if this ACL has accepted it
28489 for some or all recipients.
28490
28491 PRDR may be used to support per-user content filtering.  Without it
28492 one must defer any recipient after the first that has a different
28493 content-filter configuration.  With PRDR, the RCPT-time check
28494 .cindex "PRDR" "variable for"
28495 for this can be disabled when the variable &$prdr_requested$&
28496 is &"yes"&.
28497 Any required difference in behaviour of the main DATA-time
28498 ACL should however depend on the PRDR-time ACL having run, as Exim
28499 will avoid doing so in some situations (e.g.  single-recipient mails).
28500
28501 See also the &%prdr_enable%& global option
28502 and the &%hosts_try_prdr%& smtp transport option.
28503
28504 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
28505 If the ACL is not defined, processing completes as if
28506 the feature was not requested by the client.
28507
28508 .section "The QUIT ACL" "SECTQUITACL"
28509 .cindex "QUIT, ACL for"
28510 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
28511 does not affect the response code to QUIT, which is always 221. Thus, the ACL
28512 does not in fact control any access.
28513 For this reason, it may only accept
28514 or warn as its final result.
28515
28516 This ACL can be used for tasks such as custom logging at the end of an SMTP
28517 session. For example, you can use ACL variables in other ACLs to count
28518 messages, recipients, etc., and log the totals at QUIT time using one or
28519 more &%logwrite%& modifiers on a &%warn%& verb.
28520
28521 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
28522 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
28523
28524 You do not need to have a final &%accept%&, but if you do, you can use a
28525 &%message%& modifier to specify custom text that is sent as part of the 221
28526 response to QUIT.
28527
28528 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
28529 failure (for example, failure to open a log file, or when Exim is bombing out
28530 because it has detected an unrecoverable error), all SMTP commands from the
28531 client are given temporary error responses until QUIT is received or the
28532 connection is closed. In these special cases, the QUIT ACL does not run.
28533
28534
28535 .section "The not-QUIT ACL" "SECTNOTQUITACL"
28536 .vindex &$acl_smtp_notquit$&
28537 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
28538 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
28539 trouble, such as being unable to write to its log files, this ACL is not run,
28540 because it might try to do things (such as write to log files) that make the
28541 situation even worse.
28542
28543 Like the QUIT ACL, this ACL is provided to make it possible to do customized
28544 logging or to gather statistics, and its outcome is ignored. The &%delay%&
28545 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
28546 and &%warn%&.
28547
28548 .vindex &$smtp_notquit_reason$&
28549 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
28550 to a string that indicates the reason for the termination of the SMTP
28551 connection. The possible values are:
28552 .table2
28553 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
28554 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
28555 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
28556 .irow &`connection-lost`&          "The SMTP connection has been lost"
28557 .irow &`data-timeout`&             "Timeout while reading message data"
28558 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
28559 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
28560 .irow &`signal-exit`&              "SIGTERM or SIGINT"
28561 .irow &`synchronization-error`&    "SMTP synchronization error"
28562 .irow &`tls-failed`&               "TLS failed to start"
28563 .endtable
28564 In most cases when an SMTP connection is closed without having received QUIT,
28565 Exim sends an SMTP response message before actually closing the connection.
28566 With the exception of the &`acl-drop`& case, the default message can be
28567 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
28568 &%drop%& verb in another ACL, it is the message from the other ACL that is
28569 used.
28570
28571
28572 .section "Finding an ACL to use" "SECID195"
28573 .cindex "&ACL;" "finding which to use"
28574 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
28575 you can use different ACLs in different circumstances. For example,
28576 .code
28577 acl_smtp_rcpt = ${if ={25}{$interface_port} \
28578                      {acl_check_rcpt} {acl_check_rcpt_submit} }
28579 .endd
28580 In the default configuration file there are some example settings for
28581 providing an RFC 4409 message &"submission"& service on port 587 and
28582 an RFC 8314 &"submissions"& service on port 465. You can use a string
28583 expansion like this to choose an ACL for MUAs on these ports which is
28584 more appropriate for this purpose than the default ACL on port 25.
28585
28586 The expanded string does not have to be the name of an ACL in the
28587 configuration file; there are other possibilities. Having expanded the
28588 string, Exim searches for an ACL as follows:
28589
28590 .ilist
28591 If the string begins with a slash, Exim uses it as a file name, and reads its
28592 contents as an ACL. The lines are processed in the same way as lines in the
28593 Exim configuration file. In particular, continuation lines are supported, blank
28594 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
28595 If the file does not exist or cannot be read, an error occurs (typically
28596 causing a temporary failure of whatever caused the ACL to be run). For example:
28597 .code
28598 acl_smtp_data = /etc/acls/\
28599   ${lookup{$sender_host_address}lsearch\
28600   {/etc/acllist}{$value}{default}}
28601 .endd
28602 This looks up an ACL file to use on the basis of the host's IP address, falling
28603 back to a default if the lookup fails. If an ACL is successfully read from a
28604 file, it is retained in memory for the duration of the Exim process, so that it
28605 can be re-used without having to re-read the file.
28606 .next
28607 If the string does not start with a slash, and does not contain any spaces,
28608 Exim searches the ACL section of the configuration for an ACL whose name
28609 matches the string.
28610 .next
28611 If no named ACL is found, or if the string contains spaces, Exim parses
28612 the string as an inline ACL. This can save typing in cases where you just
28613 want to have something like
28614 .code
28615 acl_smtp_vrfy = accept
28616 .endd
28617 in order to allow free use of the VRFY command. Such a string may contain
28618 newlines; it is processed in the same way as an ACL that is read from a file.
28619 .endlist
28620
28621
28622
28623
28624 .section "ACL return codes" "SECID196"
28625 .cindex "&ACL;" "return codes"
28626 Except for the QUIT ACL, which does not affect the SMTP return code (see
28627 section &<<SECTQUITACL>>& above), the result of running an ACL is either
28628 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
28629 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
28630 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
28631 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
28632 This also causes a 4&'xx'& return code.
28633
28634 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
28635 &"deny"&, because there is no mechanism for passing temporary errors to the
28636 submitters of non-SMTP messages.
28637
28638
28639 ACLs that are relevant to message reception may also return &"discard"&. This
28640 has the effect of &"accept"&, but causes either the entire message or an
28641 individual recipient address to be discarded. In other words, it is a
28642 blackholing facility. Use it with care.
28643
28644 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
28645 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
28646 RCPT ACL is to discard just the one recipient address. If there are no
28647 recipients left when the message's data is received, the DATA ACL is not
28648 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
28649 remaining recipients. The &"discard"& return is not permitted for the
28650 &%acl_smtp_predata%& ACL.
28651
28652 If the ACL for VRFY returns &"accept"&, a recipient verify (without callout)
28653 is done on the address and the result determines the SMTP response.
28654
28655
28656 .cindex "&[local_scan()]& function" "when all recipients discarded"
28657 The &[local_scan()]& function is always run, even if there are no remaining
28658 recipients; it may create new recipients.
28659
28660
28661
28662 .section "Unset ACL options" "SECID197"
28663 .cindex "&ACL;" "unset options"
28664 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
28665 all the same. &*Note*&: These defaults apply only when the relevant ACL is
28666 not defined at all. For any defined ACL, the default action when control
28667 reaches the end of the ACL statements is &"deny"&.
28668
28669 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
28670 these two are ACLs that are used only for their side effects. They cannot be
28671 used to accept or reject anything.
28672
28673 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
28674 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
28675 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
28676 when the ACL is not defined is &"accept"&.
28677
28678 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
28679 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
28680 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
28681 messages over an SMTP connection. For an example, see the ACL in the default
28682 configuration file.
28683
28684
28685
28686
28687 .section "Data for message ACLs" "SECID198"
28688 .cindex "&ACL;" "data for message ACL"
28689 .vindex &$domain$&
28690 .vindex &$local_part$&
28691 .vindex &$sender_address$&
28692 .vindex &$sender_host_address$&
28693 .vindex &$smtp_command$&
28694 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
28695 that contain information about the host and the message's sender (for example,
28696 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
28697 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
28698 &$local_part$& are set from the argument address. The entire SMTP command
28699 is available in &$smtp_command$&.
28700
28701 When an ACL for the AUTH parameter of MAIL is running, the variables that
28702 contain information about the host are set, but &$sender_address$& is not yet
28703 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
28704 how it is used.
28705
28706 .vindex "&$message_size$&"
28707 The &$message_size$& variable is set to the value of the SIZE parameter on
28708 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
28709 that parameter is not given. The value is updated to the true message size by
28710 the time the final DATA ACL is run (after the message data has been
28711 received).
28712
28713 .vindex "&$rcpt_count$&"
28714 .vindex "&$recipients_count$&"
28715 The &$rcpt_count$& variable increases by one for each RCPT command received.
28716 The &$recipients_count$& variable increases by one each time a RCPT command is
28717 accepted, so while an ACL for RCPT is being processed, it contains the number
28718 of previously accepted recipients. At DATA time (for both the DATA ACLs),
28719 &$rcpt_count$& contains the total number of RCPT commands, and
28720 &$recipients_count$& contains the total number of accepted recipients.
28721
28722
28723
28724
28725
28726 .section "Data for non-message ACLs" "SECTdatfornon"
28727 .cindex "&ACL;" "data for non-message ACL"
28728 .vindex &$smtp_command_argument$&
28729 .vindex &$smtp_command$&
28730 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
28731 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
28732 and the entire SMTP command is available in &$smtp_command$&.
28733 These variables can be tested using a &%condition%& condition. For example,
28734 here is an ACL for use with AUTH, which insists that either the session is
28735 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
28736 does not permit authentication methods that use cleartext passwords on
28737 unencrypted connections.
28738 .code
28739 acl_check_auth:
28740   accept encrypted = *
28741   accept condition = ${if eq{${uc:$smtp_command_argument}}\
28742                      {CRAM-MD5}}
28743   deny   message   = TLS encryption or CRAM-MD5 required
28744 .endd
28745 (Another way of applying this restriction is to arrange for the authenticators
28746 that use cleartext passwords not to be advertised when the connection is not
28747 encrypted. You can use the generic &%server_advertise_condition%& authenticator
28748 option to do this.)
28749
28750
28751
28752 .section "Format of an ACL" "SECID199"
28753 .cindex "&ACL;" "format of"
28754 .cindex "&ACL;" "verbs, definition of"
28755 An individual ACL consists of a number of statements. Each statement starts
28756 with a verb, optionally followed by a number of conditions and &"modifiers"&.
28757 Modifiers can change the way the verb operates, define error and log messages,
28758 set variables, insert delays, and vary the processing of accepted messages.
28759
28760 If all the conditions are met, the verb is obeyed. The same condition may be
28761 used (with different arguments) more than once in the same statement. This
28762 provides a means of specifying an &"and"& conjunction between conditions. For
28763 example:
28764 .code
28765 deny  dnslists = list1.example
28766       dnslists = list2.example
28767 .endd
28768 If there are no conditions, the verb is always obeyed. Exim stops evaluating
28769 the conditions and modifiers when it reaches a condition that fails. What
28770 happens then depends on the verb (and in one case, on a special modifier). Not
28771 all the conditions make sense at every testing point. For example, you cannot
28772 test a sender address in the ACL that is run for a VRFY command.
28773
28774
28775 .section "ACL verbs" "SECID200"
28776 The ACL verbs are as follows:
28777
28778 .ilist
28779 .cindex "&%accept%& ACL verb"
28780 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
28781 of the conditions are not met, what happens depends on whether &%endpass%&
28782 appears among the conditions (for syntax see below). If the failing condition
28783 is before &%endpass%&, control is passed to the next ACL statement; if it is
28784 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
28785 check a RCPT command:
28786 .code
28787 accept domains = +local_domains
28788        endpass
28789        verify = recipient
28790 .endd
28791 If the recipient domain does not match the &%domains%& condition, control
28792 passes to the next statement. If it does match, the recipient is verified, and
28793 the command is accepted if verification succeeds. However, if verification
28794 fails, the ACL yields &"deny"&, because the failing condition is after
28795 &%endpass%&.
28796
28797 The &%endpass%& feature has turned out to be confusing to many people, so its
28798 use is not recommended nowadays. It is always possible to rewrite an ACL so
28799 that &%endpass%& is not needed, and it is no longer used in the default
28800 configuration.
28801
28802 .cindex "&%message%& ACL modifier" "with &%accept%&"
28803 If a &%message%& modifier appears on an &%accept%& statement, its action
28804 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
28805 (when an &%accept%& verb either accepts or passes control to the next
28806 statement), &%message%& can be used to vary the message that is sent when an
28807 SMTP command is accepted. For example, in a RCPT ACL you could have:
28808 .display
28809 &`accept  `&<&'some conditions'&>
28810 &`        message = OK, I will allow you through today`&
28811 .endd
28812 You can specify an SMTP response code, optionally followed by an &"extended
28813 response code"& at the start of the message, but the first digit must be the
28814 same as would be sent by default, which is 2 for an &%accept%& verb.
28815
28816 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
28817 an error message that is used when access is denied. This behaviour is retained
28818 for backward compatibility, but current &"best practice"& is to avoid the use
28819 of &%endpass%&.
28820
28821
28822 .next
28823 .cindex "&%defer%& ACL verb"
28824 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
28825 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
28826 &%defer%& is the same as &%deny%&, because there is no way of sending a
28827 temporary error. For a RCPT command, &%defer%& is much the same as using a
28828 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
28829 be used in any ACL, and even for a recipient it might be a simpler approach.
28830
28831
28832 .next
28833 .cindex "&%deny%& ACL verb"
28834 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
28835 the conditions are not met, control is passed to the next ACL statement. For
28836 example,
28837 .code
28838 deny dnslists = blackholes.mail-abuse.org
28839 .endd
28840 rejects commands from hosts that are on a DNS black list.
28841
28842
28843 .next
28844 .cindex "&%discard%& ACL verb"
28845 &%discard%&: This verb behaves like &%accept%&, except that it returns
28846 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
28847 that are concerned with receiving messages. When all the conditions are true,
28848 the sending entity receives a &"success"& response. However, &%discard%& causes
28849 recipients to be discarded. If it is used in an ACL for RCPT, just the one
28850 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
28851 message's recipients are discarded. Recipients that are discarded before DATA
28852 do not appear in the log line when the &%received_recipients%& log selector is set.
28853
28854 If the &%log_message%& modifier is set when &%discard%& operates,
28855 its contents are added to the line that is automatically written to the log.
28856 The &%message%& modifier operates exactly as it does for &%accept%&.
28857
28858
28859 .next
28860 .cindex "&%drop%& ACL verb"
28861 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
28862 forcibly closed after the 5&'xx'& error message has been sent. For example:
28863 .code
28864 drop   message   = I don't take more than 20 RCPTs
28865        condition = ${if > {$rcpt_count}{20}}
28866 .endd
28867 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
28868 The connection is always dropped after sending a 550 response.
28869
28870 .next
28871 .cindex "&%require%& ACL verb"
28872 &%require%&: If all the conditions are met, control is passed to the next ACL
28873 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
28874 example, when checking a RCPT command,
28875 .code
28876 require message = Sender did not verify
28877         verify  = sender
28878 .endd
28879 passes control to subsequent statements only if the message's sender can be
28880 verified. Otherwise, it rejects the command. Note the positioning of the
28881 &%message%& modifier, before the &%verify%& condition. The reason for this is
28882 discussed in section &<<SECTcondmodproc>>&.
28883
28884 .next
28885 .cindex "&%warn%& ACL verb"
28886 &%warn%&: If all the conditions are true, a line specified by the
28887 &%log_message%& modifier is written to Exim's main log. Control always passes
28888 to the next ACL statement. If any condition is false, the log line is not
28889 written. If an identical log line is requested several times in the same
28890 message, only one copy is actually written to the log. If you want to force
28891 duplicates to be written, use the &%logwrite%& modifier instead.
28892
28893 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
28894 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
28895 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
28896 first failing condition. There is more about adding header lines in section
28897 &<<SECTaddheadacl>>&.
28898
28899 If any condition on a &%warn%& statement cannot be completed (that is, there is
28900 some sort of defer), the log line specified by &%log_message%& is not written.
28901 This does not include the case of a forced failure from a lookup, which
28902 is considered to be a successful completion. After a defer, no further
28903 conditions or modifiers in the &%warn%& statement are processed. The incident
28904 is logged, and the ACL continues to be processed, from the next statement
28905 onwards.
28906
28907
28908 .vindex "&$acl_verify_message$&"
28909 When one of the &%warn%& conditions is an address verification that fails, the
28910 text of the verification failure message is in &$acl_verify_message$&. If you
28911 want this logged, you must set it up explicitly. For example:
28912 .code
28913 warn   !verify = sender
28914        log_message = sender verify failed: $acl_verify_message
28915 .endd
28916 .endlist
28917
28918 At the end of each ACL there is an implicit unconditional &%deny%&.
28919
28920 As you can see from the examples above, the conditions and modifiers are
28921 written one to a line, with the first one on the same line as the verb, and
28922 subsequent ones on following lines. If you have a very long condition, you can
28923 continue it onto several physical lines by the usual backslash continuation
28924 mechanism. It is conventional to align the conditions vertically.
28925
28926
28927
28928 .section "ACL variables" "SECTaclvariables"
28929 .cindex "&ACL;" "variables"
28930 There are some special variables that can be set during ACL processing. They
28931 can be used to pass information between different ACLs, different invocations
28932 of the same ACL in the same SMTP connection, and between ACLs and the routers,
28933 transports, and filters that are used to deliver a message. The names of these
28934 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
28935 an underscore, but the remainder of the name can be any sequence of
28936 alphanumeric characters and underscores that you choose. There is no limit on
28937 the number of ACL variables. The two sets act as follows:
28938 .ilist
28939 The values of those variables whose names begin with &$acl_c$& persist
28940 throughout an SMTP connection. They are never reset. Thus, a value that is set
28941 while receiving one message is still available when receiving the next message
28942 on the same SMTP connection.
28943 .next
28944 The values of those variables whose names begin with &$acl_m$& persist only
28945 while a message is being received. They are reset afterwards. They are also
28946 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
28947 .endlist
28948
28949 When a message is accepted, the current values of all the ACL variables are
28950 preserved with the message and are subsequently made available at delivery
28951 time. The ACL variables are set by a modifier called &%set%&. For example:
28952 .code
28953 accept hosts = whatever
28954        set acl_m4 = some value
28955 accept authenticated = *
28956        set acl_c_auth = yes
28957 .endd
28958 &*Note*&: A leading dollar sign is not used when naming a variable that is to
28959 be set. If you want to set a variable without taking any action, you can use a
28960 &%warn%& verb without any other modifiers or conditions.
28961
28962 .oindex &%strict_acl_vars%&
28963 What happens if a syntactically valid but undefined ACL variable is
28964 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
28965 false (the default), an empty string is substituted; if it is true, an
28966 error is generated.
28967
28968 Versions of Exim before 4.64 have a limited set of numbered variables, but
28969 their names are compatible, so there is no problem with upgrading.
28970
28971
28972 .section "Condition and modifier processing" "SECTcondmodproc"
28973 .cindex "&ACL;" "conditions; processing"
28974 .cindex "&ACL;" "modifiers; processing"
28975 An exclamation mark preceding a condition negates its result. For example:
28976 .code
28977 deny   domains = *.dom.example
28978       !verify  = recipient
28979 .endd
28980 causes the ACL to return &"deny"& if the recipient domain ends in
28981 &'dom.example'& and the recipient address cannot be verified. Sometimes
28982 negation can be used on the right-hand side of a condition. For example, these
28983 two statements are equivalent:
28984 .code
28985 deny  hosts = !192.168.3.4
28986 deny !hosts =  192.168.3.4
28987 .endd
28988 However, for many conditions (&%verify%& being a good example), only left-hand
28989 side negation of the whole condition is possible.
28990
28991 The arguments of conditions and modifiers are expanded. A forced failure
28992 of an expansion causes a condition to be ignored, that is, it behaves as if the
28993 condition is true. Consider these two statements:
28994 .code
28995 accept  senders = ${lookup{$host_name}lsearch\
28996                   {/some/file}{$value}fail}
28997 accept  senders = ${lookup{$host_name}lsearch\
28998                   {/some/file}{$value}{}}
28999 .endd
29000 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
29001 the returned list is searched, but if the lookup fails the behaviour is
29002 different in the two cases. The &%fail%& in the first statement causes the
29003 condition to be ignored, leaving no further conditions. The &%accept%& verb
29004 therefore succeeds. The second statement, however, generates an empty list when
29005 the lookup fails. No sender can match an empty list, so the condition fails,
29006 and therefore the &%accept%& also fails.
29007
29008 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
29009 specify actions that are taken as the conditions for a statement are checked;
29010 others specify text for messages that are used when access is denied or a
29011 warning is generated. The &%control%& modifier affects the way an incoming
29012 message is handled.
29013
29014 The positioning of the modifiers in an ACL statement is important, because the
29015 processing of a verb ceases as soon as its outcome is known. Only those
29016 modifiers that have already been encountered will take effect. For example,
29017 consider this use of the &%message%& modifier:
29018 .code
29019 require message = Can't verify sender
29020         verify  = sender
29021         message = Can't verify recipient
29022         verify  = recipient
29023         message = This message cannot be used
29024 .endd
29025 If sender verification fails, Exim knows that the result of the statement is
29026 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
29027 so its text is used as the error message. If sender verification succeeds, but
29028 recipient verification fails, the second message is used. If recipient
29029 verification succeeds, the third message becomes &"current"&, but is never used
29030 because there are no more conditions to cause failure.
29031
29032 For the &%deny%& verb, on the other hand, it is always the last &%message%&
29033 modifier that is used, because all the conditions must be true for rejection to
29034 happen. Specifying more than one &%message%& modifier does not make sense, and
29035 the message can even be specified after all the conditions. For example:
29036 .code
29037 deny   hosts = ...
29038       !senders = *@my.domain.example
29039        message = Invalid sender from client host
29040 .endd
29041 The &"deny"& result does not happen until the end of the statement is reached,
29042 by which time Exim has set up the message.
29043
29044
29045
29046 .section "ACL modifiers" "SECTACLmodi"
29047 .cindex "&ACL;" "modifiers; list of"
29048 The ACL modifiers are as follows:
29049
29050 .vlist
29051 .vitem &*add_header*&&~=&~<&'text'&>
29052 This modifier specifies one or more header lines that are to be added to an
29053 incoming message, assuming, of course, that the message is ultimately
29054 accepted. For details, see section &<<SECTaddheadacl>>&.
29055
29056 .vitem &*continue*&&~=&~<&'text'&>
29057 .cindex "&%continue%& ACL modifier"
29058 .cindex "database" "updating in ACL"
29059 This modifier does nothing of itself, and processing of the ACL always
29060 continues with the next condition or modifier. The value of &%continue%& is in
29061 the side effects of expanding its argument. Typically this could be used to
29062 update a database. It is really just a syntactic tidiness, to avoid having to
29063 write rather ugly lines like this:
29064 .display
29065 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
29066 .endd
29067 Instead, all you need is
29068 .display
29069 &`continue = `&<&'some expansion'&>
29070 .endd
29071
29072 .vitem &*control*&&~=&~<&'text'&>
29073 .cindex "&%control%& ACL modifier"
29074 This modifier affects the subsequent processing of the SMTP connection or of an
29075 incoming message that is accepted. The effect of the first type of control
29076 lasts for the duration of the connection, whereas the effect of the second type
29077 lasts only until the current message has been received. The message-specific
29078 controls always apply to the whole message, not to individual recipients,
29079 even if the &%control%& modifier appears in a RCPT ACL.
29080
29081 As there are now quite a few controls that can be applied, they are described
29082 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
29083 in several different ways. For example:
29084
29085 . ==== As this is a nested list, any displays it contains must be indented
29086 . ==== as otherwise they are too far to the left. That comment applies only
29087 . ==== when xmlto and fop are used; formatting with sdop gets it right either
29088 . ==== way.
29089
29090 .ilist
29091 It can be at the end of an &%accept%& statement:
29092 .code
29093     accept  ...some conditions
29094             control = queue_only
29095 .endd
29096 In this case, the control is applied when this statement yields &"accept"&, in
29097 other words, when the conditions are all true.
29098
29099 .next
29100 It can be in the middle of an &%accept%& statement:
29101 .code
29102     accept  ...some conditions...
29103             control = queue_only
29104             ...some more conditions...
29105 .endd
29106 If the first set of conditions are true, the control is applied, even if the
29107 statement does not accept because one of the second set of conditions is false.
29108 In this case, some subsequent statement must yield &"accept"& for the control
29109 to be relevant.
29110
29111 .next
29112 It can be used with &%warn%& to apply the control, leaving the
29113 decision about accepting or denying to a subsequent verb. For
29114 example:
29115 .code
29116     warn    ...some conditions...
29117             control = freeze
29118     accept  ...
29119 .endd
29120 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
29121 &%logwrite%&, so it does not add anything to the message and does not write a
29122 log entry.
29123
29124 .next
29125 If you want to apply a control unconditionally, you can use it with a
29126 &%require%& verb. For example:
29127 .code
29128     require  control = no_multiline_responses
29129 .endd
29130 .endlist
29131
29132 .vitem &*delay*&&~=&~<&'time'&>
29133 .cindex "&%delay%& ACL modifier"
29134 .oindex "&%-bh%&"
29135 This modifier may appear in any ACL except notquit. It causes Exim to wait for
29136 the time interval before proceeding. However, when testing Exim using the
29137 &%-bh%& option, the delay is not actually imposed (an appropriate message is
29138 output instead). The time is given in the usual Exim notation, and the delay
29139 happens as soon as the modifier is processed. In an SMTP session, pending
29140 output is flushed before the delay is imposed.
29141
29142 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
29143 example:
29144 .code
29145 deny    ...some conditions...
29146         delay = 30s
29147 .endd
29148 The delay happens if all the conditions are true, before the statement returns
29149 &"deny"&. Compare this with:
29150 .code
29151 deny    delay = 30s
29152         ...some conditions...
29153 .endd
29154 which waits for 30s before processing the conditions. The &%delay%& modifier
29155 can also be used with &%warn%& and together with &%control%&:
29156 .code
29157 warn    ...some conditions...
29158         delay = 2m
29159         control = freeze
29160 accept  ...
29161 .endd
29162
29163 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
29164 responses to several commands are no longer buffered and sent in one packet (as
29165 they would normally be) because all output is flushed before imposing the
29166 delay. This optimization is disabled so that a number of small delays do not
29167 appear to the client as one large aggregated delay that might provoke an
29168 unwanted timeout. You can, however, disable output flushing for &%delay%& by
29169 using a &%control%& modifier to set &%no_delay_flush%&.
29170
29171
29172 .vitem &*endpass*&
29173 .cindex "&%endpass%& ACL modifier"
29174 This modifier, which has no argument, is recognized only in &%accept%& and
29175 &%discard%& statements. It marks the boundary between the conditions whose
29176 failure causes control to pass to the next statement, and the conditions whose
29177 failure causes the ACL to return &"deny"&. This concept has proved to be
29178 confusing to some people, so the use of &%endpass%& is no longer recommended as
29179 &"best practice"&. See the description of &%accept%& above for more details.
29180
29181
29182 .vitem &*log_message*&&~=&~<&'text'&>
29183 .cindex "&%log_message%& ACL modifier"
29184 This modifier sets up a message that is used as part of the log message if the
29185 ACL denies access or a &%warn%& statement's conditions are true. For example:
29186 .code
29187 require log_message = wrong cipher suite $tls_in_cipher
29188         encrypted   = DES-CBC3-SHA
29189 .endd
29190 &%log_message%& is also used when recipients are discarded by &%discard%&. For
29191 example:
29192 .display
29193 &`discard `&<&'some conditions'&>
29194 &`        log_message = Discarded $local_part@$domain because...`&
29195 .endd
29196 When access is denied, &%log_message%& adds to any underlying error message
29197 that may exist because of a condition failure. For example, while verifying a
29198 recipient address, a &':fail:'& redirection might have already set up a
29199 message.
29200
29201 The message may be defined before the conditions to which it applies, because
29202 the string expansion does not happen until Exim decides that access is to be
29203 denied. This means that any variables that are set by the condition are
29204 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
29205 variables are set after a DNS black list lookup succeeds. If the expansion of
29206 &%log_message%& fails, or if the result is an empty string, the modifier is
29207 ignored.
29208
29209 .vindex "&$acl_verify_message$&"
29210 If you want to use a &%warn%& statement to log the result of an address
29211 verification, you can use &$acl_verify_message$& to include the verification
29212 error message.
29213
29214 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
29215 the start of the logged message. If the same warning log message is requested
29216 more than once while receiving  a single email message, only one copy is
29217 actually logged. If you want to log multiple copies, use &%logwrite%& instead
29218 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
29219 is logged for a successful &%warn%& statement.
29220
29221 If &%log_message%& is not present and there is no underlying error message (for
29222 example, from the failure of address verification), but &%message%& is present,
29223 the &%message%& text is used for logging rejections. However, if any text for
29224 logging contains newlines, only the first line is logged. In the absence of
29225 both &%log_message%& and &%message%&, a default built-in message is used for
29226 logging rejections.
29227
29228
29229 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
29230 .cindex "&%log_reject_target%& ACL modifier"
29231 .cindex "logging in ACL" "specifying which log"
29232 This modifier makes it possible to specify which logs are used for messages
29233 about ACL rejections. Its argument is a colon-separated list of words that can
29234 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
29235 may be empty, in which case a rejection is not logged at all. For example, this
29236 ACL fragment writes no logging information when access is denied:
29237 .display
29238 &`deny `&<&'some conditions'&>
29239 &`     log_reject_target =`&
29240 .endd
29241 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
29242 permanent and temporary rejections. Its effect lasts for the rest of the
29243 current ACL.
29244
29245
29246 .vitem &*logwrite*&&~=&~<&'text'&>
29247 .cindex "&%logwrite%& ACL modifier"
29248 .cindex "logging in ACL" "immediate"
29249 This modifier writes a message to a log file as soon as it is encountered when
29250 processing an ACL. (Compare &%log_message%&, which, except in the case of
29251 &%warn%& and &%discard%&, is used only if the ACL statement denies
29252 access.) The &%logwrite%& modifier can be used to log special incidents in
29253 ACLs. For example:
29254 .display
29255 &`accept `&<&'some special conditions'&>
29256 &`       control  = freeze`&
29257 &`       logwrite = froze message because ...`&
29258 .endd
29259 By default, the message is written to the main log. However, it may begin
29260 with a colon, followed by a comma-separated list of log names, and then
29261 another colon, to specify exactly which logs are to be written. For
29262 example:
29263 .code
29264 logwrite = :main,reject: text for main and reject logs
29265 logwrite = :panic: text for panic log only
29266 .endd
29267
29268
29269 .vitem &*message*&&~=&~<&'text'&>
29270 .cindex "&%message%& ACL modifier"
29271 This modifier sets up a text string that is expanded and used as a response
29272 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
29273 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
29274 there is some complication if &%endpass%& is involved; see the description of
29275 &%accept%& for details.)
29276
29277 The expansion of the message happens at the time Exim decides that the ACL is
29278 to end, not at the time it processes &%message%&. If the expansion fails, or
29279 generates an empty string, the modifier is ignored. Here is an example where
29280 &%message%& must be specified first, because the ACL ends with a rejection if
29281 the &%hosts%& condition fails:
29282 .code
29283 require  message = Host not recognized
29284          hosts = 10.0.0.0/8
29285 .endd
29286 (Once a condition has failed, no further conditions or modifiers are
29287 processed.)
29288
29289 .cindex "SMTP" "error codes"
29290 .oindex "&%smtp_banner%&
29291 For ACLs that are triggered by SMTP commands, the message is returned as part
29292 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
29293 is meaningful only for SMTP, as no message is returned when a non-SMTP message
29294 is accepted. In the case of the connect ACL, accepting with a message modifier
29295 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
29296 accept message may not contain more than one line (otherwise it will be
29297 truncated at the first newline and a panic logged), and it cannot affect the
29298 EHLO options.
29299
29300 When SMTP is involved, the message may begin with an overriding response code,
29301 consisting of three digits optionally followed by an &"extended response code"&
29302 of the form &'n.n.n'&, each code being followed by a space. For example:
29303 .code
29304 deny  message = 599 1.2.3 Host not welcome
29305       hosts = 192.168.34.0/24
29306 .endd
29307 The first digit of the supplied response code must be the same as would be sent
29308 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
29309 access, but for the predata ACL, note that the default success code is 354, not
29310 2&'xx'&.
29311
29312 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
29313 the message modifier cannot override the 221 response code.
29314
29315 The text in a &%message%& modifier is literal; any quotes are taken as
29316 literals, but because the string is expanded, backslash escapes are processed
29317 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
29318 response.
29319
29320 .vindex "&$acl_verify_message$&"
29321 For ACLs that are called by an &%acl =%& ACL condition, the message is
29322 stored in &$acl_verify_message$&, from which the calling ACL may use it.
29323
29324 If &%message%& is used on a statement that verifies an address, the message
29325 specified overrides any message that is generated by the verification process.
29326 However, the original message is available in the variable
29327 &$acl_verify_message$&, so you can incorporate it into your message if you
29328 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
29329 routers to be passed back as part of the SMTP response, you should either not
29330 use a &%message%& modifier, or make use of &$acl_verify_message$&.
29331
29332 For compatibility with previous releases of Exim, a &%message%& modifier that
29333 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
29334 modifier, but this usage is now deprecated. However, &%message%& acts only when
29335 all the conditions are true, wherever it appears in an ACL command, whereas
29336 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
29337 &%warn%& in an ACL that is not concerned with receiving a message, it has no
29338 effect.
29339
29340
29341 .vitem &*queue*&&~=&~<&'text'&>
29342 .cindex "&%queue%& ACL modifier"
29343 .cindex "named queues" "selecting in ACL"
29344 This modifier specifies the use of a named queue for spool files
29345 for the message.
29346 It can only be used before the message is received (i.e. not in
29347 the DATA ACL).
29348 This could be used, for example, for known high-volume burst sources
29349 of traffic, or for quarantine of messages.
29350 Separate queue-runner processes will be needed for named queues.
29351 If the text after expansion is empty, the default queue is used.
29352
29353
29354 .vitem &*remove_header*&&~=&~<&'text'&>
29355 This modifier specifies one or more header names in a colon-separated list
29356  that are to be removed from an incoming message, assuming, of course, that
29357 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
29358
29359
29360 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
29361 .cindex "&%set%& ACL modifier"
29362 This modifier puts a value into one of the ACL variables (see section
29363 &<<SECTaclvariables>>&).
29364
29365
29366 .vitem &*udpsend*&&~=&~<&'parameters'&>
29367 .cindex "UDP communications"
29368 This modifier sends a UDP packet, for purposes such as statistics
29369 collection or behaviour monitoring. The parameters are expanded, and
29370 the result of the expansion must be a colon-separated list consisting
29371 of a destination server, port number, and the packet contents. The
29372 server can be specified as a host name or IPv4 or IPv6 address. The
29373 separator can be changed with the usual angle bracket syntax. For
29374 example, you might want to collect information on which hosts connect
29375 when:
29376 .code
29377 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
29378              $tod_zulu $sender_host_address
29379 .endd
29380 .endlist
29381
29382
29383
29384
29385 .section "Use of the control modifier" "SECTcontrols"
29386 .cindex "&%control%& ACL modifier"
29387 The &%control%& modifier supports the following settings:
29388
29389 .vlist
29390 .vitem &*control&~=&~allow_auth_unadvertised*&
29391 This modifier allows a client host to use the SMTP AUTH command even when it
29392 has not been advertised in response to EHLO. Furthermore, because there are
29393 apparently some really broken clients that do this, Exim will accept AUTH after
29394 HELO (rather than EHLO) when this control is set. It should be used only if you
29395 really need it, and you should limit its use to those broken clients that do
29396 not work without it. For example:
29397 .code
29398 warn hosts   = 192.168.34.25
29399      control = allow_auth_unadvertised
29400 .endd
29401 Normally, when an Exim server receives an AUTH command, it checks the name of
29402 the authentication mechanism that is given in the command to ensure that it
29403 matches an advertised mechanism. When this control is set, the check that a
29404 mechanism has been advertised is bypassed. Any configured mechanism can be used
29405 by the client. This control is permitted only in the connection and HELO ACLs.
29406
29407
29408 .vitem &*control&~=&~caseful_local_part*& &&&
29409        &*control&~=&~caselower_local_part*&
29410 .cindex "&ACL;" "case of local part in"
29411 .cindex "case of local parts"
29412 .vindex "&$local_part$&"
29413 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
29414 (that is, during RCPT processing). By default, the contents of &$local_part$&
29415 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
29416 any uppercase letters in the original local part are restored in &$local_part$&
29417 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
29418 is encountered.
29419
29420 These controls affect only the current recipient. Moreover, they apply only to
29421 local part handling that takes place directly in the ACL (for example, as a key
29422 in lookups). If a test to verify the recipient is obeyed, the case-related
29423 handling of the local part during the verification is controlled by the router
29424 configuration (see the &%caseful_local_part%& generic router option).
29425
29426 This facility could be used, for example, to add a spam score to local parts
29427 containing upper case letters. For example, using &$acl_m4$& to accumulate the
29428 spam score:
29429 .code
29430 warn  control = caseful_local_part
29431       set acl_m4 = ${eval:\
29432                      $acl_m4 + \
29433                      ${if match{$local_part}{[A-Z]}{1}{0}}\
29434                     }
29435       control = caselower_local_part
29436 .endd
29437 Notice that we put back the lower cased version afterwards, assuming that
29438 is what is wanted for subsequent tests.
29439
29440
29441 .vitem &*control&~=&~cutthrough_delivery/*&<&'options'&>
29442 .cindex "&ACL;" "cutthrough routing"
29443 .cindex "cutthrough" "requesting"
29444 This option requests delivery be attempted while the item is being received.
29445
29446 The option is usable in the RCPT ACL.
29447 If enabled for a message received via smtp and routed to an smtp transport,
29448 and only one transport, interface, destination host and port combination
29449 is used for all recipients of the message,
29450 then the delivery connection is made while the receiving connection is open
29451 and data is copied from one to the other.
29452
29453 An attempt to set this option for any recipient but the first
29454 for a mail will be quietly ignored.
29455 If a recipient-verify callout
29456 (with use_sender)
29457 connection is subsequently
29458 requested in the same ACL it is held open and used for
29459 any subsequent recipients and the data,
29460 otherwise one is made after the initial RCPT ACL completes.
29461
29462 Note that routers are used in verify mode,
29463 and cannot depend on content of received headers.
29464 Note also that headers cannot be
29465 modified by any of the post-data ACLs (DATA, MIME and DKIM).
29466 Headers may be modified by routers (subject to the above) and transports.
29467 The Received-By: header is generated as soon as the body reception starts,
29468 rather than the traditional time after the full message is received;
29469 this will affect the timestamp.
29470
29471 All the usual ACLs are called; if one results in the message being
29472 rejected, all effort spent in delivery (including the costs on
29473 the ultimate destination) will be wasted.
29474 Note that in the case of data-time ACLs this includes the entire
29475 message body.
29476
29477 Cutthrough delivery is not supported via transport-filters or when DKIM signing
29478 of outgoing messages is done, because it sends data to the ultimate destination
29479 before the entire message has been received from the source.
29480 It is not supported for messages received with the SMTP PRDR
29481 or CHUNKING
29482 options in use.
29483
29484 Should the ultimate destination system positively accept or reject the mail,
29485 a corresponding indication is given to the source system and nothing is queued.
29486 If the item is successfully delivered in cutthrough mode
29487 the delivery log lines are tagged with ">>" rather than "=>" and appear
29488 before the acceptance "<=" line.
29489
29490 If there is a temporary error the item is queued for later delivery in the
29491 usual fashion.
29492 This behaviour can be adjusted by appending the option &*defer=*&<&'value'&>
29493 to the control; the default value is &"spool"& and the alternate value
29494 &"pass"& copies an SMTP defer response from the target back to the initiator
29495 and does not queue the message.
29496 Note that this is independent of any recipient verify conditions in the ACL.
29497
29498 Delivery in this mode avoids the generation of a bounce mail to a
29499 (possibly faked)
29500 sender when the destination system is doing content-scan based rejection.
29501
29502
29503 .vitem &*control&~=&~debug/*&<&'options'&>
29504 .cindex "&ACL;" "enabling debug logging"
29505 .cindex "debugging" "enabling from an ACL"
29506 This control turns on debug logging, almost as though Exim had been invoked
29507 with &`-d`&, with the output going to a new logfile in the usual logs directory,
29508 by default called &'debuglog'&.
29509 The filename can be adjusted with the &'tag'& option, which
29510 may access any variables already defined.  The logging may be adjusted with
29511 the &'opts'& option, which takes the same values as the &`-d`& command-line
29512 option.
29513 Logging started this way may be stopped, and the file removed,
29514 with the &'kill'& option.
29515 Some examples (which depend on variables that don't exist in all
29516 contexts):
29517 .code
29518       control = debug
29519       control = debug/tag=.$sender_host_address
29520       control = debug/opts=+expand+acl
29521       control = debug/tag=.$message_exim_id/opts=+expand
29522       control = debug/kill
29523 .endd
29524
29525
29526 .vitem &*control&~=&~dkim_disable_verify*&
29527 .cindex "disable DKIM verify"
29528 .cindex "DKIM" "disable verify"
29529 This control turns off DKIM verification processing entirely.  For details on
29530 the operation and configuration of DKIM, see section &<<SECDKIM>>&.
29531
29532
29533 .vitem &*control&~=&~dscp/*&<&'value'&>
29534 .cindex "&ACL;" "setting DSCP value"
29535 .cindex "DSCP" "inbound"
29536 This option causes the DSCP value associated with the socket for the inbound
29537 connection to be adjusted to a given value, given as one of a number of fixed
29538 strings or to numeric value.
29539 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
29540 Common values include &`throughput`&, &`mincost`&, and on newer systems
29541 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
29542
29543 The outbound packets from Exim will be marked with this value in the header
29544 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
29545 that these values will have any effect, not be stripped by networking
29546 equipment, or do much of anything without cooperation with your Network
29547 Engineer and those of all network operators between the source and destination.
29548
29549
29550 .vitem &*control&~=&~enforce_sync*& &&&
29551        &*control&~=&~no_enforce_sync*&
29552 .cindex "SMTP" "synchronization checking"
29553 .cindex "synchronization checking in SMTP"
29554 These controls make it possible to be selective about when SMTP synchronization
29555 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
29556 state of the switch (it is true by default). See the description of this option
29557 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
29558
29559 The effect of these two controls lasts for the remainder of the SMTP
29560 connection. They can appear in any ACL except the one for the non-SMTP
29561 messages. The most straightforward place to put them is in the ACL defined by
29562 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
29563 before the first synchronization check. The expected use is to turn off the
29564 synchronization checks for badly-behaved hosts that you nevertheless need to
29565 work with.
29566
29567
29568 .vitem &*control&~=&~fakedefer/*&<&'message'&>
29569 .cindex "fake defer"
29570 .cindex "defer, fake"
29571 This control works in exactly the same way as &%fakereject%& (described below)
29572 except that it causes an SMTP 450 response after the message data instead of a
29573 550 response. You must take care when using &%fakedefer%& because it causes the
29574 messages to be duplicated when the sender retries. Therefore, you should not
29575 use &%fakedefer%& if the message is to be delivered normally.
29576
29577 .vitem &*control&~=&~fakereject/*&<&'message'&>
29578 .cindex "fake rejection"
29579 .cindex "rejection, fake"
29580 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
29581 words, only when an SMTP message is being received. If Exim accepts the
29582 message, instead the final 250 response, a 550 rejection message is sent.
29583 However, Exim proceeds to deliver the message as normal. The control applies
29584 only to the current message, not to any subsequent ones that may be received in
29585 the same SMTP connection.
29586
29587 The text for the 550 response is taken from the &%control%& modifier. If no
29588 message is supplied, the following is used:
29589 .code
29590 550-Your message has been rejected but is being
29591 550-kept for evaluation.
29592 550-If it was a legitimate message, it may still be
29593 550 delivered to the target recipient(s).
29594 .endd
29595 This facility should be used with extreme caution.
29596
29597 .vitem &*control&~=&~freeze*&
29598 .cindex "frozen messages" "forcing in ACL"
29599 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
29600 other words, only when a message is being received. If the message is accepted,
29601 it is placed on Exim's queue and frozen. The control applies only to the
29602 current message, not to any subsequent ones that may be received in the same
29603 SMTP connection.
29604
29605 This modifier can optionally be followed by &`/no_tell`&. If the global option
29606 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
29607 is told about the freezing), provided all the &*control=freeze*& modifiers that
29608 are obeyed for the current message have the &`/no_tell`& option.
29609
29610 .vitem &*control&~=&~no_delay_flush*&
29611 .cindex "SMTP" "output flushing, disabling for delay"
29612 Exim normally flushes SMTP output before implementing a delay in an ACL, to
29613 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
29614 use. This control, as long as it is encountered before the &%delay%& modifier,
29615 disables such output flushing.
29616
29617 .vitem &*control&~=&~no_callout_flush*&
29618 .cindex "SMTP" "output flushing, disabling for callout"
29619 Exim normally flushes SMTP output before performing a callout in an ACL, to
29620 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
29621 use. This control, as long as it is encountered before the &%verify%& condition
29622 that causes the callout, disables such output flushing.
29623
29624 .vitem &*control&~=&~no_mbox_unspool*&
29625 This control is available when Exim is compiled with the content scanning
29626 extension. Content scanning may require a copy of the current message, or parts
29627 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
29628 or spam scanner. Normally, such copies are deleted when they are no longer
29629 needed. If this control is set, the copies are not deleted. The control applies
29630 only to the current message, not to any subsequent ones that may be received in
29631 the same SMTP connection. It is provided for debugging purposes and is unlikely
29632 to be useful in production.
29633
29634 .vitem &*control&~=&~no_multiline_responses*&
29635 .cindex "multiline responses, suppressing"
29636 This control is permitted for any ACL except the one for non-SMTP messages.
29637 It seems that there are broken clients in use that cannot handle multiline
29638 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
29639
29640 If this control is set, multiline SMTP responses from ACL rejections are
29641 suppressed. One way of doing this would have been to put out these responses as
29642 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
29643 (&"use multiline responses for more"& it says &-- ha!), and some of the
29644 responses might get close to that. So this facility, which is after all only a
29645 sop to broken clients, is implemented by doing two very easy things:
29646
29647 .ilist
29648 Extra information that is normally output as part of a rejection caused by
29649 sender verification failure is omitted. Only the final line (typically &"sender
29650 verification failed"&) is sent.
29651 .next
29652 If a &%message%& modifier supplies a multiline response, only the first
29653 line is output.
29654 .endlist
29655
29656 The setting of the switch can, of course, be made conditional on the
29657 calling host. Its effect lasts until the end of the SMTP connection.
29658
29659 .vitem &*control&~=&~no_pipelining*&
29660 .cindex "PIPELINING" "suppressing advertising"
29661 This control turns off the advertising of the PIPELINING extension to SMTP in
29662 the current session. To be useful, it must be obeyed before Exim sends its
29663 response to an EHLO command. Therefore, it should normally appear in an ACL
29664 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
29665 &%pipelining_advertise_hosts%&.
29666
29667 .vitem &*control&~=&~queue_only*&
29668 .oindex "&%queue_only%&"
29669 .cindex "queueing incoming messages"
29670 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
29671 other words, only when a message is being received. If the message is accepted,
29672 it is placed on Exim's queue and left there for delivery by a subsequent queue
29673 runner. No immediate delivery process is started. In other words, it has the
29674 effect as the &%queue_only%& global option. However, the control applies only
29675 to the current message, not to any subsequent ones that may be received in the
29676 same SMTP connection.
29677
29678 .vitem &*control&~=&~submission/*&<&'options'&>
29679 .cindex "message" "submission"
29680 .cindex "submission mode"
29681 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
29682 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
29683 the current message is a submission from a local MUA. In this case, Exim
29684 operates in &"submission mode"&, and applies certain fixups to the message if
29685 necessary. For example, it adds a &'Date:'& header line if one is not present.
29686 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
29687 late (the message has already been created).
29688
29689 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
29690 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
29691 submission mode; the available options for this control are described there.
29692 The control applies only to the current message, not to any subsequent ones
29693 that may be received in the same SMTP connection.
29694
29695 .vitem &*control&~=&~suppress_local_fixups*&
29696 .cindex "submission fixups, suppressing"
29697 This control applies to locally submitted (non TCP/IP) messages, and is the
29698 complement of &`control = submission`&. It disables the fixups that are
29699 normally applied to locally-submitted messages. Specifically:
29700
29701 .ilist
29702 Any &'Sender:'& header line is left alone (in this respect, it is a
29703 dynamic version of &%local_sender_retain%&).
29704 .next
29705 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
29706 .next
29707 There is no check that &'From:'& corresponds to the actual sender.
29708 .endlist ilist
29709
29710 This control may be useful when a remotely-originated message is accepted,
29711 passed to some scanning program, and then re-submitted for delivery. It can be
29712 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
29713 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
29714 data is read.
29715
29716 &*Note:*& This control applies only to the current message, not to any others
29717 that are being submitted at the same time using &%-bs%& or &%-bS%&.
29718
29719 .vitem &*control&~=&~utf8_downconvert*&
29720 This control enables conversion of UTF-8 in message addresses
29721 to a-label form.
29722 For details see section &<<SECTi18nMTA>>&.
29723 .endlist vlist
29724
29725
29726 .section "Summary of message fixup control" "SECTsummesfix"
29727 All four possibilities for message fixups can be specified:
29728
29729 .ilist
29730 Locally submitted, fixups applied: the default.
29731 .next
29732 Locally submitted, no fixups applied: use
29733 &`control = suppress_local_fixups`&.
29734 .next
29735 Remotely submitted, no fixups applied: the default.
29736 .next
29737 Remotely submitted, fixups applied: use &`control = submission`&.
29738 .endlist
29739
29740
29741
29742 .section "Adding header lines in ACLs" "SECTaddheadacl"
29743 .cindex "header lines" "adding in an ACL"
29744 .cindex "header lines" "position of added lines"
29745 .cindex "&%add_header%& ACL modifier"
29746 The &%add_header%& modifier can be used to add one or more extra header lines
29747 to an incoming message, as in this example:
29748 .code
29749 warn dnslists = sbl.spamhaus.org : \
29750                 dialup.mail-abuse.org
29751      add_header = X-blacklisted-at: $dnslist_domain
29752 .endd
29753 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
29754 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
29755 receiving a message). The message must ultimately be accepted for
29756 &%add_header%& to have any significant effect. You can use &%add_header%& with
29757 any ACL verb, including &%deny%& (though this is potentially useful only in a
29758 RCPT ACL).
29759
29760 Headers will not be added to the message if the modifier is used in
29761 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
29762
29763 Leading and trailing newlines are removed from
29764 the data for the &%add_header%& modifier; if it then
29765 contains one or more newlines that
29766 are not followed by a space or a tab, it is assumed to contain multiple header
29767 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
29768 front of any line that is not a valid header line.
29769
29770 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
29771 They are added to the message before processing the DATA and MIME ACLs.
29772 However, if an identical header line is requested more than once, only one copy
29773 is actually added to the message. Further header lines may be accumulated
29774 during the DATA and MIME ACLs, after which they are added to the message, again
29775 with duplicates suppressed. Thus, it is possible to add two identical header
29776 lines to an SMTP message, but only if one is added before DATA and one after.
29777 In the case of non-SMTP messages, new headers are accumulated during the
29778 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
29779 message is rejected after DATA or by the non-SMTP ACL, all added header lines
29780 are included in the entry that is written to the reject log.
29781
29782 .cindex "header lines" "added; visibility of"
29783 Header lines are not visible in string expansions
29784 of message headers
29785 until they are added to the
29786 message. It follows that header lines defined in the MAIL, RCPT, and predata
29787 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
29788 header lines that are added by the DATA or MIME ACLs are not visible in those
29789 ACLs. Because of this restriction, you cannot use header lines as a way of
29790 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
29791 this, you can use ACL variables, as described in section
29792 &<<SECTaclvariables>>&.
29793
29794 The list of headers yet to be added is given by the &%$headers_added%& variable.
29795
29796 The &%add_header%& modifier acts immediately as it is encountered during the
29797 processing of an ACL. Notice the difference between these two cases:
29798 .display
29799 &`accept add_header = ADDED: some text`&
29800 &`       `&<&'some condition'&>
29801
29802 &`accept `&<&'some condition'&>
29803 &`       add_header = ADDED: some text`&
29804 .endd
29805 In the first case, the header line is always added, whether or not the
29806 condition is true. In the second case, the header line is added only if the
29807 condition is true. Multiple occurrences of &%add_header%& may occur in the same
29808 ACL statement. All those that are encountered before a condition fails are
29809 honoured.
29810
29811 .cindex "&%warn%& ACL verb"
29812 For compatibility with previous versions of Exim, a &%message%& modifier for a
29813 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
29814 effect only if all the conditions are true, even if it appears before some of
29815 them. Furthermore, only the last occurrence of &%message%& is honoured. This
29816 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
29817 are present on a &%warn%& verb, both are processed according to their
29818 specifications.
29819
29820 By default, new header lines are added to a message at the end of the existing
29821 header lines. However, you can specify that any particular header line should
29822 be added right at the start (before all the &'Received:'& lines), immediately
29823 after the first block of &'Received:'& lines, or immediately before any line
29824 that is not a &'Received:'& or &'Resent-something:'& header.
29825
29826 This is done by specifying &":at_start:"&, &":after_received:"&, or
29827 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
29828 header line, respectively. (Header text cannot start with a colon, as there has
29829 to be a header name first.) For example:
29830 .code
29831 warn add_header = \
29832        :after_received:X-My-Header: something or other...
29833 .endd
29834 If more than one header line is supplied in a single &%add_header%& modifier,
29835 each one is treated independently and can therefore be placed differently. If
29836 you add more than one line at the start, or after the Received: block, they end
29837 up in reverse order.
29838
29839 &*Warning*&: This facility currently applies only to header lines that are
29840 added in an ACL. It does NOT work for header lines that are added in a
29841 system filter or in a router or transport.
29842
29843
29844
29845 .section "Removing header lines in ACLs" "SECTremoveheadacl"
29846 .cindex "header lines" "removing in an ACL"
29847 .cindex "header lines" "position of removed lines"
29848 .cindex "&%remove_header%& ACL modifier"
29849 The &%remove_header%& modifier can be used to remove one or more header lines
29850 from an incoming message, as in this example:
29851 .code
29852 warn   message        = Remove internal headers
29853        remove_header  = x-route-mail1 : x-route-mail2
29854 .endd
29855 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
29856 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
29857 receiving a message). The message must ultimately be accepted for
29858 &%remove_header%& to have any significant effect. You can use &%remove_header%&
29859 with any ACL verb, including &%deny%&, though this is really not useful for
29860 any verb that doesn't result in a delivered message.
29861
29862 Headers will not be removed from the message if the modifier is used in
29863 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
29864
29865 More than one header can be removed at the same time by using a colon separated
29866 list of header names. The header matching is case insensitive. Wildcards are
29867 not permitted, nor is list expansion performed, so you cannot use hostlists to
29868 create a list of headers, however both connection and message variable expansion
29869 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
29870 .code
29871 warn   hosts           = +internal_hosts
29872        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
29873 warn   message         = Remove internal headers
29874        remove_header   = $acl_c_ihdrs
29875 .endd
29876 Removed header lines are accumulated during the MAIL, RCPT, and predata ACLs.
29877 They are removed from the message before processing the DATA and MIME ACLs.
29878 There is no harm in attempting to remove the same header twice nor is removing
29879 a non-existent header. Further header lines to be removed may be accumulated
29880 during the DATA and MIME ACLs, after which they are removed from the message,
29881 if present. In the case of non-SMTP messages, headers to be removed are
29882 accumulated during the non-SMTP ACLs, and are removed from the message after
29883 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
29884 ACL, there really is no effect because there is no logging of what headers
29885 would have been removed.
29886
29887 .cindex "header lines" "removed; visibility of"
29888 Header lines are not visible in string expansions until the DATA phase when it
29889 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
29890 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
29891 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
29892 this restriction, you cannot use header lines as a way of controlling data
29893 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
29894 you should instead use ACL variables, as described in section
29895 &<<SECTaclvariables>>&.
29896
29897 The &%remove_header%& modifier acts immediately as it is encountered during the
29898 processing of an ACL. Notice the difference between these two cases:
29899 .display
29900 &`accept remove_header = X-Internal`&
29901 &`       `&<&'some condition'&>
29902
29903 &`accept `&<&'some condition'&>
29904 &`       remove_header = X-Internal`&
29905 .endd
29906 In the first case, the header line is always removed, whether or not the
29907 condition is true. In the second case, the header line is removed only if the
29908 condition is true. Multiple occurrences of &%remove_header%& may occur in the
29909 same ACL statement. All those that are encountered before a condition fails
29910 are honoured.
29911
29912 &*Warning*&: This facility currently applies only to header lines that are
29913 present during ACL processing. It does NOT remove header lines that are added
29914 in a system filter or in a router or transport.
29915
29916
29917
29918
29919 .section "ACL conditions" "SECTaclconditions"
29920 .cindex "&ACL;" "conditions; list of"
29921 Some of the conditions listed in this section are available only when Exim is
29922 compiled with the content-scanning extension. They are included here briefly
29923 for completeness. More detailed descriptions can be found in the discussion on
29924 content scanning in chapter &<<CHAPexiscan>>&.
29925
29926 Not all conditions are relevant in all circumstances. For example, testing
29927 senders and recipients does not make sense in an ACL that is being run as the
29928 result of the arrival of an ETRN command, and checks on message headers can be
29929 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
29930 can use the same condition (with different parameters) more than once in the
29931 same ACL statement. This provides a way of specifying an &"and"& conjunction.
29932 The conditions are as follows:
29933
29934
29935 .vlist
29936 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
29937 .cindex "&ACL;" "nested"
29938 .cindex "&ACL;" "indirect"
29939 .cindex "&ACL;" "arguments"
29940 .cindex "&%acl%& ACL condition"
29941 The possible values of the argument are the same as for the
29942 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
29943 &"accept"& the condition is true; if it returns &"deny"& the condition is
29944 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
29945 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
29946 condition false. This means that further processing of the &%warn%& verb
29947 ceases, but processing of the ACL continues.
29948
29949 If the argument is a named ACL, up to nine space-separated optional values
29950 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
29951 and $acl_narg is set to the count of values.
29952 Previous values of these variables are restored after the call returns.
29953 The name and values are expanded separately.
29954 Note that spaces in complex expansions which are used as arguments
29955 will act as argument separators.
29956
29957 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
29958 the connection is dropped. If it returns &"discard"&, the verb must be
29959 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
29960 conditions are tested.
29961
29962 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
29963 loops. This condition allows you to use different ACLs in different
29964 circumstances. For example, different ACLs can be used to handle RCPT commands
29965 for different local users or different local domains.
29966
29967 .vitem &*authenticated&~=&~*&<&'string&~list'&>
29968 .cindex "&%authenticated%& ACL condition"
29969 .cindex "authentication" "ACL checking"
29970 .cindex "&ACL;" "testing for authentication"
29971 If the SMTP connection is not authenticated, the condition is false. Otherwise,
29972 the name of the authenticator is tested against the list. To test for
29973 authentication by any authenticator, you can set
29974 .code
29975 authenticated = *
29976 .endd
29977
29978 .vitem &*condition&~=&~*&<&'string'&>
29979 .cindex "&%condition%& ACL condition"
29980 .cindex "customizing" "ACL condition"
29981 .cindex "&ACL;" "customized test"
29982 .cindex "&ACL;" "testing, customized"
29983 This feature allows you to make up custom conditions. If the result of
29984 expanding the string is an empty string, the number zero, or one of the strings
29985 &"no"& or &"false"&, the condition is false. If the result is any non-zero
29986 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
29987 any other value, some error is assumed to have occurred, and the ACL returns
29988 &"defer"&. However, if the expansion is forced to fail, the condition is
29989 ignored. The effect is to treat it as true, whether it is positive or
29990 negative.
29991
29992 .vitem &*decode&~=&~*&<&'location'&>
29993 .cindex "&%decode%& ACL condition"
29994 This condition is available only when Exim is compiled with the
29995 content-scanning extension, and it is allowed only in the ACL defined by
29996 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
29997 If all goes well, the condition is true. It is false only if there are
29998 problems such as a syntax error or a memory shortage. For more details, see
29999 chapter &<<CHAPexiscan>>&.
30000
30001 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
30002 .cindex "&%dnslists%& ACL condition"
30003 .cindex "DNS list" "in ACL"
30004 .cindex "black list (DNS)"
30005 .cindex "&ACL;" "testing a DNS list"
30006 This condition checks for entries in DNS black lists. These are also known as
30007 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
30008 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
30009 different variants of this condition to describe briefly here. See sections
30010 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
30011
30012 .vitem &*domains&~=&~*&<&'domain&~list'&>
30013 .cindex "&%domains%& ACL condition"
30014 .cindex "domain" "ACL checking"
30015 .cindex "&ACL;" "testing a recipient domain"
30016 .vindex "&$domain_data$&"
30017 This condition is relevant only after a RCPT command. It checks that the domain
30018 of the recipient address is in the domain list. If percent-hack processing is
30019 enabled, it is done before this test is done. If the check succeeds with a
30020 lookup, the result of the lookup is placed in &$domain_data$& until the next
30021 &%domains%& test.
30022
30023 &*Note carefully*& (because many people seem to fall foul of this): you cannot
30024 use &%domains%& in a DATA ACL.
30025
30026
30027 .vitem &*encrypted&~=&~*&<&'string&~list'&>
30028 .cindex "&%encrypted%& ACL condition"
30029 .cindex "encryption" "checking in an ACL"
30030 .cindex "&ACL;" "testing for encryption"
30031 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
30032 name of the cipher suite in use is tested against the list. To test for
30033 encryption without testing for any specific cipher suite(s), set
30034 .code
30035 encrypted = *
30036 .endd
30037
30038
30039 .vitem &*hosts&~=&~*&<&'host&~list'&>
30040 .cindex "&%hosts%& ACL condition"
30041 .cindex "host" "ACL checking"
30042 .cindex "&ACL;" "testing the client host"
30043 This condition tests that the calling host matches the host list. If you have
30044 name lookups or wildcarded host names and IP addresses in the same host list,
30045 you should normally put the IP addresses first. For example, you could have:
30046 .code
30047 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
30048 .endd
30049 The lookup in this example uses the host name for its key. This is implied by
30050 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
30051 and it wouldn't matter which way round you had these two items.)
30052
30053 The reason for the problem with host names lies in the left-to-right way that
30054 Exim processes lists. It can test IP addresses without doing any DNS lookups,
30055 but when it reaches an item that requires a host name, it fails if it cannot
30056 find a host name to compare with the pattern. If the above list is given in the
30057 opposite order, the &%accept%& statement fails for a host whose name cannot be
30058 found, even if its IP address is 10.9.8.7.
30059
30060 If you really do want to do the name check first, and still recognize the IP
30061 address even if the name lookup fails, you can rewrite the ACL like this:
30062 .code
30063 accept hosts = dbm;/etc/friendly/hosts
30064 accept hosts = 10.9.8.7
30065 .endd
30066 The default action on failing to find the host name is to assume that the host
30067 is not in the list, so the first &%accept%& statement fails. The second
30068 statement can then check the IP address.
30069
30070 .vindex "&$host_data$&"
30071 If a &%hosts%& condition is satisfied by means of a lookup, the result
30072 of the lookup is made available in the &$host_data$& variable. This
30073 allows you, for example, to set up a statement like this:
30074 .code
30075 deny  hosts = net-lsearch;/some/file
30076 message = $host_data
30077 .endd
30078 which gives a custom error message for each denied host.
30079
30080 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
30081 .cindex "&%local_parts%& ACL condition"
30082 .cindex "local part" "ACL checking"
30083 .cindex "&ACL;" "testing a local part"
30084 .vindex "&$local_part_data$&"
30085 This condition is relevant only after a RCPT command. It checks that the local
30086 part of the recipient address is in the list. If percent-hack processing is
30087 enabled, it is done before this test. If the check succeeds with a lookup, the
30088 result of the lookup is placed in &$local_part_data$&, which remains set until
30089 the next &%local_parts%& test.
30090
30091 .vitem &*malware&~=&~*&<&'option'&>
30092 .cindex "&%malware%& ACL condition"
30093 .cindex "&ACL;" "virus scanning"
30094 .cindex "&ACL;" "scanning for viruses"
30095 This condition is available only when Exim is compiled with the
30096 content-scanning extension. It causes the incoming message to be scanned for
30097 viruses. For details, see chapter &<<CHAPexiscan>>&.
30098
30099 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
30100 .cindex "&%mime_regex%& ACL condition"
30101 .cindex "&ACL;" "testing by regex matching"
30102 This condition is available only when Exim is compiled with the
30103 content-scanning extension, and it is allowed only in the ACL defined by
30104 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
30105 with any of the regular expressions. For details, see chapter
30106 &<<CHAPexiscan>>&.
30107
30108 .vitem &*ratelimit&~=&~*&<&'parameters'&>
30109 .cindex "rate limiting"
30110 This condition can be used to limit the rate at which a user or host submits
30111 messages. Details are given in section &<<SECTratelimiting>>&.
30112
30113 .vitem &*recipients&~=&~*&<&'address&~list'&>
30114 .cindex "&%recipients%& ACL condition"
30115 .cindex "recipient" "ACL checking"
30116 .cindex "&ACL;" "testing a recipient"
30117 This condition is relevant only after a RCPT command. It checks the entire
30118 recipient address against a list of recipients.
30119
30120 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
30121 .cindex "&%regex%& ACL condition"
30122 .cindex "&ACL;" "testing by regex matching"
30123 This condition is available only when Exim is compiled with the
30124 content-scanning extension, and is available only in the DATA, MIME, and
30125 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
30126 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
30127
30128 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
30129 .cindex "&%sender_domains%& ACL condition"
30130 .cindex "sender" "ACL checking"
30131 .cindex "&ACL;" "testing a sender domain"
30132 .vindex "&$domain$&"
30133 .vindex "&$sender_address_domain$&"
30134 This condition tests the domain of the sender of the message against the given
30135 domain list. &*Note*&: The domain of the sender address is in
30136 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
30137 of this condition. This is an exception to the general rule for testing domain
30138 lists. It is done this way so that, if this condition is used in an ACL for a
30139 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
30140 influence the sender checking.
30141
30142 &*Warning*&: It is a bad idea to use this condition on its own as a control on
30143 relaying, because sender addresses are easily, and commonly, forged.
30144
30145 .vitem &*senders&~=&~*&<&'address&~list'&>
30146 .cindex "&%senders%& ACL condition"
30147 .cindex "sender" "ACL checking"
30148 .cindex "&ACL;" "testing a sender"
30149 This condition tests the sender of the message against the given list. To test
30150 for a bounce message, which has an empty sender, set
30151 .code
30152 senders = :
30153 .endd
30154 &*Warning*&: It is a bad idea to use this condition on its own as a control on
30155 relaying, because sender addresses are easily, and commonly, forged.
30156
30157 .vitem &*spam&~=&~*&<&'username'&>
30158 .cindex "&%spam%& ACL condition"
30159 .cindex "&ACL;" "scanning for spam"
30160 This condition is available only when Exim is compiled with the
30161 content-scanning extension. It causes the incoming message to be scanned by
30162 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
30163
30164 .vitem &*verify&~=&~certificate*&
30165 .cindex "&%verify%& ACL condition"
30166 .cindex "TLS" "client certificate verification"
30167 .cindex "certificate" "verification of client"
30168 .cindex "&ACL;" "certificate verification"
30169 .cindex "&ACL;" "testing a TLS certificate"
30170 This condition is true in an SMTP session if the session is encrypted, and a
30171 certificate was received from the client, and the certificate was verified. The
30172 server requests a certificate only if the client matches &%tls_verify_hosts%&
30173 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
30174
30175 .vitem &*verify&~=&~csa*&
30176 .cindex "CSA verification"
30177 This condition checks whether the sending host (the client) is authorized to
30178 send email. Details of how this works are given in section
30179 &<<SECTverifyCSA>>&.
30180
30181 .vitem &*verify&~=&~header_names_ascii*&
30182 .cindex "&%verify%& ACL condition"
30183 .cindex "&ACL;" "verifying header names only ASCII"
30184 .cindex "header lines" "verifying header names only ASCII"
30185 .cindex "verifying" "header names only ASCII"
30186 This condition is relevant only in an ACL that is run after a message has been
30187 received, that is, in an ACL specified by &%acl_smtp_data%& or
30188 &%acl_not_smtp%&.  It checks all header names (not the content) to make sure
30189 there are no non-ASCII characters, also excluding control characters.  The
30190 allowable characters are decimal ASCII values 33 through 126.
30191
30192 Exim itself will handle headers with non-ASCII characters, but it can cause
30193 problems for downstream applications, so this option will allow their
30194 detection and rejection in the DATA ACL's.
30195
30196 .vitem &*verify&~=&~header_sender/*&<&'options'&>
30197 .cindex "&%verify%& ACL condition"
30198 .cindex "&ACL;" "verifying sender in the header"
30199 .cindex "header lines" "verifying the sender in"
30200 .cindex "sender" "verifying in header"
30201 .cindex "verifying" "sender in header"
30202 This condition is relevant only in an ACL that is run after a message has been
30203 received, that is, in an ACL specified by &%acl_smtp_data%& or
30204 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
30205 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
30206 is loosely thought of as a &"sender"& address (hence the name of the test).
30207 However, an address that appears in one of these headers need not be an address
30208 that accepts bounce messages; only sender addresses in envelopes are required
30209 to accept bounces. Therefore, if you use the callout option on this check, you
30210 might want to arrange for a non-empty address in the MAIL command.
30211
30212 Details of address verification and the options are given later, starting at
30213 section &<<SECTaddressverification>>& (callouts are described in section
30214 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
30215 condition to restrict it to bounce messages only:
30216 .code
30217 deny    senders = :
30218         message = A valid sender header is required for bounces
30219        !verify  = header_sender
30220 .endd
30221
30222 .vitem &*verify&~=&~header_syntax*&
30223 .cindex "&%verify%& ACL condition"
30224 .cindex "&ACL;" "verifying header syntax"
30225 .cindex "header lines" "verifying syntax"
30226 .cindex "verifying" "header syntax"
30227 This condition is relevant only in an ACL that is run after a message has been
30228 received, that is, in an ACL specified by &%acl_smtp_data%& or
30229 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
30230 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
30231 and &'Bcc:'&), returning true if there are no problems.
30232 Unqualified addresses (local parts without domains) are
30233 permitted only in locally generated messages and from hosts that match
30234 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
30235 appropriate.
30236
30237 Note that this condition is a syntax check only. However, a common spamming
30238 ploy used to be to send syntactically invalid headers such as
30239 .code
30240 To: @
30241 .endd
30242 and this condition can be used to reject such messages, though they are not as
30243 common as they used to be.
30244
30245 .vitem &*verify&~=&~helo*&
30246 .cindex "&%verify%& ACL condition"
30247 .cindex "&ACL;" "verifying HELO/EHLO"
30248 .cindex "HELO" "verifying"
30249 .cindex "EHLO" "verifying"
30250 .cindex "verifying" "EHLO"
30251 .cindex "verifying" "HELO"
30252 This condition is true if a HELO or EHLO command has been received from the
30253 client host, and its contents have been verified. If there has been no previous
30254 attempt to verify the HELO/EHLO contents, it is carried out when this
30255 condition is encountered. See the description of the &%helo_verify_hosts%& and
30256 &%helo_try_verify_hosts%& options for details of how to request verification
30257 independently of this condition.
30258
30259 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
30260 option), this condition is always true.
30261
30262
30263 .vitem &*verify&~=&~not_blind*&
30264 .cindex "verifying" "not blind"
30265 .cindex "bcc recipients, verifying none"
30266 This condition checks that there are no blind (bcc) recipients in the message.
30267 Every envelope recipient must appear either in a &'To:'& header line or in a
30268 &'Cc:'& header line for this condition to be true. Local parts are checked
30269 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
30270 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
30271 used only in a DATA or non-SMTP ACL.
30272
30273 There are, of course, many legitimate messages that make use of blind (bcc)
30274 recipients. This check should not be used on its own for blocking messages.
30275
30276
30277 .vitem &*verify&~=&~recipient/*&<&'options'&>
30278 .cindex "&%verify%& ACL condition"
30279 .cindex "&ACL;" "verifying recipient"
30280 .cindex "recipient" "verifying"
30281 .cindex "verifying" "recipient"
30282 .vindex "&$address_data$&"
30283 This condition is relevant only after a RCPT command. It verifies the current
30284 recipient. Details of address verification are given later, starting at section
30285 &<<SECTaddressverification>>&. After a recipient has been verified, the value
30286 of &$address_data$& is the last value that was set while routing the address.
30287 This applies even if the verification fails. When an address that is being
30288 verified is redirected to a single address, verification continues with the new
30289 address, and in that case, the subsequent value of &$address_data$& is the
30290 value for the child address.
30291
30292 .vitem &*verify&~=&~reverse_host_lookup/*&<&'options'&>
30293 .cindex "&%verify%& ACL condition"
30294 .cindex "&ACL;" "verifying host reverse lookup"
30295 .cindex "host" "verifying reverse lookup"
30296 This condition ensures that a verified host name has been looked up from the IP
30297 address of the client host. (This may have happened already if the host name
30298 was needed for checking a host list, or if the host matched &%host_lookup%&.)
30299 Verification ensures that the host name obtained from a reverse DNS lookup, or
30300 one of its aliases, does, when it is itself looked up in the DNS, yield the
30301 original IP address.
30302
30303 There is one possible option, &`defer_ok`&.  If this is present and a
30304 DNS operation returns a temporary error, the verify condition succeeds.
30305
30306 If this condition is used for a locally generated message (that is, when there
30307 is no client host involved), it always succeeds.
30308
30309 .vitem &*verify&~=&~sender/*&<&'options'&>
30310 .cindex "&%verify%& ACL condition"
30311 .cindex "&ACL;" "verifying sender"
30312 .cindex "sender" "verifying"
30313 .cindex "verifying" "sender"
30314 This condition is relevant only after a MAIL or RCPT command, or after a
30315 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
30316 the message's sender is empty (that is, this is a bounce message), the
30317 condition is true. Otherwise, the sender address is verified.
30318
30319 .vindex "&$address_data$&"
30320 .vindex "&$sender_address_data$&"
30321 If there is data in the &$address_data$& variable at the end of routing, its
30322 value is placed in &$sender_address_data$& at the end of verification. This
30323 value can be used in subsequent conditions and modifiers in the same ACL
30324 statement. It does not persist after the end of the current statement. If you
30325 want to preserve the value for longer, you can save it in an ACL variable.
30326
30327 Details of verification are given later, starting at section
30328 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
30329 to avoid doing it more than once per message.
30330
30331 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
30332 .cindex "&%verify%& ACL condition"
30333 This is a variation of the previous option, in which a modified address is
30334 verified as a sender.
30335
30336 Note that '/' is legal in local-parts; if the address may have such
30337 (eg. is generated from the received message)
30338 they must be protected from the options parsing by doubling:
30339 .code
30340 verify = sender=${sg{${address:$h_sender:}}{/}{//}}
30341 .endd
30342 .endlist
30343
30344
30345
30346 .section "Using DNS lists" "SECTmorednslists"
30347 .cindex "DNS list" "in ACL"
30348 .cindex "black list (DNS)"
30349 .cindex "&ACL;" "testing a DNS list"
30350 In its simplest form, the &%dnslists%& condition tests whether the calling host
30351 is on at least one of a number of DNS lists by looking up the inverted IP
30352 address in one or more DNS domains. (Note that DNS list domains are not mail
30353 domains, so the &`+`& syntax for named lists doesn't work - it is used for
30354 special options instead.) For example, if the calling host's IP
30355 address is 192.168.62.43, and the ACL statement is
30356 .code
30357 deny dnslists = blackholes.mail-abuse.org : \
30358                 dialups.mail-abuse.org
30359 .endd
30360 the following records are looked up:
30361 .code
30362 43.62.168.192.blackholes.mail-abuse.org
30363 43.62.168.192.dialups.mail-abuse.org
30364 .endd
30365 As soon as Exim finds an existing DNS record, processing of the list stops.
30366 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
30367 to test that a host is on more than one list (an &"and"& conjunction), you can
30368 use two separate conditions:
30369 .code
30370 deny dnslists = blackholes.mail-abuse.org
30371      dnslists = dialups.mail-abuse.org
30372 .endd
30373 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
30374 behaves as if the host does not match the list item, that is, as if the DNS
30375 record does not exist. If there are further items in the DNS list, they are
30376 processed.
30377
30378 This is usually the required action when &%dnslists%& is used with &%deny%&
30379 (which is the most common usage), because it prevents a DNS failure from
30380 blocking mail. However, you can change this behaviour by putting one of the
30381 following special items in the list:
30382 .display
30383 &`+include_unknown `&   behave as if the item is on the list
30384 &`+exclude_unknown `&   behave as if the item is not on the list (default)
30385 &`+defer_unknown   `&   give a temporary error
30386 .endd
30387 .cindex "&`+include_unknown`&"
30388 .cindex "&`+exclude_unknown`&"
30389 .cindex "&`+defer_unknown`&"
30390 Each of these applies to any subsequent items on the list. For example:
30391 .code
30392 deny dnslists = +defer_unknown : foo.bar.example
30393 .endd
30394 Testing the list of domains stops as soon as a match is found. If you want to
30395 warn for one list and block for another, you can use two different statements:
30396 .code
30397 deny  dnslists = blackholes.mail-abuse.org
30398 warn  message  = X-Warn: sending host is on dialups list
30399       dnslists = dialups.mail-abuse.org
30400 .endd
30401 .cindex caching "of dns lookup"
30402 .cindex DNS TTL
30403 DNS list lookups are cached by Exim for the duration of the SMTP session
30404 (but limited by the DNS return TTL value),
30405 so a lookup based on the IP address is done at most once for any incoming
30406 connection (assuming long-enough TTL).
30407 Exim does not share information between multiple incoming
30408 connections (but your local name server cache should be active).
30409
30410
30411
30412 .section "Specifying the IP address for a DNS list lookup" "SECID201"
30413 .cindex "DNS list" "keyed by explicit IP address"
30414 By default, the IP address that is used in a DNS list lookup is the IP address
30415 of the calling host. However, you can specify another IP address by listing it
30416 after the domain name, introduced by a slash. For example:
30417 .code
30418 deny dnslists = black.list.tld/192.168.1.2
30419 .endd
30420 This feature is not very helpful with explicit IP addresses; it is intended for
30421 use with IP addresses that are looked up, for example, the IP addresses of the
30422 MX hosts or nameservers of an email sender address. For an example, see section
30423 &<<SECTmulkeyfor>>& below.
30424
30425
30426
30427
30428 .section "DNS lists keyed on domain names" "SECID202"
30429 .cindex "DNS list" "keyed by domain name"
30430 There are some lists that are keyed on domain names rather than inverted IP
30431 addresses (see for example the &'domain based zones'& link at
30432 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
30433 with these lists. You can change the name that is looked up in a DNS list by
30434 listing it after the domain name, introduced by a slash. For example,
30435 .code
30436 deny  message  = Sender's domain is listed at $dnslist_domain
30437       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
30438 .endd
30439 This particular example is useful only in ACLs that are obeyed after the
30440 RCPT or DATA commands, when a sender address is available. If (for
30441 example) the message's sender is &'user@tld.example'& the name that is looked
30442 up by this example is
30443 .code
30444 tld.example.dsn.rfc-ignorant.org
30445 .endd
30446 A single &%dnslists%& condition can contain entries for both names and IP
30447 addresses. For example:
30448 .code
30449 deny dnslists = sbl.spamhaus.org : \
30450                 dsn.rfc-ignorant.org/$sender_address_domain
30451 .endd
30452 The first item checks the sending host's IP address; the second checks a domain
30453 name. The whole condition is true if either of the DNS lookups succeeds.
30454
30455
30456
30457
30458 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
30459 .cindex "DNS list" "multiple keys for"
30460 The syntax described above for looking up explicitly-defined values (either
30461 names or IP addresses) in a DNS blacklist is a simplification. After the domain
30462 name for the DNS list, what follows the slash can in fact be a list of items.
30463 As with all lists in Exim, the default separator is a colon. However, because
30464 this is a sublist within the list of DNS blacklist domains, it is necessary
30465 either to double the separators like this:
30466 .code
30467 dnslists = black.list.tld/name.1::name.2
30468 .endd
30469 or to change the separator character, like this:
30470 .code
30471 dnslists = black.list.tld/<;name.1;name.2
30472 .endd
30473 If an item in the list is an IP address, it is inverted before the DNS
30474 blacklist domain is appended. If it is not an IP address, no inversion
30475 occurs. Consider this condition:
30476 .code
30477 dnslists = black.list.tld/<;192.168.1.2;a.domain
30478 .endd
30479 The DNS lookups that occur are:
30480 .code
30481 2.1.168.192.black.list.tld
30482 a.domain.black.list.tld
30483 .endd
30484 Once a DNS record has been found (that matches a specific IP return
30485 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
30486 are done. If there is a temporary DNS error, the rest of the sublist of domains
30487 or IP addresses is tried. A temporary error for the whole dnslists item occurs
30488 only if no other DNS lookup in this sublist succeeds. In other words, a
30489 successful lookup for any of the items in the sublist overrides a temporary
30490 error for a previous item.
30491
30492 The ability to supply a list of items after the slash is in some sense just a
30493 syntactic convenience. These two examples have the same effect:
30494 .code
30495 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
30496 dnslists = black.list.tld/a.domain::b.domain
30497 .endd
30498 However, when the data for the list is obtained from a lookup, the second form
30499 is usually much more convenient. Consider this example:
30500 .code
30501 deny message  = The mail servers for the domain \
30502                 $sender_address_domain \
30503                 are listed at $dnslist_domain ($dnslist_value); \
30504                 see $dnslist_text.
30505      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
30506                                    ${lookup dnsdb {>|mxh=\
30507                                    $sender_address_domain} }} }
30508 .endd
30509 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
30510 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
30511 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
30512 of expanding the condition might be something like this:
30513 .code
30514 dnslists = sbl.spamhaus.org/<|192.168.2.3|192.168.5.6|...
30515 .endd
30516 Thus, this example checks whether or not the IP addresses of the sender
30517 domain's mail servers are on the Spamhaus black list.
30518
30519 The key that was used for a successful DNS list lookup is put into the variable
30520 &$dnslist_matched$& (see section &<<SECID204>>&).
30521
30522
30523
30524
30525 .section "Data returned by DNS lists" "SECID203"
30526 .cindex "DNS list" "data returned from"
30527 DNS lists are constructed using address records in the DNS. The original RBL
30528 just used the address 127.0.0.1 on the right hand side of each record, but the
30529 RBL+ list and some other lists use a number of values with different meanings.
30530 The values used on the RBL+ list are:
30531 .display
30532 127.1.0.1  RBL
30533 127.1.0.2  DUL
30534 127.1.0.3  DUL and RBL
30535 127.1.0.4  RSS
30536 127.1.0.5  RSS and RBL
30537 127.1.0.6  RSS and DUL
30538 127.1.0.7  RSS and DUL and RBL
30539 .endd
30540 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
30541 different values. Some DNS lists may return more than one address record;
30542 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
30543
30544
30545 .section "Variables set from DNS lists" "SECID204"
30546 .cindex "expansion" "variables, set from DNS list"
30547 .cindex "DNS list" "variables set from"
30548 .vindex "&$dnslist_domain$&"
30549 .vindex "&$dnslist_matched$&"
30550 .vindex "&$dnslist_text$&"
30551 .vindex "&$dnslist_value$&"
30552 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
30553 the name of the overall domain that matched (for example,
30554 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
30555 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
30556 the DNS record. When the key is an IP address, it is not reversed in
30557 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
30558 cases, for example:
30559 .code
30560 deny dnslists = spamhaus.example
30561 .endd
30562 the key is also available in another variable (in this case,
30563 &$sender_host_address$&). In more complicated cases, however, this is not true.
30564 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
30565 might generate a dnslists lookup like this:
30566 .code
30567 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
30568 .endd
30569 If this condition succeeds, the value in &$dnslist_matched$& might be
30570 &`192.168.6.7`& (for example).
30571
30572 If more than one address record is returned by the DNS lookup, all the IP
30573 addresses are included in &$dnslist_value$&, separated by commas and spaces.
30574 The variable &$dnslist_text$& contains the contents of any associated TXT
30575 record. For lists such as RBL+ the TXT record for a merged entry is often not
30576 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
30577 information.
30578
30579 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
30580 &-- although these appear before the condition in the ACL, they are not
30581 expanded until after it has failed. For example:
30582 .code
30583 deny    hosts = !+local_networks
30584         message = $sender_host_address is listed \
30585                   at $dnslist_domain
30586         dnslists = rbl-plus.mail-abuse.example
30587 .endd
30588
30589
30590
30591 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
30592 .cindex "DNS list" "matching specific returned data"
30593 You can add an equals sign and an IP address after a &%dnslists%& domain name
30594 in order to restrict its action to DNS records with a matching right hand side.
30595 For example,
30596 .code
30597 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
30598 .endd
30599 rejects only those hosts that yield 127.0.0.2. Without this additional data,
30600 any address record is considered to be a match. For the moment, we assume
30601 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
30602 describes how multiple records are handled.
30603
30604 More than one IP address may be given for checking, using a comma as a
30605 separator. These are alternatives &-- if any one of them matches, the
30606 &%dnslists%& condition is true. For example:
30607 .code
30608 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
30609 .endd
30610 If you want to specify a constraining address list and also specify names or IP
30611 addresses to be looked up, the constraining address list must be specified
30612 first. For example:
30613 .code
30614 deny dnslists = dsn.rfc-ignorant.org\
30615                 =127.0.0.2/$sender_address_domain
30616 .endd
30617
30618 If the character &`&&`& is used instead of &`=`&, the comparison for each
30619 listed IP address is done by a bitwise &"and"& instead of by an equality test.
30620 In other words, the listed addresses are used as bit masks. The comparison is
30621 true if all the bits in the mask are present in the address that is being
30622 tested. For example:
30623 .code
30624 dnslists = a.b.c&0.0.0.3
30625 .endd
30626 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
30627 want to test whether one bit or another bit is present (as opposed to both
30628 being present), you must use multiple values. For example:
30629 .code
30630 dnslists = a.b.c&0.0.0.1,0.0.0.2
30631 .endd
30632 matches if the final component of the address is an odd number or two times
30633 an odd number.
30634
30635
30636
30637 .section "Negated DNS matching conditions" "SECID205"
30638 You can supply a negative list of IP addresses as part of a &%dnslists%&
30639 condition. Whereas
30640 .code
30641 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
30642 .endd
30643 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
30644 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
30645 .code
30646 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
30647 .endd
30648 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
30649 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
30650 words, the result of the test is inverted if an exclamation mark appears before
30651 the &`=`& (or the &`&&`&) sign.
30652
30653 &*Note*&: This kind of negation is not the same as negation in a domain,
30654 host, or address list (which is why the syntax is different).
30655
30656 If you are using just one list, the negation syntax does not gain you much. The
30657 previous example is precisely equivalent to
30658 .code
30659 deny  dnslists = a.b.c
30660      !dnslists = a.b.c=127.0.0.2,127.0.0.3
30661 .endd
30662 However, if you are using multiple lists, the negation syntax is clearer.
30663 Consider this example:
30664 .code
30665 deny  dnslists = sbl.spamhaus.org : \
30666                  list.dsbl.org : \
30667                  dnsbl.njabl.org!=127.0.0.3 : \
30668                  relays.ordb.org
30669 .endd
30670 Using only positive lists, this would have to be:
30671 .code
30672 deny  dnslists = sbl.spamhaus.org : \
30673                  list.dsbl.org
30674 deny  dnslists = dnsbl.njabl.org
30675      !dnslists = dnsbl.njabl.org=127.0.0.3
30676 deny  dnslists = relays.ordb.org
30677 .endd
30678 which is less clear, and harder to maintain.
30679
30680
30681
30682
30683 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
30684 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
30685 thereby providing more than one IP address. When an item in a &%dnslists%& list
30686 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
30687 the match to specific results from the DNS lookup, there are two ways in which
30688 the checking can be handled. For example, consider the condition:
30689 .code
30690 dnslists = a.b.c=127.0.0.1
30691 .endd
30692 What happens if the DNS lookup for the incoming IP address yields both
30693 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
30694 condition true because at least one given value was found, or is it false
30695 because at least one of the found values was not listed? And how does this
30696 affect negated conditions? Both possibilities are provided for with the help of
30697 additional separators &`==`& and &`=&&`&.
30698
30699 .ilist
30700 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
30701 IP addresses matches one of the listed addresses. For the example above, the
30702 condition is true because 127.0.0.1 matches.
30703 .next
30704 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
30705 looked up IP addresses matches one of the listed addresses. If the condition is
30706 changed to:
30707 .code
30708 dnslists = a.b.c==127.0.0.1
30709 .endd
30710 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
30711 false because 127.0.0.2 is not listed. You would need to have:
30712 .code
30713 dnslists = a.b.c==127.0.0.1,127.0.0.2
30714 .endd
30715 for the condition to be true.
30716 .endlist
30717
30718 When &`!`& is used to negate IP address matching, it inverts the result, giving
30719 the precise opposite of the behaviour above. Thus:
30720 .ilist
30721 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
30722 addresses matches one of the listed addresses. Consider:
30723 .code
30724 dnslists = a.b.c!&0.0.0.1
30725 .endd
30726 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
30727 false because 127.0.0.1 matches.
30728 .next
30729 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
30730 looked up IP address that does not match. Consider:
30731 .code
30732 dnslists = a.b.c!=&0.0.0.1
30733 .endd
30734 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
30735 true, because 127.0.0.2 does not match. You would need to have:
30736 .code
30737 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
30738 .endd
30739 for the condition to be false.
30740 .endlist
30741 When the DNS lookup yields only a single IP address, there is no difference
30742 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
30743
30744
30745
30746
30747 .section "Detailed information from merged DNS lists" "SECTmordetinf"
30748 .cindex "DNS list" "information from merged"
30749 When the facility for restricting the matching IP values in a DNS list is used,
30750 the text from the TXT record that is set in &$dnslist_text$& may not reflect
30751 the true reason for rejection. This happens when lists are merged and the IP
30752 address in the A record is used to distinguish them; unfortunately there is
30753 only one TXT record. One way round this is not to use merged lists, but that
30754 can be inefficient because it requires multiple DNS lookups where one would do
30755 in the vast majority of cases when the host of interest is not on any of the
30756 lists.
30757
30758 A less inefficient way of solving this problem is available. If
30759 two domain names, comma-separated, are given, the second is used first to
30760 do an initial check, making use of any IP value restrictions that are set.
30761 If there is a match, the first domain is used, without any IP value
30762 restrictions, to get the TXT record. As a byproduct of this, there is also
30763 a check that the IP being tested is indeed on the first list. The first
30764 domain is the one that is put in &$dnslist_domain$&. For example:
30765 .code
30766 reject message  = \
30767          rejected because $sender_host_address is blacklisted \
30768          at $dnslist_domain\n$dnslist_text
30769        dnslists = \
30770          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
30771          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
30772 .endd
30773 For the first blacklist item, this starts by doing a lookup in
30774 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
30775 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
30776 value, and as long as something is found, it looks for the corresponding TXT
30777 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
30778 The second blacklist item is processed similarly.
30779
30780 If you are interested in more than one merged list, the same list must be
30781 given several times, but because the results of the DNS lookups are cached,
30782 the DNS calls themselves are not repeated. For example:
30783 .code
30784 reject dnslists = \
30785          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
30786          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
30787          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
30788          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
30789 .endd
30790 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
30791 values matches (or if no record is found), this is the only lookup that is
30792 done. Only if there is a match is one of the more specific lists consulted.
30793
30794
30795
30796 .section "DNS lists and IPv6" "SECTmorednslistslast"
30797 .cindex "IPv6" "DNS black lists"
30798 .cindex "DNS list" "IPv6 usage"
30799 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
30800 nibble by nibble. For example, if the calling host's IP address is
30801 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
30802 .code
30803 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
30804   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
30805 .endd
30806 (split over two lines here to fit on the page). Unfortunately, some of the DNS
30807 lists contain wildcard records, intended for IPv4, that interact badly with
30808 IPv6. For example, the DNS entry
30809 .code
30810 *.3.some.list.example.    A    127.0.0.1
30811 .endd
30812 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
30813 Unfortunately, it also matches the entire 3::/4 IPv6 network.
30814
30815 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
30816 &%condition%& condition, as in this example:
30817 .code
30818 deny   condition = ${if isip4{$sender_host_address}}
30819        dnslists  = some.list.example
30820 .endd
30821
30822 If an explicit key is being used for a DNS lookup and it may be an IPv6
30823 address you should specify alternate list separators for both the outer
30824 (DNS list name) list and inner (lookup keys) list:
30825 .code
30826        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
30827 .endd
30828
30829 .section "Rate limiting incoming messages" "SECTratelimiting"
30830 .cindex "rate limiting" "client sending"
30831 .cindex "limiting client sending rates"
30832 .oindex "&%smtp_ratelimit_*%&"
30833 The &%ratelimit%& ACL condition can be used to measure and control the rate at
30834 which clients can send email. This is more powerful than the
30835 &%smtp_ratelimit_*%& options, because those options control the rate of
30836 commands in a single SMTP session only, whereas the &%ratelimit%& condition
30837 works across all connections (concurrent and sequential) from the same client
30838 host. The syntax of the &%ratelimit%& condition is:
30839 .display
30840 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
30841 .endd
30842 If the average client sending rate is less than &'m'& messages per time
30843 period &'p'& then the condition is false; otherwise it is true.
30844
30845 As a side-effect, the &%ratelimit%& condition sets the expansion variable
30846 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
30847 configured value of &'m'&, and &$sender_rate_period$& to the configured value
30848 of &'p'&.
30849
30850 The parameter &'p'& is the smoothing time constant, in the form of an Exim
30851 time interval, for example, &`8h`& for eight hours. A larger time constant
30852 means that it takes Exim longer to forget a client's past behaviour. The
30853 parameter &'m'& is the maximum number of messages that a client is permitted to
30854 send in each time interval. It also specifies the number of messages permitted
30855 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
30856 constant, you can allow a client to send more messages in a burst without
30857 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
30858 both small, messages must be sent at an even rate.
30859
30860 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
30861 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
30862 when deploying the &%ratelimit%& ACL condition. The script prints usage
30863 instructions when it is run with no arguments.
30864
30865 The key is used to look up the data for calculating the client's average
30866 sending rate. This data is stored in Exim's spool directory, alongside the
30867 retry and other hints databases. The default key is &$sender_host_address$&,
30868 which means Exim computes the sending rate of each client host IP address.
30869 By changing the key you can change how Exim identifies clients for the purpose
30870 of ratelimiting. For example, to limit the sending rate of each authenticated
30871 user, independent of the computer they are sending from, set the key to
30872 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
30873 example, &$authenticated_id$& is only meaningful if the client has
30874 authenticated (which you can check with the &%authenticated%& ACL condition).
30875
30876 The lookup key does not have to identify clients: If you want to limit the
30877 rate at which a recipient receives messages, you can use the key
30878 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
30879 ACL.
30880
30881 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
30882 specifies what Exim measures the rate of, for example messages or recipients
30883 or bytes. You can adjust the measurement using the &%unique=%& and/or
30884 &%count=%& options. You can also control when Exim updates the recorded rate
30885 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
30886 separated by a slash, like the other parameters. They may appear in any order.
30887
30888 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
30889 any options that alter the meaning of the stored data. The limit &'m'& is not
30890 stored, so you can alter the configured maximum rate and Exim will still
30891 remember clients' past behaviour. If you change the &%per_*%& mode or add or
30892 remove the &%unique=%& option, the lookup key changes so Exim will forget past
30893 behaviour. The lookup key is not affected by changes to the update mode and
30894 the &%count=%& option.
30895
30896
30897 .section "Ratelimit options for what is being measured" "ratoptmea"
30898 .cindex "rate limiting" "per_* options"
30899 The &%per_conn%& option limits the client's connection rate. It is not
30900 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
30901 &%acl_not_smtp_start%& ACLs.
30902
30903 The &%per_mail%& option limits the client's rate of sending messages. This is
30904 the default if none of the &%per_*%& options is specified. It can be used in
30905 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
30906 &%acl_smtp_data%&, or &%acl_not_smtp%&.
30907
30908 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
30909 the same ACLs as the &%per_mail%& option, though it is best to use this option
30910 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
30911 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
30912 in its MAIL command, which may be inaccurate or completely missing. You can
30913 follow the limit &'m'& in the configuration with K, M, or G to specify limits
30914 in kilobytes, megabytes, or gigabytes, respectively.
30915
30916 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
30917 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
30918 &%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In
30919 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
30920 ACLs the rate is updated with the total (accepted) recipient count in one go. Note that
30921 in either case the rate limiting engine will see a message with many
30922 recipients as a large high-speed burst.
30923
30924 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
30925 number of different recipients that the client has sent messages to in the
30926 last time period. That is, if the client repeatedly sends messages to the same
30927 recipient, its measured rate is not increased. This option can only be used in
30928 &%acl_smtp_rcpt%&.
30929
30930 The &%per_cmd%& option causes Exim to recompute the rate every time the
30931 condition is processed. This can be used to limit the rate of any SMTP
30932 command. If it is used in multiple ACLs it can limit the aggregate rate of
30933 multiple different commands.
30934
30935 The &%count=%& option can be used to alter how much Exim adds to the client's
30936 measured rate. For example, the &%per_byte%& option is equivalent to
30937 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
30938 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
30939 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
30940
30941 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
30942
30943
30944 .section "Ratelimit update modes" "ratoptupd"
30945 .cindex "rate limiting" "reading data without updating"
30946 You can specify one of three options with the &%ratelimit%& condition to
30947 control when its database is updated. This section describes the &%readonly%&
30948 mode, and the next section describes the &%strict%& and &%leaky%& modes.
30949
30950 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
30951 previously-computed rate to check against the limit.
30952
30953 For example, you can test the client's sending rate and deny it access (when
30954 it is too fast) in the connect ACL. If the client passes this check then it
30955 can go on to send a message, in which case its recorded rate will be updated
30956 in the MAIL ACL. Subsequent connections from the same client will check this
30957 new rate.
30958 .code
30959 acl_check_connect:
30960  deny ratelimit = 100 / 5m / readonly
30961     log_message = RATE CHECK: $sender_rate/$sender_rate_period \
30962                   (max $sender_rate_limit)
30963 # ...
30964 acl_check_mail:
30965  warn ratelimit = 100 / 5m / strict
30966     log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
30967                   (max $sender_rate_limit)
30968 .endd
30969
30970 If Exim encounters multiple &%ratelimit%& conditions with the same key when
30971 processing a message then it may increase the client's measured rate more than
30972 it should. For example, this will happen if you check the &%per_rcpt%& option
30973 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
30974 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
30975 multiple update problems by using the &%readonly%& option on later ratelimit
30976 checks.
30977
30978 The &%per_*%& options described above do not make sense in some ACLs. If you
30979 use a &%per_*%& option in an ACL where it is not normally permitted then the
30980 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
30981 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
30982 next section) so you must specify the &%readonly%& option explicitly.
30983
30984
30985 .section "Ratelimit options for handling fast clients" "ratoptfast"
30986 .cindex "rate limiting" "strict and leaky modes"
30987 If a client's average rate is greater than the maximum, the rate limiting
30988 engine can react in two possible ways, depending on the presence of the
30989 &%strict%& or &%leaky%& update modes. This is independent of the other
30990 counter-measures (such as rejecting the message) that may be specified by the
30991 rest of the ACL.
30992
30993 The &%leaky%& (default) option means that the client's recorded rate is not
30994 updated if it is above the limit. The effect of this is that Exim measures the
30995 client's average rate of successfully sent email, which cannot be greater than
30996 the maximum allowed. If the client is over the limit it may suffer some
30997 counter-measures (as specified in the ACL), but it will still be able to send
30998 email at the configured maximum rate, whatever the rate of its attempts. This
30999 is generally the better choice if you have clients that retry automatically.
31000 For example, it does not prevent a sender with an over-aggressive retry rate
31001 from getting any email through.
31002
31003 The &%strict%& option means that the client's recorded rate is always
31004 updated. The effect of this is that Exim measures the client's average rate
31005 of attempts to send email, which can be much higher than the maximum it is
31006 actually allowed. If the client is over the limit it may be subjected to
31007 counter-measures by the ACL. It must slow down and allow sufficient time to
31008 pass that its computed rate falls below the maximum before it can send email
31009 again. The time (the number of smoothing periods) it must wait and not
31010 attempt to send mail can be calculated with this formula:
31011 .code
31012         ln(peakrate/maxrate)
31013 .endd
31014
31015
31016 .section "Limiting the rate of different events" "ratoptuniq"
31017 .cindex "rate limiting" "counting unique events"
31018 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
31019 rate of different events. For example, the &%per_addr%& option uses this
31020 mechanism to count the number of different recipients that the client has
31021 sent messages to in the last time period; it is equivalent to
31022 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
31023 measure the rate that a client uses different sender addresses with the
31024 options &`per_mail/unique=$sender_address`&.
31025
31026 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
31027 has seen for that key. The whole set is thrown away when it is older than the
31028 rate smoothing period &'p'&, so each different event is counted at most once
31029 per period. In the &%leaky%& update mode, an event that causes the client to
31030 go over the limit is not added to the set, in the same way that the client's
31031 recorded rate is not updated in the same situation.
31032
31033 When you combine the &%unique=%& and &%readonly%& options, the specific
31034 &%unique=%& value is ignored, and Exim just retrieves the client's stored
31035 rate.
31036
31037 The &%unique=%& mechanism needs more space in the ratelimit database than the
31038 other &%ratelimit%& options in order to store the event set. The number of
31039 unique values is potentially as large as the rate limit, so the extra space
31040 required increases with larger limits.
31041
31042 The uniqueification is not perfect: there is a small probability that Exim
31043 will think a new event has happened before. If the sender's rate is less than
31044 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
31045 the measured rate can go above the limit, in which case Exim may under-count
31046 events by a significant margin. Fortunately, if the rate is high enough (2.7
31047 times the limit) that the false positive rate goes above 9%, then Exim will
31048 throw away the over-full event set before the measured rate falls below the
31049 limit. Therefore the only harm should be that exceptionally high sending rates
31050 are logged incorrectly; any countermeasures you configure will be as effective
31051 as intended.
31052
31053
31054 .section "Using rate limiting" "useratlim"
31055 Exim's other ACL facilities are used to define what counter-measures are taken
31056 when the rate limit is exceeded. This might be anything from logging a warning
31057 (for example, while measuring existing sending rates in order to define
31058 policy), through time delays to slow down fast senders, up to rejecting the
31059 message. For example:
31060 .code
31061 # Log all senders' rates
31062 warn ratelimit = 0 / 1h / strict
31063      log_message = Sender rate $sender_rate / $sender_rate_period
31064
31065 # Slow down fast senders; note the need to truncate $sender_rate
31066 # at the decimal point.
31067 warn ratelimit = 100 / 1h / per_rcpt / strict
31068      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
31069                    $sender_rate_limit }s
31070
31071 # Keep authenticated users under control
31072 deny authenticated = *
31073      ratelimit = 100 / 1d / strict / $authenticated_id
31074
31075 # System-wide rate limit
31076 defer message = Sorry, too busy. Try again later.
31077      ratelimit = 10 / 1s / $primary_hostname
31078
31079 # Restrict incoming rate from each host, with a default
31080 # set using a macro and special cases looked up in a table.
31081 defer message = Sender rate exceeds $sender_rate_limit \
31082                messages per $sender_rate_period
31083      ratelimit = ${lookup {$sender_host_address} \
31084                    cdb {DB/ratelimits.cdb} \
31085                    {$value} {RATELIMIT} }
31086 .endd
31087 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
31088 especially with the &%per_rcpt%& option, you may suffer from a performance
31089 bottleneck caused by locking on the ratelimit hints database. Apart from
31090 making your ACLs less complicated, you can reduce the problem by using a
31091 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
31092 this means that Exim will lose its hints data after a reboot (including retry
31093 hints, the callout cache, and ratelimit data).
31094
31095
31096
31097 .section "Address verification" "SECTaddressverification"
31098 .cindex "verifying address" "options for"
31099 .cindex "policy control" "address verification"
31100 Several of the &%verify%& conditions described in section
31101 &<<SECTaclconditions>>& cause addresses to be verified. Section
31102 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
31103 The verification conditions can be followed by options that modify the
31104 verification process. The options are separated from the keyword and from each
31105 other by slashes, and some of them contain parameters. For example:
31106 .code
31107 verify = sender/callout
31108 verify = recipient/defer_ok/callout=10s,defer_ok
31109 .endd
31110 The first stage of address verification, which always happens, is to run the
31111 address through the routers, in &"verify mode"&. Routers can detect the
31112 difference between verification and routing for delivery, and their actions can
31113 be varied by a number of generic options such as &%verify%& and &%verify_only%&
31114 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
31115 The available options are as follows:
31116
31117 .ilist
31118 If the &%callout%& option is specified, successful routing to one or more
31119 remote hosts is followed by a &"callout"& to those hosts as an additional
31120 check. Callouts and their sub-options are discussed in the next section.
31121 .next
31122 If there is a defer error while doing verification routing, the ACL
31123 normally returns &"defer"&. However, if you include &%defer_ok%& in the
31124 options, the condition is forced to be true instead. Note that this is a main
31125 verification option as well as a suboption for callouts.
31126 .next
31127 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
31128 discusses the reporting of sender address verification failures.
31129 .next
31130 The &%success_on_redirect%& option causes verification always to succeed
31131 immediately after a successful redirection. By default, if a redirection
31132 generates just one address, that address is also verified. See further
31133 discussion in section &<<SECTredirwhilveri>>&.
31134 .endlist
31135
31136 .cindex "verifying address" "differentiating failures"
31137 .vindex "&$recipient_verify_failure$&"
31138 .vindex "&$sender_verify_failure$&"
31139 .vindex "&$acl_verify_message$&"
31140 After an address verification failure, &$acl_verify_message$& contains the
31141 error message that is associated with the failure. It can be preserved by
31142 coding like this:
31143 .code
31144 warn  !verify = sender
31145        set acl_m0 = $acl_verify_message
31146 .endd
31147 If you are writing your own custom rejection message or log message when
31148 denying access, you can use this variable to include information about the
31149 verification failure.
31150
31151 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
31152 appropriate) contains one of the following words:
31153
31154 .ilist
31155 &%qualify%&: The address was unqualified (no domain), and the message
31156 was neither local nor came from an exempted host.
31157 .next
31158 &%route%&: Routing failed.
31159 .next
31160 &%mail%&: Routing succeeded, and a callout was attempted; rejection
31161 occurred at or before the MAIL command (that is, on initial
31162 connection, HELO, or MAIL).
31163 .next
31164 &%recipient%&: The RCPT command in a callout was rejected.
31165 .next
31166 &%postmaster%&: The postmaster check in a callout was rejected.
31167 .endlist
31168
31169 The main use of these variables is expected to be to distinguish between
31170 rejections of MAIL and rejections of RCPT in callouts.
31171
31172
31173
31174
31175 .section "Callout verification" "SECTcallver"
31176 .cindex "verifying address" "by callout"
31177 .cindex "callout" "verification"
31178 .cindex "SMTP" "callout verification"
31179 For non-local addresses, routing verifies the domain, but is unable to do any
31180 checking of the local part. There are situations where some means of verifying
31181 the local part is desirable. One way this can be done is to make an SMTP
31182 &'callback'& to a delivery host for the sender address or a &'callforward'& to
31183 a subsequent host for a recipient address, to see if the host accepts the
31184 address. We use the term &'callout'& to cover both cases. Note that for a
31185 sender address, the callback is not to the client host that is trying to
31186 deliver the message, but to one of the hosts that accepts incoming mail for the
31187 sender's domain.
31188
31189 Exim does not do callouts by default. If you want them to happen, you must
31190 request them by setting appropriate options on the &%verify%& condition, as
31191 described below. This facility should be used with care, because it can add a
31192 lot of resource usage to the cost of verifying an address. However, Exim does
31193 cache the results of callouts, which helps to reduce the cost. Details of
31194 caching are in section &<<SECTcallvercache>>&.
31195
31196 Recipient callouts are usually used only between hosts that are controlled by
31197 the same administration. For example, a corporate gateway host could use
31198 callouts to check for valid recipients on an internal mailserver. A successful
31199 callout does not guarantee that a real delivery to the address would succeed;
31200 on the other hand, a failing callout does guarantee that a delivery would fail.
31201
31202 If the &%callout%& option is present on a condition that verifies an address, a
31203 second stage of verification occurs if the address is successfully routed to
31204 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
31205 &(manualroute)& router, where the router specifies the hosts. However, if a
31206 router that does not set up hosts routes to an &(smtp)& transport with a
31207 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
31208 &%hosts_override%& set, its hosts are always used, whether or not the router
31209 supplies a host list.
31210 Callouts are only supported on &(smtp)& transports.
31211
31212 The port that is used is taken from the transport, if it is specified and is a
31213 remote transport. (For routers that do verification only, no transport need be
31214 specified.) Otherwise, the default SMTP port is used. If a remote transport
31215 specifies an outgoing interface, this is used; otherwise the interface is not
31216 specified. Likewise, the text that is used for the HELO command is taken from
31217 the transport's &%helo_data%& option; if there is no transport, the value of
31218 &$smtp_active_hostname$& is used.
31219
31220 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
31221 test whether a bounce message could be delivered to the sender address. The
31222 following SMTP commands are sent:
31223 .display
31224 &`HELO `&<&'local host name'&>
31225 &`MAIL FROM:<>`&
31226 &`RCPT TO:`&<&'the address to be tested'&>
31227 &`QUIT`&
31228 .endd
31229 LHLO is used instead of HELO if the transport's &%protocol%& option is
31230 set to &"lmtp"&.
31231
31232 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
31233 settings.
31234
31235 A recipient callout check is similar. By default, it also uses an empty address
31236 for the sender. This default is chosen because most hosts do not make use of
31237 the sender address when verifying a recipient. Using the same address means
31238 that a single cache entry can be used for each recipient. Some sites, however,
31239 do make use of the sender address when verifying. These are catered for by the
31240 &%use_sender%& and &%use_postmaster%& options, described in the next section.
31241
31242 If the response to the RCPT command is a 2&'xx'& code, the verification
31243 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
31244 Exim tries the next host, if any. If there is a problem with all the remote
31245 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
31246 &%callout%& option is given, in which case the condition is forced to succeed.
31247
31248 .cindex "SMTP" "output flushing, disabling for callout"
31249 A callout may take a little time. For this reason, Exim normally flushes SMTP
31250 output before performing a callout in an ACL, to avoid unexpected timeouts in
31251 clients when the SMTP PIPELINING extension is in use. The flushing can be
31252 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
31253
31254
31255
31256
31257 .section "Additional parameters for callouts" "CALLaddparcall"
31258 .cindex "callout" "additional parameters for"
31259 The &%callout%& option can be followed by an equals sign and a number of
31260 optional parameters, separated by commas. For example:
31261 .code
31262 verify = recipient/callout=10s,defer_ok
31263 .endd
31264 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
31265 separate verify options, is retained for backwards compatibility, but is now
31266 deprecated. The additional parameters for &%callout%& are as follows:
31267
31268
31269 .vlist
31270 .vitem <&'a&~time&~interval'&>
31271 .cindex "callout" "timeout, specifying"
31272 This specifies the timeout that applies for the callout attempt to each host.
31273 For example:
31274 .code
31275 verify = sender/callout=5s
31276 .endd
31277 The default is 30 seconds. The timeout is used for each response from the
31278 remote host. It is also used for the initial connection, unless overridden by
31279 the &%connect%& parameter.
31280
31281
31282 .vitem &*connect&~=&~*&<&'time&~interval'&>
31283 .cindex "callout" "connection timeout, specifying"
31284 This parameter makes it possible to set a different (usually smaller) timeout
31285 for making the SMTP connection. For example:
31286 .code
31287 verify = sender/callout=5s,connect=1s
31288 .endd
31289 If not specified, this timeout defaults to the general timeout value.
31290
31291 .vitem &*defer_ok*&
31292 .cindex "callout" "defer, action on"
31293 When this parameter is present, failure to contact any host, or any other kind
31294 of temporary error, is treated as success by the ACL. However, the cache is not
31295 updated in this circumstance.
31296
31297 .vitem &*fullpostmaster*&
31298 .cindex "callout" "full postmaster check"
31299 This operates like the &%postmaster%& option (see below), but if the check for
31300 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
31301 accordance with the specification in RFC 2821. The RFC states that the
31302 unqualified address &'postmaster'& should be accepted.
31303
31304
31305 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
31306 .cindex "callout" "sender when verifying header"
31307 When verifying addresses in header lines using the &%header_sender%&
31308 verification option, Exim behaves by default as if the addresses are envelope
31309 sender addresses from a message. Callout verification therefore tests to see
31310 whether a bounce message could be delivered, by using an empty address in the
31311 MAIL command. However, it is arguable that these addresses might never be used
31312 as envelope senders, and could therefore justifiably reject bounce messages
31313 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
31314 address to use in the MAIL command. For example:
31315 .code
31316 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
31317 .endd
31318 This parameter is available only for the &%header_sender%& verification option.
31319
31320
31321 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
31322 .cindex "callout" "overall timeout, specifying"
31323 This parameter sets an overall timeout for performing a callout verification.
31324 For example:
31325 .code
31326 verify = sender/callout=5s,maxwait=30s
31327 .endd
31328 This timeout defaults to four times the callout timeout for individual SMTP
31329 commands. The overall timeout applies when there is more than one host that can
31330 be tried. The timeout is checked before trying the next host. This prevents
31331 very long delays if there are a large number of hosts and all are timing out
31332 (for example, when network connections are timing out).
31333
31334
31335 .vitem &*no_cache*&
31336 .cindex "callout" "cache, suppressing"
31337 .cindex "caching callout, suppressing"
31338 When this parameter is given, the callout cache is neither read nor updated.
31339
31340 .vitem &*postmaster*&
31341 .cindex "callout" "postmaster; checking"
31342 When this parameter is set, a successful callout check is followed by a similar
31343 check for the local part &'postmaster'& at the same domain. If this address is
31344 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
31345 the postmaster check is recorded in a cache record; if it is a failure, this is
31346 used to fail subsequent callouts for the domain without a connection being
31347 made, until the cache record expires.
31348
31349 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
31350 The postmaster check uses an empty sender in the MAIL command by default.
31351 You can use this parameter to do a postmaster check using a different address.
31352 For example:
31353 .code
31354 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
31355 .endd
31356 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
31357 one overrides. The &%postmaster%& parameter is equivalent to this example:
31358 .code
31359 require  verify = sender/callout=postmaster_mailfrom=
31360 .endd
31361 &*Warning*&: The caching arrangements for postmaster checking do not take
31362 account of the sender address. It is assumed that either the empty address or
31363 a fixed non-empty address will be used. All that Exim remembers is that the
31364 postmaster check for the domain succeeded or failed.
31365
31366
31367 .vitem &*random*&
31368 .cindex "callout" "&""random""& check"
31369 When this parameter is set, before doing the normal callout check, Exim does a
31370 check for a &"random"& local part at the same domain. The local part is not
31371 really random &-- it is defined by the expansion of the option
31372 &%callout_random_local_part%&, which defaults to
31373 .code
31374 $primary_hostname-$tod_epoch-testing
31375 .endd
31376 The idea here is to try to determine whether the remote host accepts all local
31377 parts without checking. If it does, there is no point in doing callouts for
31378 specific local parts. If the &"random"& check succeeds, the result is saved in
31379 a cache record, and used to force the current and subsequent callout checks to
31380 succeed without a connection being made, until the cache record expires.
31381
31382 .vitem &*use_postmaster*&
31383 .cindex "callout" "sender for recipient check"
31384 This parameter applies to recipient callouts only. For example:
31385 .code
31386 deny  !verify = recipient/callout=use_postmaster
31387 .endd
31388 .vindex "&$qualify_domain$&"
31389 It causes a non-empty postmaster address to be used in the MAIL command when
31390 performing the callout for the recipient, and also for a &"random"& check if
31391 that is configured. The local part of the address is &`postmaster`& and the
31392 domain is the contents of &$qualify_domain$&.
31393
31394 .vitem &*use_sender*&
31395 This option applies to recipient callouts only. For example:
31396 .code
31397 require  verify = recipient/callout=use_sender
31398 .endd
31399 It causes the message's actual sender address to be used in the MAIL
31400 command when performing the callout, instead of an empty address. There is no
31401 need to use this option unless you know that the called hosts make use of the
31402 sender when checking recipients. If used indiscriminately, it reduces the
31403 usefulness of callout caching.
31404
31405 .vitem &*hold*&
31406 This option applies to recipient callouts only. For example:
31407 .code
31408 require  verify = recipient/callout=use_sender,hold
31409 .endd
31410 It causes the connection to be held open and used for any further recipients
31411 and for eventual delivery (should that be done quickly).
31412 Doing this saves on TCP and SMTP startup costs, and TLS costs also
31413 when that is used for the connections.
31414 The advantage is only gained if there are no callout cache hits
31415 (which could be enforced by the no_cache option),
31416 if the use_sender option is used,
31417 if neither the random nor the use_postmaster option is used,
31418 and if no other callouts intervene.
31419 .endlist
31420
31421 If you use any of the parameters that set a non-empty sender for the MAIL
31422 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
31423 &%use_sender%&), you should think about possible loops. Recipient checking is
31424 usually done between two hosts that are under the same management, and the host
31425 that receives the callouts is not normally configured to do callouts itself.
31426 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
31427 these circumstances.
31428
31429 However, if you use a non-empty sender address for a callout to an arbitrary
31430 host, there is the likelihood that the remote host will itself initiate a
31431 callout check back to your host. As it is checking what appears to be a message
31432 sender, it is likely to use an empty address in MAIL, thus avoiding a
31433 callout loop. However, to be on the safe side it would be best to set up your
31434 own ACLs so that they do not do sender verification checks when the recipient
31435 is the address you use for header sender or postmaster callout checking.
31436
31437 Another issue to think about when using non-empty senders for callouts is
31438 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
31439 by the sender/recipient combination; thus, for any given recipient, many more
31440 actual callouts are performed than when an empty sender or postmaster is used.
31441
31442
31443
31444
31445 .section "Callout caching" "SECTcallvercache"
31446 .cindex "hints database" "callout cache"
31447 .cindex "callout" "cache, description of"
31448 .cindex "caching" "callout"
31449 Exim caches the results of callouts in order to reduce the amount of resources
31450 used, unless you specify the &%no_cache%& parameter with the &%callout%&
31451 option. A hints database called &"callout"& is used for the cache. Two
31452 different record types are used: one records the result of a callout check for
31453 a specific address, and the other records information that applies to the
31454 entire domain (for example, that it accepts the local part &'postmaster'&).
31455
31456 When an original callout fails, a detailed SMTP error message is given about
31457 the failure. However, for subsequent failures use the cache data, this message
31458 is not available.
31459
31460 The expiry times for negative and positive address cache records are
31461 independent, and can be set by the global options &%callout_negative_expire%&
31462 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
31463
31464 If a host gives a negative response to an SMTP connection, or rejects any
31465 commands up to and including
31466 .code
31467 MAIL FROM:<>
31468 .endd
31469 (but not including the MAIL command with a non-empty address),
31470 any callout attempt is bound to fail. Exim remembers such failures in a
31471 domain cache record, which it uses to fail callouts for the domain without
31472 making new connections, until the domain record times out. There are two
31473 separate expiry times for domain cache records:
31474 &%callout_domain_negative_expire%& (default 3h) and
31475 &%callout_domain_positive_expire%& (default 7d).
31476
31477 Domain records expire when the negative expiry time is reached if callouts
31478 cannot be made for the domain, or if the postmaster check failed.
31479 Otherwise, they expire when the positive expiry time is reached. This
31480 ensures that, for example, a host that stops accepting &"random"& local parts
31481 will eventually be noticed.
31482
31483 The callout caching mechanism is based on the domain of the address that is
31484 being tested. If the domain routes to several hosts, it is assumed that their
31485 behaviour will be the same.
31486
31487
31488
31489 .section "Sender address verification reporting" "SECTsenaddver"
31490 .cindex "verifying" "suppressing error details"
31491 See section &<<SECTaddressverification>>& for a general discussion of
31492 verification. When sender verification fails in an ACL, the details of the
31493 failure are given as additional output lines before the 550 response to the
31494 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
31495 you might see:
31496 .code
31497 MAIL FROM:<xyz@abc.example>
31498 250 OK
31499 RCPT TO:<pqr@def.example>
31500 550-Verification failed for <xyz@abc.example>
31501 550-Called:   192.168.34.43
31502 550-Sent:     RCPT TO:<xyz@abc.example>
31503 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
31504 550 Sender verification failed
31505 .endd
31506 If more than one RCPT command fails in the same way, the details are given
31507 only for the first of them. However, some administrators do not want to send
31508 out this much information. You can suppress the details by adding
31509 &`/no_details`& to the ACL statement that requests sender verification. For
31510 example:
31511 .code
31512 verify = sender/no_details
31513 .endd
31514
31515 .section "Redirection while verifying" "SECTredirwhilveri"
31516 .cindex "verifying" "redirection while"
31517 .cindex "address redirection" "while verifying"
31518 A dilemma arises when a local address is redirected by aliasing or forwarding
31519 during verification: should the generated addresses themselves be verified,
31520 or should the successful expansion of the original address be enough to verify
31521 it? By default, Exim takes the following pragmatic approach:
31522
31523 .ilist
31524 When an incoming address is redirected to just one child address, verification
31525 continues with the child address, and if that fails to verify, the original
31526 verification also fails.
31527 .next
31528 When an incoming address is redirected to more than one child address,
31529 verification does not continue. A success result is returned.
31530 .endlist
31531
31532 This seems the most reasonable behaviour for the common use of aliasing as a
31533 way of redirecting different local parts to the same mailbox. It means, for
31534 example, that a pair of alias entries of the form
31535 .code
31536 A.Wol:   aw123
31537 aw123:   :fail: Gone away, no forwarding address
31538 .endd
31539 work as expected, with both local parts causing verification failure. When a
31540 redirection generates more than one address, the behaviour is more like a
31541 mailing list, where the existence of the alias itself is sufficient for
31542 verification to succeed.
31543
31544 It is possible, however, to change the default behaviour so that all successful
31545 redirections count as successful verifications, however many new addresses are
31546 generated. This is specified by the &%success_on_redirect%& verification
31547 option. For example:
31548 .code
31549 require verify = recipient/success_on_redirect/callout=10s
31550 .endd
31551 In this example, verification succeeds if a router generates a new address, and
31552 the callout does not occur, because no address was routed to a remote host.
31553
31554 When verification is being tested via the &%-bv%& option, the treatment of
31555 redirections is as just described, unless the &%-v%& or any debugging option is
31556 also specified. In that case, full verification is done for every generated
31557 address and a report is output for each of them.
31558
31559
31560
31561 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
31562 .cindex "CSA" "verifying"
31563 Client SMTP Authorization is a system that allows a site to advertise
31564 which machines are and are not permitted to send email. This is done by placing
31565 special SRV records in the DNS; these are looked up using the client's HELO
31566 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
31567 Authorization checks in Exim are performed by the ACL condition:
31568 .code
31569 verify = csa
31570 .endd
31571 This fails if the client is not authorized. If there is a DNS problem, or if no
31572 valid CSA SRV record is found, or if the client is authorized, the condition
31573 succeeds. These three cases can be distinguished using the expansion variable
31574 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
31575 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
31576 be likely to cause problems for legitimate email.
31577
31578 The error messages produced by the CSA code include slightly more
31579 detail. If &$csa_status$& is &"defer"&, this may be because of problems
31580 looking up the CSA SRV record, or problems looking up the CSA target
31581 address record. There are four reasons for &$csa_status$& being &"fail"&:
31582
31583 .ilist
31584 The client's host name is explicitly not authorized.
31585 .next
31586 The client's IP address does not match any of the CSA target IP addresses.
31587 .next
31588 The client's host name is authorized but it has no valid target IP addresses
31589 (for example, the target's addresses are IPv6 and the client is using IPv4).
31590 .next
31591 The client's host name has no CSA SRV record but a parent domain has asserted
31592 that all subdomains must be explicitly authorized.
31593 .endlist
31594
31595 The &%csa%& verification condition can take an argument which is the domain to
31596 use for the DNS query. The default is:
31597 .code
31598 verify = csa/$sender_helo_name
31599 .endd
31600 This implementation includes an extension to CSA. If the query domain
31601 is an address literal such as [192.0.2.95], or if it is a bare IP
31602 address, Exim searches for CSA SRV records in the reverse DNS as if
31603 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
31604 meaningful to say:
31605 .code
31606 verify = csa/$sender_host_address
31607 .endd
31608 In fact, this is the check that Exim performs if the client does not say HELO.
31609 This extension can be turned off by setting the main configuration option
31610 &%dns_csa_use_reverse%& to be false.
31611
31612 If a CSA SRV record is not found for the domain itself, a search
31613 is performed through its parent domains for a record which might be
31614 making assertions about subdomains. The maximum depth of this search is limited
31615 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
31616 default. Exim does not look for CSA SRV records in a top level domain, so the
31617 default settings handle HELO domains as long as seven
31618 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
31619 of legitimate HELO domains.
31620
31621 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
31622 direct SRV lookups, this is not sufficient because of the extra parent domain
31623 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
31624 addresses into lookups in the reverse DNS space. The result of a successful
31625 lookup such as:
31626 .code
31627 ${lookup dnsdb {csa=$sender_helo_name}}
31628 .endd
31629 has two space-separated fields: an authorization code and a target host name.
31630 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
31631 authorization required but absent, or &"?"& for unknown.
31632
31633
31634
31635
31636 .section "Bounce address tag validation" "SECTverifyPRVS"
31637 .cindex "BATV, verifying"
31638 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
31639 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
31640 Genuine incoming bounce messages should therefore always be addressed to
31641 recipients that have a valid tag. This scheme is a way of detecting unwanted
31642 bounce messages caused by sender address forgeries (often called &"collateral
31643 spam"&), because the recipients of such messages do not include valid tags.
31644
31645 There are two expansion items to help with the implementation of the BATV
31646 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
31647 the original envelope sender address by using a simple key to add a hash of the
31648 address and some time-based randomizing information. The &%prvs%& expansion
31649 item creates a signed address, and the &%prvscheck%& expansion item checks one.
31650 The syntax of these expansion items is described in section
31651 &<<SECTexpansionitems>>&.
31652 The validity period on signed addresses is seven days.
31653
31654 As an example, suppose the secret per-address keys are stored in an MySQL
31655 database. A query to look up the key for an address could be defined as a macro
31656 like this:
31657 .code
31658 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
31659                 WHERE sender='${quote_mysql:$prvscheck_address}'\
31660                 }{$value}}
31661 .endd
31662 Suppose also that the senders who make use of BATV are defined by an address
31663 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
31664 use this:
31665 .code
31666 # Bounces: drop unsigned addresses for BATV senders
31667 deny message = This address does not send an unsigned reverse path
31668      senders = :
31669      recipients = +batv_senders
31670
31671 # Bounces: In case of prvs-signed address, check signature.
31672 deny message = Invalid reverse path signature.
31673      senders = :
31674      condition  = ${prvscheck {$local_part@$domain}\
31675                   {PRVSCHECK_SQL}{1}}
31676      !condition = $prvscheck_result
31677 .endd
31678 The first statement rejects recipients for bounce messages that are addressed
31679 to plain BATV sender addresses, because it is known that BATV senders do not
31680 send out messages with plain sender addresses. The second statement rejects
31681 recipients that are prvs-signed, but with invalid signatures (either because
31682 the key is wrong, or the signature has timed out).
31683
31684 A non-prvs-signed address is not rejected by the second statement, because the
31685 &%prvscheck%& expansion yields an empty string if its first argument is not a
31686 prvs-signed address, thus causing the &%condition%& condition to be false. If
31687 the first argument is a syntactically valid prvs-signed address, the yield is
31688 the third string (in this case &"1"&), whether or not the cryptographic and
31689 timeout checks succeed. The &$prvscheck_result$& variable contains the result
31690 of the checks (empty for failure, &"1"& for success).
31691
31692 There is one more issue you must consider when implementing prvs-signing:
31693 you have to ensure that the routers accept prvs-signed addresses and
31694 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
31695 router to remove the signature with a configuration along these lines:
31696 .code
31697 batv_redirect:
31698   driver = redirect
31699   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
31700 .endd
31701 This works because, if the third argument of &%prvscheck%& is empty, the result
31702 of the expansion of a prvs-signed address is the decoded value of the original
31703 address. This router should probably be the first of your routers that handles
31704 local addresses.
31705
31706 To create BATV-signed addresses in the first place, a transport of this form
31707 can be used:
31708 .code
31709 external_smtp_batv:
31710   driver = smtp
31711   return_path = ${prvs {$return_path} \
31712                        {${lookup mysql{SELECT \
31713                        secret FROM batv_prvs WHERE \
31714                        sender='${quote_mysql:$sender_address}'} \
31715                        {$value}fail}}}
31716 .endd
31717 If no key can be found for the existing return path, no signing takes place.
31718
31719
31720
31721 .section "Using an ACL to control relaying" "SECTrelaycontrol"
31722 .cindex "&ACL;" "relay control"
31723 .cindex "relaying" "control by ACL"
31724 .cindex "policy control" "relay control"
31725 An MTA is said to &'relay'& a message if it receives it from some host and
31726 delivers it directly to another host as a result of a remote address contained
31727 within it. Redirecting a local address via an alias or forward file and then
31728 passing the message on to another host is not relaying,
31729 .cindex "&""percent hack""&"
31730 but a redirection as a result of the &"percent hack"& is.
31731
31732 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
31733 A host which is acting as a gateway or an MX backup is concerned with incoming
31734 relaying from arbitrary hosts to a specific set of domains. On the other hand,
31735 a host which is acting as a smart host for a number of clients is concerned
31736 with outgoing relaying from those clients to the Internet at large. Often the
31737 same host is fulfilling both functions,
31738 . ///
31739 . as illustrated in the diagram below,
31740 . ///
31741 but in principle these two kinds of relaying are entirely independent. What is
31742 not wanted is the transmission of mail from arbitrary remote hosts through your
31743 system to arbitrary domains.
31744
31745
31746 You can implement relay control by means of suitable statements in the ACL that
31747 runs for each RCPT command. For convenience, it is often easiest to use
31748 Exim's named list facility to define the domains and hosts involved. For
31749 example, suppose you want to do the following:
31750
31751 .ilist
31752 Deliver a number of domains to mailboxes on the local host (or process them
31753 locally in some other way). Let's say these are &'my.dom1.example'& and
31754 &'my.dom2.example'&.
31755 .next
31756 Relay mail for a number of other domains for which you are the secondary MX.
31757 These might be &'friend1.example'& and &'friend2.example'&.
31758 .next
31759 Relay mail from the hosts on your local LAN, to whatever domains are involved.
31760 Suppose your LAN is 192.168.45.0/24.
31761 .endlist
31762
31763
31764 In the main part of the configuration, you put the following definitions:
31765 .code
31766 domainlist local_domains    = my.dom1.example : my.dom2.example
31767 domainlist relay_to_domains = friend1.example : friend2.example
31768 hostlist   relay_from_hosts = 192.168.45.0/24
31769 .endd
31770 Now you can use these definitions in the ACL that is run for every RCPT
31771 command:
31772 .code
31773 acl_check_rcpt:
31774   accept domains = +local_domains : +relay_to_domains
31775   accept hosts   = +relay_from_hosts
31776 .endd
31777 The first statement accepts any RCPT command that contains an address in
31778 the local or relay domains. For any other domain, control passes to the second
31779 statement, which accepts the command only if it comes from one of the relay
31780 hosts. In practice, you will probably want to make your ACL more sophisticated
31781 than this, for example, by including sender and recipient verification. The
31782 default configuration includes a more comprehensive example, which is described
31783 in chapter &<<CHAPdefconfil>>&.
31784
31785
31786
31787 .section "Checking a relay configuration" "SECTcheralcon"
31788 .cindex "relaying" "checking control of"
31789 You can check the relay characteristics of your configuration in the same way
31790 that you can test any ACL behaviour for an incoming SMTP connection, by using
31791 the &%-bh%& option to run a fake SMTP session with which you interact.
31792 .ecindex IIDacl
31793
31794
31795
31796 . ////////////////////////////////////////////////////////////////////////////
31797 . ////////////////////////////////////////////////////////////////////////////
31798
31799 .chapter "Content scanning at ACL time" "CHAPexiscan"
31800 .scindex IIDcosca "content scanning" "at ACL time"
31801 The extension of Exim to include content scanning at ACL time, formerly known
31802 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
31803 was integrated into the main source for Exim release 4.50, and Tom continues to
31804 maintain it. Most of the wording of this chapter is taken from Tom's
31805 specification.
31806
31807 It is also possible to scan the content of messages at other times. The
31808 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
31809 scanning after all the ACLs have run. A transport filter can be used to scan
31810 messages at delivery time (see the &%transport_filter%& option, described in
31811 chapter &<<CHAPtransportgeneric>>&).
31812
31813 If you want to include the ACL-time content-scanning features when you compile
31814 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
31815 &_Local/Makefile_&. When you do that, the Exim binary is built with:
31816
31817 .ilist
31818 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
31819 for all MIME parts for SMTP and non-SMTP messages, respectively.
31820 .next
31821 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
31822 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
31823 run at the end of message reception (the &%acl_smtp_data%& ACL).
31824 .next
31825 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
31826 of messages, or parts of messages, for debugging purposes.
31827 .next
31828 Additional expansion variables that are set in the new ACL and by the new
31829 conditions.
31830 .next
31831 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
31832 .endlist
31833
31834 Content-scanning is continually evolving, and new features are still being
31835 added. While such features are still unstable and liable to incompatible
31836 changes, they are made available in Exim by setting options whose names begin
31837 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
31838 this manual. You can find out about them by reading the file called
31839 &_doc/experimental.txt_&.
31840
31841 All the content-scanning facilities work on a MBOX copy of the message that is
31842 temporarily created in a file called:
31843 .display
31844 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
31845 .endd
31846 The &_.eml_& extension is a friendly hint to virus scanners that they can
31847 expect an MBOX-like structure inside that file. The file is created when the
31848 first content scanning facility is called. Subsequent calls to content
31849 scanning conditions open the same file again. The directory is recursively
31850 removed when the &%acl_smtp_data%& ACL has finished running, unless
31851 .code
31852 control = no_mbox_unspool
31853 .endd
31854 has been encountered. When the MIME ACL decodes files, they are put into the
31855 same directory by default.
31856
31857
31858
31859 .section "Scanning for viruses" "SECTscanvirus"
31860 .cindex "virus scanning"
31861 .cindex "content scanning" "for viruses"
31862 .cindex "content scanning" "the &%malware%& condition"
31863 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
31864 It supports a &"generic"& interface to scanners called via the shell, and
31865 specialized interfaces for &"daemon"& type virus scanners, which are resident
31866 in memory and thus are much faster.
31867
31868 A timeout of 2 minutes is applied to a scanner call (by default);
31869 if it expires then a defer action is taken.
31870
31871 .oindex "&%av_scanner%&"
31872 You can set the &%av_scanner%& option in the main part of the configuration
31873 to specify which scanner to use, together with any additional options that
31874 are needed. The basic syntax is as follows:
31875 .display
31876 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
31877 .endd
31878 If you do not set &%av_scanner%&, it defaults to
31879 .code
31880 av_scanner = sophie:/var/run/sophie
31881 .endd
31882 If the value of &%av_scanner%& starts with a dollar character, it is expanded
31883 before use.
31884 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
31885 The following scanner types are supported in this release,
31886 though individual ones can be included or not at build time:
31887
31888 .vlist
31889 .vitem &%avast%&
31890 .cindex "virus scanners" "avast"
31891 This is the scanner daemon of Avast. It has been tested with Avast Core
31892 Security (currently at version 2.2.0).
31893 You can get a trial version at &url(https://www.avast.com) or for Linux
31894 at &url(https://www.avast.com/linux-server-antivirus).
31895 This scanner type takes one option,
31896 which can be either a full path to a UNIX socket,
31897 or host and port specifiers separated by white space.
31898 The host may be a name or an IP address; the port is either a
31899 single number or a pair of numbers with a dash between.
31900 A list of options may follow. These options are interpreted on the
31901 Exim's side of the malware scanner, or are given on separate lines to
31902 the daemon as options before the main scan command.
31903
31904 .new
31905 .cindex &`pass_unscanned`& "avast"
31906 If &`pass_unscanned`&
31907 is set, any files the Avast scanner can't scan (e.g.
31908 decompression bombs, or invalid archives) are considered clean. Use with
31909 care.
31910 .wen
31911
31912 For example:
31913 .code
31914 av_scanner = avast:/var/run/avast/scan.sock:FLAGS -fullfiles:SENSITIVITY -pup
31915 av_scanner = avast:/var/run/avast/scan.sock:pass_unscanned:FLAGS -fullfiles:SENSITIVITY -pup
31916 av_scanner = avast:192.168.2.22 5036
31917 .endd
31918 If you omit the argument, the default path
31919 &_/var/run/avast/scan.sock_&
31920 is used.
31921 If you use a remote host,
31922 you need to make Exim's spool directory available to it,
31923 as the scanner is passed a file path, not file contents.
31924 For information about available commands and their options you may use
31925 .code
31926 $ socat UNIX:/var/run/avast/scan.sock STDIO:
31927     FLAGS
31928     SENSITIVITY
31929     PACK
31930 .endd
31931
31932 If the scanner returns a temporary failure (e.g. license issues, or
31933 permission problems), the message is deferred and a paniclog entry is
31934 written.  The usual &`defer_ok`& option is available.
31935
31936 .vitem &%aveserver%&
31937 .cindex "virus scanners" "Kaspersky"
31938 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
31939 at &url(http://www.kaspersky.com). This scanner type takes one option,
31940 which is the path to the daemon's UNIX socket. The default is shown in this
31941 example:
31942 .code
31943 av_scanner = aveserver:/var/run/aveserver
31944 .endd
31945
31946
31947 .vitem &%clamd%&
31948 .cindex "virus scanners" "clamd"
31949 This daemon-type scanner is GPL and free. You can get it at
31950 &url(http://www.clamav.net/). Some older versions of clamd do not seem to
31951 unpack MIME containers, so it used to be recommended to unpack MIME attachments
31952 in the MIME ACL. This is no longer believed to be necessary.
31953
31954 The options are a list of server specifiers, which may be
31955 a UNIX socket specification,
31956 a TCP socket specification,
31957 or a (global) option.
31958
31959 A socket specification consists of a space-separated list.
31960 For a Unix socket the first element is a full path for the socket,
31961 for a TCP socket the first element is the IP address
31962 and the second a port number,
31963 Any further elements are per-server (non-global) options.
31964 These per-server options are supported:
31965 .code
31966 retry=<timespec>        Retry on connect fail
31967 .endd
31968
31969 The &`retry`& option specifies a time after which a single retry for
31970 a failed connect is made.  The default is to not retry.
31971
31972 If a Unix socket file is specified, only one server is supported.
31973
31974 Examples:
31975 .code
31976 av_scanner = clamd:/opt/clamd/socket
31977 av_scanner = clamd:192.0.2.3 1234
31978 av_scanner = clamd:192.0.2.3 1234:local
31979 av_scanner = clamd:192.0.2.3 1234 retry=10s
31980 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
31981 .endd
31982 If the value of av_scanner points to a UNIX socket file or contains the
31983 &`local`&
31984 option, then the ClamAV interface will pass a filename containing the data
31985 to be scanned, which should normally result in less I/O happening and be
31986 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
31987 Exim does not assume that there is a common filesystem with the remote host.
31988
31989 The final example shows that multiple TCP targets can be specified.  Exim will
31990 randomly use one for each incoming email (i.e. it load balances them).  Note
31991 that only TCP targets may be used if specifying a list of scanners; a UNIX
31992 socket cannot be mixed in with TCP targets.  If one of the servers becomes
31993 unavailable, Exim will try the remaining one(s) until it finds one that works.
31994 When a clamd server becomes unreachable, Exim will log a message.  Exim does
31995 not keep track of scanner state between multiple messages, and the scanner
31996 selection is random, so the message will get logged in the mainlog for each
31997 email that the down scanner gets chosen first (message wrapped to be readable):
31998 .code
31999 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
32000    clamd: connection to localhost, port 3310 failed
32001    (Connection refused)
32002 .endd
32003
32004 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
32005 contributing the code for this scanner.
32006
32007 .vitem &%cmdline%&
32008 .cindex "virus scanners" "command line interface"
32009 This is the keyword for the generic command line scanner interface. It can be
32010 used to attach virus scanners that are invoked from the shell. This scanner
32011 type takes 3 mandatory options:
32012
32013 .olist
32014 The full path and name of the scanner binary, with all command line options,
32015 and a placeholder (&`%s`&) for the directory to scan.
32016
32017 .next
32018 A regular expression to match against the STDOUT and STDERR output of the
32019 virus scanner. If the expression matches, a virus was found. You must make
32020 absolutely sure that this expression matches on &"virus found"&. This is called
32021 the &"trigger"& expression.
32022
32023 .next
32024 Another regular expression, containing exactly one pair of parentheses, to
32025 match the name of the virus found in the scanners output. This is called the
32026 &"name"& expression.
32027 .endlist olist
32028
32029 For example, Sophos Sweep reports a virus on a line like this:
32030 .code
32031 Virus 'W32/Magistr-B' found in file ./those.bat
32032 .endd
32033 For the trigger expression, we can match the phrase &"found in file"&. For the
32034 name expression, we want to extract the W32/Magistr-B string, so we can match
32035 for the single quotes left and right of it. Altogether, this makes the
32036 configuration setting:
32037 .code
32038 av_scanner = cmdline:\
32039              /path/to/sweep -ss -all -rec -archive %s:\
32040              found in file:'(.+)'
32041 .endd
32042 .vitem &%drweb%&
32043 .cindex "virus scanners" "DrWeb"
32044 The DrWeb daemon scanner (&url(http://www.sald.com/)) interface
32045 takes one option,
32046 either a full path to a UNIX socket,
32047 or host and port specifiers separated by white space.
32048 The host may be a name or an IP address; the port is either a
32049 single number or a pair of numbers with a dash between.
32050 For example:
32051 .code
32052 av_scanner = drweb:/var/run/drwebd.sock
32053 av_scanner = drweb:192.168.2.20 31337
32054 .endd
32055 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
32056 is used. Thanks to Alex Miller for contributing the code for this scanner.
32057
32058 .vitem &%f-protd%&
32059 .cindex "virus scanners" "f-protd"
32060 The f-protd scanner is accessed via HTTP over TCP.
32061 One argument is taken, being a space-separated hostname and port number
32062 (or port-range).
32063 For example:
32064 .code
32065 av_scanner = f-protd:localhost 10200-10204
32066 .endd
32067 If you omit the argument, the default values show above are used.
32068
32069 .vitem &%f-prot6d%&
32070 .cindex "virus scanners" "f-prot6d"
32071 The f-prot6d scanner is accessed using the FPSCAND protocol over TCP.
32072 One argument is taken, being a space-separated hostname and port number.
32073 For example:
32074 .code
32075 av_scanner = f-prot6d:localhost 10200
32076 .endd
32077 If you omit the argument, the default values show above are used.
32078
32079 .vitem &%fsecure%&
32080 .cindex "virus scanners" "F-Secure"
32081 The F-Secure daemon scanner (&url(http://www.f-secure.com)) takes one
32082 argument which is the path to a UNIX socket. For example:
32083 .code
32084 av_scanner = fsecure:/path/to/.fsav
32085 .endd
32086 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
32087 Thelmen for contributing the code for this scanner.
32088
32089 .vitem &%kavdaemon%&
32090 .cindex "virus scanners" "Kaspersky"
32091 This is the scanner daemon of Kaspersky Version 4. This version of the
32092 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
32093 scanner type takes one option, which is the path to the daemon's UNIX socket.
32094 For example:
32095 .code
32096 av_scanner = kavdaemon:/opt/AVP/AvpCtl
32097 .endd
32098 The default path is &_/var/run/AvpCtl_&.
32099
32100 .vitem &%mksd%&
32101 .cindex "virus scanners" "mksd"
32102 This is a daemon type scanner that is aimed mainly at Polish users, though some
32103 parts of documentation are now available in English. You can get it at
32104 &url(http://linux.mks.com.pl/). The only option for this scanner type is
32105 the maximum number of processes used simultaneously to scan the attachments,
32106 provided that mksd has
32107 been run with at least the same number of child processes. For example:
32108 .code
32109 av_scanner = mksd:2
32110 .endd
32111 You can safely omit this option (the default value is 1).
32112
32113 .vitem &%sock%&
32114 .cindex "virus scanners" "simple socket-connected"
32115 This is a general-purpose way of talking to simple scanner daemons
32116 running on the local machine.
32117 There are four options:
32118 an address (which may be an IP address and port, or the path of a Unix socket),
32119 a commandline to send (may include a single %s which will be replaced with
32120 the path to the mail file to be scanned),
32121 an RE to trigger on from the returned data,
32122 and an RE to extract malware_name from the returned data.
32123 For example:
32124 .code
32125 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)$
32126 .endd
32127 Note that surrounding whitespace is stripped from each option, meaning
32128 there is no way to specify a trailing newline.
32129 The socket specifier and both regular-expressions are required.
32130 Default for the commandline is &_%s\n_& (note this does have a trailing newline);
32131 specify an empty element to get this.
32132
32133 .vitem &%sophie%&
32134 .cindex "virus scanners" "Sophos and Sophie"
32135 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
32136 You can get Sophie at &url(http://www.clanfield.info/sophie/). The only option
32137 for this scanner type is the path to the UNIX socket that Sophie uses for
32138 client communication. For example:
32139 .code
32140 av_scanner = sophie:/tmp/sophie
32141 .endd
32142 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
32143 the option.
32144 .endlist
32145
32146 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
32147 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
32148 ACL.
32149
32150 The &%av_scanner%& option is expanded each time &%malware%& is called. This
32151 makes it possible to use different scanners. See further below for an example.
32152 The &%malware%& condition caches its results, so when you use it multiple times
32153 for the same message, the actual scanning process is only carried out once.
32154 However, using expandable items in &%av_scanner%& disables this caching, in
32155 which case each use of the &%malware%& condition causes a new scan of the
32156 message.
32157
32158 The &%malware%& condition takes a right-hand argument that is expanded before
32159 use and taken as a list, slash-separated by default.
32160 The first element can then be one of
32161
32162 .ilist
32163 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
32164 The condition succeeds if a virus was found, and fail otherwise. This is the
32165 recommended usage.
32166 .next
32167 &"false"& or &"0"& or an empty string, in which case no scanning is done and
32168 the condition fails immediately.
32169 .next
32170 A regular expression, in which case the message is scanned for viruses. The
32171 condition succeeds if a virus is found and its name matches the regular
32172 expression. This allows you to take special actions on certain types of virus.
32173 Note that &"/"& characters in the RE must be doubled due to the list-processing,
32174 unless the separator is changed (in the usual way).
32175 .endlist
32176
32177 You can append a &`defer_ok`& element to the &%malware%& argument list to accept
32178 messages even if there is a problem with the virus scanner.
32179 Otherwise, such a problem causes the ACL to defer.
32180
32181 You can append a &`tmo=<val>`& element to the &%malware%& argument list to
32182 specify a non-default timeout.  The default is two minutes.
32183 For example:
32184 .code
32185 malware = * / defer_ok / tmo=10s
32186 .endd
32187 A timeout causes the ACL to defer.
32188
32189 .vindex "&$callout_address$&"
32190 When a connection is made to the scanner the expansion variable &$callout_address$&
32191 is set to record the actual address used.
32192
32193 .vindex "&$malware_name$&"
32194 When a virus is found, the condition sets up an expansion variable called
32195 &$malware_name$& that contains the name of the virus. You can use it in a
32196 &%message%& modifier that specifies the error returned to the sender, and/or in
32197 logging data.
32198
32199 Beware the interaction of Exim's &%message_size_limit%& with any size limits
32200 imposed by your anti-virus scanner.
32201
32202 Here is a very simple scanning example:
32203 .code
32204 deny message = This message contains malware ($malware_name)
32205      malware = *
32206 .endd
32207 The next example accepts messages when there is a problem with the scanner:
32208 .code
32209 deny message = This message contains malware ($malware_name)
32210      malware = */defer_ok
32211 .endd
32212 The next example shows how to use an ACL variable to scan with both sophie and
32213 aveserver. It assumes you have set:
32214 .code
32215 av_scanner = $acl_m0
32216 .endd
32217 in the main Exim configuration.
32218 .code
32219 deny message = This message contains malware ($malware_name)
32220      set acl_m0 = sophie
32221      malware = *
32222
32223 deny message = This message contains malware ($malware_name)
32224      set acl_m0 = aveserver
32225      malware = *
32226 .endd
32227
32228
32229 .section "Scanning with SpamAssassin and Rspamd" "SECTscanspamass"
32230 .cindex "content scanning" "for spam"
32231 .cindex "spam scanning"
32232 .cindex "SpamAssassin"
32233 .cindex "Rspamd"
32234 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
32235 score and a report for the message.
32236 Support is also provided for Rspamd.
32237
32238 For more information about installation and configuration of SpamAssassin or
32239 Rspamd refer to their respective websites at
32240 &url(http://spamassassin.apache.org) and &url(http://www.rspamd.com)
32241
32242 SpamAssassin can be installed with CPAN by running:
32243 .code
32244 perl -MCPAN -e 'install Mail::SpamAssassin'
32245 .endd
32246 SpamAssassin has its own set of configuration files. Please review its
32247 documentation to see how you can tweak it. The default installation should work
32248 nicely, however.
32249
32250 .oindex "&%spamd_address%&"
32251 By default, SpamAssassin listens on 127.0.0.1, TCP port 783 and if you
32252 intend to use an instance running on the local host you do not need to set
32253 &%spamd_address%&. If you intend to use another host or port for SpamAssassin,
32254 you must set the &%spamd_address%& option in the global part of the Exim
32255 configuration as follows (example):
32256 .code
32257 spamd_address = 192.168.99.45 387
32258 .endd
32259 The SpamAssassin protocol relies on a TCP half-close from the client.
32260 If your SpamAssassin client side is running a Linux system with an
32261 iptables firewall, consider setting
32262 &%net.netfilter.nf_conntrack_tcp_timeout_close_wait%& to at least the
32263 timeout, Exim uses when waiting for a response from the SpamAssassin
32264 server (currently defaulting to 120s).  With a lower value the Linux
32265 connection tracking may consider your half-closed connection as dead too
32266 soon.
32267
32268
32269 To use Rspamd (which by default listens on all local addresses
32270 on TCP port 11333)
32271 you should add &%variant=rspamd%& after the address/port pair, for example:
32272 .code
32273 spamd_address = 127.0.0.1 11333 variant=rspamd
32274 .endd
32275
32276 As of version 2.60, &%SpamAssassin%& also supports communication over UNIX
32277 sockets. If you want to us these, supply &%spamd_address%& with an absolute
32278 file name instead of an address/port pair:
32279 .code
32280 spamd_address = /var/run/spamd_socket
32281 .endd
32282 You can have multiple &%spamd%& servers to improve scalability. These can
32283 reside on other hardware reachable over the network. To specify multiple
32284 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
32285 option, separated with colons (the separator can be changed in the usual way):
32286 .code
32287 spamd_address = 192.168.2.10 783 : \
32288                 192.168.2.11 783 : \
32289                 192.168.2.12 783
32290 .endd
32291 Up to 32 &%spamd%& servers are supported.
32292 When a server fails to respond to the connection attempt, all other
32293 servers are tried until one succeeds. If no server responds, the &%spam%&
32294 condition defers.
32295
32296 Unix and TCP socket specifications may be mixed in any order.
32297 Each element of the list is a list itself, space-separated by default
32298 and changeable in the usual way; take care to not double the separator.
32299
32300 For TCP socket specifications a host name or IP (v4 or v6, but
32301 subject to list-separator quoting rules) address can be used,
32302 and the port can be one or a dash-separated pair.
32303 In the latter case, the range is tried in strict order.
32304
32305 Elements after the first for Unix sockets, or second for TCP socket,
32306 are options.
32307 The supported options are:
32308 .code
32309 pri=<priority>      Selection priority
32310 weight=<value>      Selection bias
32311 time=<start>-<end>  Use only between these times of day
32312 retry=<timespec>    Retry on connect fail
32313 tmo=<timespec>      Connection time limit
32314 variant=rspamd      Use Rspamd rather than SpamAssassin protocol
32315 .endd
32316
32317 The &`pri`& option specifies a priority for the server within the list,
32318 higher values being tried first.
32319 The default priority is 1.
32320
32321 The &`weight`& option specifies a selection bias.
32322 Within a priority set
32323 servers are queried in a random fashion, weighted by this value.
32324 The default value for selection bias is 1.
32325
32326 Time specifications for the &`time`& option are <hour>.<minute>.<second>
32327 in the local time zone; each element being one or more digits.
32328 Either the seconds or both minutes and seconds, plus the leading &`.`&
32329 characters, may be omitted and will be taken as zero.
32330
32331 Timeout specifications for the &`retry`& and &`tmo`& options
32332 are the usual Exim time interval standard, e.g. &`20s`& or &`1m`&.
32333
32334 The &`tmo`& option specifies an overall timeout for communication.
32335 The default value is two minutes.
32336
32337 The &`retry`& option specifies a time after which a single retry for
32338 a failed connect is made.
32339 The default is to not retry.
32340
32341 The &%spamd_address%& variable is expanded before use if it starts with
32342 a dollar sign. In this case, the expansion may return a string that is
32343 used as the list so that multiple spamd servers can be the result of an
32344 expansion.
32345
32346 .vindex "&$callout_address$&"
32347 When a connection is made to the server the expansion variable &$callout_address$&
32348 is set to record the actual address used.
32349
32350 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
32351 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
32352 .code
32353 deny message = This message was classified as SPAM
32354      spam = joe
32355 .endd
32356 The right-hand side of the &%spam%& condition specifies a name. This is
32357 relevant if you have set up multiple SpamAssassin profiles. If you do not want
32358 to scan using a specific profile, but rather use the SpamAssassin system-wide
32359 default profile, you can scan for an unknown name, or simply use &"nobody"&.
32360 Rspamd does not use this setting. However, you must put something on the
32361 right-hand side.
32362
32363 The name allows you to use per-domain or per-user antispam profiles in
32364 principle, but this is not straightforward in practice, because a message may
32365 have multiple recipients, not necessarily all in the same domain. Because the
32366 &%spam%& condition has to be called from a DATA-time ACL in order to be able to
32367 read the contents of the message, the variables &$local_part$& and &$domain$&
32368 are not set.
32369 Careful enforcement of single-recipient messages
32370 (e.g. by responding with defer in the recipient ACL for all recipients
32371 after the first),
32372 or the use of PRDR,
32373 .cindex "PRDR" "use for per-user SpamAssassin profiles"
32374 are needed to use this feature.
32375
32376 The right-hand side of the &%spam%& condition is expanded before being used, so
32377 you can put lookups or conditions there. When the right-hand side evaluates to
32378 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
32379
32380
32381 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
32382 large ones may cause significant performance degradation. As most spam messages
32383 are quite small, it is recommended that you do not scan the big ones. For
32384 example:
32385 .code
32386 deny message = This message was classified as SPAM
32387      condition = ${if < {$message_size}{10K}}
32388      spam = nobody
32389 .endd
32390
32391 The &%spam%& condition returns true if the threshold specified in the user's
32392 SpamAssassin profile has been matched or exceeded. If you want to use the
32393 &%spam%& condition for its side effects (see the variables below), you can make
32394 it always return &"true"& by appending &`:true`& to the username.
32395
32396 .cindex "spam scanning" "returned variables"
32397 When the &%spam%& condition is run, it sets up a number of expansion
32398 variables.
32399 Except for &$spam_report$&,
32400 these variables are saved with the received message so are
32401 available for use at delivery time.
32402
32403 .vlist
32404 .vitem &$spam_score$&
32405 The spam score of the message, for example &"3.4"& or &"30.5"&. This is useful
32406 for inclusion in log or reject messages.
32407
32408 .vitem &$spam_score_int$&
32409 The spam score of the message, multiplied by ten, as an integer value. For
32410 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
32411 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
32412 The integer value is useful for numeric comparisons in conditions.
32413
32414 .vitem &$spam_bar$&
32415 A string consisting of a number of &"+"& or &"-"& characters, representing the
32416 integer part of the spam score value. A spam score of 4.4 would have a
32417 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
32418 headers, since MUAs can match on such strings. The maximum length of the
32419 spam bar is 50 characters.
32420
32421 .vitem &$spam_report$&
32422 A multiline text table, containing the full SpamAssassin report for the
32423 message. Useful for inclusion in headers or reject messages.
32424 This variable is only usable in a DATA-time ACL.
32425 Beware that SpamAssassin may return non-ASCII characters, especially
32426 when running in country-specific locales, which are not legal
32427 unencoded in headers.
32428
32429 .vitem &$spam_action$&
32430 For SpamAssassin either 'reject' or 'no action' depending on the
32431 spam score versus threshold.
32432 For Rspamd, the recommended action.
32433
32434 .endlist
32435
32436 The &%spam%& condition caches its results unless expansion in
32437 spamd_address was used. If you call it again with the same user name, it
32438 does not scan again, but rather returns the same values as before.
32439
32440 The &%spam%& condition returns DEFER if there is any error while running
32441 the message through SpamAssassin or if the expansion of spamd_address
32442 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
32443 statement block), append &`/defer_ok`& to the right-hand side of the
32444 spam condition, like this:
32445 .code
32446 deny message = This message was classified as SPAM
32447      spam    = joe/defer_ok
32448 .endd
32449 This causes messages to be accepted even if there is a problem with &%spamd%&.
32450
32451 Here is a longer, commented example of the use of the &%spam%&
32452 condition:
32453 .code
32454 # put headers in all messages (no matter if spam or not)
32455 warn  spam = nobody:true
32456       add_header = X-Spam-Score: $spam_score ($spam_bar)
32457       add_header = X-Spam-Report: $spam_report
32458
32459 # add second subject line with *SPAM* marker when message
32460 # is over threshold
32461 warn  spam = nobody
32462       add_header = Subject: *SPAM* $h_Subject:
32463
32464 # reject spam at high scores (> 12)
32465 deny  message = This message scored $spam_score spam points.
32466       spam = nobody:true
32467       condition = ${if >{$spam_score_int}{120}{1}{0}}
32468 .endd
32469
32470
32471
32472 .section "Scanning MIME parts" "SECTscanmimepart"
32473 .cindex "content scanning" "MIME parts"
32474 .cindex "MIME content scanning"
32475 .oindex "&%acl_smtp_mime%&"
32476 .oindex "&%acl_not_smtp_mime%&"
32477 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
32478 each MIME part of an SMTP message, including multipart types, in the sequence
32479 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
32480 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
32481 options may both refer to the same ACL if you want the same processing in both
32482 cases.
32483
32484 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
32485 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
32486 the case of a non-SMTP message. However, a MIME ACL is called only if the
32487 message contains a &'Content-Type:'& header line. When a call to a MIME
32488 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
32489 result code is sent to the client. In the case of an SMTP message, the
32490 &%acl_smtp_data%& ACL is not called when this happens.
32491
32492 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
32493 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
32494 condition to match against the raw MIME part. You can also use the
32495 &%mime_regex%& condition to match against the decoded MIME part (see section
32496 &<<SECTscanregex>>&).
32497
32498 At the start of a MIME ACL, a number of variables are set from the header
32499 information for the relevant MIME part. These are described below. The contents
32500 of the MIME part are not by default decoded into a disk file except for MIME
32501 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
32502 part into a disk file, you can use the &%decode%& condition. The general
32503 syntax is:
32504 .display
32505 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
32506 .endd
32507 The right hand side is expanded before use. After expansion,
32508 the value can be:
32509
32510 .olist
32511 &"0"& or &"false"&, in which case no decoding is done.
32512 .next
32513 The string &"default"&. In that case, the file is put in the temporary
32514 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
32515 a sequential file name consisting of the message id and a sequence number. The
32516 full path and name is available in &$mime_decoded_filename$& after decoding.
32517 .next
32518 A full path name starting with a slash. If the full name is an existing
32519 directory, it is used as a replacement for the default directory. The filename
32520 is then sequentially assigned. If the path does not exist, it is used as
32521 the full path and file name.
32522 .next
32523 If the string does not start with a slash, it is used as the
32524 filename, and the default path is then used.
32525 .endlist
32526 The &%decode%& condition normally succeeds. It is only false for syntax
32527 errors or unusual circumstances such as memory shortages. You can easily decode
32528 a file with its original, proposed filename using
32529 .code
32530 decode = $mime_filename
32531 .endd
32532 However, you should keep in mind that &$mime_filename$& might contain
32533 anything. If you place files outside of the default path, they are not
32534 automatically unlinked.
32535
32536 For RFC822 attachments (these are messages attached to messages, with a
32537 content-type of &"message/rfc822"&), the ACL is called again in the same manner
32538 as for the primary message, only that the &$mime_is_rfc822$& expansion
32539 variable is set (see below). Attached messages are always decoded to disk
32540 before being checked, and the files are unlinked once the check is done.
32541
32542 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
32543 used to match regular expressions against raw and decoded MIME parts,
32544 respectively. They are described in section &<<SECTscanregex>>&.
32545
32546 .cindex "MIME content scanning" "returned variables"
32547 The following list describes all expansion variables that are
32548 available in the MIME ACL:
32549
32550 .vlist
32551 .vitem &$mime_boundary$&
32552 If the current part is a multipart (see &$mime_is_multipart$&) below, it should
32553 have a boundary string, which is stored in this variable. If the current part
32554 has no boundary parameter in the &'Content-Type:'& header, this variable
32555 contains the empty string.
32556
32557 .vitem &$mime_charset$&
32558 This variable contains the character set identifier, if one was found in the
32559 &'Content-Type:'& header. Examples for charset identifiers are:
32560 .code
32561 us-ascii
32562 gb2312 (Chinese)
32563 iso-8859-1
32564 .endd
32565 Please note that this value is not normalized, so you should do matches
32566 case-insensitively.
32567
32568 .vitem &$mime_content_description$&
32569 This variable contains the normalized content of the &'Content-Description:'&
32570 header. It can contain a human-readable description of the parts content. Some
32571 implementations repeat the filename for attachments here, but they are usually
32572 only used for display purposes.
32573
32574 .vitem &$mime_content_disposition$&
32575 This variable contains the normalized content of the &'Content-Disposition:'&
32576 header. You can expect strings like &"attachment"& or &"inline"& here.
32577
32578 .vitem &$mime_content_id$&
32579 This variable contains the normalized content of the &'Content-ID:'& header.
32580 This is a unique ID that can be used to reference a part from another part.
32581
32582 .vitem &$mime_content_size$&
32583 This variable is set only after the &%decode%& modifier (see above) has been
32584 successfully run. It contains the size of the decoded part in kilobytes. The
32585 size is always rounded up to full kilobytes, so only a completely empty part
32586 has a &$mime_content_size$& of zero.
32587
32588 .vitem &$mime_content_transfer_encoding$&
32589 This variable contains the normalized content of the
32590 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
32591 type. Typical values are &"base64"& and &"quoted-printable"&.
32592
32593 .vitem &$mime_content_type$&
32594 If the MIME part has a &'Content-Type:'& header, this variable contains its
32595 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
32596 are some examples of popular MIME types, as they may appear in this variable:
32597 .code
32598 text/plain
32599 text/html
32600 application/octet-stream
32601 image/jpeg
32602 audio/midi
32603 .endd
32604 If the MIME part has no &'Content-Type:'& header, this variable contains the
32605 empty string.
32606
32607 .vitem &$mime_decoded_filename$&
32608 This variable is set only after the &%decode%& modifier (see above) has been
32609 successfully run. It contains the full path and file name of the file
32610 containing the decoded data.
32611 .endlist
32612
32613 .cindex "RFC 2047"
32614 .vlist
32615 .vitem &$mime_filename$&
32616 This is perhaps the most important of the MIME variables. It contains a
32617 proposed filename for an attachment, if one was found in either the
32618 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
32619 RFC2047
32620 or RFC2231
32621 decoded, but no additional sanity checks are done.
32622  If no filename was
32623 found, this variable contains the empty string.
32624
32625 .vitem &$mime_is_coverletter$&
32626 This variable attempts to differentiate the &"cover letter"& of an e-mail from
32627 attached data. It can be used to clamp down on flashy or unnecessarily encoded
32628 content in the cover letter, while not restricting attachments at all.
32629
32630 The variable contains 1 (true) for a MIME part believed to be part of the
32631 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
32632 follows:
32633
32634 .olist
32635 The outermost MIME part of a message is always a cover letter.
32636
32637 .next
32638 If a multipart/alternative or multipart/related MIME part is a cover letter,
32639 so are all MIME subparts within that multipart.
32640
32641 .next
32642 If any other multipart is a cover letter, the first subpart is a cover letter,
32643 and the rest are attachments.
32644
32645 .next
32646 All parts contained within an attachment multipart are attachments.
32647 .endlist olist
32648
32649 As an example, the following will ban &"HTML mail"& (including that sent with
32650 alternative plain text), while allowing HTML files to be attached. HTML
32651 coverletter mail attached to non-HTML coverletter mail will also be allowed:
32652 .code
32653 deny message = HTML mail is not accepted here
32654 !condition = $mime_is_rfc822
32655 condition = $mime_is_coverletter
32656 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
32657 .endd
32658 .vitem &$mime_is_multipart$&
32659 This variable has the value 1 (true) when the current part has the main type
32660 &"multipart"&, for example &"multipart/alternative"& or &"multipart/mixed"&.
32661 Since multipart entities only serve as containers for other parts, you may not
32662 want to carry out specific actions on them.
32663
32664 .vitem &$mime_is_rfc822$&
32665 This variable has the value 1 (true) if the current part is not a part of the
32666 checked message itself, but part of an attached message. Attached message
32667 decoding is fully recursive.
32668
32669 .vitem &$mime_part_count$&
32670 This variable is a counter that is raised for each processed MIME part. It
32671 starts at zero for the very first part (which is usually a multipart). The
32672 counter is per-message, so it is reset when processing RFC822 attachments (see
32673 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
32674 complete, so you can use it in the DATA ACL to determine the number of MIME
32675 parts of a message. For non-MIME messages, this variable contains the value -1.
32676 .endlist
32677
32678
32679
32680 .section "Scanning with regular expressions" "SECTscanregex"
32681 .cindex "content scanning" "with regular expressions"
32682 .cindex "regular expressions" "content scanning with"
32683 You can specify your own custom regular expression matches on the full body of
32684 the message, or on individual MIME parts.
32685
32686 The &%regex%& condition takes one or more regular expressions as arguments and
32687 matches them against the full message (when called in the DATA ACL) or a raw
32688 MIME part (when called in the MIME ACL). The &%regex%& condition matches
32689 linewise, with a maximum line length of 32K characters. That means you cannot
32690 have multiline matches with the &%regex%& condition.
32691
32692 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
32693 to 32K of decoded content (the whole content at once, not linewise). If the
32694 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
32695 is decoded automatically when &%mime_regex%& is executed (using default path
32696 and filename values). If the decoded data is larger than  32K, only the first
32697 32K characters are checked.
32698
32699 The regular expressions are passed as a colon-separated list. To include a
32700 literal colon, you must double it. Since the whole right-hand side string is
32701 expanded before being used, you must also escape dollar signs and backslashes
32702 with more backslashes, or use the &`\N`& facility to disable expansion.
32703 Here is a simple example that contains two regular expressions:
32704 .code
32705 deny message = contains blacklisted regex ($regex_match_string)
32706      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
32707 .endd
32708 The conditions returns true if any one of the regular expressions matches. The
32709 &$regex_match_string$& expansion variable is then set up and contains the
32710 matching regular expression.
32711 The expansion variables &$regex1$& &$regex2$& etc
32712 are set to any substrings captured by the regular expression.
32713
32714 &*Warning*&: With large messages, these conditions can be fairly
32715 CPU-intensive.
32716
32717 .ecindex IIDcosca
32718
32719
32720
32721
32722 . ////////////////////////////////////////////////////////////////////////////
32723 . ////////////////////////////////////////////////////////////////////////////
32724
32725 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
32726          "Local scan function"
32727 .scindex IIDlosca "&[local_scan()]& function" "description of"
32728 .cindex "customizing" "input scan using C function"
32729 .cindex "policy control" "by local scan function"
32730 In these days of email worms, viruses, and ever-increasing spam, some sites
32731 want to apply a lot of checking to messages before accepting them.
32732
32733 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
32734 passing messages to external virus and spam scanning software. You can also do
32735 a certain amount in Exim itself through string expansions and the &%condition%&
32736 condition in the ACL that runs after the SMTP DATA command or the ACL for
32737 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
32738
32739 To allow for further customization to a site's own requirements, there is the
32740 possibility of linking Exim with a private message scanning function, written
32741 in C. If you want to run code that is written in something other than C, you
32742 can of course use a little C stub to call it.
32743
32744 The local scan function is run once for every incoming message, at the point
32745 when Exim is just about to accept the message.
32746 It can therefore be used to control non-SMTP messages from local processes as
32747 well as messages arriving via SMTP.
32748
32749 Exim applies a timeout to calls of the local scan function, and there is an
32750 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
32751 Zero means &"no timeout"&.
32752 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
32753 before calling the local scan function, so that the most common types of crash
32754 are caught. If the timeout is exceeded or one of those signals is caught, the
32755 incoming message is rejected with a temporary error if it is an SMTP message.
32756 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
32757 code. The incident is logged on the main and reject logs.
32758
32759
32760
32761 .section "Building Exim to use a local scan function" "SECID207"
32762 .cindex "&[local_scan()]& function" "building Exim to use"
32763 To make use of the local scan function feature, you must tell Exim where your
32764 function is before building Exim, by setting LOCAL_SCAN_SOURCE in your
32765 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
32766 directory, so you might set
32767 .code
32768 LOCAL_SCAN_SOURCE=Local/local_scan.c
32769 .endd
32770 for example. The function must be called &[local_scan()]&. It is called by
32771 Exim after it has received a message, when the success return code is about to
32772 be sent. This is after all the ACLs have been run. The return code from your
32773 function controls whether the message is actually accepted or not. There is a
32774 commented template function (that just accepts the message) in the file
32775 _src/local_scan.c_.
32776
32777 If you want to make use of Exim's run time configuration file to set options
32778 for your &[local_scan()]& function, you must also set
32779 .code
32780 LOCAL_SCAN_HAS_OPTIONS=yes
32781 .endd
32782 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
32783
32784
32785
32786
32787 .section "API for local_scan()" "SECTapiforloc"
32788 .cindex "&[local_scan()]& function" "API description"
32789 You must include this line near the start of your code:
32790 .code
32791 #include "local_scan.h"
32792 .endd
32793 This header file defines a number of variables and other values, and the
32794 prototype for the function itself. Exim is coded to use unsigned char values
32795 almost exclusively, and one of the things this header defines is a shorthand
32796 for &`unsigned char`& called &`uschar`&.
32797 It also contains the following macro definitions, to simplify casting character
32798 strings and pointers to character strings:
32799 .code
32800 #define CS   (char *)
32801 #define CCS  (const char *)
32802 #define CSS  (char **)
32803 #define US   (unsigned char *)
32804 #define CUS  (const unsigned char *)
32805 #define USS  (unsigned char **)
32806 .endd
32807 The function prototype for &[local_scan()]& is:
32808 .code
32809 extern int local_scan(int fd, uschar **return_text);
32810 .endd
32811 The arguments are as follows:
32812
32813 .ilist
32814 &%fd%& is a file descriptor for the file that contains the body of the message
32815 (the -D file). The file is open for reading and writing, but updating it is not
32816 recommended. &*Warning*&: You must &'not'& close this file descriptor.
32817
32818 The descriptor is positioned at character 19 of the file, which is the first
32819 character of the body itself, because the first 19 characters are the message
32820 id followed by &`-D`& and a newline. If you rewind the file, you should use the
32821 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
32822 case this changes in some future version.
32823 .next
32824 &%return_text%& is an address which you can use to return a pointer to a text
32825 string at the end of the function. The value it points to on entry is NULL.
32826 .endlist
32827
32828 The function must return an &%int%& value which is one of the following macros:
32829
32830 .vlist
32831 .vitem &`LOCAL_SCAN_ACCEPT`&
32832 .vindex "&$local_scan_data$&"
32833 The message is accepted. If you pass back a string of text, it is saved with
32834 the message, and made available in the variable &$local_scan_data$&. No
32835 newlines are permitted (if there are any, they are turned into spaces) and the
32836 maximum length of text is 1000 characters.
32837
32838 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
32839 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
32840 queued without immediate delivery, and is frozen.
32841
32842 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
32843 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
32844 queued without immediate delivery.
32845
32846 .vitem &`LOCAL_SCAN_REJECT`&
32847 The message is rejected; the returned text is used as an error message which is
32848 passed back to the sender and which is also logged. Newlines are permitted &--
32849 they cause a multiline response for SMTP rejections, but are converted to
32850 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
32851 used.
32852
32853 .vitem &`LOCAL_SCAN_TEMPREJECT`&
32854 The message is temporarily rejected; the returned text is used as an error
32855 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
32856 problem"& is used.
32857
32858 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
32859 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
32860 message is not written to the reject log. It has the effect of unsetting the
32861 &%rejected_header%& log selector for just this rejection. If
32862 &%rejected_header%& is already unset (see the discussion of the
32863 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
32864 same as LOCAL_SCAN_REJECT.
32865
32866 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
32867 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
32868 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
32869 .endlist
32870
32871 If the message is not being received by interactive SMTP, rejections are
32872 reported by writing to &%stderr%& or by sending an email, as configured by the
32873 &%-oe%& command line options.
32874
32875
32876
32877 .section "Configuration options for local_scan()" "SECTconoptloc"
32878 .cindex "&[local_scan()]& function" "configuration options"
32879 It is possible to have option settings in the main configuration file
32880 that set values in static variables in the &[local_scan()]& module. If you
32881 want to do this, you must have the line
32882 .code
32883 LOCAL_SCAN_HAS_OPTIONS=yes
32884 .endd
32885 in your &_Local/Makefile_& when you build Exim. (This line is in
32886 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
32887 file, you must define static variables to hold the option values, and a table
32888 to define them.
32889
32890 The table must be a vector called &%local_scan_options%&, of type
32891 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
32892 and a pointer to the variable that holds the value. The entries must appear in
32893 alphabetical order. Following &%local_scan_options%& you must also define a
32894 variable called &%local_scan_options_count%& that contains the number of
32895 entries in the table. Here is a short example, showing two kinds of option:
32896 .code
32897 static int my_integer_option = 42;
32898 static uschar *my_string_option = US"a default string";
32899
32900 optionlist local_scan_options[] = {
32901   { "my_integer", opt_int,       &my_integer_option },
32902   { "my_string",  opt_stringptr, &my_string_option }
32903 };
32904
32905 int local_scan_options_count =
32906   sizeof(local_scan_options)/sizeof(optionlist);
32907 .endd
32908 The values of the variables can now be changed from Exim's runtime
32909 configuration file by including a local scan section as in this example:
32910 .code
32911 begin local_scan
32912 my_integer = 99
32913 my_string = some string of text...
32914 .endd
32915 The available types of option data are as follows:
32916
32917 .vlist
32918 .vitem &*opt_bool*&
32919 This specifies a boolean (true/false) option. The address should point to a
32920 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
32921 that are defined as &"1"& and &"0"&, respectively. If you want to detect
32922 whether such a variable has been set at all, you can initialize it to
32923 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
32924 values.)
32925
32926 .vitem &*opt_fixed*&
32927 This specifies a fixed point number, such as is used for load averages.
32928 The address should point to a variable of type &`int`&. The value is stored
32929 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
32930
32931 .vitem &*opt_int*&
32932 This specifies an integer; the address should point to a variable of type
32933 &`int`&. The value may be specified in any of the integer formats accepted by
32934 Exim.
32935
32936 .vitem &*opt_mkint*&
32937 This is the same as &%opt_int%&, except that when such a value is output in a
32938 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
32939 printed with the suffix K or M.
32940
32941 .vitem &*opt_octint*&
32942 This also specifies an integer, but the value is always interpreted as an
32943 octal integer, whether or not it starts with the digit zero, and it is
32944 always output in octal.
32945
32946 .vitem &*opt_stringptr*&
32947 This specifies a string value; the address must be a pointer to a
32948 variable that points to a string (for example, of type &`uschar *`&).
32949
32950 .vitem &*opt_time*&
32951 This specifies a time interval value. The address must point to a variable of
32952 type &`int`&. The value that is placed there is a number of seconds.
32953 .endlist
32954
32955 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
32956 out the values of all the &[local_scan()]& options.
32957
32958
32959
32960 .section "Available Exim variables" "SECID208"
32961 .cindex "&[local_scan()]& function" "available Exim variables"
32962 The header &_local_scan.h_& gives you access to a number of C variables. These
32963 are the only ones that are guaranteed to be maintained from release to release.
32964 Note, however, that you can obtain the value of any Exim expansion variable,
32965 including &$recipients$&, by calling &'expand_string()'&. The exported
32966 C variables are as follows:
32967
32968 .vlist
32969 .vitem &*int&~body_linecount*&
32970 This variable contains the number of lines in the message's body.
32971 It is not valid if the &%spool_files_wireformat%& option is used.
32972
32973 .vitem &*int&~body_zerocount*&
32974 This variable contains the number of binary zero bytes in the message's body.
32975 It is not valid if the &%spool_files_wireformat%& option is used.
32976
32977 .vitem &*unsigned&~int&~debug_selector*&
32978 This variable is set to zero when no debugging is taking place. Otherwise, it
32979 is a bitmap of debugging selectors. Two bits are identified for use in
32980 &[local_scan()]&; they are defined as macros:
32981
32982 .ilist
32983 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
32984 testing option that is not privileged &-- any caller may set it. All the
32985 other selector bits can be set only by admin users.
32986
32987 .next
32988 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
32989 by the &`+local_scan`& debug selector. It is not included in the default set
32990 of debugging bits.
32991 .endlist ilist
32992
32993 Thus, to write to the debugging output only when &`+local_scan`& has been
32994 selected, you should use code like this:
32995 .code
32996 if ((debug_selector & D_local_scan) != 0)
32997   debug_printf("xxx", ...);
32998 .endd
32999 .vitem &*uschar&~*expand_string_message*&
33000 After a failing call to &'expand_string()'& (returned value NULL), the
33001 variable &%expand_string_message%& contains the error message, zero-terminated.
33002
33003 .vitem &*header_line&~*header_list*&
33004 A pointer to a chain of header lines. The &%header_line%& structure is
33005 discussed below.
33006
33007 .vitem &*header_line&~*header_last*&
33008 A pointer to the last of the header lines.
33009
33010 .vitem &*uschar&~*headers_charset*&
33011 The value of the &%headers_charset%& configuration option.
33012
33013 .vitem &*BOOL&~host_checking*&
33014 This variable is TRUE during a host checking session that is initiated by the
33015 &%-bh%& command line option.
33016
33017 .vitem &*uschar&~*interface_address*&
33018 The IP address of the interface that received the message, as a string. This
33019 is NULL for locally submitted messages.
33020
33021 .vitem &*int&~interface_port*&
33022 The port on which this message was received. When testing with the &%-bh%&
33023 command line option, the value of this variable is -1 unless a port has been
33024 specified via the &%-oMi%& option.
33025
33026 .vitem &*uschar&~*message_id*&
33027 This variable contains Exim's message id for the incoming message (the value of
33028 &$message_exim_id$&) as a zero-terminated string.
33029
33030 .vitem &*uschar&~*received_protocol*&
33031 The name of the protocol by which the message was received.
33032
33033 .vitem &*int&~recipients_count*&
33034 The number of accepted recipients.
33035
33036 .vitem &*recipient_item&~*recipients_list*&
33037 .cindex "recipient" "adding in local scan"
33038 .cindex "recipient" "removing in local scan"
33039 The list of accepted recipients, held in a vector of length
33040 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
33041 can add additional recipients by calling &'receive_add_recipient()'& (see
33042 below). You can delete recipients by removing them from the vector and
33043 adjusting the value in &%recipients_count%&. In particular, by setting
33044 &%recipients_count%& to zero you remove all recipients. If you then return the
33045 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
33046 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
33047 and then call &'receive_add_recipient()'& as often as needed.
33048
33049 .vitem &*uschar&~*sender_address*&
33050 The envelope sender address. For bounce messages this is the empty string.
33051
33052 .vitem &*uschar&~*sender_host_address*&
33053 The IP address of the sending host, as a string. This is NULL for
33054 locally-submitted messages.
33055
33056 .vitem &*uschar&~*sender_host_authenticated*&
33057 The name of the authentication mechanism that was used, or NULL if the message
33058 was not received over an authenticated SMTP connection.
33059
33060 .vitem &*uschar&~*sender_host_name*&
33061 The name of the sending host, if known.
33062
33063 .vitem &*int&~sender_host_port*&
33064 The port on the sending host.
33065
33066 .vitem &*BOOL&~smtp_input*&
33067 This variable is TRUE for all SMTP input, including BSMTP.
33068
33069 .vitem &*BOOL&~smtp_batched_input*&
33070 This variable is TRUE for BSMTP input.
33071
33072 .vitem &*int&~store_pool*&
33073 The contents of this variable control which pool of memory is used for new
33074 requests. See section &<<SECTmemhanloc>>& for details.
33075 .endlist
33076
33077
33078 .section "Structure of header lines" "SECID209"
33079 The &%header_line%& structure contains the members listed below.
33080 You can add additional header lines by calling the &'header_add()'& function
33081 (see below). You can cause header lines to be ignored (deleted) by setting
33082 their type to *.
33083
33084
33085 .vlist
33086 .vitem &*struct&~header_line&~*next*&
33087 A pointer to the next header line, or NULL for the last line.
33088
33089 .vitem &*int&~type*&
33090 A code identifying certain headers that Exim recognizes. The codes are printing
33091 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
33092 Notice in particular that any header line whose type is * is not transmitted
33093 with the message. This flagging is used for header lines that have been
33094 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
33095 lines.) Effectively, * means &"deleted"&.
33096
33097 .vitem &*int&~slen*&
33098 The number of characters in the header line, including the terminating and any
33099 internal newlines.
33100
33101 .vitem &*uschar&~*text*&
33102 A pointer to the text of the header. It always ends with a newline, followed by
33103 a zero byte. Internal newlines are preserved.
33104 .endlist
33105
33106
33107
33108 .section "Structure of recipient items" "SECID210"
33109 The &%recipient_item%& structure contains these members:
33110
33111 .vlist
33112 .vitem &*uschar&~*address*&
33113 This is a pointer to the recipient address as it was received.
33114
33115 .vitem &*int&~pno*&
33116 This is used in later Exim processing when top level addresses are created by
33117 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
33118 and must always contain -1 at this stage.
33119
33120 .vitem &*uschar&~*errors_to*&
33121 If this value is not NULL, bounce messages caused by failing to deliver to the
33122 recipient are sent to the address it contains. In other words, it overrides the
33123 envelope sender for this one recipient. (Compare the &%errors_to%& generic
33124 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
33125 an unqualified address, Exim qualifies it using the domain from
33126 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
33127 is NULL for all recipients.
33128 .endlist
33129
33130
33131
33132 .section "Available Exim functions" "SECID211"
33133 .cindex "&[local_scan()]& function" "available Exim functions"
33134 The header &_local_scan.h_& gives you access to a number of Exim functions.
33135 These are the only ones that are guaranteed to be maintained from release to
33136 release:
33137
33138 .vlist
33139 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
33140        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
33141
33142 This function creates a child process that runs the command specified by
33143 &%argv%&. The environment for the process is specified by &%envp%&, which can
33144 be NULL if no environment variables are to be passed. A new umask is supplied
33145 for the process in &%newumask%&.
33146
33147 Pipes to the standard input and output of the new process are set up
33148 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
33149 standard error is cloned to the standard output. If there are any file
33150 descriptors &"in the way"& in the new process, they are closed. If the final
33151 argument is TRUE, the new process is made into a process group leader.
33152
33153 The function returns the pid of the new process, or -1 if things go wrong.
33154
33155 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
33156 This function waits for a child process to terminate, or for a timeout (in
33157 seconds) to expire. A timeout value of zero means wait as long as it takes. The
33158 return value is as follows:
33159
33160 .ilist
33161 >= 0
33162
33163 The process terminated by a normal exit and the value is the process
33164 ending status.
33165
33166 .next
33167 < 0 and > &--256
33168
33169 The process was terminated by a signal and the value is the negation of the
33170 signal number.
33171
33172 .next
33173 &--256
33174
33175 The process timed out.
33176 .next
33177 &--257
33178
33179 The was some other error in wait(); &%errno%& is still set.
33180 .endlist
33181
33182 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
33183 This function provide you with a means of submitting a new message to
33184 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
33185 want, but this packages it all up for you.) The function creates a pipe,
33186 forks a subprocess that is running
33187 .code
33188 exim -t -oem -oi -f <>
33189 .endd
33190 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
33191 that is connected to the standard input. The yield of the function is the PID
33192 of the subprocess. You can then write a message to the file descriptor, with
33193 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
33194
33195 When you have finished, call &'child_close()'& to wait for the process to
33196 finish and to collect its ending status. A timeout value of zero is usually
33197 fine in this circumstance. Unless you have made a mistake with the recipient
33198 addresses, you should get a return code of zero.
33199
33200
33201 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
33202        *sender_authentication)*&
33203 This function is a more sophisticated version of &'child_open()'&. The command
33204 that it runs is:
33205 .display
33206 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
33207 .endd
33208 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
33209
33210
33211 .vitem &*void&~debug_printf(char&~*,&~...)*&
33212 This is Exim's debugging function, with arguments as for &'(printf()'&. The
33213 output is written to the standard error stream. If no debugging is selected,
33214 calls to &'debug_printf()'& have no effect. Normally, you should make calls
33215 conditional on the &`local_scan`& debug selector by coding like this:
33216 .code
33217 if ((debug_selector & D_local_scan) != 0)
33218   debug_printf("xxx", ...);
33219 .endd
33220
33221 .vitem &*uschar&~*expand_string(uschar&~*string)*&
33222 This is an interface to Exim's string expansion code. The return value is the
33223 expanded string, or NULL if there was an expansion failure.
33224 The C variable &%expand_string_message%& contains an error message after an
33225 expansion failure. If expansion does not change the string, the return value is
33226 the pointer to the input string. Otherwise, the return value points to a new
33227 block of memory that was obtained by a call to &'store_get()'&. See section
33228 &<<SECTmemhanloc>>& below for a discussion of memory handling.
33229
33230 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
33231 This function allows you to an add additional header line at the end of the
33232 existing ones. The first argument is the type, and should normally be a space
33233 character. The second argument is a format string and any number of
33234 substitution arguments as for &[sprintf()]&. You may include internal newlines
33235 if you want, and you must ensure that the string ends with a newline.
33236
33237 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
33238         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
33239 This function adds a new header line at a specified point in the header
33240 chain. The header itself is specified as for &'header_add()'&.
33241
33242 If &%name%& is NULL, the new header is added at the end of the chain if
33243 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
33244 NULL, the header lines are searched for the first non-deleted header that
33245 matches the name. If one is found, the new header is added before it if
33246 &%after%& is false. If &%after%& is true, the new header is added after the
33247 found header and any adjacent subsequent ones with the same name (even if
33248 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
33249 option controls where the header is added. If it is true, addition is at the
33250 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
33251 headers, or at the top if there are no &'Received:'& headers, you could use
33252 .code
33253 header_add_at_position(TRUE, US"Received", TRUE,
33254   ' ', "X-xxx: ...");
33255 .endd
33256 Normally, there is always at least one non-deleted &'Received:'& header, but
33257 there may not be if &%received_header_text%& expands to an empty string.
33258
33259
33260 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
33261 This function removes header lines. If &%occurrence%& is zero or negative, all
33262 occurrences of the header are removed. If occurrence is greater than zero, that
33263 particular instance of the header is removed. If no header(s) can be found that
33264 match the specification, the function does nothing.
33265
33266
33267 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
33268         int&~length,&~BOOL&~notdel)*&"
33269 This function tests whether the given header has the given name. It is not just
33270 a string comparison, because white space is permitted between the name and the
33271 colon. If the &%notdel%& argument is true, a false return is forced for all
33272 &"deleted"& headers; otherwise they are not treated specially. For example:
33273 .code
33274 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
33275 .endd
33276 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
33277 .cindex "base64 encoding" "functions for &[local_scan()]& use"
33278 This function base64-encodes a string, which is passed by address and length.
33279 The text may contain bytes of any value, including zero. The result is passed
33280 back in dynamic memory that is obtained by calling &'store_get()'&. It is
33281 zero-terminated.
33282
33283 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
33284 This function decodes a base64-encoded string. Its arguments are a
33285 zero-terminated base64-encoded string and the address of a variable that is set
33286 to point to the result, which is in dynamic memory. The length of the decoded
33287 string is the yield of the function. If the input is invalid base64 data, the
33288 yield is -1. A zero byte is added to the end of the output string to make it
33289 easy to interpret as a C string (assuming it contains no zeros of its own). The
33290 added zero byte is not included in the returned count.
33291
33292 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
33293 This function checks for a match in a domain list. Domains are always
33294 matched caselessly. The return value is one of the following:
33295 .display
33296 &`OK     `& match succeeded
33297 &`FAIL   `& match failed
33298 &`DEFER  `& match deferred
33299 .endd
33300 DEFER is usually caused by some kind of lookup defer, such as the
33301 inability to contact a database.
33302
33303 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
33304         BOOL&~caseless)*&"
33305 This function checks for a match in a local part list. The third argument
33306 controls case-sensitivity. The return values are as for
33307 &'lss_match_domain()'&.
33308
33309 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
33310         BOOL&~caseless)*&"
33311 This function checks for a match in an address list. The third argument
33312 controls the case-sensitivity of the local part match. The domain is always
33313 matched caselessly. The return values are as for &'lss_match_domain()'&.
33314
33315 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
33316         uschar&~*list)*&"
33317 This function checks for a match in a host list. The most common usage is
33318 expected to be
33319 .code
33320 lss_match_host(sender_host_name, sender_host_address, ...)
33321 .endd
33322 .vindex "&$sender_host_address$&"
33323 An empty address field matches an empty item in the host list. If the host name
33324 is NULL, the name corresponding to &$sender_host_address$& is automatically
33325 looked up if a host name is required to match an item in the list. The return
33326 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
33327 returns ERROR in the case when it had to look up a host name, but the lookup
33328 failed.
33329
33330 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
33331         *format,&~...)*&"
33332 This function writes to Exim's log files. The first argument should be zero (it
33333 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
33334 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
33335 them. It specifies to which log or logs the message is written. The remaining
33336 arguments are a format and relevant insertion arguments. The string should not
33337 contain any newlines, not even at the end.
33338
33339
33340 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
33341 This function adds an additional recipient to the message. The first argument
33342 is the recipient address. If it is unqualified (has no domain), it is qualified
33343 with the &%qualify_recipient%& domain. The second argument must always be -1.
33344
33345 This function does not allow you to specify a private &%errors_to%& address (as
33346 described with the structure of &%recipient_item%& above), because it pre-dates
33347 the addition of that field to the structure. However, it is easy to add such a
33348 value afterwards. For example:
33349 .code
33350  receive_add_recipient(US"monitor@mydom.example", -1);
33351  recipients_list[recipients_count-1].errors_to =
33352    US"postmaster@mydom.example";
33353 .endd
33354
33355 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
33356 This is a convenience function to remove a named recipient from the list of
33357 recipients. It returns true if a recipient was removed, and false if no
33358 matching recipient could be found. The argument must be a complete email
33359 address.
33360 .endlist
33361
33362
33363 .cindex "RFC 2047"
33364 .vlist
33365 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
33366   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
33367 This function decodes strings that are encoded according to RFC 2047. Typically
33368 these are the contents of header lines. First, each &"encoded word"& is decoded
33369 from the Q or B encoding into a byte-string. Then, if provided with the name of
33370 a charset encoding, and if the &[iconv()]& function is available, an attempt is
33371 made  to translate the result to the named character set. If this fails, the
33372 binary string is returned with an error message.
33373
33374 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
33375 maximum MIME word length is enforced. The third argument is the target
33376 encoding, or NULL if no translation is wanted.
33377
33378 .cindex "binary zero" "in RFC 2047 decoding"
33379 .cindex "RFC 2047" "binary zero in"
33380 If a binary zero is encountered in the decoded string, it is replaced by the
33381 contents of the &%zeroval%& argument. For use with Exim headers, the value must
33382 not be 0 because header lines are handled as zero-terminated strings.
33383
33384 The function returns the result of processing the string, zero-terminated; if
33385 &%lenptr%& is not NULL, the length of the result is set in the variable to
33386 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
33387
33388 If an error is encountered, the function returns NULL and uses the &%error%&
33389 argument to return an error message. The variable pointed to by &%error%& is
33390 set to NULL if there is no error; it may be set non-NULL even when the function
33391 returns a non-NULL value if decoding was successful, but there was a problem
33392 with translation.
33393
33394
33395 .vitem &*int&~smtp_fflush(void)*&
33396 This function is used in conjunction with &'smtp_printf()'&, as described
33397 below.
33398
33399 .vitem &*void&~smtp_printf(char&~*,&~...)*&
33400 The arguments of this function are like &[printf()]&; it writes to the SMTP
33401 output stream. You should use this function only when there is an SMTP output
33402 stream, that is, when the incoming message is being received via interactive
33403 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
33404 is FALSE. If you want to test for an incoming message from another host (as
33405 opposed to a local process that used the &%-bs%& command line option), you can
33406 test the value of &%sender_host_address%&, which is non-NULL when a remote host
33407 is involved.
33408
33409 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
33410 output function, so it can be used for all forms of SMTP connection.
33411
33412 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
33413 must start with an appropriate response code: 550 if you are going to return
33414 LOCAL_SCAN_REJECT, 451 if you are going to return
33415 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
33416 initial lines of a multi-line response, the code must be followed by a hyphen
33417 to indicate that the line is not the final response line. You must also ensure
33418 that the lines you write terminate with CRLF. For example:
33419 .code
33420 smtp_printf("550-this is some extra info\r\n");
33421 return LOCAL_SCAN_REJECT;
33422 .endd
33423 Note that you can also create multi-line responses by including newlines in
33424 the data returned via the &%return_text%& argument. The added value of using
33425 &'smtp_printf()'& is that, for instance, you could introduce delays between
33426 multiple output lines.
33427
33428 The &'smtp_printf()'& function does not return any error indication, because it
33429 does not automatically flush pending output, and therefore does not test
33430 the state of the stream. (In the main code of Exim, flushing and error
33431 detection is done when Exim is ready for the next SMTP input command.) If
33432 you want to flush the output and check for an error (for example, the
33433 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
33434 arguments. It flushes the output stream, and returns a non-zero value if there
33435 is an error.
33436
33437 .vitem &*void&~*store_get(int)*&
33438 This function accesses Exim's internal store (memory) manager. It gets a new
33439 chunk of memory whose size is given by the argument. Exim bombs out if it ever
33440 runs out of memory. See the next section for a discussion of memory handling.
33441
33442 .vitem &*void&~*store_get_perm(int)*&
33443 This function is like &'store_get()'&, but it always gets memory from the
33444 permanent pool. See the next section for a discussion of memory handling.
33445
33446 .vitem &*uschar&~*string_copy(uschar&~*string)*&
33447 See below.
33448
33449 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
33450 See below.
33451
33452 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
33453 These three functions create strings using Exim's dynamic memory facilities.
33454 The first makes a copy of an entire string. The second copies up to a maximum
33455 number of characters, indicated by the second argument. The third uses a format
33456 and insertion arguments to create a new string. In each case, the result is a
33457 pointer to a new string in the current memory pool. See the next section for
33458 more discussion.
33459 .endlist
33460
33461
33462
33463 .section "More about Exim's memory handling" "SECTmemhanloc"
33464 .cindex "&[local_scan()]& function" "memory handling"
33465 No function is provided for freeing memory, because that is never needed.
33466 The dynamic memory that Exim uses when receiving a message is automatically
33467 recycled if another message is received by the same process (this applies only
33468 to incoming SMTP connections &-- other input methods can supply only one
33469 message at a time). After receiving the last message, a reception process
33470 terminates.
33471
33472 Because it is recycled, the normal dynamic memory cannot be used for holding
33473 data that must be preserved over a number of incoming messages on the same SMTP
33474 connection. However, Exim in fact uses two pools of dynamic memory; the second
33475 one is not recycled, and can be used for this purpose.
33476
33477 If you want to allocate memory that remains available for subsequent messages
33478 in the same SMTP connection, you should set
33479 .code
33480 store_pool = POOL_PERM
33481 .endd
33482 before calling the function that does the allocation. There is no need to
33483 restore the value if you do not need to; however, if you do want to revert to
33484 the normal pool, you can either restore the previous value of &%store_pool%& or
33485 set it explicitly to POOL_MAIN.
33486
33487 The pool setting applies to all functions that get dynamic memory, including
33488 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
33489 There is also a convenience function called &'store_get_perm()'& that gets a
33490 block of memory from the permanent pool while preserving the value of
33491 &%store_pool%&.
33492 .ecindex IIDlosca
33493
33494
33495
33496
33497 . ////////////////////////////////////////////////////////////////////////////
33498 . ////////////////////////////////////////////////////////////////////////////
33499
33500 .chapter "System-wide message filtering" "CHAPsystemfilter"
33501 .scindex IIDsysfil1 "filter" "system filter"
33502 .scindex IIDsysfil2 "filtering all mail"
33503 .scindex IIDsysfil3 "system filter"
33504 The previous chapters (on ACLs and the local scan function) describe checks
33505 that can be applied to messages before they are accepted by a host. There is
33506 also a mechanism for checking messages once they have been received, but before
33507 they are delivered. This is called the &'system filter'&.
33508
33509 The system filter operates in a similar manner to users' filter files, but it
33510 is run just once per message (however many recipients the message has).
33511 It should not normally be used as a substitute for routing, because &%deliver%&
33512 commands in a system router provide new envelope recipient addresses.
33513 The system filter must be an Exim filter. It cannot be a Sieve filter.
33514
33515 The system filter is run at the start of a delivery attempt, before any routing
33516 is done. If a message fails to be completely delivered at the first attempt,
33517 the system filter is run again at the start of every retry.
33518 If you want your filter to do something only once per message, you can make use
33519 of the &%first_delivery%& condition in an &%if%& command in the filter to
33520 prevent it happening on retries.
33521
33522 .vindex "&$domain$&"
33523 .vindex "&$local_part$&"
33524 &*Warning*&: Because the system filter runs just once, variables that are
33525 specific to individual recipient addresses, such as &$local_part$& and
33526 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
33527 you want to run a centrally-specified filter for each recipient address
33528 independently, you can do so by setting up a suitable &(redirect)& router, as
33529 described in section &<<SECTperaddfil>>& below.
33530
33531
33532 .section "Specifying a system filter" "SECID212"
33533 .cindex "uid (user id)" "system filter"
33534 .cindex "gid (group id)" "system filter"
33535 The name of the file that contains the system filter must be specified by
33536 setting &%system_filter%&. If you want the filter to run under a uid and gid
33537 other than root, you must also set &%system_filter_user%& and
33538 &%system_filter_group%& as appropriate. For example:
33539 .code
33540 system_filter = /etc/mail/exim.filter
33541 system_filter_user = exim
33542 .endd
33543 If a system filter generates any deliveries directly to files or pipes (via the
33544 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
33545 specified by setting &%system_filter_file_transport%& and
33546 &%system_filter_pipe_transport%&, respectively. Similarly,
33547 &%system_filter_reply_transport%& must be set to handle any messages generated
33548 by the &%reply%& command.
33549
33550
33551 .section "Testing a system filter" "SECID213"
33552 You can run simple tests of a system filter in the same way as for a user
33553 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
33554 are permitted only in system filters are recognized.
33555
33556 If you want to test the combined effect of a system filter and a user filter,
33557 you can use both &%-bF%& and &%-bf%& on the same command line.
33558
33559
33560
33561 .section "Contents of a system filter" "SECID214"
33562 The language used to specify system filters is the same as for users' filter
33563 files. It is described in the separate end-user document &'Exim's interface to
33564 mail filtering'&. However, there are some additional features that are
33565 available only in system filters; these are described in subsequent sections.
33566 If they are encountered in a user's filter file or when testing with &%-bf%&,
33567 they cause errors.
33568
33569 .cindex "frozen messages" "manual thaw; testing in filter"
33570 There are two special conditions which, though available in users' filter
33571 files, are designed for use in system filters. The condition &%first_delivery%&
33572 is true only for the first attempt at delivering a message, and
33573 &%manually_thawed%& is true only if the message has been frozen, and
33574 subsequently thawed by an admin user. An explicit forced delivery counts as a
33575 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
33576
33577 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
33578 specify an &"unseen"& (non-significant) delivery, and that delivery does not
33579 succeed, it will not be tried again.
33580 If you want Exim to retry an unseen delivery until it succeeds, you should
33581 arrange to set it up every time the filter runs.
33582
33583 When a system filter finishes running, the values of the variables &$n0$& &--
33584 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
33585 users' filter files. Thus a system filter can, for example, set up &"scores"&
33586 to which users' filter files can refer.
33587
33588
33589
33590 .section "Additional variable for system filters" "SECID215"
33591 .vindex "&$recipients$&"
33592 The expansion variable &$recipients$&, containing a list of all the recipients
33593 of the message (separated by commas and white space), is available in system
33594 filters. It is not available in users' filters for privacy reasons.
33595
33596
33597
33598 .section "Defer, freeze, and fail commands for system filters" "SECID216"
33599 .cindex "freezing messages"
33600 .cindex "message" "freezing"
33601 .cindex "message" "forced failure"
33602 .cindex "&%fail%&" "in system filter"
33603 .cindex "&%freeze%& in system filter"
33604 .cindex "&%defer%& in system filter"
33605 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
33606 always available in system filters, but are not normally enabled in users'
33607 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
33608 for the &(redirect)& router.) These commands can optionally be followed by the
33609 word &%text%& and a string containing an error message, for example:
33610 .code
33611 fail text "this message looks like spam to me"
33612 .endd
33613 The keyword &%text%& is optional if the next character is a double quote.
33614
33615 The &%defer%& command defers delivery of the original recipients of the
33616 message. The &%fail%& command causes all the original recipients to be failed,
33617 and a bounce message to be created. The &%freeze%& command suspends all
33618 delivery attempts for the original recipients. In all cases, any new deliveries
33619 that are specified by the filter are attempted as normal after the filter has
33620 run.
33621
33622 The &%freeze%& command is ignored if the message has been manually unfrozen and
33623 not manually frozen since. This means that automatic freezing by a system
33624 filter can be used as a way of checking out suspicious messages. If a message
33625 is found to be all right, manually unfreezing it allows it to be delivered.
33626
33627 .cindex "log" "&%fail%& command log line"
33628 .cindex "&%fail%&" "log line; reducing"
33629 The text given with a fail command is used as part of the bounce message as
33630 well as being written to the log. If the message is quite long, this can fill
33631 up a lot of log space when such failures are common. To reduce the size of the
33632 log message, Exim interprets the text in a special way if it starts with the
33633 two characters &`<<`& and contains &`>>`& later. The text between these two
33634 strings is written to the log, and the rest of the text is used in the bounce
33635 message. For example:
33636 .code
33637 fail "<<filter test 1>>Your message is rejected \
33638      because it contains attachments that we are \
33639      not prepared to receive."
33640 .endd
33641
33642 .cindex "loop" "caused by &%fail%&"
33643 Take great care with the &%fail%& command when basing the decision to fail on
33644 the contents of the message, because the bounce message will of course include
33645 the contents of the original message and will therefore trigger the &%fail%&
33646 command again (causing a mail loop) unless steps are taken to prevent this.
33647 Testing the &%error_message%& condition is one way to prevent this. You could
33648 use, for example
33649 .code
33650 if $message_body contains "this is spam" and not error_message
33651 then fail text "spam is not wanted here" endif
33652 .endd
33653 though of course that might let through unwanted bounce messages. The
33654 alternative is clever checking of the body and/or headers to detect bounces
33655 generated by the filter.
33656
33657 The interpretation of a system filter file ceases after a
33658 &%defer%&,
33659 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
33660 set up earlier in the filter file are honoured, so you can use a sequence such
33661 as
33662 .code
33663 mail ...
33664 freeze
33665 .endd
33666 to send a specified message when the system filter is freezing (or deferring or
33667 failing) a message. The normal deliveries for the message do not, of course,
33668 take place.
33669
33670
33671
33672 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
33673 .cindex "header lines" "adding; in system filter"
33674 .cindex "header lines" "removing; in system filter"
33675 .cindex "filter" "header lines; adding/removing"
33676 Two filter commands that are available only in system filters are:
33677 .code
33678 headers add <string>
33679 headers remove <string>
33680 .endd
33681 The argument for the &%headers add%& is a string that is expanded and then
33682 added to the end of the message's headers. It is the responsibility of the
33683 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
33684 space is ignored, and if the string is otherwise empty, or if the expansion is
33685 forced to fail, the command has no effect.
33686
33687 You can use &"\n"& within the string, followed by white space, to specify
33688 continued header lines. More than one header may be added in one command by
33689 including &"\n"& within the string without any following white space. For
33690 example:
33691 .code
33692 headers add "X-header-1: ....\n  \
33693              continuation of X-header-1 ...\n\
33694              X-header-2: ...."
33695 .endd
33696 Note that the header line continuation white space after the first newline must
33697 be placed before the backslash that continues the input string, because white
33698 space after input continuations is ignored.
33699
33700 The argument for &%headers remove%& is a colon-separated list of header names.
33701 This command applies only to those headers that are stored with the message;
33702 those that are added at delivery time (such as &'Envelope-To:'& and
33703 &'Return-Path:'&) cannot be removed by this means. If there is more than one
33704 header with the same name, they are all removed.
33705
33706 The &%headers%& command in a system filter makes an immediate change to the set
33707 of header lines that was received with the message (with possible additions
33708 from ACL processing). Subsequent commands in the system filter operate on the
33709 modified set, which also forms the basis for subsequent message delivery.
33710 Unless further modified during routing or transporting, this set of headers is
33711 used for all recipients of the message.
33712
33713 During routing and transporting, the variables that refer to the contents of
33714 header lines refer only to those lines that are in this set. Thus, header lines
33715 that are added by a system filter are visible to users' filter files and to all
33716 routers and transports. This contrasts with the manipulation of header lines by
33717 routers and transports, which is not immediate, but which instead is saved up
33718 until the message is actually being written (see section
33719 &<<SECTheadersaddrem>>&).
33720
33721 If the message is not delivered at the first attempt, header lines that were
33722 added by the system filter are stored with the message, and so are still
33723 present at the next delivery attempt. Header lines that were removed are still
33724 present, but marked &"deleted"& so that they are not transported with the
33725 message. For this reason, it is usual to make the &%headers%& command
33726 conditional on &%first_delivery%& so that the set of header lines is not
33727 modified more than once.
33728
33729 Because header modification in a system filter acts immediately, you have to
33730 use an indirect approach if you want to modify the contents of a header line.
33731 For example:
33732 .code
33733 headers add "Old-Subject: $h_subject:"
33734 headers remove "Subject"
33735 headers add "Subject: new subject (was: $h_old-subject:)"
33736 headers remove "Old-Subject"
33737 .endd
33738
33739
33740
33741 .section "Setting an errors address in a system filter" "SECID217"
33742 .cindex "envelope sender"
33743 In a system filter, if a &%deliver%& command is followed by
33744 .code
33745 errors_to <some address>
33746 .endd
33747 in order to change the envelope sender (and hence the error reporting) for that
33748 delivery, any address may be specified. (In a user filter, only the current
33749 user's address can be set.) For example, if some mail is being monitored, you
33750 might use
33751 .code
33752 unseen deliver monitor@spying.example errors_to root@local.example
33753 .endd
33754 to take a copy which would not be sent back to the normal error reporting
33755 address if its delivery failed.
33756
33757
33758
33759 .section "Per-address filtering" "SECTperaddfil"
33760 .vindex "&$domain$&"
33761 .vindex "&$local_part$&"
33762 In contrast to the system filter, which is run just once per message for each
33763 delivery attempt, it is also possible to set up a system-wide filtering
33764 operation that runs once for each recipient address. In this case, variables
33765 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
33766 filter file could be made dependent on them. This is an example of a router
33767 which implements such a filter:
33768 .code
33769 central_filter:
33770   check_local_user
33771   driver = redirect
33772   domains = +local_domains
33773   file = /central/filters/$local_part
33774   no_verify
33775   allow_filter
33776   allow_freeze
33777 .endd
33778 The filter is run in a separate process under its own uid. Therefore, either
33779 &%check_local_user%& must be set (as above), in which case the filter is run as
33780 the local user, or the &%user%& option must be used to specify which user to
33781 use. If both are set, &%user%& overrides.
33782
33783 Care should be taken to ensure that none of the commands in the filter file
33784 specify a significant delivery if the message is to go on to be delivered to
33785 its intended recipient. The router will not then claim to have dealt with the
33786 address, so it will be passed on to subsequent routers to be delivered in the
33787 normal way.
33788 .ecindex IIDsysfil1
33789 .ecindex IIDsysfil2
33790 .ecindex IIDsysfil3
33791
33792
33793
33794
33795
33796
33797 . ////////////////////////////////////////////////////////////////////////////
33798 . ////////////////////////////////////////////////////////////////////////////
33799
33800 .chapter "Message processing" "CHAPmsgproc"
33801 .scindex IIDmesproc "message" "general processing"
33802 Exim performs various transformations on the sender and recipient addresses of
33803 all messages that it handles, and also on the messages' header lines. Some of
33804 these are optional and configurable, while others always take place. All of
33805 this processing, except rewriting as a result of routing, and the addition or
33806 removal of header lines while delivering, happens when a message is received,
33807 before it is placed on Exim's queue.
33808
33809 Some of the automatic processing takes place by default only for
33810 &"locally-originated"& messages. This adjective is used to describe messages
33811 that are not received over TCP/IP, but instead are passed to an Exim process on
33812 its standard input. This includes the interactive &"local SMTP"& case that is
33813 set up by the &%-bs%& command line option.
33814
33815 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
33816 or ::1) are not considered to be locally-originated. Exim does not treat the
33817 loopback interface specially in any way.
33818
33819 If you want the loopback interface to be treated specially, you must ensure
33820 that there are appropriate entries in your ACLs.
33821
33822
33823
33824
33825 .section "Submission mode for non-local messages" "SECTsubmodnon"
33826 .cindex "message" "submission"
33827 .cindex "submission mode"
33828 Processing that happens automatically for locally-originated messages (unless
33829 &%suppress_local_fixups%& is set) can also be requested for messages that are
33830 received over TCP/IP. The term &"submission mode"& is used to describe this
33831 state. Submission mode is set by the modifier
33832 .code
33833 control = submission
33834 .endd
33835 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
33836 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
33837 a local submission, and is normally used when the source of the message is
33838 known to be an MUA running on a client host (as opposed to an MTA). For
33839 example, to set submission mode for messages originating on the IPv4 loopback
33840 interface, you could include the following in the MAIL ACL:
33841 .code
33842 warn  hosts = 127.0.0.1
33843       control = submission
33844 .endd
33845 .cindex "&%sender_retain%& submission option"
33846 There are some options that can be used when setting submission mode. A slash
33847 is used to separate options. For example:
33848 .code
33849 control = submission/sender_retain
33850 .endd
33851 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
33852 true and &%local_from_check%& false for the current incoming message. The first
33853 of these allows an existing &'Sender:'& header in the message to remain, and
33854 the second suppresses the check to ensure that &'From:'& matches the
33855 authenticated sender. With this setting, Exim still fixes up messages by adding
33856 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
33857 attempt to check sender authenticity in header lines.
33858
33859 When &%sender_retain%& is not set, a submission mode setting may specify a
33860 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
33861 example:
33862 .code
33863 control = submission/domain=some.domain
33864 .endd
33865 The domain may be empty. How this value is used is described in sections
33866 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
33867 that allows you to specify the user's full name for inclusion in a created
33868 &'Sender:'& or &'From:'& header line. For example:
33869 .code
33870 accept authenticated = *
33871        control = submission/domain=wonderland.example/\
33872                             name=${lookup {$authenticated_id} \
33873                                    lsearch {/etc/exim/namelist}}
33874 .endd
33875 Because the name may contain any characters, including slashes, the &%name%&
33876 option must be given last. The remainder of the string is used as the name. For
33877 the example above, if &_/etc/exim/namelist_& contains:
33878 .code
33879 bigegg:  Humpty Dumpty
33880 .endd
33881 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
33882 line would be:
33883 .code
33884 Sender: Humpty Dumpty <bigegg@wonderland.example>
33885 .endd
33886 .cindex "return path" "in submission mode"
33887 By default, submission mode forces the return path to the same address as is
33888 used to create the &'Sender:'& header. However, if &%sender_retain%& is
33889 specified, the return path is also left unchanged.
33890
33891 &*Note*&: The changes caused by submission mode take effect after the predata
33892 ACL. This means that any sender checks performed before the fix-ups use the
33893 untrusted sender address specified by the user, not the trusted sender address
33894 specified by submission mode. Although this might be slightly unexpected, it
33895 does mean that you can configure ACL checks to spot that a user is trying to
33896 spoof another's address.
33897
33898 .section "Line endings" "SECTlineendings"
33899 .cindex "line endings"
33900 .cindex "carriage return"
33901 .cindex "linefeed"
33902 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
33903 linefeed) is the line ending for messages transmitted over the Internet using
33904 SMTP over TCP/IP. However, within individual operating systems, different
33905 conventions are used. For example, Unix-like systems use just LF, but others
33906 use CRLF or just CR.
33907
33908 Exim was designed for Unix-like systems, and internally, it stores messages
33909 using the system's convention of a single LF as a line terminator. When
33910 receiving a message, all line endings are translated to this standard format.
33911 Originally, it was thought that programs that passed messages directly to an
33912 MTA within an operating system would use that system's convention. Experience
33913 has shown that this is not the case; for example, there are Unix applications
33914 that use CRLF in this circumstance. For this reason, and for compatibility with
33915 other MTAs, the way Exim handles line endings for all messages is now as
33916 follows:
33917
33918 .ilist
33919 LF not preceded by CR is treated as a line ending.
33920 .next
33921 CR is treated as a line ending; if it is immediately followed by LF, the LF
33922 is ignored.
33923 .next
33924 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
33925 nor a local message in the state where a line containing only a dot is a
33926 terminator.
33927 .next
33928 If a bare CR is encountered within a header line, an extra space is added after
33929 the line terminator so as not to end the header line. The reasoning behind this
33930 is that bare CRs in header lines are most likely either to be mistakes, or
33931 people trying to play silly games.
33932 .next
33933 If the first header line received in a message ends with CRLF, a subsequent
33934 bare LF in a header line is treated in the same way as a bare CR in a header
33935 line.
33936 .endlist
33937
33938
33939
33940
33941
33942 .section "Unqualified addresses" "SECID218"
33943 .cindex "unqualified addresses"
33944 .cindex "address" "qualification"
33945 By default, Exim expects every envelope address it receives from an external
33946 host to be fully qualified. Unqualified addresses cause negative responses to
33947 SMTP commands. However, because SMTP is used as a means of transporting
33948 messages from MUAs running on personal workstations, there is sometimes a
33949 requirement to accept unqualified addresses from specific hosts or IP networks.
33950
33951 Exim has two options that separately control which hosts may send unqualified
33952 sender or recipient addresses in SMTP commands, namely
33953 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
33954 cases, if an unqualified address is accepted, it is qualified by adding the
33955 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
33956
33957 .oindex "&%qualify_domain%&"
33958 .oindex "&%qualify_recipient%&"
33959 Unqualified addresses in header lines are automatically qualified for messages
33960 that are locally originated, unless the &%-bnq%& option is given on the command
33961 line. For messages received over SMTP, unqualified addresses in header lines
33962 are qualified only if unqualified addresses are permitted in SMTP commands. In
33963 other words, such qualification is also controlled by
33964 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
33965
33966
33967
33968
33969 .section "The UUCP From line" "SECID219"
33970 .cindex "&""From""& line"
33971 .cindex "UUCP" "&""From""& line"
33972 .cindex "sender" "address"
33973 .oindex "&%uucp_from_pattern%&"
33974 .oindex "&%uucp_from_sender%&"
33975 .cindex "envelope sender"
33976 .cindex "Sendmail compatibility" "&""From""& line"
33977 Messages that have come from UUCP (and some other applications) often begin
33978 with a line containing the envelope sender and a timestamp, following the word
33979 &"From"&. Examples of two common formats are:
33980 .code
33981 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
33982 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
33983 .endd
33984 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
33985 Exim recognizes such lines at the start of messages that are submitted to it
33986 via the command line (that is, on the standard input). It does not recognize
33987 such lines in incoming SMTP messages, unless the sending host matches
33988 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
33989 and &%ignore_fromline_local%& is set. The recognition is controlled by a
33990 regular expression that is defined by the &%uucp_from_pattern%& option, whose
33991 default value matches the two common cases shown above and puts the address
33992 that follows &"From"& into &$1$&.
33993
33994 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
33995 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
33996 a trusted user, the message's sender address is constructed by expanding the
33997 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
33998 then parsed as an RFC 2822 address. If there is no domain, the local part is
33999 qualified with &%qualify_domain%& unless it is the empty string. However, if
34000 the command line &%-f%& option is used, it overrides the &"From"& line.
34001
34002 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
34003 sender address is not changed. This is also the case for incoming SMTP messages
34004 that are permitted to contain &"From"& lines.
34005
34006 Only one &"From"& line is recognized. If there is more than one, the second is
34007 treated as a data line that starts the body of the message, as it is not valid
34008 as a header line. This also happens if a &"From"& line is present in an
34009 incoming SMTP message from a source that is not permitted to send them.
34010
34011
34012
34013 .section "Resent- header lines" "SECID220"
34014 .cindex "&%Resent-%& header lines"
34015 .cindex "header lines" "Resent-"
34016 RFC 2822 makes provision for sets of header lines starting with the string
34017 &`Resent-`& to be added to a message when it is resent by the original
34018 recipient to somebody else. These headers are &'Resent-Date:'&,
34019 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
34020 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
34021
34022 .blockquote
34023 &'Resent fields are strictly informational. They MUST NOT be used in the normal
34024 processing of replies or other such automatic actions on messages.'&
34025 .endblockquote
34026
34027 This leaves things a bit vague as far as other processing actions such as
34028 address rewriting are concerned. Exim treats &%Resent-%& header lines as
34029 follows:
34030
34031 .ilist
34032 A &'Resent-From:'& line that just contains the login id of the submitting user
34033 is automatically rewritten in the same way as &'From:'& (see below).
34034 .next
34035 If there's a rewriting rule for a particular header line, it is also applied to
34036 &%Resent-%& header lines of the same type. For example, a rule that rewrites
34037 &'From:'& also rewrites &'Resent-From:'&.
34038 .next
34039 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
34040 also removed.
34041 .next
34042 For a locally-submitted message,
34043 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
34044 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
34045 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
34046 included in log lines in this case.
34047 .next
34048 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
34049 &%Resent-%& header lines are present.
34050 .endlist
34051
34052
34053
34054
34055 .section "The Auto-Submitted: header line" "SECID221"
34056 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
34057 includes the header line:
34058 .code
34059 Auto-Submitted: auto-replied
34060 .endd
34061
34062 .section "The Bcc: header line" "SECID222"
34063 .cindex "&'Bcc:'& header line"
34064 If Exim is called with the &%-t%& option, to take recipient addresses from a
34065 message's header, it removes any &'Bcc:'& header line that may exist (after
34066 extracting its addresses). If &%-t%& is not present on the command line, any
34067 existing &'Bcc:'& is not removed.
34068
34069
34070 .section "The Date: header line" "SECID223"
34071 .cindex "&'Date:'& header line"
34072 .cindex "header lines" "Date:"
34073 If a locally-generated or submission-mode message has no &'Date:'& header line,
34074 Exim adds one, using the current date and time, unless the
34075 &%suppress_local_fixups%& control has been specified.
34076
34077 .section "The Delivery-date: header line" "SECID224"
34078 .cindex "&'Delivery-date:'& header line"
34079 .oindex "&%delivery_date_remove%&"
34080 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
34081 set. Exim can be configured to add them to the final delivery of messages. (See
34082 the generic &%delivery_date_add%& transport option.) They should not be present
34083 in messages in transit. If the &%delivery_date_remove%& configuration option is
34084 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
34085 messages.
34086
34087
34088 .section "The Envelope-to: header line" "SECID225"
34089 .cindex "&'Envelope-to:'& header line"
34090 .cindex "header lines" "Envelope-to:"
34091 .oindex "&%envelope_to_remove%&"
34092 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
34093 Exim can be configured to add them to the final delivery of messages. (See the
34094 generic &%envelope_to_add%& transport option.) They should not be present in
34095 messages in transit. If the &%envelope_to_remove%& configuration option is set
34096 (the default), Exim removes &'Envelope-to:'& header lines from incoming
34097 messages.
34098
34099
34100 .section "The From: header line" "SECTthefrohea"
34101 .cindex "&'From:'& header line"
34102 .cindex "header lines" "From:"
34103 .cindex "Sendmail compatibility" "&""From""& line"
34104 .cindex "message" "submission"
34105 .cindex "submission mode"
34106 If a submission-mode message does not contain a &'From:'& header line, Exim
34107 adds one if either of the following conditions is true:
34108
34109 .ilist
34110 The envelope sender address is not empty (that is, this is not a bounce
34111 message). The added header line copies the envelope sender address.
34112 .next
34113 .vindex "&$authenticated_id$&"
34114 The SMTP session is authenticated and &$authenticated_id$& is not empty.
34115 .olist
34116 .vindex "&$qualify_domain$&"
34117 If no domain is specified by the submission control, the local part is
34118 &$authenticated_id$& and the domain is &$qualify_domain$&.
34119 .next
34120 If a non-empty domain is specified by the submission control, the local
34121 part is &$authenticated_id$&, and the domain is the specified domain.
34122 .next
34123 If an empty domain is specified by the submission control,
34124 &$authenticated_id$& is assumed to be the complete address.
34125 .endlist
34126 .endlist
34127
34128 A non-empty envelope sender takes precedence.
34129
34130 If a locally-generated incoming message does not contain a &'From:'& header
34131 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
34132 containing the sender's address. The calling user's login name and full name
34133 are used to construct the address, as described in section &<<SECTconstr>>&.
34134 They are obtained from the password data by calling &[getpwuid()]& (but see the
34135 &%unknown_login%& configuration option). The address is qualified with
34136 &%qualify_domain%&.
34137
34138 For compatibility with Sendmail, if an incoming, non-SMTP message has a
34139 &'From:'& header line containing just the unqualified login name of the calling
34140 user, this is replaced by an address containing the user's login name and full
34141 name as described in section &<<SECTconstr>>&.
34142
34143
34144 .section "The Message-ID: header line" "SECID226"
34145 .cindex "&'Message-ID:'& header line"
34146 .cindex "header lines" "Message-ID:"
34147 .cindex "message" "submission"
34148 .oindex "&%message_id_header_text%&"
34149 If a locally-generated or submission-mode incoming message does not contain a
34150 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
34151 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
34152 to the message. If there are any &'Resent-:'& headers in the message, it
34153 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
34154 message id, preceded by the letter E to ensure it starts with a letter, and
34155 followed by @ and the primary host name. Additional information can be included
34156 in this header line by setting the &%message_id_header_text%& and/or
34157 &%message_id_header_domain%& options.
34158
34159
34160 .section "The Received: header line" "SECID227"
34161 .cindex "&'Received:'& header line"
34162 .cindex "header lines" "Received:"
34163 A &'Received:'& header line is added at the start of every message. The
34164 contents are defined by the &%received_header_text%& configuration option, and
34165 Exim automatically adds a semicolon and a timestamp to the configured string.
34166
34167 The &'Received:'& header is generated as soon as the message's header lines
34168 have been received. At this stage, the timestamp in the &'Received:'& header
34169 line is the time that the message started to be received. This is the value
34170 that is seen by the DATA ACL and by the &[local_scan()]& function.
34171
34172 Once a message is accepted, the timestamp in the &'Received:'& header line is
34173 changed to the time of acceptance, which is (apart from a small delay while the
34174 -H spool file is written) the earliest time at which delivery could start.
34175
34176
34177 .section "The References: header line" "SECID228"
34178 .cindex "&'References:'& header line"
34179 .cindex "header lines" "References:"
34180 Messages created by the &(autoreply)& transport include a &'References:'&
34181 header line. This is constructed according to the rules that are described in
34182 section 3.64 of RFC 2822 (which states that replies should contain such a
34183 header line), and section 3.14 of RFC 3834 (which states that automatic
34184 responses are not different in this respect). However, because some mail
34185 processing software does not cope well with very long header lines, no more
34186 than 12 message IDs are copied from the &'References:'& header line in the
34187 incoming message. If there are more than 12, the first one and then the final
34188 11 are copied, before adding the message ID of the incoming message.
34189
34190
34191
34192 .section "The Return-path: header line" "SECID229"
34193 .cindex "&'Return-path:'& header line"
34194 .cindex "header lines" "Return-path:"
34195 .oindex "&%return_path_remove%&"
34196 &'Return-path:'& header lines are defined as something an MTA may insert when
34197 it does the final delivery of messages. (See the generic &%return_path_add%&
34198 transport option.) Therefore, they should not be present in messages in
34199 transit. If the &%return_path_remove%& configuration option is set (the
34200 default), Exim removes &'Return-path:'& header lines from incoming messages.
34201
34202
34203
34204 .section "The Sender: header line" "SECTthesenhea"
34205 .cindex "&'Sender:'& header line"
34206 .cindex "message" "submission"
34207 .cindex "header lines" "Sender:"
34208 For a locally-originated message from an untrusted user, Exim may remove an
34209 existing &'Sender:'& header line, and it may add a new one. You can modify
34210 these actions by setting the &%local_sender_retain%& option true, the
34211 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
34212 control setting.
34213
34214 When a local message is received from an untrusted user and
34215 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
34216 control has not been set, a check is made to see if the address given in the
34217 &'From:'& header line is the correct (local) sender of the message. The address
34218 that is expected has the login name as the local part and the value of
34219 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
34220 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
34221 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
34222 line is added to the message.
34223
34224 If you set &%local_from_check%& false, this checking does not occur. However,
34225 the removal of an existing &'Sender:'& line still happens, unless you also set
34226 &%local_sender_retain%& to be true. It is not possible to set both of these
34227 options true at the same time.
34228
34229 .cindex "submission mode"
34230 By default, no processing of &'Sender:'& header lines is done for messages
34231 received over TCP/IP or for messages submitted by trusted users. However, when
34232 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
34233 not specified on the submission control, the following processing takes place:
34234
34235 .vindex "&$authenticated_id$&"
34236 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
34237 authenticated, and &$authenticated_id$& is not empty, a sender address is
34238 created as follows:
34239
34240 .ilist
34241 .vindex "&$qualify_domain$&"
34242 If no domain is specified by the submission control, the local part is
34243 &$authenticated_id$& and the domain is &$qualify_domain$&.
34244 .next
34245 If a non-empty domain is specified by the submission control, the local part
34246 is &$authenticated_id$&, and the domain is the specified domain.
34247 .next
34248 If an empty domain is specified by the submission control,
34249 &$authenticated_id$& is assumed to be the complete address.
34250 .endlist
34251
34252 This address is compared with the address in the &'From:'& header line. If they
34253 are different, a &'Sender:'& header line containing the created address is
34254 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
34255 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
34256
34257 .cindex "return path" "created from &'Sender:'&"
34258 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
34259 the message (the envelope sender address) is changed to be the same address,
34260 except in the case of submission mode when &%sender_retain%& is specified.
34261
34262
34263
34264 .section "Adding and removing header lines in routers and transports" &&&
34265          "SECTheadersaddrem"
34266 .cindex "header lines" "adding; in router or transport"
34267 .cindex "header lines" "removing; in router or transport"
34268 When a message is delivered, the addition and removal of header lines can be
34269 specified in a system filter, or on any of the routers and transports that
34270 process the message. Section &<<SECTaddremheasys>>& contains details about
34271 modifying headers in a system filter. Header lines can also be added in an ACL
34272 as a message is received (see section &<<SECTaddheadacl>>&).
34273
34274 In contrast to what happens in a system filter, header modifications that are
34275 specified on routers and transports apply only to the particular recipient
34276 addresses that are being processed by those routers and transports. These
34277 changes do not actually take place until a copy of the message is being
34278 transported. Therefore, they do not affect the basic set of header lines, and
34279 they do not affect the values of the variables that refer to header lines.
34280
34281 &*Note*&: In particular, this means that any expansions in the configuration of
34282 the transport cannot refer to the modified header lines, because such
34283 expansions all occur before the message is actually transported.
34284
34285 For both routers and transports, the argument of a &%headers_add%&
34286 option must be in the form of one or more RFC 2822 header lines, separated by
34287 newlines (coded as &"\n"&). For example:
34288 .code
34289 headers_add = X-added-header: added by $primary_hostname\n\
34290               X-added-second: another added header line
34291 .endd
34292 Exim does not check the syntax of these added header lines.
34293
34294 Multiple &%headers_add%& options for a single router or transport can be
34295 specified; the values will append to a single list of header lines.
34296 Each header-line is separately expanded.
34297
34298 The argument of a &%headers_remove%& option must consist of a colon-separated
34299 list of header names. This is confusing, because header names themselves are
34300 often terminated by colons. In this case, the colons are the list separators,
34301 not part of the names. For example:
34302 .code
34303 headers_remove = return-receipt-to:acknowledge-to
34304 .endd
34305
34306 Multiple &%headers_remove%& options for a single router or transport can be
34307 specified; the arguments will append to a single header-names list.
34308 Each item is separately expanded.
34309 Note that colons in complex expansions which are used to
34310 form all or part of a &%headers_remove%& list
34311 will act as list separators.
34312
34313 When &%headers_add%& or &%headers_remove%& is specified on a router,
34314 items are expanded at routing time,
34315 and then associated with all addresses that are
34316 accepted by that router, and also with any new addresses that it generates. If
34317 an address passes through several routers as a result of aliasing or
34318 forwarding, the changes are cumulative.
34319
34320 .oindex "&%unseen%&"
34321 However, this does not apply to multiple routers that result from the use of
34322 the &%unseen%& option. Any header modifications that were specified by the
34323 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
34324
34325 Addresses that end up with different &%headers_add%& or &%headers_remove%&
34326 settings cannot be delivered together in a batch, so a transport is always
34327 dealing with a set of addresses that have the same header-processing
34328 requirements.
34329
34330 The transport starts by writing the original set of header lines that arrived
34331 with the message, possibly modified by the system filter. As it writes out
34332 these lines, it consults the list of header names that were attached to the
34333 recipient address(es) by &%headers_remove%& options in routers, and it also
34334 consults the transport's own &%headers_remove%& option. Header lines whose
34335 names are on either of these lists are not written out. If there are multiple
34336 instances of any listed header, they are all skipped.
34337
34338 After the remaining original header lines have been written, new header
34339 lines that were specified by routers' &%headers_add%& options are written, in
34340 the order in which they were attached to the address. These are followed by any
34341 header lines specified by the transport's &%headers_add%& option.
34342
34343 This way of handling header line modifications in routers and transports has
34344 the following consequences:
34345
34346 .ilist
34347 The original set of header lines, possibly modified by the system filter,
34348 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
34349 to it, at all times.
34350 .next
34351 Header lines that are added by a router's
34352 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
34353 expansion syntax in subsequent routers or the transport.
34354 .next
34355 Conversely, header lines that are specified for removal by &%headers_remove%&
34356 in a router remain visible to subsequent routers and the transport.
34357 .next
34358 Headers added to an address by &%headers_add%& in a router cannot be removed by
34359 a later router or by a transport.
34360 .next
34361 An added header can refer to the contents of an original header that is to be
34362 removed, even it has the same name as the added header. For example:
34363 .code
34364 headers_remove = subject
34365 headers_add = Subject: new subject (was: $h_subject:)
34366 .endd
34367 .endlist
34368
34369 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
34370 for a &(redirect)& router that has the &%one_time%& option set.
34371
34372
34373
34374
34375
34376 .section "Constructed addresses" "SECTconstr"
34377 .cindex "address" "constructed"
34378 .cindex "constructed address"
34379 When Exim constructs a sender address for a locally-generated message, it uses
34380 the form
34381 .display
34382 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
34383 .endd
34384 For example:
34385 .code
34386 Zaphod Beeblebrox <zaphod@end.univ.example>
34387 .endd
34388 The user name is obtained from the &%-F%& command line option if set, or
34389 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
34390 &"gecos"& field from the password entry. If the &"gecos"& field contains an
34391 ampersand character, this is replaced by the login name with the first letter
34392 upper cased, as is conventional in a number of operating systems. See the
34393 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
34394 The &%unknown_username%& option can be used to specify user names in cases when
34395 there is no password file entry.
34396
34397 .cindex "RFC 2047"
34398 In all cases, the user name is made to conform to RFC 2822 by quoting all or
34399 parts of it if necessary. In addition, if it contains any non-printing
34400 characters, it is encoded as described in RFC 2047, which defines a way of
34401 including non-ASCII characters in header lines. The value of the
34402 &%headers_charset%& option specifies the name of the encoding that is used (the
34403 characters are assumed to be in this encoding). The setting of
34404 &%print_topbitchars%& controls whether characters with the top bit set (that
34405 is, with codes greater than 127) count as printing characters or not.
34406
34407
34408
34409 .section "Case of local parts" "SECID230"
34410 .cindex "case of local parts"
34411 .cindex "local part" "case of"
34412 RFC 2822 states that the case of letters in the local parts of addresses cannot
34413 be assumed to be non-significant. Exim preserves the case of local parts of
34414 addresses, but by default it uses a lower-cased form when it is routing,
34415 because on most Unix systems, usernames are in lower case and case-insensitive
34416 routing is required. However, any particular router can be made to use the
34417 original case for local parts by setting the &%caseful_local_part%& generic
34418 router option.
34419
34420 .cindex "mixed-case login names"
34421 If you must have mixed-case user names on your system, the best way to proceed,
34422 assuming you want case-independent handling of incoming email, is to set up
34423 your first router to convert incoming local parts in your domains to the
34424 correct case by means of a file lookup. For example:
34425 .code
34426 correct_case:
34427   driver = redirect
34428   domains = +local_domains
34429   data = ${lookup{$local_part}cdb\
34430               {/etc/usercased.cdb}{$value}fail}\
34431               @$domain
34432 .endd
34433 For this router, the local part is forced to lower case by the default action
34434 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
34435 up a new local part in the correct case. If you then set &%caseful_local_part%&
34436 on any subsequent routers which process your domains, they will operate on
34437 local parts with the correct case in a case-sensitive manner.
34438
34439
34440
34441 .section "Dots in local parts" "SECID231"
34442 .cindex "dot" "in local part"
34443 .cindex "local part" "dots in"
34444 RFC 2822 forbids empty components in local parts. That is, an unquoted local
34445 part may not begin or end with a dot, nor have two consecutive dots in the
34446 middle. However, it seems that many MTAs do not enforce this, so Exim permits
34447 empty components for compatibility.
34448
34449
34450
34451 .section "Rewriting addresses" "SECID232"
34452 .cindex "rewriting" "addresses"
34453 Rewriting of sender and recipient addresses, and addresses in headers, can
34454 happen automatically, or as the result of configuration options, as described
34455 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
34456 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
34457
34458 Automatic rewriting includes qualification, as mentioned above. The other case
34459 in which it can happen is when an incomplete non-local domain is given. The
34460 routing process may cause this to be expanded into the full domain name. For
34461 example, a header such as
34462 .code
34463 To: hare@teaparty
34464 .endd
34465 might get rewritten as
34466 .code
34467 To: hare@teaparty.wonderland.fict.example
34468 .endd
34469 Rewriting as a result of routing is the one kind of message processing that
34470 does not happen at input time, as it cannot be done until the address has
34471 been routed.
34472
34473 Strictly, one should not do &'any'& deliveries of a message until all its
34474 addresses have been routed, in case any of the headers get changed as a
34475 result of routing. However, doing this in practice would hold up many
34476 deliveries for unreasonable amounts of time, just because one address could not
34477 immediately be routed. Exim therefore does not delay other deliveries when
34478 routing of one or more addresses is deferred.
34479 .ecindex IIDmesproc
34480
34481
34482
34483 . ////////////////////////////////////////////////////////////////////////////
34484 . ////////////////////////////////////////////////////////////////////////////
34485
34486 .chapter "SMTP processing" "CHAPSMTP"
34487 .scindex IIDsmtpproc1 "SMTP" "processing details"
34488 .scindex IIDsmtpproc2 "LMTP" "processing details"
34489 Exim supports a number of different ways of using the SMTP protocol, and its
34490 LMTP variant, which is an interactive protocol for transferring messages into a
34491 closed mail store application. This chapter contains details of how SMTP is
34492 processed. For incoming mail, the following are available:
34493
34494 .ilist
34495 SMTP over TCP/IP (Exim daemon or &'inetd'&);
34496 .next
34497 SMTP over the standard input and output (the &%-bs%& option);
34498 .next
34499 Batched SMTP on the standard input (the &%-bS%& option).
34500 .endlist
34501
34502 For mail delivery, the following are available:
34503
34504 .ilist
34505 SMTP over TCP/IP (the &(smtp)& transport);
34506 .next
34507 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
34508 &"lmtp"&);
34509 .next
34510 LMTP over a pipe to a process running in the local host (the &(lmtp)&
34511 transport);
34512 .next
34513 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
34514 the &%use_bsmtp%& option set).
34515 .endlist
34516
34517 &'Batched SMTP'& is the name for a process in which batches of messages are
34518 stored in or read from files (or pipes), in a format in which SMTP commands are
34519 used to contain the envelope information.
34520
34521
34522
34523 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
34524 .cindex "SMTP" "outgoing over TCP/IP"
34525 .cindex "outgoing SMTP over TCP/IP"
34526 .cindex "LMTP" "over TCP/IP"
34527 .cindex "outgoing LMTP over TCP/IP"
34528 .cindex "EHLO"
34529 .cindex "HELO"
34530 .cindex "SIZE option on MAIL command"
34531 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
34532 The &%protocol%& option selects which protocol is to be used, but the actual
34533 processing is the same in both cases.
34534
34535 If, in response to its EHLO command, Exim is told that the SIZE
34536 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
34537 command. The value of <&'n'&> is the message size plus the value of the
34538 &%size_addition%& option (default 1024) to allow for additions to the message
34539 such as per-transport header lines, or changes made in a
34540 .cindex "transport" "filter"
34541 .cindex "filter" "transport filter"
34542 transport filter. If &%size_addition%& is set negative, the use of SIZE is
34543 suppressed.
34544
34545 If the remote server advertises support for PIPELINING, Exim uses the
34546 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
34547 required for the transaction.
34548
34549 If the remote server advertises support for the STARTTLS command, and Exim
34550 was built to support TLS encryption, it tries to start a TLS session unless the
34551 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
34552 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
34553 is called for verification.
34554
34555 If the remote server advertises support for the AUTH command, Exim scans
34556 the authenticators configuration for any suitable client settings, as described
34557 in chapter &<<CHAPSMTPAUTH>>&.
34558
34559 .cindex "carriage return"
34560 .cindex "linefeed"
34561 Responses from the remote host are supposed to be terminated by CR followed by
34562 LF. However, there are known to be hosts that do not send CR characters, so in
34563 order to be able to interwork with such hosts, Exim treats LF on its own as a
34564 line terminator.
34565
34566 If a message contains a number of different addresses, all those with the same
34567 characteristics (for example, the same envelope sender) that resolve to the
34568 same set of hosts, in the same order, are sent in a single SMTP transaction,
34569 even if they are for different domains, unless there are more than the setting
34570 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
34571 they are split into groups containing no more than &%max_rcpt%&s addresses
34572 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
34573 in parallel sessions. The order of hosts with identical MX values is not
34574 significant when checking whether addresses can be batched in this way.
34575
34576 When the &(smtp)& transport suffers a temporary failure that is not
34577 message-related, Exim updates its transport-specific database, which contains
34578 records indexed by host name that remember which messages are waiting for each
34579 particular host. It also updates the retry database with new retry times.
34580
34581 .cindex "hints database" "retry keys"
34582 Exim's retry hints are based on host name plus IP address, so if one address of
34583 a multi-homed host is broken, it will soon be skipped most of the time.
34584 See the next section for more detail about error handling.
34585
34586 .cindex "SMTP" "passed connection"
34587 .cindex "SMTP" "batching over TCP/IP"
34588 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
34589 looks in the hints database for the transport to see if there are any queued
34590 messages waiting for the host to which it is connected. If it finds one, it
34591 creates a new Exim process using the &%-MC%& option (which can only be used by
34592 a process running as root or the Exim user) and passes the TCP/IP socket to it
34593 so that it can deliver another message using the same socket. The new process
34594 does only those deliveries that are routed to the connected host, and may in
34595 turn pass the socket on to a third process, and so on.
34596
34597 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
34598 limit the number of messages sent down a single TCP/IP connection.
34599
34600 .cindex "asterisk" "after IP address"
34601 The second and subsequent messages delivered down an existing connection are
34602 identified in the main log by the addition of an asterisk after the closing
34603 square bracket of the IP address.
34604
34605
34606
34607
34608 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
34609 .cindex "error" "in outgoing SMTP"
34610 .cindex "SMTP" "errors in outgoing"
34611 .cindex "host" "error"
34612 Three different kinds of error are recognized for outgoing SMTP: host errors,
34613 message errors, and recipient errors.
34614
34615 .vlist
34616 .vitem "&*Host errors*&"
34617 A host error is not associated with a particular message or with a
34618 particular recipient of a message. The host errors are:
34619
34620 .ilist
34621 Connection refused or timed out,
34622 .next
34623 Any error response code on connection,
34624 .next
34625 Any error response code to EHLO or HELO,
34626 .next
34627 Loss of connection at any time, except after &"."&,
34628 .next
34629 I/O errors at any time,
34630 .next
34631 Timeouts during the session, other than in response to MAIL, RCPT or
34632 the &"."& at the end of the data.
34633 .endlist ilist
34634
34635 For a host error, a permanent error response on connection, or in response to
34636 EHLO, causes all addresses routed to the host to be failed. Any other host
34637 error causes all addresses to be deferred, and retry data to be created for the
34638 host. It is not tried again, for any message, until its retry time arrives. If
34639 the current set of addresses are not all delivered in this run (to some
34640 alternative host), the message is added to the list of those waiting for this
34641 host, so if it is still undelivered when a subsequent successful delivery is
34642 made to the host, it will be sent down the same SMTP connection.
34643
34644 .vitem "&*Message errors*&"
34645 .cindex "message" "error"
34646 A message error is associated with a particular message when sent to a
34647 particular host, but not with a particular recipient of the message. The
34648 message errors are:
34649
34650 .ilist
34651 Any error response code to MAIL, DATA, or the &"."& that terminates
34652 the data,
34653 .next
34654 Timeout after MAIL,
34655 .next
34656 Timeout or loss of connection after the &"."& that terminates the data. A
34657 timeout after the DATA command itself is treated as a host error, as is loss of
34658 connection at any other time.
34659 .endlist ilist
34660
34661 For a message error, a permanent error response (5&'xx'&) causes all addresses
34662 to be failed, and a delivery error report to be returned to the sender. A
34663 temporary error response (4&'xx'&), or one of the timeouts, causes all
34664 addresses to be deferred. Retry data is not created for the host, but instead,
34665 a retry record for the combination of host plus message id is created. The
34666 message is not added to the list of those waiting for this host. This ensures
34667 that the failing message will not be sent to this host again until the retry
34668 time arrives. However, other messages that are routed to the host are not
34669 affected, so if it is some property of the message that is causing the error,
34670 it will not stop the delivery of other mail.
34671
34672 If the remote host specified support for the SIZE parameter in its response
34673 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
34674 over-large message will cause a message error because the error arrives as a
34675 response to MAIL.
34676
34677 .vitem "&*Recipient errors*&"
34678 .cindex "recipient" "error"
34679 A recipient error is associated with a particular recipient of a message. The
34680 recipient errors are:
34681
34682 .ilist
34683 Any error response to RCPT,
34684 .next
34685 Timeout after RCPT.
34686 .endlist
34687
34688 For a recipient error, a permanent error response (5&'xx'&) causes the
34689 recipient address to be failed, and a bounce message to be returned to the
34690 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
34691 address to be deferred, and routing retry data to be created for it. This is
34692 used to delay processing of the address in subsequent queue runs, until its
34693 routing retry time arrives. This applies to all messages, but because it
34694 operates only in queue runs, one attempt will be made to deliver a new message
34695 to the failing address before the delay starts to operate. This ensures that,
34696 if the failure is really related to the message rather than the recipient
34697 (&"message too big for this recipient"& is a possible example), other messages
34698 have a chance of getting delivered. If a delivery to the address does succeed,
34699 the retry information gets cleared, so all stuck messages get tried again, and
34700 the retry clock is reset.
34701
34702 The message is not added to the list of those waiting for this host. Use of the
34703 host for other messages is unaffected, and except in the case of a timeout,
34704 other recipients are processed independently, and may be successfully delivered
34705 in the current SMTP session. After a timeout it is of course impossible to
34706 proceed with the session, so all addresses get deferred. However, those other
34707 than the one that failed do not suffer any subsequent retry delays. Therefore,
34708 if one recipient is causing trouble, the others have a chance of getting
34709 through when a subsequent delivery attempt occurs before the failing
34710 recipient's retry time.
34711 .endlist
34712
34713 In all cases, if there are other hosts (or IP addresses) available for the
34714 current set of addresses (for example, from multiple MX records), they are
34715 tried in this run for any undelivered addresses, subject of course to their
34716 own retry data. In other words, recipient error retry data does not take effect
34717 until the next delivery attempt.
34718
34719 Some hosts have been observed to give temporary error responses to every
34720 MAIL command at certain times (&"insufficient space"& has been seen). It
34721 would be nice if such circumstances could be recognized, and defer data for the
34722 host itself created, but this is not possible within the current Exim design.
34723 What actually happens is that retry data for every (host, message) combination
34724 is created.
34725
34726 The reason that timeouts after MAIL and RCPT are treated specially is that
34727 these can sometimes arise as a result of the remote host's verification
34728 procedures. Exim makes this assumption, and treats them as if a temporary error
34729 response had been received. A timeout after &"."& is treated specially because
34730 it is known that some broken implementations fail to recognize the end of the
34731 message if the last character of the last line is a binary zero. Thus, it is
34732 helpful to treat this case as a message error.
34733
34734 Timeouts at other times are treated as host errors, assuming a problem with the
34735 host, or the connection to it. If a timeout after MAIL, RCPT,
34736 or &"."& is really a connection problem, the assumption is that at the next try
34737 the timeout is likely to occur at some other point in the dialogue, causing it
34738 then to be treated as a host error.
34739
34740 There is experimental evidence that some MTAs drop the connection after the
34741 terminating &"."& if they do not like the contents of the message for some
34742 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
34743 should be given. That is why Exim treats this case as a message rather than a
34744 host error, in order not to delay other messages to the same host.
34745
34746
34747
34748
34749 .section "Incoming SMTP messages over TCP/IP" "SECID233"
34750 .cindex "SMTP" "incoming over TCP/IP"
34751 .cindex "incoming SMTP over TCP/IP"
34752 .cindex "inetd"
34753 .cindex "daemon"
34754 Incoming SMTP messages can be accepted in one of two ways: by running a
34755 listening daemon, or by using &'inetd'&. In the latter case, the entry in
34756 &_/etc/inetd.conf_& should be like this:
34757 .code
34758 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
34759 .endd
34760 Exim distinguishes between this case and the case of a locally running user
34761 agent using the &%-bs%& option by checking whether or not the standard input is
34762 a socket. When it is, either the port must be privileged (less than 1024), or
34763 the caller must be root or the Exim user. If any other user passes a socket
34764 with an unprivileged port number, Exim prints a message on the standard error
34765 stream and exits with an error code.
34766
34767 By default, Exim does not make a log entry when a remote host connects or
34768 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
34769 unexpected. It can be made to write such log entries by setting the
34770 &%smtp_connection%& log selector.
34771
34772 .cindex "carriage return"
34773 .cindex "linefeed"
34774 Commands from the remote host are supposed to be terminated by CR followed by
34775 LF. However, there are known to be hosts that do not send CR characters. In
34776 order to be able to interwork with such hosts, Exim treats LF on its own as a
34777 line terminator.
34778 Furthermore, because common code is used for receiving messages from all
34779 sources, a CR on its own is also interpreted as a line terminator. However, the
34780 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
34781
34782 .cindex "EHLO" "invalid data"
34783 .cindex "HELO" "invalid data"
34784 One area that sometimes gives rise to problems concerns the EHLO or
34785 HELO commands. Some clients send syntactically invalid versions of these
34786 commands, which Exim rejects by default. (This is nothing to do with verifying
34787 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
34788 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
34789 match the broken hosts that send invalid commands.
34790
34791 .cindex "SIZE option on MAIL command"
34792 .cindex "MAIL" "SIZE option"
34793 The amount of disk space available is checked whenever SIZE is received on
34794 a MAIL command, independently of whether &%message_size_limit%& or
34795 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
34796 false. A temporary error is given if there is not enough space. If
34797 &%check_spool_space%& is set, the check is for that amount of space plus the
34798 value given with SIZE, that is, it checks that the addition of the incoming
34799 message will not reduce the space below the threshold.
34800
34801 When a message is successfully received, Exim includes the local message id in
34802 its response to the final &"."& that terminates the data. If the remote host
34803 logs this text it can help with tracing what has happened to a message.
34804
34805 The Exim daemon can limit the number of simultaneous incoming connections it is
34806 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
34807 number of simultaneous incoming connections from a single remote host (see the
34808 &%smtp_accept_max_per_host%& option). Additional connection attempts are
34809 rejected using the SMTP temporary error code 421.
34810
34811 The Exim daemon does not rely on the SIGCHLD signal to detect when a
34812 subprocess has finished, as this can get lost at busy times. Instead, it looks
34813 for completed subprocesses every time it wakes up. Provided there are other
34814 things happening (new incoming calls, starts of queue runs), completed
34815 processes will be noticed and tidied away. On very quiet systems you may
34816 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
34817 it will be noticed when the daemon next wakes up.
34818
34819 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
34820 and can also be set up to reject SMTP calls from non-reserved hosts at times of
34821 high system load &-- for details see the &%smtp_accept_reserve%&,
34822 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
34823 applies in both the daemon and &'inetd'& cases.
34824
34825 Exim normally starts a delivery process for each message received, though this
34826 can be varied by means of the &%-odq%& command line option and the
34827 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
34828 number of simultaneously running delivery processes started in this way from
34829 SMTP input can be limited by the &%smtp_accept_queue%& and
34830 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
34831 subsequently received messages are just put on the input queue without starting
34832 a delivery process.
34833
34834 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
34835 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
34836 started up from the &'inetd'& daemon, because in that case each connection is
34837 handled by an entirely independent Exim process. Control by load average is,
34838 however, available with &'inetd'&.
34839
34840 Exim can be configured to verify addresses in incoming SMTP commands as they
34841 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
34842 to rewrite addresses at this time &-- before any syntax checking is done. See
34843 section &<<SECTrewriteS>>&.
34844
34845 Exim can also be configured to limit the rate at which a client host submits
34846 MAIL and RCPT commands in a single SMTP session. See the
34847 &%smtp_ratelimit_hosts%& option.
34848
34849
34850
34851 .section "Unrecognized SMTP commands" "SECID234"
34852 .cindex "SMTP" "unrecognized commands"
34853 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
34854 commands during a single SMTP connection, it drops the connection after sending
34855 the error response to the last command. The default value for
34856 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
34857 abuse that subvert web servers into making connections to SMTP ports; in these
34858 circumstances, a number of non-SMTP lines are sent first.
34859
34860
34861 .section "Syntax and protocol errors in SMTP commands" "SECID235"
34862 .cindex "SMTP" "syntax errors"
34863 .cindex "SMTP" "protocol errors"
34864 A syntax error is detected if an SMTP command is recognized, but there is
34865 something syntactically wrong with its data, for example, a malformed email
34866 address in a RCPT command. Protocol errors include invalid command
34867 sequencing such as RCPT before MAIL. If Exim receives more than
34868 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
34869 drops the connection after sending the error response to the last command. The
34870 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
34871 broken clients that loop sending bad commands (yes, it has been seen).
34872
34873
34874
34875 .section "Use of non-mail SMTP commands" "SECID236"
34876 .cindex "SMTP" "non-mail commands"
34877 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
34878 DATA. Exim counts such commands, and drops the connection if there are too
34879 many of them in a single SMTP session. This action catches some
34880 denial-of-service attempts and things like repeated failing AUTHs, or a mad
34881 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
34882 defines what &"too many"& means. Its default value is 10.
34883
34884 When a new message is expected, one occurrence of RSET is not counted. This
34885 allows a client to send one RSET between messages (this is not necessary,
34886 but some clients do it). Exim also allows one uncounted occurrence of HELO
34887 or EHLO, and one occurrence of STARTTLS between messages. After
34888 starting up a TLS session, another EHLO is expected, and so it too is not
34889 counted.
34890
34891 The first occurrence of AUTH in a connection, or immediately following
34892 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
34893 RCPT, DATA, and QUIT are counted.
34894
34895 You can control which hosts are subject to the limit set by
34896 &%smtp_accept_max_nonmail%& by setting
34897 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
34898 the limit apply to all hosts. This option means that you can exclude any
34899 specific badly-behaved hosts that you have to live with.
34900
34901
34902
34903
34904 .section "The VRFY and EXPN commands" "SECID237"
34905 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
34906 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
34907 appropriate) in order to decide whether the command should be accepted or not.
34908
34909 .cindex "VRFY" "processing"
34910 When no ACL is defined for VRFY, or if it rejects without
34911 setting an explicit response code, the command is accepted
34912 (with a 252 SMTP response code)
34913 in order to support awkward clients that do a VRFY before every RCPT.
34914 When VRFY is accepted, it runs exactly the same code as when Exim is
34915 called with the &%-bv%& option, and returns 250/451/550
34916 SMTP response codes.
34917
34918 .cindex "EXPN" "processing"
34919 If no ACL for EXPN is defined, the command is rejected.
34920 When EXPN is accepted, a single-level expansion of the address is done.
34921 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
34922 than a verification (the &%-bv%& option). If an unqualified local part is given
34923 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
34924 of VRFY and EXPN commands are logged on the main and reject logs, and
34925 VRFY verification failures are logged on the main log for consistency with
34926 RCPT failures.
34927
34928
34929
34930 .section "The ETRN command" "SECTETRN"
34931 .cindex "ETRN" "processing"
34932 RFC 1985 describes an SMTP command called ETRN that is designed to
34933 overcome the security problems of the TURN command (which has fallen into
34934 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
34935 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
34936 should be accepted or not. If no ACL is defined, the command is rejected.
34937
34938 The ETRN command is concerned with &"releasing"& messages that are awaiting
34939 delivery to certain hosts. As Exim does not organize its message queue by host,
34940 the only form of ETRN that is supported by default is the one where the
34941 text starts with the &"#"& prefix, in which case the remainder of the text is
34942 specific to the SMTP server. A valid ETRN command causes a run of Exim with
34943 the &%-R%& option to happen, with the remainder of the ETRN text as its
34944 argument. For example,
34945 .code
34946 ETRN #brigadoon
34947 .endd
34948 runs the command
34949 .code
34950 exim -R brigadoon
34951 .endd
34952 which causes a delivery attempt on all messages with undelivered addresses
34953 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
34954 default), Exim prevents the simultaneous execution of more than one queue run
34955 for the same argument string as a result of an ETRN command. This stops
34956 a misbehaving client from starting more than one queue runner at once.
34957
34958 .cindex "hints database" "ETRN serialization"
34959 Exim implements the serialization by means of a hints database in which a
34960 record is written whenever a process is started by ETRN, and deleted when
34961 the process completes. However, Exim does not keep the SMTP session waiting for
34962 the ETRN process to complete. Once ETRN is accepted, the client is sent
34963 a &"success"& return code. Obviously there is scope for hints records to get
34964 left lying around if there is a system or program crash. To guard against this,
34965 Exim ignores any records that are more than six hours old.
34966
34967 .oindex "&%smtp_etrn_command%&"
34968 For more control over what ETRN does, the &%smtp_etrn_command%& option can
34969 used. This specifies a command that is run whenever ETRN is received,
34970 whatever the form of its argument. For
34971 example:
34972 .code
34973 smtp_etrn_command = /etc/etrn_command $domain \
34974                     $sender_host_address
34975 .endd
34976 .vindex "&$domain$&"
34977 The string is split up into arguments which are independently expanded. The
34978 expansion variable &$domain$& is set to the argument of the ETRN command,
34979 and no syntax checking is done on the contents of this argument. Exim does not
34980 wait for the command to complete, so its status code is not checked. Exim runs
34981 under its own uid and gid when receiving incoming SMTP, so it is not possible
34982 for it to change them before running the command.
34983
34984
34985
34986 .section "Incoming local SMTP" "SECID238"
34987 .cindex "SMTP" "local incoming"
34988 Some user agents use SMTP to pass messages to their local MTA using the
34989 standard input and output, as opposed to passing the envelope on the command
34990 line and writing the message to the standard input. This is supported by the
34991 &%-bs%& option. This form of SMTP is handled in the same way as incoming
34992 messages over TCP/IP (including the use of ACLs), except that the envelope
34993 sender given in a MAIL command is ignored unless the caller is trusted. In
34994 an ACL you can detect this form of SMTP input by testing for an empty host
34995 identification. It is common to have this as the first line in the ACL that
34996 runs for RCPT commands:
34997 .code
34998 accept hosts = :
34999 .endd
35000 This accepts SMTP messages from local processes without doing any other tests.
35001
35002
35003
35004 .section "Outgoing batched SMTP" "SECTbatchSMTP"
35005 .cindex "SMTP" "batched outgoing"
35006 .cindex "batched SMTP output"
35007 Both the &(appendfile)& and &(pipe)& transports can be used for handling
35008 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
35009 be output in BSMTP format. No SMTP responses are possible for this form of
35010 delivery. All it is doing is using SMTP commands as a way of transmitting the
35011 envelope along with the message.
35012
35013 The message is written to the file or pipe preceded by the SMTP commands
35014 MAIL and RCPT, and followed by a line containing a single dot. Lines in
35015 the message that start with a dot have an extra dot added. The SMTP command
35016 HELO is not normally used. If it is required, the &%message_prefix%& option
35017 can be used to specify it.
35018
35019 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
35020 one recipient address at a time by default. However, you can arrange for them
35021 to handle several addresses at once by setting the &%batch_max%& option. When
35022 this is done for BSMTP, messages may contain multiple RCPT commands. See
35023 chapter &<<CHAPbatching>>& for more details.
35024
35025 .vindex "&$host$&"
35026 When one or more addresses are routed to a BSMTP transport by a router that
35027 sets up a host list, the name of the first host on the list is available to the
35028 transport in the variable &$host$&. Here is an example of such a transport and
35029 router:
35030 .code
35031 begin routers
35032 route_append:
35033   driver = manualroute
35034   transport = smtp_appendfile
35035   route_list = domain.example  batch.host.example
35036
35037 begin transports
35038 smtp_appendfile:
35039   driver = appendfile
35040   directory = /var/bsmtp/$host
35041   batch_max = 1000
35042   use_bsmtp
35043   user = exim
35044 .endd
35045 This causes messages addressed to &'domain.example'& to be written in BSMTP
35046 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
35047 message (unless there are more than 1000 recipients).
35048
35049
35050
35051 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
35052 .cindex "SMTP" "batched incoming"
35053 .cindex "batched SMTP input"
35054 The &%-bS%& command line option causes Exim to accept one or more messages by
35055 reading SMTP on the standard input, but to generate no responses. If the caller
35056 is trusted, the senders in the MAIL commands are believed; otherwise the
35057 sender is always the caller of Exim. Unqualified senders and receivers are not
35058 rejected (there seems little point) but instead just get qualified. HELO
35059 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
35060 as NOOP; QUIT quits.
35061
35062 Minimal policy checking is done for BSMTP input. Only the non-SMTP
35063 ACL is run in the same way as for non-SMTP local input.
35064
35065 If an error is detected while reading a message, including a missing &"."& at
35066 the end, Exim gives up immediately. It writes details of the error to the
35067 standard output in a stylized way that the calling program should be able to
35068 make some use of automatically, for example:
35069 .code
35070 554 Unexpected end of file
35071 Transaction started in line 10
35072 Error detected in line 14
35073 .endd
35074 It writes a more verbose version, for human consumption, to the standard error
35075 file, for example:
35076 .code
35077 An error was detected while processing a file of BSMTP input.
35078 The error message was:
35079
35080 501 '>' missing at end of address
35081
35082 The SMTP transaction started in line 10.
35083 The error was detected in line 12.
35084 The SMTP command at fault was:
35085
35086 rcpt to:<malformed@in.com.plete
35087
35088 1 previous message was successfully processed.
35089 The rest of the batch was abandoned.
35090 .endd
35091 The return code from Exim is zero only if there were no errors. It is 1 if some
35092 messages were accepted before an error was detected, and 2 if no messages were
35093 accepted.
35094 .ecindex IIDsmtpproc1
35095 .ecindex IIDsmtpproc2
35096
35097
35098
35099 . ////////////////////////////////////////////////////////////////////////////
35100 . ////////////////////////////////////////////////////////////////////////////
35101
35102 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
35103          "Customizing messages"
35104 When a message fails to be delivered, or remains on the queue for more than a
35105 configured amount of time, Exim sends a message to the original sender, or
35106 to an alternative configured address. The text of these messages is built into
35107 the code of Exim, but it is possible to change it, either by adding a single
35108 string, or by replacing each of the paragraphs by text supplied in a file.
35109
35110 The &'From:'& and &'To:'& header lines are automatically generated; you can
35111 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
35112 option. Exim also adds the line
35113 .code
35114 Auto-Submitted: auto-generated
35115 .endd
35116 to all warning and bounce messages,
35117
35118
35119 .section "Customizing bounce messages" "SECID239"
35120 .cindex "customizing" "bounce message"
35121 .cindex "bounce message" "customizing"
35122 If &%bounce_message_text%& is set, its contents are included in the default
35123 message immediately after &"This message was created automatically by mail
35124 delivery software."& The string is not expanded. It is not used if
35125 &%bounce_message_file%& is set.
35126
35127 When &%bounce_message_file%& is set, it must point to a template file for
35128 constructing error messages. The file consists of a series of text items,
35129 separated by lines consisting of exactly four asterisks. If the file cannot be
35130 opened, default text is used and a message is written to the main and panic
35131 logs. If any text item in the file is empty, default text is used for that
35132 item.
35133
35134 .vindex "&$bounce_recipient$&"
35135 .vindex "&$bounce_return_size_limit$&"
35136 Each item of text that is read from the file is expanded, and there are two
35137 expansion variables which can be of use here: &$bounce_recipient$& is set to
35138 the recipient of an error message while it is being created, and
35139 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
35140 option, rounded to a whole number.
35141
35142 The items must appear in the file in the following order:
35143
35144 .ilist
35145 The first item is included in the headers, and should include at least a
35146 &'Subject:'& header. Exim does not check the syntax of these headers.
35147 .next
35148 The second item forms the start of the error message. After it, Exim lists the
35149 failing addresses with their error messages.
35150 .next
35151 The third item is used to introduce any text from pipe transports that is to be
35152 returned to the sender. It is omitted if there is no such text.
35153 .next
35154 The fourth, fifth and sixth items will be ignored and may be empty.
35155 The fields exist for back-compatibility
35156 .endlist
35157
35158 The default state (&%bounce_message_file%& unset) is equivalent to the
35159 following file, in which the sixth item is empty. The &'Subject:'& and some
35160 other lines have been split in order to fit them on the page:
35161 .code
35162 Subject: Mail delivery failed
35163   ${if eq{$sender_address}{$bounce_recipient}
35164   {: returning message to sender}}
35165 ****
35166 This message was created automatically by mail delivery software.
35167
35168 A message ${if eq{$sender_address}{$bounce_recipient}
35169   {that you sent }{sent by
35170
35171 <$sender_address>
35172
35173 }}could not be delivered to all of its recipients.
35174 This is a permanent error. The following address(es) failed:
35175 ****
35176 The following text was generated during the delivery attempt(s):
35177 ****
35178 ------ This is a copy of the message, including all the headers.
35179   ------
35180 ****
35181 ------ The body of the message is $message_size characters long;
35182   only the first
35183 ------ $bounce_return_size_limit or so are included here.
35184 ****
35185 .endd
35186 .section "Customizing warning messages" "SECTcustwarn"
35187 .cindex "customizing" "warning message"
35188 .cindex "warning of delay" "customizing the message"
35189 The option &%warn_message_file%& can be pointed at a template file for use when
35190 warnings about message delays are created. In this case there are only three
35191 text sections:
35192
35193 .ilist
35194 The first item is included in the headers, and should include at least a
35195 &'Subject:'& header. Exim does not check the syntax of these headers.
35196 .next
35197 The second item forms the start of the warning message. After it, Exim lists
35198 the delayed addresses.
35199 .next
35200 The third item then ends the message.
35201 .endlist
35202
35203 The default state is equivalent to the following file, except that some lines
35204 have been split here, in order to fit them on the page:
35205 .code
35206 Subject: Warning: message $message_exim_id delayed
35207   $warn_message_delay
35208 ****
35209 This message was created automatically by mail delivery software.
35210
35211 A message ${if eq{$sender_address}{$warn_message_recipients}
35212 {that you sent }{sent by
35213
35214 <$sender_address>
35215
35216 }}has not been delivered to all of its recipients after
35217 more than $warn_message_delay on the queue on $primary_hostname.
35218
35219 The message identifier is:     $message_exim_id
35220 The subject of the message is: $h_subject
35221 The date of the message is:    $h_date
35222
35223 The following address(es) have not yet been delivered:
35224 ****
35225 No action is required on your part. Delivery attempts will
35226 continue for some time, and this warning may be repeated at
35227 intervals if the message remains undelivered. Eventually the
35228 mail delivery software will give up, and when that happens,
35229 the message will be returned to you.
35230 .endd
35231 .vindex "&$warn_message_delay$&"
35232 .vindex "&$warn_message_recipients$&"
35233 However, in the default state the subject and date lines are omitted if no
35234 appropriate headers exist. During the expansion of this file,
35235 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
35236 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
35237 of recipients for the warning message. There may be more than one if there are
35238 multiple addresses with different &%errors_to%& settings on the routers that
35239 handled them.
35240
35241
35242
35243
35244 . ////////////////////////////////////////////////////////////////////////////
35245 . ////////////////////////////////////////////////////////////////////////////
35246
35247 .chapter "Some common configuration settings" "CHAPcomconreq"
35248 This chapter discusses some configuration settings that seem to be fairly
35249 common. More examples and discussion can be found in the Exim book.
35250
35251
35252
35253 .section "Sending mail to a smart host" "SECID240"
35254 .cindex "smart host" "example router"
35255 If you want to send all mail for non-local domains to a &"smart host"&, you
35256 should replace the default &(dnslookup)& router with a router which does the
35257 routing explicitly:
35258 .code
35259 send_to_smart_host:
35260   driver = manualroute
35261   route_list = !+local_domains smart.host.name
35262   transport = remote_smtp
35263 .endd
35264 You can use the smart host's IP address instead of the name if you wish.
35265 If you are using Exim only to submit messages to a smart host, and not for
35266 receiving incoming messages, you can arrange for it to do the submission
35267 synchronously by setting the &%mua_wrapper%& option (see chapter
35268 &<<CHAPnonqueueing>>&).
35269
35270
35271
35272
35273 .section "Using Exim to handle mailing lists" "SECTmailinglists"
35274 .cindex "mailing lists"
35275 Exim can be used to run simple mailing lists, but for large and/or complicated
35276 requirements, the use of additional specialized mailing list software such as
35277 Majordomo or Mailman is recommended.
35278
35279 The &(redirect)& router can be used to handle mailing lists where each list
35280 is maintained in a separate file, which can therefore be managed by an
35281 independent manager. The &%domains%& router option can be used to run these
35282 lists in a separate domain from normal mail. For example:
35283 .code
35284 lists:
35285   driver = redirect
35286   domains = lists.example
35287   file = /usr/lists/$local_part
35288   forbid_pipe
35289   forbid_file
35290   errors_to = $local_part-request@lists.example
35291   no_more
35292 .endd
35293 This router is skipped for domains other than &'lists.example'&. For addresses
35294 in that domain, it looks for a file that matches the local part. If there is no
35295 such file, the router declines, but because &%no_more%& is set, no subsequent
35296 routers are tried, and so the whole delivery fails.
35297
35298 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
35299 expanded into a file name or a pipe delivery, which is usually inappropriate in
35300 a mailing list.
35301
35302 .oindex "&%errors_to%&"
35303 The &%errors_to%& option specifies that any delivery errors caused by addresses
35304 taken from a mailing list are to be sent to the given address rather than the
35305 original sender of the message. However, before acting on this, Exim verifies
35306 the error address, and ignores it if verification fails.
35307
35308 For example, using the configuration above, mail sent to
35309 &'dicts@lists.example'& is passed on to those addresses contained in
35310 &_/usr/lists/dicts_&, with error reports directed to
35311 &'dicts-request@lists.example'&, provided that this address can be verified.
35312 There could be a file called &_/usr/lists/dicts-request_& containing
35313 the address(es) of this particular list's manager(s), but other approaches,
35314 such as setting up an earlier router (possibly using the &%local_part_prefix%&
35315 or &%local_part_suffix%& options) to handle addresses of the form
35316 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
35317
35318
35319
35320 .section "Syntax errors in mailing lists" "SECID241"
35321 .cindex "mailing lists" "syntax errors in"
35322 If an entry in redirection data contains a syntax error, Exim normally defers
35323 delivery of the original address. That means that a syntax error in a mailing
35324 list holds up all deliveries to the list. This may not be appropriate when a
35325 list is being maintained automatically from data supplied by users, and the
35326 addresses are not rigorously checked.
35327
35328 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
35329 entries that fail to parse, noting the incident in the log. If in addition
35330 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
35331 whenever a broken address is skipped. It is usually appropriate to set
35332 &%syntax_errors_to%& to the same address as &%errors_to%&.
35333
35334
35335
35336 .section "Re-expansion of mailing lists" "SECID242"
35337 .cindex "mailing lists" "re-expansion of"
35338 Exim remembers every individual address to which a message has been delivered,
35339 in order to avoid duplication, but it normally stores only the original
35340 recipient addresses with a message. If all the deliveries to a mailing list
35341 cannot be done at the first attempt, the mailing list is re-expanded when the
35342 delivery is next tried. This means that alterations to the list are taken into
35343 account at each delivery attempt, so addresses that have been added to
35344 the list since the message arrived will therefore receive a copy of the
35345 message, even though it pre-dates their subscription.
35346
35347 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
35348 on the &(redirect)& router. If this is done, any addresses generated by the
35349 router that fail to deliver at the first attempt are added to the message as
35350 &"top level"& addresses, and the parent address that generated them is marked
35351 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
35352 subsequent delivery attempts. The disadvantage of this is that if any of the
35353 failing addresses are incorrect, correcting them in the file has no effect on
35354 pre-existing messages.
35355
35356 The original top-level address is remembered with each of the generated
35357 addresses, and is output in any log messages. However, any intermediate parent
35358 addresses are not recorded. This makes a difference to the log only if the
35359 &%all_parents%& selector is set, but for mailing lists there is normally only
35360 one level of expansion anyway.
35361
35362
35363
35364 .section "Closed mailing lists" "SECID243"
35365 .cindex "mailing lists" "closed"
35366 The examples so far have assumed open mailing lists, to which anybody may
35367 send mail. It is also possible to set up closed lists, where mail is accepted
35368 from specified senders only. This is done by making use of the generic
35369 &%senders%& option to restrict the router that handles the list.
35370
35371 The following example uses the same file as a list of recipients and as a list
35372 of permitted senders. It requires three routers:
35373 .code
35374 lists_request:
35375   driver = redirect
35376   domains = lists.example
35377   local_part_suffix = -request
35378   file = /usr/lists/$local_part$local_part_suffix
35379   no_more
35380
35381 lists_post:
35382   driver = redirect
35383   domains = lists.example
35384   senders = ${if exists {/usr/lists/$local_part}\
35385              {lsearch;/usr/lists/$local_part}{*}}
35386   file = /usr/lists/$local_part
35387   forbid_pipe
35388   forbid_file
35389   errors_to = $local_part-request@lists.example
35390   no_more
35391
35392 lists_closed:
35393   driver = redirect
35394   domains = lists.example
35395   allow_fail
35396   data = :fail: $local_part@lists.example is a closed mailing list
35397 .endd
35398 All three routers have the same &%domains%& setting, so for any other domains,
35399 they are all skipped. The first router runs only if the local part ends in
35400 &%-request%&. It handles messages to the list manager(s) by means of an open
35401 mailing list.
35402
35403 The second router runs only if the &%senders%& precondition is satisfied. It
35404 checks for the existence of a list that corresponds to the local part, and then
35405 checks that the sender is on the list by means of a linear search. It is
35406 necessary to check for the existence of the file before trying to search it,
35407 because otherwise Exim thinks there is a configuration error. If the file does
35408 not exist, the expansion of &%senders%& is *, which matches all senders. This
35409 means that the router runs, but because there is no list, declines, and
35410 &%no_more%& ensures that no further routers are run. The address fails with an
35411 &"unrouteable address"& error.
35412
35413 The third router runs only if the second router is skipped, which happens when
35414 a mailing list exists, but the sender is not on it. This router forcibly fails
35415 the address, giving a suitable error message.
35416
35417
35418
35419
35420 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
35421 .cindex "VERP"
35422 .cindex "Variable Envelope Return Paths"
35423 .cindex "envelope sender"
35424 Variable Envelope Return Paths &-- see &url(http://cr.yp.to/proto/verp.txt) &--
35425 are a way of helping mailing list administrators discover which subscription
35426 address is the cause of a particular delivery failure. The idea is to encode
35427 the original recipient address in the outgoing envelope sender address, so that
35428 if the message is forwarded by another host and then subsequently bounces, the
35429 original recipient can be extracted from the recipient address of the bounce.
35430
35431 .oindex &%errors_to%&
35432 .oindex &%return_path%&
35433 Envelope sender addresses can be modified by Exim using two different
35434 facilities: the &%errors_to%& option on a router (as shown in previous mailing
35435 list examples), or the &%return_path%& option on a transport. The second of
35436 these is effective only if the message is successfully delivered to another
35437 host; it is not used for errors detected on the local host (see the description
35438 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
35439 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
35440 .code
35441 verp_smtp:
35442   driver = smtp
35443   max_rcpt = 1
35444   return_path = \
35445     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
35446       {$1-request+$local_part=$domain@your.dom.example}fail}
35447 .endd
35448 This has the effect of rewriting the return path (envelope sender) on outgoing
35449 SMTP messages, if the local part of the original return path ends in
35450 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
35451 local part and domain of the recipient into the return path. Suppose, for
35452 example, that a message whose return path has been set to
35453 &'somelist-request@your.dom.example'& is sent to
35454 &'subscriber@other.dom.example'&. In the transport, the return path is
35455 rewritten as
35456 .code
35457 somelist-request+subscriber=other.dom.example@your.dom.example
35458 .endd
35459 .vindex "&$local_part$&"
35460 For this to work, you must tell Exim to send multiple copies of messages that
35461 have more than one recipient, so that each copy has just one recipient. This is
35462 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
35463 might be sent to several different recipients in the same domain, in which case
35464 &$local_part$& is not available in the transport, because it is not unique.
35465
35466 Unless your host is doing nothing but mailing list deliveries, you should
35467 probably use a separate transport for the VERP deliveries, so as not to use
35468 extra resources in making one-per-recipient copies for other deliveries. This
35469 can easily be done by expanding the &%transport%& option in the router:
35470 .code
35471 dnslookup:
35472   driver = dnslookup
35473   domains = ! +local_domains
35474   transport = \
35475     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
35476       {verp_smtp}{remote_smtp}}
35477   no_more
35478 .endd
35479 If you want to change the return path using &%errors_to%& in a router instead
35480 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
35481 routers that handle mailing list addresses. This will ensure that all delivery
35482 errors, including those detected on the local host, are sent to the VERP
35483 address.
35484
35485 On a host that does no local deliveries and has no manual routing, only the
35486 &(dnslookup)& router needs to be changed. A special transport is not needed for
35487 SMTP deliveries. Every mailing list recipient has its own return path value,
35488 and so Exim must hand them to the transport one at a time. Here is an example
35489 of a &(dnslookup)& router that implements VERP:
35490 .code
35491 verp_dnslookup:
35492   driver = dnslookup
35493   domains = ! +local_domains
35494   transport = remote_smtp
35495   errors_to = \
35496     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
35497      {$1-request+$local_part=$domain@your.dom.example}fail}
35498   no_more
35499 .endd
35500 Before you start sending out messages with VERPed return paths, you must also
35501 configure Exim to accept the bounce messages that come back to those paths.
35502 Typically this is done by setting a &%local_part_suffix%& option for a
35503 router, and using this to route the messages to wherever you want to handle
35504 them.
35505
35506 The overhead incurred in using VERP depends very much on the size of the
35507 message, the number of recipient addresses that resolve to the same remote
35508 host, and the speed of the connection over which the message is being sent. If
35509 a lot of addresses resolve to the same host and the connection is slow, sending
35510 a separate copy of the message for each address may take substantially longer
35511 than sending a single copy with many recipients (for which VERP cannot be
35512 used).
35513
35514
35515
35516
35517
35518
35519 .section "Virtual domains" "SECTvirtualdomains"
35520 .cindex "virtual domains"
35521 .cindex "domain" "virtual"
35522 The phrase &'virtual domain'& is unfortunately used with two rather different
35523 meanings:
35524
35525 .ilist
35526 A domain for which there are no real mailboxes; all valid local parts are
35527 aliases for other email addresses. Common examples are organizational
35528 top-level domains and &"vanity"& domains.
35529 .next
35530 One of a number of independent domains that are all handled by the same host,
35531 with mailboxes on that host, but where the mailbox owners do not necessarily
35532 have login accounts on that host.
35533 .endlist
35534
35535 The first usage is probably more common, and does seem more &"virtual"& than
35536 the second. This kind of domain can be handled in Exim with a straightforward
35537 aliasing router. One approach is to create a separate alias file for each
35538 virtual domain. Exim can test for the existence of the alias file to determine
35539 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
35540 to a router of this form:
35541 .code
35542 virtual:
35543   driver = redirect
35544   domains = dsearch;/etc/mail/virtual
35545   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
35546   no_more
35547 .endd
35548 The &%domains%& option specifies that the router is to be skipped, unless there
35549 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
35550 domain that is being processed. When the router runs, it looks up the local
35551 part in the file to find a new address (or list of addresses). The &%no_more%&
35552 setting ensures that if the lookup fails (leading to &%data%& being an empty
35553 string), Exim gives up on the address without trying any subsequent routers.
35554
35555 This one router can handle all the virtual domains because the alias file names
35556 follow a fixed pattern. Permissions can be arranged so that appropriate people
35557 can edit the different alias files. A successful aliasing operation results in
35558 a new envelope recipient address, which is then routed from scratch.
35559
35560 The other kind of &"virtual"& domain can also be handled in a straightforward
35561 way. One approach is to create a file for each domain containing a list of
35562 valid local parts, and use it in a router like this:
35563 .code
35564 my_domains:
35565   driver = accept
35566   domains = dsearch;/etc/mail/domains
35567   local_parts = lsearch;/etc/mail/domains/$domain
35568   transport = my_mailboxes
35569 .endd
35570 The address is accepted if there is a file for the domain, and the local part
35571 can be found in the file. The &%domains%& option is used to check for the
35572 file's existence because &%domains%& is tested before the &%local_parts%&
35573 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
35574 because that option is tested after &%local_parts%&. The transport is as
35575 follows:
35576 .code
35577 my_mailboxes:
35578   driver = appendfile
35579   file = /var/mail/$domain/$local_part
35580   user = mail
35581 .endd
35582 This uses a directory of mailboxes for each domain. The &%user%& setting is
35583 required, to specify which uid is to be used for writing to the mailboxes.
35584
35585 The configuration shown here is just one example of how you might support this
35586 requirement. There are many other ways this kind of configuration can be set
35587 up, for example, by using a database instead of separate files to hold all the
35588 information about the domains.
35589
35590
35591
35592 .section "Multiple user mailboxes" "SECTmulbox"
35593 .cindex "multiple mailboxes"
35594 .cindex "mailbox" "multiple"
35595 .cindex "local part" "prefix"
35596 .cindex "local part" "suffix"
35597 Heavy email users often want to operate with multiple mailboxes, into which
35598 incoming mail is automatically sorted. A popular way of handling this is to
35599 allow users to use multiple sender addresses, so that replies can easily be
35600 identified. Users are permitted to add prefixes or suffixes to their local
35601 parts for this purpose. The wildcard facility of the generic router options
35602 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
35603 example, consider this router:
35604 .code
35605 userforward:
35606   driver = redirect
35607   check_local_user
35608   file = $home/.forward
35609   local_part_suffix = -*
35610   local_part_suffix_optional
35611   allow_filter
35612 .endd
35613 .vindex "&$local_part_suffix$&"
35614 It runs a user's &_.forward_& file for all local parts of the form
35615 &'username-*'&. Within the filter file the user can distinguish different
35616 cases by testing the variable &$local_part_suffix$&. For example:
35617 .code
35618 if $local_part_suffix contains -special then
35619 save /home/$local_part/Mail/special
35620 endif
35621 .endd
35622 If the filter file does not exist, or does not deal with such addresses, they
35623 fall through to subsequent routers, and, assuming no subsequent use of the
35624 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
35625 control over which suffixes are valid.
35626
35627 Alternatively, a suffix can be used to trigger the use of a different
35628 &_.forward_& file &-- which is the way a similar facility is implemented in
35629 another MTA:
35630 .code
35631 userforward:
35632   driver = redirect
35633   check_local_user
35634   file = $home/.forward$local_part_suffix
35635   local_part_suffix = -*
35636   local_part_suffix_optional
35637   allow_filter
35638 .endd
35639 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
35640 example, &_.forward-special_& is used. Once again, if the appropriate file
35641 does not exist, or does not deal with the address, it is passed on to
35642 subsequent routers, which could, if required, look for an unqualified
35643 &_.forward_& file to use as a default.
35644
35645
35646
35647 .section "Simplified vacation processing" "SECID244"
35648 .cindex "vacation processing"
35649 The traditional way of running the &'vacation'& program is for a user to set up
35650 a pipe command in a &_.forward_& file
35651 (see section &<<SECTspecitredli>>& for syntax details).
35652 This is prone to error by inexperienced users. There are two features of Exim
35653 that can be used to make this process simpler for users:
35654
35655 .ilist
35656 A local part prefix such as &"vacation-"& can be specified on a router which
35657 can cause the message to be delivered directly to the &'vacation'& program, or
35658 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
35659 &_.forward_& file are then much simpler. For example:
35660 .code
35661 spqr, vacation-spqr
35662 .endd
35663 .next
35664 The &%require_files%& generic router option can be used to trigger a
35665 vacation delivery by checking for the existence of a certain file in the
35666 user's home directory. The &%unseen%& generic option should also be used, to
35667 ensure that the original delivery also proceeds. In this case, all the user has
35668 to do is to create a file called, say, &_.vacation_&, containing a vacation
35669 message.
35670 .endlist
35671
35672 Another advantage of both these methods is that they both work even when the
35673 use of arbitrary pipes by users is locked out.
35674
35675
35676
35677 .section "Taking copies of mail" "SECID245"
35678 .cindex "message" "copying every"
35679 Some installations have policies that require archive copies of all messages to
35680 be made. A single copy of each message can easily be taken by an appropriate
35681 command in a system filter, which could, for example, use a different file for
35682 each day's messages.
35683
35684 There is also a shadow transport mechanism that can be used to take copies of
35685 messages that are successfully delivered by local transports, one copy per
35686 delivery. This could be used, &'inter alia'&, to implement automatic
35687 notification of delivery by sites that insist on doing such things.
35688
35689
35690
35691 .section "Intermittently connected hosts" "SECID246"
35692 .cindex "intermittently connected hosts"
35693 It has become quite common (because it is cheaper) for hosts to connect to the
35694 Internet periodically rather than remain connected all the time. The normal
35695 arrangement is that mail for such hosts accumulates on a system that is
35696 permanently connected.
35697
35698 Exim was designed for use on permanently connected hosts, and so it is not
35699 particularly well-suited to use in an intermittently connected environment.
35700 Nevertheless there are some features that can be used.
35701
35702
35703 .section "Exim on the upstream server host" "SECID247"
35704 It is tempting to arrange for incoming mail for the intermittently connected
35705 host to remain on Exim's queue until the client connects. However, this
35706 approach does not scale very well. Two different kinds of waiting message are
35707 being mixed up in the same queue &-- those that cannot be delivered because of
35708 some temporary problem, and those that are waiting for their destination host
35709 to connect. This makes it hard to manage the queue, as well as wasting
35710 resources, because each queue runner scans the entire queue.
35711
35712 A better approach is to separate off those messages that are waiting for an
35713 intermittently connected host. This can be done by delivering these messages
35714 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
35715 format, from where they are transmitted by other software when their
35716 destination connects. This makes it easy to collect all the mail for one host
35717 in a single directory, and to apply local timeout rules on a per-message basis
35718 if required.
35719
35720 On a very small scale, leaving the mail on Exim's queue can be made to work. If
35721 you are doing this, you should configure Exim with a long retry period for the
35722 intermittent host. For example:
35723 .code
35724 cheshire.wonderland.fict.example    *   F,5d,24h
35725 .endd
35726 This stops a lot of failed delivery attempts from occurring, but Exim remembers
35727 which messages it has queued up for that host. Once the intermittent host comes
35728 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
35729 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
35730 causes all the queued up messages to be delivered, often down a single SMTP
35731 connection. While the host remains connected, any new messages get delivered
35732 immediately.
35733
35734 If the connecting hosts do not have fixed IP addresses, that is, if a host is
35735 issued with a different IP address each time it connects, Exim's retry
35736 mechanisms on the holding host get confused, because the IP address is normally
35737 used as part of the key string for holding retry information. This can be
35738 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
35739 Since this has disadvantages for permanently connected hosts, it is best to
35740 arrange a separate transport for the intermittently connected ones.
35741
35742
35743
35744 .section "Exim on the intermittently connected client host" "SECID248"
35745 The value of &%smtp_accept_queue_per_connection%& should probably be
35746 increased, or even set to zero (that is, disabled) on the intermittently
35747 connected host, so that all incoming messages down a single connection get
35748 delivered immediately.
35749
35750 .cindex "SMTP" "passed connection"
35751 .cindex "SMTP" "multiple deliveries"
35752 .cindex "multiple SMTP deliveries"
35753 Mail waiting to be sent from an intermittently connected host will probably
35754 not have been routed, because without a connection DNS lookups are not
35755 possible. This means that if a normal queue run is done at connection time,
35756 each message is likely to be sent in a separate SMTP session. This can be
35757 avoided by starting the queue run with a command line option beginning with
35758 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
35759 first pass, routing is done but no deliveries take place. The second pass is a
35760 normal queue run; since all the messages have been previously routed, those
35761 destined for the same host are likely to get sent as multiple deliveries in a
35762 single SMTP connection.
35763
35764
35765
35766 . ////////////////////////////////////////////////////////////////////////////
35767 . ////////////////////////////////////////////////////////////////////////////
35768
35769 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
35770          "Exim as a non-queueing client"
35771 .cindex "client, non-queueing"
35772 .cindex "smart host" "suppressing queueing"
35773 On a personal computer, it is a common requirement for all
35774 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
35775 configured to operate that way, for all the popular operating systems.
35776 However, there are some MUAs for Unix-like systems that cannot be so
35777 configured: they submit messages using the command line interface of
35778 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
35779 messages this way.
35780
35781 If the personal computer runs continuously, there is no problem, because it can
35782 run a conventional MTA that handles delivery to the smart host, and deal with
35783 any delays via its queueing mechanism. However, if the computer does not run
35784 continuously or runs different operating systems at different times, queueing
35785 email is not desirable.
35786
35787 There is therefore a requirement for something that can provide the
35788 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
35789 any queueing or retrying facilities. Furthermore, the delivery to the smart
35790 host should be synchronous, so that if it fails, the sending MUA is immediately
35791 informed. In other words, we want something that extends an MUA that submits
35792 to a local MTA via the command line so that it behaves like one that submits
35793 to a remote smart host using TCP/SMTP.
35794
35795 There are a number of applications (for example, there is one called &'ssmtp'&)
35796 that do this job. However, people have found them to be lacking in various
35797 ways. For instance, you might want to allow aliasing and forwarding to be done
35798 before sending a message to the smart host.
35799
35800 Exim already had the necessary infrastructure for doing this job. Just a few
35801 tweaks were needed to make it behave as required, though it is somewhat of an
35802 overkill to use a fully-featured MTA for this purpose.
35803
35804 .oindex "&%mua_wrapper%&"
35805 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
35806 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
35807 assumes that it is being used to &"wrap"& a command-line MUA in the manner
35808 just described. As well as setting &%mua_wrapper%&, you also need to provide a
35809 compatible router and transport configuration. Typically there will be just one
35810 router and one transport, sending everything to a smart host.
35811
35812 When run in MUA wrapping mode, the behaviour of Exim changes in the
35813 following ways:
35814
35815 .ilist
35816 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
35817 In other words, the only way to submit messages is via the command line.
35818 .next
35819 Each message is synchronously delivered as soon as it is received (&%-odi%& is
35820 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
35821 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
35822 does not finish until the delivery attempt is complete. If the delivery is
35823 successful, a zero return code is given.
35824 .next
35825 Address redirection is permitted, but the final routing for all addresses must
35826 be to the same remote transport, and to the same list of hosts. Furthermore,
35827 the return address (envelope sender) must be the same for all recipients, as
35828 must any added or deleted header lines. In other words, it must be possible to
35829 deliver the message in a single SMTP transaction, however many recipients there
35830 are.
35831 .next
35832 If these conditions are not met, or if routing any address results in a
35833 failure or defer status, or if Exim is unable to deliver all the recipients
35834 successfully to one of the smart hosts, delivery of the entire message fails.
35835 .next
35836 Because no queueing is allowed, all failures are treated as permanent; there
35837 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
35838 smart host. Furthermore, because only a single yes/no response can be given to
35839 the caller, it is not possible to deliver to some recipients and not others. If
35840 there is an error (temporary or permanent) for any recipient, all are failed.
35841 .next
35842 If more than one smart host is listed, Exim will try another host after a
35843 connection failure or a timeout, in the normal way. However, if this kind of
35844 failure happens for all the hosts, the delivery fails.
35845 .next
35846 When delivery fails, an error message is written to the standard error stream
35847 (as well as to Exim's log), and Exim exits to the caller with a return code
35848 value 1. The message is expunged from Exim's spool files. No bounce messages
35849 are ever generated.
35850 .next
35851 No retry data is maintained, and any retry rules are ignored.
35852 .next
35853 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
35854 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
35855 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
35856 .endlist
35857
35858 The overall effect is that Exim makes a single synchronous attempt to deliver
35859 the message, failing if there is any kind of problem. Because no local
35860 deliveries are done and no daemon can be run, Exim does not need root
35861 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
35862 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
35863 the advantages and disadvantages of running without root privilege.
35864
35865
35866
35867
35868 . ////////////////////////////////////////////////////////////////////////////
35869 . ////////////////////////////////////////////////////////////////////////////
35870
35871 .chapter "Log files" "CHAPlog"
35872 .scindex IIDloggen "log" "general description"
35873 .cindex "log" "types of"
35874 Exim writes three different logs, referred to as the main log, the reject log,
35875 and the panic log:
35876
35877 .ilist
35878 .cindex "main log"
35879 The main log records the arrival of each message and each delivery in a single
35880 line in each case. The format is as compact as possible, in an attempt to keep
35881 down the size of log files. Two-character flag sequences make it easy to pick
35882 out these lines. A number of other events are recorded in the main log. Some of
35883 them are optional, in which case the &%log_selector%& option controls whether
35884 they are included or not. A Perl script called &'eximstats'&, which does simple
35885 analysis of main log files, is provided in the Exim distribution (see section
35886 &<<SECTmailstat>>&).
35887 .next
35888 .cindex "reject log"
35889 The reject log records information from messages that are rejected as a result
35890 of a configuration option (that is, for policy reasons).
35891 The first line of each rejection is a copy of the line that is also written to
35892 the main log. Then, if the message's header has been read at the time the log
35893 is written, its contents are written to this log. Only the original header
35894 lines are available; header lines added by ACLs are not logged. You can use the
35895 reject log to check that your policy controls are working correctly; on a busy
35896 host this may be easier than scanning the main log for rejection messages. You
35897 can suppress the writing of the reject log by setting &%write_rejectlog%&
35898 false.
35899 .next
35900 .cindex "panic log"
35901 .cindex "system log"
35902 When certain serious errors occur, Exim writes entries to its panic log. If the
35903 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
35904 are usually written to the main log as well, but can get lost amid the mass of
35905 other entries. The panic log should be empty under normal circumstances. It is
35906 therefore a good idea to check it (or to have a &'cron'& script check it)
35907 regularly, in order to become aware of any problems. When Exim cannot open its
35908 panic log, it tries as a last resort to write to the system log (syslog). This
35909 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
35910 message itself is written at priority LOG_CRIT.
35911 .endlist
35912
35913 Every log line starts with a timestamp, in the format shown in the following
35914 example. Note that many of the examples shown in this chapter are line-wrapped.
35915 In the log file, this would be all on one line:
35916 .code
35917 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
35918   by QUIT
35919 .endd
35920 By default, the timestamps are in the local timezone. There are two
35921 ways of changing this:
35922
35923 .ilist
35924 You can set the &%timezone%& option to a different time zone; in particular, if
35925 you set
35926 .code
35927 timezone = UTC
35928 .endd
35929 the timestamps will be in UTC (aka GMT).
35930 .next
35931 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
35932 example:
35933 .code
35934 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
35935 .endd
35936 .endlist
35937
35938 .cindex "log" "process ids in"
35939 .cindex "pid (process id)" "in log lines"
35940 Exim does not include its process id in log lines by default, but you can
35941 request that it does so by specifying the &`pid`& log selector (see section
35942 &<<SECTlogselector>>&). When this is set, the process id is output, in square
35943 brackets, immediately after the time and date.
35944
35945
35946
35947
35948 .section "Where the logs are written" "SECTwhelogwri"
35949 .cindex "log" "destination"
35950 .cindex "log" "to file"
35951 .cindex "log" "to syslog"
35952 .cindex "syslog"
35953 The logs may be written to local files, or to syslog, or both. However, it
35954 should be noted that many syslog implementations use UDP as a transport, and
35955 are therefore unreliable in the sense that messages are not guaranteed to
35956 arrive at the loghost, nor is the ordering of messages necessarily maintained.
35957 It has also been reported that on large log files (tens of megabytes) you may
35958 need to tweak syslog to prevent it syncing the file with each write &-- on
35959 Linux this has been seen to make syslog take 90% plus of CPU time.
35960
35961 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
35962 &_Local/Makefile_& or by setting &%log_file_path%& in the run time
35963 configuration. This latter string is expanded, so it can contain, for example,
35964 references to the host name:
35965 .code
35966 log_file_path = /var/log/$primary_hostname/exim_%slog
35967 .endd
35968 It is generally advisable, however, to set the string in &_Local/Makefile_&
35969 rather than at run time, because then the setting is available right from the
35970 start of Exim's execution. Otherwise, if there's something it wants to log
35971 before it has read the configuration file (for example, an error in the
35972 configuration file) it will not use the path you want, and may not be able to
35973 log at all.
35974
35975 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
35976 list, currently limited to at most two items. This is one option where the
35977 facility for changing a list separator may not be used. The list must always be
35978 colon-separated. If an item in the list is &"syslog"& then syslog is used;
35979 otherwise the item must either be an absolute path, containing &`%s`& at the
35980 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
35981 implying the use of a default path.
35982
35983 When Exim encounters an empty item in the list, it searches the list defined by
35984 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
35985 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
35986 mean &"use the path specified at build time"&. It no such item exists, log
35987 files are written in the &_log_& subdirectory of the spool directory. This is
35988 equivalent to the setting:
35989 .code
35990 log_file_path = $spool_directory/log/%slog
35991 .endd
35992 If you do not specify anything at build time or run time,
35993 or if you unset the option at run time (i.e. &`log_file_path = `&),
35994 that is where the logs are written.
35995
35996 A log file path may also contain &`%D`& or &`%M`& if datestamped log file names
35997 are in use &-- see section &<<SECTdatlogfil>>& below.
35998
35999 Here are some examples of possible settings:
36000 .display
36001 &`LOG_FILE_PATH=syslog                    `& syslog only
36002 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
36003 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
36004 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
36005 .endd
36006 If there are more than two paths in the list, the first is used and a panic
36007 error is logged.
36008
36009
36010
36011 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
36012 .cindex "log" "cycling local files"
36013 .cindex "cycling logs"
36014 .cindex "&'exicyclog'&"
36015 .cindex "log" "local files; writing to"
36016 Some operating systems provide centralized and standardized methods for cycling
36017 log files. For those that do not, a utility script called &'exicyclog'& is
36018 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
36019 main and reject logs each time it is called. The maximum number of old logs to
36020 keep can be set. It is suggested this script is run as a daily &'cron'& job.
36021
36022 An Exim delivery process opens the main log when it first needs to write to it,
36023 and it keeps the file open in case subsequent entries are required &-- for
36024 example, if a number of different deliveries are being done for the same
36025 message. However, remote SMTP deliveries can take a long time, and this means
36026 that the file may be kept open long after it is renamed if &'exicyclog'& or
36027 something similar is being used to rename log files on a regular basis. To
36028 ensure that a switch of log files is noticed as soon as possible, Exim calls
36029 &[stat()]& on the main log's name before reusing an open file, and if the file
36030 does not exist, or its inode has changed, the old file is closed and Exim
36031 tries to open the main log from scratch. Thus, an old log file may remain open
36032 for quite some time, but no Exim processes should write to it once it has been
36033 renamed.
36034
36035
36036
36037 .section "Datestamped log files" "SECTdatlogfil"
36038 .cindex "log" "datestamped files"
36039 Instead of cycling the main and reject log files by renaming them
36040 periodically, some sites like to use files whose names contain a datestamp,
36041 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
36042 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
36043 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
36044 point where the datestamp is required. For example:
36045 .code
36046 log_file_path = /var/spool/exim/log/%slog-%D
36047 log_file_path = /var/log/exim-%s-%D.log
36048 log_file_path = /var/spool/exim/log/%D-%slog
36049 log_file_path = /var/log/exim/%s.%M
36050 .endd
36051 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
36052 examples of names generated by the above examples:
36053 .code
36054 /var/spool/exim/log/mainlog-20021225
36055 /var/log/exim-reject-20021225.log
36056 /var/spool/exim/log/20021225-mainlog
36057 /var/log/exim/main.200212
36058 .endd
36059 When this form of log file is specified, Exim automatically switches to new
36060 files at midnight. It does not make any attempt to compress old logs; you
36061 will need to write your own script if you require this. You should not
36062 run &'exicyclog'& with this form of logging.
36063
36064 The location of the panic log is also determined by &%log_file_path%&, but it
36065 is not datestamped, because rotation of the panic log does not make sense.
36066 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
36067 the string. In addition, if it immediately follows a slash, a following
36068 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
36069 character is removed. Thus, the four examples above would give these panic
36070 log names:
36071 .code
36072 /var/spool/exim/log/paniclog
36073 /var/log/exim-panic.log
36074 /var/spool/exim/log/paniclog
36075 /var/log/exim/panic
36076 .endd
36077
36078
36079 .section "Logging to syslog" "SECID249"
36080 .cindex "log" "syslog; writing to"
36081 The use of syslog does not change what Exim logs or the format of its messages,
36082 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
36083 Exim's log lines are omitted when these lines are sent to syslog. Apart from
36084 that, the same strings are written to syslog as to log files. The syslog
36085 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
36086 by default, but you can change these by setting the &%syslog_facility%& and
36087 &%syslog_processname%& options, respectively. If Exim was compiled with
36088 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
36089 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
36090 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
36091 the time and host name to each line.
36092 The three log streams are mapped onto syslog priorities as follows:
36093
36094 .ilist
36095 &'mainlog'& is mapped to LOG_INFO
36096 .next
36097 &'rejectlog'& is mapped to LOG_NOTICE
36098 .next
36099 &'paniclog'& is mapped to LOG_ALERT
36100 .endlist
36101
36102 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
36103 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
36104 these are routed by syslog to the same place. You can suppress this duplication
36105 by setting &%syslog_duplication%& false.
36106
36107 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
36108 entries contain multiple lines when headers are included. To cope with both
36109 these cases, entries written to syslog are split into separate &[syslog()]&
36110 calls at each internal newline, and also after a maximum of
36111 870 data characters. (This allows for a total syslog line length of 1024, when
36112 additions such as timestamps are added.) If you are running a syslog
36113 replacement that can handle lines longer than the 1024 characters allowed by
36114 RFC 3164, you should set
36115 .code
36116 SYSLOG_LONG_LINES=yes
36117 .endd
36118 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
36119 lines, but it still splits at internal newlines in &'reject'& log entries.
36120
36121 To make it easy to re-assemble split lines later, each component of a split
36122 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
36123 where <&'n'&> is the component number and <&'m'&> is the total number of
36124 components in the entry. The / delimiter is used when the line was split
36125 because it was too long; if it was split because of an internal newline, the \
36126 delimiter is used. For example, supposing the length limit to be 50 instead of
36127 870, the following would be the result of a typical rejection message to
36128 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
36129 name, and pid as added by syslog:
36130 .code
36131 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
36132 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
36133 [3/5]  when scanning for sender: missing or malformed lo
36134 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
36135 [5/5] mple>)
36136 .endd
36137 The same error might cause the following lines to be written to &"rejectlog"&
36138 (LOG_NOTICE):
36139 .code
36140 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
36141 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
36142 [3/18] er when scanning for sender: missing or malformed
36143 [4/18]  local part in "<>" (envelope sender is <ph10@cam
36144 [5\18] .example>)
36145 [6\18] Recipients: ph10@some.domain.cam.example
36146 [7\18] P Received: from [127.0.0.1] (ident=ph10)
36147 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
36148 [9\18]        id 16RdAL-0006pc-00
36149 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
36150 [11\18] 09:43 +0100
36151 [12\18] F From: <>
36152 [13\18]   Subject: this is a test header
36153 [18\18]   X-something: this is another header
36154 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
36155 [16\18] le>
36156 [17\18] B Bcc:
36157 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
36158 .endd
36159 Log lines that are neither too long nor contain newlines are written to syslog
36160 without modification.
36161
36162 If only syslog is being used, the Exim monitor is unable to provide a log tail
36163 display, unless syslog is routing &'mainlog'& to a file on the local host and
36164 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
36165 where it is.
36166
36167
36168
36169 .section "Log line flags" "SECID250"
36170 One line is written to the main log for each message received, and for each
36171 successful, unsuccessful, and delayed delivery. These lines can readily be
36172 picked out by the distinctive two-character flags that immediately follow the
36173 timestamp. The flags are:
36174 .display
36175 &`<=`&     message arrival
36176 &`(=`&     message fakereject
36177 &`=>`&     normal message delivery
36178 &`->`&     additional address in same delivery
36179 &`>>`&     cutthrough message delivery
36180 &`*>`&     delivery suppressed by &%-N%&
36181 &`**`&     delivery failed; address bounced
36182 &`==`&     delivery deferred; temporary problem
36183 .endd
36184
36185
36186 .section "Logging message reception" "SECID251"
36187 .cindex "log" "reception line"
36188 The format of the single-line entry in the main log that is written for every
36189 message received is shown in the basic example below, which is split over
36190 several lines in order to fit it on the page:
36191 .code
36192 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
36193   H=mailer.fict.example [192.168.123.123] U=exim
36194   P=smtp S=5678 id=<incoming message id>
36195 .endd
36196 The address immediately following &"<="& is the envelope sender address. A
36197 bounce message is shown with the sender address &"<>"&, and if it is locally
36198 generated, this is followed by an item of the form
36199 .code
36200 R=<message id>
36201 .endd
36202 which is a reference to the message that caused the bounce to be sent.
36203
36204 .cindex "HELO"
36205 .cindex "EHLO"
36206 For messages from other hosts, the H and U fields identify the remote host and
36207 record the RFC 1413 identity of the user that sent the message, if one was
36208 received. The number given in square brackets is the IP address of the sending
36209 host. If there is a single, unparenthesized  host name in the H field, as
36210 above, it has been verified to correspond to the IP address (see the
36211 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
36212 by the remote host in the SMTP HELO or EHLO command, and has not been
36213 verified. If verification yields a different name to that given for HELO or
36214 EHLO, the verified name appears first, followed by the HELO or EHLO
36215 name in parentheses.
36216
36217 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
36218 without brackets, in the HELO or EHLO command, leading to entries in
36219 the log containing text like these examples:
36220 .code
36221 H=(10.21.32.43) [192.168.8.34]
36222 H=([10.21.32.43]) [192.168.8.34]
36223 .endd
36224 This can be confusing. Only the final address in square brackets can be relied
36225 on.
36226
36227 For locally generated messages (that is, messages not received over TCP/IP),
36228 the H field is omitted, and the U field contains the login name of the caller
36229 of Exim.
36230
36231 .cindex "authentication" "logging"
36232 .cindex "AUTH" "logging"
36233 For all messages, the P field specifies the protocol used to receive the
36234 message. This is the value that is stored in &$received_protocol$&. In the case
36235 of incoming SMTP messages, the value indicates whether or not any SMTP
36236 extensions (ESMTP), encryption, or authentication were used. If the SMTP
36237 session was encrypted, there is an additional X field that records the cipher
36238 suite that was used.
36239
36240 .cindex log protocol
36241 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
36242 hosts that have authenticated themselves using the SMTP AUTH command. The first
36243 value is used when the SMTP connection was encrypted (&"secure"&). In this case
36244 there is an additional item A= followed by the name of the authenticator that
36245 was used. If an authenticated identification was set up by the authenticator's
36246 &%server_set_id%& option, this is logged too, separated by a colon from the
36247 authenticator name.
36248
36249 .cindex "size" "of message"
36250 The id field records the existing message id, if present. The size of the
36251 received message is given by the S field. When the message is delivered,
36252 headers may be removed or added, so that the size of delivered copies of the
36253 message may not correspond with this value (and indeed may be different to each
36254 other).
36255
36256 The &%log_selector%& option can be used to request the logging of additional
36257 data when a message is received. See section &<<SECTlogselector>>& below.
36258
36259
36260
36261 .section "Logging deliveries" "SECID252"
36262 .cindex "log" "delivery line"
36263 The format of the single-line entry in the main log that is written for every
36264 delivery is shown in one of the examples below, for local and remote
36265 deliveries, respectively. Each example has been split into multiple lines in order
36266 to fit it on the page:
36267 .code
36268 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
36269   <marv@hitch.fict.example> R=localuser T=local_delivery
36270 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
36271   monk@holistic.fict.example R=dnslookup T=remote_smtp
36272   H=holistic.fict.example [192.168.234.234]
36273 .endd
36274 For ordinary local deliveries, the original address is given in angle brackets
36275 after the final delivery address, which might be a pipe or a file. If
36276 intermediate address(es) exist between the original and the final address, the
36277 last of these is given in parentheses after the final address. The R and T
36278 fields record the router and transport that were used to process the address.
36279
36280 If SMTP AUTH was used for the delivery there is an additional item A=
36281 followed by the name of the authenticator that was used.
36282 If an authenticated identification was set up by the authenticator's &%client_set_id%&
36283 option, this is logged too, separated by a colon from the authenticator name.
36284
36285 If a shadow transport was run after a successful local delivery, the log line
36286 for the successful delivery has an item added on the end, of the form
36287 .display
36288 &`ST=<`&&'shadow transport name'&&`>`&
36289 .endd
36290 If the shadow transport did not succeed, the error message is put in
36291 parentheses afterwards.
36292
36293 .cindex "asterisk" "after IP address"
36294 When more than one address is included in a single delivery (for example, two
36295 SMTP RCPT commands in one transaction) the second and subsequent addresses are
36296 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
36297 down a single SMTP connection, an asterisk follows the IP address in the log
36298 lines for the second and subsequent messages.
36299 When two or more messages are delivered down a single TLS connection, the
36300 DNS and some TLS-related information logged for the first message delivered
36301 will not be present in the log lines for the second and subsequent messages.
36302 TLS cipher information is still available.
36303
36304 .cindex "delivery" "cutthrough; logging"
36305 .cindex "cutthrough" "logging"
36306 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
36307 line precedes the reception line, since cutthrough waits for a possible
36308 rejection from the destination in case it can reject the sourced item.
36309
36310 The generation of a reply message by a filter file gets logged as a
36311 &"delivery"& to the addressee, preceded by &">"&.
36312
36313 The &%log_selector%& option can be used to request the logging of additional
36314 data when a message is delivered. See section &<<SECTlogselector>>& below.
36315
36316
36317 .section "Discarded deliveries" "SECID253"
36318 .cindex "discarded messages"
36319 .cindex "message" "discarded"
36320 .cindex "delivery" "discarded; logging"
36321 When a message is discarded as a result of the command &"seen finish"& being
36322 obeyed in a filter file which generates no deliveries, a log entry of the form
36323 .code
36324 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
36325   <low.club@bridge.example> R=userforward
36326 .endd
36327 is written, to record why no deliveries are logged. When a message is discarded
36328 because it is aliased to &":blackhole:"& the log line is like this:
36329 .code
36330 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
36331   <hole@nowhere.example> R=blackhole_router
36332 .endd
36333
36334
36335 .section "Deferred deliveries" "SECID254"
36336 When a delivery is deferred, a line of the following form is logged:
36337 .code
36338 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
36339   R=dnslookup T=smtp defer (146): Connection refused
36340 .endd
36341 In the case of remote deliveries, the error is the one that was given for the
36342 last IP address that was tried. Details of individual SMTP failures are also
36343 written to the log, so the above line would be preceded by something like
36344 .code
36345 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
36346   mail1.endrest.example [192.168.239.239]: Connection refused
36347 .endd
36348 When a deferred address is skipped because its retry time has not been reached,
36349 a message is written to the log, but this can be suppressed by setting an
36350 appropriate value in &%log_selector%&.
36351
36352
36353
36354 .section "Delivery failures" "SECID255"
36355 .cindex "delivery" "failure; logging"
36356 If a delivery fails because an address cannot be routed, a line of the
36357 following form is logged:
36358 .code
36359 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
36360   <jim@trek99.example>: unknown mail domain
36361 .endd
36362 If a delivery fails at transport time, the router and transport are shown, and
36363 the response from the remote host is included, as in this example:
36364 .code
36365 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
36366   R=dnslookup T=remote_smtp: SMTP error from remote mailer
36367   after pipelined RCPT TO:<ace400@pb.example>: host
36368   pbmail3.py.example [192.168.63.111]: 553 5.3.0
36369   <ace400@pb.example>...Addressee unknown
36370 .endd
36371 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
36372 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
36373 disabling PIPELINING. The log lines for all forms of delivery failure are
36374 flagged with &`**`&.
36375
36376
36377
36378 .section "Fake deliveries" "SECID256"
36379 .cindex "delivery" "fake; logging"
36380 If a delivery does not actually take place because the &%-N%& option has been
36381 used to suppress it, a normal delivery line is written to the log, except that
36382 &"=>"& is replaced by &"*>"&.
36383
36384
36385
36386 .section "Completion" "SECID257"
36387 A line of the form
36388 .code
36389 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
36390 .endd
36391 is written to the main log when a message is about to be removed from the spool
36392 at the end of its processing.
36393
36394
36395
36396
36397 .section "Summary of Fields in Log Lines" "SECID258"
36398 .cindex "log" "summary of fields"
36399 A summary of the field identifiers that are used in log lines is shown in
36400 the following table:
36401 .display
36402 &`A   `&        authenticator name (and optional id and sender)
36403 &`C   `&        SMTP confirmation on delivery
36404 &`    `&        command list for &"no mail in SMTP session"&
36405 &`CV  `&        certificate verification status
36406 &`D   `&        duration of &"no mail in SMTP session"&
36407 &`DKIM`&        domain verified in incoming message
36408 &`DN  `&        distinguished name from peer certificate
36409 &`DS  `&        DNSSEC secured lookups
36410 &`DT  `&        on &`=>`& lines: time taken for a delivery
36411 &`F   `&        sender address (on delivery lines)
36412 &`H   `&        host name and IP address
36413 &`I   `&        local interface used
36414 &`K   `&        CHUNKING extension used
36415 &`id  `&        message id for incoming message
36416 &`M8S `&        8BITMIME status for incoming message
36417 &`P   `&        on &`<=`& lines: protocol used
36418 &`    `&        on &`=>`& and &`**`& lines: return path
36419 &`PRDR`&        PRDR extension used
36420 &`PRX `&        on &`<=`& and &`=>`& lines: proxy address
36421 &`Q   `&        alternate queue name
36422 &`QT  `&        on &`=>`& lines: time spent on queue so far
36423 &`    `&        on &"Completed"& lines: time spent on queue
36424 &`R   `&        on &`<=`& lines: reference for local bounce
36425 &`    `&        on &`=>`&  &`>>`& &`**`& and &`==`& lines: router name
36426 &`RT  `&        on &`<=`& lines: time taken for reception
36427 &`S   `&        size of message in bytes
36428 &`SNI `&        server name indication from TLS client hello
36429 &`ST  `&        shadow transport name
36430 &`T   `&        on &`<=`& lines: message subject (topic)
36431 &`TFO `&        connection took advantage of TCP Fast Open
36432 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
36433 &`U   `&        local user or RFC 1413 identity
36434 &`X   `&        TLS cipher suite
36435 .endd
36436
36437
36438 .section "Other log entries" "SECID259"
36439 Various other types of log entry are written from time to time. Most should be
36440 self-explanatory. Among the more common are:
36441
36442 .ilist
36443 .cindex "retry" "time not reached"
36444 &'retry time not reached'&&~&~An address previously suffered a temporary error
36445 during routing or local delivery, and the time to retry has not yet arrived.
36446 This message is not written to an individual message log file unless it happens
36447 during the first delivery attempt.
36448 .next
36449 &'retry time not reached for any host'&&~&~An address previously suffered
36450 temporary errors during remote delivery, and the retry time has not yet arrived
36451 for any of the hosts to which it is routed.
36452 .next
36453 .cindex "spool directory" "file locked"
36454 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
36455 some other Exim process is already working on the message. This can be quite
36456 common if queue running processes are started at frequent intervals. The
36457 &'exiwhat'& utility script can be used to find out what Exim processes are
36458 doing.
36459 .next
36460 .cindex "error" "ignored"
36461 &'error ignored'&&~&~There are several circumstances that give rise to this
36462 message:
36463 .olist
36464 Exim failed to deliver a bounce message whose age was greater than
36465 &%ignore_bounce_errors_after%&. The bounce was discarded.
36466 .next
36467 A filter file set up a delivery using the &"noerror"& option, and the delivery
36468 failed. The delivery was discarded.
36469 .next
36470 A delivery set up by a router configured with
36471 . ==== As this is a nested list, any displays it contains must be indented
36472 . ==== as otherwise they are too far to the left.
36473 .code
36474     errors_to = <>
36475 .endd
36476 failed. The delivery was discarded.
36477 .endlist olist
36478 .next
36479 .new
36480 .cindex DKIM "log line"
36481 &'DKIM: d='&&~&~Verbose results of a DKIM verification attempt, if enabled for
36482 logging and the message has a DKIM signature header.
36483 .wen
36484 .endlist ilist
36485
36486
36487
36488
36489
36490 .section "Reducing or increasing what is logged" "SECTlogselector"
36491 .cindex "log" "selectors"
36492 By setting the &%log_selector%& global option, you can disable some of Exim's
36493 default logging, or you can request additional logging. The value of
36494 &%log_selector%& is made up of names preceded by plus or minus characters. For
36495 example:
36496 .code
36497 log_selector = +arguments -retry_defer
36498 .endd
36499 The list of optional log items is in the following table, with the default
36500 selection marked by asterisks:
36501 .display
36502 &` 8bitmime                   `&  received 8BITMIME status
36503 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
36504 &` address_rewrite            `&  address rewriting
36505 &` all_parents                `&  all parents in => lines
36506 &` arguments                  `&  command line arguments
36507 &`*connection_reject          `&  connection rejections
36508 &`*delay_delivery             `&  immediate delivery delayed
36509 &` deliver_time               `&  time taken to perform delivery
36510 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
36511 &`*dkim                       `&  DKIM verified domain on <= lines
36512 &` dkim_verbose               `&  separate full DKIM verification result line, per signature
36513 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
36514 &` dnssec                     `&  DNSSEC secured lookups
36515 &`*etrn                       `&  ETRN commands
36516 &`*host_lookup_failed         `&  as it says
36517 &` ident_timeout              `&  timeout for ident connection
36518 &` incoming_interface         `&  local interface on <= and => lines
36519 &` incoming_port              `&  remote port on <= lines
36520 &`*lost_incoming_connection   `&  as it says (includes timeouts)
36521 &` millisec                   `&  millisecond timestamps and RT,QT,DT,D times
36522 &` outgoing_interface         `&  local interface on => lines
36523 &` outgoing_port              `&  add remote port to => lines
36524 &`*queue_run                  `&  start and end queue runs
36525 &` queue_time                 `&  time on queue for one recipient
36526 &` queue_time_overall         `&  time on queue for whole message
36527 &` pid                        `&  Exim process id
36528 &` proxy                      `&  proxy address on <= and => lines
36529 &` receive_time               `&  time taken to receive message
36530 &` received_recipients        `&  recipients on <= lines
36531 &` received_sender            `&  sender on <= lines
36532 &`*rejected_header            `&  header contents on reject log
36533 &`*retry_defer                `&  &"retry time not reached"&
36534 &` return_path_on_delivery    `&  put return path on => and ** lines
36535 &` sender_on_delivery         `&  add sender to => lines
36536 &`*sender_verify_fail         `&  sender verification failures
36537 &`*size_reject                `&  rejection because too big
36538 &`*skip_delivery              `&  delivery skipped in a queue run
36539 &`*smtp_confirmation          `&  SMTP confirmation on => lines
36540 &` smtp_connection            `&  incoming SMTP connections
36541 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
36542 &` smtp_mailauth              `&  AUTH argument to MAIL commands
36543 &` smtp_no_mail               `&  session with no MAIL commands
36544 &` smtp_protocol_error        `&  SMTP protocol errors
36545 &` smtp_syntax_error          `&  SMTP syntax errors
36546 &` subject                    `&  contents of &'Subject:'& on <= lines
36547 &`*tls_certificate_verified   `&  certificate verification status
36548 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
36549 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
36550 &` tls_sni                    `&  TLS SNI on <= lines
36551 &` unknown_in_list            `&  DNS lookup failed in list match
36552
36553 &` all                        `&  all of the above
36554 .endd
36555 See also the &%slow_lookup_log%& main configuration option,
36556 section &<<SECID99>>&
36557
36558 More details on each of these items follows:
36559
36560 .ilist
36561 .cindex "8BITMIME"
36562 .cindex "log" "8BITMIME"
36563 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
36564 which may help in tracking down interoperability issues with ancient MTAs
36565 that are not 8bit clean.  This is added to the &"<="& line, tagged with
36566 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
36567 &`7BIT`& and &`8BITMIME`& respectively.
36568 .next
36569 .cindex "&%warn%& ACL verb" "log when skipping"
36570 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
36571 its conditions cannot be evaluated, a log line to this effect is written if
36572 this log selector is set.
36573 .next
36574 .cindex "log" "rewriting"
36575 .cindex "rewriting" "logging"
36576 &%address_rewrite%&: This applies both to global rewrites and per-transport
36577 rewrites, but not to rewrites in filters run as an unprivileged user (because
36578 such users cannot access the log).
36579 .next
36580 .cindex "log" "full parentage"
36581 &%all_parents%&: Normally only the original and final addresses are logged on
36582 delivery lines; with this selector, intermediate parents are given in
36583 parentheses between them.
36584 .next
36585 .cindex "log" "Exim arguments"
36586 .cindex "Exim arguments, logging"
36587 &%arguments%&: This causes Exim to write the arguments with which it was called
36588 to the main log, preceded by the current working directory. This is a debugging
36589 feature, added to make it easier to find out how certain MUAs call
36590 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
36591 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
36592 that are empty or that contain white space are quoted. Non-printing characters
36593 are shown as escape sequences. This facility cannot log unrecognized arguments,
36594 because the arguments are checked before the configuration file is read. The
36595 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
36596 between the caller and Exim.
36597 .next
36598 .cindex "log" "connection rejections"
36599 &%connection_reject%&: A log entry is written whenever an incoming SMTP
36600 connection is rejected, for whatever reason.
36601 .next
36602 .cindex "log" "delayed delivery"
36603 .cindex "delayed delivery, logging"
36604 &%delay_delivery%&: A log entry is written whenever a delivery process is not
36605 started for an incoming message because the load is too high or too many
36606 messages were received on one connection. Logging does not occur if no delivery
36607 process is started because &%queue_only%& is set or &%-odq%& was used.
36608 .next
36609 .cindex "log" "delivery duration"
36610 &%deliver_time%&: For each delivery, the amount of real time it has taken to
36611 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
36612 If millisecond logging is enabled, short times will be shown with greater
36613 precision, eg. &`DT=0.304s`&.
36614 .next
36615 .cindex "log" "message size on delivery"
36616 .cindex "size" "of message"
36617 &%delivery_size%&: For each delivery, the size of message delivered is added to
36618 the &"=>"& line, tagged with S=.
36619 .next
36620 .new
36621 .cindex log "DKIM verification"
36622 .cindex DKIM "verification logging"
36623 &%dkim%&: For message acceptance log lines, when an DKIM signature in the header
36624 verifies successfully a tag of DKIM is added, with one of the verified domains.
36625 .next
36626 .cindex log "DKIM verification"
36627 .cindex DKIM "verification logging"
36628 &%dkim_verbose%&: A log entry is written for each attempted DKIM verification.
36629 .wen
36630 .next
36631 .cindex "log" "dnslist defer"
36632 .cindex "DNS list" "logging defer"
36633 .cindex "black list (DNS)"
36634 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
36635 DNS black list suffers a temporary error.
36636 .next
36637 .cindex log dnssec
36638 .cindex dnssec logging
36639 &%dnssec%&: For message acceptance and (attempted) delivery log lines, when
36640 dns lookups gave secure results a tag of DS is added.
36641 For acceptance this covers the reverse and forward lookups for host name verification.
36642 It does not cover helo-name verification.
36643 For delivery this covers the SRV, MX, A and/or AAAA lookups.
36644 .next
36645 .cindex "log" "ETRN commands"
36646 .cindex "ETRN" "logging"
36647 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
36648 is run to determine whether or not it is actually accepted. An invalid ETRN
36649 command, or one received within a message transaction is not logged by this
36650 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
36651 .next
36652 .cindex "log" "host lookup failure"
36653 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
36654 any addresses, or when a lookup of an IP address fails to find a host name, a
36655 log line is written. This logging does not apply to direct DNS lookups when
36656 routing email addresses, but it does apply to &"byname"& lookups.
36657 .next
36658 .cindex "log" "ident timeout"
36659 .cindex "RFC 1413" "logging timeout"
36660 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
36661 client's ident port times out.
36662 .next
36663 .cindex "log" "incoming interface"
36664 .cindex "log" "local interface"
36665 .cindex "log" "local address and port"
36666 .cindex "TCP/IP" "logging local address and port"
36667 .cindex "interface" "logging"
36668 &%incoming_interface%&: The interface on which a message was received is added
36669 to the &"<="& line as an IP address in square brackets, tagged by I= and
36670 followed by a colon and the port number. The local interface and port are also
36671 added to other SMTP log lines, for example &"SMTP connection from"&, to
36672 rejection lines, and (despite the name) to outgoing &"=>"& and &"->"& lines.
36673 The latter can be disabled by turning off the &%outgoing_interface%& option.
36674 .next
36675 .cindex log "incoming proxy address"
36676 .cindex proxy "logging proxy address"
36677 .cindex "TCP/IP" "logging proxy address"
36678 &%proxy%&: The internal (closest to the system running Exim) IP address
36679 of the proxy, tagged by PRX=, on the &"<="& line for a message accepted
36680 on a proxied connection
36681 or the &"=>"& line for a message delivered on a proxied connection.
36682 See &<<SECTproxyInbound>>& for more information.
36683 .next
36684 .cindex "log" "incoming remote port"
36685 .cindex "port" "logging remote"
36686 .cindex "TCP/IP" "logging incoming remote port"
36687 .vindex "&$sender_fullhost$&"
36688 .vindex "&$sender_rcvhost$&"
36689 &%incoming_port%&: The remote port number from which a message was received is
36690 added to log entries and &'Received:'& header lines, following the IP address
36691 in square brackets, and separated from it by a colon. This is implemented by
36692 changing the value that is put in the &$sender_fullhost$& and
36693 &$sender_rcvhost$& variables. Recording the remote port number has become more
36694 important with the widening use of NAT (see RFC 2505).
36695 .next
36696 .cindex "log" "dropped connection"
36697 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
36698 connection is unexpectedly dropped.
36699 .next
36700 .cindex "log" "millisecond timestamps"
36701 .cindex millisecond logging
36702 .cindex timestamps "millisecond, in logs"
36703 &%millisec%&: Timestamps have a period and three decimal places of finer granularity
36704 appended to the seconds value.
36705 .next
36706 .cindex "log" "outgoing interface"
36707 .cindex "log" "local interface"
36708 .cindex "log" "local address and port"
36709 .cindex "TCP/IP" "logging local address and port"
36710 .cindex "interface" "logging"
36711 &%outgoing_interface%&: If &%incoming_interface%& is turned on, then the
36712 interface on which a message was sent is added to delivery lines as an I= tag
36713 followed by IP address in square brackets. You can disable this by turning
36714 off the &%outgoing_interface%& option.
36715 .next
36716 .cindex "log" "outgoing remote port"
36717 .cindex "port" "logging outgoing remote"
36718 .cindex "TCP/IP" "logging outgoing remote port"
36719 &%outgoing_port%&: The remote port number is added to delivery log lines (those
36720 containing => tags) following the IP address.
36721 The local port is also added if &%incoming_interface%& and
36722 &%outgoing_interface%& are both enabled.
36723 This option is not included in the default setting, because for most ordinary
36724 configurations, the remote port number is always 25 (the SMTP port), and the
36725 local port is a random ephemeral port.
36726 .next
36727 .cindex "log" "process ids in"
36728 .cindex "pid (process id)" "in log lines"
36729 &%pid%&: The current process id is added to every log line, in square brackets,
36730 immediately after the time and date.
36731 .next
36732 .cindex "log" "queue run"
36733 .cindex "queue runner" "logging"
36734 &%queue_run%&: The start and end of every queue run are logged.
36735 .next
36736 .cindex "log" "queue time"
36737 &%queue_time%&: The amount of time the message has been in the queue on the
36738 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
36739 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
36740 includes reception time as well as the delivery time for the current address.
36741 This means that it may be longer than the difference between the arrival and
36742 delivery log line times, because the arrival log line is not written until the
36743 message has been successfully received.
36744 If millisecond logging is enabled, short times will be shown with greater
36745 precision, eg. &`QT=1.578s`&.
36746 .next
36747 &%queue_time_overall%&: The amount of time the message has been in the queue on
36748 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
36749 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
36750 message, so it includes reception time as well as the total delivery time.
36751 .new
36752 .next
36753 .cindex "log" "receive duration"
36754 &%receive_time%&: For each message, the amount of real time it has taken to
36755 perform the reception is logged as RT=<&'time'&>, for example, &`RT=1s`&.
36756 If millisecond logging is enabled, short times will be shown with greater
36757 precision, eg. &`RT=0.204s`&.
36758 .wen
36759 .next
36760 .cindex "log" "recipients"
36761 &%received_recipients%&: The recipients of a message are listed in the main log
36762 as soon as the message is received. The list appears at the end of the log line
36763 that is written when a message is received, preceded by the word &"for"&. The
36764 addresses are listed after they have been qualified, but before any rewriting
36765 has taken place.
36766 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
36767 in the list.
36768 .next
36769 .cindex "log" "sender reception"
36770 &%received_sender%&: The unrewritten original sender of a message is added to
36771 the end of the log line that records the message's arrival, after the word
36772 &"from"& (before the recipients if &%received_recipients%& is also set).
36773 .next
36774 .cindex "log" "header lines for rejection"
36775 &%rejected_header%&: If a message's header has been received at the time a
36776 rejection is written to the reject log, the complete header is added to the
36777 log. Header logging can be turned off individually for messages that are
36778 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
36779 .next
36780 .cindex "log" "retry defer"
36781 &%retry_defer%&: A log line is written if a delivery is deferred because a
36782 retry time has not yet been reached. However, this &"retry time not reached"&
36783 message is always omitted from individual message logs after the first delivery
36784 attempt.
36785 .next
36786 .cindex "log" "return path"
36787 &%return_path_on_delivery%&: The return path that is being transmitted with
36788 the message is included in delivery and bounce lines, using the tag P=.
36789 This is omitted if no delivery actually happens, for example, if routing fails,
36790 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
36791 .next
36792 .cindex "log" "sender on delivery"
36793 &%sender_on_delivery%&: The message's sender address is added to every delivery
36794 and bounce line, tagged by F= (for &"from"&).
36795 This is the original sender that was received with the message; it is not
36796 necessarily the same as the outgoing return path.
36797 .next
36798 .cindex "log" "sender verify failure"
36799 &%sender_verify_fail%&: If this selector is unset, the separate log line that
36800 gives details of a sender verification failure is not written. Log lines for
36801 the rejection of SMTP commands contain just &"sender verify failed"&, so some
36802 detail is lost.
36803 .next
36804 .cindex "log" "size rejection"
36805 &%size_reject%&: A log line is written whenever a message is rejected because
36806 it is too big.
36807 .next
36808 .cindex "log" "frozen messages; skipped"
36809 .cindex "frozen messages" "logging skipping"
36810 &%skip_delivery%&: A log line is written whenever a message is skipped during a
36811 queue run because it is frozen or because another process is already delivering
36812 it.
36813 .cindex "&""spool file is locked""&"
36814 The message that is written is &"spool file is locked"&.
36815 .next
36816 .cindex "log" "smtp confirmation"
36817 .cindex "SMTP" "logging confirmation"
36818 .cindex "LMTP" "logging confirmation"
36819 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
36820 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
36821 A number of MTAs (including Exim) return an identifying string in this
36822 response.
36823 .next
36824 .cindex "log" "SMTP connections"
36825 .cindex "SMTP" "logging connections"
36826 &%smtp_connection%&: A log line is written whenever an incoming SMTP connection is
36827 established or closed, unless the connection is from a host that matches
36828 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
36829 only when the closure is unexpected.) This applies to connections from local
36830 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
36831 dropped in the middle of a message, a log line is always written, whether or
36832 not this selector is set, but otherwise nothing is written at the start and end
36833 of connections unless this selector is enabled.
36834
36835 For TCP/IP connections to an Exim daemon, the current number of connections is
36836 included in the log message for each new connection, but note that the count is
36837 reset if the daemon is restarted.
36838 Also, because connections are closed (and the closure is logged) in
36839 subprocesses, the count may not include connections that have been closed but
36840 whose termination the daemon has not yet noticed. Thus, while it is possible to
36841 match up the opening and closing of connections in the log, the value of the
36842 logged counts may not be entirely accurate.
36843 .next
36844 .cindex "log" "SMTP transaction; incomplete"
36845 .cindex "SMTP" "logging incomplete transactions"
36846 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
36847 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
36848 and the message sender plus any accepted recipients are included in the log
36849 line. This can provide evidence of dictionary attacks.
36850 .next
36851 .cindex "log" "non-MAIL SMTP sessions"
36852 .cindex "MAIL" "logging session without"
36853 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
36854 connection terminates without having issued a MAIL command. This includes both
36855 the case when the connection is dropped, and the case when QUIT is used. It
36856 does not include cases where the connection is rejected right at the start (by
36857 an ACL, or because there are too many connections, or whatever). These cases
36858 already have their own log lines.
36859
36860 The log line that is written contains the identity of the client in the usual
36861 way, followed by D= and a time, which records the duration of the connection.
36862 If the connection was authenticated, this fact is logged exactly as it is for
36863 an incoming message, with an A= item. If the connection was encrypted, CV=,
36864 DN=, and X= items may appear as they do for an incoming message, controlled by
36865 the same logging options.
36866
36867 Finally, if any SMTP commands were issued during the connection, a C= item
36868 is added to the line, listing the commands that were used. For example,
36869 .code
36870 C=EHLO,QUIT
36871 .endd
36872 shows that the client issued QUIT straight after EHLO. If there were fewer
36873 than 20 commands, they are all listed. If there were more than 20 commands,
36874 the last 20 are listed, preceded by &"..."&. However, with the default
36875 setting of 10 for &%smtp_accept_max_nonmail%&, the connection will in any case
36876 have been aborted before 20 non-mail commands are processed.
36877 .next
36878 &%smtp_mailauth%&: A third subfield with the authenticated sender,
36879 colon-separated, is appended to the A= item for a message arrival or delivery
36880 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
36881 was accepted or used.
36882 .next
36883 .cindex "log" "SMTP protocol error"
36884 .cindex "SMTP" "logging protocol error"
36885 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
36886 encountered. Exim does not have perfect detection of all protocol errors
36887 because of transmission delays and the use of pipelining. If PIPELINING has
36888 been advertised to a client, an Exim server assumes that the client will use
36889 it, and therefore it does not count &"expected"& errors (for example, RCPT
36890 received after rejecting MAIL) as protocol errors.
36891 .next
36892 .cindex "SMTP" "logging syntax errors"
36893 .cindex "SMTP" "syntax errors; logging"
36894 .cindex "SMTP" "unknown command; logging"
36895 .cindex "log" "unknown SMTP command"
36896 .cindex "log" "SMTP syntax error"
36897 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
36898 encountered. An unrecognized command is treated as a syntax error. For an
36899 external connection, the host identity is given; for an internal connection
36900 using &%-bs%& the sender identification (normally the calling user) is given.
36901 .next
36902 .cindex "log" "subject"
36903 .cindex "subject, logging"
36904 &%subject%&: The subject of the message is added to the arrival log line,
36905 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
36906 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
36907 specifies whether characters with values greater than 127 should be logged
36908 unchanged, or whether they should be rendered as escape sequences.
36909 .next
36910 .cindex "log" "certificate verification"
36911 .cindex log DANE
36912 .cindex DANE logging
36913 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
36914 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
36915 verified
36916 .new
36917 using a CA trust anchor,
36918 &`CA=dane`& if using a DNS trust anchor,
36919 .wen
36920 and &`CV=no`& if not.
36921 .next
36922 .cindex "log" "TLS cipher"
36923 .cindex "TLS" "logging cipher"
36924 &%tls_cipher%&: When a message is sent or received over an encrypted
36925 connection, the cipher suite used is added to the log line, preceded by X=.
36926 .next
36927 .cindex "log" "TLS peer DN"
36928 .cindex "TLS" "logging peer DN"
36929 &%tls_peerdn%&: When a message is sent or received over an encrypted
36930 connection, and a certificate is supplied by the remote host, the peer DN is
36931 added to the log line, preceded by DN=.
36932 .next
36933 .cindex "log" "TLS SNI"
36934 .cindex "TLS" "logging SNI"
36935 &%tls_sni%&: When a message is received over an encrypted connection, and
36936 the remote host provided the Server Name Indication extension, the SNI is
36937 added to the log line, preceded by SNI=.
36938 .next
36939 .cindex "log" "DNS failure in list"
36940 &%unknown_in_list%&: This setting causes a log entry to be written when the
36941 result of a list match is failure because a DNS lookup failed.
36942 .endlist
36943
36944
36945 .section "Message log" "SECID260"
36946 .cindex "message" "log file for"
36947 .cindex "log" "message log; description of"
36948 .cindex "&_msglog_& directory"
36949 .oindex "&%preserve_message_logs%&"
36950 In addition to the general log files, Exim writes a log file for each message
36951 that it handles. The names of these per-message logs are the message ids, and
36952 they are kept in the &_msglog_& sub-directory of the spool directory. Each
36953 message log contains copies of the log lines that apply to the message. This
36954 makes it easier to inspect the status of an individual message without having
36955 to search the main log. A message log is deleted when processing of the message
36956 is complete, unless &%preserve_message_logs%& is set, but this should be used
36957 only with great care because they can fill up your disk very quickly.
36958
36959 On a heavily loaded system, it may be desirable to disable the use of
36960 per-message logs, in order to reduce disk I/O. This can be done by setting the
36961 &%message_logs%& option false.
36962 .ecindex IIDloggen
36963
36964
36965
36966
36967 . ////////////////////////////////////////////////////////////////////////////
36968 . ////////////////////////////////////////////////////////////////////////////
36969
36970 .chapter "Exim utilities" "CHAPutils"
36971 .scindex IIDutils "utilities"
36972 A number of utility scripts and programs are supplied with Exim and are
36973 described in this chapter. There is also the Exim Monitor, which is covered in
36974 the next chapter. The utilities described here are:
36975
36976 .itable none 0 0 3  7* left  15* left  40* left
36977 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
36978   "list what Exim processes are doing"
36979 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
36980 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
36981 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
36982 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
36983                                                 various criteria"
36984 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
36985 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
36986   "extract statistics from the log"
36987 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
36988   "check address acceptance from given IP"
36989 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
36990 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
36991 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
36992 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
36993 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
36994 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
36995 .endtable
36996
36997 Another utility that might be of use to sites with many MTAs is Tom Kistner's
36998 &'exilog'&. It provides log visualizations across multiple Exim servers. See
36999 &url(http://duncanthrax.net/exilog/) for details.
37000
37001
37002
37003
37004 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
37005 .cindex "&'exiwhat'&"
37006 .cindex "process, querying"
37007 .cindex "SIGUSR1"
37008 On operating systems that can restart a system call after receiving a signal
37009 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
37010 a line describing what it is doing to the file &_exim-process.info_& in the
37011 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
37012 processes it can find, having first emptied the file. It then waits for one
37013 second to allow the Exim processes to react before displaying the results. In
37014 order to run &'exiwhat'& successfully you have to have sufficient privilege to
37015 send the signal to the Exim processes, so it is normally run as root.
37016
37017 &*Warning*&: This is not an efficient process. It is intended for occasional
37018 use by system administrators. It is not sensible, for example, to set up a
37019 script that sends SIGUSR1 signals to Exim processes at short intervals.
37020
37021
37022 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
37023 varies in different operating systems. Not only are different options used,
37024 but the format of the output is different. For this reason, there are some
37025 system configuration options that configure exactly how &'exiwhat'& works. If
37026 it doesn't seem to be working for you, check the following compile-time
37027 options:
37028 .display
37029 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
37030 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
37031 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
37032 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
37033 .endd
37034 An example of typical output from &'exiwhat'& is
37035 .code
37036 164 daemon: -q1h, listening on port 25
37037 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
37038 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
37039   [10.19.42.42] (editor@ref.example)
37040 10592 handling incoming call from [192.168.243.242]
37041 10628 accepting a local non-SMTP message
37042 .endd
37043 The first number in the output line is the process number. The third line has
37044 been split here, in order to fit it on the page.
37045
37046
37047
37048 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
37049 .cindex "&'exiqgrep'&"
37050 .cindex "queue" "grepping"
37051 This utility is a Perl script contributed by Matt Hubbard. It runs
37052 .code
37053 exim -bpu
37054 .endd
37055 or (in case &*-a*& switch is specified)
37056 .code
37057 exim -bp
37058 .endd
37059 The &*-C*& option is used to specify an alternate &_exim.conf_& which might
37060 contain alternate exim configuration the queue management might be using.
37061
37062 to obtain a queue listing, and then greps the output to select messages
37063 that match given criteria. The following selection options are available:
37064
37065 .vlist
37066 .vitem &*-f*&&~<&'regex'&>
37067 Match the sender address using a case-insensitive search. The field that is
37068 tested is enclosed in angle brackets, so you can test for bounce messages with
37069 .code
37070 exiqgrep -f '^<>$'
37071 .endd
37072 .vitem &*-r*&&~<&'regex'&>
37073 Match a recipient address using a case-insensitive search. The field that is
37074 tested is not enclosed in angle brackets.
37075
37076 .vitem &*-s*&&~<&'regex'&>
37077 Match against the size field.
37078
37079 .vitem &*-y*&&~<&'seconds'&>
37080 Match messages that are younger than the given time.
37081
37082 .vitem &*-o*&&~<&'seconds'&>
37083 Match messages that are older than the given time.
37084
37085 .vitem &*-z*&
37086 Match only frozen messages.
37087
37088 .vitem &*-x*&
37089 Match only non-frozen messages.
37090 .endlist
37091
37092 The following options control the format of the output:
37093
37094 .vlist
37095 .vitem &*-c*&
37096 Display only the count of matching messages.
37097
37098 .vitem &*-l*&
37099 Long format &-- display the full message information as output by Exim. This is
37100 the default.
37101
37102 .vitem &*-i*&
37103 Display message ids only.
37104
37105 .vitem &*-b*&
37106 Brief format &-- one line per message.
37107
37108 .vitem &*-R*&
37109 Display messages in reverse order.
37110
37111 .vitem &*-a*&
37112 Include delivered recipients in queue listing.
37113 .endlist
37114
37115 There is one more option, &%-h%&, which outputs a list of options.
37116
37117
37118
37119 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
37120 .cindex "&'exiqsumm'&"
37121 .cindex "queue" "summary"
37122 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
37123 -bp`& and produces a summary of the messages on the queue. Thus, you use it by
37124 running a command such as
37125 .code
37126 exim -bp | exiqsumm
37127 .endd
37128 The output consists of one line for each domain that has messages waiting for
37129 it, as in the following example:
37130 .code
37131 3   2322   74m   66m  msn.com.example
37132 .endd
37133 Each line lists the number of pending deliveries for a domain, their total
37134 volume, and the length of time that the oldest and the newest messages have
37135 been waiting. Note that the number of pending deliveries is greater than the
37136 number of messages when messages have more than one recipient.
37137
37138 A summary line is output at the end. By default the output is sorted on the
37139 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
37140 the output to be sorted by oldest message and by count of messages,
37141 respectively. There are also three options that split the messages for each
37142 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
37143 separates frozen messages, and &%-s%& separates messages according to their
37144 sender.
37145
37146 The output of &'exim -bp'& contains the original addresses in the message, so
37147 this also applies to the output from &'exiqsumm'&. No domains from addresses
37148 generated by aliasing or forwarding are included (unless the &%one_time%&
37149 option of the &(redirect)& router has been used to convert them into &"top
37150 level"& addresses).
37151
37152
37153
37154
37155 .section "Extracting specific information from the log (exigrep)" &&&
37156          "SECTextspeinf"
37157 .cindex "&'exigrep'&"
37158 .cindex "log" "extracts; grepping for"
37159 The &'exigrep'& utility is a Perl script that searches one or more main log
37160 files for entries that match a given pattern. When it finds a match, it
37161 extracts all the log entries for the relevant message, not just those that
37162 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
37163 given message, or all mail for a given user, or for a given host, for example.
37164 The input files can be in Exim log format or syslog format.
37165 If a matching log line is not associated with a specific message, it is
37166 included in &'exigrep'&'s output without any additional lines. The usage is:
37167 .display
37168 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-M] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
37169 .endd
37170 If no log file names are given on the command line, the standard input is read.
37171
37172 The &%-t%& argument specifies a number of seconds. It adds an additional
37173 condition for message selection. Messages that are complete are shown only if
37174 they spent more than <&'n'&> seconds on the queue.
37175
37176 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
37177 makes it case-sensitive. This may give a performance improvement when searching
37178 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
37179 option; with &%-I%& they do not. In both cases it is possible to change the
37180 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
37181
37182 The &%-l%& option means &"literal"&, that is, treat all characters in the
37183 pattern as standing for themselves. Otherwise the pattern must be a Perl
37184 regular expression.
37185
37186 The &%-v%& option inverts the matching condition. That is, a line is selected
37187 if it does &'not'& match the pattern.
37188
37189 The &%-M%& options means &"related messages"&. &'exigrep'& will show messages
37190 that are generated as a result/response to a message that &'exigrep'& matched
37191 normally.
37192
37193 Example of &%-M%&:
37194 user_a sends a message to user_b, which generates a bounce back to user_b. If
37195 &'exigrep'& is used to search for &"user_a"&, only the first message will be
37196 displayed.  But if &'exigrep'& is used to search for &"user_b"&, the first and
37197 the second (bounce) message will be displayed. Using &%-M%& with &'exigrep'&
37198 when searching for &"user_a"& will show both messages since the bounce is
37199 &"related"& to or a &"result"& of the first message that was found by the
37200 search term.
37201
37202 If the location of a &'zcat'& command is known from the definition of
37203 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
37204 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
37205 If the ZCAT_COMMAND is not executable, &'exigrep'& tries to use
37206 autodetection of some well known compression extensions.
37207
37208
37209 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
37210 .cindex "&'exipick'&"
37211 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
37212 lists messages from the queue according to a variety of criteria. For details
37213 of &'exipick'&'s facilities, run &'exipick'& with
37214 the &%--help%& option.
37215
37216
37217 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
37218 .cindex "log" "cycling local files"
37219 .cindex "cycling logs"
37220 .cindex "&'exicyclog'&"
37221 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
37222 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
37223 you are using log files with datestamps in their names (see section
37224 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
37225 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
37226 There are two command line options for &'exicyclog'&:
37227 .ilist
37228 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
37229 default that is set when Exim is built. The default default is 10.
37230 .next
37231 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
37232 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
37233 overriding the script's default, which is to find the setting from Exim's
37234 configuration.
37235 .endlist
37236
37237 Each time &'exicyclog'& is run the file names get &"shuffled down"& by one. If
37238 the main log file name is &_mainlog_& (the default) then when &'exicyclog'& is
37239 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
37240 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
37241 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
37242 logs are handled similarly.
37243
37244 If the limit is greater than 99, the script uses 3-digit numbers such as
37245 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
37246 to one that is greater, or &'vice versa'&, you will have to fix the names of
37247 any existing log files.
37248
37249 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
37250 the end are deleted. All files with numbers greater than 01 are compressed,
37251 using a compression command which is configured by the COMPRESS_COMMAND
37252 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
37253 root &%crontab%& entry of the form
37254 .code
37255 1 0 * * * su exim -c /usr/exim/bin/exicyclog
37256 .endd
37257 assuming you have used the name &"exim"& for the Exim user. You can run
37258 &'exicyclog'& as root if you wish, but there is no need.
37259
37260
37261
37262 .section "Mail statistics (eximstats)" "SECTmailstat"
37263 .cindex "statistics"
37264 .cindex "&'eximstats'&"
37265 A Perl script called &'eximstats'& is provided for extracting statistical
37266 information from log files. The output is either plain text, or HTML.
37267 Exim log files are also supported by the &'Lire'& system produced by the
37268 LogReport Foundation &url(http://www.logreport.org).
37269
37270 The &'eximstats'& script has been hacked about quite a bit over time. The
37271 latest version is the result of some extensive revision by Steve Campbell. A
37272 lot of information is given by default, but there are options for suppressing
37273 various parts of it. Following any options, the arguments to the script are a
37274 list of files, which should be main log files. For example:
37275 .code
37276 eximstats -nr /var/spool/exim/log/mainlog.01
37277 .endd
37278 By default, &'eximstats'& extracts information about the number and volume of
37279 messages received from or delivered to various hosts. The information is sorted
37280 both by message count and by volume, and the top fifty hosts in each category
37281 are listed on the standard output. Similar information, based on email
37282 addresses or domains instead of hosts can be requested by means of various
37283 options. For messages delivered and received locally, similar statistics are
37284 also produced per user.
37285
37286 The output also includes total counts and statistics about delivery errors, and
37287 histograms showing the number of messages received and deliveries made in each
37288 hour of the day. A delivery with more than one address in its envelope (for
37289 example, an SMTP transaction with more than one RCPT command) is counted
37290 as a single delivery by &'eximstats'&.
37291
37292 Though normally more deliveries than receipts are reported (as messages may
37293 have multiple recipients), it is possible for &'eximstats'& to report more
37294 messages received than delivered, even though the queue is empty at the start
37295 and end of the period in question. If an incoming message contains no valid
37296 recipients, no deliveries are recorded for it. A bounce message is handled as
37297 an entirely separate message.
37298
37299 &'eximstats'& always outputs a grand total summary giving the volume and number
37300 of messages received and deliveries made, and the number of hosts involved in
37301 each case. It also outputs the number of messages that were delayed (that is,
37302 not completely delivered at the first attempt), and the number that had at
37303 least one address that failed.
37304
37305 The remainder of the output is in sections that can be independently disabled
37306 or modified by various options. It consists of a summary of deliveries by
37307 transport, histograms of messages received and delivered per time interval
37308 (default per hour), information about the time messages spent on the queue,
37309 a list of relayed messages, lists of the top fifty sending hosts, local
37310 senders, destination hosts, and destination local users by count and by volume,
37311 and a list of delivery errors that occurred.
37312
37313 The relay information lists messages that were actually relayed, that is, they
37314 came from a remote host and were directly delivered to some other remote host,
37315 without being processed (for example, for aliasing or forwarding) locally.
37316
37317 There are quite a few options for &'eximstats'& to control exactly what it
37318 outputs. These are documented in the Perl script itself, and can be extracted
37319 by running the command &(perldoc)& on the script. For example:
37320 .code
37321 perldoc /usr/exim/bin/eximstats
37322 .endd
37323
37324 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
37325 .cindex "&'exim_checkaccess'&"
37326 .cindex "policy control" "checking access"
37327 .cindex "checking access"
37328 The &%-bh%& command line argument allows you to run a fake SMTP session with
37329 debugging output, in order to check what Exim is doing when it is applying
37330 policy controls to incoming SMTP mail. However, not everybody is sufficiently
37331 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
37332 sometimes you just want to answer the question &"Does this address have
37333 access?"& without bothering with any further details.
37334
37335 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
37336 two arguments, an IP address and an email address:
37337 .code
37338 exim_checkaccess 10.9.8.7 A.User@a.domain.example
37339 .endd
37340 The utility runs a call to Exim with the &%-bh%& option, to test whether the
37341 given email address would be accepted in a RCPT command in a TCP/IP
37342 connection from the host with the given IP address. The output of the utility
37343 is either the word &"accepted"&, or the SMTP error response, for example:
37344 .code
37345 Rejected:
37346 550 Relay not permitted
37347 .endd
37348 When running this test, the utility uses &`<>`& as the envelope sender address
37349 for the MAIL command, but you can change this by providing additional
37350 options. These are passed directly to the Exim command. For example, to specify
37351 that the test is to be run with the sender address &'himself@there.example'&
37352 you can use:
37353 .code
37354 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
37355                  -f himself@there.example
37356 .endd
37357 Note that these additional Exim command line items must be given after the two
37358 mandatory arguments.
37359
37360 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
37361 while running its checks. You can run checks that include callouts by using
37362 &%-bhc%&, but this is not yet available in a &"packaged"& form.
37363
37364
37365
37366 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
37367 .cindex "DBM" "building dbm files"
37368 .cindex "building DBM files"
37369 .cindex "&'exim_dbmbuild'&"
37370 .cindex "lower casing"
37371 .cindex "binary zero" "in lookup key"
37372 The &'exim_dbmbuild'& program reads an input file containing keys and data in
37373 the format used by the &(lsearch)& lookup (see section
37374 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
37375 names as keys and the remainder of the information as data. The lower-casing
37376 can be prevented by calling the program with the &%-nolc%& option.
37377
37378 A terminating zero is included as part of the key string. This is expected by
37379 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
37380 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
37381 strings or the data strings. The &(dbmnz)& lookup type can be used with such
37382 files.
37383
37384 The program requires two arguments: the name of the input file (which can be a
37385 single hyphen to indicate the standard input), and the name of the output file.
37386 It creates the output under a temporary name, and then renames it if all went
37387 well.
37388
37389 .cindex "USE_DB"
37390 If the native DB interface is in use (USE_DB is set in a compile-time
37391 configuration file &-- this is common in free versions of Unix) the two file
37392 names must be different, because in this mode the Berkeley DB functions create
37393 a single output file using exactly the name given. For example,
37394 .code
37395 exim_dbmbuild /etc/aliases /etc/aliases.db
37396 .endd
37397 reads the system alias file and creates a DBM version of it in
37398 &_/etc/aliases.db_&.
37399
37400 In systems that use the &'ndbm'& routines (mostly proprietary versions of
37401 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
37402 environment, the suffixes are added to the second argument of
37403 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
37404 when the Berkeley functions are used in compatibility mode (though this is not
37405 recommended), because in that case it adds a &_.db_& suffix to the file name.
37406
37407 If a duplicate key is encountered, the program outputs a warning, and when it
37408 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
37409 option is used. By default, only the first of a set of duplicates is used &--
37410 this makes it compatible with &(lsearch)& lookups. There is an option
37411 &%-lastdup%& which causes it to use the data for the last duplicate instead.
37412 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
37413 &%stderr%&. For other errors, where it doesn't actually make a new file, the
37414 return code is 2.
37415
37416
37417
37418
37419 .section "Finding individual retry times (exinext)" "SECTfinindret"
37420 .cindex "retry" "times"
37421 .cindex "&'exinext'&"
37422 A utility called &'exinext'& (mostly a Perl script) provides the ability to
37423 fish specific information out of the retry database. Given a mail domain (or a
37424 complete address), it looks up the hosts for that domain, and outputs any retry
37425 information for the hosts or for the domain. At present, the retry information
37426 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
37427 output. For example:
37428 .code
37429 $ exinext piglet@milne.fict.example
37430 kanga.milne.example:192.168.8.1 error 146: Connection refused
37431   first failed: 21-Feb-1996 14:57:34
37432   last tried:   21-Feb-1996 14:57:34
37433   next try at:  21-Feb-1996 15:02:34
37434 roo.milne.example:192.168.8.3 error 146: Connection refused
37435   first failed: 20-Jan-1996 13:12:08
37436   last tried:   21-Feb-1996 11:42:03
37437   next try at:  21-Feb-1996 19:42:03
37438   past final cutoff time
37439 .endd
37440 You can also give &'exinext'& a local part, without a domain, and it
37441 will give any retry information for that local part in your default domain.
37442 A message id can be used to obtain retry information pertaining to a specific
37443 message. This exists only when an attempt to deliver a message to a remote host
37444 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
37445 &'exinext'& is not particularly efficient, but then it is not expected to be
37446 run very often.
37447
37448 The &'exinext'& utility calls Exim to find out information such as the location
37449 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
37450 passed on to the &'exim'& commands. The first specifies an alternate Exim
37451 configuration file, and the second sets macros for use within the configuration
37452 file. These features are mainly to help in testing, but might also be useful in
37453 environments where more than one configuration file is in use.
37454
37455
37456
37457 .section "Hints database maintenance" "SECThindatmai"
37458 .cindex "hints database" "maintenance"
37459 .cindex "maintaining Exim's hints database"
37460 Three utility programs are provided for maintaining the DBM files that Exim
37461 uses to contain its delivery hint information. Each program requires two
37462 arguments. The first specifies the name of Exim's spool directory, and the
37463 second is the name of the database it is to operate on. These are as follows:
37464
37465 .ilist
37466 &'retry'&: the database of retry information
37467 .next
37468 &'wait-'&<&'transport name'&>: databases of information about messages waiting
37469 for remote hosts
37470 .next
37471 &'callout'&: the callout cache
37472 .next
37473 &'ratelimit'&: the data for implementing the ratelimit ACL condition
37474 .next
37475 &'misc'&: other hints data
37476 .endlist
37477
37478 The &'misc'& database is used for
37479
37480 .ilist
37481 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
37482 .next
37483 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
37484 &(smtp)& transport)
37485 .next
37486 Limiting the concurrency of specific transports (when &%max_parallel%& is set
37487 in a transport)
37488 .endlist
37489
37490
37491
37492 .section "exim_dumpdb" "SECID261"
37493 .cindex "&'exim_dumpdb'&"
37494 The entire contents of a database are written to the standard output by the
37495 &'exim_dumpdb'& program, which has no options or arguments other than the
37496 spool and database names. For example, to dump the retry database:
37497 .code
37498 exim_dumpdb /var/spool/exim retry
37499 .endd
37500 Two lines of output are produced for each entry:
37501 .code
37502 T:mail.ref.example:192.168.242.242 146 77 Connection refused
37503 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
37504 .endd
37505 The first item on the first line is the key of the record. It starts with one
37506 of the letters R, or T, depending on whether it refers to a routing or
37507 transport retry. For a local delivery, the next part is the local address; for
37508 a remote delivery it is the name of the remote host, followed by its failing IP
37509 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
37510 transport). If the remote port is not the standard one (port 25), it is added
37511 to the IP address. Then there follows an error code, an additional error code,
37512 and a textual description of the error.
37513
37514 The three times on the second line are the time of first failure, the time of
37515 the last delivery attempt, and the computed time for the next attempt. The line
37516 ends with an asterisk if the cutoff time for the last retry rule has been
37517 exceeded.
37518
37519 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
37520 consists of a host name followed by a list of ids for messages that are or were
37521 waiting to be delivered to that host. If there are a very large number for any
37522 one host, continuation records, with a sequence number added to the host name,
37523 may be seen. The data in these records is often out of date, because a message
37524 may be routed to several alternative hosts, and Exim makes no effort to keep
37525 cross-references.
37526
37527
37528
37529 .section "exim_tidydb" "SECID262"
37530 .cindex "&'exim_tidydb'&"
37531 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
37532 database. If run with no options, it removes all records that are more than 30
37533 days old. The age is calculated from the date and time that the record was last
37534 updated. Note that, in the case of the retry database, it is &'not'& the time
37535 since the first delivery failure. Information about a host that has been down
37536 for more than 30 days will remain in the database, provided that the record is
37537 updated sufficiently often.
37538
37539 The cutoff date can be altered by means of the &%-t%& option, which must be
37540 followed by a time. For example, to remove all records older than a week from
37541 the retry database:
37542 .code
37543 exim_tidydb -t 7d /var/spool/exim retry
37544 .endd
37545 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
37546 message ids. In the former these appear as data in records keyed by host &--
37547 they were messages that were waiting for that host &-- and in the latter they
37548 are the keys for retry information for messages that have suffered certain
37549 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
37550 message ids in database records are those of messages that are still on the
37551 queue. Message ids for messages that no longer exist are removed from
37552 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
37553 For the &'retry'& database, records whose keys are non-existent message ids are
37554 removed. The &'exim_tidydb'& utility outputs comments on the standard output
37555 whenever it removes information from the database.
37556
37557 Certain records are automatically removed by Exim when they are no longer
37558 needed, but others are not. For example, if all the MX hosts for a domain are
37559 down, a retry record is created for each one. If the primary MX host comes back
37560 first, its record is removed when Exim successfully delivers to it, but the
37561 records for the others remain because Exim has not tried to use those hosts.
37562
37563 It is important, therefore, to run &'exim_tidydb'& periodically on all the
37564 hints databases. You should do this at a quiet time of day, because it requires
37565 a database to be locked (and therefore inaccessible to Exim) while it does its
37566 work. Removing records from a DBM file does not normally make the file smaller,
37567 but all the common DBM libraries are able to re-use the space that is released.
37568 After an initial phase of increasing in size, the databases normally reach a
37569 point at which they no longer get any bigger, as long as they are regularly
37570 tidied.
37571
37572 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
37573 databases is likely to keep on increasing.
37574
37575
37576
37577
37578 .section "exim_fixdb" "SECID263"
37579 .cindex "&'exim_fixdb'&"
37580 The &'exim_fixdb'& program is a utility for interactively modifying databases.
37581 Its main use is for testing Exim, but it might also be occasionally useful for
37582 getting round problems in a live system. It has no options, and its interface
37583 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
37584 key of a database record can then be entered, and the data for that record is
37585 displayed.
37586
37587 If &"d"& is typed at the next prompt, the entire record is deleted. For all
37588 except the &'retry'& database, that is the only operation that can be carried
37589 out. For the &'retry'& database, each field is output preceded by a number, and
37590 data for individual fields can be changed by typing the field number followed
37591 by new data, for example:
37592 .code
37593 > 4 951102:1000
37594 .endd
37595 resets the time of the next delivery attempt. Time values are given as a
37596 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
37597 used as optional separators.
37598
37599
37600
37601
37602 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
37603 .cindex "mailbox" "maintenance"
37604 .cindex "&'exim_lock'&"
37605 .cindex "locking mailboxes"
37606 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
37607 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
37608 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
37609 a user agent while investigating a problem. The utility requires the name of
37610 the file as its first argument. If the locking is successful, the second
37611 argument is run as a command (using C's &[system()]& function); if there is no
37612 second argument, the value of the SHELL environment variable is used; if this
37613 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
37614 is unlocked and the utility ends. The following options are available:
37615
37616 .vlist
37617 .vitem &%-fcntl%&
37618 Use &[fcntl()]& locking on the open mailbox.
37619
37620 .vitem &%-flock%&
37621 Use &[flock()]& locking on the open mailbox, provided the operating system
37622 supports it.
37623
37624 .vitem &%-interval%&
37625 This must be followed by a number, which is a number of seconds; it sets the
37626 interval to sleep between retries (default 3).
37627
37628 .vitem &%-lockfile%&
37629 Create a lock file before opening the mailbox.
37630
37631 .vitem &%-mbx%&
37632 Lock the mailbox using MBX rules.
37633
37634 .vitem &%-q%&
37635 Suppress verification output.
37636
37637 .vitem &%-retries%&
37638 This must be followed by a number; it sets the number of times to try to get
37639 the lock (default 10).
37640
37641 .vitem &%-restore_time%&
37642 This option causes &%exim_lock%& to restore the modified and read times to the
37643 locked file before exiting. This allows you to access a locked mailbox (for
37644 example, to take a backup copy) without disturbing the times that the user
37645 subsequently sees.
37646
37647 .vitem &%-timeout%&
37648 This must be followed by a number, which is a number of seconds; it sets a
37649 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
37650 default), a non-blocking call is used.
37651
37652 .vitem &%-v%&
37653 Generate verbose output.
37654 .endlist
37655
37656 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
37657 default is to create a lock file and also to use &[fcntl()]& locking on the
37658 mailbox, which is the same as Exim's default. The use of &%-flock%& or
37659 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
37660 requires that the directory containing the file be writeable. Locking by lock
37661 file does not last for ever; Exim assumes that a lock file is expired if it is
37662 more than 30 minutes old.
37663
37664 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
37665 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
37666 to be taken out on the open mailbox, and an exclusive lock on the file
37667 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
37668 number of the mailbox file. When the locking is released, if an exclusive lock
37669 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
37670
37671 The default output contains verification of the locking that takes place. The
37672 &%-v%& option causes some additional information to be given. The &%-q%& option
37673 suppresses all output except error messages.
37674
37675 A command such as
37676 .code
37677 exim_lock /var/spool/mail/spqr
37678 .endd
37679 runs an interactive shell while the file is locked, whereas
37680 .display
37681 &`exim_lock -q /var/spool/mail/spqr <<End`&
37682 <&'some commands'&>
37683 &`End`&
37684 .endd
37685 runs a specific non-interactive sequence of commands while the file is locked,
37686 suppressing all verification output. A single command can be run by a command
37687 such as
37688 .code
37689 exim_lock -q /var/spool/mail/spqr \
37690   "cp /var/spool/mail/spqr /some/where"
37691 .endd
37692 Note that if a command is supplied, it must be entirely contained within the
37693 second argument &-- hence the quotes.
37694 .ecindex IIDutils
37695
37696
37697 . ////////////////////////////////////////////////////////////////////////////
37698 . ////////////////////////////////////////////////////////////////////////////
37699
37700 .chapter "The Exim monitor" "CHAPeximon"
37701 .scindex IIDeximon "Exim monitor" "description"
37702 .cindex "X-windows"
37703 .cindex "&'eximon'&"
37704 .cindex "Local/eximon.conf"
37705 .cindex "&_exim_monitor/EDITME_&"
37706 The Exim monitor is an application which displays in an X window information
37707 about the state of Exim's queue and what Exim is doing. An admin user can
37708 perform certain operations on messages from this GUI interface; however all
37709 such facilities are also available from the command line, and indeed, the
37710 monitor itself makes use of the command line to perform any actions requested.
37711
37712
37713
37714 .section "Running the monitor" "SECID264"
37715 The monitor is started by running the script called &'eximon'&. This is a shell
37716 script that sets up a number of environment variables, and then runs the
37717 binary called &_eximon.bin_&. The default appearance of the monitor window can
37718 be changed by editing the &_Local/eximon.conf_& file created by editing
37719 &_exim_monitor/EDITME_&. Comments in that file describe what the various
37720 parameters are for.
37721
37722 The parameters that get built into the &'eximon'& script can be overridden for
37723 a particular invocation by setting up environment variables of the same names,
37724 preceded by &`EXIMON_`&. For example, a shell command such as
37725 .code
37726 EXIMON_LOG_DEPTH=400 eximon
37727 .endd
37728 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
37729 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
37730 overrides the Exim log file configuration. This makes it possible to have
37731 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
37732 syslog messages are routed to a file on the local host.
37733
37734 X resources can be used to change the appearance of the window in the normal
37735 way. For example, a resource setting of the form
37736 .code
37737 Eximon*background: gray94
37738 .endd
37739 changes the colour of the background to light grey rather than white. The
37740 stripcharts are drawn with both the data lines and the reference lines in
37741 black. This means that the reference lines are not visible when on top of the
37742 data. However, their colour can be changed by setting a resource called
37743 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
37744 For example, if your X server is running Unix, you could set up lighter
37745 reference lines in the stripcharts by obeying
37746 .code
37747 xrdb -merge <<End
37748 Eximon*highlight: gray
37749 End
37750 .endd
37751 .cindex "admin user"
37752 In order to see the contents of messages on the queue, and to operate on them,
37753 &'eximon'& must either be run as root or by an admin user.
37754
37755 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
37756 contain X11 resource parameters interpreted by the X11 library.  In addition,
37757 if the first parameter starts with the string "gdb" then it is removed and the
37758 binary is invoked under gdb (the parameter is used as the gdb command-name, so
37759 versioned variants of gdb can be invoked).
37760
37761 The monitor's window is divided into three parts. The first contains one or
37762 more stripcharts and two action buttons, the second contains a &"tail"& of the
37763 main log file, and the third is a display of the queue of messages awaiting
37764 delivery, with two more action buttons. The following sections describe these
37765 different parts of the display.
37766
37767
37768
37769
37770 .section "The stripcharts" "SECID265"
37771 .cindex "stripchart"
37772 The first stripchart is always a count of messages on the queue. Its name can
37773 be configured by setting QUEUE_STRIPCHART_NAME in the
37774 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
37775 configuration script by regular expression matches on log file entries, making
37776 it possible to display, for example, counts of messages delivered to certain
37777 hosts or using certain transports. The supplied defaults display counts of
37778 received and delivered messages, and of local and SMTP deliveries. The default
37779 period between stripchart updates is one minute; this can be adjusted by a
37780 parameter in the &_Local/eximon.conf_& file.
37781
37782 The stripchart displays rescale themselves automatically as the value they are
37783 displaying changes. There are always 10 horizontal lines in each chart; the
37784 title string indicates the value of each division when it is greater than one.
37785 For example, &"x2"& means that each division represents a value of 2.
37786
37787 It is also possible to have a stripchart which shows the percentage fullness of
37788 a particular disk partition, which is useful when local deliveries are confined
37789 to a single partition.
37790
37791 .cindex "&%statvfs%& function"
37792 This relies on the availability of the &[statvfs()]& function or equivalent in
37793 the operating system. Most, but not all versions of Unix that support Exim have
37794 this. For this particular stripchart, the top of the chart always represents
37795 100%, and the scale is given as &"x10%"&. This chart is configured by setting
37796 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
37797 &_Local/eximon.conf_& file.
37798
37799
37800
37801
37802 .section "Main action buttons" "SECID266"
37803 .cindex "size" "of monitor window"
37804 .cindex "Exim monitor" "window size"
37805 .cindex "window size"
37806 Below the stripcharts there is an action button for quitting the monitor. Next
37807 to this is another button marked &"Size"&. They are placed here so that
37808 shrinking the window to its default minimum size leaves just the queue count
37809 stripchart and these two buttons visible. Pressing the &"Size"& button causes
37810 the window to expand to its maximum size, unless it is already at the maximum,
37811 in which case it is reduced to its minimum.
37812
37813 When expanding to the maximum, if the window cannot be fully seen where it
37814 currently is, it is moved back to where it was the last time it was at full
37815 size. When it is expanding from its minimum size, the old position is
37816 remembered, and next time it is reduced to the minimum it is moved back there.
37817
37818 The idea is that you can keep a reduced window just showing one or two
37819 stripcharts at a convenient place on your screen, easily expand it to show
37820 the full window when required, and just as easily put it back to what it was.
37821 The idea is copied from what the &'twm'& window manager does for its
37822 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
37823 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
37824
37825 Normally, the monitor starts up with the window at its full size, but it can be
37826 built so that it starts up with the window at its smallest size, by setting
37827 START_SMALL=yes in &_Local/eximon.conf_&.
37828
37829
37830
37831 .section "The log display" "SECID267"
37832 .cindex "log" "tail of; in monitor"
37833 The second section of the window is an area in which a display of the tail of
37834 the main log is maintained.
37835 To save space on the screen, the timestamp on each log line is shortened by
37836 removing the date and, if &%log_timezone%& is set, the timezone.
37837 The log tail is not available when the only destination for logging data is
37838 syslog, unless the syslog lines are routed to a local file whose name is passed
37839 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
37840
37841 The log sub-window has a scroll bar at its lefthand side which can be used to
37842 move back to look at earlier text, and the up and down arrow keys also have a
37843 scrolling effect. The amount of log that is kept depends on the setting of
37844 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
37845 to use. When this is full, the earlier 50% of data is discarded &-- this is
37846 much more efficient than throwing it away line by line. The sub-window also has
37847 a horizontal scroll bar for accessing the ends of long log lines. This is the
37848 only means of horizontal scrolling; the right and left arrow keys are not
37849 available. Text can be cut from this part of the window using the mouse in the
37850 normal way. The size of this subwindow is controlled by parameters in the
37851 configuration file &_Local/eximon.conf_&.
37852
37853 Searches of the text in the log window can be carried out by means of the ^R
37854 and ^S keystrokes, which default to a reverse and a forward search,
37855 respectively. The search covers only the text that is displayed in the window.
37856 It cannot go further back up the log.
37857
37858 The point from which the search starts is indicated by a caret marker. This is
37859 normally at the end of the text in the window, but can be positioned explicitly
37860 by pointing and clicking with the left mouse button, and is moved automatically
37861 by a successful search. If new text arrives in the window when it is scrolled
37862 back, the caret remains where it is, but if the window is not scrolled back,
37863 the caret is moved to the end of the new text.
37864
37865 Pressing ^R or ^S pops up a window into which the search text can be typed.
37866 There are buttons for selecting forward or reverse searching, for carrying out
37867 the search, and for cancelling. If the &"Search"& button is pressed, the search
37868 happens and the window remains so that further searches can be done. If the
37869 &"Return"& key is pressed, a single search is done and the window is closed. If
37870 ^C is typed the search is cancelled.
37871
37872 The searching facility is implemented using the facilities of the Athena text
37873 widget. By default this pops up a window containing both &"search"& and
37874 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
37875 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
37876 However, the linkers in BSDI and HP-UX seem unable to handle an externally
37877 provided version of &%TextPop%& when the remaining parts of the text widget
37878 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
37879 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
37880 on these systems, at the expense of having unwanted items in the search popup
37881 window.
37882
37883
37884
37885 .section "The queue display" "SECID268"
37886 .cindex "queue" "display in monitor"
37887 The bottom section of the monitor window contains a list of all messages that
37888 are on the queue, which includes those currently being received or delivered,
37889 as well as those awaiting delivery. The size of this subwindow is controlled by
37890 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
37891 at which it is updated is controlled by another parameter in the same file &--
37892 the default is 5 minutes, since queue scans can be quite expensive. However,
37893 there is an &"Update"& action button just above the display which can be used
37894 to force an update of the queue display at any time.
37895
37896 When a host is down for some time, a lot of pending mail can build up for it,
37897 and this can make it hard to deal with other messages on the queue. To help
37898 with this situation there is a button next to &"Update"& called &"Hide"&. If
37899 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
37900 type anything in here and press &"Return"&, the text is added to a chain of
37901 such texts, and if every undelivered address in a message matches at least one
37902 of the texts, the message is not displayed.
37903
37904 If there is an address that does not match any of the texts, all the addresses
37905 are displayed as normal. The matching happens on the ends of addresses so, for
37906 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
37907 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
37908 has been set up, a button called &"Unhide"& is displayed. If pressed, it
37909 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
37910 a hide request is automatically cancelled after one hour.
37911
37912 While the dialogue box is displayed, you can't press any buttons or do anything
37913 else to the monitor window. For this reason, if you want to cut text from the
37914 queue display to use in the dialogue box, you have to do the cutting before
37915 pressing the &"Hide"& button.
37916
37917 The queue display contains, for each unhidden queued message, the length of
37918 time it has been on the queue, the size of the message, the message id, the
37919 message sender, and the first undelivered recipient, all on one line. If it is
37920 a bounce message, the sender is shown as &"<>"&. If there is more than one
37921 recipient to which the message has not yet been delivered, subsequent ones are
37922 listed on additional lines, up to a maximum configured number, following which
37923 an ellipsis is displayed. Recipients that have already received the message are
37924 not shown.
37925
37926 .cindex "frozen messages" "display"
37927 If a message is frozen, an asterisk is displayed at the left-hand side.
37928
37929 The queue display has a vertical scroll bar, and can also be scrolled by means
37930 of the arrow keys. Text can be cut from it using the mouse in the normal way.
37931 The text searching facilities, as described above for the log window, are also
37932 available, but the caret is always moved to the end of the text when the queue
37933 display is updated.
37934
37935
37936
37937 .section "The queue menu" "SECID269"
37938 .cindex "queue" "menu in monitor"
37939 If the &%shift%& key is held down and the left button is clicked when the mouse
37940 pointer is over the text for any message, an action menu pops up, and the first
37941 line of the queue display for the message is highlighted. This does not affect
37942 any selected text.
37943
37944 If you want to use some other event for popping up the menu, you can set the
37945 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
37946 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
37947 value set in this parameter is a standard X event description. For example, to
37948 run eximon using &%ctrl%& rather than &%shift%& you could use
37949 .code
37950 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
37951 .endd
37952 The title of the menu is the message id, and it contains entries which act as
37953 follows:
37954
37955 .ilist
37956 &'message log'&: The contents of the message log for the message are displayed
37957 in a new text window.
37958 .next
37959 &'headers'&: Information from the spool file that contains the envelope
37960 information and headers is displayed in a new text window. See chapter
37961 &<<CHAPspool>>& for a description of the format of spool files.
37962 .next
37963 &'body'&: The contents of the spool file containing the body of the message are
37964 displayed in a new text window. There is a default limit of 20,000 bytes to the
37965 amount of data displayed. This can be changed by setting the BODY_MAX
37966 option at compile time, or the EXIMON_BODY_MAX option at run time.
37967 .next
37968 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
37969 delivery of the message. This causes an automatic thaw if the message is
37970 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
37971 a new text window. The delivery is run in a separate process, to avoid holding
37972 up the monitor while the delivery proceeds.
37973 .next
37974 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
37975 that the message be frozen.
37976 .next
37977 .cindex "thawing messages"
37978 .cindex "unfreezing messages"
37979 .cindex "frozen messages" "thawing"
37980 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
37981 that the message be thawed.
37982 .next
37983 .cindex "delivery" "forcing failure"
37984 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
37985 that Exim gives up trying to deliver the message. A bounce message is generated
37986 for any remaining undelivered addresses.
37987 .next
37988 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
37989 that the message be deleted from the system without generating a bounce
37990 message.
37991 .next
37992 &'add recipient'&: A dialog box is displayed into which a recipient address can
37993 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
37994 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
37995 Otherwise it must be entered as a fully qualified address. Pressing RETURN
37996 causes a call to Exim to be made using the &%-Mar%& option to request that an
37997 additional recipient be added to the message, unless the entry box is empty, in
37998 which case no action is taken.
37999 .next
38000 &'mark delivered'&: A dialog box is displayed into which a recipient address
38001 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
38002 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
38003 Otherwise it must be entered as a fully qualified address. Pressing RETURN
38004 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
38005 recipient address as already delivered, unless the entry box is empty, in which
38006 case no action is taken.
38007 .next
38008 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
38009 mark all recipient addresses as already delivered.
38010 .next
38011 &'edit sender'&: A dialog box is displayed initialized with the current
38012 sender's address. Pressing RETURN causes a call to Exim to be made using the
38013 &%-Mes%& option to replace the sender address, unless the entry box is empty,
38014 in which case no action is taken. If you want to set an empty sender (as in
38015 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
38016 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
38017 the address is qualified with that domain.
38018 .endlist
38019
38020 When a delivery is forced, a window showing the &%-v%& output is displayed. In
38021 other cases when a call to Exim is made, if there is any output from Exim (in
38022 particular, if the command fails) a window containing the command and the
38023 output is displayed. Otherwise, the results of the action are normally apparent
38024 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
38025 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
38026 if no output is generated.
38027
38028 The queue display is automatically updated for actions such as freezing and
38029 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
38030 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
38031 force an update of the display after one of these actions.
38032
38033 In any text window that is displayed as result of a menu action, the normal
38034 cut-and-paste facility is available, and searching can be carried out using ^R
38035 and ^S, as described above for the log tail window.
38036 .ecindex IIDeximon
38037
38038
38039
38040
38041
38042 . ////////////////////////////////////////////////////////////////////////////
38043 . ////////////////////////////////////////////////////////////////////////////
38044
38045 .chapter "Security considerations" "CHAPsecurity"
38046 .scindex IIDsecurcon "security" "discussion of"
38047 This chapter discusses a number of issues concerned with security, some of
38048 which are also covered in other parts of this manual.
38049
38050 For reasons that this author does not understand, some people have promoted
38051 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
38052 existence of this chapter in the documentation. However, the intent of the
38053 chapter is simply to describe the way Exim works in relation to certain
38054 security concerns, not to make any specific claims about the effectiveness of
38055 its security as compared with other MTAs.
38056
38057 What follows is a description of the way Exim is supposed to be. Best efforts
38058 have been made to try to ensure that the code agrees with the theory, but an
38059 absence of bugs can never be guaranteed. Any that are reported will get fixed
38060 as soon as possible.
38061
38062
38063 .section "Building a more &""hardened""& Exim" "SECID286"
38064 .cindex "security" "build-time features"
38065 There are a number of build-time options that can be set in &_Local/Makefile_&
38066 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
38067 Exim administrator who does not have the root password, or by someone who has
38068 penetrated the Exim (but not the root) account. These options are as follows:
38069
38070 .ilist
38071 ALT_CONFIG_PREFIX can be set to a string that is required to match the
38072 start of any file names used with the &%-C%& option. When it is set, these file
38073 names are also not allowed to contain the sequence &"/../"&. (However, if the
38074 value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
38075 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
38076 default setting for &%ALT_CONFIG_PREFIX%&.
38077
38078 If the permitted configuration files are confined to a directory to
38079 which only root has access, this guards against someone who has broken
38080 into the Exim account from running a privileged Exim with an arbitrary
38081 configuration file, and using it to break into other accounts.
38082 .next
38083
38084 If a non-trusted configuration file (i.e. not the default configuration file
38085 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
38086 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
38087 the next item), then root privilege is retained only if the caller of Exim is
38088 root. This locks out the possibility of testing a configuration using &%-C%&
38089 right through message reception and delivery, even if the caller is root. The
38090 reception works, but by that time, Exim is running as the Exim user, so when
38091 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
38092 privilege to be lost. However, root can test reception and delivery using two
38093 separate commands.
38094
38095 .next
38096 The WHITELIST_D_MACROS build option declares some macros to be safe to override
38097 with &%-D%& if the real uid is one of root, the Exim run-time user or the
38098 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
38099 requiring the run-time value supplied to &%-D%& to match a regex that errs on
38100 the restrictive side.  Requiring build-time selection of safe macros is onerous
38101 but this option is intended solely as a transition mechanism to permit
38102 previously-working configurations to continue to work after release 4.73.
38103 .next
38104 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
38105 is disabled.
38106 .next
38107 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
38108 never to be used for any deliveries. This is like the &%never_users%& runtime
38109 option, but it cannot be overridden; the runtime option adds additional users
38110 to the list. The default setting is &"root"&; this prevents a non-root user who
38111 is permitted to modify the runtime file from using Exim as a way to get root.
38112 .endlist
38113
38114
38115
38116 .section "Root privilege" "SECID270"
38117 .cindex "setuid"
38118 .cindex "root privilege"
38119 The Exim binary is normally setuid to root, which means that it gains root
38120 privilege (runs as root) when it starts execution. In some special cases (for
38121 example, when the daemon is not in use and there are no local deliveries), it
38122 may be possible to run Exim setuid to some user other than root. This is
38123 discussed in the next section. However, in most installations, root privilege
38124 is required for two things:
38125
38126 .ilist
38127 To set up a socket connected to the standard SMTP port (25) when initialising
38128 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
38129 not required.
38130 .next
38131 To be able to change uid and gid in order to read users' &_.forward_& files and
38132 perform local deliveries as the receiving user or as specified in the
38133 configuration.
38134 .endlist
38135
38136 It is not necessary to be root to do any of the other things Exim does, such as
38137 receiving messages and delivering them externally over SMTP, and it is
38138 obviously more secure if Exim does not run as root except when necessary.
38139 For this reason, a user and group for Exim to use must be defined in
38140 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
38141 group"&. Their values can be changed by the run time configuration, though this
38142 is not recommended. Often a user called &'exim'& is used, but some sites use
38143 &'mail'& or another user name altogether.
38144
38145 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
38146 abdication; the process cannot regain root afterwards. Prior to release 4.00,
38147 &[seteuid()]& was used in some circumstances, but this is no longer the case.
38148
38149 After a new Exim process has interpreted its command line options, it changes
38150 uid and gid in the following cases:
38151
38152 .ilist
38153 .oindex "&%-C%&"
38154 .oindex "&%-D%&"
38155 If the &%-C%& option is used to specify an alternate configuration file, or if
38156 the &%-D%& option is used to define macro values for the configuration, and the
38157 calling process is not running as root, the uid and gid are changed to those of
38158 the calling process.
38159 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
38160 option may not be used at all.
38161 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
38162 can be supplied if the calling process is running as root, the Exim run-time
38163 user or CONFIGURE_OWNER, if defined.
38164 .next
38165 .oindex "&%-be%&"
38166 .oindex "&%-bf%&"
38167 .oindex "&%-bF%&"
38168 If the expansion test option (&%-be%&) or one of the filter testing options
38169 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
38170 calling process.
38171 .next
38172 If the process is not a daemon process or a queue runner process or a delivery
38173 process or a process for testing address routing (started with &%-bt%&), the
38174 uid and gid are changed to the Exim user and group. This means that Exim always
38175 runs under its own uid and gid when receiving messages. This also applies when
38176 testing address verification
38177 .oindex "&%-bv%&"
38178 .oindex "&%-bh%&"
38179 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
38180 option).
38181 .next
38182 For a daemon, queue runner, delivery, or address testing process, the uid
38183 remains as root at this stage, but the gid is changed to the Exim group.
38184 .endlist
38185
38186 The processes that initially retain root privilege behave as follows:
38187
38188 .ilist
38189 A daemon process changes the gid to the Exim group and the uid to the Exim
38190 user after setting up one or more listening sockets. The &[initgroups()]&
38191 function is called, so that if the Exim user is in any additional groups, they
38192 will be used during message reception.
38193 .next
38194 A queue runner process retains root privilege throughout its execution. Its
38195 job is to fork a controlled sequence of delivery processes.
38196 .next
38197 A delivery process retains root privilege throughout most of its execution,
38198 but any actual deliveries (that is, the transports themselves) are run in
38199 subprocesses which always change to a non-root uid and gid. For local
38200 deliveries this is typically the uid and gid of the owner of the mailbox; for
38201 remote deliveries, the Exim uid and gid are used. Once all the delivery
38202 subprocesses have been run, a delivery process changes to the Exim uid and gid
38203 while doing post-delivery tidying up such as updating the retry database and
38204 generating bounce and warning messages.
38205
38206 While the recipient addresses in a message are being routed, the delivery
38207 process runs as root. However, if a user's filter file has to be processed,
38208 this is done in a subprocess that runs under the individual user's uid and
38209 gid. A system filter is run as root unless &%system_filter_user%& is set.
38210 .next
38211 A process that is testing addresses (the &%-bt%& option) runs as root so that
38212 the routing is done in the same environment as a message delivery.
38213 .endlist
38214
38215
38216
38217
38218 .section "Running Exim without privilege" "SECTrunexiwitpri"
38219 .cindex "privilege, running without"
38220 .cindex "unprivileged running"
38221 .cindex "root privilege" "running without"
38222 Some installations like to run Exim in an unprivileged state for more of its
38223 operation, for added security. Support for this mode of operation is provided
38224 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
38225 gid are changed to the Exim user and group at the start of a delivery process
38226 (and also queue runner and address testing processes). This means that address
38227 routing is no longer run as root, and the deliveries themselves cannot change
38228 to any other uid.
38229
38230 .cindex SIGHUP
38231 .cindex "daemon" "restarting"
38232 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
38233 that the daemon can still be started in the usual way, and it can respond
38234 correctly to SIGHUP because the re-invocation regains root privilege.
38235
38236 An alternative approach is to make Exim setuid to the Exim user and also setgid
38237 to the Exim group. If you do this, the daemon must be started from a root
38238 process. (Calling Exim from a root process makes it behave in the way it does
38239 when it is setuid root.) However, the daemon cannot restart itself after a
38240 SIGHUP signal because it cannot regain privilege.
38241
38242 It is still useful to set &%deliver_drop_privilege%& in this case, because it
38243 stops Exim from trying to re-invoke itself to do a delivery after a message has
38244 been received. Such a re-invocation is a waste of resources because it has no
38245 effect.
38246
38247 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
38248 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
38249 to the Exim user seems a clean approach, but there is one complication:
38250
38251 In this style of operation, Exim is running with the real uid and gid set to
38252 those of the calling process, and the effective uid/gid set to Exim's values.
38253 Ideally, any association with the calling process' uid/gid should be dropped,
38254 that is, the real uid/gid should be reset to the effective values so as to
38255 discard any privileges that the caller may have. While some operating systems
38256 have a function that permits this action for a non-root effective uid, quite a
38257 number of them do not. Because of this lack of standardization, Exim does not
38258 address this problem at this time.
38259
38260 For this reason, the recommended approach for &"mostly unprivileged"& running
38261 is to keep the Exim binary setuid to root, and to set
38262 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
38263 be used in the most straightforward way.
38264
38265 If you configure Exim not to run delivery processes as root, there are a
38266 number of restrictions on what you can do:
38267
38268 .ilist
38269 You can deliver only as the Exim user/group. You should  explicitly use the
38270 &%user%& and &%group%& options to override routers or local transports that
38271 normally deliver as the recipient. This makes sure that configurations that
38272 work in this mode function the same way in normal mode. Any implicit or
38273 explicit specification of another user causes an error.
38274 .next
38275 Use of &_.forward_& files is severely restricted, such that it is usually
38276 not worthwhile to include them in the configuration.
38277 .next
38278 Users who wish to use &_.forward_& would have to make their home directory and
38279 the file itself accessible to the Exim user. Pipe and append-to-file entries,
38280 and their equivalents in Exim filters, cannot be used. While they could be
38281 enabled in the Exim user's name, that would be insecure and not very useful.
38282 .next
38283 Unless the local user mailboxes are all owned by the Exim user (possible in
38284 some POP3 or IMAP-only environments):
38285
38286 .olist
38287 They must be owned by the Exim group and be writeable by that group. This
38288 implies you must set &%mode%& in the appendfile configuration, as well as the
38289 mode of the mailbox files themselves.
38290 .next
38291 You must set &%no_check_owner%&, since most or all of the files will not be
38292 owned by the Exim user.
38293 .next
38294 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
38295 on a newly created mailbox when unprivileged. This also implies that new
38296 mailboxes need to be created manually.
38297 .endlist olist
38298 .endlist ilist
38299
38300
38301 These restrictions severely restrict what can be done in local deliveries.
38302 However, there are no restrictions on remote deliveries. If you are running a
38303 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
38304 gives more security at essentially no cost.
38305
38306 If you are using the &%mua_wrapper%& facility (see chapter
38307 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
38308
38309
38310
38311
38312 .section "Delivering to local files" "SECID271"
38313 Full details of the checks applied by &(appendfile)& before it writes to a file
38314 are given in chapter &<<CHAPappendfile>>&.
38315
38316
38317
38318 .section "Running local commands" "SECTsecconslocalcmds"
38319 .cindex "security" "local commands"
38320 .cindex "security" "command injection attacks"
38321 There are a number of ways in which an administrator can configure Exim to run
38322 commands based upon received, untrustworthy, data. Further, in some
38323 configurations a user who can control a &_.forward_& file can also arrange to
38324 run commands. Configuration to check includes, but is not limited to:
38325
38326 .ilist
38327 Use of &%use_shell%& in the pipe transport: various forms of shell command
38328 injection may be possible with this option present. It is dangerous and should
38329 be used only with considerable caution. Consider constraints which whitelist
38330 allowed characters in a variable which is to be used in a pipe transport that
38331 has &%use_shell%& enabled.
38332 .next
38333 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
38334 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
38335 &_.forward_& files in a redirect router. If Exim is running on a central mail
38336 hub to which ordinary users do not have shell access, but home directories are
38337 NFS mounted (for instance) then administrators should review the list of these
38338 forbid options available, and should bear in mind that the options that may
38339 need forbidding can change as new features are added between releases.
38340 .next
38341 The &%${run...}%& expansion item does not use a shell by default, but
38342 administrators can configure use of &_/bin/sh_& as part of the command.
38343 Such invocations should be viewed with prejudicial suspicion.
38344 .next
38345 Administrators who use embedded Perl are advised to explore how Perl's
38346 taint checking might apply to their usage.
38347 .next
38348 Use of &%${expand...}%& is somewhat analogous to shell's eval builtin and
38349 administrators are well advised to view its use with suspicion, in case (for
38350 instance) it allows a local-part to contain embedded Exim directives.
38351 .next
38352 Use of &%${match_local_part...}%& and friends becomes more dangerous if
38353 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
38354 each can reference arbitrary lists and files, rather than just being a list
38355 of opaque strings.
38356 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
38357 real-world security vulnerabilities caused by its use with untrustworthy data
38358 injected in, for SQL injection attacks.
38359 Consider the use of the &%inlisti%& expansion condition instead.
38360 .endlist
38361
38362
38363
38364
38365 .section "Trust in configuration data" "SECTsecconfdata"
38366 .cindex "security" "data sources"
38367 .cindex "security" "regular expressions"
38368 .cindex "regular expressions" "security"
38369 .cindex "PCRE" "security"
38370 If configuration data for Exim can come from untrustworthy sources, there
38371 are some issues to be aware of:
38372
38373 .ilist
38374 Use of &%${expand...}%& may provide a path for shell injection attacks.
38375 .next
38376 Letting untrusted data provide a regular expression is unwise.
38377 .next
38378 Using &%${match...}%& to apply a fixed regular expression against untrusted
38379 data may result in pathological behaviour within PCRE.  Be aware of what
38380 "backtracking" means and consider options for being more strict with a regular
38381 expression. Avenues to explore include limiting what can match (avoiding &`.`&
38382 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
38383 possessive quantifiers or just not using regular expressions against untrusted
38384 data.
38385 .next
38386 It can be important to correctly use &%${quote:...}%&,
38387 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
38388 items to ensure that data is correctly constructed.
38389 .next
38390 Some lookups might return multiple results, even though normal usage is only
38391 expected to yield one result.
38392 .endlist
38393
38394
38395
38396
38397 .section "IPv4 source routing" "SECID272"
38398 .cindex "source routing" "in IP packets"
38399 .cindex "IP source routing"
38400 Many operating systems suppress IP source-routed packets in the kernel, but
38401 some cannot be made to do this, so Exim does its own check. It logs incoming
38402 IPv4 source-routed TCP calls, and then drops them. Things are all different in
38403 IPv6. No special checking is currently done.
38404
38405
38406
38407 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
38408 Support for these SMTP commands is disabled by default. If required, they can
38409 be enabled by defining suitable ACLs.
38410
38411
38412
38413
38414 .section "Privileged users" "SECID274"
38415 .cindex "trusted users"
38416 .cindex "admin user"
38417 .cindex "privileged user"
38418 .cindex "user" "trusted"
38419 .cindex "user" "admin"
38420 Exim recognizes two sets of users with special privileges. Trusted users are
38421 able to submit new messages to Exim locally, but supply their own sender
38422 addresses and information about a sending host. For other users submitting
38423 local messages, Exim sets up the sender address from the uid, and doesn't
38424 permit a remote host to be specified.
38425
38426 .oindex "&%-f%&"
38427 However, an untrusted user is permitted to use the &%-f%& command line option
38428 in the special form &%-f <>%& to indicate that a delivery failure for the
38429 message should not cause an error report. This affects the message's envelope,
38430 but it does not affect the &'Sender:'& header. Untrusted users may also be
38431 permitted to use specific forms of address with the &%-f%& option by setting
38432 the &%untrusted_set_sender%& option.
38433
38434 Trusted users are used to run processes that receive mail messages from some
38435 other mail domain and pass them on to Exim for delivery either locally, or over
38436 the Internet. Exim trusts a caller that is running as root, as the Exim user,
38437 as any user listed in the &%trusted_users%& configuration option, or under any
38438 group listed in the &%trusted_groups%& option.
38439
38440 Admin users are permitted to do things to the messages on Exim's queue. They
38441 can freeze or thaw messages, cause them to be returned to their senders, remove
38442 them entirely, or modify them in various ways. In addition, admin users can run
38443 the Exim monitor and see all the information it is capable of providing, which
38444 includes the contents of files on the spool.
38445
38446 .oindex "&%-M%&"
38447 .oindex "&%-q%&"
38448 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
38449 delivery of messages on its queue is restricted to admin users. This
38450 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
38451 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
38452 queue is also restricted to admin users. This restriction can be relaxed by
38453 setting &%no_queue_list_requires_admin%&.
38454
38455 Exim recognizes an admin user if the calling process is running as root or as
38456 the Exim user or if any of the groups associated with the calling process is
38457 the Exim group. It is not necessary actually to be running under the Exim
38458 group. However, if admin users who are not root or the Exim user are to access
38459 the contents of files on the spool via the Exim monitor (which runs
38460 unprivileged), Exim must be built to allow group read access to its spool
38461 files.
38462
38463 By default, regular users are trusted to perform basic testing and
38464 introspection commands, as themselves.  This setting can be tightened by
38465 setting the &%commandline_checks_require_admin%& option.
38466 This affects most of the checking options,
38467 such as &%-be%& and anything else &%-b*%&.
38468
38469
38470 .section "Spool files" "SECID275"
38471 .cindex "spool directory" "files"
38472 Exim's spool directory and everything it contains is owned by the Exim user and
38473 set to the Exim group. The mode for spool files is defined in the
38474 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
38475 any user who is a member of the Exim group can access these files.
38476
38477
38478
38479 .section "Use of argv[0]" "SECID276"
38480 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
38481 of specific strings, Exim assumes certain options. For example, calling Exim
38482 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
38483 to calling it with the option &%-bS%&. There are no security implications in
38484 this.
38485
38486
38487
38488 .section "Use of %f formatting" "SECID277"
38489 The only use made of &"%f"& by Exim is in formatting load average values. These
38490 are actually stored in integer variables as 1000 times the load average.
38491 Consequently, their range is limited and so therefore is the length of the
38492 converted output.
38493
38494
38495
38496 .section "Embedded Exim path" "SECID278"
38497 Exim uses its own path name, which is embedded in the code, only when it needs
38498 to re-exec in order to regain root privilege. Therefore, it is not root when it
38499 does so. If some bug allowed the path to get overwritten, it would lead to an
38500 arbitrary program's being run as exim, not as root.
38501
38502
38503
38504 .section "Dynamic module directory" "SECTdynmoddir"
38505 Any dynamically loadable modules must be installed into the directory
38506 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
38507 loading it.
38508
38509
38510 .section "Use of sprintf()" "SECID279"
38511 .cindex "&[sprintf()]&"
38512 A large number of occurrences of &"sprintf"& in the code are actually calls to
38513 &'string_sprintf()'&, a function that returns the result in malloc'd store.
38514 The intermediate formatting is done into a large fixed buffer by a function
38515 that runs through the format string itself, and checks the length of each
38516 conversion before performing it, thus preventing buffer overruns.
38517
38518 The remaining uses of &[sprintf()]& happen in controlled circumstances where
38519 the output buffer is known to be sufficiently long to contain the converted
38520 string.
38521
38522
38523
38524 .section "Use of debug_printf() and log_write()" "SECID280"
38525 Arbitrary strings are passed to both these functions, but they do their
38526 formatting by calling the function &'string_vformat()'&, which runs through
38527 the format string itself, and checks the length of each conversion.
38528
38529
38530
38531 .section "Use of strcat() and strcpy()" "SECID281"
38532 These are used only in cases where the output buffer is known to be large
38533 enough to hold the result.
38534 .ecindex IIDsecurcon
38535
38536
38537
38538
38539 . ////////////////////////////////////////////////////////////////////////////
38540 . ////////////////////////////////////////////////////////////////////////////
38541
38542 .chapter "Format of spool files" "CHAPspool"
38543 .scindex IIDforspo1 "format" "spool files"
38544 .scindex IIDforspo2 "spool directory" "format of files"
38545 .scindex IIDforspo3 "spool files" "format of"
38546 .cindex "spool files" "editing"
38547 A message on Exim's queue consists of two files, whose names are the message id
38548 followed by -D and -H, respectively. The data portion of the message is kept in
38549 the -D file on its own. The message's envelope, status, and headers are all
38550 kept in the -H file, whose format is described in this chapter. Each of these
38551 two files contains the final component of its own name as its first line. This
38552 is insurance against disk crashes where the directory is lost but the files
38553 themselves are recoverable.
38554
38555 Some people are tempted into editing -D files in order to modify messages. You
38556 need to be extremely careful if you do this; it is not recommended and you are
38557 on your own if you do it. Here are some of the pitfalls:
38558
38559 .ilist
38560 You must ensure that Exim does not try to deliver the message while you are
38561 fiddling with it. The safest way is to take out a write lock on the -D file,
38562 which is what Exim itself does, using &[fcntl()]&. If you update the file in
38563 place, the lock will be retained. If you write a new file and rename it, the
38564 lock will be lost at the instant of rename.
38565 .next
38566 .vindex "&$body_linecount$&"
38567 If you change the number of lines in the file, the value of
38568 &$body_linecount$&, which is stored in the -H file, will be incorrect and can
38569 cause incomplete transmission of messages or undeliverable messages.
38570 .next
38571 If the message is in MIME format, you must take care not to break it.
38572 .next
38573 If the message is cryptographically signed, any change will invalidate the
38574 signature.
38575 .endlist
38576 All in all, modifying -D files is fraught with danger.
38577
38578 Files whose names end with -J may also be seen in the &_input_& directory (or
38579 its subdirectories when &%split_spool_directory%& is set). These are journal
38580 files, used to record addresses to which the message has been delivered during
38581 the course of a delivery attempt. If there are still undelivered recipients at
38582 the end, the -H file is updated, and the -J file is deleted. If, however, there
38583 is some kind of crash (for example, a power outage) before this happens, the -J
38584 file remains in existence. When Exim next processes the message, it notices the
38585 -J file and uses it to update the -H file before starting the next delivery
38586 attempt.
38587
38588 Files whose names end with -K or .eml may also be seen in the spool.
38589 These are temporaries used for DKIM or malware processing, when that is used.
38590 They should be tidied up by normal operations; any old ones are probably
38591 relics of crashes and can be removed.
38592
38593 .section "Format of the -H file" "SECID282"
38594 .cindex "uid (user id)" "in spool file"
38595 .cindex "gid (group id)" "in spool file"
38596 The second line of the -H file contains the login name for the uid of the
38597 process that called Exim to read the message, followed by the numerical uid and
38598 gid. For a locally generated message, this is normally the user who sent the
38599 message. For a message received over TCP/IP via the daemon, it is
38600 normally the Exim user.
38601
38602 The third line of the file contains the address of the message's sender as
38603 transmitted in the envelope, contained in angle brackets. The sender address is
38604 empty for bounce messages. For incoming SMTP mail, the sender address is given
38605 in the MAIL command. For locally generated mail, the sender address is
38606 created by Exim from the login name of the current user and the configured
38607 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
38608 leading &"From&~"& line if the caller is trusted, or if the supplied address is
38609 &"<>"& or an address that matches &%untrusted_set_senders%&.
38610
38611 The fourth line contains two numbers. The first is the time that the message
38612 was received, in the conventional Unix form &-- the number of seconds since the
38613 start of the epoch. The second number is a count of the number of messages
38614 warning of delayed delivery that have been sent to the sender.
38615
38616 There follow a number of lines starting with a hyphen. These can appear in any
38617 order, and are omitted when not relevant:
38618
38619 .vlist
38620 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
38621 This item is obsolete, and is not generated from Exim release 4.61 onwards;
38622 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
38623 recognized, to provide backward compatibility. In the old format, a line of
38624 this form is present for every ACL variable that is not empty. The number
38625 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
38626 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
38627 the data string for the variable. The string itself starts at the beginning of
38628 the next line, and is followed by a newline character. It may contain internal
38629 newlines.
38630
38631 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
38632 A line of this form is present for every ACL connection variable that is
38633 defined. Note that there is a space between &%-aclc%& and the rest of the name.
38634 The length is the length of the data string for the variable. The string itself
38635 starts at the beginning of the next line, and is followed by a newline
38636 character. It may contain internal newlines.
38637
38638 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
38639 A line of this form is present for every ACL message variable that is defined.
38640 Note that there is a space between &%-aclm%& and the rest of the name. The
38641 length is the length of the data string for the variable. The string itself
38642 starts at the beginning of the next line, and is followed by a newline
38643 character. It may contain internal newlines.
38644
38645 .vitem "&%-active_hostname%&&~<&'hostname'&>"
38646 This is present if, when the message was received over SMTP, the value of
38647 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
38648
38649 .vitem &%-allow_unqualified_recipient%&
38650 This is present if unqualified recipient addresses are permitted in header
38651 lines (to stop such addresses from being qualified if rewriting occurs at
38652 transport time). Local messages that were input using &%-bnq%& and remote
38653 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
38654
38655 .vitem &%-allow_unqualified_sender%&
38656 This is present if unqualified sender addresses are permitted in header lines
38657 (to stop such addresses from being qualified if rewriting occurs at transport
38658 time). Local messages that were input using &%-bnq%& and remote messages from
38659 hosts that match &%sender_unqualified_hosts%& set this flag.
38660
38661 .vitem "&%-auth_id%&&~<&'text'&>"
38662 The id information for a message received on an authenticated SMTP connection
38663 &-- the value of the &$authenticated_id$& variable.
38664
38665 .vitem "&%-auth_sender%&&~<&'address'&>"
38666 The address of an authenticated sender &-- the value of the
38667 &$authenticated_sender$& variable.
38668
38669 .vitem "&%-body_linecount%&&~<&'number'&>"
38670 This records the number of lines in the body of the message, and is
38671 present unless &%-spool_file_wireformat%& is.
38672
38673 .vitem "&%-body_zerocount%&&~<&'number'&>"
38674 This records the number of binary zero bytes in the body of the message, and is
38675 present if the number is greater than zero.
38676
38677 .vitem &%-deliver_firsttime%&
38678 This is written when a new message is first added to the spool. When the spool
38679 file is updated after a deferral, it is omitted.
38680
38681 .vitem "&%-frozen%&&~<&'time'&>"
38682 .cindex "frozen messages" "spool data"
38683 The message is frozen, and the freezing happened at <&'time'&>.
38684
38685 .vitem "&%-helo_name%&&~<&'text'&>"
38686 This records the host name as specified by a remote host in a HELO or EHLO
38687 command.
38688
38689 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
38690 This records the IP address of the host from which the message was received and
38691 the remote port number that was used. It is omitted for locally generated
38692 messages.
38693
38694 .vitem "&%-host_auth%&&~<&'text'&>"
38695 If the message was received on an authenticated SMTP connection, this records
38696 the name of the authenticator &-- the value of the
38697 &$sender_host_authenticated$& variable.
38698
38699 .vitem &%-host_lookup_failed%&
38700 This is present if an attempt to look up the sending host's name from its IP
38701 address failed. It corresponds to the &$host_lookup_failed$& variable.
38702
38703 .vitem "&%-host_name%&&~<&'text'&>"
38704 .cindex "reverse DNS lookup"
38705 .cindex "DNS" "reverse lookup"
38706 This records the name of the remote host from which the message was received,
38707 if the host name was looked up from the IP address when the message was being
38708 received. It is not present if no reverse lookup was done.
38709
38710 .vitem "&%-ident%&&~<&'text'&>"
38711 For locally submitted messages, this records the login of the originating user,
38712 unless it was a trusted user and the &%-oMt%& option was used to specify an
38713 ident value. For messages received over TCP/IP, this records the ident string
38714 supplied by the remote host, if any.
38715
38716 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
38717 This records the IP address of the local interface and the port number through
38718 which a message was received from a remote host. It is omitted for locally
38719 generated messages.
38720
38721 .vitem &%-local%&
38722 The message is from a local sender.
38723
38724 .vitem &%-localerror%&
38725 The message is a locally-generated bounce message.
38726
38727 .vitem "&%-local_scan%&&~<&'string'&>"
38728 This records the data string that was returned by the &[local_scan()]& function
38729 when the message was received &-- the value of the &$local_scan_data$&
38730 variable. It is omitted if no data was returned.
38731
38732 .vitem &%-manual_thaw%&
38733 The message was frozen but has been thawed manually, that is, by an explicit
38734 Exim command rather than via the auto-thaw process.
38735
38736 .vitem &%-N%&
38737 A testing delivery process was started using the &%-N%& option to suppress any
38738 actual deliveries, but delivery was deferred. At any further delivery attempts,
38739 &%-N%& is assumed.
38740
38741 .vitem &%-received_protocol%&
38742 This records the value of the &$received_protocol$& variable, which contains
38743 the name of the protocol by which the message was received.
38744
38745 .vitem &%-sender_set_untrusted%&
38746 The envelope sender of this message was set by an untrusted local caller (used
38747 to ensure that the caller is displayed in queue listings).
38748
38749 .vitem "&%-spam_score_int%&&~<&'number'&>"
38750 If a message was scanned by SpamAssassin, this is present. It records the value
38751 of &$spam_score_int$&.
38752
38753 .vitem &%-spool_file_wireformat%&
38754 The -D file for this message is in wire-format (for ESMTP CHUNKING)
38755 rather than Unix-format.
38756 The line-ending is CRLF rather than newline.
38757 There is still, however, no leading-dot-stuffing.
38758
38759 .vitem &%-tls_certificate_verified%&
38760 A TLS certificate was received from the client that sent this message, and the
38761 certificate was verified by the server.
38762
38763 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
38764 When the message was received over an encrypted connection, this records the
38765 name of the cipher suite that was used.
38766
38767 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
38768 When the message was received over an encrypted connection, and a certificate
38769 was received from the client, this records the Distinguished Name from that
38770 certificate.
38771 .endlist
38772
38773 Following the options there is a list of those addresses to which the message
38774 is not to be delivered. This set of addresses is initialized from the command
38775 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
38776 is set; otherwise it starts out empty. Whenever a successful delivery is made,
38777 the address is added to this set. The addresses are kept internally as a
38778 balanced binary tree, and it is a representation of that tree which is written
38779 to the spool file. If an address is expanded via an alias or forward file, the
38780 original address is added to the tree when deliveries to all its child
38781 addresses are complete.
38782
38783 If the tree is empty, there is a single line in the spool file containing just
38784 the text &"XX"&. Otherwise, each line consists of two letters, which are either
38785 Y or N, followed by an address. The address is the value for the node of the
38786 tree, and the letters indicate whether the node has a left branch and/or a
38787 right branch attached to it, respectively. If branches exist, they immediately
38788 follow. Here is an example of a three-node tree:
38789 .code
38790 YY darcy@austen.fict.example
38791 NN alice@wonderland.fict.example
38792 NN editor@thesaurus.ref.example
38793 .endd
38794 After the non-recipients tree, there is a list of the message's recipients.
38795 This is a simple list, preceded by a count. It includes all the original
38796 recipients of the message, including those to whom the message has already been
38797 delivered. In the simplest case, the list contains one address per line. For
38798 example:
38799 .code
38800 4
38801 editor@thesaurus.ref.example
38802 darcy@austen.fict.example
38803 rdo@foundation
38804 alice@wonderland.fict.example
38805 .endd
38806 However, when a child address has been added to the top-level addresses as a
38807 result of the use of the &%one_time%& option on a &(redirect)& router, each
38808 line is of the following form:
38809 .display
38810 <&'top-level address'&> <&'errors_to address'&> &&&
38811   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
38812 .endd
38813 The 01 flag bit indicates the presence of the three other fields that follow
38814 the top-level address. Other bits may be used in future to support additional
38815 fields. The <&'parent number'&> is the offset in the recipients list of the
38816 original parent of the &"one time"& address. The first two fields are the
38817 envelope sender that is associated with this address and its length. If the
38818 length is zero, there is no special envelope sender (there are then two space
38819 characters in the line). A non-empty field can arise from a &(redirect)& router
38820 that has an &%errors_to%& setting.
38821
38822
38823 A blank line separates the envelope and status information from the headers
38824 which follow. A header may occupy several lines of the file, and to save effort
38825 when reading it in, each header is preceded by a number and an identifying
38826 character. The number is the number of characters in the header, including any
38827 embedded newlines and the terminating newline. The character is one of the
38828 following:
38829
38830 .table2 50pt
38831 .row <&'blank'&>         "header in which Exim has no special interest"
38832 .row &`B`&               "&'Bcc:'& header"
38833 .row &`C`&               "&'Cc:'& header"
38834 .row &`F`&               "&'From:'& header"
38835 .row &`I`&               "&'Message-id:'& header"
38836 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
38837 .row &`R`&               "&'Reply-To:'& header"
38838 .row &`S`&               "&'Sender:'& header"
38839 .row &`T`&               "&'To:'& header"
38840 .row &`*`&               "replaced or deleted header"
38841 .endtable
38842
38843 Deleted or replaced (rewritten) headers remain in the spool file for debugging
38844 purposes. They are not transmitted when the message is delivered. Here is a
38845 typical set of headers:
38846 .code
38847 111P Received: by hobbit.fict.example with local (Exim 4.00)
38848 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
38849 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
38850 038* X-rewrote-sender: bb@hobbit.fict.example
38851 042* From: Bilbo Baggins <bb@hobbit.fict.example>
38852 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
38853 099* To: alice@wonderland.fict.example, rdo@foundation,
38854 darcy@austen.fict.example, editor@thesaurus.ref.example
38855 104T To: alice@wonderland.fict.example, rdo@foundation.example,
38856 darcy@austen.fict.example, editor@thesaurus.ref.example
38857 038  Date: Fri, 11 May 2001 10:28:59 +0100
38858 .endd
38859 The asterisked headers indicate that the envelope sender, &'From:'& header, and
38860 &'To:'& header have been rewritten, the last one because routing expanded the
38861 unqualified domain &'foundation'&.
38862 .ecindex IIDforspo1
38863 .ecindex IIDforspo2
38864 .ecindex IIDforspo3
38865
38866 .section "Format of the -D file" "SECID282a"
38867 The data file is traditionally in Unix-standard format: lines are ended with
38868 an ASCII newline character.
38869 However, when the &%spool_wireformat%& main option is used some -D files
38870 can have an alternate format.
38871 This is flagged by a &%-spool_file_wireformat%& line in the corresponding -H file.
38872 The -D file lines (not including the first name-component line) are
38873 suitable for direct copying to the wire when transmitting using the
38874 ESMTP CHUNKING option, meaning lower processing overhead.
38875 Lines are terminated with an ASCII CRLF pair.
38876 There is no dot-stuffing (and no dot-termination).
38877
38878 . ////////////////////////////////////////////////////////////////////////////
38879 . ////////////////////////////////////////////////////////////////////////////
38880
38881 .chapter "DKIM and SPF" "CHAPdkim" &&&
38882          "DKIM and SPF Support"
38883 .cindex "DKIM"
38884
38885 .section "DKIM (DomainKeys Identified Mail)" SECDKIM
38886
38887 DKIM is a mechanism by which messages sent by some entity can be provably
38888 linked to a domain which that entity controls.  It permits reputation to
38889 be tracked on a per-domain basis, rather than merely upon source IP address.
38890 DKIM is documented in RFC 6376.
38891
38892 .new
38893 As DKIM relies on the message being unchanged in transit, messages handled
38894 by a mailing-list (which traditionally adds to the message) will not match
38895 any original DKIM signature.
38896 .wen
38897
38898 DKIM support is compiled into Exim by default if TLS support is present.
38899 It can be disabled by setting DISABLE_DKIM=yes in &_Local/Makefile_&.
38900
38901 Exim's DKIM implementation allows for
38902 .olist
38903 Signing outgoing messages: This function is implemented in the SMTP transport.
38904 It can co-exist with all other Exim features
38905 (including transport filters)
38906 except cutthrough delivery.
38907 .next
38908 Verifying signatures in incoming messages: This is implemented by an additional
38909 ACL (acl_smtp_dkim), which can be called several times per message, with
38910 different signature contexts.
38911 .endlist
38912
38913 In typical Exim style, the verification implementation does not include any
38914 default "policy". Instead it enables you to build your own policy using
38915 Exim's standard controls.
38916
38917 .new
38918 Please note that verification of DKIM signatures in incoming mail is turned
38919 on by default for logging (in the <= line) purposes.
38920
38921 Additional log detail can be enabled using the &%dkim_verbose%& log_selector.
38922 When set, for each signature in incoming email,
38923 exim will log a line displaying the most important signature details, and the
38924 signature status. Here is an example (with line-breaks added for clarity):
38925 .code
38926 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
38927     d=facebookmail.com s=q1-2009b
38928     c=relaxed/relaxed a=rsa-sha1
38929     i=@facebookmail.com t=1252484542 [verification succeeded]
38930 .endd
38931 .wen
38932
38933 You might want to turn off DKIM verification processing entirely for internal
38934 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
38935 control modifier. This should typically be done in the RCPT ACL, at points
38936 where you accept mail from relay sources (internal hosts or authenticated
38937 senders).
38938
38939
38940 .section "Signing outgoing messages" "SECDKIMSIGN"
38941 .cindex "DKIM" "signing"
38942
38943 .new
38944 For signing to be usable you must have published a DKIM record in DNS.
38945 Note that RFC 8301 says:
38946 .code
38947 rsa-sha1 MUST NOT be used for signing or verifying.
38948
38949 Signers MUST use RSA keys of at least 1024 bits for all keys.
38950 Signers SHOULD use RSA keys of at least 2048 bits.
38951 .endd
38952
38953 Note also that the key content (the 'p=' field)
38954 in the DNS record is different between RSA and EC keys;
38955 for the former it is the base64 of the ASN.1 for the RSA public key
38956 (equivalent to the private-key .pem with the header/trailer stripped)
38957 but for EC keys it is the base64 of the pure key; no ASN.1 wrapping.
38958 .wen
38959
38960 Signing is enabled by setting private options on the SMTP transport.
38961 These options take (expandable) strings as arguments.
38962
38963 .option dkim_domain smtp string list&!! unset
38964 The domain(s) you want to sign with.
38965 After expansion, this can be a list.
38966 Each element in turn is put into the &%$dkim_domain%& expansion variable
38967 while expanding the remaining signing options.
38968 If it is empty after expansion, DKIM signing is not done,
38969 and no error will result even if &%dkim_strict%& is set.
38970
38971 .option dkim_selector smtp string list&!! unset
38972 This sets the key selector string.
38973 After expansion, which can use &$dkim_domain$&, this can be a list.
38974 Each element in turn is put in the expansion
38975 variable &%$dkim_selector%& which may be used in the &%dkim_private_key%&
38976 option along with &%$dkim_domain%&.
38977 If the option is empty after expansion, DKIM signing is not done for this domain,
38978 and no error will result even if &%dkim_strict%& is set.
38979
38980 .option dkim_private_key smtp string&!! unset
38981 This sets the private key to use.
38982 You can use the &%$dkim_domain%& and
38983 &%$dkim_selector%& expansion variables to determine the private key to use.
38984 The result can either
38985 .ilist
38986 be a valid RSA private key in ASCII armor (.pem file), including line breaks
38987 .new
38988 .next
38989 with GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
38990 be a valid Ed25519 private key (same format as above)
38991 .wen
38992 .next
38993 start with a slash, in which case it is treated as a file that contains
38994 the private key
38995 .next
38996 be "0", "false" or the empty string, in which case the message will not
38997 be signed. This case will not result in an error, even if &%dkim_strict%&
38998 is set.
38999 .endlist
39000
39001 .new
39002 To generate keys under OpenSSL:
39003 .code
39004 openssl genrsa -out dkim_rsa.private 2048
39005 openssl rsa -in dkim_rsa.private -out /dev/stdout -pubout -outform PEM
39006 .endd
39007 Take the base-64 lines from the output of the second command, concatenated,
39008 for the DNS TXT record.
39009 See section 3.6 of RFC6376 for the record specification.
39010
39011 Under GnuTLS:
39012 .code
39013 certtool --generate-privkey --rsa --bits=2048 --password='' -8 --outfile=dkim_rsa.private
39014 certtool --load-privkey=dkim_rsa.private --pubkey-info
39015 .endd
39016
39017 Note that RFC 8301 says:
39018 .code
39019 Signers MUST use RSA keys of at least 1024 bits for all keys.
39020 Signers SHOULD use RSA keys of at least 2048 bits.
39021 .endd
39022
39023 Support for EC keys is being developed under
39024 &url(https://datatracker.ietf.org/doc/draft-ietf-dcrup-dkim-crypto/).
39025 They are considerably smaller than RSA keys for equivalent protection.
39026 As they are a recent development, users should consider dual-signing
39027 (by setting a list of selectors, and an expansion for this option)
39028 for some transition period.
39029 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
39030 for EC keys.
39031
39032 OpenSSL 1.1.1 and GnuTLS 3.6.0 can create Ed25519 private keys:
39033 .code
39034 openssl genpkey -algorithm ed25519 -out dkim_ed25519.private
39035 certtool --generate-privkey --key-type=ed25519 --outfile=dkim_ed25519.private
39036 .endd
39037
39038 To produce the required public key value for a DNS record:
39039 .code
39040 openssl pkey -outform DER -pubout -in dkim_ed25519.private | tail -c +13 | base64
39041 certtool --load_privkey=dkim_ed25519.private --pubkey_info --outder | tail -c +13 | base64
39042 .endd
39043 .wen
39044
39045 .option dkim_hash smtp string&!! sha256
39046 Can be set alternatively to &"sha1"& to use an alternate hash
39047 method.
39048
39049 .new
39050 Note that RFC 8301 says:
39051 .code
39052 rsa-sha1 MUST NOT be used for signing or verifying.
39053 .endd
39054 .wen
39055
39056 .option dkim_identity smtp string&!! unset
39057 If set after expansion, the value is used to set an "i=" tag in
39058 the signing header.  The DKIM standards restrict the permissible
39059 syntax of this optional tag to a mail address, with possibly-empty
39060 local part, an @, and a domain identical to or subdomain of the "d="
39061 tag value.  Note that Exim does not check the value.
39062
39063 .option dkim_canon smtp string&!! unset
39064 This option sets the canonicalization method used when signing a message.
39065 The DKIM RFC currently supports two methods: "simple" and "relaxed".
39066 The option defaults to "relaxed" when unset. Note: the current implementation
39067 only supports using the same canonicalization method for both headers and body.
39068
39069 .option dkim_strict smtp string&!! unset
39070 This  option  defines  how  Exim  behaves  when  signing a message that
39071 should be signed fails for some reason.  When the expansion evaluates to
39072 either "1" or "true", Exim will defer. Otherwise Exim will send the message
39073 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
39074 variables here.
39075
39076 .option dkim_sign_headers smtp string&!! "see below"
39077 If set, this option must expand to a colon-separated
39078 list of header names.
39079 Headers with these names, or the absence or such a header, will be included
39080 in the message signature.
39081 When unspecified, the header names listed in RFC4871 will be used,
39082 whether or not each header is present in the message.
39083 The default list is available for the expansion in the macro
39084 "_DKIM_SIGN_HEADERS".
39085
39086 If a name is repeated, multiple headers by that name (or the absence thereof)
39087 will be signed.  The textually later headers in the headers part of the
39088 message are signed first, if there are multiples.
39089
39090 A name can be prefixed with either an '=' or a '+' character.
39091 If an '=' prefix is used, all headers that are present with this name
39092 will be signed.
39093 If a '+' prefix if used, all headers that are present with this name
39094 will be signed, and one signature added for a missing header with the
39095 name will be appended.
39096
39097
39098 .section "Verifying DKIM signatures in incoming mail" "SECDKIMVFY"
39099 .cindex "DKIM" "verification"
39100
39101 Verification of DKIM signatures in SMTP incoming email is implemented via the
39102 &%acl_smtp_dkim%& ACL. By default, this ACL is called once for each
39103 syntactically(!) correct signature in the incoming message.
39104 A missing ACL definition defaults to accept.
39105 If any ACL call does not accept, the message is not accepted.
39106 If a cutthrough delivery was in progress for the message, that is
39107 summarily dropped (having wasted the transmission effort).
39108
39109 To evaluate the signature in the ACL a large number of expansion variables
39110 containing the signature status and its details are set up during the
39111 runtime of the ACL.
39112
39113 .new
39114 .cindex authentication "expansion item"
39115 Performing verification sets up information used by the
39116 &$authresults$& expansion item.
39117 .wen
39118
39119 Calling the ACL only for existing signatures is not sufficient to build
39120 more advanced policies. For that reason, the global option
39121 &%dkim_verify_signers%&, and a global expansion variable
39122 &%$dkim_signers%& exist.
39123
39124 The global option &%dkim_verify_signers%& can be set to a colon-separated
39125 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
39126 called. It is expanded when the message has been received. At this point,
39127 the expansion variable &%$dkim_signers%& already contains a colon-separated
39128 list of signer domains and identities for the message. When
39129 &%dkim_verify_signers%& is not specified in the main configuration,
39130 it defaults as:
39131 .code
39132 dkim_verify_signers = $dkim_signers
39133 .endd
39134 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
39135 DKIM signature in the message. Current DKIM verifiers may want to explicitly
39136 call the ACL for known domains or identities. This would be achieved as follows:
39137 .code
39138 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
39139 .endd
39140 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
39141 and "ebay.com", plus all domains and identities that have signatures in the message.
39142 You can also be more creative in constructing your policy. For example:
39143 .code
39144 dkim_verify_signers = $sender_address_domain:$dkim_signers
39145 .endd
39146
39147 If a domain or identity is listed several times in the (expanded) value of
39148 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
39149
39150 If multiple signatures match a domain (or identity), the ACL is called once
39151 for each matching signature.
39152
39153
39154 Inside the &%acl_smtp_dkim%&, the following expansion variables are
39155 available (from most to least important):
39156
39157
39158 .vlist
39159 .vitem &%$dkim_cur_signer%&
39160 The signer that is being evaluated in this ACL run. This can be a domain or
39161 an identity. This is one of the list items from the expanded main option
39162 &%dkim_verify_signers%& (see above).
39163
39164 .vitem &%$dkim_verify_status%&
39165 Within the DKIM ACL,
39166 a string describing the general status of the signature. One of
39167 .ilist
39168 &%none%&: There is no signature in the message for the current domain or
39169 identity (as reflected by &%$dkim_cur_signer%&).
39170 .next
39171 &%invalid%&: The signature could not be verified due to a processing error.
39172 More detail is available in &%$dkim_verify_reason%&.
39173 .next
39174 &%fail%&: Verification of the signature failed.  More detail is
39175 available in &%$dkim_verify_reason%&.
39176 .next
39177 &%pass%&: The signature passed verification. It is valid.
39178 .endlist
39179
39180 This variable can be overwritten using an ACL 'set' modifier.
39181 This might, for instance, be done to enforce a policy restriction on
39182 hash-method or key-size:
39183 .code
39184   warn  condition =     ${if eq {$dkim_verify_status}{pass}}
39185         condition =     ${if eq {$len_3:$dkim_algo}{rsa}}
39186         condition =     ${if or {eq {$dkim_algo}{rsa-sha1}} \
39187                                 {< {$dkim_key_length}{1024}} }
39188         logwrite =      NOTE: forcing dkim verify fail (was pass)
39189         set dkim_verify_status = fail
39190         set dkim_verify_reason = hash too weak or key too short
39191 .endd
39192
39193 After all the DKIM ACL runs have completed, the value becomes a
39194 colon-separated list of the values after each run.
39195
39196 .vitem &%$dkim_verify_reason%&
39197 A string giving a little bit more detail when &%$dkim_verify_status%& is either
39198 "fail" or "invalid". One of
39199 .ilist
39200 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
39201 key for the domain could not be retrieved. This may be a temporary problem.
39202 .next
39203 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
39204 record for the domain is syntactically invalid.
39205 .next
39206 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
39207 body hash does not match the one specified in the signature header. This
39208 means that the message body was modified in transit.
39209 .next
39210 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
39211 could not be verified. This may mean that headers were modified,
39212 re-written or otherwise changed in a way which is incompatible with
39213 DKIM verification. It may of course also mean that the signature is forged.
39214 .endlist
39215
39216 This variable can be overwritten, with any value, using an ACL 'set' modifier.
39217
39218 .vitem &%$dkim_domain%&
39219 The signing domain. IMPORTANT: This variable is only populated if there is
39220 an actual signature in the message for the current domain or identity (as
39221 reflected by &%$dkim_cur_signer%&).
39222
39223 .vitem &%$dkim_identity%&
39224 The signing identity, if present. IMPORTANT: This variable is only populated
39225 if there is an actual signature in the message for the current domain or
39226 identity (as reflected by &%$dkim_cur_signer%&).
39227
39228 .vitem &%$dkim_selector%&
39229 The key record selector string.
39230
39231 .vitem &%$dkim_algo%&
39232 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
39233 .new
39234 If running under GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
39235 may also be 'ed25519-sha256'.
39236 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
39237 for EC keys.
39238 .wen
39239
39240 .new
39241 Note that RFC 8301 says:
39242 .code
39243 rsa-sha1 MUST NOT be used for signing or verifying.
39244
39245 DKIM signatures identified as having been signed with historic
39246 algorithms (currently, rsa-sha1) have permanently failed evaluation
39247 .endd
39248
39249 To enforce this you must have a DKIM ACL which checks this variable
39250 and overwrites the &$dkim_verify_status$& variable as discussed above.
39251 .wen
39252
39253 .vitem &%$dkim_canon_body%&
39254 The body canonicalization method. One of 'relaxed' or 'simple'.
39255
39256 .vitem &%$dkim_canon_headers%&
39257 The header canonicalization method. One of 'relaxed' or 'simple'.
39258
39259 .vitem &%$dkim_copiedheaders%&
39260 A transcript of headers and their values which are included in the signature
39261 (copied from the 'z=' tag of the signature).
39262 Note that RFC6376 requires that verification fail if the From: header is
39263 not included in the signature.  Exim does not enforce this; sites wishing
39264 strict enforcement should code the check explicitly.
39265
39266 .vitem &%$dkim_bodylength%&
39267 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
39268 limit was set by the signer, "9999999999999" is returned. This makes sure
39269 that this variable always expands to an integer value.
39270
39271 .vitem &%$dkim_created%&
39272 UNIX timestamp reflecting the date and time when the signature was created.
39273 When this was not specified by the signer, "0" is returned.
39274
39275 .vitem &%$dkim_expires%&
39276 UNIX timestamp reflecting the date and time when the signer wants the
39277 signature to be treated as "expired". When this was not specified by the
39278 signer, "9999999999999" is returned. This makes it possible to do useful
39279 integer size comparisons against this value.
39280 .new
39281 Note that Exim does not check this value.
39282 .wen
39283
39284 .vitem &%$dkim_headernames%&
39285 A colon-separated list of names of headers included in the signature.
39286
39287 .vitem &%$dkim_key_testing%&
39288 "1" if the key record has the "testing" flag set, "0" if not.
39289
39290 .vitem &%$dkim_key_nosubdomains%&
39291 "1" if the key record forbids subdomaining, "0" otherwise.
39292
39293 .vitem &%$dkim_key_srvtype%&
39294 Service type (tag s=) from the key record. Defaults to "*" if not specified
39295 in the key record.
39296
39297 .vitem &%$dkim_key_granularity%&
39298 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
39299 in the key record.
39300
39301 .vitem &%$dkim_key_notes%&
39302 Notes from the key record (tag n=).
39303
39304 .vitem &%$dkim_key_length%&
39305 Number of bits in the key.
39306
39307 .new
39308 Note that RFC 8301 says:
39309 .code
39310 Verifiers MUST NOT consider signatures using RSA keys of
39311 less than 1024 bits as valid signatures.
39312 .endd
39313
39314 To enforce this you must have a DKIM ACL which checks this variable
39315 and overwrites the &$dkim_verify_status$& variable as discussed above.
39316 As EC keys are much smaller, the check should only do this for RSA keys.
39317 .wen
39318
39319 .endlist
39320
39321 In addition, two ACL conditions are provided:
39322
39323 .vlist
39324 .vitem &%dkim_signers%&
39325 ACL condition that checks a colon-separated list of domains or identities
39326 for a match against the domain or identity that the ACL is currently verifying
39327 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
39328 verb to a group of domains or identities. For example:
39329
39330 .code
39331 # Warn when Mail purportedly from GMail has no gmail signature
39332 warn log_message = GMail sender without gmail.com DKIM signature
39333      sender_domains = gmail.com
39334      dkim_signers = gmail.com
39335      dkim_status = none
39336 .endd
39337
39338 Note that the above does not check for a total lack of DKIM signing;
39339 for that check for empty &$h_DKIM-Signature:$& in the data ACL.
39340
39341 .vitem &%dkim_status%&
39342 ACL condition that checks a colon-separated list of possible DKIM verification
39343 results against the actual result of verification. This is typically used
39344 to restrict an ACL verb to a list of verification outcomes, for example:
39345
39346 .code
39347 deny message = Mail from Paypal with invalid/missing signature
39348      sender_domains = paypal.com:paypal.de
39349      dkim_signers = paypal.com:paypal.de
39350      dkim_status = none:invalid:fail
39351 .endd
39352
39353 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
39354 see the documentation of the &%$dkim_verify_status%& expansion variable above
39355 for more information of what they mean.
39356 .endlist
39357
39358
39359
39360
39361 .new
39362 .section "SPF (Sender Policy Framework)" SECSPF
39363 .cindex SPF verification
39364
39365 SPF is a mechanism whereby a domain may assert which IP addresses may transmit
39366 messages with its domain in the envelope from, documented by RFC 7208.
39367 For more information on SPF see &url(http://www.openspf.org).
39368
39369 Messages sent by a system not authorised will fail checking of such assertions.
39370 This includes retransmissions done by traditional forwarders.
39371
39372 SPF verification support is built into Exim if SUPPORT_SPF=yes is set in
39373 &_Local/Makefile_&.  The support uses the &_libspf2_& library
39374 &url(http://www.libspf2.org/).
39375 There is no Exim involvement on the trasmission of messages; publishing certain
39376 DNS records is all that is required.
39377
39378 For verification, an ACL condition and an expansion lookup are provided.
39379 .new
39380 .cindex authentication "expansion item"
39381 Performing verification sets up information used by the
39382 &$authresults$& expansion item.
39383 .wen
39384
39385
39386 .cindex SPF "ACL condition"
39387 .cindex ACL "spf condition"
39388 The ACL condition "spf" can be used at or after the MAIL ACL.
39389 It takes as an argument a list of strings giving the outcome of the SPF check,
39390 and will succeed for any matching outcome.
39391 Valid strings are:
39392 .vlist
39393 .vitem &%pass%&
39394 The SPF check passed, the sending host is positively verified by SPF.
39395
39396 .vitem &%fail%&
39397 The SPF check failed, the sending host is NOT allowed to send mail for the
39398 domain in the envelope-from address.
39399
39400 .vitem &%softfail%&
39401 The SPF check failed, but the queried domain can't absolutely confirm that this
39402 is a forgery.
39403
39404 .vitem &%none%&
39405 The queried domain does not publish SPF records.
39406
39407 .vitem &%neutral%&
39408 The SPF check returned a "neutral" state.  This means the queried domain has
39409 published a SPF record, but wants to allow outside servers to send mail under
39410 its domain as well.  This should be treated like "none".
39411
39412 .vitem &%permerror%&
39413 This indicates a syntax error in the SPF record of the queried domain.
39414 You may deny messages when this occurs.
39415
39416 .vitem &%temperror%&
39417 This indicates a temporary error during all processing, including Exim's
39418 SPF processing.  You may defer messages when this occurs.
39419 .endlist
39420
39421 You can prefix each string with an exclamation mark to  invert
39422 its meaning,  for example  "!fail" will  match all  results but
39423 "fail".  The  string  list is  evaluated  left-to-right,  in a
39424 short-circuit fashion.
39425
39426 Example:
39427 .code
39428 deny spf = fail
39429      message = $sender_host_address is not allowed to send mail from \
39430                ${if def:sender_address_domain \
39431                     {$sender_address_domain}{$sender_helo_name}}.  \
39432                Please see http://www.openspf.org/Why?scope=\
39433                ${if def:sender_address_domain {mfrom}{helo}};\
39434                identity=${if def:sender_address_domain \
39435                              {$sender_address}{$sender_helo_name}};\
39436                ip=$sender_host_address
39437 .endd
39438
39439 When the spf condition has run, it sets up several expansion
39440 variables:
39441
39442 .cindex SPF "verification variables"
39443 .vlist
39444 .vitem &$spf_header_comment$&
39445 .vindex &$spf_header_comment$&
39446   This contains a human-readable string describing the outcome
39447   of the SPF check. You can add it to a custom header or use
39448   it for logging purposes.
39449
39450 .vitem &$spf_received$&
39451 .vindex &$spf_received$&
39452   This contains a complete Received-SPF: header that can be
39453   added to the message. Please note that according to the SPF
39454   draft, this header must be added at the top of the header
39455   list. Please see section 10 on how you can do this.
39456
39457   Note: in case of "Best-guess" (see below), the convention is
39458   to put this string in a header called X-SPF-Guess: instead.
39459
39460 .vitem &$spf_result$&
39461 .vindex &$spf_result$&
39462   This contains the outcome of the SPF check in string form,
39463   one of pass, fail, softfail, none, neutral, permerror or
39464   temperror.
39465
39466 .vitem &$spf_result_guessed$&
39467 .vindex &$spf_result_guessed$&
39468   This boolean is true only if a best-guess operation was used
39469   and required in order to obtain a result.
39470
39471 .vitem &$spf_smtp_comment$&
39472 .vindex &$spf_smtp_comment$&
39473   This contains a string that can be used in a SMTP response
39474   to the calling party. Useful for "fail".
39475 .endlist
39476
39477
39478 .cindex SPF "ACL condition"
39479 .cindex ACL "spf_guess condition"
39480 .cindex SPF "best guess"
39481 In addition to SPF, you can also perform checks for so-called
39482 "Best-guess".  Strictly speaking, "Best-guess" is not standard
39483 SPF, but it is supported by the same framework that enables SPF
39484 capability.
39485 Refer to &url(http://www.openspf.org/FAQ/Best_guess_record)
39486 for a description of what it means.
39487
39488 To access this feature, simply use the spf_guess condition in place
39489 of the spf one.  For example:
39490
39491 .code
39492 deny spf_guess = fail
39493      message = $sender_host_address doesn't look trustworthy to me
39494 .endd
39495
39496 In case you decide to reject messages based on this check, you
39497 should note that although it uses the same framework, "Best-guess"
39498 is not SPF, and therefore you should not mention SPF at all in your
39499 reject message.
39500
39501 When the spf_guess condition has run, it sets up the same expansion
39502 variables as when spf condition is run, described above.
39503
39504 Additionally, since Best-guess is not standardized, you may redefine
39505 what "Best-guess" means to you by redefining the main configuration
39506 &%spf_guess%& option.
39507 For example, the following:
39508
39509 .code
39510 spf_guess = v=spf1 a/16 mx/16 ptr ?all
39511 .endd
39512
39513 would relax host matching rules to a broader network range.
39514
39515
39516 .cindex SPF "lookup expansion"
39517 .cindex lookup spf
39518 A lookup expansion is also available. It takes an email
39519 address as the key and an IP address as the database:
39520
39521 .code
39522   ${lookup {username@domain} spf {ip.ip.ip.ip}}
39523 .endd
39524
39525 The lookup will return the same result strings as they can appear in
39526 &$spf_result$& (pass,fail,softfail,neutral,none,err_perm,err_temp).
39527 Currently, only IPv4 addresses are supported.
39528
39529
39530 . wen-for SPF section
39531 .wen
39532
39533
39534 . ////////////////////////////////////////////////////////////////////////////
39535 . ////////////////////////////////////////////////////////////////////////////
39536
39537 .chapter "Proxies" "CHAPproxies" &&&
39538          "Proxy support"
39539 .cindex "proxy support"
39540 .cindex "proxy" "access via"
39541
39542 A proxy is an intermediate system through which communication is passed.
39543 Proxies may provide a security, availability or load-distribution function.
39544
39545
39546 .section "Inbound proxies" SECTproxyInbound
39547 .cindex proxy inbound
39548 .cindex proxy "server side"
39549 .cindex proxy "Proxy protocol"
39550 .cindex "Proxy protocol" proxy
39551
39552 Exim has support for receiving inbound SMTP connections via a proxy
39553 that uses &"Proxy Protocol"& to speak to it.
39554 To include this support, include &"SUPPORT_PROXY=yes"&
39555 in Local/Makefile.
39556
39557 It was built on specifications from:
39558 (&url(http://haproxy.1wt.eu/download/1.5/doc/proxy-protocol.txt)).
39559 That URL was revised in May 2014 to version 2 spec:
39560 (&url(http://git.1wt.eu/web?p=haproxy.git;a=commitdiff;h=afb768340c9d7e50d8e)).
39561
39562 The purpose of this facility is so that an application load balancer,
39563 such as HAProxy, can sit in front of several Exim servers
39564 to distribute load.
39565 Exim uses the local protocol communication with the proxy to obtain
39566 the remote SMTP system IP address and port information.
39567 There is no logging if a host passes or
39568 fails Proxy Protocol negotiation, but it can easily be determined and
39569 recorded in an ACL (example is below).
39570
39571 Use of a proxy is enabled by setting the &%hosts_proxy%&
39572 main configuration option to a hostlist; connections from these
39573 hosts will use Proxy Protocol.
39574 Exim supports both version 1 and version 2 of the Proxy Protocol and
39575 automatically determines which version is in use.
39576
39577 The Proxy Protocol header is the first data received on a TCP connection
39578 and is inserted before any TLS-on-connect handshake from the client; Exim
39579 negotiates TLS between Exim-as-server and the remote client, not between
39580 Exim and the proxy server.
39581
39582 The following expansion variables are usable
39583 (&"internal"& and &"external"& here refer to the interfaces
39584 of the proxy):
39585 .display
39586 &'proxy_external_address   '& IP of host being proxied or IP of remote interface of proxy
39587 &'proxy_external_port      '& Port of host being proxied or Port on remote interface of proxy
39588 &'proxy_local_address      '& IP of proxy server inbound or IP of local interface of proxy
39589 &'proxy_local_port         '& Port of proxy server inbound or Port on local interface of proxy
39590 &'proxy_session            '& boolean: SMTP connection via proxy
39591 .endd
39592 If &$proxy_session$& is set but &$proxy_external_address$& is empty
39593 there was a protocol error.
39594
39595 Since the real connections are all coming from the proxy, and the
39596 per host connection tracking is done before Proxy Protocol is
39597 evaluated, &%smtp_accept_max_per_host%& must be set high enough to
39598 handle all of the parallel volume you expect per inbound proxy.
39599 With the option set so high, you lose the ability
39600 to protect your server from many connections from one IP.
39601 In order to prevent your server from overload, you
39602 need to add a per connection ratelimit to your connect ACL.
39603 A possible solution is:
39604 .display
39605   # Set max number of connections per host
39606   LIMIT   = 5
39607   # Or do some kind of IP lookup in a flat file or database
39608   # LIMIT = ${lookup{$sender_host_address}iplsearch{/etc/exim/proxy_limits}}
39609
39610   defer   message        = Too many connections from this IP right now
39611           ratelimit      = LIMIT / 5s / per_conn / strict
39612 .endd
39613
39614
39615
39616 .section "Outbound proxies" SECTproxySOCKS
39617 .cindex proxy outbound
39618 .cindex proxy "client side"
39619 .cindex proxy SOCKS
39620 .cindex SOCKS proxy
39621 Exim has support for sending outbound SMTP via a proxy
39622 using a protocol called SOCKS5 (defined by RFC1928).
39623 The support can be optionally included by defining SUPPORT_SOCKS=yes in
39624 Local/Makefile.
39625
39626 Use of a proxy is enabled by setting the &%socks_proxy%& option
39627 on an smtp transport.
39628 The option value is expanded and should then be a list
39629 (colon-separated by default) of proxy specifiers.
39630 Each proxy specifier is a list
39631 (space-separated by default) where the initial element
39632 is an IP address and any subsequent elements are options.
39633
39634 Options are a string <name>=<value>.
39635 The list of options is in the following table:
39636 .display
39637 &'auth   '& authentication method
39638 &'name   '& authentication username
39639 &'pass   '& authentication password
39640 &'port   '& tcp port
39641 &'tmo    '& connection timeout
39642 &'pri    '& priority
39643 &'weight '& selection bias
39644 .endd
39645
39646 More details on each of these options follows:
39647
39648 .ilist
39649 .cindex authentication "to proxy"
39650 .cindex proxy authentication
39651 &%auth%&: Either &"none"& (default) or &"name"&.
39652 Using &"name"& selects username/password authentication per RFC 1929
39653 for access to the proxy.
39654 Default is &"none"&.
39655 .next
39656 &%name%&: sets the username for the &"name"& authentication method.
39657 Default is empty.
39658 .next
39659 &%pass%&: sets the password for the &"name"& authentication method.
39660 Default is empty.
39661 .next
39662 &%port%&: the TCP port number to use for the connection to the proxy.
39663 Default is 1080.
39664 .next
39665 &%tmo%&: sets a connection timeout in seconds for this proxy.
39666 Default is 5.
39667 .next
39668 &%pri%&: specifies a priority for the proxy within the list,
39669 higher values being tried first.
39670 The default priority is 1.
39671 .next
39672 &%weight%&: specifies a selection bias.
39673 Within a priority set servers are queried in a random fashion,
39674 weighted by this value.
39675 The default value for selection bias is 1.
39676 .endlist
39677
39678 Proxies from the list are tried according to their priority
39679 and weight settings until one responds.  The timeout for the
39680 overall connection applies to the set of proxied attempts.
39681
39682 .section Logging SECTproxyLog
39683 To log the (local) IP of a proxy in the incoming or delivery logline,
39684 add &"+proxy"& to the &%log_selector%& option.
39685 This will add a component tagged with &"PRX="& to the line.
39686
39687 . ////////////////////////////////////////////////////////////////////////////
39688 . ////////////////////////////////////////////////////////////////////////////
39689
39690 .chapter "Internationalisation" "CHAPi18n" &&&
39691          "Internationalisation""
39692 .cindex internationalisation "email address"
39693 .cindex EAI
39694 .cindex i18n
39695 .cindex utf8 "mail name handling"
39696
39697 Exim has support for Internationalised mail names.
39698 To include this it must be built with SUPPORT_I18N and the libidn library.
39699 Standards supported are RFCs 2060, 5890, 6530 and 6533.
39700
39701 If Exim is built with SUPPORT_I18N_2008 (in addition to SUPPORT_I18N, not
39702 instead of it) then IDNA2008 is supported; this adds an extra library
39703 requirement, upon libidn2.
39704
39705 .section "MTA operations" SECTi18nMTA
39706 .cindex SMTPUTF8 "ESMTP option"
39707 The main configuration option &%smtputf8_advertise_hosts%& specifies
39708 a host list.  If this matches the sending host and
39709 accept_8bitmime is true (the default) then the ESMTP option
39710 SMTPUTF8 will be advertised.
39711
39712 If the sender specifies the SMTPUTF8 option on a MAIL command
39713 international handling for the message is enabled and
39714 the expansion variable &$message_smtputf8$& will have value TRUE.
39715
39716 The option &%allow_utf8_domains%& is set to true for this
39717 message. All DNS lookups are converted to a-label form
39718 whatever the setting of &%allow_utf8_domains%&
39719 when Exim is built with SUPPORT_I18N.
39720
39721 Both localparts and domain are maintained as the original
39722 UTF-8 form internally; any comparison or regular-expression use will
39723 require appropriate care.  Filenames created, eg. by
39724 the appendfile transport, will have UTF-8 names.
39725
39726 HELO names sent by the smtp transport will have any UTF-8
39727 components expanded to a-label form,
39728 and any certificate name checks will be done using the a-label
39729 form of the name.
39730
39731 .cindex log protocol
39732 .cindex SMTPUTF8 logging
39733 .cindex i18n logging
39734 Log lines and Received-by: header lines will acquire a "utf8"
39735 prefix on the protocol element, eg. utf8esmtp.
39736
39737 The following expansion operators can be used:
39738 .code
39739 ${utf8_domain_to_alabel:str}
39740 ${utf8_domain_from_alabel:str}
39741 ${utf8_localpart_to_alabel:str}
39742 ${utf8_localpart_from_alabel:str}
39743 .endd
39744
39745 .cindex utf8 "address downconversion"
39746 .cindex i18n "utf8 address downconversion"
39747 .new
39748 The RCPT ACL
39749 .wen
39750 may use the following modifier:
39751 .display
39752 control = utf8_downconvert
39753 control = utf8_downconvert/<value>
39754 .endd
39755 This sets a flag requiring that addresses are converted to
39756 a-label form before smtp delivery, for use in a
39757 Message Submission Agent context.
39758 If a value is appended it may be:
39759 .display
39760 &`1  `& (default) mandatory downconversion
39761 &`0  `& no downconversion
39762 &`-1 `& if SMTPUTF8 not supported by destination host
39763 .endd
39764
39765 If mua_wrapper is set, the utf8_downconvert control
39766 is initially set to -1.
39767
39768
39769 There is no explicit support for VRFY and EXPN.
39770 Configurations supporting these should inspect
39771 &$smtp_command_argument$& for an SMTPUTF8 argument.
39772
39773 There is no support for LMTP on Unix sockets.
39774 Using the "lmtp" protocol option on an smtp transport,
39775 for LMTP over TCP, should work as expected.
39776
39777 There is no support for DSN unitext handling,
39778 and no provision for converting logging from or to UTF-8.
39779
39780
39781
39782 .section "MDA operations" SECTi18nMDA
39783 To aid in constructing names suitable for IMAP folders
39784 the following expansion operator can be used:
39785 .code
39786 ${imapfolder {<string>} {<sep>} {<specials>}}
39787 .endd
39788
39789 The string is converted from the charset specified by
39790 the "headers charset" command (in a filter file)
39791 or &%headers_charset%& main configuration option (otherwise),
39792 to the
39793 modified UTF-7 encoding specified by RFC 2060,
39794 with the following exception: All occurrences of <sep>
39795 (which has to be a single character)
39796 are replaced with periods ("."), and all periods and slashes that are not
39797 <sep> and are not in the <specials> string are BASE64 encoded.
39798
39799 The third argument can be omitted, defaulting to an empty string.
39800 The second argument can be omitted, defaulting to "/".
39801
39802 This is the encoding used by Courier for Maildir names on disk, and followed
39803 by many other IMAP servers.
39804
39805 Examples:
39806 .display
39807 &`${imapfolder {Foo/Bar}}       `& yields &`Foo.Bar`&
39808 &`${imapfolder {Foo/Bar}{.}{/}} `& yields &`Foo&&AC8-Bar`&
39809 &`${imapfolder {Räksmörgås}}    `& yields &`R&&AOQ-ksm&&APY-rg&&AOU-s`&
39810 .endd
39811
39812 Note that the source charset setting is vital, and also that characters
39813 must be representable in UTF-16.
39814
39815
39816 . ////////////////////////////////////////////////////////////////////////////
39817 . ////////////////////////////////////////////////////////////////////////////
39818
39819 .chapter "Events" "CHAPevents" &&&
39820          "Events"
39821 .cindex events
39822
39823 The events mechanism in Exim can be used to intercept processing at a number
39824 of points.  It was originally invented to give a way to do customised logging
39825 actions (for example, to a database) but can also be used to modify some
39826 processing actions.
39827
39828 Most installations will never need to use Events.
39829 The support can be left out of a build by defining DISABLE_EVENT=yes
39830 in &_Local/Makefile_&.
39831
39832 There are two major classes of events: main and transport.
39833 The main configuration option &%event_action%& controls reception events;
39834 a transport option &%event_action%& controls delivery events.
39835
39836 Both options are a string which is expanded when the event fires.
39837 An example might look like:
39838 .cindex logging custom
39839 .code
39840 event_action = ${if eq {msg:delivery}{$event_name} \
39841 {${lookup pgsql {SELECT * FROM record_Delivery( \
39842     '${quote_pgsql:$sender_address_domain}',\
39843     '${quote_pgsql:${lc:$sender_address_local_part}}', \
39844     '${quote_pgsql:$domain}', \
39845     '${quote_pgsql:${lc:$local_part}}', \
39846     '${quote_pgsql:$host_address}', \
39847     '${quote_pgsql:${lc:$host}}', \
39848     '${quote_pgsql:$message_exim_id}')}} \
39849 } {}}
39850 .endd
39851
39852 Events have names which correspond to the point in process at which they fire.
39853 The name is placed in the variable &$event_name$& and the event action
39854 expansion must check this, as it will be called for every possible event type.
39855
39856 The current list of events is:
39857 .display
39858 &`dane:fail              after    transport  `& per connection
39859 &`msg:complete           after    main       `& per message
39860 &`msg:delivery           after    transport  `& per recipient
39861 &`msg:rcpt:host:defer    after    transport  `& per recipient per host
39862 &`msg:rcpt:defer         after    transport  `& per recipient
39863 &`msg:host:defer         after    transport  `& per attempt
39864 &`msg:fail:delivery      after    transport  `& per recipient
39865 &`msg:fail:internal      after    main       `& per recipient
39866 &`tcp:connect            before   transport  `& per connection
39867 &`tcp:close              after    transport  `& per connection
39868 &`tls:cert               before   both       `& per certificate in verification chain
39869 &`smtp:connect           after    transport  `& per connection
39870 .endd
39871 New event types may be added in future.
39872
39873 The event name is a colon-separated list, defining the type of
39874 event in a tree of possibilities.  It may be used as a list
39875 or just matched on as a whole.  There will be no spaces in the name.
39876
39877 The second column in the table above describes whether the event fires
39878 before or after the action is associates with.  Those which fire before
39879 can be used to affect that action (more on this below).
39880
39881 The third column in the table above says what section of the configuration
39882 should define the event action.
39883
39884 An additional variable, &$event_data$&, is filled with information varying
39885 with the event type:
39886 .display
39887 &`dane:fail            `& failure reason
39888 &`msg:delivery         `& smtp confirmation message
39889 &`msg:rcpt:host:defer  `& error string
39890 &`msg:rcpt:defer       `& error string
39891 &`msg:host:defer       `& error string
39892 &`tls:cert             `& verification chain depth
39893 &`smtp:connect         `& smtp banner
39894 .endd
39895
39896 The :defer events populate one extra variable: &$event_defer_errno$&.
39897
39898 For complex operations an ACL expansion can be used in &%event_action%&
39899 however due to the multiple contexts that Exim operates in during
39900 the course of its processing:
39901 .ilist
39902 variables set in transport events will not be visible outside that
39903 transport call
39904 .next
39905 acl_m variables in a server context are lost on a new connection,
39906 and after smtp helo/ehlo/mail/starttls/rset commands
39907 .endlist
39908 Using an ACL expansion with the logwrite modifier can be
39909 a useful way of writing to the main log.
39910
39911 The expansion of the event_action option should normally
39912 return an empty string.  Should it return anything else the
39913 following will be forced:
39914 .display
39915 &`tcp:connect      `&  do not connect
39916 &`tls:cert         `&  refuse verification
39917 &`smtp:connect     `&  close connection
39918 .endd
39919 All other message types ignore the result string, and
39920 no other use is made of it.
39921
39922 For a tcp:connect event, if the connection is being made to a proxy
39923 then the address and port variables will be that of the proxy and not
39924 the target system.
39925
39926 For tls:cert events, if GnuTLS is in use this will trigger only per
39927 chain element received on the connection.
39928 For OpenSSL it will trigger for every chain element including those
39929 loaded locally.
39930
39931 . ////////////////////////////////////////////////////////////////////////////
39932 . ////////////////////////////////////////////////////////////////////////////
39933
39934 .chapter "Adding new drivers or lookup types" "CHID13" &&&
39935          "Adding drivers or lookups"
39936 .cindex "adding drivers"
39937 .cindex "new drivers, adding"
39938 .cindex "drivers" "adding new"
39939 The following actions have to be taken in order to add a new router, transport,
39940 authenticator, or lookup type to Exim:
39941
39942 .olist
39943 Choose a name for the driver or lookup type that does not conflict with any
39944 existing name; I will use &"newdriver"& in what follows.
39945 .next
39946 Add to &_src/EDITME_& the line:
39947 .display
39948 <&'type'&>&`_NEWDRIVER=yes`&
39949 .endd
39950 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
39951 code is not to be included in the binary by default, comment this line out. You
39952 should also add any relevant comments about the driver or lookup type.
39953 .next
39954 Add to &_src/config.h.defaults_& the line:
39955 .code
39956 #define <type>_NEWDRIVER
39957 .endd
39958 .next
39959 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
39960 and create a table entry as is done for all the other drivers and lookup types.
39961 .next
39962 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
39963 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
39964 Add your &`NEWDRIVER`& to that list.
39965 As long as the dynamic module would be named &_newdriver.so_&, you can use the
39966 simple form that most lookups have.
39967 .next
39968 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
39969 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
39970 driver or lookup type and add it to the definition of OBJ.
39971 .next
39972 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
39973 &_src_&.
39974 .next
39975 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
39976 as for other drivers and lookups.
39977 .endlist
39978
39979 Then all you need to do is write the code! A good way to start is to make a
39980 proforma by copying an existing module of the same type, globally changing all
39981 occurrences of the name, and cutting out most of the code. Note that any
39982 options you create must be listed in alphabetical order, because the tables are
39983 searched using a binary chop procedure.
39984
39985 There is a &_README_& file in each of the sub-directories of &_src_& describing
39986 the interface that is expected.
39987
39988
39989
39990
39991 . ////////////////////////////////////////////////////////////////////////////
39992 . ////////////////////////////////////////////////////////////////////////////
39993
39994 . /////////////////////////////////////////////////////////////////////////////
39995 . These lines are processing instructions for the Simple DocBook Processor that
39996 . Philip Hazel has developed as a less cumbersome way of making PostScript and
39997 . PDFs than using xmlto and fop. They will be ignored by all other XML
39998 . processors.
39999 . /////////////////////////////////////////////////////////////////////////////
40000
40001 .literal xml
40002 <?sdop
40003   format="newpage"
40004   foot_right_recto="&chaptertitle;"
40005   foot_right_verso="&chaptertitle;"
40006 ?>
40007 .literal off
40008
40009 .makeindex "Options index"   "option"
40010 .makeindex "Variables index" "variable"
40011 .makeindex "Concept index"   "concept"
40012
40013
40014 . /////////////////////////////////////////////////////////////////////////////
40015 . /////////////////////////////////////////////////////////////////////////////