Restrict line lengths in bounces. Bug 1760
[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.86"
49 .include ./local_params
50
51 .set ACL "access control lists (ACLs)"
52 .set I   "&nbsp;&nbsp;&nbsp;&nbsp;"
53
54 .macro copyyear
55 2015
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 .endtable
440
441 The main specification and the specification of the filtering language are also
442 available in other formats (HTML, PostScript, PDF, and Texinfo). Section
443 &<<SECTavail>>& below tells you how to get hold of these.
444
445
446
447 .section "FTP and web sites" "SECID2"
448 .cindex "web site"
449 .cindex "FTP site"
450 The primary site for Exim source distributions is currently the University of
451 Cambridge's FTP site, whose contents are described in &'Where to find the Exim
452 distribution'& below. In addition, there is a web site and an FTP site at
453 &%exim.org%&. These are now also hosted at the University of Cambridge. The
454 &%exim.org%& site was previously hosted for a number of years by Energis
455 Squared, formerly Planet Online Ltd, whose support I gratefully acknowledge.
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
465 .cindex Bugzilla
466 An Exim Bugzilla exists at &url(http://bugs.exim.org). You can use
467 this to report bugs, and also to add items to the wish list. Please search
468 first to check that you are not duplicating a previous entry.
469
470
471
472 .section "Mailing lists" "SECID3"
473 .cindex "mailing lists" "for Exim users"
474 The following Exim mailing lists exist:
475
476 .table2 140pt
477 .row &'exim-announce@exim.org'&   "Moderated, low volume announcements list"
478 .row &'exim-users@exim.org'&      "General discussion list"
479 .row &'exim-dev@exim.org'&        "Discussion of bugs, enhancements, etc."
480 .row &'exim-cvs@exim.org'&        "Automated commit messages from the VCS"
481 .endtable
482
483 You can subscribe to these lists, change your existing subscriptions, and view
484 or search the archives via the mailing lists link on the Exim home page.
485 .cindex "Debian" "mailing list for"
486 If you are using a Debian distribution of Exim, you may wish to subscribe to
487 the Debian-specific mailing list &'pkg-exim4-users@lists.alioth.debian.org'&
488 via this web page:
489 .display
490 &url(http://lists.alioth.debian.org/mailman/listinfo/pkg-exim4-users)
491 .endd
492 Please ask Debian-specific questions on this list and not on the general Exim
493 lists.
494
495 .section "Exim training" "SECID4"
496 .cindex "training courses"
497 Training courses in Cambridge (UK) used to be run annually by the author of
498 Exim, before he retired. At the time of writing, there are no plans to run
499 further Exim courses in Cambridge. However, if that changes, relevant
500 information will be posted at &url(http://www-tus.csx.cam.ac.uk/courses/exim/).
501
502 .section "Bug reports" "SECID5"
503 .cindex "bug reports"
504 .cindex "reporting bugs"
505 Reports of obvious bugs can be emailed to &'bugs@exim.org'& or reported
506 via the Bugzilla (&url(http://bugs.exim.org)). However, if you are unsure
507 whether some behaviour is a bug or not, the best thing to do is to post a
508 message to the &'exim-dev'& mailing list and have it discussed.
509
510
511
512 .section "Where to find the Exim distribution" "SECTavail"
513 .cindex "FTP site"
514 .cindex "distribution" "ftp site"
515 The master ftp site for the Exim distribution is
516 .display
517 &*ftp://ftp.csx.cam.ac.uk/pub/software/email/exim*&
518 .endd
519 This is mirrored by
520 .display
521 &*ftp://ftp.exim.org/pub/exim*&
522 .endd
523 The file references that follow are relative to the &_exim_& directories at
524 these sites. There are now quite a number of independent mirror sites around
525 the world. Those that I know about are listed in the file called &_Mirrors_&.
526
527 Within the &_exim_& directory there are subdirectories called &_exim3_& (for
528 previous Exim 3 distributions), &_exim4_& (for the latest Exim 4
529 distributions), and &_Testing_& for testing versions. In the &_exim4_&
530 subdirectory, the current release can always be found in files called
531 .display
532 &_exim-n.nn.tar.gz_&
533 &_exim-n.nn.tar.bz2_&
534 .endd
535 where &'n.nn'& is the highest such version number in the directory. The two
536 files contain identical data; the only difference is the type of compression.
537 The &_.bz2_& file is usually a lot smaller than the &_.gz_& file.
538
539 .cindex "distribution" "signing details"
540 .cindex "distribution" "public key"
541 .cindex "public key for signed distribution"
542 The distributions will be PGP signed by an individual key of the Release
543 Coordinator.  This key will have a uid containing an email address in the
544 &'exim.org'& domain and will have signatures from other people, including
545 other Exim maintainers.  We expect that the key will be in the "strong set" of
546 PGP keys.  There should be a trust path to that key from Nigel Metheringham's
547 PGP key, a version of which can be found in the release directory in the file
548 &_nigel-pubkey.asc_&.  All keys used will be available in public keyserver pools,
549 such as &'pool.sks-keyservers.net'&.
550
551 At time of last update, releases were being made by Phil Pennock and signed with
552 key &'0x403043153903637F'&, although that key is expected to be replaced in 2013.
553 A trust path from Nigel's key to Phil's can be observed at
554 &url(https://www.security.spodhuis.org/exim-trustpath).
555
556 Releases have also been authorized to be performed by Todd Lyons who signs with
557 key &'0xC4F4F94804D29EBA'&. A direct trust path exists between previous RE Phil
558 Pennock and Todd Lyons through a common associate.
559
560 The signatures for the tar bundles are in:
561 .display
562 &_exim-n.nn.tar.gz.asc_&
563 &_exim-n.nn.tar.bz2.asc_&
564 .endd
565 For each released version, the log of changes is made separately available in a
566 separate file in the directory &_ChangeLogs_& so that it is possible to
567 find out what has changed without having to download the entire distribution.
568
569 .cindex "documentation" "available formats"
570 The main distribution contains ASCII versions of this specification and other
571 documentation; other formats of the documents are available in separate files
572 inside the &_exim4_& directory of the FTP site:
573 .display
574 &_exim-html-n.nn.tar.gz_&
575 &_exim-pdf-n.nn.tar.gz_&
576 &_exim-postscript-n.nn.tar.gz_&
577 &_exim-texinfo-n.nn.tar.gz_&
578 .endd
579 These tar files contain only the &_doc_& directory, not the complete
580 distribution, and are also available in &_.bz2_& as well as &_.gz_& forms.
581
582
583 .section "Limitations" "SECID6"
584 .ilist
585 .cindex "limitations of Exim"
586 .cindex "bang paths" "not handled by Exim"
587 Exim is designed for use as an Internet MTA, and therefore handles addresses in
588 RFC 2822 domain format only. It cannot handle UUCP &"bang paths"&, though
589 simple two-component bang paths can be converted by a straightforward rewriting
590 configuration. This restriction does not prevent Exim from being interfaced to
591 UUCP as a transport mechanism, provided that domain addresses are used.
592 .next
593 .cindex "domainless addresses"
594 .cindex "address" "without domain"
595 Exim insists that every address it handles has a domain attached. For incoming
596 local messages, domainless addresses are automatically qualified with a
597 configured domain value. Configuration options specify from which remote
598 systems unqualified addresses are acceptable. These are then qualified on
599 arrival.
600 .next
601 .cindex "transport" "external"
602 .cindex "external transports"
603 The only external transport mechanisms that are currently implemented are SMTP
604 and LMTP over a TCP/IP network (including support for IPv6). However, a pipe
605 transport is available, and there are facilities for writing messages to files
606 and pipes, optionally in &'batched SMTP'& format; these facilities can be used
607 to send messages to other transport mechanisms such as UUCP, provided they can
608 handle domain-style addresses. Batched SMTP input is also catered for.
609 .next
610 Exim is not designed for storing mail for dial-in hosts. When the volumes of
611 such mail are large, it is better to get the messages &"delivered"& into files
612 (that is, off Exim's queue) and subsequently passed on to the dial-in hosts by
613 other means.
614 .next
615 Although Exim does have basic facilities for scanning incoming messages, these
616 are not comprehensive enough to do full virus or spam scanning. Such operations
617 are best carried out using additional specialized software packages. If you
618 compile Exim with the content-scanning extension, straightforward interfaces to
619 a number of common scanners are provided.
620 .endlist
621
622
623 .section "Run time configuration" "SECID7"
624 Exim's run time configuration is held in a single text file that is divided
625 into a number of sections. The entries in this file consist of keywords and
626 values, in the style of Smail 3 configuration files. A default configuration
627 file which is suitable for simple online installations is provided in the
628 distribution, and is described in chapter &<<CHAPdefconfil>>& below.
629
630
631 .section "Calling interface" "SECID8"
632 .cindex "Sendmail compatibility" "command line interface"
633 Like many MTAs, Exim has adopted the Sendmail command line interface so that it
634 can be a straight replacement for &_/usr/lib/sendmail_& or
635 &_/usr/sbin/sendmail_& when sending mail, but you do not need to know anything
636 about Sendmail in order to run Exim. For actions other than sending messages,
637 Sendmail-compatible options also exist, but those that produce output (for
638 example, &%-bp%&, which lists the messages on the queue) do so in Exim's own
639 format. There are also some additional options that are compatible with Smail
640 3, and some further options that are new to Exim. Chapter &<<CHAPcommandline>>&
641 documents all Exim's command line options. This information is automatically
642 made into the man page that forms part of the Exim distribution.
643
644 Control of messages on the queue can be done via certain privileged command
645 line options. There is also an optional monitor program called &'eximon'&,
646 which displays current information in an X window, and which contains a menu
647 interface to Exim's command line administration options.
648
649
650
651 .section "Terminology" "SECID9"
652 .cindex "terminology definitions"
653 .cindex "body of message" "definition of"
654 The &'body'& of a message is the actual data that the sender wants to transmit.
655 It is the last part of a message, and is separated from the &'header'& (see
656 below) by a blank line.
657
658 .cindex "bounce message" "definition of"
659 When a message cannot be delivered, it is normally returned to the sender in a
660 delivery failure message or a &"non-delivery report"& (NDR). The term
661 &'bounce'& is commonly used for this action, and the error reports are often
662 called &'bounce messages'&. This is a convenient shorthand for &"delivery
663 failure error report"&. Such messages have an empty sender address in the
664 message's &'envelope'& (see below) to ensure that they cannot themselves give
665 rise to further bounce messages.
666
667 The term &'default'& appears frequently in this manual. It is used to qualify a
668 value which is used in the absence of any setting in the configuration. It may
669 also qualify an action which is taken unless a configuration setting specifies
670 otherwise.
671
672 The term &'defer'& is used when the delivery of a message to a specific
673 destination cannot immediately take place for some reason (a remote host may be
674 down, or a user's local mailbox may be full). Such deliveries are &'deferred'&
675 until a later time.
676
677 The word &'domain'& is sometimes used to mean all but the first component of a
678 host's name. It is &'not'& used in that sense here, where it normally refers to
679 the part of an email address following the @ sign.
680
681 .cindex "envelope, definition of"
682 .cindex "sender" "definition of"
683 A message in transit has an associated &'envelope'&, as well as a header and a
684 body. The envelope contains a sender address (to which bounce messages should
685 be delivered), and any number of recipient addresses. References to the
686 sender or the recipients of a message usually mean the addresses in the
687 envelope. An MTA uses these addresses for delivery, and for returning bounce
688 messages, not the addresses that appear in the header lines.
689
690 .cindex "message" "header, definition of"
691 .cindex "header section" "definition of"
692 The &'header'& of a message is the first part of a message's text, consisting
693 of a number of lines, each of which has a name such as &'From:'&, &'To:'&,
694 &'Subject:'&, etc. Long header lines can be split over several text lines by
695 indenting the continuations. The header is separated from the body by a blank
696 line.
697
698 .cindex "local part" "definition of"
699 .cindex "domain" "definition of"
700 The term &'local part'&, which is taken from RFC 2822, is used to refer to that
701 part of an email address that precedes the @ sign. The part that follows the
702 @ sign is called the &'domain'& or &'mail domain'&.
703
704 .cindex "local delivery" "definition of"
705 .cindex "remote delivery, definition of"
706 The terms &'local delivery'& and &'remote delivery'& are used to distinguish
707 delivery to a file or a pipe on the local host from delivery by SMTP over
708 TCP/IP to another host. As far as Exim is concerned, all hosts other than the
709 host it is running on are &'remote'&.
710
711 .cindex "return path" "definition of"
712 &'Return path'& is another name that is used for the sender address in a
713 message's envelope.
714
715 .cindex "queue" "definition of"
716 The term &'queue'& is used to refer to the set of messages awaiting delivery,
717 because this term is in widespread use in the context of MTAs. However, in
718 Exim's case the reality is more like a pool than a queue, because there is
719 normally no ordering of waiting messages.
720
721 .cindex "queue runner" "definition of"
722 The term &'queue runner'& is used to describe a process that scans the queue
723 and attempts to deliver those messages whose retry times have come. This term
724 is used by other MTAs, and also relates to the command &%runq%&, but in Exim
725 the waiting messages are normally processed in an unpredictable order.
726
727 .cindex "spool directory" "definition of"
728 The term &'spool directory'& is used for a directory in which Exim keeps the
729 messages on its queue &-- that is, those that it is in the process of
730 delivering. This should not be confused with the directory in which local
731 mailboxes are stored, which is called a &"spool directory"& by some people. In
732 the Exim documentation, &"spool"& is always used in the first sense.
733
734
735
736
737
738
739 . ////////////////////////////////////////////////////////////////////////////
740 . ////////////////////////////////////////////////////////////////////////////
741
742 .chapter "Incorporated code" "CHID2"
743 .cindex "incorporated code"
744 .cindex "regular expressions" "library"
745 .cindex "PCRE"
746 .cindex "OpenDMARC"
747 A number of pieces of external code are included in the Exim distribution.
748
749 .ilist
750 Regular expressions are supported in the main Exim program and in the
751 Exim monitor using the freely-distributable PCRE library, copyright
752 &copy; University of Cambridge. The source to PCRE is no longer shipped with
753 Exim, so you will need to use the version of PCRE shipped with your system,
754 or obtain and install the full version of the library from
755 &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre).
756 .next
757 .cindex "cdb" "acknowledgment"
758 Support for the cdb (Constant DataBase) lookup method is provided by code
759 contributed by Nigel Metheringham of (at the time he contributed it) Planet
760 Online Ltd. The implementation is completely contained within the code of Exim.
761 It does not link against an external cdb library. The code contains the
762 following statements:
763
764 .blockquote
765 Copyright &copy; 1998 Nigel Metheringham, Planet Online Ltd
766
767 This program is free software; you can redistribute it and/or modify it under
768 the terms of the GNU General Public License as published by the Free Software
769 Foundation; either version 2 of the License, or (at your option) any later
770 version.
771 This code implements Dan Bernstein's Constant DataBase (cdb) spec. Information,
772 the spec and sample code for cdb can be obtained from
773 &url(http://www.pobox.com/~djb/cdb.html). This implementation borrows
774 some code from Dan Bernstein's implementation (which has no license
775 restrictions applied to it).
776 .endblockquote
777 .next
778 .cindex "SPA authentication"
779 .cindex "Samba project"
780 .cindex "Microsoft Secure Password Authentication"
781 Client support for Microsoft's &'Secure Password Authentication'& is provided
782 by code contributed by Marc Prud'hommeaux. Server support was contributed by
783 Tom Kistner. This includes code taken from the Samba project, which is released
784 under the Gnu GPL.
785 .next
786 .cindex "Cyrus"
787 .cindex "&'pwcheck'& daemon"
788 .cindex "&'pwauthd'& daemon"
789 Support for calling the Cyrus &'pwcheck'& and &'saslauthd'& daemons is provided
790 by code taken from the Cyrus-SASL library and adapted by Alexander S.
791 Sabourenkov. The permission notice appears below, in accordance with the
792 conditions expressed therein.
793
794 .blockquote
795 Copyright &copy; 2001 Carnegie Mellon University.  All rights reserved.
796
797 Redistribution and use in source and binary forms, with or without
798 modification, are permitted provided that the following conditions
799 are met:
800
801 .olist
802 Redistributions of source code must retain the above copyright
803 notice, this list of conditions and the following disclaimer.
804 .next
805 Redistributions in binary form must reproduce the above copyright
806 notice, this list of conditions and the following disclaimer in
807 the documentation and/or other materials provided with the
808 distribution.
809 .next
810 The name &"Carnegie Mellon University"& must not be used to
811 endorse or promote products derived from this software without
812 prior written permission. For permission or any other legal
813 details, please contact
814 .display
815               Office of Technology Transfer
816               Carnegie Mellon University
817               5000 Forbes Avenue
818               Pittsburgh, PA  15213-3890
819               (412) 268-4387, fax: (412) 268-7395
820               tech-transfer@andrew.cmu.edu
821 .endd
822 .next
823 Redistributions of any form whatsoever must retain the following
824 acknowledgment:
825
826 &"This product includes software developed by Computing Services
827 at Carnegie Mellon University (&url(http://www.cmu.edu/computing/)."&
828
829 CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
830 THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
831 AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
832 FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
833 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
834 AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
835 OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
836 .endlist
837 .endblockquote
838
839 .next
840 .cindex "Exim monitor" "acknowledgment"
841 .cindex "X-windows"
842 .cindex "Athena"
843 The Exim Monitor program, which is an X-Window application, includes
844 modified versions of the Athena StripChart and TextPop widgets.
845 This code is copyright by DEC and MIT, and their permission notice appears
846 below, in accordance with the conditions expressed therein.
847
848 .blockquote
849 Copyright 1987, 1988 by Digital Equipment Corporation, Maynard, Massachusetts,
850 and the Massachusetts Institute of Technology, Cambridge, Massachusetts.
851
852 All Rights Reserved
853
854 Permission to use, copy, modify, and distribute this software and its
855 documentation for any purpose and without fee is hereby granted,
856 provided that the above copyright notice appear in all copies and that
857 both that copyright notice and this permission notice appear in
858 supporting documentation, and that the names of Digital or MIT not be
859 used in advertising or publicity pertaining to distribution of the
860 software without specific, written prior permission.
861
862 DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
863 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
864 DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
865 ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
866 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
867 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
868 SOFTWARE.
869 .endblockquote
870
871 .next
872 .cindex "opendmarc" "acknowledgment"
873 The DMARC implementation uses the OpenDMARC library which is Copyrighted by
874 The Trusted Domain Project. Portions of Exim source which use OpenDMARC
875 derived code are indicated in the respective source files. The full OpenDMARC
876 license is provided in the LICENSE.opendmarc file contained in the distributed
877 source code.
878
879 .next
880 Many people have contributed code fragments, some large, some small, that were
881 not covered by any specific licence requirements. It is assumed that the
882 contributors are happy to see their code incorporated into Exim under the GPL.
883 .endlist
884
885
886
887
888
889 . ////////////////////////////////////////////////////////////////////////////
890 . ////////////////////////////////////////////////////////////////////////////
891
892 .chapter "How Exim receives and delivers mail" "CHID11" &&&
893          "Receiving and delivering mail"
894
895
896 .section "Overall philosophy" "SECID10"
897 .cindex "design philosophy"
898 Exim is designed to work efficiently on systems that are permanently connected
899 to the Internet and are handling a general mix of mail. In such circumstances,
900 most messages can be delivered immediately. Consequently, Exim does not
901 maintain independent queues of messages for specific domains or hosts, though
902 it does try to send several messages in a single SMTP connection after a host
903 has been down, and it also maintains per-host retry information.
904
905
906 .section "Policy control" "SECID11"
907 .cindex "policy control" "overview"
908 Policy controls are now an important feature of MTAs that are connected to the
909 Internet. Perhaps their most important job is to stop MTAs being abused as
910 &"open relays"& by misguided individuals who send out vast amounts of
911 unsolicited junk, and want to disguise its source. Exim provides flexible
912 facilities for specifying policy controls on incoming mail:
913
914 .ilist
915 .cindex "&ACL;" "introduction"
916 Exim 4 (unlike previous versions of Exim) implements policy controls on
917 incoming mail by means of &'Access Control Lists'& (ACLs). Each list is a
918 series of statements that may either grant or deny access. ACLs can be used at
919 several places in the SMTP dialogue while receiving a message from a remote
920 host. However, the most common places are after each RCPT command, and at the
921 very end of the message. The sysadmin can specify conditions for accepting or
922 rejecting individual recipients or the entire message, respectively, at these
923 two points (see chapter &<<CHAPACL>>&). Denial of access results in an SMTP
924 error code.
925 .next
926 An ACL is also available for locally generated, non-SMTP messages. In this
927 case, the only available actions are to accept or deny the entire message.
928 .next
929 When Exim is compiled with the content-scanning extension, facilities are
930 provided in the ACL mechanism for passing the message to external virus and/or
931 spam scanning software. The result of such a scan is passed back to the ACL,
932 which can then use it to decide what to do with the message.
933 .next
934 When a message has been received, either from a remote host or from the local
935 host, but before the final acknowledgment has been sent, a locally supplied C
936 function called &[local_scan()]& can be run to inspect the message and decide
937 whether to accept it or not (see chapter &<<CHAPlocalscan>>&). If the message
938 is accepted, the list of recipients can be modified by the function.
939 .next
940 Using the &[local_scan()]& mechanism is another way of calling external scanner
941 software. The &%SA-Exim%& add-on package works this way. It does not require
942 Exim to be compiled with the content-scanning extension.
943 .next
944 After a message has been accepted, a further checking mechanism is available in
945 the form of the &'system filter'& (see chapter &<<CHAPsystemfilter>>&). This
946 runs at the start of every delivery process.
947 .endlist
948
949
950
951 .section "User filters" "SECID12"
952 .cindex "filter" "introduction"
953 .cindex "Sieve filter"
954 In a conventional Exim configuration, users are able to run private filters by
955 setting up appropriate &_.forward_& files in their home directories. See
956 chapter &<<CHAPredirect>>& (about the &(redirect)& router) for the
957 configuration needed to support this, and the separate document entitled
958 &'Exim's interfaces to mail filtering'& for user details. Two different kinds
959 of filtering are available:
960
961 .ilist
962 Sieve filters are written in the standard filtering language that is defined
963 by RFC 3028.
964 .next
965 Exim filters are written in a syntax that is unique to Exim, but which is more
966 powerful than Sieve, which it pre-dates.
967 .endlist
968
969 User filters are run as part of the routing process, described below.
970
971
972
973 .section "Message identification" "SECTmessiden"
974 .cindex "message ids" "details of format"
975 .cindex "format" "of message id"
976 .cindex "id of message"
977 .cindex "base62"
978 .cindex "base36"
979 .cindex "Darwin"
980 .cindex "Cygwin"
981 Every message handled by Exim is given a &'message id'& which is sixteen
982 characters long. It is divided into three parts, separated by hyphens, for
983 example &`16VDhn-0001bo-D3`&. Each part is a sequence of letters and digits,
984 normally encoding numbers in base 62. However, in the Darwin operating
985 system (Mac OS X) and when Exim is compiled to run under Cygwin, base 36
986 (avoiding the use of lower case letters) is used instead, because the message
987 id is used to construct file names, and the names of files in those systems are
988 not always case-sensitive.
989
990 .cindex "pid (process id)" "re-use of"
991 The detail of the contents of the message id have changed as Exim has evolved.
992 Earlier versions relied on the operating system not re-using a process id (pid)
993 within one second. On modern operating systems, this assumption can no longer
994 be made, so the algorithm had to be changed. To retain backward compatibility,
995 the format of the message id was retained, which is why the following rules are
996 somewhat eccentric:
997
998 .ilist
999 The first six characters of the message id are the time at which the message
1000 started to be received, to a granularity of one second. That is, this field
1001 contains the number of seconds since the start of the epoch (the normal Unix
1002 way of representing the date and time of day).
1003 .next
1004 After the first hyphen, the next six characters are the id of the process that
1005 received the message.
1006 .next
1007 There are two different possibilities for the final two characters:
1008 .olist
1009 .oindex "&%localhost_number%&"
1010 If &%localhost_number%& is not set, this value is the fractional part of the
1011 time of reception, normally in units of 1/2000 of a second, but for systems
1012 that must use base 36 instead of base 62 (because of case-insensitive file
1013 systems), the units are 1/1000 of a second.
1014 .next
1015 If &%localhost_number%& is set, it is multiplied by 200 (100) and added to
1016 the fractional part of the time, which in this case is in units of 1/200
1017 (1/100) of a second.
1018 .endlist
1019 .endlist
1020
1021 After a message has been received, Exim waits for the clock to tick at the
1022 appropriate resolution before proceeding, so that if another message is
1023 received by the same process, or by another process with the same (re-used)
1024 pid, it is guaranteed that the time will be different. In most cases, the clock
1025 will already have ticked while the message was being received.
1026
1027
1028 .section "Receiving mail" "SECID13"
1029 .cindex "receiving mail"
1030 .cindex "message" "reception"
1031 The only way Exim can receive mail from another host is using SMTP over
1032 TCP/IP, in which case the sender and recipient addresses are transferred using
1033 SMTP commands. However, from a locally running process (such as a user's MUA),
1034 there are several possibilities:
1035
1036 .ilist
1037 If the process runs Exim with the &%-bm%& option, the message is read
1038 non-interactively (usually via a pipe), with the recipients taken from the
1039 command line, or from the body of the message if &%-t%& is also used.
1040 .next
1041 If the process runs Exim with the &%-bS%& option, the message is also read
1042 non-interactively, but in this case the recipients are listed at the start of
1043 the message in a series of SMTP RCPT commands, terminated by a DATA
1044 command. This is so-called &"batch SMTP"& format,
1045 but it isn't really SMTP. The SMTP commands are just another way of passing
1046 envelope addresses in a non-interactive submission.
1047 .next
1048 If the process runs Exim with the &%-bs%& option, the message is read
1049 interactively, using the SMTP protocol. A two-way pipe is normally used for
1050 passing data between the local process and the Exim process.
1051 This is &"real"& SMTP and is handled in the same way as SMTP over TCP/IP. For
1052 example, the ACLs for SMTP commands are used for this form of submission.
1053 .next
1054 A local process may also make a TCP/IP call to the host's loopback address
1055 (127.0.0.1) or any other of its IP addresses. When receiving messages, Exim
1056 does not treat the loopback address specially. It treats all such connections
1057 in the same way as connections from other hosts.
1058 .endlist
1059
1060
1061 .cindex "message sender, constructed by Exim"
1062 .cindex "sender" "constructed by Exim"
1063 In the three cases that do not involve TCP/IP, the sender address is
1064 constructed from the login name of the user that called Exim and a default
1065 qualification domain (which can be set by the &%qualify_domain%& configuration
1066 option). For local or batch SMTP, a sender address that is passed using the
1067 SMTP MAIL command is ignored. However, the system administrator may allow
1068 certain users (&"trusted users"&) to specify a different sender address
1069 unconditionally, or all users to specify certain forms of different sender
1070 address. The &%-f%& option or the SMTP MAIL command is used to specify these
1071 different addresses. See section &<<SECTtrustedadmin>>& for details of trusted
1072 users, and the &%untrusted_set_sender%& option for a way of allowing untrusted
1073 users to change sender addresses.
1074
1075 Messages received by either of the non-interactive mechanisms are subject to
1076 checking by the non-SMTP ACL, if one is defined. Messages received using SMTP
1077 (either over TCP/IP, or interacting with a local process) can be checked by a
1078 number of ACLs that operate at different times during the SMTP session. Either
1079 individual recipients, or the entire message, can be rejected if local policy
1080 requirements are not met. The &[local_scan()]& function (see chapter
1081 &<<CHAPlocalscan>>&) is run for all incoming messages.
1082
1083 Exim can be configured not to start a delivery process when a message is
1084 received; this can be unconditional, or depend on the number of incoming SMTP
1085 connections or the system load. In these situations, new messages wait on the
1086 queue until a queue runner process picks them up. However, in standard
1087 configurations under normal conditions, delivery is started as soon as a
1088 message is received.
1089
1090
1091
1092
1093
1094 .section "Handling an incoming message" "SECID14"
1095 .cindex "spool directory" "files that hold a message"
1096 .cindex "file" "how a message is held"
1097 When Exim accepts a message, it writes two files in its spool directory. The
1098 first contains the envelope information, the current status of the message, and
1099 the header lines, and the second contains the body of the message. The names of
1100 the two spool files consist of the message id, followed by &`-H`& for the
1101 file containing the envelope and header, and &`-D`& for the data file.
1102
1103 .cindex "spool directory" "&_input_& sub-directory"
1104 By default all these message files are held in a single directory called
1105 &_input_& inside the general Exim spool directory. Some operating systems do
1106 not perform very well if the number of files in a directory gets large; to
1107 improve performance in such cases, the &%split_spool_directory%& option can be
1108 used. This causes Exim to split up the input files into 62 sub-directories
1109 whose names are single letters or digits. When this is done, the queue is
1110 processed one sub-directory at a time instead of all at once, which can improve
1111 overall performance even when there are not enough files in each directory to
1112 affect file system performance.
1113
1114 The envelope information consists of the address of the message's sender and
1115 the addresses of the recipients. This information is entirely separate from
1116 any addresses contained in the header lines. The status of the message includes
1117 a list of recipients who have already received the message. The format of the
1118 first spool file is described in chapter &<<CHAPspool>>&.
1119
1120 .cindex "rewriting" "addresses"
1121 Address rewriting that is specified in the rewrite section of the configuration
1122 (see chapter &<<CHAPrewrite>>&) is done once and for all on incoming addresses,
1123 both in the header lines and the envelope, at the time the message is accepted.
1124 If during the course of delivery additional addresses are generated (for
1125 example, via aliasing), these new addresses are rewritten as soon as they are
1126 generated. At the time a message is actually delivered (transported) further
1127 rewriting can take place; because this is a transport option, it can be
1128 different for different forms of delivery. It is also possible to specify the
1129 addition or removal of certain header lines at the time the message is
1130 delivered (see chapters &<<CHAProutergeneric>>& and
1131 &<<CHAPtransportgeneric>>&).
1132
1133
1134
1135 .section "Life of a message" "SECID15"
1136 .cindex "message" "life of"
1137 .cindex "message" "frozen"
1138 A message remains in the spool directory until it is completely delivered to
1139 its recipients or to an error address, or until it is deleted by an
1140 administrator or by the user who originally created it. In cases when delivery
1141 cannot proceed &-- for example, when a message can neither be delivered to its
1142 recipients nor returned to its sender, the message is marked &"frozen"& on the
1143 spool, and no more deliveries are attempted.
1144
1145 .cindex "frozen messages" "thawing"
1146 .cindex "message" "thawing frozen"
1147 An administrator can &"thaw"& such messages when the problem has been
1148 corrected, and can also freeze individual messages by hand if necessary. In
1149 addition, an administrator can force a delivery error, causing a bounce message
1150 to be sent.
1151
1152 .oindex "&%timeout_frozen_after%&"
1153 .oindex "&%ignore_bounce_errors_after%&"
1154 There are options called &%ignore_bounce_errors_after%& and
1155 &%timeout_frozen_after%&, which discard frozen messages after a certain time.
1156 The first applies only to frozen bounces, the second to any frozen messages.
1157
1158 .cindex "message" "log file for"
1159 .cindex "log" "file for each message"
1160 While Exim is working on a message, it writes information about each delivery
1161 attempt to its main log file. This includes successful, unsuccessful, and
1162 delayed deliveries for each recipient (see chapter &<<CHAPlog>>&). The log
1163 lines are also written to a separate &'message log'& file for each message.
1164 These logs are solely for the benefit of the administrator, and are normally
1165 deleted along with the spool files when processing of a message is complete.
1166 The use of individual message logs can be disabled by setting
1167 &%no_message_logs%&; this might give an improvement in performance on very busy
1168 systems.
1169
1170 .cindex "journal file"
1171 .cindex "file" "journal"
1172 All the information Exim itself needs to set up a delivery is kept in the first
1173 spool file, along with the header lines. When a successful delivery occurs, the
1174 address is immediately written at the end of a journal file, whose name is the
1175 message id followed by &`-J`&. At the end of a delivery run, if there are some
1176 addresses left to be tried again later, the first spool file (the &`-H`& file)
1177 is updated to indicate which these are, and the journal file is then deleted.
1178 Updating the spool file is done by writing a new file and renaming it, to
1179 minimize the possibility of data loss.
1180
1181 Should the system or the program crash after a successful delivery but before
1182 the spool file has been updated, the journal is left lying around. The next
1183 time Exim attempts to deliver the message, it reads the journal file and
1184 updates the spool file before proceeding. This minimizes the chances of double
1185 deliveries caused by crashes.
1186
1187
1188
1189 .section "Processing an address for delivery" "SECTprocaddress"
1190 .cindex "drivers" "definition of"
1191 .cindex "router" "definition of"
1192 .cindex "transport" "definition of"
1193 The main delivery processing elements of Exim are called &'routers'& and
1194 &'transports'&, and collectively these are known as &'drivers'&. Code for a
1195 number of them is provided in the source distribution, and compile-time options
1196 specify which ones are included in the binary. Run time options specify which
1197 ones are actually used for delivering messages.
1198
1199 .cindex "drivers" "instance definition"
1200 Each driver that is specified in the run time configuration is an &'instance'&
1201 of that particular driver type. Multiple instances are allowed; for example,
1202 you can set up several different &(smtp)& transports, each with different
1203 option values that might specify different ports or different timeouts. Each
1204 instance has its own identifying name. In what follows we will normally use the
1205 instance name when discussing one particular instance (that is, one specific
1206 configuration of the driver), and the generic driver name when discussing
1207 the driver's features in general.
1208
1209 A &'router'& is a driver that operates on an address, either determining how
1210 its delivery should happen, by assigning it to a specific transport, or
1211 converting the address into one or more new addresses (for example, via an
1212 alias file). A router may also explicitly choose to fail an address, causing it
1213 to be bounced.
1214
1215 A &'transport'& is a driver that transmits a copy of the message from Exim's
1216 spool to some destination. There are two kinds of transport: for a &'local'&
1217 transport, the destination is a file or a pipe on the local host, whereas for a
1218 &'remote'& transport the destination is some other host. A message is passed
1219 to a specific transport as a result of successful routing. If a message has
1220 several recipients, it may be passed to a number of different transports.
1221
1222 .cindex "preconditions" "definition of"
1223 An address is processed by passing it to each configured router instance in
1224 turn, subject to certain preconditions, until a router accepts the address or
1225 specifies that it should be bounced. We will describe this process in more
1226 detail shortly. First, as a simple example, we consider how each recipient
1227 address in a message is processed in a small configuration of three routers.
1228
1229 To make this a more concrete example, it is described in terms of some actual
1230 routers, but remember, this is only an example. You can configure Exim's
1231 routers in many different ways, and there may be any number of routers in a
1232 configuration.
1233
1234 The first router that is specified in a configuration is often one that handles
1235 addresses in domains that are not recognized specially by the local host. These
1236 are typically addresses for arbitrary domains on the Internet. A precondition
1237 is set up which looks for the special domains known to the host (for example,
1238 its own domain name), and the router is run for addresses that do &'not'&
1239 match. Typically, this is a router that looks up domains in the DNS in order to
1240 find the hosts to which this address routes. If it succeeds, the address is
1241 assigned to a suitable SMTP transport; if it does not succeed, the router is
1242 configured to fail the address.
1243
1244 The second router is reached only when the domain is recognized as one that
1245 &"belongs"& to the local host. This router does redirection &-- also known as
1246 aliasing and forwarding. When it generates one or more new addresses from the
1247 original, each of them is routed independently from the start. Otherwise, the
1248 router may cause an address to fail, or it may simply decline to handle the
1249 address, in which case the address is passed to the next router.
1250
1251 The final router in many configurations is one that checks to see if the
1252 address belongs to a local mailbox. The precondition may involve a check to
1253 see if the local part is the name of a login account, or it may look up the
1254 local part in a file or a database. If its preconditions are not met, or if
1255 the router declines, we have reached the end of the routers. When this happens,
1256 the address is bounced.
1257
1258
1259
1260 .section "Processing an address for verification" "SECID16"
1261 .cindex "router" "for verification"
1262 .cindex "verifying address" "overview"
1263 As well as being used to decide how to deliver to an address, Exim's routers
1264 are also used for &'address verification'&. Verification can be requested as
1265 one of the checks to be performed in an ACL for incoming messages, on both
1266 sender and recipient addresses, and it can be tested using the &%-bv%& and
1267 &%-bvs%& command line options.
1268
1269 When an address is being verified, the routers are run in &"verify mode"&. This
1270 does not affect the way the routers work, but it is a state that can be
1271 detected. By this means, a router can be skipped or made to behave differently
1272 when verifying. A common example is a configuration in which the first router
1273 sends all messages to a message-scanning program, unless they have been
1274 previously scanned. Thus, the first router accepts all addresses without any
1275 checking, making it useless for verifying. Normally, the &%no_verify%& option
1276 would be set for such a router, causing it to be skipped in verify mode.
1277
1278
1279
1280
1281 .section "Running an individual router" "SECTrunindrou"
1282 .cindex "router" "running details"
1283 .cindex "preconditions" "checking"
1284 .cindex "router" "result of running"
1285 As explained in the example above, a number of preconditions are checked before
1286 running a router. If any are not met, the router is skipped, and the address is
1287 passed to the next router. When all the preconditions on a router &'are'& met,
1288 the router is run. What happens next depends on the outcome, which is one of
1289 the following:
1290
1291 .ilist
1292 &'accept'&: The router accepts the address, and either assigns it to a
1293 transport, or generates one or more &"child"& addresses. Processing the
1294 original address ceases,
1295 .oindex "&%unseen%&"
1296 unless the &%unseen%& option is set on the router. This option
1297 can be used to set up multiple deliveries with different routing (for example,
1298 for keeping archive copies of messages). When &%unseen%& is set, the address is
1299 passed to the next router. Normally, however, an &'accept'& return marks the
1300 end of routing.
1301
1302 Any child addresses generated by the router are processed independently,
1303 starting with the first router by default. It is possible to change this by
1304 setting the &%redirect_router%& option to specify which router to start at for
1305 child addresses. Unlike &%pass_router%& (see below) the router specified by
1306 &%redirect_router%& may be anywhere in the router configuration.
1307 .next
1308 &'pass'&: The router recognizes the address, but cannot handle it itself. It
1309 requests that the address be passed to another router. By default the address
1310 is passed to the next router, but this can be changed by setting the
1311 &%pass_router%& option. However, (unlike &%redirect_router%&) the named router
1312 must be below the current router (to avoid loops).
1313 .next
1314 &'decline'&: The router declines to accept the address because it does not
1315 recognize it at all. By default, the address is passed to the next router, but
1316 this can be prevented by setting the &%no_more%& option. When &%no_more%& is
1317 set, all the remaining routers are skipped. In effect, &%no_more%& converts
1318 &'decline'& into &'fail'&.
1319 .next
1320 &'fail'&: The router determines that the address should fail, and queues it for
1321 the generation of a bounce message. There is no further processing of the
1322 original address unless &%unseen%& is set on the router.
1323 .next
1324 &'defer'&: The router cannot handle the address at the present time. (A
1325 database may be offline, or a DNS lookup may have timed out.) No further
1326 processing of the address happens in this delivery attempt. It is tried again
1327 next time the message is considered for delivery.
1328 .next
1329 &'error'&: There is some error in the router (for example, a syntax error in
1330 its configuration). The action is as for defer.
1331 .endlist
1332
1333 If an address reaches the end of the routers without having been accepted by
1334 any of them, it is bounced as unrouteable. The default error message in this
1335 situation is &"unrouteable address"&, but you can set your own message by
1336 making use of the &%cannot_route_message%& option. This can be set for any
1337 router; the value from the last router that &"saw"& the address is used.
1338
1339 Sometimes while routing you want to fail a delivery when some conditions are
1340 met but others are not, instead of passing the address on for further routing.
1341 You can do this by having a second router that explicitly fails the delivery
1342 when the relevant conditions are met. The &(redirect)& router has a &"fail"&
1343 facility for this purpose.
1344
1345
1346 .section "Duplicate addresses" "SECID17"
1347 .cindex "case of local parts"
1348 .cindex "address duplicate, discarding"
1349 .cindex "duplicate addresses"
1350 Once routing is complete, Exim scans the addresses that are assigned to local
1351 and remote transports, and discards any duplicates that it finds. During this
1352 check, local parts are treated as case-sensitive. This happens only when
1353 actually delivering a message; when testing routers with &%-bt%&, all the
1354 routed addresses are shown.
1355
1356
1357
1358 .section "Router preconditions" "SECTrouprecon"
1359 .cindex "router" "preconditions, order of processing"
1360 .cindex "preconditions" "order of processing"
1361 The preconditions that are tested for each router are listed below, in the
1362 order in which they are tested. The individual configuration options are
1363 described in more detail in chapter &<<CHAProutergeneric>>&.
1364
1365 .ilist
1366 The &%local_part_prefix%& and &%local_part_suffix%& options can specify that
1367 the local parts handled by the router may or must have certain prefixes and/or
1368 suffixes. If a mandatory affix (prefix or suffix) is not present, the router is
1369 skipped. These conditions are tested first. When an affix is present, it is
1370 removed from the local part before further processing, including the evaluation
1371 of any other conditions.
1372 .next
1373 Routers can be designated for use only when not verifying an address, that is,
1374 only when routing it for delivery (or testing its delivery routing). If the
1375 &%verify%& option is set false, the router is skipped when Exim is verifying an
1376 address.
1377 Setting the &%verify%& option actually sets two options, &%verify_sender%& and
1378 &%verify_recipient%&, which independently control the use of the router for
1379 sender and recipient verification. You can set these options directly if
1380 you want a router to be used for only one type of verification.
1381 Note that cutthrough delivery is classed as a recipient verification for this purpose.
1382 .next
1383 If the &%address_test%& option is set false, the router is skipped when Exim is
1384 run with the &%-bt%& option to test an address routing. This can be helpful
1385 when the first router sends all new messages to a scanner of some sort; it
1386 makes it possible to use &%-bt%& to test subsequent delivery routing without
1387 having to simulate the effect of the scanner.
1388 .next
1389 Routers can be designated for use only when verifying an address, as
1390 opposed to routing it for delivery. The &%verify_only%& option controls this.
1391 Again, cutthrough delivery counts as a verification.
1392 .next
1393 Individual routers can be explicitly skipped when running the routers to
1394 check an address given in the SMTP EXPN command (see the &%expn%& option).
1395 .next
1396 If the &%domains%& option is set, the domain of the address must be in the set
1397 of domains that it defines.
1398 .next
1399 .vindex "&$local_part_prefix$&"
1400 .vindex "&$local_part$&"
1401 .vindex "&$local_part_suffix$&"
1402 If the &%local_parts%& option is set, the local part of the address must be in
1403 the set of local parts that it defines. If &%local_part_prefix%& or
1404 &%local_part_suffix%& is in use, the prefix or suffix is removed from the local
1405 part before this check. If you want to do precondition tests on local parts
1406 that include affixes, you can do so by using a &%condition%& option (see below)
1407 that uses the variables &$local_part$&, &$local_part_prefix$&, and
1408 &$local_part_suffix$& as necessary.
1409 .next
1410 .vindex "&$local_user_uid$&"
1411 .vindex "&$local_user_gid$&"
1412 .vindex "&$home$&"
1413 If the &%check_local_user%& option is set, the local part must be the name of
1414 an account on the local host. If this check succeeds, the uid and gid of the
1415 local user are placed in &$local_user_uid$& and &$local_user_gid$& and the
1416 user's home directory is placed in &$home$&; these values can be used in the
1417 remaining preconditions.
1418 .next
1419 If the &%router_home_directory%& option is set, it is expanded at this point,
1420 because it overrides the value of &$home$&. If this expansion were left till
1421 later, the value of &$home$& as set by &%check_local_user%& would be used in
1422 subsequent tests. Having two different values of &$home$& in the same router
1423 could lead to confusion.
1424 .next
1425 If the &%senders%& option is set, the envelope sender address must be in the
1426 set of addresses that it defines.
1427 .next
1428 If the &%require_files%& option is set, the existence or non-existence of
1429 specified files is tested.
1430 .next
1431 .cindex "customizing" "precondition"
1432 If the &%condition%& option is set, it is evaluated and tested. This option
1433 uses an expanded string to allow you to set up your own custom preconditions.
1434 Expanded strings are described in chapter &<<CHAPexpand>>&.
1435 .endlist
1436
1437
1438 Note that &%require_files%& comes near the end of the list, so you cannot use
1439 it to check for the existence of a file in which to lookup up a domain, local
1440 part, or sender. However, as these options are all expanded, you can use the
1441 &%exists%& expansion condition to make such tests within each condition. The
1442 &%require_files%& option is intended for checking files that the router may be
1443 going to use internally, or which are needed by a specific transport (for
1444 example, &_.procmailrc_&).
1445
1446
1447
1448 .section "Delivery in detail" "SECID18"
1449 .cindex "delivery" "in detail"
1450 When a message is to be delivered, the sequence of events is as follows:
1451
1452 .ilist
1453 If a system-wide filter file is specified, the message is passed to it. The
1454 filter may add recipients to the message, replace the recipients, discard the
1455 message, cause a new message to be generated, or cause the message delivery to
1456 fail. The format of the system filter file is the same as for Exim user filter
1457 files, described in the separate document entitled &'Exim's interfaces to mail
1458 filtering'&.
1459 .cindex "Sieve filter" "not available for system filter"
1460 (&*Note*&: Sieve cannot be used for system filter files.)
1461
1462 Some additional features are available in system filters &-- see chapter
1463 &<<CHAPsystemfilter>>& for details. Note that a message is passed to the system
1464 filter only once per delivery attempt, however many recipients it has. However,
1465 if there are several delivery attempts because one or more addresses could not
1466 be immediately delivered, the system filter is run each time. The filter
1467 condition &%first_delivery%& can be used to detect the first run of the system
1468 filter.
1469 .next
1470 Each recipient address is offered to each configured router in turn, subject to
1471 its preconditions, until one is able to handle it. If no router can handle the
1472 address, that is, if they all decline, the address is failed. Because routers
1473 can be targeted at particular domains, several locally handled domains can be
1474 processed entirely independently of each other.
1475 .next
1476 .cindex "routing" "loops in"
1477 .cindex "loop" "while routing"
1478 A router that accepts an address may assign it to a local or a remote
1479 transport. However, the transport is not run at this time. Instead, the address
1480 is placed on a list for the particular transport, which will be run later.
1481 Alternatively, the router may generate one or more new addresses (typically
1482 from alias, forward, or filter files). New addresses are fed back into this
1483 process from the top, but in order to avoid loops, a router ignores any address
1484 which has an identically-named ancestor that was processed by itself.
1485 .next
1486 When all the routing has been done, addresses that have been successfully
1487 handled are passed to their assigned transports. When local transports are
1488 doing real local deliveries, they handle only one address at a time, but if a
1489 local transport is being used as a pseudo-remote transport (for example, to
1490 collect batched SMTP messages for transmission by some other means) multiple
1491 addresses can be handled. Remote transports can always handle more than one
1492 address at a time, but can be configured not to do so, or to restrict multiple
1493 addresses to the same domain.
1494 .next
1495 Each local delivery to a file or a pipe runs in a separate process under a
1496 non-privileged uid, and these deliveries are run one at a time. Remote
1497 deliveries also run in separate processes, normally under a uid that is private
1498 to Exim (&"the Exim user"&), but in this case, several remote deliveries can be
1499 run in parallel. The maximum number of simultaneous remote deliveries for any
1500 one message is set by the &%remote_max_parallel%& option.
1501 The order in which deliveries are done is not defined, except that all local
1502 deliveries happen before any remote deliveries.
1503 .next
1504 .cindex "queue runner"
1505 When it encounters a local delivery during a queue run, Exim checks its retry
1506 database to see if there has been a previous temporary delivery failure for the
1507 address before running the local transport. If there was a previous failure,
1508 Exim does not attempt a new delivery until the retry time for the address is
1509 reached. However, this happens only for delivery attempts that are part of a
1510 queue run. Local deliveries are always attempted when delivery immediately
1511 follows message reception, even if retry times are set for them. This makes for
1512 better behaviour if one particular message is causing problems (for example,
1513 causing quota overflow, or provoking an error in a filter file).
1514 .next
1515 .cindex "delivery" "retry in remote transports"
1516 Remote transports do their own retry handling, since an address may be
1517 deliverable to one of a number of hosts, each of which may have a different
1518 retry time. If there have been previous temporary failures and no host has
1519 reached its retry time, no delivery is attempted, whether in a queue run or
1520 not. See chapter &<<CHAPretry>>& for details of retry strategies.
1521 .next
1522 If there were any permanent errors, a bounce message is returned to an
1523 appropriate address (the sender in the common case), with details of the error
1524 for each failing address. Exim can be configured to send copies of bounce
1525 messages to other addresses.
1526 .next
1527 .cindex "delivery" "deferral"
1528 If one or more addresses suffered a temporary failure, the message is left on
1529 the queue, to be tried again later. Delivery of these addresses is said to be
1530 &'deferred'&.
1531 .next
1532 When all the recipient addresses have either been delivered or bounced,
1533 handling of the message is complete. The spool files and message log are
1534 deleted, though the message log can optionally be preserved if required.
1535 .endlist
1536
1537
1538
1539
1540 .section "Retry mechanism" "SECID19"
1541 .cindex "delivery" "retry mechanism"
1542 .cindex "retry" "description of mechanism"
1543 .cindex "queue runner"
1544 Exim's mechanism for retrying messages that fail to get delivered at the first
1545 attempt is the queue runner process. You must either run an Exim daemon that
1546 uses the &%-q%& option with a time interval to start queue runners at regular
1547 intervals, or use some other means (such as &'cron'&) to start them. If you do
1548 not arrange for queue runners to be run, messages that fail temporarily at the
1549 first attempt will remain on your queue for ever. A queue runner process works
1550 its way through the queue, one message at a time, trying each delivery that has
1551 passed its retry time.
1552 You can run several queue runners at once.
1553
1554 Exim uses a set of configured rules to determine when next to retry the failing
1555 address (see chapter &<<CHAPretry>>&). These rules also specify when Exim
1556 should give up trying to deliver to the address, at which point it generates a
1557 bounce message. If no retry rules are set for a particular host, address, and
1558 error combination, no retries are attempted, and temporary errors are treated
1559 as permanent.
1560
1561
1562
1563 .section "Temporary delivery failure" "SECID20"
1564 .cindex "delivery" "temporary failure"
1565 There are many reasons why a message may not be immediately deliverable to a
1566 particular address. Failure to connect to a remote machine (because it, or the
1567 connection to it, is down) is one of the most common. Temporary failures may be
1568 detected during routing as well as during the transport stage of delivery.
1569 Local deliveries may be delayed if NFS files are unavailable, or if a mailbox
1570 is on a file system where the user is over quota. Exim can be configured to
1571 impose its own quotas on local mailboxes; where system quotas are set they will
1572 also apply.
1573
1574 If a host is unreachable for a period of time, a number of messages may be
1575 waiting for it by the time it recovers, and sending them in a single SMTP
1576 connection is clearly beneficial. Whenever a delivery to a remote host is
1577 deferred,
1578 .cindex "hints database" "deferred deliveries"
1579 Exim makes a note in its hints database, and whenever a successful
1580 SMTP delivery has happened, it looks to see if any other messages are waiting
1581 for the same host. If any are found, they are sent over the same SMTP
1582 connection, subject to a configuration limit as to the maximum number in any
1583 one connection.
1584
1585
1586
1587 .section "Permanent delivery failure" "SECID21"
1588 .cindex "delivery" "permanent failure"
1589 .cindex "bounce message" "when generated"
1590 When a message cannot be delivered to some or all of its intended recipients, a
1591 bounce message is generated. Temporary delivery failures turn into permanent
1592 errors when their timeout expires. All the addresses that fail in a given
1593 delivery attempt are listed in a single message. If the original message has
1594 many recipients, it is possible for some addresses to fail in one delivery
1595 attempt and others to fail subsequently, giving rise to more than one bounce
1596 message. The wording of bounce messages can be customized by the administrator.
1597 See chapter &<<CHAPemsgcust>>& for details.
1598
1599 .cindex "&'X-Failed-Recipients:'& header line"
1600 Bounce messages contain an &'X-Failed-Recipients:'& header line that lists the
1601 failed addresses, for the benefit of programs that try to analyse such messages
1602 automatically.
1603
1604 .cindex "bounce message" "recipient of"
1605 A bounce message is normally sent to the sender of the original message, as
1606 obtained from the message's envelope. For incoming SMTP messages, this is the
1607 address given in the MAIL command. However, when an address is expanded via a
1608 forward or alias file, an alternative address can be specified for delivery
1609 failures of the generated addresses. For a mailing list expansion (see section
1610 &<<SECTmailinglists>>&) it is common to direct bounce messages to the manager
1611 of the list.
1612
1613
1614
1615 .section "Failures to deliver bounce messages" "SECID22"
1616 .cindex "bounce message" "failure to deliver"
1617 If a bounce message (either locally generated or received from a remote host)
1618 itself suffers a permanent delivery failure, the message is left on the queue,
1619 but it is frozen, awaiting the attention of an administrator. There are options
1620 that can be used to make Exim discard such failed messages, or to keep them
1621 for only a short time (see &%timeout_frozen_after%& and
1622 &%ignore_bounce_errors_after%&).
1623
1624
1625
1626
1627
1628 . ////////////////////////////////////////////////////////////////////////////
1629 . ////////////////////////////////////////////////////////////////////////////
1630
1631 .chapter "Building and installing Exim" "CHID3"
1632 .scindex IIDbuex "building Exim"
1633
1634 .section "Unpacking" "SECID23"
1635 Exim is distributed as a gzipped or bzipped tar file which, when unpacked,
1636 creates a directory with the name of the current release (for example,
1637 &_exim-&version()_&) into which the following files are placed:
1638
1639 .table2 140pt
1640 .irow &_ACKNOWLEDGMENTS_& "contains some acknowledgments"
1641 .irow &_CHANGES_&         "contains a reference to where changes are &&&
1642   documented"
1643 .irow &_LICENCE_&         "the GNU General Public Licence"
1644 .irow &_Makefile_&        "top-level make file"
1645 .irow &_NOTICE_&          "conditions for the use of Exim"
1646 .irow &_README_&          "list of files, directories and simple build &&&
1647   instructions"
1648 .endtable
1649
1650 Other files whose names begin with &_README_& may also be present. The
1651 following subdirectories are created:
1652
1653 .table2 140pt
1654 .irow &_Local_&           "an empty directory for local configuration files"
1655 .irow &_OS_&              "OS-specific files"
1656 .irow &_doc_&             "documentation files"
1657 .irow &_exim_monitor_&    "source files for the Exim monitor"
1658 .irow &_scripts_&         "scripts used in the build process"
1659 .irow &_src_&             "remaining source files"
1660 .irow &_util_&            "independent utilities"
1661 .endtable
1662
1663 The main utility programs are contained in the &_src_& directory, and are built
1664 with the Exim binary. The &_util_& directory contains a few optional scripts
1665 that may be useful to some sites.
1666
1667
1668 .section "Multiple machine architectures and operating systems" "SECID24"
1669 .cindex "building Exim" "multiple OS/architectures"
1670 The building process for Exim is arranged to make it easy to build binaries for
1671 a number of different architectures and operating systems from the same set of
1672 source files. Compilation does not take place in the &_src_& directory.
1673 Instead, a &'build directory'& is created for each architecture and operating
1674 system.
1675 .cindex "symbolic link" "to build directory"
1676 Symbolic links to the sources are installed in this directory, which is where
1677 the actual building takes place. In most cases, Exim can discover the machine
1678 architecture and operating system for itself, but the defaults can be
1679 overridden if necessary.
1680
1681
1682 .section "PCRE library" "SECTpcre"
1683 .cindex "PCRE library"
1684 Exim no longer has an embedded PCRE library as the vast majority of
1685 modern systems include PCRE as a system library, although you may need
1686 to install the PCRE or PCRE development package for your operating
1687 system. If your system has a normal PCRE installation the Exim build
1688 process will need no further configuration. If the library or the
1689 headers are in an unusual location you will need to either set the PCRE_LIBS
1690 and INCLUDE directives appropriately,
1691 or set PCRE_CONFIG=yes to use the installed &(pcre-config)& command.
1692 If your operating system has no
1693 PCRE support then you will need to obtain and build the current PCRE
1694 from &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/).
1695 More information on PCRE is available at &url(http://www.pcre.org/).
1696
1697 .section "DBM libraries" "SECTdb"
1698 .cindex "DBM libraries" "discussion of"
1699 .cindex "hints database" "DBM files used for"
1700 Even if you do not use any DBM files in your configuration, Exim still needs a
1701 DBM library in order to operate, because it uses indexed files for its hints
1702 databases. Unfortunately, there are a number of DBM libraries in existence, and
1703 different operating systems often have different ones installed.
1704
1705 .cindex "Solaris" "DBM library for"
1706 .cindex "IRIX, DBM library for"
1707 .cindex "BSD, DBM library for"
1708 .cindex "Linux, DBM library for"
1709 If you are using Solaris, IRIX, one of the modern BSD systems, or a modern
1710 Linux distribution, the DBM configuration should happen automatically, and you
1711 may be able to ignore this section. Otherwise, you may have to learn more than
1712 you would like about DBM libraries from what follows.
1713
1714 .cindex "&'ndbm'& DBM library"
1715 Licensed versions of Unix normally contain a library of DBM functions operating
1716 via the &'ndbm'& interface, and this is what Exim expects by default. Free
1717 versions of Unix seem to vary in what they contain as standard. In particular,
1718 some early versions of Linux have no default DBM library, and different
1719 distributors have chosen to bundle different libraries with their packaged
1720 versions. However, the more recent releases seem to have standardized on the
1721 Berkeley DB library.
1722
1723 Different DBM libraries have different conventions for naming the files they
1724 use. When a program opens a file called &_dbmfile_&, there are several
1725 possibilities:
1726
1727 .olist
1728 A traditional &'ndbm'& implementation, such as that supplied as part of
1729 Solaris, operates on two files called &_dbmfile.dir_& and &_dbmfile.pag_&.
1730 .next
1731 .cindex "&'gdbm'& DBM library"
1732 The GNU library, &'gdbm'&, operates on a single file. If used via its &'ndbm'&
1733 compatibility interface it makes two different hard links to it with names
1734 &_dbmfile.dir_& and &_dbmfile.pag_&, but if used via its native interface, the
1735 file name is used unmodified.
1736 .next
1737 .cindex "Berkeley DB library"
1738 The Berkeley DB package, if called via its &'ndbm'& compatibility interface,
1739 operates on a single file called &_dbmfile.db_&, but otherwise looks to the
1740 programmer exactly the same as the traditional &'ndbm'& implementation.
1741 .next
1742 If the Berkeley package is used in its native mode, it operates on a single
1743 file called &_dbmfile_&; the programmer's interface is somewhat different to
1744 the traditional &'ndbm'& interface.
1745 .next
1746 To complicate things further, there are several very different versions of the
1747 Berkeley DB package. Version 1.85 was stable for a very long time, releases
1748 2.&'x'& and 3.&'x'& were current for a while, but the latest versions are now
1749 numbered 4.&'x'&. Maintenance of some of the earlier releases has ceased. All
1750 versions of Berkeley DB can be obtained from
1751 &url(http://www.sleepycat.com/).
1752 .next
1753 .cindex "&'tdb'& DBM library"
1754 Yet another DBM library, called &'tdb'&, is available from
1755 &url(http://download.sourceforge.net/tdb). It has its own interface, and also
1756 operates on a single file.
1757 .endlist
1758
1759 .cindex "USE_DB"
1760 .cindex "DBM libraries" "configuration for building"
1761 Exim and its utilities can be compiled to use any of these interfaces. In order
1762 to use any version of the Berkeley DB package in native mode, you must set
1763 USE_DB in an appropriate configuration file (typically
1764 &_Local/Makefile_&). For example:
1765 .code
1766 USE_DB=yes
1767 .endd
1768 Similarly, for gdbm you set USE_GDBM, and for tdb you set USE_TDB. An
1769 error is diagnosed if you set more than one of these.
1770
1771 At the lowest level, the build-time configuration sets none of these options,
1772 thereby assuming an interface of type (1). However, some operating system
1773 configuration files (for example, those for the BSD operating systems and
1774 Linux) assume type (4) by setting USE_DB as their default, and the
1775 configuration files for Cygwin set USE_GDBM. Anything you set in
1776 &_Local/Makefile_&, however, overrides these system defaults.
1777
1778 As well as setting USE_DB, USE_GDBM, or USE_TDB, it may also be
1779 necessary to set DBMLIB, to cause inclusion of the appropriate library, as
1780 in one of these lines:
1781 .code
1782 DBMLIB = -ldb
1783 DBMLIB = -ltdb
1784 .endd
1785 Settings like that will work if the DBM library is installed in the standard
1786 place. Sometimes it is not, and the library's header file may also not be in
1787 the default path. You may need to set INCLUDE to specify where the header
1788 file is, and to specify the path to the library more fully in DBMLIB, as in
1789 this example:
1790 .code
1791 INCLUDE=-I/usr/local/include/db-4.1
1792 DBMLIB=/usr/local/lib/db-4.1/libdb.a
1793 .endd
1794 There is further detailed discussion about the various DBM libraries in the
1795 file &_doc/dbm.discuss.txt_& in the Exim distribution.
1796
1797
1798
1799 .section "Pre-building configuration" "SECID25"
1800 .cindex "building Exim" "pre-building configuration"
1801 .cindex "configuration for building Exim"
1802 .cindex "&_Local/Makefile_&"
1803 .cindex "&_src/EDITME_&"
1804 Before building Exim, a local configuration file that specifies options
1805 independent of any operating system has to be created with the name
1806 &_Local/Makefile_&. A template for this file is supplied as the file
1807 &_src/EDITME_&, and it contains full descriptions of all the option settings
1808 therein. These descriptions are therefore not repeated here. If you are
1809 building Exim for the first time, the simplest thing to do is to copy
1810 &_src/EDITME_& to &_Local/Makefile_&, then read it and edit it appropriately.
1811
1812 There are three settings that you must supply, because Exim will not build
1813 without them. They are the location of the run time configuration file
1814 (CONFIGURE_FILE), the directory in which Exim binaries will be installed
1815 (BIN_DIRECTORY), and the identity of the Exim user (EXIM_USER and
1816 maybe EXIM_GROUP as well). The value of CONFIGURE_FILE can in fact be
1817 a colon-separated list of file names; Exim uses the first of them that exists.
1818
1819 There are a few other parameters that can be specified either at build time or
1820 at run time, to enable the same binary to be used on a number of different
1821 machines. However, if the locations of Exim's spool directory and log file
1822 directory (if not within the spool directory) are fixed, it is recommended that
1823 you specify them in &_Local/Makefile_& instead of at run time, so that errors
1824 detected early in Exim's execution (such as a malformed configuration file) can
1825 be logged.
1826
1827 .cindex "content scanning" "specifying at build time"
1828 Exim's interfaces for calling virus and spam scanning software directly from
1829 access control lists are not compiled by default. If you want to include these
1830 facilities, you need to set
1831 .code
1832 WITH_CONTENT_SCAN=yes
1833 .endd
1834 in your &_Local/Makefile_&. For details of the facilities themselves, see
1835 chapter &<<CHAPexiscan>>&.
1836
1837
1838 .cindex "&_Local/eximon.conf_&"
1839 .cindex "&_exim_monitor/EDITME_&"
1840 If you are going to build the Exim monitor, a similar configuration process is
1841 required. The file &_exim_monitor/EDITME_& must be edited appropriately for
1842 your installation and saved under the name &_Local/eximon.conf_&. If you are
1843 happy with the default settings described in &_exim_monitor/EDITME_&,
1844 &_Local/eximon.conf_& can be empty, but it must exist.
1845
1846 This is all the configuration that is needed in straightforward cases for known
1847 operating systems. However, the building process is set up so that it is easy
1848 to override options that are set by default or by operating-system-specific
1849 configuration files, for example to change the name of the C compiler, which
1850 defaults to &%gcc%&. See section &<<SECToverride>>& below for details of how to
1851 do this.
1852
1853
1854
1855 .section "Support for iconv()" "SECID26"
1856 .cindex "&[iconv()]& support"
1857 .cindex "RFC 2047"
1858 The contents of header lines in messages may be encoded according to the rules
1859 described RFC 2047. This makes it possible to transmit characters that are not
1860 in the ASCII character set, and to label them as being in a particular
1861 character set. When Exim is inspecting header lines by means of the &%$h_%&
1862 mechanism, it decodes them, and translates them into a specified character set
1863 (default is set at build time). The translation is possible only if the operating system
1864 supports the &[iconv()]& function.
1865
1866 However, some of the operating systems that supply &[iconv()]& do not support
1867 very many conversions. The GNU &%libiconv%& library (available from
1868 &url(http://www.gnu.org/software/libiconv/)) can be installed on such
1869 systems to remedy this deficiency, as well as on systems that do not supply
1870 &[iconv()]& at all. After installing &%libiconv%&, you should add
1871 .code
1872 HAVE_ICONV=yes
1873 .endd
1874 to your &_Local/Makefile_& and rebuild Exim.
1875
1876
1877
1878 .section "Including TLS/SSL encryption support" "SECTinctlsssl"
1879 .cindex "TLS" "including support for TLS"
1880 .cindex "encryption" "including support for"
1881 .cindex "SUPPORT_TLS"
1882 .cindex "OpenSSL" "building Exim with"
1883 .cindex "GnuTLS" "building Exim with"
1884 Exim can be built to support encrypted SMTP connections, using the STARTTLS
1885 command as per RFC 2487. It can also support legacy clients that expect to
1886 start a TLS session immediately on connection to a non-standard port (see the
1887 &%tls_on_connect_ports%& runtime option and the &%-tls-on-connect%& command
1888 line option).
1889
1890 If you want to build Exim with TLS support, you must first install either the
1891 OpenSSL or GnuTLS library. There is no cryptographic code in Exim itself for
1892 implementing SSL.
1893
1894 If OpenSSL is installed, you should set
1895 .code
1896 SUPPORT_TLS=yes
1897 TLS_LIBS=-lssl -lcrypto
1898 .endd
1899 in &_Local/Makefile_&. You may also need to specify the locations of the
1900 OpenSSL library and include files. For example:
1901 .code
1902 SUPPORT_TLS=yes
1903 TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
1904 TLS_INCLUDE=-I/usr/local/openssl/include/
1905 .endd
1906 .cindex "pkg-config" "OpenSSL"
1907 If you have &'pkg-config'& available, then instead you can just use:
1908 .code
1909 SUPPORT_TLS=yes
1910 USE_OPENSSL_PC=openssl
1911 .endd
1912 .cindex "USE_GNUTLS"
1913 If GnuTLS is installed, you should set
1914 .code
1915 SUPPORT_TLS=yes
1916 USE_GNUTLS=yes
1917 TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
1918 .endd
1919 in &_Local/Makefile_&, and again you may need to specify the locations of the
1920 library and include files. For example:
1921 .code
1922 SUPPORT_TLS=yes
1923 USE_GNUTLS=yes
1924 TLS_LIBS=-L/usr/gnu/lib -lgnutls -ltasn1 -lgcrypt
1925 TLS_INCLUDE=-I/usr/gnu/include
1926 .endd
1927 .cindex "pkg-config" "GnuTLS"
1928 If you have &'pkg-config'& available, then instead you can just use:
1929 .code
1930 SUPPORT_TLS=yes
1931 USE_GNUTLS=yes
1932 USE_GNUTLS_PC=gnutls
1933 .endd
1934
1935 You do not need to set TLS_INCLUDE if the relevant directory is already
1936 specified in INCLUDE. Details of how to configure Exim to make use of TLS are
1937 given in chapter &<<CHAPTLS>>&.
1938
1939
1940
1941
1942 .section "Use of tcpwrappers" "SECID27"
1943
1944 .cindex "tcpwrappers, building Exim to support"
1945 .cindex "USE_TCP_WRAPPERS"
1946 .cindex "TCP_WRAPPERS_DAEMON_NAME"
1947 .cindex "tcp_wrappers_daemon_name"
1948 Exim can be linked with the &'tcpwrappers'& library in order to check incoming
1949 SMTP calls using the &'tcpwrappers'& control files. This may be a convenient
1950 alternative to Exim's own checking facilities for installations that are
1951 already making use of &'tcpwrappers'& for other purposes. To do this, you
1952 should set USE_TCP_WRAPPERS in &_Local/Makefile_&, arrange for the file
1953 &_tcpd.h_& to be available at compile time, and also ensure that the library
1954 &_libwrap.a_& is available at link time, typically by including &%-lwrap%& in
1955 EXTRALIBS_EXIM. For example, if &'tcpwrappers'& is installed in &_/usr/local_&,
1956 you might have
1957 .code
1958 USE_TCP_WRAPPERS=yes
1959 CFLAGS=-O -I/usr/local/include
1960 EXTRALIBS_EXIM=-L/usr/local/lib -lwrap
1961 .endd
1962 in &_Local/Makefile_&. The daemon name to use in the &'tcpwrappers'& control
1963 files is &"exim"&. For example, the line
1964 .code
1965 exim : LOCAL  192.168.1.  .friendly.domain.example
1966 .endd
1967 in your &_/etc/hosts.allow_& file allows connections from the local host, from
1968 the subnet 192.168.1.0/24, and from all hosts in &'friendly.domain.example'&.
1969 All other connections are denied. The daemon name used by &'tcpwrappers'&
1970 can be changed at build time by setting TCP_WRAPPERS_DAEMON_NAME in
1971 &_Local/Makefile_&, or by setting tcp_wrappers_daemon_name in the
1972 configure file. Consult the &'tcpwrappers'& documentation for
1973 further details.
1974
1975
1976 .section "Including support for IPv6" "SECID28"
1977 .cindex "IPv6" "including support for"
1978 Exim contains code for use on systems that have IPv6 support. Setting
1979 &`HAVE_IPV6=YES`& in &_Local/Makefile_& causes the IPv6 code to be included;
1980 it may also be necessary to set IPV6_INCLUDE and IPV6_LIBS on systems
1981 where the IPv6 support is not fully integrated into the normal include and
1982 library files.
1983
1984 Two different types of DNS record for handling IPv6 addresses have been
1985 defined. AAAA records (analogous to A records for IPv4) are in use, and are
1986 currently seen as the mainstream. Another record type called A6 was proposed
1987 as better than AAAA because it had more flexibility. However, it was felt to be
1988 over-complex, and its status was reduced to &"experimental"&.
1989 Exim used to
1990 have a compile option for including A6 record support but this has now been
1991 withdrawn.
1992
1993
1994
1995 .section "Dynamically loaded lookup module support" "SECTdynamicmodules"
1996 .cindex "lookup modules"
1997 .cindex "dynamic modules"
1998 .cindex ".so building"
1999 On some platforms, Exim supports not compiling all lookup types directly into
2000 the main binary, instead putting some into external modules which can be loaded
2001 on demand.
2002 This permits packagers to build Exim with support for lookups with extensive
2003 library dependencies without requiring all users to install all of those
2004 dependencies.
2005 Most, but not all, lookup types can be built this way.
2006
2007 Set &`LOOKUP_MODULE_DIR`& to the directory into which the modules will be
2008 installed; Exim will only load modules from that directory, as a security
2009 measure.  You will need to set &`CFLAGS_DYNAMIC`& if not already defined
2010 for your OS; see &_OS/Makefile-Linux_& for an example.
2011 Some other requirements for adjusting &`EXTRALIBS`& may also be necessary,
2012 see &_src/EDITME_& for details.
2013
2014 Then, for each module to be loaded dynamically, define the relevant
2015 &`LOOKUP_`&<&'lookup_type'&> flags to have the value "2" instead of "yes".
2016 For example, this will build in lsearch but load sqlite and mysql support
2017 on demand:
2018 .code
2019 LOOKUP_LSEARCH=yes
2020 LOOKUP_SQLITE=2
2021 LOOKUP_MYSQL=2
2022 .endd
2023
2024
2025 .section "The building process" "SECID29"
2026 .cindex "build directory"
2027 Once &_Local/Makefile_& (and &_Local/eximon.conf_&, if required) have been
2028 created, run &'make'& at the top level. It determines the architecture and
2029 operating system types, and creates a build directory if one does not exist.
2030 For example, on a Sun system running Solaris 8, the directory
2031 &_build-SunOS5-5.8-sparc_& is created.
2032 .cindex "symbolic link" "to source files"
2033 Symbolic links to relevant source files are installed in the build directory.
2034
2035 If this is the first time &'make'& has been run, it calls a script that builds
2036 a make file inside the build directory, using the configuration files from the
2037 &_Local_& directory. The new make file is then passed to another instance of
2038 &'make'&. This does the real work, building a number of utility scripts, and
2039 then compiling and linking the binaries for the Exim monitor (if configured), a
2040 number of utility programs, and finally Exim itself. The command &`make
2041 makefile`& can be used to force a rebuild of the make file in the build
2042 directory, should this ever be necessary.
2043
2044 If you have problems building Exim, check for any comments there may be in the
2045 &_README_& file concerning your operating system, and also take a look at the
2046 FAQ, where some common problems are covered.
2047
2048
2049
2050 .section 'Output from &"make"&' "SECID283"
2051 The output produced by the &'make'& process for compile lines is often very
2052 unreadable, because these lines can be very long. For this reason, the normal
2053 output is suppressed by default, and instead output similar to that which
2054 appears when compiling the 2.6 Linux kernel is generated: just a short line for
2055 each module that is being compiled or linked. However, it is still possible to
2056 get the full output, by calling &'make'& like this:
2057 .code
2058 FULLECHO='' make -e
2059 .endd
2060 The value of FULLECHO defaults to &"@"&, the flag character that suppresses
2061 command reflection in &'make'&. When you ask for the full output, it is
2062 given in addition to the short output.
2063
2064
2065
2066 .section "Overriding build-time options for Exim" "SECToverride"
2067 .cindex "build-time options, overriding"
2068 The main make file that is created at the beginning of the building process
2069 consists of the concatenation of a number of files which set configuration
2070 values, followed by a fixed set of &'make'& instructions. If a value is set
2071 more than once, the last setting overrides any previous ones. This provides a
2072 convenient way of overriding defaults. The files that are concatenated are, in
2073 order:
2074 .display
2075 &_OS/Makefile-Default_&
2076 &_OS/Makefile-_&<&'ostype'&>
2077 &_Local/Makefile_&
2078 &_Local/Makefile-_&<&'ostype'&>
2079 &_Local/Makefile-_&<&'archtype'&>
2080 &_Local/Makefile-_&<&'ostype'&>-<&'archtype'&>
2081 &_OS/Makefile-Base_&
2082 .endd
2083 .cindex "&_Local/Makefile_&"
2084 .cindex "building Exim" "operating system type"
2085 .cindex "building Exim" "architecture type"
2086 where <&'ostype'&> is the operating system type and <&'archtype'&> is the
2087 architecture type. &_Local/Makefile_& is required to exist, and the building
2088 process fails if it is absent. The other three &_Local_& files are optional,
2089 and are often not needed.
2090
2091 The values used for <&'ostype'&> and <&'archtype'&> are obtained from scripts
2092 called &_scripts/os-type_& and &_scripts/arch-type_& respectively. If either of
2093 the environment variables EXIM_OSTYPE or EXIM_ARCHTYPE is set, their
2094 values are used, thereby providing a means of forcing particular settings.
2095 Otherwise, the scripts try to get values from the &%uname%& command. If this
2096 fails, the shell variables OSTYPE and ARCHTYPE are inspected. A number
2097 of &'ad hoc'& transformations are then applied, to produce the standard names
2098 that Exim expects. You can run these scripts directly from the shell in order
2099 to find out what values are being used on your system.
2100
2101
2102 &_OS/Makefile-Default_& contains comments about the variables that are set
2103 therein. Some (but not all) are mentioned below. If there is something that
2104 needs changing, review the contents of this file and the contents of the make
2105 file for your operating system (&_OS/Makefile-<ostype>_&) to see what the
2106 default values are.
2107
2108
2109 .cindex "building Exim" "overriding default settings"
2110 If you need to change any of the values that are set in &_OS/Makefile-Default_&
2111 or in &_OS/Makefile-<ostype>_&, or to add any new definitions, you do not
2112 need to change the original files. Instead, you should make the changes by
2113 putting the new values in an appropriate &_Local_& file. For example,
2114 .cindex "Tru64-Unix build-time settings"
2115 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2116 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2117 compiler is called &'cc'& rather than &'gcc'&. Also, the compiler must be
2118 called with the option &%-std1%&, to make it recognize some of the features of
2119 Standard C that Exim uses. (Most other compilers recognize Standard C by
2120 default.) To do this, you should create a file called &_Local/Makefile-OSF1_&
2121 containing the lines
2122 .code
2123 CC=cc
2124 CFLAGS=-std1
2125 .endd
2126 If you are compiling for just one operating system, it may be easier to put
2127 these lines directly into &_Local/Makefile_&.
2128
2129 Keeping all your local configuration settings separate from the distributed
2130 files makes it easy to transfer them to new versions of Exim simply by copying
2131 the contents of the &_Local_& directory.
2132
2133
2134 .cindex "NIS lookup type" "including support for"
2135 .cindex "NIS+ lookup type" "including support for"
2136 .cindex "LDAP" "including support for"
2137 .cindex "lookup" "inclusion in binary"
2138 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2139 lookup, but not all systems have these components installed, so the default is
2140 not to include the relevant code in the binary. All the different kinds of file
2141 and database lookup that Exim supports are implemented as separate code modules
2142 which are included only if the relevant compile-time options are set. In the
2143 case of LDAP, NIS, and NIS+, the settings for &_Local/Makefile_& are:
2144 .code
2145 LOOKUP_LDAP=yes
2146 LOOKUP_NIS=yes
2147 LOOKUP_NISPLUS=yes
2148 .endd
2149 and similar settings apply to the other lookup types. They are all listed in
2150 &_src/EDITME_&. In many cases the relevant include files and interface
2151 libraries need to be installed before compiling Exim.
2152 .cindex "cdb" "including support for"
2153 However, there are some optional lookup types (such as cdb) for which
2154 the code is entirely contained within Exim, and no external include
2155 files or libraries are required. When a lookup type is not included in the
2156 binary, attempts to configure Exim to use it cause run time configuration
2157 errors.
2158
2159 .cindex "pkg-config" "lookups"
2160 .cindex "pkg-config" "authenticators"
2161 Many systems now use a tool called &'pkg-config'& to encapsulate information
2162 about how to compile against a library; Exim has some initial support for
2163 being able to use pkg-config for lookups and authenticators.  For any given
2164 makefile variable which starts &`LOOKUP_`& or &`AUTH_`&, you can add a new
2165 variable with the &`_PC`& suffix in the name and assign as the value the
2166 name of the package to be queried.  The results of querying via the
2167 &'pkg-config'& command will be added to the appropriate Makefile variables
2168 with &`+=`& directives, so your version of &'make'& will need to support that
2169 syntax.  For instance:
2170 .code
2171 LOOKUP_SQLITE=yes
2172 LOOKUP_SQLITE_PC=sqlite3
2173 AUTH_GSASL=yes
2174 AUTH_GSASL_PC=libgsasl
2175 AUTH_HEIMDAL_GSSAPI=yes
2176 AUTH_HEIMDAL_GSSAPI_PC=heimdal-gssapi
2177 .endd
2178
2179 .cindex "Perl" "including support for"
2180 Exim can be linked with an embedded Perl interpreter, allowing Perl
2181 subroutines to be called during string expansion. To enable this facility,
2182 .code
2183 EXIM_PERL=perl.o
2184 .endd
2185 must be defined in &_Local/Makefile_&. Details of this facility are given in
2186 chapter &<<CHAPperl>>&.
2187
2188 .cindex "X11 libraries, location of"
2189 The location of the X11 libraries is something that varies a lot between
2190 operating systems, and there may be different versions of X11 to cope
2191 with. Exim itself makes no use of X11, but if you are compiling the Exim
2192 monitor, the X11 libraries must be available.
2193 The following three variables are set in &_OS/Makefile-Default_&:
2194 .code
2195 X11=/usr/X11R6
2196 XINCLUDE=-I$(X11)/include
2197 XLFLAGS=-L$(X11)/lib
2198 .endd
2199 These are overridden in some of the operating-system configuration files. For
2200 example, in &_OS/Makefile-SunOS5_& there is
2201 .code
2202 X11=/usr/openwin
2203 XINCLUDE=-I$(X11)/include
2204 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2205 .endd
2206 If you need to override the default setting for your operating system, place a
2207 definition of all three of these variables into your
2208 &_Local/Makefile-<ostype>_& file.
2209
2210 .cindex "EXTRALIBS"
2211 If you need to add any extra libraries to the link steps, these can be put in a
2212 variable called EXTRALIBS, which appears in all the link commands, but by
2213 default is not defined. In contrast, EXTRALIBS_EXIM is used only on the
2214 command for linking the main Exim binary, and not for any associated utilities.
2215
2216 .cindex "DBM libraries" "configuration for building"
2217 There is also DBMLIB, which appears in the link commands for binaries that
2218 use DBM functions (see also section &<<SECTdb>>&). Finally, there is
2219 EXTRALIBS_EXIMON, which appears only in the link step for the Exim monitor
2220 binary, and which can be used, for example, to include additional X11
2221 libraries.
2222
2223 .cindex "configuration file" "editing"
2224 The make file copes with rebuilding Exim correctly if any of the configuration
2225 files are edited. However, if an optional configuration file is deleted, it is
2226 necessary to touch the associated non-optional file (that is,
2227 &_Local/Makefile_& or &_Local/eximon.conf_&) before rebuilding.
2228
2229
2230 .section "OS-specific header files" "SECID30"
2231 .cindex "&_os.h_&"
2232 .cindex "building Exim" "OS-specific C header files"
2233 The &_OS_& directory contains a number of files with names of the form
2234 &_os.h-<ostype>_&. These are system-specific C header files that should not
2235 normally need to be changed. There is a list of macro settings that are
2236 recognized in the file &_OS/os.configuring_&, which should be consulted if you
2237 are porting Exim to a new operating system.
2238
2239
2240
2241 .section "Overriding build-time options for the monitor" "SECID31"
2242 .cindex "building Eximon"
2243 A similar process is used for overriding things when building the Exim monitor,
2244 where the files that are involved are
2245 .display
2246 &_OS/eximon.conf-Default_&
2247 &_OS/eximon.conf-_&<&'ostype'&>
2248 &_Local/eximon.conf_&
2249 &_Local/eximon.conf-_&<&'ostype'&>
2250 &_Local/eximon.conf-_&<&'archtype'&>
2251 &_Local/eximon.conf-_&<&'ostype'&>-<&'archtype'&>
2252 .endd
2253 .cindex "&_Local/eximon.conf_&"
2254 As with Exim itself, the final three files need not exist, and in this case the
2255 &_OS/eximon.conf-<ostype>_& file is also optional. The default values in
2256 &_OS/eximon.conf-Default_& can be overridden dynamically by setting environment
2257 variables of the same name, preceded by EXIMON_. For example, setting
2258 EXIMON_LOG_DEPTH in the environment overrides the value of
2259 LOG_DEPTH at run time.
2260 .ecindex IIDbuex
2261
2262
2263 .section "Installing Exim binaries and scripts" "SECID32"
2264 .cindex "installing Exim"
2265 .cindex "BIN_DIRECTORY"
2266 The command &`make install`& runs the &(exim_install)& script with no
2267 arguments. The script copies binaries and utility scripts into the directory
2268 whose name is specified by the BIN_DIRECTORY setting in &_Local/Makefile_&.
2269 .cindex "setuid" "installing Exim with"
2270 The install script copies files only if they are newer than the files they are
2271 going to replace. The Exim binary is required to be owned by root and have the
2272 &'setuid'& bit set, for normal configurations. Therefore, you must run &`make
2273 install`& as root so that it can set up the Exim binary in this way. However, in
2274 some special situations (for example, if a host is doing no local deliveries)
2275 it may be possible to run Exim without making the binary setuid root (see
2276 chapter &<<CHAPsecurity>>& for details).
2277
2278 .cindex "CONFIGURE_FILE"
2279 Exim's run time configuration file is named by the CONFIGURE_FILE setting
2280 in &_Local/Makefile_&. If this names a single file, and the file does not
2281 exist, the default configuration file &_src/configure.default_& is copied there
2282 by the installation script. If a run time configuration file already exists, it
2283 is left alone. If CONFIGURE_FILE is a colon-separated list, naming several
2284 alternative files, no default is installed.
2285
2286 .cindex "system aliases file"
2287 .cindex "&_/etc/aliases_&"
2288 One change is made to the default configuration file when it is installed: the
2289 default configuration contains a router that references a system aliases file.
2290 The path to this file is set to the value specified by
2291 SYSTEM_ALIASES_FILE in &_Local/Makefile_& (&_/etc/aliases_& by default).
2292 If the system aliases file does not exist, the installation script creates it,
2293 and outputs a comment to the user.
2294
2295 The created file contains no aliases, but it does contain comments about the
2296 aliases a site should normally have. Mail aliases have traditionally been
2297 kept in &_/etc/aliases_&. However, some operating systems are now using
2298 &_/etc/mail/aliases_&. You should check if yours is one of these, and change
2299 Exim's configuration if necessary.
2300
2301 The default configuration uses the local host's name as the only local domain,
2302 and is set up to do local deliveries into the shared directory &_/var/mail_&,
2303 running as the local user. System aliases and &_.forward_& files in users' home
2304 directories are supported, but no NIS or NIS+ support is configured. Domains
2305 other than the name of the local host are routed using the DNS, with delivery
2306 over SMTP.
2307
2308 It is possible to install Exim for special purposes (such as building a binary
2309 distribution) in a private part of the file system. You can do this by a
2310 command such as
2311 .code
2312 make DESTDIR=/some/directory/ install
2313 .endd
2314 This has the effect of pre-pending the specified directory to all the file
2315 paths, except the name of the system aliases file that appears in the default
2316 configuration. (If a default alias file is created, its name &'is'& modified.)
2317 For backwards compatibility, ROOT is used if DESTDIR is not set,
2318 but this usage is deprecated.
2319
2320 .cindex "installing Exim" "what is not installed"
2321 Running &'make install'& does not copy the Exim 4 conversion script
2322 &'convert4r4'&. You will probably run this only once if you are
2323 upgrading from Exim 3. None of the documentation files in the &_doc_&
2324 directory are copied, except for the info files when you have set
2325 INFO_DIRECTORY, as described in section &<<SECTinsinfdoc>>& below.
2326
2327 For the utility programs, old versions are renamed by adding the suffix &_.O_&
2328 to their names. The Exim binary itself, however, is handled differently. It is
2329 installed under a name that includes the version number and the compile number,
2330 for example &_exim-&version()-1_&. The script then arranges for a symbolic link
2331 called &_exim_& to point to the binary. If you are updating a previous version
2332 of Exim, the script takes care to ensure that the name &_exim_& is never absent
2333 from the directory (as seen by other processes).
2334
2335 .cindex "installing Exim" "testing the script"
2336 If you want to see what the &'make install'& will do before running it for
2337 real, you can pass the &%-n%& option to the installation script by this
2338 command:
2339 .code
2340 make INSTALL_ARG=-n install
2341 .endd
2342 The contents of the variable INSTALL_ARG are passed to the installation
2343 script. You do not need to be root to run this test. Alternatively, you can run
2344 the installation script directly, but this must be from within the build
2345 directory. For example, from the top-level Exim directory you could use this
2346 command:
2347 .code
2348 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
2349 .endd
2350 .cindex "installing Exim" "install script options"
2351 There are two other options that can be supplied to the installation script.
2352
2353 .ilist
2354 &%-no_chown%& bypasses the call to change the owner of the installed binary
2355 to root, and the call to make it a setuid binary.
2356 .next
2357 &%-no_symlink%& bypasses the setting up of the symbolic link &_exim_& to the
2358 installed binary.
2359 .endlist
2360
2361 INSTALL_ARG can be used to pass these options to the script. For example:
2362 .code
2363 make INSTALL_ARG=-no_symlink install
2364 .endd
2365 The installation script can also be given arguments specifying which files are
2366 to be copied. For example, to install just the Exim binary, and nothing else,
2367 without creating the symbolic link, you could use:
2368 .code
2369 make INSTALL_ARG='-no_symlink exim' install
2370 .endd
2371
2372
2373
2374 .section "Installing info documentation" "SECTinsinfdoc"
2375 .cindex "installing Exim" "&'info'& documentation"
2376 Not all systems use the GNU &'info'& system for documentation, and for this
2377 reason, the Texinfo source of Exim's documentation is not included in the main
2378 distribution. Instead it is available separately from the ftp site (see section
2379 &<<SECTavail>>&).
2380
2381 If you have defined INFO_DIRECTORY in &_Local/Makefile_& and the Texinfo
2382 source of the documentation is found in the source tree, running &`make
2383 install`& automatically builds the info files and installs them.
2384
2385
2386
2387 .section "Setting up the spool directory" "SECID33"
2388 .cindex "spool directory" "creating"
2389 When it starts up, Exim tries to create its spool directory if it does not
2390 exist. The Exim uid and gid are used for the owner and group of the spool
2391 directory. Sub-directories are automatically created in the spool directory as
2392 necessary.
2393
2394
2395
2396
2397 .section "Testing" "SECID34"
2398 .cindex "testing" "installation"
2399 Having installed Exim, you can check that the run time configuration file is
2400 syntactically valid by running the following command, which assumes that the
2401 Exim binary directory is within your PATH environment variable:
2402 .code
2403 exim -bV
2404 .endd
2405 If there are any errors in the configuration file, Exim outputs error messages.
2406 Otherwise it outputs the version number and build date,
2407 the DBM library that is being used, and information about which drivers and
2408 other optional code modules are included in the binary.
2409 Some simple routing tests can be done by using the address testing option. For
2410 example,
2411 .display
2412 &`exim -bt`& <&'local username'&>
2413 .endd
2414 should verify that it recognizes a local mailbox, and
2415 .display
2416 &`exim -bt`& <&'remote address'&>
2417 .endd
2418 a remote one. Then try getting it to deliver mail, both locally and remotely.
2419 This can be done by passing messages directly to Exim, without going through a
2420 user agent. For example:
2421 .code
2422 exim -v postmaster@your.domain.example
2423 From: user@your.domain.example
2424 To: postmaster@your.domain.example
2425 Subject: Testing Exim
2426
2427 This is a test message.
2428 ^D
2429 .endd
2430 The &%-v%& option causes Exim to output some verification of what it is doing.
2431 In this case you should see copies of three log lines, one for the message's
2432 arrival, one for its delivery, and one containing &"Completed"&.
2433
2434 .cindex "delivery" "problems with"
2435 If you encounter problems, look at Exim's log files (&'mainlog'& and
2436 &'paniclog'&) to see if there is any relevant information there. Another source
2437 of information is running Exim with debugging turned on, by specifying the
2438 &%-d%& option. If a message is stuck on Exim's spool, you can force a delivery
2439 with debugging turned on by a command of the form
2440 .display
2441 &`exim -d -M`& <&'exim-message-id'&>
2442 .endd
2443 You must be root or an &"admin user"& in order to do this. The &%-d%& option
2444 produces rather a lot of output, but you can cut this down to specific areas.
2445 For example, if you use &%-d-all+route%& only the debugging information
2446 relevant to routing is included. (See the &%-d%& option in chapter
2447 &<<CHAPcommandline>>& for more details.)
2448
2449 .cindex '&"sticky"& bit'
2450 .cindex "lock files"
2451 One specific problem that has shown up on some sites is the inability to do
2452 local deliveries into a shared mailbox directory, because it does not have the
2453 &"sticky bit"& set on it. By default, Exim tries to create a lock file before
2454 writing to a mailbox file, and if it cannot create the lock file, the delivery
2455 is deferred. You can get round this either by setting the &"sticky bit"& on the
2456 directory, or by setting a specific group for local deliveries and allowing
2457 that group to create files in the directory (see the comments above the
2458 &(local_delivery)& transport in the default configuration file). Another
2459 approach is to configure Exim not to use lock files, but just to rely on
2460 &[fcntl()]& locking instead. However, you should do this only if all user
2461 agents also use &[fcntl()]& locking. For further discussion of locking issues,
2462 see chapter &<<CHAPappendfile>>&.
2463
2464 One thing that cannot be tested on a system that is already running an MTA is
2465 the receipt of incoming SMTP mail on the standard SMTP port. However, the
2466 &%-oX%& option can be used to run an Exim daemon that listens on some other
2467 port, or &'inetd'& can be used to do this. The &%-bh%& option and the
2468 &'exim_checkaccess'& utility can be used to check out policy controls on
2469 incoming SMTP mail.
2470
2471 Testing a new version on a system that is already running Exim can most easily
2472 be done by building a binary with a different CONFIGURE_FILE setting. From
2473 within the run time configuration, all other file and directory names
2474 that Exim uses can be altered, in order to keep it entirely clear of the
2475 production version.
2476
2477
2478 .section "Replacing another MTA with Exim" "SECID35"
2479 .cindex "replacing another MTA"
2480 Building and installing Exim for the first time does not of itself put it in
2481 general use. The name by which the system's MTA is called by mail user agents
2482 is either &_/usr/sbin/sendmail_&, or &_/usr/lib/sendmail_& (depending on the
2483 operating system), and it is necessary to make this name point to the &'exim'&
2484 binary in order to get the user agents to pass messages to Exim. This is
2485 normally done by renaming any existing file and making &_/usr/sbin/sendmail_&
2486 or &_/usr/lib/sendmail_&
2487 .cindex "symbolic link" "to &'exim'& binary"
2488 a symbolic link to the &'exim'& binary. It is a good idea to remove any setuid
2489 privilege and executable status from the old MTA. It is then necessary to stop
2490 and restart the mailer daemon, if one is running.
2491
2492 .cindex "FreeBSD, MTA indirection"
2493 .cindex "&_/etc/mail/mailer.conf_&"
2494 Some operating systems have introduced alternative ways of switching MTAs. For
2495 example, if you are running FreeBSD, you need to edit the file
2496 &_/etc/mail/mailer.conf_& instead of setting up a symbolic link as just
2497 described. A typical example of the contents of this file for running Exim is
2498 as follows:
2499 .code
2500 sendmail            /usr/exim/bin/exim
2501 send-mail           /usr/exim/bin/exim
2502 mailq               /usr/exim/bin/exim -bp
2503 newaliases          /usr/bin/true
2504 .endd
2505 Once you have set up the symbolic link, or edited &_/etc/mail/mailer.conf_&,
2506 your Exim installation is &"live"&. Check it by sending a message from your
2507 favourite user agent.
2508
2509 You should consider what to tell your users about the change of MTA. Exim may
2510 have different capabilities to what was previously running, and there are
2511 various operational differences such as the text of messages produced by
2512 command line options and in bounce messages. If you allow your users to make
2513 use of Exim's filtering capabilities, you should make the document entitled
2514 &'Exim's interface to mail filtering'& available to them.
2515
2516
2517
2518 .section "Upgrading Exim" "SECID36"
2519 .cindex "upgrading Exim"
2520 If you are already running Exim on your host, building and installing a new
2521 version automatically makes it available to MUAs, or any other programs that
2522 call the MTA directly. However, if you are running an Exim daemon, you do need
2523 to send it a HUP signal, to make it re-execute itself, and thereby pick up the
2524 new binary. You do not need to stop processing mail in order to install a new
2525 version of Exim. The install script does not modify an existing runtime
2526 configuration file.
2527
2528
2529
2530
2531 .section "Stopping the Exim daemon on Solaris" "SECID37"
2532 .cindex "Solaris" "stopping Exim on"
2533 The standard command for stopping the mailer daemon on Solaris is
2534 .code
2535 /etc/init.d/sendmail stop
2536 .endd
2537 If &_/usr/lib/sendmail_& has been turned into a symbolic link, this script
2538 fails to stop Exim because it uses the command &'ps -e'& and greps the output
2539 for the text &"sendmail"&; this is not present because the actual program name
2540 (that is, &"exim"&) is given by the &'ps'& command with these options. A
2541 solution is to replace the line that finds the process id with something like
2542 .code
2543 pid=`cat /var/spool/exim/exim-daemon.pid`
2544 .endd
2545 to obtain the daemon's pid directly from the file that Exim saves it in.
2546
2547 Note, however, that stopping the daemon does not &"stop Exim"&. Messages can
2548 still be received from local processes, and if automatic delivery is configured
2549 (the normal case), deliveries will still occur.
2550
2551
2552
2553
2554 . ////////////////////////////////////////////////////////////////////////////
2555 . ////////////////////////////////////////////////////////////////////////////
2556
2557 .chapter "The Exim command line" "CHAPcommandline"
2558 .scindex IIDclo1 "command line" "options"
2559 .scindex IIDclo2 "options" "command line"
2560 Exim's command line takes the standard Unix form of a sequence of options,
2561 each starting with a hyphen character, followed by a number of arguments. The
2562 options are compatible with the main options of Sendmail, and there are also
2563 some additional options, some of which are compatible with Smail 3. Certain
2564 combinations of options do not make sense, and provoke an error if used.
2565 The form of the arguments depends on which options are set.
2566
2567
2568 .section "Setting options by program name" "SECID38"
2569 .cindex "&'mailq'&"
2570 If Exim is called under the name &'mailq'&, it behaves as if the option &%-bp%&
2571 were present before any other options.
2572 The &%-bp%& option requests a listing of the contents of the mail queue on the
2573 standard output.
2574 This feature is for compatibility with some systems that contain a command of
2575 that name in one of the standard libraries, symbolically linked to
2576 &_/usr/sbin/sendmail_& or &_/usr/lib/sendmail_&.
2577
2578 .cindex "&'rsmtp'&"
2579 If Exim is called under the name &'rsmtp'& it behaves as if the option &%-bS%&
2580 were present before any other options, for compatibility with Smail. The
2581 &%-bS%& option is used for reading in a number of messages in batched SMTP
2582 format.
2583
2584 .cindex "&'rmail'&"
2585 If Exim is called under the name &'rmail'& it behaves as if the &%-i%& and
2586 &%-oee%& options were present before any other options, for compatibility with
2587 Smail. The name &'rmail'& is used as an interface by some UUCP systems.
2588
2589 .cindex "&'runq'&"
2590 .cindex "queue runner"
2591 If Exim is called under the name &'runq'& it behaves as if the option &%-q%&
2592 were present before any other options, for compatibility with Smail. The &%-q%&
2593 option causes a single queue runner process to be started.
2594
2595 .cindex "&'newaliases'&"
2596 .cindex "alias file" "building"
2597 .cindex "Sendmail compatibility" "calling Exim as &'newaliases'&"
2598 If Exim is called under the name &'newaliases'& it behaves as if the option
2599 &%-bi%& were present before any other options, for compatibility with Sendmail.
2600 This option is used for rebuilding Sendmail's alias file. Exim does not have
2601 the concept of a single alias file, but can be configured to run a given
2602 command if called with the &%-bi%& option.
2603
2604
2605 .section "Trusted and admin users" "SECTtrustedadmin"
2606 Some Exim options are available only to &'trusted users'& and others are
2607 available only to &'admin users'&. In the description below, the phrases &"Exim
2608 user"& and &"Exim group"& mean the user and group defined by EXIM_USER and
2609 EXIM_GROUP in &_Local/Makefile_& or set by the &%exim_user%& and
2610 &%exim_group%& options. These do not necessarily have to use the name &"exim"&.
2611
2612 .ilist
2613 .cindex "trusted users" "definition of"
2614 .cindex "user" "trusted definition of"
2615 The trusted users are root, the Exim user, any user listed in the
2616 &%trusted_users%& configuration option, and any user whose current group or any
2617 supplementary group is one of those listed in the &%trusted_groups%&
2618 configuration option. Note that the Exim group is not automatically trusted.
2619
2620 .cindex '&"From"& line'
2621 .cindex "envelope sender"
2622 Trusted users are always permitted to use the &%-f%& option or a leading
2623 &"From&~"& line to specify the envelope sender of a message that is passed to
2624 Exim through the local interface (see the &%-bm%& and &%-f%& options below).
2625 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
2626 users to set envelope senders.
2627
2628 .cindex "&'From:'& header line"
2629 .cindex "&'Sender:'& header line"
2630 For a trusted user, there is never any check on the contents of the &'From:'&
2631 header line, and a &'Sender:'& line is never added. Furthermore, any existing
2632 &'Sender:'& line in incoming local (non-TCP/IP) messages is not removed.
2633
2634 Trusted users may also specify a host name, host address, interface address,
2635 protocol name, ident value, and authentication data when submitting a message
2636 locally. Thus, they are able to insert messages into Exim's queue locally that
2637 have the characteristics of messages received from a remote host. Untrusted
2638 users may in some circumstances use &%-f%&, but can never set the other values
2639 that are available to trusted users.
2640 .next
2641 .cindex "user" "admin definition of"
2642 .cindex "admin user" "definition of"
2643 The admin users are root, the Exim user, and any user that is a member of the
2644 Exim group or of any group listed in the &%admin_groups%& configuration option.
2645 The current group does not have to be one of these groups.
2646
2647 Admin users are permitted to list the queue, and to carry out certain
2648 operations on messages, for example, to force delivery failures. It is also
2649 necessary to be an admin user in order to see the full information provided by
2650 the Exim monitor, and full debugging output.
2651
2652 By default, the use of the &%-M%&, &%-q%&, &%-R%&, and &%-S%& options to cause
2653 Exim to attempt delivery of messages on its queue is restricted to admin users.
2654 However, this restriction can be relaxed by setting the &%prod_requires_admin%&
2655 option false (that is, specifying &%no_prod_requires_admin%&).
2656
2657 Similarly, the use of the &%-bp%& option to list all the messages in the queue
2658 is restricted to admin users unless &%queue_list_requires_admin%& is set
2659 false.
2660 .endlist
2661
2662
2663 &*Warning*&: If you configure your system so that admin users are able to
2664 edit Exim's configuration file, you are giving those users an easy way of
2665 getting root. There is further discussion of this issue at the start of chapter
2666 &<<CHAPconf>>&.
2667
2668
2669
2670
2671 .section "Command line options" "SECID39"
2672 Exim's command line options are described in alphabetical order below. If none
2673 of the options that specifies a specific action (such as starting the daemon or
2674 a queue runner, or testing an address, or receiving a message in a specific
2675 format, or listing the queue) are present, and there is at least one argument
2676 on the command line, &%-bm%& (accept a local message on the standard input,
2677 with the arguments specifying the recipients) is assumed. Otherwise, Exim
2678 outputs a brief message about itself and exits.
2679
2680 . ////////////////////////////////////////////////////////////////////////////
2681 . Insert a stylized XML comment here, to identify the start of the command line
2682 . options. This is for the benefit of the Perl script that automatically
2683 . creates a man page for the options.
2684 . ////////////////////////////////////////////////////////////////////////////
2685
2686 .literal xml
2687 <!-- === Start of command line options === -->
2688 .literal off
2689
2690
2691 .vlist
2692 .vitem &%--%&
2693 .oindex "--"
2694 .cindex "options" "command line; terminating"
2695 This is a pseudo-option whose only purpose is to terminate the options and
2696 therefore to cause subsequent command line items to be treated as arguments
2697 rather than options, even if they begin with hyphens.
2698
2699 .vitem &%--help%&
2700 .oindex "&%--help%&"
2701 This option causes Exim to output a few sentences stating what it is.
2702 The same output is generated if the Exim binary is called with no options and
2703 no arguments.
2704
2705 .vitem &%--version%&
2706 .oindex "&%--version%&"
2707 This option is an alias for &%-bV%& and causes version information to be
2708 displayed.
2709
2710 .vitem &%-Ac%& &&&
2711        &%-Am%&
2712 .oindex "&%-Ac%&"
2713 .oindex "&%-Am%&"
2714 These options are used by Sendmail for selecting configuration files and are
2715 ignored by Exim.
2716
2717 .vitem &%-B%&<&'type'&>
2718 .oindex "&%-B%&"
2719 .cindex "8-bit characters"
2720 .cindex "Sendmail compatibility" "8-bit characters"
2721 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2722 clean; it ignores this option.
2723
2724 .vitem &%-bd%&
2725 .oindex "&%-bd%&"
2726 .cindex "daemon"
2727 .cindex "SMTP" "listener"
2728 .cindex "queue runner"
2729 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2730 the &%-bd%& option is combined with the &%-q%&<&'time'&> option, to specify
2731 that the daemon should also initiate periodic queue runs.
2732
2733 The &%-bd%& option can be used only by an admin user. If either of the &%-d%&
2734 (debugging) or &%-v%& (verifying) options are set, the daemon does not
2735 disconnect from the controlling terminal. When running this way, it can be
2736 stopped by pressing ctrl-C.
2737
2738 By default, Exim listens for incoming connections to the standard SMTP port on
2739 all the host's running interfaces. However, it is possible to listen on other
2740 ports, on multiple ports, and only on specific interfaces. Chapter
2741 &<<CHAPinterfaces>>& contains a description of the options that control this.
2742
2743 When a listening daemon
2744 .cindex "daemon" "process id (pid)"
2745 .cindex "pid (process id)" "of daemon"
2746 is started without the use of &%-oX%& (that is, without overriding the normal
2747 configuration), it writes its process id to a file called &_exim-daemon.pid_&
2748 in Exim's spool directory. This location can be overridden by setting
2749 PID_FILE_PATH in &_Local/Makefile_&. The file is written while Exim is still
2750 running as root.
2751
2752 When &%-oX%& is used on the command line to start a listening daemon, the
2753 process id is not written to the normal pid file path. However, &%-oP%& can be
2754 used to specify a path on the command line if a pid file is required.
2755
2756 The SIGHUP signal
2757 .cindex "SIGHUP"
2758 .cindex "daemon" "restarting"
2759 can be used to cause the daemon to re-execute itself. This should be done
2760 whenever Exim's configuration file, or any file that is incorporated into it by
2761 means of the &%.include%& facility, is changed, and also whenever a new version
2762 of Exim is installed. It is not necessary to do this when other files that are
2763 referenced from the configuration (for example, alias files) are changed,
2764 because these are reread each time they are used.
2765
2766 .vitem &%-bdf%&
2767 .oindex "&%-bdf%&"
2768 This option has the same effect as &%-bd%& except that it never disconnects
2769 from the controlling terminal, even when no debugging is specified.
2770
2771 .vitem &%-be%&
2772 .oindex "&%-be%&"
2773 .cindex "testing" "string expansion"
2774 .cindex "expansion" "testing"
2775 Run Exim in expansion testing mode. Exim discards its root privilege, to
2776 prevent ordinary users from using this mode to read otherwise inaccessible
2777 files. If no arguments are given, Exim runs interactively, prompting for lines
2778 of data. Otherwise, it processes each argument in turn.
2779
2780 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2781 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2782 used without command line arguments. If successful, it uses the &[readline()]&
2783 function, which provides extensive line-editing facilities, for reading the
2784 test data. A line history is supported.
2785
2786 Long expansion expressions can be split over several lines by using backslash
2787 continuations. As in Exim's run time configuration, white space at the start of
2788 continuation lines is ignored. Each argument or data line is passed through the
2789 string expansion mechanism, and the result is output. Variable values from the
2790 configuration file (for example, &$qualify_domain$&) are available, but no
2791 message-specific values (such as &$sender_domain$&) are set, because no message
2792 is being processed (but see &%-bem%& and &%-Mset%&).
2793
2794 &*Note*&: If you use this mechanism to test lookups, and you change the data
2795 files or databases you are using, you must exit and restart Exim before trying
2796 the same lookup again. Otherwise, because each Exim process caches the results
2797 of lookups, you will just get the same result as before.
2798
2799 .vitem &%-bem%&&~<&'filename'&>
2800 .oindex "&%-bem%&"
2801 .cindex "testing" "string expansion"
2802 .cindex "expansion" "testing"
2803 This option operates like &%-be%& except that it must be followed by the name
2804 of a file. For example:
2805 .code
2806 exim -bem /tmp/testmessage
2807 .endd
2808 The file is read as a message (as if receiving a locally-submitted non-SMTP
2809 message) before any of the test expansions are done. Thus, message-specific
2810 variables such as &$message_size$& and &$header_from:$& are available. However,
2811 no &'Received:'& header is added to the message. If the &%-t%& option is set,
2812 recipients are read from the headers in the normal way, and are shown in the
2813 &$recipients$& variable. Note that recipients cannot be given on the command
2814 line, because further arguments are taken as strings to expand (just like
2815 &%-be%&).
2816
2817 .vitem &%-bF%&&~<&'filename'&>
2818 .oindex "&%-bF%&"
2819 .cindex "system filter" "testing"
2820 .cindex "testing" "system filter"
2821 This option is the same as &%-bf%& except that it assumes that the filter being
2822 tested is a system filter. The additional commands that are available only in
2823 system filters are recognized.
2824
2825 .vitem &%-bf%&&~<&'filename'&>
2826 .oindex "&%-bf%&"
2827 .cindex "filter" "testing"
2828 .cindex "testing" "filter file"
2829 .cindex "forward file" "testing"
2830 .cindex "testing" "forward file"
2831 .cindex "Sieve filter" "testing"
2832 This option runs Exim in user filter testing mode; the file is the filter file
2833 to be tested, and a test message must be supplied on the standard input. If
2834 there are no message-dependent tests in the filter, an empty file can be
2835 supplied.
2836
2837 If you want to test a system filter file, use &%-bF%& instead of &%-bf%&. You
2838 can use both &%-bF%& and &%-bf%& on the same command, in order to test a system
2839 filter and a user filter in the same run. For example:
2840 .code
2841 exim -bF /system/filter -bf /user/filter </test/message
2842 .endd
2843 This is helpful when the system filter adds header lines or sets filter
2844 variables that are used by the user filter.
2845
2846 If the test filter file does not begin with one of the special lines
2847 .code
2848 # Exim filter
2849 # Sieve filter
2850 .endd
2851 it is taken to be a normal &_.forward_& file, and is tested for validity under
2852 that interpretation. See sections &<<SECTitenonfilred>>& to
2853 &<<SECTspecitredli>>& for a description of the possible contents of non-filter
2854 redirection lists.
2855
2856 The result of an Exim command that uses &%-bf%&, provided no errors are
2857 detected, is a list of the actions that Exim would try to take if presented
2858 with the message for real. More details of filter testing are given in the
2859 separate document entitled &'Exim's interfaces to mail filtering'&.
2860
2861 When testing a filter file,
2862 .cindex "&""From""& line"
2863 .cindex "envelope sender"
2864 .oindex "&%-f%&" "for filter testing"
2865 the envelope sender can be set by the &%-f%& option,
2866 or by a &"From&~"& line at the start of the test message. Various parameters
2867 that would normally be taken from the envelope recipient address of the message
2868 can be set by means of additional command line options (see the next four
2869 options).
2870
2871 .vitem &%-bfd%&&~<&'domain'&>
2872 .oindex "&%-bfd%&"
2873 .vindex "&$qualify_domain$&"
2874 This sets the domain of the recipient address when a filter file is being
2875 tested by means of the &%-bf%& option. The default is the value of
2876 &$qualify_domain$&.
2877
2878 .vitem &%-bfl%&&~<&'local&~part'&>
2879 .oindex "&%-bfl%&"
2880 This sets the local part of the recipient address when a filter file is being
2881 tested by means of the &%-bf%& option. The default is the username of the
2882 process that calls Exim. A local part should be specified with any prefix or
2883 suffix stripped, because that is how it appears to the filter when a message is
2884 actually being delivered.
2885
2886 .vitem &%-bfp%&&~<&'prefix'&>
2887 .oindex "&%-bfp%&"
2888 This sets the prefix of the local part of the recipient address when a filter
2889 file is being tested by means of the &%-bf%& option. The default is an empty
2890 prefix.
2891
2892 .vitem &%-bfs%&&~<&'suffix'&>
2893 .oindex "&%-bfs%&"
2894 This sets the suffix of the local part of the recipient address when a filter
2895 file is being tested by means of the &%-bf%& option. The default is an empty
2896 suffix.
2897
2898 .vitem &%-bh%&&~<&'IP&~address'&>
2899 .oindex "&%-bh%&"
2900 .cindex "testing" "incoming SMTP"
2901 .cindex "SMTP" "testing incoming"
2902 .cindex "testing" "relay control"
2903 .cindex "relaying" "testing configuration"
2904 .cindex "policy control" "testing"
2905 .cindex "debugging" "&%-bh%& option"
2906 This option runs a fake SMTP session as if from the given IP address, using the
2907 standard input and output. The IP address may include a port number at the end,
2908 after a full stop. For example:
2909 .code
2910 exim -bh 10.9.8.7.1234
2911 exim -bh fe80::a00:20ff:fe86:a061.5678
2912 .endd
2913 When an IPv6 address is given, it is converted into canonical form. In the case
2914 of the second example above, the value of &$sender_host_address$& after
2915 conversion to the canonical form is
2916 &`fe80:0000:0000:0a00:20ff:fe86:a061.5678`&.
2917
2918 Comments as to what is going on are written to the standard error file. These
2919 include lines beginning with &"LOG"& for anything that would have been logged.
2920 This facility is provided for testing configuration options for incoming
2921 messages, to make sure they implement the required policy. For example, you can
2922 test your relay controls using &%-bh%&.
2923
2924 &*Warning 1*&:
2925 .cindex "RFC 1413"
2926 You can test features of the configuration that rely on ident (RFC 1413)
2927 information by using the &%-oMt%& option. However, Exim cannot actually perform
2928 an ident callout when testing using &%-bh%& because there is no incoming SMTP
2929 connection.
2930
2931 &*Warning 2*&: Address verification callouts (see section &<<SECTcallver>>&)
2932 are also skipped when testing using &%-bh%&. If you want these callouts to
2933 occur, use &%-bhc%& instead.
2934
2935 Messages supplied during the testing session are discarded, and nothing is
2936 written to any of the real log files. There may be pauses when DNS (and other)
2937 lookups are taking place, and of course these may time out. The &%-oMi%& option
2938 can be used to specify a specific IP interface and port if this is important,
2939 and &%-oMaa%& and &%-oMai%& can be used to set parameters as if the SMTP
2940 session were authenticated.
2941
2942 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%& whose
2943 output just states whether a given recipient address from a given host is
2944 acceptable or not. See section &<<SECTcheckaccess>>&.
2945
2946 Features such as authentication and encryption, where the client input is not
2947 plain text, cannot easily be tested with &%-bh%&. Instead, you should use a
2948 specialized SMTP test program such as
2949 &url(http://jetmore.org/john/code/#swaks,swaks).
2950
2951 .vitem &%-bhc%&&~<&'IP&~address'&>
2952 .oindex "&%-bhc%&"
2953 This option operates in the same way as &%-bh%&, except that address
2954 verification callouts are performed if required. This includes consulting and
2955 updating the callout cache database.
2956
2957 .vitem &%-bi%&
2958 .oindex "&%-bi%&"
2959 .cindex "alias file" "building"
2960 .cindex "building alias file"
2961 .cindex "Sendmail compatibility" "&%-bi%& option"
2962 Sendmail interprets the &%-bi%& option as a request to rebuild its alias file.
2963 Exim does not have the concept of a single alias file, and so it cannot mimic
2964 this behaviour. However, calls to &_/usr/lib/sendmail_& with the &%-bi%& option
2965 tend to appear in various scripts such as NIS make files, so the option must be
2966 recognized.
2967
2968 If &%-bi%& is encountered, the command specified by the &%bi_command%&
2969 configuration option is run, under the uid and gid of the caller of Exim. If
2970 the &%-oA%& option is used, its value is passed to the command as an argument.
2971 The command set by &%bi_command%& may not contain arguments. The command can
2972 use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files
2973 if this is required. If the &%bi_command%& option is not set, calling Exim with
2974 &%-bi%& is a no-op.
2975
2976 . // Keep :help first, then the rest in alphabetical order
2977 .vitem &%-bI:help%&
2978 .oindex "&%-bI:help%&"
2979 .cindex "querying exim information"
2980 We shall provide various options starting &`-bI:`& for querying Exim for
2981 information.  The output of many of these will be intended for machine
2982 consumption.  This one is not.  The &%-bI:help%& option asks Exim for a
2983 synopsis of supported options beginning &`-bI:`&.  Use of any of these
2984 options shall cause Exim to exit after producing the requested output.
2985
2986 .vitem &%-bI:dscp%&
2987 .oindex "&%-bI:dscp%&"
2988 .cindex "DSCP" "values"
2989 This option causes Exim to emit an alphabetically sorted list of all
2990 recognised DSCP names.
2991
2992 .vitem &%-bI:sieve%&
2993 .oindex "&%-bI:sieve%&"
2994 .cindex "Sieve filter" "capabilities"
2995 This option causes Exim to emit an alphabetically sorted list of all supported
2996 Sieve protocol extensions on stdout, one per line.  This is anticipated to be
2997 useful for ManageSieve (RFC 5804) implementations, in providing that protocol's
2998 &`SIEVE`& capability response line.  As the precise list may depend upon
2999 compile-time build options, which this option will adapt to, this is the only
3000 way to guarantee a correct response.
3001
3002 .vitem &%-bm%&
3003 .oindex "&%-bm%&"
3004 .cindex "local message reception"
3005 This option runs an Exim receiving process that accepts an incoming,
3006 locally-generated message on the standard input. The recipients are given as the
3007 command arguments (except when &%-t%& is also present &-- see below). Each
3008 argument can be a comma-separated list of RFC 2822 addresses. This is the
3009 default option for selecting the overall action of an Exim call; it is assumed
3010 if no other conflicting option is present.
3011
3012 If any addresses in the message are unqualified (have no domain), they are
3013 qualified by the values of the &%qualify_domain%& or &%qualify_recipient%&
3014 options, as appropriate. The &%-bnq%& option (see below) provides a way of
3015 suppressing this for special cases.
3016
3017 Policy checks on the contents of local messages can be enforced by means of
3018 the non-SMTP ACL. See chapter &<<CHAPACL>>& for details.
3019
3020 .cindex "return code" "for &%-bm%&"
3021 The return code is zero if the message is successfully accepted. Otherwise, the
3022 action is controlled by the &%-oe%&&'x'& option setting &-- see below.
3023
3024 The format
3025 .cindex "message" "format"
3026 .cindex "format" "message"
3027 .cindex "&""From""& line"
3028 .cindex "UUCP" "&""From""& line"
3029 .cindex "Sendmail compatibility" "&""From""& line"
3030 of the message must be as defined in RFC 2822, except that, for
3031 compatibility with Sendmail and Smail, a line in one of the forms
3032 .code
3033 From sender Fri Jan  5 12:55 GMT 1997
3034 From sender Fri, 5 Jan 97 12:55:01
3035 .endd
3036 (with the weekday optional, and possibly with additional text after the date)
3037 is permitted to appear at the start of the message. There appears to be no
3038 authoritative specification of the format of this line. Exim recognizes it by
3039 matching against the regular expression defined by the &%uucp_from_pattern%&
3040 option, which can be changed if necessary.
3041
3042 .oindex "&%-f%&" "overriding &""From""& line"
3043 The specified sender is treated as if it were given as the argument to the
3044 &%-f%& option, but if a &%-f%& option is also present, its argument is used in
3045 preference to the address taken from the message. The caller of Exim must be a
3046 trusted user for the sender of a message to be set in this way.
3047
3048 .vitem &%-bmalware%&&~<&'filename'&>
3049 .oindex "&%-bmalware%&"
3050 .cindex "testing", "malware"
3051 .cindex "malware scan test"
3052 This debugging option causes Exim to scan the given file,
3053 using the malware scanning framework.  The option of &%av_scanner%& influences
3054 this option, so if &%av_scanner%&'s value is dependent upon an expansion then
3055 the expansion should have defaults which apply to this invocation.  ACLs are
3056 not invoked, so if &%av_scanner%& references an ACL variable then that variable
3057 will never be populated and &%-bmalware%& will fail.
3058
3059 Exim will have changed working directory before resolving the filename, so
3060 using fully qualified pathnames is advisable.  Exim will be running as the Exim
3061 user when it tries to open the file, rather than as the invoking user.
3062 This option requires admin privileges.
3063
3064 The &%-bmalware%& option will not be extended to be more generally useful,
3065 there are better tools for file-scanning.  This option exists to help
3066 administrators verify their Exim and AV scanner configuration.
3067
3068 .vitem &%-bnq%&
3069 .oindex "&%-bnq%&"
3070 .cindex "address qualification, suppressing"
3071 By default, Exim automatically qualifies unqualified addresses (those
3072 without domains) that appear in messages that are submitted locally (that
3073 is, not over TCP/IP). This qualification applies both to addresses in
3074 envelopes, and addresses in header lines. Sender addresses are qualified using
3075 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
3076 defaults to the value of &%qualify_domain%&).
3077
3078 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
3079 being used to re-submit messages that originally came from remote hosts after
3080 content scanning, you probably do not want to qualify unqualified addresses in
3081 header lines. (Such lines will be present only if you have not enabled a header
3082 syntax check in the appropriate ACL.)
3083
3084 The &%-bnq%& option suppresses all qualification of unqualified addresses in
3085 messages that originate on the local host. When this is used, unqualified
3086 addresses in the envelope provoke errors (causing message rejection) and
3087 unqualified addresses in header lines are left alone.
3088
3089
3090 .vitem &%-bP%&
3091 .oindex "&%-bP%&"
3092 .cindex "configuration options" "extracting"
3093 .cindex "options" "configuration &-- extracting"
3094 If this option is given with no arguments, it causes the values of all Exim's
3095 main configuration options to be written to the standard output. The values
3096 of one or more specific options can be requested by giving their names as
3097 arguments, for example:
3098 .code
3099 exim -bP qualify_domain hold_domains
3100 .endd
3101 .cindex "hiding configuration option values"
3102 .cindex "configuration options" "hiding value of"
3103 .cindex "options" "hiding value of"
3104 However, any option setting that is preceded by the word &"hide"& in the
3105 configuration file is not shown in full, except to an admin user. For other
3106 users, the output is as in this example:
3107 .code
3108 mysql_servers = <value not displayable>
3109 .endd
3110 If &%config%& is given as an argument, the config is
3111 output, as it was parsed, any include file resolved, any comment removed.
3112
3113 If &%config_file%& is given as an argument, the name of the run time
3114 configuration file is output. (&%configure_file%& works too, for
3115 backward compatibility.)
3116 If a list of configuration files was supplied, the value that is output here
3117 is the name of the file that was actually used.
3118
3119 .cindex "options" "hiding name of"
3120 If the &%-n%& flag is given, then for most modes of &%-bP%& operation the
3121 name will not be output.
3122
3123 .cindex "daemon" "process id (pid)"
3124 .cindex "pid (process id)" "of daemon"
3125 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
3126 directories where log files and daemon pid files are written are output,
3127 respectively. If these values are unset, log files are written in a
3128 sub-directory of the spool directory called &%log%&, and the pid file is
3129 written directly into the spool directory.
3130
3131 If &%-bP%& is followed by a name preceded by &`+`&, for example,
3132 .code
3133 exim -bP +local_domains
3134 .endd
3135 it searches for a matching named list of any type (domain, host, address, or
3136 local part) and outputs what it finds.
3137
3138 .cindex "options" "router &-- extracting"
3139 .cindex "options" "transport &-- extracting"
3140 .cindex "options" "authenticator &-- extracting"
3141 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
3142 followed by the name of an appropriate driver instance, the option settings for
3143 that driver are output. For example:
3144 .code
3145 exim -bP transport local_delivery
3146 .endd
3147 The generic driver options are output first, followed by the driver's private
3148 options. A list of the names of drivers of a particular type can be obtained by
3149 using one of the words &%router_list%&, &%transport_list%&, or
3150 &%authenticator_list%&, and a complete list of all drivers with their option
3151 settings can be obtained by using &%routers%&, &%transports%&, or
3152 &%authenticators%&.
3153
3154 .cindex "options" "macro &-- extracting"
3155 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3156 are available, similarly to the drivers.  Because macros are sometimes used
3157 for storing passwords, this option is restricted.
3158 The output format is one item per line.
3159
3160 .vitem &%-bp%&
3161 .oindex "&%-bp%&"
3162 .cindex "queue" "listing messages on"
3163 .cindex "listing" "messages on the queue"
3164 This option requests a listing of the contents of the mail queue on the
3165 standard output. If the &%-bp%& option is followed by a list of message ids,
3166 just those messages are listed. By default, this option can be used only by an
3167 admin user. However, the &%queue_list_requires_admin%& option can be set false
3168 to allow any user to see the queue.
3169
3170 Each message on the queue is displayed as in the following example:
3171 .code
3172 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3173           red.king@looking-glass.fict.example
3174           <other addresses>
3175 .endd
3176 .cindex "message" "size in queue listing"
3177 .cindex "size" "of message"
3178 The first line contains the length of time the message has been on the queue
3179 (in this case 25 minutes), the size of the message (2.9K), the unique local
3180 identifier for the message, and the message sender, as contained in the
3181 envelope. For bounce messages, the sender address is empty, and appears as
3182 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3183 the default sender address, the user's login name is shown in parentheses
3184 before the sender address.
3185
3186 .cindex "frozen messages" "in queue listing"
3187 If the message is frozen (attempts to deliver it are suspended) then the text
3188 &"*** frozen ***"& is displayed at the end of this line.
3189
3190 The recipients of the message (taken from the envelope, not the headers) are
3191 displayed on subsequent lines. Those addresses to which the message has already
3192 been delivered are marked with the letter D. If an original address gets
3193 expanded into several addresses via an alias or forward file, the original is
3194 displayed with a D only when deliveries for all of its child addresses are
3195 complete.
3196
3197
3198 .vitem &%-bpa%&
3199 .oindex "&%-bpa%&"
3200 This option operates like &%-bp%&, but in addition it shows delivered addresses
3201 that were generated from the original top level address(es) in each message by
3202 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3203 of just &"D"&.
3204
3205
3206 .vitem &%-bpc%&
3207 .oindex "&%-bpc%&"
3208 .cindex "queue" "count of messages on"
3209 This option counts the number of messages on the queue, and writes the total
3210 to the standard output. It is restricted to admin users, unless
3211 &%queue_list_requires_admin%& is set false.
3212
3213
3214 .vitem &%-bpr%&
3215 .oindex "&%-bpr%&"
3216 This option operates like &%-bp%&, but the output is not sorted into
3217 chronological order of message arrival. This can speed it up when there are
3218 lots of messages on the queue, and is particularly useful if the output is
3219 going to be post-processed in a way that doesn't need the sorting.
3220
3221 .vitem &%-bpra%&
3222 .oindex "&%-bpra%&"
3223 This option is a combination of &%-bpr%& and &%-bpa%&.
3224
3225 .vitem &%-bpru%&
3226 .oindex "&%-bpru%&"
3227 This option is a combination of &%-bpr%& and &%-bpu%&.
3228
3229
3230 .vitem &%-bpu%&
3231 .oindex "&%-bpu%&"
3232 This option operates like &%-bp%& but shows only undelivered top-level
3233 addresses for each message displayed. Addresses generated by aliasing or
3234 forwarding are not shown, unless the message was deferred after processing by a
3235 router with the &%one_time%& option set.
3236
3237
3238 .vitem &%-brt%&
3239 .oindex "&%-brt%&"
3240 .cindex "testing" "retry configuration"
3241 .cindex "retry" "configuration testing"
3242 This option is for testing retry rules, and it must be followed by up to three
3243 arguments. It causes Exim to look for a retry rule that matches the values
3244 and to write it to the standard output. For example:
3245 .code
3246 exim -brt bach.comp.mus.example
3247 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3248 .endd
3249 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3250 argument, which is required, can be a complete address in the form
3251 &'local_part@domain'&, or it can be just a domain name. If the second argument
3252 contains a dot, it is interpreted as an optional second domain name; if no
3253 retry rule is found for the first argument, the second is tried. This ties in
3254 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3255 rule is found that matches the host, one that matches the mail domain is
3256 sought. Finally, an argument that is the name of a specific delivery error, as
3257 used in setting up retry rules, can be given. For example:
3258 .code
3259 exim -brt haydn.comp.mus.example quota_3d
3260 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3261 .endd
3262
3263 .vitem &%-brw%&
3264 .oindex "&%-brw%&"
3265 .cindex "testing" "rewriting"
3266 .cindex "rewriting" "testing"
3267 This option is for testing address rewriting rules, and it must be followed by
3268 a single argument, consisting of either a local part without a domain, or a
3269 complete address with a fully qualified domain. Exim outputs how this address
3270 would be rewritten for each possible place it might appear. See chapter
3271 &<<CHAPrewrite>>& for further details.
3272
3273 .vitem &%-bS%&
3274 .oindex "&%-bS%&"
3275 .cindex "SMTP" "batched incoming"
3276 .cindex "batched SMTP input"
3277 This option is used for batched SMTP input, which is an alternative interface
3278 for non-interactive local message submission. A number of messages can be
3279 submitted in a single run. However, despite its name, this is not really SMTP
3280 input. Exim reads each message's envelope from SMTP commands on the standard
3281 input, but generates no responses. If the caller is trusted, or
3282 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3283 believed; otherwise the sender is always the caller of Exim.
3284
3285 The message itself is read from the standard input, in SMTP format (leading
3286 dots doubled), terminated by a line containing just a single dot. An error is
3287 provoked if the terminating dot is missing. A further message may then follow.
3288
3289 As for other local message submissions, the contents of incoming batch SMTP
3290 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3291 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3292 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3293
3294 Some other SMTP commands are recognized in the input. HELO and EHLO act
3295 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3296 QUIT quits, ignoring the rest of the standard input.
3297
3298 .cindex "return code" "for &%-bS%&"
3299 If any error is encountered, reports are written to the standard output and
3300 error streams, and Exim gives up immediately. The return code is 0 if no error
3301 was detected; it is 1 if one or more messages were accepted before the error
3302 was detected; otherwise it is 2.
3303
3304 More details of input using batched SMTP are given in section
3305 &<<SECTincomingbatchedSMTP>>&.
3306
3307 .vitem &%-bs%&
3308 .oindex "&%-bs%&"
3309 .cindex "SMTP" "local input"
3310 .cindex "local SMTP input"
3311 This option causes Exim to accept one or more messages by reading SMTP commands
3312 on the standard input, and producing SMTP replies on the standard output. SMTP
3313 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3314 Some user agents use this interface as a way of passing locally-generated
3315 messages to the MTA.
3316
3317 In
3318 .cindex "sender" "source of"
3319 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3320 set, the senders of messages are taken from the SMTP MAIL commands.
3321 Otherwise the content of these commands is ignored and the sender is set up as
3322 the calling user. Unqualified addresses are automatically qualified using
3323 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3324 &%-bnq%& option is used.
3325
3326 .cindex "inetd"
3327 The
3328 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3329 using a listening daemon. Exim can distinguish the two cases by checking
3330 whether the standard input is a TCP/IP socket. When Exim is called from
3331 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3332 above concerning senders and qualification do not apply. In this situation,
3333 Exim behaves in exactly the same way as it does when receiving a message via
3334 the listening daemon.
3335
3336 .vitem &%-bt%&
3337 .oindex "&%-bt%&"
3338 .cindex "testing" "addresses"
3339 .cindex "address" "testing"
3340 This option runs Exim in address testing mode, in which each argument is taken
3341 as a recipient address to be tested for deliverability. The results are
3342 written to the standard output. If a test fails, and the caller is not an admin
3343 user, no details of the failure are output, because these might contain
3344 sensitive information such as usernames and passwords for database lookups.
3345
3346 If no arguments are given, Exim runs in an interactive manner, prompting with a
3347 right angle bracket for addresses to be tested.
3348
3349 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3350 &[readline()]& function, because it is running as &'root'& and there are
3351 security issues.
3352
3353 Each address is handled as if it were the recipient address of a message
3354 (compare the &%-bv%& option). It is passed to the routers and the result is
3355 written to the standard output. However, any router that has
3356 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3357 genuine routing tests if your first router passes everything to a scanner
3358 program.
3359
3360 .cindex "return code" "for &%-bt%&"
3361 The return code is 2 if any address failed outright; it is 1 if no address
3362 failed outright but at least one could not be resolved for some reason. Return
3363 code 0 is given only when all addresses succeed.
3364
3365 .cindex "duplicate addresses"
3366 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3367 addresses after routing is complete, so that only one delivery takes place.
3368 This does not happen when testing with &%-bt%&; the full results of routing are
3369 always shown.
3370
3371 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3372 routers in the configuration makes any tests on the sender address of a
3373 message,
3374 .oindex "&%-f%&" "for address testing"
3375 you can use the &%-f%& option to set an appropriate sender when running
3376 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3377 default qualifying domain. However, if you have set up (for example) routers
3378 whose behaviour depends on the contents of an incoming message, you cannot test
3379 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3380 doing such tests.
3381
3382 .vitem &%-bV%&
3383 .oindex "&%-bV%&"
3384 .cindex "version number of Exim"
3385 This option causes Exim to write the current version number, compilation
3386 number, and compilation date of the &'exim'& binary to the standard output.
3387 It also lists the DBM library that is being used, the optional modules (such as
3388 specific lookup types), the drivers that are included in the binary, and the
3389 name of the run time configuration file that is in use.
3390
3391 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3392 configuration file. However, this is a static check only. It cannot check
3393 values that are to be expanded. For example, although a misspelt ACL verb is
3394 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3395 alone to discover (for example) all the typos in the configuration; some
3396 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3397 dynamic testing facilities.
3398
3399 .vitem &%-bv%&
3400 .oindex "&%-bv%&"
3401 .cindex "verifying address" "using &%-bv%&"
3402 .cindex "address" "verification"
3403 This option runs Exim in address verification mode, in which each argument is
3404 taken as a recipient address to be verified by the routers. (This does
3405 not involve any verification callouts). During normal operation, verification
3406 happens mostly as a consequence processing a &%verify%& condition in an ACL
3407 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3408 including callouts, see the &%-bh%& and &%-bhc%& options.
3409
3410 If verification fails, and the caller is not an admin user, no details of the
3411 failure are output, because these might contain sensitive information such as
3412 usernames and passwords for database lookups.
3413
3414 If no arguments are given, Exim runs in an interactive manner, prompting with a
3415 right angle bracket for addresses to be verified.
3416
3417 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3418 &[readline()]& function, because it is running as &'exim'& and there are
3419 security issues.
3420
3421 Verification differs from address testing (the &%-bt%& option) in that routers
3422 that have &%no_verify%& set are skipped, and if the address is accepted by a
3423 router that has &%fail_verify%& set, verification fails. The address is
3424 verified as a recipient if &%-bv%& is used; to test verification for a sender
3425 address, &%-bvs%& should be used.
3426
3427 If the &%-v%& option is not set, the output consists of a single line for each
3428 address, stating whether it was verified or not, and giving a reason in the
3429 latter case. Without &%-v%&, generating more than one address by redirection
3430 causes verification to end successfully, without considering the generated
3431 addresses. However, if just one address is generated, processing continues,
3432 and the generated address must verify successfully for the overall verification
3433 to succeed.
3434
3435 When &%-v%& is set, more details are given of how the address has been handled,
3436 and in the case of address redirection, all the generated addresses are also
3437 considered. Verification may succeed for some and fail for others.
3438
3439 The
3440 .cindex "return code" "for &%-bv%&"
3441 return code is 2 if any address failed outright; it is 1 if no address
3442 failed outright but at least one could not be resolved for some reason. Return
3443 code 0 is given only when all addresses succeed.
3444
3445 If any of the routers in the configuration makes any tests on the sender
3446 address of a message, you should use the &%-f%& option to set an appropriate
3447 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3448 calling user at the default qualifying domain.
3449
3450 .vitem &%-bvs%&
3451 .oindex "&%-bvs%&"
3452 This option acts like &%-bv%&, but verifies the address as a sender rather
3453 than a recipient address. This affects any rewriting and qualification that
3454 might happen.
3455
3456 .vitem &%-bw%&
3457 .oindex "&%-bw%&"
3458 .cindex "daemon"
3459 .cindex "inetd"
3460 .cindex "inetd" "wait mode"
3461 This option runs Exim as a daemon, awaiting incoming SMTP connections,
3462 similarly to the &%-bd%& option.  All port specifications on the command-line
3463 and in the configuration file are ignored.  Queue-running may not be specified.
3464
3465 In this mode, Exim expects to be passed a socket as fd 0 (stdin) which is
3466 listening for connections.  This permits the system to start up and have
3467 inetd (or equivalent) listen on the SMTP ports, starting an Exim daemon for
3468 each port only when the first connection is received.
3469
3470 If the option is given as &%-bw%&<&'time'&> then the time is a timeout, after
3471 which the daemon will exit, which should cause inetd to listen once more.
3472
3473 .vitem &%-C%&&~<&'filelist'&>
3474 .oindex "&%-C%&"
3475 .cindex "configuration file" "alternate"
3476 .cindex "CONFIGURE_FILE"
3477 .cindex "alternate configuration file"
3478 This option causes Exim to find the run time configuration file from the given
3479 list instead of from the list specified by the CONFIGURE_FILE
3480 compile-time setting. Usually, the list will consist of just a single file
3481 name, but it can be a colon-separated list of names. In this case, the first
3482 file that exists is used. Failure to open an existing file stops Exim from
3483 proceeding any further along the list, and an error is generated.
3484
3485 When this option is used by a caller other than root, and the list is different
3486 from the compiled-in list, Exim gives up its root privilege immediately, and
3487 runs with the real and effective uid and gid set to those of the caller.
3488 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3489 file contains a list of full pathnames, one per line, for configuration files
3490 which are trusted. Root privilege is retained for any configuration file so
3491 listed, as long as the caller is the Exim user (or the user specified in the
3492 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3493 not writeable by inappropriate users or groups.
3494
3495 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3496 configuration using &%-C%& right through message reception and delivery,
3497 even if the caller is root. The reception works, but by that time, Exim is
3498 running as the Exim user, so when it re-executes to regain privilege for the
3499 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3500 test reception and delivery using two separate commands (one to put a message
3501 on the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3502
3503 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3504 prefix string with which any file named in a &%-C%& command line option
3505 must start. In addition, the file name must not contain the sequence &`/../`&.
3506 However, if the value of the &%-C%& option is identical to the value of
3507 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3508 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3509 unset, any file name can be used with &%-C%&.
3510
3511 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3512 to a directory to which only root has access. This prevents someone who has
3513 broken into the Exim account from running a privileged Exim with an arbitrary
3514 configuration file.
3515
3516 The &%-C%& facility is useful for ensuring that configuration files are
3517 syntactically correct, but cannot be used for test deliveries, unless the
3518 caller is privileged, or unless it is an exotic configuration that does not
3519 require privilege. No check is made on the owner or group of the files
3520 specified by this option.
3521
3522
3523 .vitem &%-D%&<&'macro'&>=<&'value'&>
3524 .oindex "&%-D%&"
3525 .cindex "macro" "setting on command line"
3526 This option can be used to override macro definitions in the configuration file
3527 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3528 unprivileged caller, it causes Exim to give up its root privilege.
3529 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3530 completely disabled, and its use causes an immediate error exit.
3531
3532 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3533 colon-separated list of macros which are considered safe and, if &%-D%& only
3534 supplies macros from this list, and the values are acceptable, then Exim will
3535 not give up root privilege if the caller is root, the Exim run-time user, or
3536 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3537 to be removed in the future.  Acceptable values for the macros satisfy the
3538 regexp: &`^[A-Za-z0-9_/.-]*$`&
3539
3540 The entire option (including equals sign if present) must all be within one
3541 command line item. &%-D%& can be used to set the value of a macro to the empty
3542 string, in which case the equals sign is optional. These two commands are
3543 synonymous:
3544 .code
3545 exim -DABC  ...
3546 exim -DABC= ...
3547 .endd
3548 To include spaces in a macro definition item, quotes must be used. If you use
3549 quotes, spaces are permitted around the macro name and the equals sign. For
3550 example:
3551 .code
3552 exim '-D ABC = something' ...
3553 .endd
3554 &%-D%& may be repeated up to 10 times on a command line.
3555 .new
3556 Only macro names up to 22 letters long can be set.
3557 .wen
3558
3559
3560 .vitem &%-d%&<&'debug&~options'&>
3561 .oindex "&%-d%&"
3562 .cindex "debugging" "list of selectors"
3563 .cindex "debugging" "&%-d%& option"
3564 This option causes debugging information to be written to the standard
3565 error stream. It is restricted to admin users because debugging output may show
3566 database queries that contain password information. Also, the details of users'
3567 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3568 writes an error message to the standard error stream and exits with a non-zero
3569 return code.
3570
3571 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3572 standard debugging data is output. This can be reduced, or increased to include
3573 some more rarely needed information, by directly following &%-d%& with a string
3574 made up of names preceded by plus or minus characters. These add or remove sets
3575 of debugging data, respectively. For example, &%-d+filter%& adds filter
3576 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3577 no spaces are allowed in the debug setting. The available debugging categories
3578 are:
3579 .display
3580 &`acl            `& ACL interpretation
3581 &`auth           `& authenticators
3582 &`deliver        `& general delivery logic
3583 &`dns            `& DNS lookups (see also resolver)
3584 &`dnsbl          `& DNS black list (aka RBL) code
3585 &`exec           `& arguments for &[execv()]& calls
3586 &`expand         `& detailed debugging for string expansions
3587 &`filter         `& filter handling
3588 &`hints_lookup   `& hints data lookups
3589 &`host_lookup    `& all types of name-to-IP address handling
3590 &`ident          `& ident lookup
3591 &`interface      `& lists of local interfaces
3592 &`lists          `& matching things in lists
3593 &`load           `& system load checks
3594 &`local_scan     `& can be used by &[local_scan()]& (see chapter &&&
3595                     &<<CHAPlocalscan>>&)
3596 &`lookup         `& general lookup code and all lookups
3597 &`memory         `& memory handling
3598 &`pid            `& add pid to debug output lines
3599 &`process_info   `& setting info for the process log
3600 &`queue_run      `& queue runs
3601 &`receive        `& general message reception logic
3602 &`resolver       `& turn on the DNS resolver's debugging output
3603 &`retry          `& retry handling
3604 &`rewrite        `& address rewriting
3605 &`route          `& address routing
3606 &`timestamp      `& add timestamp to debug output lines
3607 &`tls            `& TLS logic
3608 &`transport      `& transports
3609 &`uid            `& changes of uid/gid and looking up uid/gid
3610 &`verify         `& address verification logic
3611 &`all            `& almost all of the above (see below), and also &%-v%&
3612 .endd
3613 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3614 for &`-all`&. The reason for this is that &`+all`& is something that people
3615 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3616 is included, an awful lot of output that is very rarely of interest is
3617 generated, so it now has to be explicitly requested. However, &`-all`& does
3618 turn everything off.
3619
3620 .cindex "resolver, debugging output"
3621 .cindex "DNS resolver, debugging output"
3622 The &`resolver`& option produces output only if the DNS resolver was compiled
3623 with DEBUG enabled. This is not the case in some operating systems. Also,
3624 unfortunately, debugging output from the DNS resolver is written to stdout
3625 rather than stderr.
3626
3627 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3628 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3629 However, the &`pid`& selector is forced when debugging is turned on for a
3630 daemon, which then passes it on to any re-executed Exims. Exim also
3631 automatically adds the pid to debug lines when several remote deliveries are
3632 run in parallel.
3633
3634 The &`timestamp`& selector causes the current time to be inserted at the start
3635 of all debug output lines. This can be useful when trying to track down delays
3636 in processing.
3637
3638 If the &%debug_print%& option is set in any driver, it produces output whenever
3639 any debugging is selected, or if &%-v%& is used.
3640
3641 .vitem &%-dd%&<&'debug&~options'&>
3642 .oindex "&%-dd%&"
3643 This option behaves exactly like &%-d%& except when used on a command that
3644 starts a daemon process. In that case, debugging is turned off for the
3645 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3646 behaviour of the daemon without creating as much output as full debugging does.
3647
3648 .vitem &%-dropcr%&
3649 .oindex "&%-dropcr%&"
3650 This is an obsolete option that is now a no-op. It used to affect the way Exim
3651 handled CR and LF characters in incoming messages. What happens now is
3652 described in section &<<SECTlineendings>>&.
3653
3654 .vitem &%-E%&
3655 .oindex "&%-E%&"
3656 .cindex "bounce message" "generating"
3657 This option specifies that an incoming message is a locally-generated delivery
3658 failure report. It is used internally by Exim when handling delivery failures
3659 and is not intended for external use. Its only effect is to stop Exim
3660 generating certain messages to the postmaster, as otherwise message cascades
3661 could occur in some situations. As part of the same option, a message id may
3662 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3663 new message contains the id, following &"R="&, as a cross-reference.
3664
3665 .vitem &%-e%&&'x'&
3666 .oindex "&%-e%&&'x'&"
3667 There are a number of Sendmail options starting with &%-oe%& which seem to be
3668 called by various programs without the leading &%o%& in the option. For
3669 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3670 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3671
3672 .vitem &%-F%&&~<&'string'&>
3673 .oindex "&%-F%&"
3674 .cindex "sender" "name"
3675 .cindex "name" "of sender"
3676 This option sets the sender's full name for use when a locally-generated
3677 message is being accepted. In the absence of this option, the user's &'gecos'&
3678 entry from the password data is used. As users are generally permitted to alter
3679 their &'gecos'& entries, no security considerations are involved. White space
3680 between &%-F%& and the <&'string'&> is optional.
3681
3682 .vitem &%-f%&&~<&'address'&>
3683 .oindex "&%-f%&"
3684 .cindex "sender" "address"
3685 .cindex "address" "sender"
3686 .cindex "trusted users"
3687 .cindex "envelope sender"
3688 .cindex "user" "trusted"
3689 This option sets the address of the envelope sender of a locally-generated
3690 message (also known as the return path). The option can normally be used only
3691 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3692 users to use it.
3693
3694 Processes running as root or the Exim user are always trusted. Other
3695 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3696 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3697 of a local message is set to the caller's login name at the default qualify
3698 domain.
3699
3700 There is one exception to the restriction on the use of &%-f%&: an empty sender
3701 can be specified by any user, trusted or not, to create a message that can
3702 never provoke a bounce. An empty sender can be specified either as an empty
3703 string, or as a pair of angle brackets with nothing between them, as in these
3704 examples of shell commands:
3705 .code
3706 exim -f '<>' user@domain
3707 exim -f "" user@domain
3708 .endd
3709 In addition, the use of &%-f%& is not restricted when testing a filter file
3710 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3711 &%-bv%& options.
3712
3713 Allowing untrusted users to change the sender address does not of itself make
3714 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3715 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3716 though this can be overridden by setting &%no_local_from_check%&.
3717
3718 White
3719 .cindex "&""From""& line"
3720 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3721 given as two arguments or one combined argument). The sender of a
3722 locally-generated message can also be set (when permitted) by an initial
3723 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3724 if &%-f%& is also present, it overrides &"From&~"&.
3725
3726 .vitem &%-G%&
3727 .oindex "&%-G%&"
3728 .cindex "submission fixups, suppressing (command-line)"
3729 This option is equivalent to an ACL applying:
3730 .code
3731 control = suppress_local_fixups
3732 .endd
3733 for every message received.  Note that Sendmail will complain about such
3734 bad formatting, where Exim silently just does not fix it up.  This may change
3735 in future.
3736
3737 As this affects audit information, the caller must be a trusted user to use
3738 this option.
3739
3740 .vitem &%-h%&&~<&'number'&>
3741 .oindex "&%-h%&"
3742 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3743 This option is accepted for compatibility with Sendmail, but has no effect. (In
3744 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3745 headers.)
3746
3747 .vitem &%-i%&
3748 .oindex "&%-i%&"
3749 .cindex "Solaris" "&'mail'& command"
3750 .cindex "dot" "in incoming non-SMTP message"
3751 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3752 line by itself should not terminate an incoming, non-SMTP message. I can find
3753 no documentation for this option in Solaris 2.4 Sendmail, but the &'mailx'&
3754 command in Solaris 2.4 uses it. See also &%-ti%&.
3755
3756 .vitem &%-L%&&~<&'tag'&>
3757 .oindex "&%-L%&"
3758 .cindex "syslog" "process name; set with flag"
3759 This option is equivalent to setting &%syslog_processname%& in the config
3760 file and setting &%log_file_path%& to &`syslog`&.
3761 Its use is restricted to administrators.  The configuration file has to be
3762 read and parsed, to determine access rights, before this is set and takes
3763 effect, so early configuration file errors will not honour this flag.
3764
3765 The tag should not be longer than 32 characters.
3766
3767 .vitem &%-M%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3768 .oindex "&%-M%&"
3769 .cindex "forcing delivery"
3770 .cindex "delivery" "forcing attempt"
3771 .cindex "frozen messages" "forcing delivery"
3772 This option requests Exim to run a delivery attempt on each message in turn. If
3773 any of the messages are frozen, they are automatically thawed before the
3774 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3775 and &%hold_domains%& are ignored.
3776
3777 Retry
3778 .cindex "hints database" "overriding retry hints"
3779 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3780 the normal retry time has not yet been reached. This option requires the caller
3781 to be an admin user. However, there is an option called &%prod_requires_admin%&
3782 which can be set false to relax this restriction (and also the same requirement
3783 for the &%-q%&, &%-R%&, and &%-S%& options).
3784
3785 The deliveries happen synchronously, that is, the original Exim process does
3786 not terminate until all the delivery attempts have finished. No output is
3787 produced unless there is a serious error. If you want to see what is happening,
3788 use the &%-v%& option as well, or inspect Exim's main log.
3789
3790 .vitem &%-Mar%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3791 .oindex "&%-Mar%&"
3792 .cindex "message" "adding recipients"
3793 .cindex "recipient" "adding"
3794 This option requests Exim to add the addresses to the list of recipients of the
3795 message (&"ar"& for &"add recipients"&). The first argument must be a message
3796 id, and the remaining ones must be email addresses. However, if the message is
3797 active (in the middle of a delivery attempt), it is not altered. This option
3798 can be used only by an admin user.
3799
3800 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&~<&'sequence&~number'&>&&&
3801         &~<&'message&~id'&>"
3802 .oindex "&%-MC%&"
3803 .cindex "SMTP" "passed connection"
3804 .cindex "SMTP" "multiple deliveries"
3805 .cindex "multiple SMTP deliveries"
3806 This option is not intended for use by external callers. It is used internally
3807 by Exim to invoke another instance of itself to deliver a waiting message using
3808 an existing SMTP connection, which is passed as the standard input. Details are
3809 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3810 must be root or the Exim user in order to use it.
3811
3812 .vitem &%-MCA%&
3813 .oindex "&%-MCA%&"
3814 This option is not intended for use by external callers. It is used internally
3815 by Exim in conjunction with the &%-MC%& option. It signifies that the
3816 connection to the remote host has been authenticated.
3817
3818 .vitem &%-MCD%&
3819 .oindex "&%-MCD%&"
3820 This option is not intended for use by external callers. It is used internally
3821 by Exim in conjunction with the &%-MC%& option. It signifies that the
3822 remote host supports the ESMTP &_DSN_& extension.
3823
3824 .vitem &%-MCP%&
3825 .oindex "&%-MCP%&"
3826 This option is not intended for use by external callers. It is used internally
3827 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3828 which Exim is connected supports pipelining.
3829
3830 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3831 .oindex "&%-MCQ%&"
3832 This option is not intended for use by external callers. It is used internally
3833 by Exim in conjunction with the &%-MC%& option when the original delivery was
3834 started by a queue runner. It passes on the process id of the queue runner,
3835 together with the file descriptor number of an open pipe. Closure of the pipe
3836 signals the final completion of the sequence of processes that are passing
3837 messages through the same SMTP connection.
3838
3839 .vitem &%-MCS%&
3840 .oindex "&%-MCS%&"
3841 This option is not intended for use by external callers. It is used internally
3842 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3843 SMTP SIZE option should be used on messages delivered down the existing
3844 connection.
3845
3846 .vitem &%-MCT%&
3847 .oindex "&%-MCT%&"
3848 This option is not intended for use by external callers. It is used internally
3849 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3850 host to which Exim is connected supports TLS encryption.
3851
3852 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3853 .oindex "&%-Mc%&"
3854 .cindex "hints database" "not overridden by &%-Mc%&"
3855 .cindex "delivery" "manually started &-- not forced"
3856 This option requests Exim to run a delivery attempt on each message in turn,
3857 but unlike the &%-M%& option, it does check for retry hints, and respects any
3858 that are found. This option is not very useful to external callers. It is
3859 provided mainly for internal use by Exim when it needs to re-invoke itself in
3860 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3861 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3862 respects retry times and other options such as &%hold_domains%& that are
3863 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3864 If you want to run a specific delivery as if in a queue run, you should use
3865 &%-q%& with a message id argument. A distinction between queue run deliveries
3866 and other deliveries is made in one or two places.
3867
3868 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
3869 .oindex "&%-Mes%&"
3870 .cindex "message" "changing sender"
3871 .cindex "sender" "changing"
3872 This option requests Exim to change the sender address in the message to the
3873 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3874 &"edit sender"&). There must be exactly two arguments. The first argument must
3875 be a message id, and the second one an email address. However, if the message
3876 is active (in the middle of a delivery attempt), its status is not altered.
3877 This option can be used only by an admin user.
3878
3879 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3880 .oindex "&%-Mf%&"
3881 .cindex "freezing messages"
3882 .cindex "message" "manually freezing"
3883 This option requests Exim to mark each listed message as &"frozen"&. This
3884 prevents any delivery attempts taking place until the message is &"thawed"&,
3885 either manually or as a result of the &%auto_thaw%& configuration option.
3886 However, if any of the messages are active (in the middle of a delivery
3887 attempt), their status is not altered. This option can be used only by an admin
3888 user.
3889
3890 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3891 .oindex "&%-Mg%&"
3892 .cindex "giving up on messages"
3893 .cindex "message" "abandoning delivery attempts"
3894 .cindex "delivery" "abandoning further attempts"
3895 This option requests Exim to give up trying to deliver the listed messages,
3896 including any that are frozen. However, if any of the messages are active,
3897 their status is not altered. For non-bounce messages, a delivery error message
3898 is sent to the sender, containing the text &"cancelled by administrator"&.
3899 Bounce messages are just discarded. This option can be used only by an admin
3900 user.
3901
3902 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3903 .oindex "&%-Mmad%&"
3904 .cindex "delivery" "cancelling all"
3905 This option requests Exim to mark all the recipient addresses in the messages
3906 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
3907 message is active (in the middle of a delivery attempt), its status is not
3908 altered. This option can be used only by an admin user.
3909
3910 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3911 .oindex "&%-Mmd%&"
3912 .cindex "delivery" "cancelling by address"
3913 .cindex "recipient" "removing"
3914 .cindex "removing recipients"
3915 This option requests Exim to mark the given addresses as already delivered
3916 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
3917 the remaining ones must be email addresses. These are matched to recipient
3918 addresses in the message in a case-sensitive manner. If the message is active
3919 (in the middle of a delivery attempt), its status is not altered. This option
3920 can be used only by an admin user.
3921
3922 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3923 .oindex "&%-Mrm%&"
3924 .cindex "removing messages"
3925 .cindex "abandoning mail"
3926 .cindex "message" "manually discarding"
3927 This option requests Exim to remove the given messages from the queue. No
3928 bounce messages are sent; each message is simply forgotten. However, if any of
3929 the messages are active, their status is not altered. This option can be used
3930 only by an admin user or by the user who originally caused the message to be
3931 placed on the queue.
3932
3933 .vitem &%-Mset%&&~<&'message&~id'&>
3934 .oindex "&%-Mset%&
3935 .cindex "testing" "string expansion"
3936 .cindex "expansion" "testing"
3937 This option is useful only in conjunction with &%-be%& (that is, when testing
3938 string expansions). Exim loads the given message from its spool before doing
3939 the test expansions, thus setting message-specific variables such as
3940 &$message_size$& and the header variables. The &$recipients$& variable is made
3941 available. This feature is provided to make it easier to test expansions that
3942 make use of these variables. However, this option can be used only by an admin
3943 user. See also &%-bem%&.
3944
3945 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3946 .oindex "&%-Mt%&"
3947 .cindex "thawing messages"
3948 .cindex "unfreezing messages"
3949 .cindex "frozen messages" "thawing"
3950 .cindex "message" "thawing frozen"
3951 This option requests Exim to &"thaw"& any of the listed messages that are
3952 &"frozen"&, so that delivery attempts can resume. However, if any of the
3953 messages are active, their status is not altered. This option can be used only
3954 by an admin user.
3955
3956 .vitem &%-Mvb%&&~<&'message&~id'&>
3957 .oindex "&%-Mvb%&"
3958 .cindex "listing" "message body"
3959 .cindex "message" "listing body of"
3960 This option causes the contents of the message body (-D) spool file to be
3961 written to the standard output. This option can be used only by an admin user.
3962
3963 .vitem &%-Mvc%&&~<&'message&~id'&>
3964 .oindex "&%-Mvc%&"
3965 .cindex "message" "listing in RFC 2822 format"
3966 .cindex "listing" "message in RFC 2822 format"
3967 This option causes a copy of the complete message (header lines plus body) to
3968 be written to the standard output in RFC 2822 format. This option can be used
3969 only by an admin user.
3970
3971 .vitem &%-Mvh%&&~<&'message&~id'&>
3972 .oindex "&%-Mvh%&"
3973 .cindex "listing" "message headers"
3974 .cindex "header lines" "listing"
3975 .cindex "message" "listing header lines"
3976 This option causes the contents of the message headers (-H) spool file to be
3977 written to the standard output. This option can be used only by an admin user.
3978
3979 .vitem &%-Mvl%&&~<&'message&~id'&>
3980 .oindex "&%-Mvl%&"
3981 .cindex "listing" "message log"
3982 .cindex "message" "listing message log"
3983 This option causes the contents of the message log spool file to be written to
3984 the standard output. This option can be used only by an admin user.
3985
3986 .vitem &%-m%&
3987 .oindex "&%-m%&"
3988 This is apparently a synonym for &%-om%& that is accepted by Sendmail, so Exim
3989 treats it that way too.
3990
3991 .vitem &%-N%&
3992 .oindex "&%-N%&"
3993 .cindex "debugging" "&%-N%& option"
3994 .cindex "debugging" "suppressing delivery"
3995 This is a debugging option that inhibits delivery of a message at the transport
3996 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
3997 it just doesn't actually transport the message, but instead behaves as if it
3998 had successfully done so. However, it does not make any updates to the retry
3999 database, and the log entries for deliveries are flagged with &"*>"& rather
4000 than &"=>"&.
4001
4002 Because &%-N%& discards any message to which it applies, only root or the Exim
4003 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
4004 words, an ordinary user can use it only when supplying an incoming message to
4005 which it will apply. Although transportation never fails when &%-N%& is set, an
4006 address may be deferred because of a configuration problem on a transport, or a
4007 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
4008 the message, and applies to any subsequent delivery attempts that may happen
4009 for that message.
4010
4011 .vitem &%-n%&
4012 .oindex "&%-n%&"
4013 This option is interpreted by Sendmail to mean &"no aliasing"&.
4014 For normal modes of operation, it is ignored by Exim.
4015 When combined with &%-bP%& it suppresses the name of an option from being output.
4016
4017 .vitem &%-O%&&~<&'data'&>
4018 .oindex "&%-O%&"
4019 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
4020 Exim.
4021
4022 .vitem &%-oA%&&~<&'file&~name'&>
4023 .oindex "&%-oA%&"
4024 .cindex "Sendmail compatibility" "&%-oA%& option"
4025 This option is used by Sendmail in conjunction with &%-bi%& to specify an
4026 alternative alias file name. Exim handles &%-bi%& differently; see the
4027 description above.
4028
4029 .vitem &%-oB%&&~<&'n'&>
4030 .oindex "&%-oB%&"
4031 .cindex "SMTP" "passed connection"
4032 .cindex "SMTP" "multiple deliveries"
4033 .cindex "multiple SMTP deliveries"
4034 This is a debugging option which limits the maximum number of messages that can
4035 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
4036 transport. If <&'n'&> is omitted, the limit is set to 1.
4037
4038 .vitem &%-odb%&
4039 .oindex "&%-odb%&"
4040 .cindex "background delivery"
4041 .cindex "delivery" "in the background"
4042 This option applies to all modes in which Exim accepts incoming messages,
4043 including the listening daemon. It requests &"background"& delivery of such
4044 messages, which means that the accepting process automatically starts a
4045 delivery process for each message received, but does not wait for the delivery
4046 processes to finish.
4047
4048 When all the messages have been received, the reception process exits,
4049 leaving the delivery processes to finish in their own time. The standard output
4050 and error streams are closed at the start of each delivery process.
4051 This is the default action if none of the &%-od%& options are present.
4052
4053 If one of the queueing options in the configuration file
4054 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
4055 overrides it if &%queue_only_override%& is set true, which is the default
4056 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
4057
4058 .vitem &%-odf%&
4059 .oindex "&%-odf%&"
4060 .cindex "foreground delivery"
4061 .cindex "delivery" "in the foreground"
4062 This option requests &"foreground"& (synchronous) delivery when Exim has
4063 accepted a locally-generated message. (For the daemon it is exactly the same as
4064 &%-odb%&.) A delivery process is automatically started to deliver the message,
4065 and Exim waits for it to complete before proceeding.
4066
4067 The original Exim reception process does not finish until the delivery
4068 process for the final message has ended. The standard error stream is left open
4069 during deliveries.
4070
4071 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
4072 false and one of the queueing options in the configuration file is in effect.
4073
4074 If there is a temporary delivery error during foreground delivery, the
4075 message is left on the queue for later delivery, and the original reception
4076 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
4077 restricted configuration that never queues messages.
4078
4079
4080 .vitem &%-odi%&
4081 .oindex "&%-odi%&"
4082 This option is synonymous with &%-odf%&. It is provided for compatibility with
4083 Sendmail.
4084
4085 .vitem &%-odq%&
4086 .oindex "&%-odq%&"
4087 .cindex "non-immediate delivery"
4088 .cindex "delivery" "suppressing immediate"
4089 .cindex "queueing incoming messages"
4090 This option applies to all modes in which Exim accepts incoming messages,
4091 including the listening daemon. It specifies that the accepting process should
4092 not automatically start a delivery process for each message received. Messages
4093 are placed on the queue, and remain there until a subsequent queue runner
4094 process encounters them. There are several configuration options (such as
4095 &%queue_only%&) that can be used to queue incoming messages under certain
4096 conditions. This option overrides all of them and also &%-odqs%&. It always
4097 forces queueing.
4098
4099 .vitem &%-odqs%&
4100 .oindex "&%-odqs%&"
4101 .cindex "SMTP" "delaying delivery"
4102 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4103 However, like &%-odb%& and &%-odi%&, this option has no effect if
4104 &%queue_only_override%& is false and one of the queueing options in the
4105 configuration file is in effect.
4106
4107 When &%-odqs%& does operate, a delivery process is started for each incoming
4108 message, in the background by default, but in the foreground if &%-odi%& is
4109 also present. The recipient addresses are routed, and local deliveries are done
4110 in the normal way. However, if any SMTP deliveries are required, they are not
4111 done at this time, so the message remains on the queue until a subsequent queue
4112 runner process encounters it. Because routing was done, Exim knows which
4113 messages are waiting for which hosts, and so a number of messages for the same
4114 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4115 configuration option has the same effect for specific domains. See also the
4116 &%-qq%& option.
4117
4118 .vitem &%-oee%&
4119 .oindex "&%-oee%&"
4120 .cindex "error" "reporting"
4121 If an error is detected while a non-SMTP message is being received (for
4122 example, a malformed address), the error is reported to the sender in a mail
4123 message.
4124
4125 .cindex "return code" "for &%-oee%&"
4126 Provided
4127 this error message is successfully sent, the Exim receiving process
4128 exits with a return code of zero. If not, the return code is 2 if the problem
4129 is that the original message has no recipients, or 1 for any other error.
4130 This is the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4131
4132 .vitem &%-oem%&
4133 .oindex "&%-oem%&"
4134 .cindex "error" "reporting"
4135 .cindex "return code" "for &%-oem%&"
4136 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4137 return code, whether or not the error message was successfully sent.
4138 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4139
4140 .vitem &%-oep%&
4141 .oindex "&%-oep%&"
4142 .cindex "error" "reporting"
4143 If an error is detected while a non-SMTP message is being received, the
4144 error is reported by writing a message to the standard error file (stderr).
4145 .cindex "return code" "for &%-oep%&"
4146 The return code is 1 for all errors.
4147
4148 .vitem &%-oeq%&
4149 .oindex "&%-oeq%&"
4150 .cindex "error" "reporting"
4151 This option is supported for compatibility with Sendmail, but has the same
4152 effect as &%-oep%&.
4153
4154 .vitem &%-oew%&
4155 .oindex "&%-oew%&"
4156 .cindex "error" "reporting"
4157 This option is supported for compatibility with Sendmail, but has the same
4158 effect as &%-oem%&.
4159
4160 .vitem &%-oi%&
4161 .oindex "&%-oi%&"
4162 .cindex "dot" "in incoming non-SMTP message"
4163 This option, which has the same effect as &%-i%&, specifies that a dot on a
4164 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4165 single dot does terminate, though Exim does no special processing for other
4166 lines that start with a dot. This option is set by default if Exim is called as
4167 &'rmail'&. See also &%-ti%&.
4168
4169 .vitem &%-oitrue%&
4170 .oindex "&%-oitrue%&"
4171 This option is treated as synonymous with &%-oi%&.
4172
4173 .vitem &%-oMa%&&~<&'host&~address'&>
4174 .oindex "&%-oMa%&"
4175 .cindex "sender" "host address, specifying for local message"
4176 A number of options starting with &%-oM%& can be used to set values associated
4177 with remote hosts on locally-submitted messages (that is, messages not received
4178 over TCP/IP). These options can be used by any caller in conjunction with the
4179 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4180 other circumstances, they are ignored unless the caller is trusted.
4181
4182 The &%-oMa%& option sets the sender host address. This may include a port
4183 number at the end, after a full stop (period). For example:
4184 .code
4185 exim -bs -oMa 10.9.8.7.1234
4186 .endd
4187 An alternative syntax is to enclose the IP address in square brackets,
4188 followed by a colon and the port number:
4189 .code
4190 exim -bs -oMa [10.9.8.7]:1234
4191 .endd
4192 The IP address is placed in the &$sender_host_address$& variable, and the
4193 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4194 are present on the command line, the sender host IP address is taken from
4195 whichever one is last.
4196
4197 .vitem &%-oMaa%&&~<&'name'&>
4198 .oindex "&%-oMaa%&"
4199 .cindex "authentication" "name, specifying for local message"
4200 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4201 option sets the value of &$sender_host_authenticated$& (the authenticator
4202 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4203 This option can be used with &%-bh%& and &%-bs%& to set up an
4204 authenticated SMTP session without actually using the SMTP AUTH command.
4205
4206 .vitem &%-oMai%&&~<&'string'&>
4207 .oindex "&%-oMai%&"
4208 .cindex "authentication" "id, specifying for local message"
4209 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4210 option sets the value of &$authenticated_id$& (the id that was authenticated).
4211 This overrides the default value (the caller's login id, except with &%-bh%&,
4212 where there is no default) for messages from local sources. See chapter
4213 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4214
4215 .vitem &%-oMas%&&~<&'address'&>
4216 .oindex "&%-oMas%&"
4217 .cindex "authentication" "sender, specifying for local message"
4218 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4219 option sets the authenticated sender value in &$authenticated_sender$&. It
4220 overrides the sender address that is created from the caller's login id for
4221 messages from local sources, except when &%-bh%& is used, when there is no
4222 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4223 specified on a MAIL command overrides this value. See chapter
4224 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4225
4226 .vitem &%-oMi%&&~<&'interface&~address'&>
4227 .oindex "&%-oMi%&"
4228 .cindex "interface" "address, specifying for local message"
4229 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4230 option sets the IP interface address value. A port number may be included,
4231 using the same syntax as for &%-oMa%&. The interface address is placed in
4232 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4233
4234 .vitem &%-oMm%&&~<&'message&~reference'&>
4235 .oindex "&%-oMm%&"
4236 .cindex "message reference" "message reference, specifying for local message"
4237 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMm%&
4238 option sets the message reference, e.g. message-id, and is logged during
4239 delivery. This is useful when some kind of audit trail is required to tie
4240 messages together. The format of the message reference is checked and will
4241 abort if the format is invalid. The option will only be accepted if exim is
4242 running in trusted mode, not as any regular user.
4243
4244 The best example of a message reference is when Exim sends a bounce message.
4245 The message reference is the message-id of the original message for which Exim
4246 is sending the bounce.
4247
4248 .vitem &%-oMr%&&~<&'protocol&~name'&>
4249 .oindex "&%-oMr%&"
4250 .cindex "protocol, specifying for local message"
4251 .vindex "&$received_protocol$&"
4252 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4253 option sets the received protocol value that is stored in
4254 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4255 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4256 SMTP protocol names (see the description of &$received_protocol$& in section
4257 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4258 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4259 be set by &%-oMr%&.
4260
4261 .vitem &%-oMs%&&~<&'host&~name'&>
4262 .oindex "&%-oMs%&"
4263 .cindex "sender" "host name, specifying for local message"
4264 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4265 option sets the sender host name in &$sender_host_name$&. When this option is
4266 present, Exim does not attempt to look up a host name from an IP address; it
4267 uses the name it is given.
4268
4269 .vitem &%-oMt%&&~<&'ident&~string'&>
4270 .oindex "&%-oMt%&"
4271 .cindex "sender" "ident string, specifying for local message"
4272 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4273 option sets the sender ident value in &$sender_ident$&. The default setting for
4274 local callers is the login id of the calling process, except when &%-bh%& is
4275 used, when there is no default.
4276
4277 .vitem &%-om%&
4278 .oindex "&%-om%&"
4279 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4280 In Sendmail, this option means &"me too"&, indicating that the sender of a
4281 message should receive a copy of the message if the sender appears in an alias
4282 expansion. Exim always does this, so the option does nothing.
4283
4284 .vitem &%-oo%&
4285 .oindex "&%-oo%&"
4286 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4287 This option is ignored. In Sendmail it specifies &"old style headers"&,
4288 whatever that means.
4289
4290 .vitem &%-oP%&&~<&'path'&>
4291 .oindex "&%-oP%&"
4292 .cindex "pid (process id)" "of daemon"
4293 .cindex "daemon" "process id (pid)"
4294 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4295 value. The option specifies the file to which the process id of the daemon is
4296 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4297 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4298 because in those cases, the normal pid file is not used.
4299
4300 .vitem &%-or%&&~<&'time'&>
4301 .oindex "&%-or%&"
4302 .cindex "timeout" "for non-SMTP input"
4303 This option sets a timeout value for incoming non-SMTP messages. If it is not
4304 set, Exim will wait forever for the standard input. The value can also be set
4305 by the &%receive_timeout%& option. The format used for specifying times is
4306 described in section &<<SECTtimeformat>>&.
4307
4308 .vitem &%-os%&&~<&'time'&>
4309 .oindex "&%-os%&"
4310 .cindex "timeout" "for SMTP input"
4311 .cindex "SMTP" "input timeout"
4312 This option sets a timeout value for incoming SMTP messages. The timeout
4313 applies to each SMTP command and block of data. The value can also be set by
4314 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4315 for specifying times is described in section &<<SECTtimeformat>>&.
4316
4317 .vitem &%-ov%&
4318 .oindex "&%-ov%&"
4319 This option has exactly the same effect as &%-v%&.
4320
4321 .vitem &%-oX%&&~<&'number&~or&~string'&>
4322 .oindex "&%-oX%&"
4323 .cindex "TCP/IP" "setting listening ports"
4324 .cindex "TCP/IP" "setting listening interfaces"
4325 .cindex "port" "receiving TCP/IP"
4326 This option is relevant only when the &%-bd%& (start listening daemon) option
4327 is also given. It controls which ports and interfaces the daemon uses. Details
4328 of the syntax, and how it interacts with configuration file options, are given
4329 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4330 file is written unless &%-oP%& is also present to specify a pid file name.
4331
4332 .vitem &%-pd%&
4333 .oindex "&%-pd%&"
4334 .cindex "Perl" "starting the interpreter"
4335 This option applies when an embedded Perl interpreter is linked with Exim (see
4336 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4337 option, forcing the starting of the interpreter to be delayed until it is
4338 needed.
4339
4340 .vitem &%-ps%&
4341 .oindex "&%-ps%&"
4342 .cindex "Perl" "starting the interpreter"
4343 This option applies when an embedded Perl interpreter is linked with Exim (see
4344 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4345 option, forcing the starting of the interpreter to occur as soon as Exim is
4346 started.
4347
4348 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4349 .oindex "&%-p%&"
4350 For compatibility with Sendmail, this option is equivalent to
4351 .display
4352 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4353 .endd
4354 It sets the incoming protocol and host name (for trusted callers). The
4355 host name and its colon can be omitted when only the protocol is to be set.
4356 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4357 to embedded Perl. It is therefore impossible to set a protocol value of &`d`&
4358 or &`s`& using this option (but that does not seem a real limitation).
4359
4360 .vitem &%-q%&
4361 .oindex "&%-q%&"
4362 .cindex "queue runner" "starting manually"
4363 This option is normally restricted to admin users. However, there is a
4364 configuration option called &%prod_requires_admin%& which can be set false to
4365 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4366 and &%-S%& options).
4367
4368 .cindex "queue runner" "description of operation"
4369 The &%-q%& option starts one queue runner process. This scans the queue of
4370 waiting messages, and runs a delivery process for each one in turn. It waits
4371 for each delivery process to finish before starting the next one. A delivery
4372 process may not actually do any deliveries if the retry times for the addresses
4373 have not been reached. Use &%-qf%& (see below) if you want to override this.
4374
4375 If
4376 .cindex "SMTP" "passed connection"
4377 .cindex "SMTP" "multiple deliveries"
4378 .cindex "multiple SMTP deliveries"
4379 the delivery process spawns other processes to deliver other messages down
4380 passed SMTP connections, the queue runner waits for these to finish before
4381 proceeding.
4382
4383 When all the queued messages have been considered, the original queue runner
4384 process terminates. In other words, a single pass is made over the waiting
4385 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4386 this to be repeated periodically.
4387
4388 Exim processes the waiting messages in an unpredictable order. It isn't very
4389 random, but it is likely to be different each time, which is all that matters.
4390 If one particular message screws up a remote MTA, other messages to the same
4391 MTA have a chance of getting through if they get tried first.
4392
4393 It is possible to cause the messages to be processed in lexical message id
4394 order, which is essentially the order in which they arrived, by setting the
4395 &%queue_run_in_order%& option, but this is not recommended for normal use.
4396
4397 .vitem &%-q%&<&'qflags'&>
4398 The &%-q%& option may be followed by one or more flag letters that change its
4399 behaviour. They are all optional, but if more than one is present, they must
4400 appear in the correct order. Each flag is described in a separate item below.
4401
4402 .vitem &%-qq...%&
4403 .oindex "&%-qq%&"
4404 .cindex "queue" "double scanning"
4405 .cindex "queue" "routing"
4406 .cindex "routing" "whole queue before delivery"
4407 An option starting with &%-qq%& requests a two-stage queue run. In the first
4408 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4409 every domain. Addresses are routed, local deliveries happen, but no remote
4410 transports are run.
4411
4412 .cindex "hints database" "remembering routing"
4413 The hints database that remembers which messages are waiting for specific hosts
4414 is updated, as if delivery to those hosts had been deferred. After this is
4415 complete, a second, normal queue scan happens, with routing and delivery taking
4416 place as normal. Messages that are routed to the same host should mostly be
4417 delivered down a single SMTP
4418 .cindex "SMTP" "passed connection"
4419 .cindex "SMTP" "multiple deliveries"
4420 .cindex "multiple SMTP deliveries"
4421 connection because of the hints that were set up during the first queue scan.
4422 This option may be useful for hosts that are connected to the Internet
4423 intermittently.
4424
4425 .vitem &%-q[q]i...%&
4426 .oindex "&%-qi%&"
4427 .cindex "queue" "initial delivery"
4428 If the &'i'& flag is present, the queue runner runs delivery processes only for
4429 those messages that haven't previously been tried. (&'i'& stands for &"initial
4430 delivery"&.) This can be helpful if you are putting messages on the queue using
4431 &%-odq%& and want a queue runner just to process the new messages.
4432
4433 .vitem &%-q[q][i]f...%&
4434 .oindex "&%-qf%&"
4435 .cindex "queue" "forcing delivery"
4436 .cindex "delivery" "forcing in queue run"
4437 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4438 message, whereas without &'f'& only those non-frozen addresses that have passed
4439 their retry times are tried.
4440
4441 .vitem &%-q[q][i]ff...%&
4442 .oindex "&%-qff%&"
4443 .cindex "frozen messages" "forcing delivery"
4444 If &'ff'& is present, a delivery attempt is forced for every message, whether
4445 frozen or not.
4446
4447 .vitem &%-q[q][i][f[f]]l%&
4448 .oindex "&%-ql%&"
4449 .cindex "queue" "local deliveries only"
4450 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4451 be done. If a message requires any remote deliveries, it remains on the queue
4452 for later delivery.
4453
4454 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4455 .cindex "queue" "delivering specific messages"
4456 When scanning the queue, Exim can be made to skip over messages whose ids are
4457 lexically less than a given value by following the &%-q%& option with a
4458 starting message id. For example:
4459 .code
4460 exim -q 0t5C6f-0000c8-00
4461 .endd
4462 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4463 second message id is given, messages whose ids are lexically greater than it
4464 are also skipped. If the same id is given twice, for example,
4465 .code
4466 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4467 .endd
4468 just one delivery process is started, for that message. This differs from
4469 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4470 that it counts as a delivery from a queue run. Note that the selection
4471 mechanism does not affect the order in which the messages are scanned. There
4472 are also other ways of selecting specific sets of messages for delivery in a
4473 queue run &-- see &%-R%& and &%-S%&.
4474
4475 .vitem &%-q%&<&'qflags'&><&'time'&>
4476 .cindex "queue runner" "starting periodically"
4477 .cindex "periodic queue running"
4478 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4479 starting a queue runner process at intervals specified by the given time value
4480 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4481 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4482 single daemon process handles both functions. A common way of starting up a
4483 combined daemon at system boot time is to use a command such as
4484 .code
4485 /usr/exim/bin/exim -bd -q30m
4486 .endd
4487 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4488 process every 30 minutes.
4489
4490 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4491 pid file is written unless one is explicitly requested by the &%-oP%& option.
4492
4493 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4494 .oindex "&%-qR%&"
4495 This option is synonymous with &%-R%&. It is provided for Sendmail
4496 compatibility.
4497
4498 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4499 .oindex "&%-qS%&"
4500 This option is synonymous with &%-S%&.
4501
4502 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4503 .oindex "&%-R%&"
4504 .cindex "queue runner" "for specific recipients"
4505 .cindex "delivery" "to given domain"
4506 .cindex "domain" "delivery to"
4507 The <&'rsflags'&> may be empty, in which case the white space before the string
4508 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4509 which are the possible values for <&'rsflags'&>. White space is required if
4510 <&'rsflags'&> is not empty.
4511
4512 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4513 perform a single queue run, except that, when scanning the messages on the
4514 queue, Exim processes only those that have at least one undelivered recipient
4515 address containing the given string, which is checked in a case-independent
4516 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4517 regular expression; otherwise it is a literal string.
4518
4519 If you want to do periodic queue runs for messages with specific recipients,
4520 you can combine &%-R%& with &%-q%& and a time value. For example:
4521 .code
4522 exim -q25m -R @special.domain.example
4523 .endd
4524 This example does a queue run for messages with recipients in the given domain
4525 every 25 minutes. Any additional flags that are specified with &%-q%& are
4526 applied to each queue run.
4527
4528 Once a message is selected for delivery by this mechanism, all its addresses
4529 are processed. For the first selected message, Exim overrides any retry
4530 information and forces a delivery attempt for each undelivered address. This
4531 means that if delivery of any address in the first message is successful, any
4532 existing retry information is deleted, and so delivery attempts for that
4533 address in subsequently selected messages (which are processed without forcing)
4534 will run. However, if delivery of any address does not succeed, the retry
4535 information is updated, and in subsequently selected messages, the failing
4536 address will be skipped.
4537
4538 .cindex "frozen messages" "forcing delivery"
4539 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4540 all selected messages, not just the first; frozen messages are included when
4541 &'ff'& is present.
4542
4543 The &%-R%& option makes it straightforward to initiate delivery of all messages
4544 to a given domain after a host has been down for some time. When the SMTP
4545 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4546 effect is to run Exim with the &%-R%& option, but it can be configured to run
4547 an arbitrary command instead.
4548
4549 .vitem &%-r%&
4550 .oindex "&%-r%&"
4551 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4552
4553 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4554 .oindex "&%-S%&"
4555 .cindex "delivery" "from given sender"
4556 .cindex "queue runner" "for specific senders"
4557 This option acts like &%-R%& except that it checks the string against each
4558 message's sender instead of against the recipients. If &%-R%& is also set, both
4559 conditions must be met for a message to be selected. If either of the options
4560 has &'f'& or &'ff'& in its flags, the associated action is taken.
4561
4562 .vitem &%-Tqt%&&~<&'times'&>
4563 .oindex "&%-Tqt%&"
4564 This is an option that is exclusively for use by the Exim testing suite. It is not
4565 recognized when Exim is run normally. It allows for the setting up of explicit
4566 &"queue times"& so that various warning/retry features can be tested.
4567
4568 .vitem &%-t%&
4569 .oindex "&%-t%&"
4570 .cindex "recipient" "extracting from header lines"
4571 .cindex "&'Bcc:'& header line"
4572 .cindex "&'Cc:'& header line"
4573 .cindex "&'To:'& header line"
4574 When Exim is receiving a locally-generated, non-SMTP message on its standard
4575 input, the &%-t%& option causes the recipients of the message to be obtained
4576 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4577 from the command arguments. The addresses are extracted before any rewriting
4578 takes place and the &'Bcc:'& header line, if present, is then removed.
4579
4580 .cindex "Sendmail compatibility" "&%-t%& option"
4581 If the command has any arguments, they specify addresses to which the message
4582 is &'not'& to be delivered. That is, the argument addresses are removed from
4583 the recipients list obtained from the headers. This is compatible with Smail 3
4584 and in accordance with the documented behaviour of several versions of
4585 Sendmail, as described in man pages on a number of operating systems (e.g.
4586 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4587 argument addresses to those obtained from the headers, and the O'Reilly
4588 Sendmail book documents it that way. Exim can be made to add argument addresses
4589 instead of subtracting them by setting the option
4590 &%extract_addresses_remove_arguments%& false.
4591
4592 .cindex "&%Resent-%& header lines" "with &%-t%&"
4593 If there are any &%Resent-%& header lines in the message, Exim extracts
4594 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4595 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4596 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4597 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4598
4599 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4600 message is resent several times). The RFC also specifies that they should be
4601 added at the front of the message, and separated by &'Received:'& lines. It is
4602 not at all clear how &%-t%& should operate in the present of multiple sets,
4603 nor indeed exactly what constitutes a &"set"&.
4604 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4605 are often added at the end of the header, and if a message is resent more than
4606 once, it is common for the original set of &%Resent-%& headers to be renamed as
4607 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4608
4609 .vitem &%-ti%&
4610 .oindex "&%-ti%&"
4611 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4612 compatibility with Sendmail.
4613
4614 .vitem &%-tls-on-connect%&
4615 .oindex "&%-tls-on-connect%&"
4616 .cindex "TLS" "use without STARTTLS"
4617 .cindex "TLS" "automatic start"
4618 This option is available when Exim is compiled with TLS support. It forces all
4619 incoming SMTP connections to behave as if the incoming port is listed in the
4620 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4621 &<<CHAPTLS>>& for further details.
4622
4623
4624 .vitem &%-U%&
4625 .oindex "&%-U%&"
4626 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4627 Sendmail uses this option for &"initial message submission"&, and its
4628 documentation states that in future releases, it may complain about
4629 syntactically invalid messages rather than fixing them when this flag is not
4630 set. Exim ignores this option.
4631
4632 .vitem &%-v%&
4633 .oindex "&%-v%&"
4634 This option causes Exim to write information to the standard error stream,
4635 describing what it is doing. In particular, it shows the log lines for
4636 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4637 dialogue is shown. Some of the log lines shown may not actually be written to
4638 the log if the setting of &%log_selector%& discards them. Any relevant
4639 selectors are shown with each log line. If none are shown, the logging is
4640 unconditional.
4641
4642 .vitem &%-x%&
4643 .oindex "&%-x%&"
4644 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4645 National Language Support extended characters in the body of the mail item"&).
4646 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4647 this option.
4648
4649 .vitem &%-X%&&~<&'logfile'&>
4650 .oindex "&%-X%&"
4651 This option is interpreted by Sendmail to cause debug information to be sent
4652 to the named file.  It is ignored by Exim.
4653
4654 .vitem &%-z%&&~<&'log-line'&>
4655 .oindex "&%-z%&"
4656 This option writes its argument to Exim's logfile.
4657 Use is restricted to administrators; the intent is for operational notes.
4658 Quotes should be used to maintain a multi-word item as a single argument,
4659 under most shells.
4660 .endlist
4661
4662 .ecindex IIDclo1
4663 .ecindex IIDclo2
4664
4665
4666 . ////////////////////////////////////////////////////////////////////////////
4667 . Insert a stylized DocBook comment here, to identify the end of the command
4668 . line options. This is for the benefit of the Perl script that automatically
4669 . creates a man page for the options.
4670 . ////////////////////////////////////////////////////////////////////////////
4671
4672 .literal xml
4673 <!-- === End of command line options === -->
4674 .literal off
4675
4676
4677
4678
4679
4680 . ////////////////////////////////////////////////////////////////////////////
4681 . ////////////////////////////////////////////////////////////////////////////
4682
4683
4684 .chapter "The Exim run time configuration file" "CHAPconf" &&&
4685          "The runtime configuration file"
4686
4687 .cindex "run time configuration"
4688 .cindex "configuration file" "general description"
4689 .cindex "CONFIGURE_FILE"
4690 .cindex "configuration file" "errors in"
4691 .cindex "error" "in configuration file"
4692 .cindex "return code" "for bad configuration"
4693 Exim uses a single run time configuration file that is read whenever an Exim
4694 binary is executed. Note that in normal operation, this happens frequently,
4695 because Exim is designed to operate in a distributed manner, without central
4696 control.
4697
4698 If a syntax error is detected while reading the configuration file, Exim
4699 writes a message on the standard error, and exits with a non-zero return code.
4700 The message is also written to the panic log. &*Note*&: Only simple syntax
4701 errors can be detected at this time. The values of any expanded options are
4702 not checked until the expansion happens, even when the expansion does not
4703 actually alter the string.
4704
4705 The name of the configuration file is compiled into the binary for security
4706 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4707 most configurations, this specifies a single file. However, it is permitted to
4708 give a colon-separated list of file names, in which case Exim uses the first
4709 existing file in the list.
4710
4711 .cindex "EXIM_USER"
4712 .cindex "EXIM_GROUP"
4713 .cindex "CONFIGURE_OWNER"
4714 .cindex "CONFIGURE_GROUP"
4715 .cindex "configuration file" "ownership"
4716 .cindex "ownership" "configuration file"
4717 The run time configuration file must be owned by root or by the user that is
4718 specified at compile time by the CONFIGURE_OWNER option (if set). The
4719 configuration file must not be world-writeable, or group-writeable unless its
4720 group is the root group or the one specified at compile time by the
4721 CONFIGURE_GROUP option.
4722
4723 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4724 to root, anybody who is able to edit the run time configuration file has an
4725 easy way to run commands as root. If you specify a user or group in the
4726 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4727 who are members of that group will trivially be able to obtain root privileges.
4728
4729 Up to Exim version 4.72, the run time configuration file was also permitted to
4730 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4731 since it offered a simple privilege escalation for any attacker who managed to
4732 compromise the Exim user account.
4733
4734 A default configuration file, which will work correctly in simple situations,
4735 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4736 defines just one file name, the installation process copies the default
4737 configuration to a new file of that name if it did not previously exist. If
4738 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4739 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4740 configuration.
4741
4742
4743
4744 .section "Using a different configuration file" "SECID40"
4745 .cindex "configuration file" "alternate"
4746 A one-off alternate configuration can be specified by the &%-C%& command line
4747 option, which may specify a single file or a list of files. However, when
4748 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4749 unless the argument for &%-C%& is identical to the built-in value from
4750 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4751 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4752 is useful mainly for checking the syntax of configuration files before
4753 installing them. No owner or group checks are done on a configuration file
4754 specified by &%-C%&, if root privilege has been dropped.
4755
4756 Even the Exim user is not trusted to specify an arbitrary configuration file
4757 with the &%-C%& option to be used with root privileges, unless that file is
4758 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4759 testing a configuration using &%-C%& right through message reception and
4760 delivery, even if the caller is root. The reception works, but by that time,
4761 Exim is running as the Exim user, so when it re-execs to regain privilege for
4762 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4763 can test reception and delivery using two separate commands (one to put a
4764 message on the queue, using &%-odq%&, and another to do the delivery, using
4765 &%-M%&).
4766
4767 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4768 prefix string with which any file named in a &%-C%& command line option must
4769 start. In addition, the file name must not contain the sequence &"&`/../`&"&.
4770 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any file
4771 name can be used with &%-C%&.
4772
4773 One-off changes to a configuration can be specified by the &%-D%& command line
4774 option, which defines and overrides values for macros used inside the
4775 configuration file. However, like &%-C%&, the use of this option by a
4776 non-privileged user causes Exim to discard its root privilege.
4777 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4778 completely disabled, and its use causes an immediate error exit.
4779
4780 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4781 to declare certain macro names trusted, such that root privilege will not
4782 necessarily be discarded.
4783 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4784 considered safe and, if &%-D%& only supplies macros from this list, and the
4785 values are acceptable, then Exim will not give up root privilege if the caller
4786 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4787 transition mechanism and is expected to be removed in the future.  Acceptable
4788 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4789
4790 Some sites may wish to use the same Exim binary on different machines that
4791 share a file system, but to use different configuration files on each machine.
4792 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4793 looks for a file whose name is the configuration file name followed by a dot
4794 and the machine's node name, as obtained from the &[uname()]& function. If this
4795 file does not exist, the standard name is tried. This processing occurs for
4796 each file name in the list given by CONFIGURE_FILE or &%-C%&.
4797
4798 In some esoteric situations different versions of Exim may be run under
4799 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4800 help with this. See the comments in &_src/EDITME_& for details.
4801
4802
4803
4804 .section "Configuration file format" "SECTconffilfor"
4805 .cindex "configuration file" "format of"
4806 .cindex "format" "configuration file"
4807 Exim's configuration file is divided into a number of different parts. General
4808 option settings must always appear at the start of the file. The other parts
4809 are all optional, and may appear in any order. Each part other than the first
4810 is introduced by the word &"begin"& followed by at least one literal
4811 space, and the name of the part. The optional parts are:
4812
4813 .ilist
4814 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4815 &<<CHAPACL>>&).
4816 .next
4817 .cindex "AUTH" "configuration"
4818 &'authenticators'&: Configuration settings for the authenticator drivers. These
4819 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4820 .next
4821 &'routers'&: Configuration settings for the router drivers. Routers process
4822 addresses and determine how the message is to be delivered (see chapters
4823 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4824 .next
4825 &'transports'&: Configuration settings for the transport drivers. Transports
4826 define mechanisms for copying messages to destinations (see chapters
4827 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4828 .next
4829 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4830 If there is no retry section, or if it is empty (that is, no retry rules are
4831 defined), Exim will not retry deliveries. In this situation, temporary errors
4832 are treated the same as permanent errors. Retry rules are discussed in chapter
4833 &<<CHAPretry>>&.
4834 .next
4835 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4836 when new addresses are generated during delivery. Rewriting is discussed in
4837 chapter &<<CHAPrewrite>>&.
4838 .next
4839 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4840 want to use this feature, you must set
4841 .code
4842 LOCAL_SCAN_HAS_OPTIONS=yes
4843 .endd
4844 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4845 facility are given in chapter &<<CHAPlocalscan>>&.
4846 .endlist
4847
4848 .cindex "configuration file" "leading white space in"
4849 .cindex "configuration file" "trailing white space in"
4850 .cindex "white space" "in configuration file"
4851 Leading and trailing white space in configuration lines is always ignored.
4852
4853 Blank lines in the file, and lines starting with a # character (ignoring
4854 leading white space) are treated as comments and are ignored. &*Note*&: A
4855 # character other than at the beginning of a line is not treated specially,
4856 and does not introduce a comment.
4857
4858 Any non-comment line can be continued by ending it with a backslash. Note that
4859 the general rule for white space means that trailing white space after the
4860 backslash and leading white space at the start of continuation
4861 lines is ignored. Comment lines beginning with # (but not empty lines) may
4862 appear in the middle of a sequence of continuation lines.
4863
4864 A convenient way to create a configuration file is to start from the
4865 default, which is supplied in &_src/configure.default_&, and add, delete, or
4866 change settings as required.
4867
4868 The ACLs, retry rules, and rewriting rules have their own syntax which is
4869 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
4870 respectively. The other parts of the configuration file have some syntactic
4871 items in common, and these are described below, from section &<<SECTcos>>&
4872 onwards. Before that, the inclusion, macro, and conditional facilities are
4873 described.
4874
4875
4876
4877 .section "File inclusions in the configuration file" "SECID41"
4878 .cindex "inclusions in configuration file"
4879 .cindex "configuration file" "including other files"
4880 .cindex "&`.include`& in configuration file"
4881 .cindex "&`.include_if_exists`& in configuration file"
4882 You can include other files inside Exim's run time configuration file by
4883 using this syntax:
4884 .display
4885 &`.include`& <&'file name'&>
4886 &`.include_if_exists`& <&'file name'&>
4887 .endd
4888 on a line by itself. Double quotes round the file name are optional. If you use
4889 the first form, a configuration error occurs if the file does not exist; the
4890 second form does nothing for non-existent files. In all cases, an absolute file
4891 name is required.
4892
4893 Includes may be nested to any depth, but remember that Exim reads its
4894 configuration file often, so it is a good idea to keep them to a minimum.
4895 If you change the contents of an included file, you must HUP the daemon,
4896 because an included file is read only when the configuration itself is read.
4897
4898 The processing of inclusions happens early, at a physical line level, so, like
4899 comment lines, an inclusion can be used in the middle of an option setting,
4900 for example:
4901 .code
4902 hosts_lookup = a.b.c \
4903                .include /some/file
4904 .endd
4905 Include processing happens after macro processing (see below). Its effect is to
4906 process the lines of the included file as if they occurred inline where the
4907 inclusion appears.
4908
4909
4910
4911 .section "Macros in the configuration file" "SECTmacrodefs"
4912 .cindex "macro" "description of"
4913 .cindex "configuration file" "macros"
4914 If a line in the main part of the configuration (that is, before the first
4915 &"begin"& line) begins with an upper case letter, it is taken as a macro
4916 definition, and must be of the form
4917 .display
4918 <&'name'&> = <&'rest of line'&>
4919 .endd
4920 The name must consist of letters, digits, and underscores, and need not all be
4921 in upper case, though that is recommended. The rest of the line, including any
4922 continuations, is the replacement text, and has leading and trailing white
4923 space removed. Quotes are not removed. The replacement text can never end with
4924 a backslash character, but this doesn't seem to be a serious limitation.
4925
4926 Macros may also be defined between router, transport, authenticator, or ACL
4927 definitions. They may not, however, be defined within an individual driver or
4928 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
4929
4930 .section "Macro substitution" "SECID42"
4931 Once a macro is defined, all subsequent lines in the file (and any included
4932 files) are scanned for the macro name; if there are several macros, the line is
4933 scanned for each in turn, in the order in which the macros are defined. The
4934 replacement text is not re-scanned for the current macro, though it is scanned
4935 for subsequently defined macros. For this reason, a macro name may not contain
4936 the name of a previously defined macro as a substring. You could, for example,
4937 define
4938 .display
4939 &`ABCD_XYZ = `&<&'something'&>
4940 &`ABCD = `&<&'something else'&>
4941 .endd
4942 but putting the definitions in the opposite order would provoke a configuration
4943 error. Macro expansion is applied to individual physical lines from the file,
4944 before checking for line continuation or file inclusion (see above). If a line
4945 consists solely of a macro name, and the expansion of the macro is empty, the
4946 line is ignored. A macro at the start of a line may turn the line into a
4947 comment line or a &`.include`& line.
4948
4949
4950 .section "Redefining macros" "SECID43"
4951 Once defined, the value of a macro can be redefined later in the configuration
4952 (or in an included file). Redefinition is specified by using &'=='& instead of
4953 &'='&. For example:
4954 .code
4955 MAC =  initial value
4956 ...
4957 MAC == updated value
4958 .endd
4959 Redefinition does not alter the order in which the macros are applied to the
4960 subsequent lines of the configuration file. It is still the same order in which
4961 the macros were originally defined. All that changes is the macro's value.
4962 Redefinition makes it possible to accumulate values. For example:
4963 .code
4964 MAC =  initial value
4965 ...
4966 MAC == MAC and something added
4967 .endd
4968 This can be helpful in situations where the configuration file is built
4969 from a number of other files.
4970
4971 .section "Overriding macro values" "SECID44"
4972 The values set for macros in the configuration file can be overridden by the
4973 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
4974 used, unless called by root or the Exim user. A definition on the command line
4975 using the &%-D%& option causes all definitions and redefinitions within the
4976 file to be ignored.
4977
4978
4979
4980 .section "Example of macro usage" "SECID45"
4981 As an example of macro usage, consider a configuration where aliases are looked
4982 up in a MySQL database. It helps to keep the file less cluttered if long
4983 strings such as SQL statements are defined separately as macros, for example:
4984 .code
4985 ALIAS_QUERY = select mailbox from user where \
4986               login='${quote_mysql:$local_part}';
4987 .endd
4988 This can then be used in a &(redirect)& router setting like this:
4989 .code
4990 data = ${lookup mysql{ALIAS_QUERY}}
4991 .endd
4992 In earlier versions of Exim macros were sometimes used for domain, host, or
4993 address lists. In Exim 4 these are handled better by named lists &-- see
4994 section &<<SECTnamedlists>>&.
4995
4996
4997 .section "Conditional skips in the configuration file" "SECID46"
4998 .cindex "configuration file" "conditional skips"
4999 .cindex "&`.ifdef`&"
5000 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
5001 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
5002 portions of the configuration file. The processing happens whenever the file is
5003 read (that is, when an Exim binary starts to run).
5004
5005 The implementation is very simple. Instances of the first four directives must
5006 be followed by text that includes the names of one or macros. The condition
5007 that is tested is whether or not any macro substitution has taken place in the
5008 line. Thus:
5009 .code
5010 .ifdef AAA
5011 message_size_limit = 50M
5012 .else
5013 message_size_limit = 100M
5014 .endif
5015 .endd
5016 sets a message size limit of 50M if the macro &`AAA`& is defined
5017 (or &`A`& or &`AA`&), and 100M
5018 otherwise. If there is more than one macro named on the line, the condition
5019 is true if any of them are defined. That is, it is an &"or"& condition. To
5020 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
5021
5022 Although you can use a macro expansion to generate one of these directives,
5023 it is not very useful, because the condition &"there was a macro substitution
5024 in this line"& will always be true.
5025
5026 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
5027 to clarify complicated nestings.
5028
5029
5030
5031 .section "Common option syntax" "SECTcos"
5032 .cindex "common option syntax"
5033 .cindex "syntax of common options"
5034 .cindex "configuration file" "common option syntax"
5035 For the main set of options, driver options, and &[local_scan()]& options,
5036 each setting is on a line by itself, and starts with a name consisting of
5037 lower-case letters and underscores. Many options require a data value, and in
5038 these cases the name must be followed by an equals sign (with optional white
5039 space) and then the value. For example:
5040 .code
5041 qualify_domain = mydomain.example.com
5042 .endd
5043 .cindex "hiding configuration option values"
5044 .cindex "configuration options" "hiding value of"
5045 .cindex "options" "hiding value of"
5046 Some option settings may contain sensitive data, for example, passwords for
5047 accessing databases. To stop non-admin users from using the &%-bP%& command
5048 line option to read these values, you can precede the option settings with the
5049 word &"hide"&. For example:
5050 .code
5051 hide mysql_servers = localhost/users/admin/secret-password
5052 .endd
5053 For non-admin users, such options are displayed like this:
5054 .code
5055 mysql_servers = <value not displayable>
5056 .endd
5057 If &"hide"& is used on a driver option, it hides the value of that option on
5058 all instances of the same driver.
5059
5060 The following sections describe the syntax used for the different data types
5061 that are found in option settings.
5062
5063
5064 .section "Boolean options" "SECID47"
5065 .cindex "format" "boolean"
5066 .cindex "boolean configuration values"
5067 .oindex "&%no_%&&'xxx'&"
5068 .oindex "&%not_%&&'xxx'&"
5069 Options whose type is given as boolean are on/off switches. There are two
5070 different ways of specifying such options: with and without a data value. If
5071 the option name is specified on its own without data, the switch is turned on;
5072 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5073 boolean options may be followed by an equals sign and one of the words
5074 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5075 the following two settings have exactly the same effect:
5076 .code
5077 queue_only
5078 queue_only = true
5079 .endd
5080 The following two lines also have the same (opposite) effect:
5081 .code
5082 no_queue_only
5083 queue_only = false
5084 .endd
5085 You can use whichever syntax you prefer.
5086
5087
5088
5089
5090 .section "Integer values" "SECID48"
5091 .cindex "integer configuration values"
5092 .cindex "format" "integer"
5093 If an option's type is given as &"integer"&, the value can be given in decimal,
5094 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5095 number is assumed. Otherwise, it is treated as an octal number unless it starts
5096 with the characters &"0x"&, in which case the remainder is interpreted as a
5097 hexadecimal number.
5098
5099 If an integer value is followed by the letter K, it is multiplied by 1024; if
5100 it is followed by the letter M, it is multiplied by 1024x1024. When the values
5101 of integer option settings are output, values which are an exact multiple of
5102 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5103 and M. The printing style is independent of the actual input format that was
5104 used.
5105
5106
5107 .section "Octal integer values" "SECID49"
5108 .cindex "integer format"
5109 .cindex "format" "octal integer"
5110 If an option's type is given as &"octal integer"&, its value is always
5111 interpreted as an octal number, whether or not it starts with the digit zero.
5112 Such options are always output in octal.
5113
5114
5115 .section "Fixed point numbers" "SECID50"
5116 .cindex "fixed point configuration values"
5117 .cindex "format" "fixed point"
5118 If an option's type is given as &"fixed-point"&, its value must be a decimal
5119 integer, optionally followed by a decimal point and up to three further digits.
5120
5121
5122
5123 .section "Time intervals" "SECTtimeformat"
5124 .cindex "time interval" "specifying in configuration"
5125 .cindex "format" "time interval"
5126 A time interval is specified as a sequence of numbers, each followed by one of
5127 the following letters, with no intervening white space:
5128
5129 .table2 30pt
5130 .irow &%s%& seconds
5131 .irow &%m%& minutes
5132 .irow &%h%& hours
5133 .irow &%d%& days
5134 .irow &%w%& weeks
5135 .endtable
5136
5137 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5138 intervals are output in the same format. Exim does not restrict the values; it
5139 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5140
5141
5142
5143 .section "String values" "SECTstrings"
5144 .cindex "string" "format of configuration values"
5145 .cindex "format" "string"
5146 If an option's type is specified as &"string"&, the value can be specified with
5147 or without double-quotes. If it does not start with a double-quote, the value
5148 consists of the remainder of the line plus any continuation lines, starting at
5149 the first character after any leading white space, with trailing white space
5150 removed, and with no interpretation of the characters in the string. Because
5151 Exim removes comment lines (those beginning with #) at an early stage, they can
5152 appear in the middle of a multi-line string. The following two settings are
5153 therefore equivalent:
5154 .code
5155 trusted_users = uucp:mail
5156 trusted_users = uucp:\
5157                 # This comment line is ignored
5158                 mail
5159 .endd
5160 .cindex "string" "quoted"
5161 .cindex "escape characters in quoted strings"
5162 If a string does start with a double-quote, it must end with a closing
5163 double-quote, and any backslash characters other than those used for line
5164 continuation are interpreted as escape characters, as follows:
5165
5166 .table2 100pt
5167 .irow &`\\`&                     "single backslash"
5168 .irow &`\n`&                     "newline"
5169 .irow &`\r`&                     "carriage return"
5170 .irow &`\t`&                     "tab"
5171 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5172 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5173                                    character"
5174 .endtable
5175
5176 If a backslash is followed by some other character, including a double-quote
5177 character, that character replaces the pair.
5178
5179 Quoting is necessary only if you want to make use of the backslash escapes to
5180 insert special characters, or if you need to specify a value with leading or
5181 trailing spaces. These cases are rare, so quoting is almost never needed in
5182 current versions of Exim. In versions of Exim before 3.14, quoting was required
5183 in order to continue lines, so you may come across older configuration files
5184 and examples that apparently quote unnecessarily.
5185
5186
5187 .section "Expanded strings" "SECID51"
5188 .cindex "expansion" "definition of"
5189 Some strings in the configuration file are subjected to &'string expansion'&,
5190 by which means various parts of the string may be changed according to the
5191 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5192 is as just described; in particular, the handling of backslashes in quoted
5193 strings is done as part of the input process, before expansion takes place.
5194 However, backslash is also an escape character for the expander, so any
5195 backslashes that are required for that reason must be doubled if they are
5196 within a quoted configuration string.
5197
5198
5199 .section "User and group names" "SECID52"
5200 .cindex "user name" "format of"
5201 .cindex "format" "user name"
5202 .cindex "groups" "name format"
5203 .cindex "format" "group name"
5204 User and group names are specified as strings, using the syntax described
5205 above, but the strings are interpreted specially. A user or group name must
5206 either consist entirely of digits, or be a name that can be looked up using the
5207 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5208
5209
5210 .section "List construction" "SECTlistconstruct"
5211 .cindex "list" "syntax of in configuration"
5212 .cindex "format" "list item in configuration"
5213 .cindex "string" "list, definition of"
5214 The data for some configuration options is a list of items, with colon as the
5215 default separator. Many of these options are shown with type &"string list"& in
5216 the descriptions later in this document. Others are listed as &"domain list"&,
5217 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5218 are all the same; however, those other than &"string list"& are subject to
5219 particular kinds of interpretation, as described in chapter
5220 &<<CHAPdomhosaddlists>>&.
5221
5222 In all these cases, the entire list is treated as a single string as far as the
5223 input syntax is concerned. The &%trusted_users%& setting in section
5224 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5225 in a list, it must be entered as two colons. Leading and trailing white space
5226 on each item in a list is ignored. This makes it possible to include items that
5227 start with a colon, and in particular, certain forms of IPv6 address. For
5228 example, the list
5229 .code
5230 local_interfaces = 127.0.0.1 : ::::1
5231 .endd
5232 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5233
5234 &*Note*&: Although leading and trailing white space is ignored in individual
5235 list items, it is not ignored when parsing the list. The space after the first
5236 colon in the example above is necessary. If it were not there, the list would
5237 be interpreted as the two items 127.0.0.1:: and 1.
5238
5239 .section "Changing list separators" "SECTlistsepchange"
5240 .cindex "list separator" "changing"
5241 .cindex "IPv6" "addresses in lists"
5242 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5243 introduced to allow the separator character to be changed. If a list begins
5244 with a left angle bracket, followed by any punctuation character, that
5245 character is used instead of colon as the list separator. For example, the list
5246 above can be rewritten to use a semicolon separator like this:
5247 .code
5248 local_interfaces = <; 127.0.0.1 ; ::1
5249 .endd
5250 This facility applies to all lists, with the exception of the list in
5251 &%log_file_path%&. It is recommended that the use of non-colon separators be
5252 confined to circumstances where they really are needed.
5253
5254 .cindex "list separator" "newline as"
5255 .cindex "newline" "as list separator"
5256 It is also possible to use newline and other control characters (those with
5257 code values less than 32, plus DEL) as separators in lists. Such separators
5258 must be provided literally at the time the list is processed. For options that
5259 are string-expanded, you can write the separator using a normal escape
5260 sequence. This will be processed by the expander before the string is
5261 interpreted as a list. For example, if a newline-separated list of domains is
5262 generated by a lookup, you can process it directly by a line such as this:
5263 .code
5264 domains = <\n ${lookup mysql{.....}}
5265 .endd
5266 This avoids having to change the list separator in such data. You are unlikely
5267 to want to use a control character as a separator in an option that is not
5268 expanded, because the value is literal text. However, it can be done by giving
5269 the value in quotes. For example:
5270 .code
5271 local_interfaces = "<\n 127.0.0.1 \n ::1"
5272 .endd
5273 Unlike printing character separators, which can be included in list items by
5274 doubling, it is not possible to include a control character as data when it is
5275 set as the separator. Two such characters in succession are interpreted as
5276 enclosing an empty list item.
5277
5278
5279
5280 .section "Empty items in lists" "SECTempitelis"
5281 .cindex "list" "empty item in"
5282 An empty item at the end of a list is always ignored. In other words, trailing
5283 separator characters are ignored. Thus, the list in
5284 .code
5285 senders = user@domain :
5286 .endd
5287 contains only a single item. If you want to include an empty string as one item
5288 in a list, it must not be the last item. For example, this list contains three
5289 items, the second of which is empty:
5290 .code
5291 senders = user1@domain : : user2@domain
5292 .endd
5293 &*Note*&: There must be white space between the two colons, as otherwise they
5294 are interpreted as representing a single colon data character (and the list
5295 would then contain just one item). If you want to specify a list that contains
5296 just one, empty item, you can do it as in this example:
5297 .code
5298 senders = :
5299 .endd
5300 In this case, the first item is empty, and the second is discarded because it
5301 is at the end of the list.
5302
5303
5304
5305
5306 .section "Format of driver configurations" "SECTfordricon"
5307 .cindex "drivers" "configuration format"
5308 There are separate parts in the configuration for defining routers, transports,
5309 and authenticators. In each part, you are defining a number of driver
5310 instances, each with its own set of options. Each driver instance is defined by
5311 a sequence of lines like this:
5312 .display
5313 <&'instance name'&>:
5314   <&'option'&>
5315   ...
5316   <&'option'&>
5317 .endd
5318 In the following example, the instance name is &(localuser)&, and it is
5319 followed by three options settings:
5320 .code
5321 localuser:
5322   driver = accept
5323   check_local_user
5324   transport = local_delivery
5325 .endd
5326 For each driver instance, you specify which Exim code module it uses &-- by the
5327 setting of the &%driver%& option &-- and (optionally) some configuration
5328 settings. For example, in the case of transports, if you want a transport to
5329 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5330 a local file you would use the &(appendfile)& driver. Each of the drivers is
5331 described in detail in its own separate chapter later in this manual.
5332
5333 You can have several routers, transports, or authenticators that are based on
5334 the same underlying driver (each must have a different instance name).
5335
5336 The order in which routers are defined is important, because addresses are
5337 passed to individual routers one by one, in order. The order in which
5338 transports are defined does not matter at all. The order in which
5339 authenticators are defined is used only when Exim, as a client, is searching
5340 them to find one that matches an authentication mechanism offered by the
5341 server.
5342
5343 .cindex "generic options"
5344 .cindex "options" "generic &-- definition of"
5345 Within a driver instance definition, there are two kinds of option: &'generic'&
5346 and &'private'&. The generic options are those that apply to all drivers of the
5347 same type (that is, all routers, all transports or all authenticators). The
5348 &%driver%& option is a generic option that must appear in every definition.
5349 .cindex "private options"
5350 The private options are special for each driver, and none need appear, because
5351 they all have default values.
5352
5353 The options may appear in any order, except that the &%driver%& option must
5354 precede any private options, since these depend on the particular driver. For
5355 this reason, it is recommended that &%driver%& always be the first option.
5356
5357 Driver instance names, which are used for reference in log entries and
5358 elsewhere, can be any sequence of letters, digits, and underscores (starting
5359 with a letter) and must be unique among drivers of the same type. A router and
5360 a transport (for example) can each have the same name, but no two router
5361 instances can have the same name. The name of a driver instance should not be
5362 confused with the name of the underlying driver module. For example, the
5363 configuration lines:
5364 .code
5365 remote_smtp:
5366   driver = smtp
5367 .endd
5368 create an instance of the &(smtp)& transport driver whose name is
5369 &(remote_smtp)&. The same driver code can be used more than once, with
5370 different instance names and different option settings each time. A second
5371 instance of the &(smtp)& transport, with different options, might be defined
5372 thus:
5373 .code
5374 special_smtp:
5375   driver = smtp
5376   port = 1234
5377   command_timeout = 10s
5378 .endd
5379 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5380 these transport instances from routers, and these names would appear in log
5381 lines.
5382
5383 Comment lines may be present in the middle of driver specifications. The full
5384 list of option settings for any particular driver instance, including all the
5385 defaulted values, can be extracted by making use of the &%-bP%& command line
5386 option.
5387
5388
5389
5390
5391
5392
5393 . ////////////////////////////////////////////////////////////////////////////
5394 . ////////////////////////////////////////////////////////////////////////////
5395
5396 .chapter "The default configuration file" "CHAPdefconfil"
5397 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5398 .cindex "default" "configuration file &""walk through""&"
5399 The default configuration file supplied with Exim as &_src/configure.default_&
5400 is sufficient for a host with simple mail requirements. As an introduction to
5401 the way Exim is configured, this chapter &"walks through"& the default
5402 configuration, giving brief explanations of the settings. Detailed descriptions
5403 of the options are given in subsequent chapters. The default configuration file
5404 itself contains extensive comments about ways you might want to modify the
5405 initial settings. However, note that there are many options that are not
5406 mentioned at all in the default configuration.
5407
5408
5409
5410 .section "Main configuration settings" "SECTdefconfmain"
5411 The main (global) configuration option settings must always come first in the
5412 file. The first thing you'll see in the file, after some initial comments, is
5413 the line
5414 .code
5415 # primary_hostname =
5416 .endd
5417 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5418 to know the official, fully qualified name of your host, and this is where you
5419 can specify it. However, in most cases you do not need to set this option. When
5420 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5421
5422 The first three non-comment configuration lines are as follows:
5423 .code
5424 domainlist local_domains    = @
5425 domainlist relay_to_domains =
5426 hostlist   relay_from_hosts = 127.0.0.1
5427 .endd
5428 These are not, in fact, option settings. They are definitions of two named
5429 domain lists and one named host list. Exim allows you to give names to lists of
5430 domains, hosts, and email addresses, in order to make it easier to manage the
5431 configuration file (see section &<<SECTnamedlists>>&).
5432
5433 The first line defines a domain list called &'local_domains'&; this is used
5434 later in the configuration to identify domains that are to be delivered
5435 on the local host.
5436
5437 .cindex "@ in a domain list"
5438 There is just one item in this list, the string &"@"&. This is a special form
5439 of entry which means &"the name of the local host"&. Thus, if the local host is
5440 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5441 be delivered locally. Because the local host's name is referenced indirectly,
5442 the same configuration file can be used on different hosts.
5443
5444 The second line defines a domain list called &'relay_to_domains'&, but the
5445 list itself is empty. Later in the configuration we will come to the part that
5446 controls mail relaying through the local host; it allows relaying to any
5447 domains in this list. By default, therefore, no relaying on the basis of a mail
5448 domain is permitted.
5449
5450 The third line defines a host list called &'relay_from_hosts'&. This list is
5451 used later in the configuration to permit relaying from any host or IP address
5452 that matches the list. The default contains just the IP address of the IPv4
5453 loopback interface, which means that processes on the local host are able to
5454 submit mail for relaying by sending it over TCP/IP to that interface. No other
5455 hosts are permitted to submit messages for relaying.
5456
5457 Just to be sure there's no misunderstanding: at this point in the configuration
5458 we aren't actually setting up any controls. We are just defining some domains
5459 and hosts that will be used in the controls that are specified later.
5460
5461 The next two configuration lines are genuine option settings:
5462 .code
5463 acl_smtp_rcpt = acl_check_rcpt
5464 acl_smtp_data = acl_check_data
5465 .endd
5466 These options specify &'Access Control Lists'& (ACLs) that are to be used
5467 during an incoming SMTP session for every recipient of a message (every RCPT
5468 command), and after the contents of the message have been received,
5469 respectively. The names of the lists are &'acl_check_rcpt'& and
5470 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5471 section of the configuration. The RCPT ACL controls which recipients are
5472 accepted for an incoming message &-- if a configuration does not provide an ACL
5473 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5474 contents of a message to be checked.
5475
5476 Two commented-out option settings are next:
5477 .code
5478 # av_scanner = clamd:/tmp/clamd
5479 # spamd_address = 127.0.0.1 783
5480 .endd
5481 These are example settings that can be used when Exim is compiled with the
5482 content-scanning extension. The first specifies the interface to the virus
5483 scanner, and the second specifies the interface to SpamAssassin. Further
5484 details are given in chapter &<<CHAPexiscan>>&.
5485
5486 Three more commented-out option settings follow:
5487 .code
5488 # tls_advertise_hosts = *
5489 # tls_certificate = /etc/ssl/exim.crt
5490 # tls_privatekey = /etc/ssl/exim.pem
5491 .endd
5492 These are example settings that can be used when Exim is compiled with
5493 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5494 first one specifies the list of clients that are allowed to use TLS when
5495 connecting to this server; in this case the wildcard means all clients. The
5496 other options specify where Exim should find its TLS certificate and private
5497 key, which together prove the server's identity to any clients that connect.
5498 More details are given in chapter &<<CHAPTLS>>&.
5499
5500 Another two commented-out option settings follow:
5501 .code
5502 # daemon_smtp_ports = 25 : 465 : 587
5503 # tls_on_connect_ports = 465
5504 .endd
5505 .cindex "port" "465 and 587"
5506 .cindex "port" "for message submission"
5507 .cindex "message" "submission, ports for"
5508 .cindex "ssmtp protocol"
5509 .cindex "smtps protocol"
5510 .cindex "SMTP" "ssmtp protocol"
5511 .cindex "SMTP" "smtps protocol"
5512 These options provide better support for roaming users who wish to use this
5513 server for message submission. They are not much use unless you have turned on
5514 TLS (as described in the previous paragraph) and authentication (about which
5515 more in section &<<SECTdefconfauth>>&). The usual SMTP port 25 is often blocked
5516 on end-user networks, so RFC 4409 specifies that message submission should use
5517 port 587 instead. However some software (notably Microsoft Outlook) cannot be
5518 configured to use port 587 correctly, so these settings also enable the
5519 non-standard &"smtps"& (aka &"ssmtp"&) port 465 (see section
5520 &<<SECTsupobssmt>>&).
5521
5522 Two more commented-out options settings follow:
5523 .code
5524 # qualify_domain =
5525 # qualify_recipient =
5526 .endd
5527 The first of these specifies a domain that Exim uses when it constructs a
5528 complete email address from a local login name. This is often needed when Exim
5529 receives a message from a local process. If you do not set &%qualify_domain%&,
5530 the value of &%primary_hostname%& is used. If you set both of these options,
5531 you can have different qualification domains for sender and recipient
5532 addresses. If you set only the first one, its value is used in both cases.
5533
5534 .cindex "domain literal" "recognizing format"
5535 The following line must be uncommented if you want Exim to recognize
5536 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5537 (an IP address within square brackets) instead of a named domain.
5538 .code
5539 # allow_domain_literals
5540 .endd
5541 The RFCs still require this form, but many people think that in the modern
5542 Internet it makes little sense to permit mail to be sent to specific hosts by
5543 quoting their IP addresses. This ancient format has been used by people who
5544 try to abuse hosts by using them for unwanted relaying. However, some
5545 people believe there are circumstances (for example, messages addressed to
5546 &'postmaster'&) where domain literals are still useful.
5547
5548 The next configuration line is a kind of trigger guard:
5549 .code
5550 never_users = root
5551 .endd
5552 It specifies that no delivery must ever be run as the root user. The normal
5553 convention is to set up &'root'& as an alias for the system administrator. This
5554 setting is a guard against slips in the configuration.
5555 The list of users specified by &%never_users%& is not, however, the complete
5556 list; the build-time configuration in &_Local/Makefile_& has an option called
5557 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5558 contents of &%never_users%& are added to this list. By default
5559 FIXED_NEVER_USERS also specifies root.
5560
5561 When a remote host connects to Exim in order to send mail, the only information
5562 Exim has about the host's identity is its IP address. The next configuration
5563 line,
5564 .code
5565 host_lookup = *
5566 .endd
5567 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5568 in order to get a host name. This improves the quality of the logging
5569 information, but if you feel it is too expensive, you can remove it entirely,
5570 or restrict the lookup to hosts on &"nearby"& networks.
5571 Note that it is not always possible to find a host name from an IP address,
5572 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5573 unreachable.
5574
5575 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5576 1413 (hence their names):
5577 .code
5578 rfc1413_hosts = *
5579 rfc1413_query_timeout = 0s
5580 .endd
5581 These settings cause Exim to avoid ident callbacks for all incoming SMTP calls.
5582 Few hosts offer RFC1413 service these days; calls have to be
5583 terminated by a timeout and this needlessly delays the startup
5584 of an incoming SMTP connection.
5585 If you have hosts for which you trust RFC1413 and need this
5586 information, you can change this.
5587
5588 This line enables an efficiency SMTP option.  It is negotiated by clients
5589 and not expected to cause problems but can be disabled if needed.
5590 .code
5591 prdr_enable = true
5592 .endd
5593
5594 When Exim receives messages over SMTP connections, it expects all addresses to
5595 be fully qualified with a domain, as required by the SMTP definition. However,
5596 if you are running a server to which simple clients submit messages, you may
5597 find that they send unqualified addresses. The two commented-out options:
5598 .code
5599 # sender_unqualified_hosts =
5600 # recipient_unqualified_hosts =
5601 .endd
5602 show how you can specify hosts that are permitted to send unqualified sender
5603 and recipient addresses, respectively.
5604
5605 The &%log_selector%& option is used to increase the detail of logging
5606 over the default:
5607 .code
5608 log_selector = +smtp_protocol_error +smtp_syntax_error \
5609                +tls_certificate_verified
5610 .endd
5611
5612 The &%percent_hack_domains%& option is also commented out:
5613 .code
5614 # percent_hack_domains =
5615 .endd
5616 It provides a list of domains for which the &"percent hack"& is to operate.
5617 This is an almost obsolete form of explicit email routing. If you do not know
5618 anything about it, you can safely ignore this topic.
5619
5620 The last two settings in the main part of the default configuration are
5621 concerned with messages that have been &"frozen"& on Exim's queue. When a
5622 message is frozen, Exim no longer continues to try to deliver it. Freezing
5623 occurs when a bounce message encounters a permanent failure because the sender
5624 address of the original message that caused the bounce is invalid, so the
5625 bounce cannot be delivered. This is probably the most common case, but there
5626 are also other conditions that cause freezing, and frozen messages are not
5627 always bounce messages.
5628 .code
5629 ignore_bounce_errors_after = 2d
5630 timeout_frozen_after = 7d
5631 .endd
5632 The first of these options specifies that failing bounce messages are to be
5633 discarded after 2 days on the queue. The second specifies that any frozen
5634 message (whether a bounce message or not) is to be timed out (and discarded)
5635 after a week. In this configuration, the first setting ensures that no failing
5636 bounce message ever lasts a week.
5637
5638
5639
5640 .section "ACL configuration" "SECID54"
5641 .cindex "default" "ACLs"
5642 .cindex "&ACL;" "default configuration"
5643 In the default configuration, the ACL section follows the main configuration.
5644 It starts with the line
5645 .code
5646 begin acl
5647 .endd
5648 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5649 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5650 and &%acl_smtp_data%& above.
5651
5652 .cindex "RCPT" "ACL for"
5653 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5654 RCPT command specifies one of the message's recipients. The ACL statements
5655 are considered in order, until the recipient address is either accepted or
5656 rejected. The RCPT command is then accepted or rejected, according to the
5657 result of the ACL processing.
5658 .code
5659 acl_check_rcpt:
5660 .endd
5661 This line, consisting of a name terminated by a colon, marks the start of the
5662 ACL, and names it.
5663 .code
5664 accept  hosts = :
5665 .endd
5666 This ACL statement accepts the recipient if the sending host matches the list.
5667 But what does that strange list mean? It doesn't actually contain any host
5668 names or IP addresses. The presence of the colon puts an empty item in the
5669 list; Exim matches this only if the incoming message did not come from a remote
5670 host, because in that case, the remote hostname is empty. The colon is
5671 important. Without it, the list itself is empty, and can never match anything.
5672
5673 What this statement is doing is to accept unconditionally all recipients in
5674 messages that are submitted by SMTP from local processes using the standard
5675 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5676 manner.
5677 .code
5678 deny    message       = Restricted characters in address
5679         domains       = +local_domains
5680         local_parts   = ^[.] : ^.*[@%!/|]
5681
5682 deny    message       = Restricted characters in address
5683         domains       = !+local_domains
5684         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5685 .endd
5686 These statements are concerned with local parts that contain any of the
5687 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5688 Although these characters are entirely legal in local parts (in the case of
5689 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5690 in Internet mail addresses.
5691
5692 The first three have in the past been associated with explicitly routed
5693 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5694 option). Addresses containing these characters are regularly tried by spammers
5695 in an attempt to bypass relaying restrictions, and also by open relay testing
5696 programs. Unless you really need them it is safest to reject these characters
5697 at this early stage. This configuration is heavy-handed in rejecting these
5698 characters for all messages it accepts from remote hosts. This is a deliberate
5699 policy of being as safe as possible.
5700
5701 The first rule above is stricter, and is applied to messages that are addressed
5702 to one of the local domains handled by this host. This is implemented by the
5703 first condition, which restricts it to domains that are listed in the
5704 &'local_domains'& domain list. The &"+"& character is used to indicate a
5705 reference to a named list. In this configuration, there is just one domain in
5706 &'local_domains'&, but in general there may be many.
5707
5708 The second condition on the first statement uses two regular expressions to
5709 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5710 or &"|"&. If you have local accounts that include these characters, you will
5711 have to modify this rule.
5712
5713 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5714 allows them because they have been encountered in practice. (Consider the
5715 common convention of local parts constructed as
5716 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5717 the author of Exim, who has no second initial.) However, a local part starting
5718 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5719 file name (for example, for a mailing list). This is also true for local parts
5720 that contain slashes. A pipe symbol can also be troublesome if the local part
5721 is incorporated unthinkingly into a shell command line.
5722
5723 The second rule above applies to all other domains, and is less strict. This
5724 allows your own users to send outgoing messages to sites that use slashes
5725 and vertical bars in their local parts. It blocks local parts that begin
5726 with a dot, slash, or vertical bar, but allows these characters within the
5727 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5728 and &"!"& is blocked, as before. The motivation here is to prevent your users
5729 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5730 .code
5731 accept  local_parts   = postmaster
5732         domains       = +local_domains
5733 .endd
5734 This statement, which has two conditions, accepts an incoming address if the
5735 local part is &'postmaster'& and the domain is one of those listed in the
5736 &'local_domains'& domain list. The &"+"& character is used to indicate a
5737 reference to a named list. In this configuration, there is just one domain in
5738 &'local_domains'&, but in general there may be many.
5739
5740 The presence of this statement means that mail to postmaster is never blocked
5741 by any of the subsequent tests. This can be helpful while sorting out problems
5742 in cases where the subsequent tests are incorrectly denying access.
5743 .code
5744 require verify        = sender
5745 .endd
5746 This statement requires the sender address to be verified before any subsequent
5747 ACL statement can be used. If verification fails, the incoming recipient
5748 address is refused. Verification consists of trying to route the address, to
5749 see if a bounce message could be delivered to it. In the case of remote
5750 addresses, basic verification checks only the domain, but &'callouts'& can be
5751 used for more verification if required. Section &<<SECTaddressverification>>&
5752 discusses the details of address verification.
5753 .code
5754 accept  hosts         = +relay_from_hosts
5755         control       = submission
5756 .endd
5757 This statement accepts the address if the message is coming from one of the
5758 hosts that are defined as being allowed to relay through this host. Recipient
5759 verification is omitted here, because in many cases the clients are dumb MUAs
5760 that do not cope well with SMTP error responses. For the same reason, the
5761 second line specifies &"submission mode"& for messages that are accepted. This
5762 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5763 messages that are deficient in some way, for example, because they lack a
5764 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5765 probably add recipient verification here, and disable submission mode.
5766 .code
5767 accept  authenticated = *
5768         control       = submission
5769 .endd
5770 This statement accepts the address if the client host has authenticated itself.
5771 Submission mode is again specified, on the grounds that such messages are most
5772 likely to come from MUAs. The default configuration does not define any
5773 authenticators, though it does include some nearly complete commented-out
5774 examples described in &<<SECTdefconfauth>>&. This means that no client can in
5775 fact authenticate until you complete the authenticator definitions.
5776 .code
5777 require message = relay not permitted
5778         domains = +local_domains : +relay_to_domains
5779 .endd
5780 This statement rejects the address if its domain is neither a local domain nor
5781 one of the domains for which this host is a relay.
5782 .code
5783 require verify = recipient
5784 .endd
5785 This statement requires the recipient address to be verified; if verification
5786 fails, the address is rejected.
5787 .code
5788 # deny    message     = rejected because $sender_host_address \
5789 #                       is in a black list at $dnslist_domain\n\
5790 #                       $dnslist_text
5791 #         dnslists    = black.list.example
5792 #
5793 # warn    dnslists    = black.list.example
5794 #         add_header  = X-Warning: $sender_host_address is in \
5795 #                       a black list at $dnslist_domain
5796 #         log_message = found in $dnslist_domain
5797 .endd
5798 These commented-out lines are examples of how you could configure Exim to check
5799 sending hosts against a DNS black list. The first statement rejects messages
5800 from blacklisted hosts, whereas the second just inserts a warning header
5801 line.
5802 .code
5803 # require verify = csa
5804 .endd
5805 This commented-out line is an example of how you could turn on client SMTP
5806 authorization (CSA) checking. Such checks do DNS lookups for special SRV
5807 records.
5808 .code
5809 accept
5810 .endd
5811 The final statement in the first ACL unconditionally accepts any recipient
5812 address that has successfully passed all the previous tests.
5813 .code
5814 acl_check_data:
5815 .endd
5816 This line marks the start of the second ACL, and names it. Most of the contents
5817 of this ACL are commented out:
5818 .code
5819 # deny    malware   = *
5820 #         message   = This message contains a virus \
5821 #                     ($malware_name).
5822 .endd
5823 These lines are examples of how to arrange for messages to be scanned for
5824 viruses when Exim has been compiled with the content-scanning extension, and a
5825 suitable virus scanner is installed. If the message is found to contain a
5826 virus, it is rejected with the given custom error message.
5827 .code
5828 # warn    spam      = nobody
5829 #         message   = X-Spam_score: $spam_score\n\
5830 #                     X-Spam_score_int: $spam_score_int\n\
5831 #                     X-Spam_bar: $spam_bar\n\
5832 #                     X-Spam_report: $spam_report
5833 .endd
5834 These lines are an example of how to arrange for messages to be scanned by
5835 SpamAssassin when Exim has been compiled with the content-scanning extension,
5836 and SpamAssassin has been installed. The SpamAssassin check is run with
5837 &`nobody`& as its user parameter, and the results are added to the message as a
5838 series of extra header line. In this case, the message is not rejected,
5839 whatever the spam score.
5840 .code
5841 accept
5842 .endd
5843 This final line in the DATA ACL accepts the message unconditionally.
5844
5845
5846 .section "Router configuration" "SECID55"
5847 .cindex "default" "routers"
5848 .cindex "routers" "default"
5849 The router configuration comes next in the default configuration, introduced
5850 by the line
5851 .code
5852 begin routers
5853 .endd
5854 Routers are the modules in Exim that make decisions about where to send
5855 messages. An address is passed to each router in turn, until it is either
5856 accepted, or failed. This means that the order in which you define the routers
5857 matters. Each router is fully described in its own chapter later in this
5858 manual. Here we give only brief overviews.
5859 .code
5860 # domain_literal:
5861 #   driver = ipliteral
5862 #   domains = !+local_domains
5863 #   transport = remote_smtp
5864 .endd
5865 .cindex "domain literal" "default router"
5866 This router is commented out because the majority of sites do not want to
5867 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
5868 you uncomment this router, you also need to uncomment the setting of
5869 &%allow_domain_literals%& in the main part of the configuration.
5870 .code
5871 dnslookup:
5872   driver = dnslookup
5873   domains = ! +local_domains
5874   transport = remote_smtp
5875   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
5876   no_more
5877 .endd
5878 The first uncommented router handles addresses that do not involve any local
5879 domains. This is specified by the line
5880 .code
5881 domains = ! +local_domains
5882 .endd
5883 The &%domains%& option lists the domains to which this router applies, but the
5884 exclamation mark is a negation sign, so the router is used only for domains
5885 that are not in the domain list called &'local_domains'& (which was defined at
5886 the start of the configuration). The plus sign before &'local_domains'&
5887 indicates that it is referring to a named list. Addresses in other domains are
5888 passed on to the following routers.
5889
5890 The name of the router driver is &(dnslookup)&,
5891 and is specified by the &%driver%& option. Do not be confused by the fact that
5892 the name of this router instance is the same as the name of the driver. The
5893 instance name is arbitrary, but the name set in the &%driver%& option must be
5894 one of the driver modules that is in the Exim binary.
5895
5896 The &(dnslookup)& router routes addresses by looking up their domains in the
5897 DNS in order to obtain a list of hosts to which the address is routed. If the
5898 router succeeds, the address is queued for the &(remote_smtp)& transport, as
5899 specified by the &%transport%& option. If the router does not find the domain
5900 in the DNS, no further routers are tried because of the &%no_more%& setting, so
5901 the address fails and is bounced.
5902
5903 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
5904 be entirely ignored. This option is present because a number of cases have been
5905 encountered where MX records in the DNS point to host names
5906 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
5907 Completely ignoring these IP addresses causes Exim to fail to route the
5908 email address, so it bounces. Otherwise, Exim would log a routing problem, and
5909 continue to try to deliver the message periodically until the address timed
5910 out.
5911 .code
5912 system_aliases:
5913   driver = redirect
5914   allow_fail
5915   allow_defer
5916   data = ${lookup{$local_part}lsearch{/etc/aliases}}
5917 # user = exim
5918   file_transport = address_file
5919   pipe_transport = address_pipe
5920 .endd
5921 Control reaches this and subsequent routers only for addresses in the local
5922 domains. This router checks to see whether the local part is defined as an
5923 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
5924 data that it looks up from that file. If no data is found for the local part,
5925 the value of the &%data%& option is empty, causing the address to be passed to
5926 the next router.
5927
5928 &_/etc/aliases_& is a conventional name for the system aliases file that is
5929 often used. That is why it is referenced by from the default configuration
5930 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
5931 &_Local/Makefile_& before building Exim.
5932 .code
5933 userforward:
5934   driver = redirect
5935   check_local_user
5936 # local_part_suffix = +* : -*
5937 # local_part_suffix_optional
5938   file = $home/.forward
5939 # allow_filter
5940   no_verify
5941   no_expn
5942   check_ancestor
5943   file_transport = address_file
5944   pipe_transport = address_pipe
5945   reply_transport = address_reply
5946 .endd
5947 This is the most complicated router in the default configuration. It is another
5948 redirection router, but this time it is looking for forwarding data set up by
5949 individual users. The &%check_local_user%& setting specifies a check that the
5950 local part of the address is the login name of a local user. If it is not, the
5951 router is skipped. The two commented options that follow &%check_local_user%&,
5952 namely:
5953 .code
5954 # local_part_suffix = +* : -*
5955 # local_part_suffix_optional
5956 .endd
5957 .vindex "&$local_part_suffix$&"
5958 show how you can specify the recognition of local part suffixes. If the first
5959 is uncommented, a suffix beginning with either a plus or a minus sign, followed
5960 by any sequence of characters, is removed from the local part and placed in the
5961 variable &$local_part_suffix$&. The second suffix option specifies that the
5962 presence of a suffix in the local part is optional. When a suffix is present,
5963 the check for a local login uses the local part with the suffix removed.
5964
5965 When a local user account is found, the file called &_.forward_& in the user's
5966 home directory is consulted. If it does not exist, or is empty, the router
5967 declines. Otherwise, the contents of &_.forward_& are interpreted as
5968 redirection data (see chapter &<<CHAPredirect>>& for more details).
5969
5970 .cindex "Sieve filter" "enabling in default router"
5971 Traditional &_.forward_& files contain just a list of addresses, pipes, or
5972 files. Exim supports this by default. However, if &%allow_filter%& is set (it
5973 is commented out by default), the contents of the file are interpreted as a set
5974 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
5975 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
5976 separate document entitled &'Exim's interfaces to mail filtering'&.
5977
5978 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
5979 verifying addresses, or when running as a consequence of an SMTP EXPN command.
5980 There are two reasons for doing this:
5981
5982 .olist
5983 Whether or not a local user has a &_.forward_& file is not really relevant when
5984 checking an address for validity; it makes sense not to waste resources doing
5985 unnecessary work.
5986 .next
5987 More importantly, when Exim is verifying addresses or handling an EXPN
5988 command during an SMTP session, it is running as the Exim user, not as root.
5989 The group is the Exim group, and no additional groups are set up.
5990 It may therefore not be possible for Exim to read users' &_.forward_& files at
5991 this time.
5992 .endlist
5993
5994 The setting of &%check_ancestor%& prevents the router from generating a new
5995 address that is the same as any previous address that was redirected. (This
5996 works round a problem concerning a bad interaction between aliasing and
5997 forwarding &-- see section &<<SECTredlocmai>>&).
5998
5999 The final three option settings specify the transports that are to be used when
6000 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
6001 auto-reply, respectively. For example, if a &_.forward_& file contains
6002 .code
6003 a.nother@elsewhere.example, /home/spqr/archive
6004 .endd
6005 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
6006 transport.
6007 .code
6008 localuser:
6009   driver = accept
6010   check_local_user
6011 # local_part_suffix = +* : -*
6012 # local_part_suffix_optional
6013   transport = local_delivery
6014 .endd
6015 The final router sets up delivery into local mailboxes, provided that the local
6016 part is the name of a local login, by accepting the address and assigning it to
6017 the &(local_delivery)& transport. Otherwise, we have reached the end of the
6018 routers, so the address is bounced. The commented suffix settings fulfil the
6019 same purpose as they do for the &(userforward)& router.
6020
6021
6022 .section "Transport configuration" "SECID56"
6023 .cindex "default" "transports"
6024 .cindex "transports" "default"
6025 Transports define mechanisms for actually delivering messages. They operate
6026 only when referenced from routers, so the order in which they are defined does
6027 not matter. The transports section of the configuration starts with
6028 .code
6029 begin transports
6030 .endd
6031 One remote transport and four local transports are defined.
6032 .code
6033 remote_smtp:
6034   driver = smtp
6035   hosts_try_prdr = *
6036 .endd
6037 This transport is used for delivering messages over SMTP connections.
6038 The list of remote hosts comes from the router.
6039 The &%hosts_try_prdr%& option enables an efficiency SMTP option.
6040 It is negotiated between client and server
6041 and not expected to cause problems but can be disabled if needed.
6042 All other options are defaulted.
6043 .code
6044 local_delivery:
6045   driver = appendfile
6046   file = /var/mail/$local_part
6047   delivery_date_add
6048   envelope_to_add
6049   return_path_add
6050 # group = mail
6051 # mode = 0660
6052 .endd
6053 This &(appendfile)& transport is used for local delivery to user mailboxes in
6054 traditional BSD mailbox format. By default it runs under the uid and gid of the
6055 local user, which requires the sticky bit to be set on the &_/var/mail_&
6056 directory. Some systems use the alternative approach of running mail deliveries
6057 under a particular group instead of using the sticky bit. The commented options
6058 show how this can be done.
6059
6060 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
6061 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
6062 similarly-named options above.
6063 .code
6064 address_pipe:
6065   driver = pipe
6066   return_output
6067 .endd
6068 This transport is used for handling deliveries to pipes that are generated by
6069 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6070 option specifies that any output on stdout or stderr generated by the pipe is to
6071 be returned to the sender.
6072 .code
6073 address_file:
6074   driver = appendfile
6075   delivery_date_add
6076   envelope_to_add
6077   return_path_add
6078 .endd
6079 This transport is used for handling deliveries to files that are generated by
6080 redirection. The name of the file is not specified in this instance of
6081 &(appendfile)&, because it comes from the &(redirect)& router.
6082 .code
6083 address_reply:
6084   driver = autoreply
6085 .endd
6086 This transport is used for handling automatic replies generated by users'
6087 filter files.
6088
6089
6090
6091 .section "Default retry rule" "SECID57"
6092 .cindex "retry" "default rule"
6093 .cindex "default" "retry rule"
6094 The retry section of the configuration file contains rules which affect the way
6095 Exim retries deliveries that cannot be completed at the first attempt. It is
6096 introduced by the line
6097 .code
6098 begin retry
6099 .endd
6100 In the default configuration, there is just one rule, which applies to all
6101 errors:
6102 .code
6103 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6104 .endd
6105 This causes any temporarily failing address to be retried every 15 minutes for
6106 2 hours, then at intervals starting at one hour and increasing by a factor of
6107 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6108 is not delivered after 4 days of temporary failure, it is bounced.
6109
6110 If the retry section is removed from the configuration, or is empty (that is,
6111 if no retry rules are defined), Exim will not retry deliveries. This turns
6112 temporary errors into permanent errors.
6113
6114
6115 .section "Rewriting configuration" "SECID58"
6116 The rewriting section of the configuration, introduced by
6117 .code
6118 begin rewrite
6119 .endd
6120 contains rules for rewriting addresses in messages as they arrive. There are no
6121 rewriting rules in the default configuration file.
6122
6123
6124
6125 .section "Authenticators configuration" "SECTdefconfauth"
6126 .cindex "AUTH" "configuration"
6127 The authenticators section of the configuration, introduced by
6128 .code
6129 begin authenticators
6130 .endd
6131 defines mechanisms for the use of the SMTP AUTH command. The default
6132 configuration file contains two commented-out example authenticators
6133 which support plaintext username/password authentication using the
6134 standard PLAIN mechanism and the traditional but non-standard LOGIN
6135 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6136 to support most MUA software.
6137
6138 The example PLAIN authenticator looks like this:
6139 .code
6140 #PLAIN:
6141 #  driver                  = plaintext
6142 #  server_set_id           = $auth2
6143 #  server_prompts          = :
6144 #  server_condition        = Authentication is not yet configured
6145 #  server_advertise_condition = ${if def:tls_in_cipher }
6146 .endd
6147 And the example LOGIN authenticator looks like this:
6148 .code
6149 #LOGIN:
6150 #  driver                  = plaintext
6151 #  server_set_id           = $auth1
6152 #  server_prompts          = <| Username: | Password:
6153 #  server_condition        = Authentication is not yet configured
6154 #  server_advertise_condition = ${if def:tls_in_cipher }
6155 .endd
6156
6157 The &%server_set_id%& option makes Exim remember the authenticated username
6158 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6159 &%server_prompts%& option configures the &(plaintext)& authenticator so
6160 that it implements the details of the specific authentication mechanism,
6161 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6162 when Exim offers authentication to clients; in the examples, this is only
6163 when TLS or SSL has been started, so to enable the authenticators you also
6164 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6165
6166 The &%server_condition%& setting defines how to verify that the username and
6167 password are correct. In the examples it just produces an error message.
6168 To make the authenticators work, you can use a string expansion
6169 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6170
6171 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6172 usercode and password are in different positions.
6173 Chapter &<<CHAPplaintext>>& covers both.
6174
6175 .ecindex IIDconfiwal
6176
6177
6178
6179 . ////////////////////////////////////////////////////////////////////////////
6180 . ////////////////////////////////////////////////////////////////////////////
6181
6182 .chapter "Regular expressions" "CHAPregexp"
6183
6184 .cindex "regular expressions" "library"
6185 .cindex "PCRE"
6186 Exim supports the use of regular expressions in many of its options. It
6187 uses the PCRE regular expression library; this provides regular expression
6188 matching that is compatible with Perl 5. The syntax and semantics of
6189 regular expressions is discussed in many Perl reference books, and also in
6190 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6191 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6192
6193 The documentation for the syntax and semantics of the regular expressions that
6194 are supported by PCRE is included in the PCRE distribution, and no further
6195 description is included here. The PCRE functions are called from Exim using
6196 the default option settings (that is, with no PCRE options set), except that
6197 the PCRE_CASELESS option is set when the matching is required to be
6198 case-insensitive.
6199
6200 In most cases, when a regular expression is required in an Exim configuration,
6201 it has to start with a circumflex, in order to distinguish it from plain text
6202 or an &"ends with"& wildcard. In this example of a configuration setting, the
6203 second item in the colon-separated list is a regular expression.
6204 .code
6205 domains = a.b.c : ^\\d{3} : *.y.z : ...
6206 .endd
6207 The doubling of the backslash is required because of string expansion that
6208 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6209 of this issue, and a way of avoiding the need for doubling backslashes. The
6210 regular expression that is eventually used in this example contains just one
6211 backslash. The circumflex is included in the regular expression, and has the
6212 normal effect of &"anchoring"& it to the start of the string that is being
6213 matched.
6214
6215 There are, however, two cases where a circumflex is not required for the
6216 recognition of a regular expression: these are the &%match%& condition in a
6217 string expansion, and the &%matches%& condition in an Exim filter file. In
6218 these cases, the relevant string is always treated as a regular expression; if
6219 it does not start with a circumflex, the expression is not anchored, and can
6220 match anywhere in the subject string.
6221
6222 In all cases, if you want a regular expression to match at the end of a string,
6223 you must code the $ metacharacter to indicate this. For example:
6224 .code
6225 domains = ^\\d{3}\\.example
6226 .endd
6227 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6228 You need to use:
6229 .code
6230 domains = ^\\d{3}\\.example\$
6231 .endd
6232 if you want &'example'& to be the top-level domain. The backslash before the
6233 $ is needed because string expansion also interprets dollar characters.
6234
6235
6236
6237 . ////////////////////////////////////////////////////////////////////////////
6238 . ////////////////////////////////////////////////////////////////////////////
6239
6240 .chapter "File and database lookups" "CHAPfdlookup"
6241 .scindex IIDfidalo1 "file" "lookups"
6242 .scindex IIDfidalo2 "database" "lookups"
6243 .cindex "lookup" "description of"
6244 Exim can be configured to look up data in files or databases as it processes
6245 messages. Two different kinds of syntax are used:
6246
6247 .olist
6248 A string that is to be expanded may contain explicit lookup requests. These
6249 cause parts of the string to be replaced by data that is obtained from the
6250 lookup. Lookups of this type are conditional expansion items. Different results
6251 can be defined for the cases of lookup success and failure. See chapter
6252 &<<CHAPexpand>>&, where string expansions are described in detail.
6253 The key for the lookup is specified as part of the string expansion.
6254 .next
6255 Lists of domains, hosts, and email addresses can contain lookup requests as a
6256 way of avoiding excessively long linear lists. In this case, the data that is
6257 returned by the lookup is often (but not always) discarded; whether the lookup
6258 succeeds or fails is what really counts. These kinds of list are described in
6259 chapter &<<CHAPdomhosaddlists>>&.
6260 The key for the lookup is given by the context in which the list is expanded.
6261 .endlist
6262
6263 String expansions, lists, and lookups interact with each other in such a way
6264 that there is no order in which to describe any one of them that does not
6265 involve references to the others. Each of these three chapters makes more sense
6266 if you have read the other two first. If you are reading this for the first
6267 time, be aware that some of it will make a lot more sense after you have read
6268 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6269
6270 .section "Examples of different lookup syntax" "SECID60"
6271 It is easy to confuse the two different kinds of lookup, especially as the
6272 lists that may contain the second kind are always expanded before being
6273 processed as lists. Therefore, they may also contain lookups of the first kind.
6274 Be careful to distinguish between the following two examples:
6275 .code
6276 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6277 domains = lsearch;/some/file
6278 .endd
6279 The first uses a string expansion, the result of which must be a domain list.
6280 No strings have been specified for a successful or a failing lookup; the
6281 defaults in this case are the looked-up data and an empty string, respectively.
6282 The expansion takes place before the string is processed as a list, and the
6283 file that is searched could contain lines like this:
6284 .code
6285 192.168.3.4: domain1:domain2:...
6286 192.168.1.9: domain3:domain4:...
6287 .endd
6288 When the lookup succeeds, the result of the expansion is a list of domains (and
6289 possibly other types of item that are allowed in domain lists).
6290
6291 In the second example, the lookup is a single item in a domain list. It causes
6292 Exim to use a lookup to see if the domain that is being processed can be found
6293 in the file. The file could contains lines like this:
6294 .code
6295 domain1:
6296 domain2:
6297 .endd
6298 Any data that follows the keys is not relevant when checking that the domain
6299 matches the list item.
6300
6301 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6302 Consider a file containing lines like this:
6303 .code
6304 192.168.5.6: lsearch;/another/file
6305 .endd
6306 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6307 first &%domains%& setting above generates the second setting, which therefore
6308 causes a second lookup to occur.
6309
6310 The rest of this chapter describes the different lookup types that are
6311 available. Any of them can be used in any part of the configuration where a
6312 lookup is permitted.
6313
6314
6315 .section "Lookup types" "SECID61"
6316 .cindex "lookup" "types of"
6317 .cindex "single-key lookup" "definition of"
6318 Two different types of data lookup are implemented:
6319
6320 .ilist
6321 The &'single-key'& type requires the specification of a file in which to look,
6322 and a single key to search for. The key must be a non-empty string for the
6323 lookup to succeed. The lookup type determines how the file is searched.
6324 .next
6325 .cindex "query-style lookup" "definition of"
6326 The &'query-style'& type accepts a generalized database query. No particular
6327 key value is assumed by Exim for query-style lookups. You can use whichever
6328 Exim variables you need to construct the database query.
6329 .endlist
6330
6331 The code for each lookup type is in a separate source file that is included in
6332 the binary of Exim only if the corresponding compile-time option is set. The
6333 default settings in &_src/EDITME_& are:
6334 .code
6335 LOOKUP_DBM=yes
6336 LOOKUP_LSEARCH=yes
6337 .endd
6338 which means that only linear searching and DBM lookups are included by default.
6339 For some types of lookup (e.g. SQL databases), you need to install appropriate
6340 libraries and header files before building Exim.
6341
6342
6343
6344
6345 .section "Single-key lookup types" "SECTsinglekeylookups"
6346 .cindex "lookup" "single-key types"
6347 .cindex "single-key lookup" "list of types"
6348 The following single-key lookup types are implemented:
6349
6350 .ilist
6351 .cindex "cdb" "description of"
6352 .cindex "lookup" "cdb"
6353 .cindex "binary zero" "in lookup key"
6354 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6355 string without a terminating binary zero. The cdb format is designed for
6356 indexed files that are read frequently and never updated, except by total
6357 re-creation. As such, it is particularly suitable for large files containing
6358 aliases or other indexed data referenced by an MTA. Information about cdb can
6359 be found in several places:
6360 .display
6361 &url(http://www.pobox.com/~djb/cdb.html)
6362 &url(ftp://ftp.corpit.ru/pub/tinycdb/)
6363 &url(http://packages.debian.org/stable/utils/freecdb.html)
6364 .endd
6365 A cdb distribution is not needed in order to build Exim with cdb support,
6366 because the code for reading cdb files is included directly in Exim itself.
6367 However, no means of building or testing cdb files is provided with Exim, so
6368 you need to obtain a cdb distribution in order to do this.
6369 .next
6370 .cindex "DBM" "lookup type"
6371 .cindex "lookup" "dbm"
6372 .cindex "binary zero" "in lookup key"
6373 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6374 DBM file by looking up the record with the given key. A terminating binary
6375 zero is included in the key that is passed to the DBM library. See section
6376 &<<SECTdb>>& for a discussion of DBM libraries.
6377
6378 .cindex "Berkeley DB library" "file format"
6379 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6380 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6381 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6382 the DB_UNKNOWN option. This enables it to handle any of the types of database
6383 that the library supports, and can be useful for accessing DBM files created by
6384 other applications. (For earlier DB versions, DB_HASH is always used.)
6385 .next
6386 .cindex "lookup" "dbmjz"
6387 .cindex "lookup" "dbm &-- embedded NULs"
6388 .cindex "sasldb2"
6389 .cindex "dbmjz lookup type"
6390 &(dbmjz)&: This is the same as &(dbm)&, except that the lookup key is
6391 interpreted as an Exim list; the elements of the list are joined together with
6392 ASCII NUL characters to form the lookup key.  An example usage would be to
6393 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6394 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6395 &(cram_md5)& authenticator.
6396 .next
6397 .cindex "lookup" "dbmnz"
6398 .cindex "lookup" "dbm &-- terminating zero"
6399 .cindex "binary zero" "in lookup key"
6400 .cindex "Courier"
6401 .cindex "&_/etc/userdbshadow.dat_&"
6402 .cindex "dbmnz lookup type"
6403 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6404 is not included in the key that is passed to the DBM library. You may need this
6405 if you want to look up data in files that are created by or shared with some
6406 other application that does not use terminating zeros. For example, you need to
6407 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6408 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6409 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6410 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6411 .next
6412 .cindex "lookup" "dsearch"
6413 .cindex "dsearch lookup type"
6414 &(dsearch)&: The given file must be a directory; this is searched for an entry
6415 whose name is the key by calling the &[lstat()]& function. The key may not
6416 contain any forward slash characters. If &[lstat()]& succeeds, the result of
6417 the lookup is the name of the entry, which may be a file, directory,
6418 symbolic link, or any other kind of directory entry. An example of how this
6419 lookup can be used to support virtual domains is given in section
6420 &<<SECTvirtualdomains>>&.
6421 .next
6422 .cindex "lookup" "iplsearch"
6423 .cindex "iplsearch lookup type"
6424 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6425 terminated by a colon or white space or the end of the line. The keys in the
6426 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6427 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6428 being interpreted as a key terminator. For example:
6429 .code
6430 1.2.3.4:           data for 1.2.3.4
6431 192.168.0.0/16:    data for 192.168.0.0/16
6432 "abcd::cdab":      data for abcd::cdab
6433 "abcd:abcd::/32"   data for abcd:abcd::/32
6434 .endd
6435 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6436 file is searched linearly, using the CIDR masks where present, until a matching
6437 key is found. The first key that matches is used; there is no attempt to find a
6438 &"best"& match. Apart from the way the keys are matched, the processing for
6439 &(iplsearch)& is the same as for &(lsearch)&.
6440
6441 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6442 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6443 lookup types support only literal keys.
6444
6445 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6446 the implicit key is the host's IP address rather than its name (see section
6447 &<<SECThoslispatsikey>>&).
6448 .next
6449 .cindex "linear search"
6450 .cindex "lookup" "lsearch"
6451 .cindex "lsearch lookup type"
6452 .cindex "case sensitivity" "in lsearch lookup"
6453 &(lsearch)&: The given file is a text file that is searched linearly for a
6454 line beginning with the search key, terminated by a colon or white space or the
6455 end of the line. The search is case-insensitive; that is, upper and lower case
6456 letters are treated as the same. The first occurrence of the key that is found
6457 in the file is used.
6458
6459 White space between the key and the colon is permitted. The remainder of the
6460 line, with leading and trailing white space removed, is the data. This can be
6461 continued onto subsequent lines by starting them with any amount of white
6462 space, but only a single space character is included in the data at such a
6463 junction. If the data begins with a colon, the key must be terminated by a
6464 colon, for example:
6465 .code
6466 baduser:  :fail:
6467 .endd
6468 Empty lines and lines beginning with # are ignored, even if they occur in the
6469 middle of an item. This is the traditional textual format of alias files. Note
6470 that the keys in an &(lsearch)& file are literal strings. There is no
6471 wildcarding of any kind.
6472
6473 .cindex "lookup" "lsearch &-- colons in keys"
6474 .cindex "white space" "in lsearch key"
6475 In most &(lsearch)& files, keys are not required to contain colons or #
6476 characters, or white space. However, if you need this feature, it is available.
6477 If a key begins with a doublequote character, it is terminated only by a
6478 matching quote (or end of line), and the normal escaping rules apply to its
6479 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6480 quoted keys (exactly as for unquoted keys). There is no special handling of
6481 quotes for the data part of an &(lsearch)& line.
6482
6483 .next
6484 .cindex "NIS lookup type"
6485 .cindex "lookup" "NIS"
6486 .cindex "binary zero" "in lookup key"
6487 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6488 the given key, without a terminating binary zero. There is a variant called
6489 &(nis0)& which does include the terminating binary zero in the key. This is
6490 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6491 aliases; the full map names must be used.
6492
6493 .next
6494 .cindex "wildlsearch lookup type"
6495 .cindex "lookup" "wildlsearch"
6496 .cindex "nwildlsearch lookup type"
6497 .cindex "lookup" "nwildlsearch"
6498 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6499 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6500 the file may be wildcarded. The difference between these two lookup types is
6501 that for &(wildlsearch)&, each key in the file is string-expanded before being
6502 used, whereas for &(nwildlsearch)&, no expansion takes place.
6503
6504 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6505 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6506 file that are regular expressions can be made case-sensitive by the use of
6507 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6508
6509 . ==== As this is a nested list, any displays it contains must be indented
6510 . ==== as otherwise they are too far to the left.
6511
6512 .olist
6513 The string may begin with an asterisk to mean &"ends with"&. For example:
6514 .code
6515     *.a.b.c       data for anything.a.b.c
6516     *fish         data for anythingfish
6517 .endd
6518 .next
6519 The string may begin with a circumflex to indicate a regular expression. For
6520 example, for &(wildlsearch)&:
6521 .code
6522     ^\N\d+\.a\.b\N    data for <digits>.a.b
6523 .endd
6524 Note the use of &`\N`& to disable expansion of the contents of the regular
6525 expression. If you are using &(nwildlsearch)&, where the keys are not
6526 string-expanded, the equivalent entry is:
6527 .code
6528     ^\d+\.a\.b        data for <digits>.a.b
6529 .endd
6530 The case-insensitive flag is set at the start of compiling the regular
6531 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6532 For example, to make the entire pattern case-sensitive:
6533 .code
6534     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6535 .endd
6536
6537 If the regular expression contains white space or colon characters, you must
6538 either quote it (see &(lsearch)& above), or represent these characters in other
6539 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6540 colon. This may be easier than quoting, because if you quote, you have to
6541 escape all the backslashes inside the quotes.
6542
6543 &*Note*&: It is not possible to capture substrings in a regular expression
6544 match for later use, because the results of all lookups are cached. If a lookup
6545 is repeated, the result is taken from the cache, and no actual pattern matching
6546 takes place. The values of all the numeric variables are unset after a
6547 &((n)wildlsearch)& match.
6548
6549 .next
6550 Although I cannot see it being of much use, the general matching function that
6551 is used to implement &((n)wildlsearch)& means that the string may begin with a
6552 lookup name terminated by a semicolon, and followed by lookup data. For
6553 example:
6554 .code
6555     cdb;/some/file  data for keys that match the file
6556 .endd
6557 The data that is obtained from the nested lookup is discarded.
6558 .endlist olist
6559
6560 Keys that do not match any of these patterns are interpreted literally. The
6561 continuation rules for the data are the same as for &(lsearch)&, and keys may
6562 be followed by optional colons.
6563
6564 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6565 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6566 lookup types support only literal keys.
6567 .endlist ilist
6568
6569
6570 .section "Query-style lookup types" "SECID62"
6571 .cindex "lookup" "query-style types"
6572 .cindex "query-style lookup" "list of types"
6573 The supported query-style lookup types are listed below. Further details about
6574 many of them are given in later sections.
6575
6576 .ilist
6577 .cindex "DNS" "as a lookup type"
6578 .cindex "lookup" "DNS"
6579 &(dnsdb)&: This does a DNS search for one or more records whose domain names
6580 are given in the supplied query. The resulting data is the contents of the
6581 records. See section &<<SECTdnsdb>>&.
6582 .next
6583 .cindex "InterBase lookup type"
6584 .cindex "lookup" "InterBase"
6585 &(ibase)&: This does a lookup in an InterBase database.
6586 .next
6587 .cindex "LDAP" "lookup type"
6588 .cindex "lookup" "LDAP"
6589 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
6590 returns attributes from a single entry. There is a variant called &(ldapm)&
6591 that permits values from multiple entries to be returned. A third variant
6592 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
6593 any attribute values. See section &<<SECTldap>>&.
6594 .next
6595 .cindex "MySQL" "lookup type"
6596 .cindex "lookup" "MySQL"
6597 &(mysql)&: The format of the query is an SQL statement that is passed to a
6598 MySQL database. See section &<<SECTsql>>&.
6599 .next
6600 .cindex "NIS+ lookup type"
6601 .cindex "lookup" "NIS+"
6602 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
6603 the field to be returned. See section &<<SECTnisplus>>&.
6604 .next
6605 .cindex "Oracle" "lookup type"
6606 .cindex "lookup" "Oracle"
6607 &(oracle)&: The format of the query is an SQL statement that is passed to an
6608 Oracle database. See section &<<SECTsql>>&.
6609 .next
6610 .cindex "lookup" "passwd"
6611 .cindex "passwd lookup type"
6612 .cindex "&_/etc/passwd_&"
6613 &(passwd)& is a query-style lookup with queries that are just user names. The
6614 lookup calls &[getpwnam()]& to interrogate the system password data, and on
6615 success, the result string is the same as you would get from an &(lsearch)&
6616 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
6617 password value. For example:
6618 .code
6619 *:42:42:King Rat:/home/kr:/bin/bash
6620 .endd
6621 .next
6622 .cindex "PostgreSQL lookup type"
6623 .cindex "lookup" "PostgreSQL"
6624 &(pgsql)&: The format of the query is an SQL statement that is passed to a
6625 PostgreSQL database. See section &<<SECTsql>>&.
6626
6627 .next
6628 .new
6629 .cindex "Redis lookup type"
6630 .cindex lookup Redis
6631 &(redis)&: The format of the query is an SQL statement that is passed to a
6632 Redis database. See section &<<SECTsql>>&.
6633 .wen
6634
6635 .next
6636 .cindex "sqlite lookup type"
6637 .cindex "lookup" "sqlite"
6638 &(sqlite)&: The format of the query is a file name followed by an SQL statement
6639 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
6640
6641 .next
6642 &(testdb)&: This is a lookup type that is used for testing Exim. It is
6643 not likely to be useful in normal operation.
6644 .next
6645 .cindex "whoson lookup type"
6646 .cindex "lookup" "whoson"
6647 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
6648 allows a server to check whether a particular (dynamically allocated) IP
6649 address is currently allocated to a known (trusted) user and, optionally, to
6650 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
6651 at one time for &"POP before SMTP"& authentication, but that approach has been
6652 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
6653 &"POP before SMTP"& checking using ACL statements such as
6654 .code
6655 require condition = \
6656   ${lookup whoson {$sender_host_address}{yes}{no}}
6657 .endd
6658 The query consists of a single IP address. The value returned is the name of
6659 the authenticated user, which is stored in the variable &$value$&. However, in
6660 this example, the data in &$value$& is not used; the result of the lookup is
6661 one of the fixed strings &"yes"& or &"no"&.
6662 .endlist
6663
6664
6665
6666 .section "Temporary errors in lookups" "SECID63"
6667 .cindex "lookup" "temporary error in"
6668 Lookup functions can return temporary error codes if the lookup cannot be
6669 completed. For example, an SQL or LDAP database might be unavailable. For this
6670 reason, it is not advisable to use a lookup that might do this for critical
6671 options such as a list of local domains.
6672
6673 When a lookup cannot be completed in a router or transport, delivery
6674 of the message (to the relevant address) is deferred, as for any other
6675 temporary error. In other circumstances Exim may assume the lookup has failed,
6676 or may give up altogether.
6677
6678
6679
6680 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
6681 .cindex "wildcard lookups"
6682 .cindex "lookup" "default values"
6683 .cindex "lookup" "wildcard"
6684 .cindex "lookup" "* added to type"
6685 .cindex "default" "in single-key lookups"
6686 In this context, a &"default value"& is a value specified by the administrator
6687 that is to be used if a lookup fails.
6688
6689 &*Note:*& This section applies only to single-key lookups. For query-style
6690 lookups, the facilities of the query language must be used. An attempt to
6691 specify a default for a query-style lookup provokes an error.
6692
6693 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
6694 and the initial lookup fails, the key &"*"& is looked up in the file to
6695 provide a default value. See also the section on partial matching below.
6696
6697 .cindex "*@ with single-key lookup"
6698 .cindex "lookup" "*@ added to type"
6699 .cindex "alias file" "per-domain default"
6700 Alternatively, if &"*@"& is added to a single-key lookup type (for example
6701 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
6702 character, a second lookup is done with everything before the last @ replaced
6703 by *. This makes it possible to provide per-domain defaults in alias files
6704 that include the domains in the keys. If the second lookup fails (or doesn't
6705 take place because there is no @ in the key), &"*"& is looked up.
6706 For example, a &(redirect)& router might contain:
6707 .code
6708 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
6709 .endd
6710 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
6711 looks up these keys, in this order:
6712 .code
6713 jane@eyre.example
6714 *@eyre.example
6715 *
6716 .endd
6717 The data is taken from whichever key it finds first. &*Note*&: In an
6718 &(lsearch)& file, this does not mean the first of these keys in the file. A
6719 complete scan is done for each key, and only if it is not found at all does
6720 Exim move on to try the next key.
6721
6722
6723
6724 .section "Partial matching in single-key lookups" "SECTpartiallookup"
6725 .cindex "partial matching"
6726 .cindex "wildcard lookups"
6727 .cindex "lookup" "partial matching"
6728 .cindex "lookup" "wildcard"
6729 .cindex "asterisk" "in search type"
6730 The normal operation of a single-key lookup is to search the file for an exact
6731 match with the given key. However, in a number of situations where domains are
6732 being looked up, it is useful to be able to do partial matching. In this case,
6733 information in the file that has a key starting with &"*."& is matched by any
6734 domain that ends with the components that follow the full stop. For example, if
6735 a key in a DBM file is
6736 .code
6737 *.dates.fict.example
6738 .endd
6739 then when partial matching is enabled this is matched by (amongst others)
6740 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
6741 by &'dates.fict.example'&, if that does not appear as a separate key in the
6742 file.
6743
6744 &*Note*&: Partial matching is not available for query-style lookups. It is
6745 also not available for any lookup items in address lists (see section
6746 &<<SECTaddresslist>>&).
6747
6748 Partial matching is implemented by doing a series of separate lookups using
6749 keys constructed by modifying the original subject key. This means that it can
6750 be used with any of the single-key lookup types, provided that
6751 partial matching keys
6752 beginning with a special prefix (default &"*."&) are included in the data file.
6753 Keys in the file that do not begin with the prefix are matched only by
6754 unmodified subject keys when partial matching is in use.
6755
6756 Partial matching is requested by adding the string &"partial-"& to the front of
6757 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
6758 is done, the subject key is first looked up unmodified; if that fails, &"*."&
6759 is added at the start of the subject key, and it is looked up again. If that
6760 fails, further lookups are tried with dot-separated components removed from the
6761 start of the subject key, one-by-one, and &"*."& added on the front of what
6762 remains.
6763
6764 A minimum number of two non-* components are required. This can be adjusted
6765 by including a number before the hyphen in the search type. For example,
6766 &%partial3-lsearch%& specifies a minimum of three non-* components in the
6767 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
6768 subject key is &'2250.dates.fict.example'& then the following keys are looked
6769 up when the minimum number of non-* components is two:
6770 .code
6771 2250.dates.fict.example
6772 *.2250.dates.fict.example
6773 *.dates.fict.example
6774 *.fict.example
6775 .endd
6776 As soon as one key in the sequence is successfully looked up, the lookup
6777 finishes.
6778
6779 .cindex "lookup" "partial matching &-- changing prefix"
6780 .cindex "prefix" "for partial matching"
6781 The use of &"*."& as the partial matching prefix is a default that can be
6782 changed. The motivation for this feature is to allow Exim to operate with file
6783 formats that are used by other MTAs. A different prefix can be supplied in
6784 parentheses instead of the hyphen after &"partial"&. For example:
6785 .code
6786 domains = partial(.)lsearch;/some/file
6787 .endd
6788 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
6789 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
6790 components is unchanged). The prefix may consist of any punctuation characters
6791 other than a closing parenthesis. It may be empty, for example:
6792 .code
6793 domains = partial1()cdb;/some/file
6794 .endd
6795 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
6796 &`a.b.c`&, &`b.c`&, and &`c`&.
6797
6798 If &"partial0"& is specified, what happens at the end (when the lookup with
6799 just one non-wild component has failed, and the original key is shortened right
6800 down to the null string) depends on the prefix:
6801
6802 .ilist
6803 If the prefix has zero length, the whole lookup fails.
6804 .next
6805 If the prefix has length 1, a lookup for just the prefix is done. For
6806 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
6807 .next
6808 Otherwise, if the prefix ends in a dot, the dot is removed, and the
6809 remainder is looked up. With the default prefix, therefore, the final lookup is
6810 for &"*"& on its own.
6811 .next
6812 Otherwise, the whole prefix is looked up.
6813 .endlist
6814
6815
6816 If the search type ends in &"*"& or &"*@"& (see section
6817 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
6818 this implies happens after all partial lookups have failed. If &"partial0"& is
6819 specified, adding &"*"& to the search type has no effect with the default
6820 prefix, because the &"*"& key is already included in the sequence of partial
6821 lookups. However, there might be a use for lookup types such as
6822 &"partial0(.)lsearch*"&.
6823
6824 The use of &"*"& in lookup partial matching differs from its use as a wildcard
6825 in domain lists and the like. Partial matching works only in terms of
6826 dot-separated components; a key such as &`*fict.example`&
6827 in a database file is useless, because the asterisk in a partial matching
6828 subject key is always followed by a dot.
6829
6830
6831
6832
6833 .section "Lookup caching" "SECID64"
6834 .cindex "lookup" "caching"
6835 .cindex "caching" "lookup data"
6836 Exim caches all lookup results in order to avoid needless repetition of
6837 lookups. However, because (apart from the daemon) Exim operates as a collection
6838 of independent, short-lived processes, this caching applies only within a
6839 single Exim process. There is no inter-process lookup caching facility.
6840
6841 For single-key lookups, Exim keeps the relevant files open in case there is
6842 another lookup that needs them. In some types of configuration this can lead to
6843 many files being kept open for messages with many recipients. To avoid hitting
6844 the operating system limit on the number of simultaneously open files, Exim
6845 closes the least recently used file when it needs to open more files than its
6846 own internal limit, which can be changed via the &%lookup_open_max%& option.
6847
6848 The single-key lookup files are closed and the lookup caches are flushed at
6849 strategic points during delivery &-- for example, after all routing is
6850 complete.
6851
6852
6853
6854
6855 .section "Quoting lookup data" "SECID65"
6856 .cindex "lookup" "quoting"
6857 .cindex "quoting" "in lookups"
6858 When data from an incoming message is included in a query-style lookup, there
6859 is the possibility of special characters in the data messing up the syntax of
6860 the query. For example, a NIS+ query that contains
6861 .code
6862 [name=$local_part]
6863 .endd
6864 will be broken if the local part happens to contain a closing square bracket.
6865 For NIS+, data can be enclosed in double quotes like this:
6866 .code
6867 [name="$local_part"]
6868 .endd
6869 but this still leaves the problem of a double quote in the data. The rule for
6870 NIS+ is that double quotes must be doubled. Other lookup types have different
6871 rules, and to cope with the differing requirements, an expansion operator
6872 of the following form is provided:
6873 .code
6874 ${quote_<lookup-type>:<string>}
6875 .endd
6876 For example, the safest way to write the NIS+ query is
6877 .code
6878 [name="${quote_nisplus:$local_part}"]
6879 .endd
6880 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
6881 operator can be used for all lookup types, but has no effect for single-key
6882 lookups, since no quoting is ever needed in their key strings.
6883
6884
6885
6886
6887 .section "More about dnsdb" "SECTdnsdb"
6888 .cindex "dnsdb lookup"
6889 .cindex "lookup" "dnsdb"
6890 .cindex "DNS" "as a lookup type"
6891 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
6892 of a record type and a domain name, separated by an equals sign. For example,
6893 an expansion string could contain:
6894 .code
6895 ${lookup dnsdb{mx=a.b.example}{$value}fail}
6896 .endd
6897 If the lookup succeeds, the result is placed in &$value$&, which in this case
6898 is used on its own as the result. If the lookup does not succeed, the
6899 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
6900 &<<SECTforexpfai>>& for an explanation of what this means.
6901
6902 The supported DNS record types are A, CNAME, MX, NS, PTR, SOA, SPF, SRV, TLSA
6903 and TXT, and, when Exim is compiled with IPv6 support, AAAA.
6904 If no type is given, TXT is assumed.
6905
6906 For any record type, if multiple records are found, the data is returned as a
6907 concatenation, with newline as the default separator. The order, of course,
6908 depends on the DNS resolver. You can specify a different separator character
6909 between multiple records by putting a right angle-bracket followed immediately
6910 by the new separator at the start of the query. For example:
6911 .code
6912 ${lookup dnsdb{>: a=host1.example}}
6913 .endd
6914 It is permitted to specify a space as the separator character. Further
6915 white space is ignored.
6916 For lookup types that return multiple fields per record,
6917 an alternate field separator can be specified using a comma after the main
6918 separator character, followed immediately by the field separator.
6919
6920 .cindex "PTR record" "in &(dnsdb)& lookup"
6921 When the type is PTR,
6922 the data can be an IP address, written as normal; inversion and the addition of
6923 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
6924 .code
6925 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
6926 .endd
6927 If the data for a PTR record is not a syntactically valid IP address, it is not
6928 altered and nothing is added.
6929
6930 .cindex "MX record" "in &(dnsdb)& lookup"
6931 .cindex "SRV record" "in &(dnsdb)& lookup"
6932 For an MX lookup, both the preference value and the host name are returned for
6933 each record, separated by a space. For an SRV lookup, the priority, weight,
6934 port, and host name are returned for each record, separated by spaces.
6935 The field separator can be modified as above.
6936
6937 .cindex "TXT record" "in &(dnsdb)& lookup"
6938 .cindex "SPF record" "in &(dnsdb)& lookup"
6939 For TXT records with multiple items of data, only the first item is returned,
6940 unless a field separator is specified.
6941 To concatenate items without a separator, use a semicolon instead.
6942 For SPF records the
6943 default behaviour is to concatenate multiple items without using a separator.
6944 .code
6945 ${lookup dnsdb{>\n,: txt=a.b.example}}
6946 ${lookup dnsdb{>\n; txt=a.b.example}}
6947 ${lookup dnsdb{spf=example.org}}
6948 .endd
6949 It is permitted to specify a space as the separator character. Further
6950 white space is ignored.
6951
6952 .cindex "SOA record" "in &(dnsdb)& lookup"
6953 For an SOA lookup, while no result is obtained the lookup is redone with
6954 successively more leading components dropped from the given domain.
6955 Only the primary-nameserver field is returned unless a field separator is
6956 specified.
6957 .code
6958 ${lookup dnsdb{>:,; soa=a.b.example.com}}
6959 .endd
6960
6961 .section "Dnsdb lookup modifiers" "SECTdnsdb_mod"
6962 .cindex "dnsdb modifiers"
6963 .cindex "modifiers" "dnsdb"
6964 .cindex "options" "dnsdb"
6965 Modifiers for &(dnsdb)& lookups are given by optional keywords,
6966 each followed by a comma,
6967 that may appear before the record type.
6968
6969 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
6970 temporary DNS error for any of them, the behaviour is controlled by
6971 a defer-option modifier.
6972 The possible keywords are
6973 &"defer_strict"&, &"defer_never"&, and &"defer_lax"&.
6974 With &"strict"& behaviour, any temporary DNS error causes the
6975 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
6976 ignored, and the behaviour is as if the DNS lookup failed to find anything.
6977 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
6978 error causes the whole lookup to defer only if none of the other lookups
6979 succeed. The default is &"lax"&, so the following lookups are equivalent:
6980 .code
6981 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
6982 ${lookup dnsdb{a=one.host.com:two.host.com}}
6983 .endd
6984 Thus, in the default case, as long as at least one of the DNS lookups
6985 yields some data, the lookup succeeds.
6986
6987 .cindex "DNSSEC" "dns lookup"
6988 Use of &(DNSSEC)& is controlled by a dnssec modifier.
6989 The possible keywords are
6990 &"dnssec_strict"&, &"dnssec_lax"&, and &"dnssec_never"&.
6991 With &"strict"& or &"lax"& DNSSEC information is requested
6992 with the lookup.
6993 With &"strict"& a response from the DNS resolver that
6994 is not labelled as authenticated data
6995 is treated as equivalent to a temporary DNS error.
6996 The default is &"never"&.
6997
6998 See also the &$lookup_dnssec_authenticated$& variable.
6999
7000 .cindex timeout "dns lookup"
7001 .cindex "DNS" timeout
7002 Timeout for the dnsdb lookup can be controlled by a retrans modifier.
7003 The form is &"retrans_VAL"& where VAL is an Exim time specification
7004 (e.g. &"5s"&).
7005 The default value is set by the main configuration option &%dns_retrans%&.
7006
7007 Retries for the dnsdb lookup can be controlled by a retry modifier.
7008 The form if &"retry_VAL"& where VAL is an integer.
7009 The default count is set by the main configuration option &%dns_retry%&.
7010
7011 .new
7012 .cindex cacheing "of dns lookup"
7013 .cindex TTL "of dns lookup"
7014 .cindex DNS TTL
7015 Dnsdb lookup results are cached within a single process (and its children).
7016 The cache entry lifetime is limited to the smallest time-to-live (TTL)
7017 value of the set of returned DNS records.
7018 .wen
7019
7020
7021 .section "Pseudo dnsdb record types" "SECID66"
7022 .cindex "MX record" "in &(dnsdb)& lookup"
7023 By default, both the preference value and the host name are returned for
7024 each MX record, separated by a space. If you want only host names, you can use
7025 the pseudo-type MXH:
7026 .code
7027 ${lookup dnsdb{mxh=a.b.example}}
7028 .endd
7029 In this case, the preference values are omitted, and just the host names are
7030 returned.
7031
7032 .cindex "name server for enclosing domain"
7033 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
7034 records on the given domain, but if none are found, it removes the first
7035 component of the domain name, and tries again. This process continues until NS
7036 records are found or there are no more components left (or there is a DNS
7037 error). In other words, it may return the name servers for a top-level domain,
7038 but it never returns the root name servers. If there are no NS records for the
7039 top-level domain, the lookup fails. Consider these examples:
7040 .code
7041 ${lookup dnsdb{zns=xxx.quercite.com}}
7042 ${lookup dnsdb{zns=xxx.edu}}
7043 .endd
7044 Assuming that in each case there are no NS records for the full domain name,
7045 the first returns the name servers for &%quercite.com%&, and the second returns
7046 the name servers for &%edu%&.
7047
7048 You should be careful about how you use this lookup because, unless the
7049 top-level domain does not exist, the lookup always returns some host names. The
7050 sort of use to which this might be put is for seeing if the name servers for a
7051 given domain are on a blacklist. You can probably assume that the name servers
7052 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
7053 such a list.
7054
7055 .cindex "CSA" "in &(dnsdb)& lookup"
7056 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
7057 records according to the CSA rules, which are described in section
7058 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
7059 not sufficient because of the extra parent domain search behaviour of CSA. The
7060 result of a successful lookup such as:
7061 .code
7062 ${lookup dnsdb {csa=$sender_helo_name}}
7063 .endd
7064 has two space-separated fields: an authorization code and a target host name.
7065 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
7066 authorization required but absent, or &"?"& for unknown.
7067
7068 .cindex "A+" "in &(dnsdb)& lookup"
7069 The pseudo-type A+ performs an AAAA
7070 and then an A lookup.  All results are returned; defer processing
7071 (see below) is handled separately for each lookup.  Example:
7072 .code
7073 ${lookup dnsdb {>; a+=$sender_helo_name}}
7074 .endd
7075
7076
7077 .section "Multiple dnsdb lookups" "SECID67"
7078 In the previous sections, &(dnsdb)& lookups for a single domain are described.
7079 However, you can specify a list of domains or IP addresses in a single
7080 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
7081 the default separator, but with the ability to change this. For example:
7082 .code
7083 ${lookup dnsdb{one.domain.com:two.domain.com}}
7084 ${lookup dnsdb{a=one.host.com:two.host.com}}
7085 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
7086 .endd
7087 In order to retain backwards compatibility, there is one special case: if
7088 the lookup type is PTR and no change of separator is specified, Exim looks
7089 to see if the rest of the string is precisely one IPv6 address. In this
7090 case, it does not treat it as a list.
7091
7092 The data from each lookup is concatenated, with newline separators by default,
7093 in the same way that multiple DNS records for a single item are handled. A
7094 different separator can be specified, as described above.
7095
7096
7097
7098
7099 .section "More about LDAP" "SECTldap"
7100 .cindex "LDAP" "lookup, more about"
7101 .cindex "lookup" "LDAP"
7102 .cindex "Solaris" "LDAP"
7103 The original LDAP implementation came from the University of Michigan; this has
7104 become &"Open LDAP"&, and there are now two different releases. Another
7105 implementation comes from Netscape, and Solaris 7 and subsequent releases
7106 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7107 the lookup function level, their error handling is different. For this reason
7108 it is necessary to set a compile-time variable when building Exim with LDAP, to
7109 indicate which LDAP library is in use. One of the following should appear in
7110 your &_Local/Makefile_&:
7111 .code
7112 LDAP_LIB_TYPE=UMICHIGAN
7113 LDAP_LIB_TYPE=OPENLDAP1
7114 LDAP_LIB_TYPE=OPENLDAP2
7115 LDAP_LIB_TYPE=NETSCAPE
7116 LDAP_LIB_TYPE=SOLARIS
7117 .endd
7118 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7119 same interface as the University of Michigan version.
7120
7121 There are three LDAP lookup types in Exim. These behave slightly differently in
7122 the way they handle the results of a query:
7123
7124 .ilist
7125 &(ldap)& requires the result to contain just one entry; if there are more, it
7126 gives an error.
7127 .next
7128 &(ldapdn)& also requires the result to contain just one entry, but it is the
7129 Distinguished Name that is returned rather than any attribute values.
7130 .next
7131 &(ldapm)& permits the result to contain more than one entry; the attributes
7132 from all of them are returned.
7133 .endlist
7134
7135
7136 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7137 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7138 the data returned by a successful lookup is described in the next section.
7139 First we explain how LDAP queries are coded.
7140
7141
7142 .section "Format of LDAP queries" "SECTforldaque"
7143 .cindex "LDAP" "query format"
7144 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7145 the configuration of a &(redirect)& router one might have this setting:
7146 .code
7147 data = ${lookup ldap \
7148   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7149   c=UK?mailbox?base?}}
7150 .endd
7151 .cindex "LDAP" "with TLS"
7152 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7153 secure (encrypted) LDAP connections. The second of these ensures that an
7154 encrypted TLS connection is used.
7155
7156 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7157 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7158 See the &%ldap_start_tls%& option.
7159
7160 Starting with Exim 4.83, the initialization of LDAP with TLS is more tightly
7161 controlled. Every part of the TLS configuration can be configured by settings in
7162 &_exim.conf_&. Depending on the version of the client libraries installed on
7163 your system, some of the initialization may have required setting options in
7164 &_/etc/ldap.conf_& or &_~/.ldaprc_& to get TLS working with self-signed
7165 certificates. This revealed a nuance where the current UID that exim was
7166 running as could affect which config files it read. With Exim 4.83, these
7167 methods become optional, only taking effect if not specifically set in
7168 &_exim.conf_&.
7169
7170
7171 .section "LDAP quoting" "SECID68"
7172 .cindex "LDAP" "quoting"
7173 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7174 and the second because the LDAP query is represented as a URL. Furthermore,
7175 within an LDAP query, two different kinds of quoting are required. For this
7176 reason, there are two different LDAP-specific quoting operators.
7177
7178 The &%quote_ldap%& operator is designed for use on strings that are part of
7179 filter specifications. Conceptually, it first does the following conversions on
7180 the string:
7181 .code
7182 *   =>   \2A
7183 (   =>   \28
7184 )   =>   \29
7185 \   =>   \5C
7186 .endd
7187 in accordance with RFC 2254. The resulting string is then quoted according
7188 to the rules for URLs, that is, all non-alphanumeric characters except
7189 .code
7190 ! $ ' - . _ ( ) * +
7191 .endd
7192 are converted to their hex values, preceded by a percent sign. For example:
7193 .code
7194 ${quote_ldap: a(bc)*, a<yz>; }
7195 .endd
7196 yields
7197 .code
7198 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7199 .endd
7200 Removing the URL quoting, this is (with a leading and a trailing space):
7201 .code
7202 a\28bc\29\2A, a<yz>;
7203 .endd
7204 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7205 base DN specifications in queries. Conceptually, it first converts the string
7206 by inserting a backslash in front of any of the following characters:
7207 .code
7208 , + " \ < > ;
7209 .endd
7210 It also inserts a backslash before any leading spaces or # characters, and
7211 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7212 is then quoted according to the rules for URLs. For example:
7213 .code
7214 ${quote_ldap_dn: a(bc)*, a<yz>; }
7215 .endd
7216 yields
7217 .code
7218 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7219 .endd
7220 Removing the URL quoting, this is (with a trailing space):
7221 .code
7222 \ a(bc)*\, a\<yz\>\;\
7223 .endd
7224 There are some further comments about quoting in the section on LDAP
7225 authentication below.
7226
7227
7228 .section "LDAP connections" "SECID69"
7229 .cindex "LDAP" "connections"
7230 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7231 is in use, via a Unix domain socket. The example given above does not specify
7232 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7233 by starting it with
7234 .code
7235 ldap://<hostname>:<port>/...
7236 .endd
7237 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7238 used. When no server is specified in a query, a list of default servers is
7239 taken from the &%ldap_default_servers%& configuration option. This supplies a
7240 colon-separated list of servers which are tried in turn until one successfully
7241 handles a query, or there is a serious error. Successful handling either
7242 returns the requested data, or indicates that it does not exist. Serious errors
7243 are syntactical, or multiple values when only a single value is expected.
7244 Errors which cause the next server to be tried are connection failures, bind
7245 failures, and timeouts.
7246
7247 For each server name in the list, a port number can be given. The standard way
7248 of specifying a host and port is to use a colon separator (RFC 1738). Because
7249 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7250 doubled. For example
7251 .code
7252 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7253 .endd
7254 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7255 to the LDAP library with no server name, and the library's default (normally
7256 the local host) is used.
7257
7258 If you are using the OpenLDAP library, you can connect to an LDAP server using
7259 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7260 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7261 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7262 not available.
7263
7264 For this type of connection, instead of a host name for the server, a pathname
7265 for the socket is required, and the port number is not relevant. The pathname
7266 can be specified either as an item in &%ldap_default_servers%&, or inline in
7267 the query. In the former case, you can have settings such as
7268 .code
7269 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7270 .endd
7271 When the pathname is given in the query, you have to escape the slashes as
7272 &`%2F`& to fit in with the LDAP URL syntax. For example:
7273 .code
7274 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7275 .endd
7276 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7277 a pathname, it uses the Unix domain socket code, even if the query actually
7278 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7279 socket connection. This behaviour means that you can use a setting of
7280 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7281 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7282 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7283 backup host.
7284
7285 If an explicit &`ldapi`& type is given in a query when a host name is
7286 specified, an error is diagnosed. However, if there are more items in
7287 &%ldap_default_servers%&, they are tried. In other words:
7288
7289 .ilist
7290 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7291 interface.
7292 .next
7293 Using &`ldapi`& with a host name causes an error.
7294 .endlist
7295
7296
7297 Using &`ldapi`& with no host or path in the query, and no setting of
7298 &%ldap_default_servers%&, does whatever the library does by default.
7299
7300
7301
7302 .section "LDAP authentication and control information" "SECID70"
7303 .cindex "LDAP" "authentication"
7304 The LDAP URL syntax provides no way of passing authentication and other control
7305 information to the server. To make this possible, the URL in an LDAP query may
7306 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7307 spaces. If a value contains spaces it must be enclosed in double quotes, and
7308 when double quotes are used, backslash is interpreted in the usual way inside
7309 them. The following names are recognized:
7310 .display
7311 &`DEREFERENCE`&  set the dereferencing parameter
7312 &`NETTIME    `&  set a timeout for a network operation
7313 &`USER       `&  set the DN, for authenticating the LDAP bind
7314 &`PASS       `&  set the password, likewise
7315 &`REFERRALS  `&  set the referrals parameter
7316 &`SERVERS    `&  set alternate server list for this query only
7317 &`SIZE       `&  set the limit for the number of entries returned
7318 &`TIME       `&  set the maximum waiting time for a query
7319 .endd
7320 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7321 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7322 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7323 library from trying to follow referrals issued by the LDAP server.
7324
7325 .cindex LDAP timeout
7326 .cindex timeout "LDAP lookup"
7327 The name CONNECT is an obsolete name for NETTIME, retained for
7328 backwards compatibility. This timeout (specified as a number of seconds) is
7329 enforced from the client end for operations that can be carried out over a
7330 network. Specifically, it applies to network connections and calls to the
7331 &'ldap_result()'& function. If the value is greater than zero, it is used if
7332 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7333 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7334 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7335 Netscape SDK; for OpenLDAP no action is taken.
7336
7337 The TIME parameter (also a number of seconds) is passed to the server to
7338 set a server-side limit on the time taken to complete a search.
7339
7340 The SERVERS parameter allows you to specify an alternate list of ldap servers
7341 to use for an individual lookup.  The global &%ldap_default_servers%& option provides a
7342 default list of ldap servers, and a single lookup can specify a single ldap
7343 server to use.  But when you need to do a lookup with a list of servers that is
7344 different than the default list (maybe different order, maybe a completely
7345 different set of servers), the SERVERS parameter allows you to specify this
7346 alternate list (colon-separated).
7347
7348 Here is an example of an LDAP query in an Exim lookup that uses some of these
7349 values. This is a single line, folded to fit on the page:
7350 .code
7351 ${lookup ldap
7352   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7353   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7354   {$value}fail}
7355 .endd
7356 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7357 any of the auxiliary data. Exim configuration settings that include lookups
7358 which contain password information should be preceded by &"hide"& to prevent
7359 non-admin users from using the &%-bP%& option to see their values.
7360
7361 The auxiliary data items may be given in any order. The default is no
7362 connection timeout (the system timeout is used), no user or password, no limit
7363 on the number of entries returned, and no time limit on queries.
7364
7365 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7366 removes any URL quoting that it may contain before passing it LDAP. Apparently
7367 some libraries do this for themselves, but some do not. Removing the URL
7368 quoting has two advantages:
7369
7370 .ilist
7371 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7372 DNs as with DNs inside actual queries.
7373 .next
7374 It permits spaces inside USER= DNs.
7375 .endlist
7376
7377 For example, a setting such as
7378 .code
7379 USER=cn=${quote_ldap_dn:$1}
7380 .endd
7381 should work even if &$1$& contains spaces.
7382
7383 Expanded data for the PASS= value should be quoted using the &%quote%&
7384 expansion operator, rather than the LDAP quote operators. The only reason this
7385 field needs quoting is to ensure that it conforms to the Exim syntax, which
7386 does not allow unquoted spaces. For example:
7387 .code
7388 PASS=${quote:$3}
7389 .endd
7390 The LDAP authentication mechanism can be used to check passwords as part of
7391 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7392 &<<CHAPexpand>>&.
7393
7394
7395
7396 .section "Format of data returned by LDAP" "SECID71"
7397 .cindex "LDAP" "returned data formats"
7398 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7399 as a sequence of values, for example
7400 .code
7401 cn=manager,o=University of Cambridge,c=UK
7402 .endd
7403 The &(ldap)& lookup type generates an error if more than one entry matches the
7404 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7405 the result between the data from different entries. It is possible for multiple
7406 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7407 you know that whatever values are returned all came from a single entry in the
7408 directory.
7409
7410 In the common case where you specify a single attribute in your LDAP query, the
7411 result is not quoted, and does not contain the attribute name. If the attribute
7412 has multiple values, they are separated by commas. Any comma that is
7413 part of an attribute's value is doubled.
7414
7415 If you specify multiple attributes, the result contains space-separated, quoted
7416 strings, each preceded by the attribute name and an equals sign. Within the
7417 quotes, the quote character, backslash, and newline are escaped with
7418 backslashes, and commas are used to separate multiple values for the attribute.
7419 Any commas in attribute values are doubled
7420 (permitting treatment of the values as a comma-separated list).
7421 Apart from the escaping, the string within quotes takes the same form as the
7422 output when a single attribute is requested. Specifying no attributes is the
7423 same as specifying all of an entry's attributes.
7424
7425 Here are some examples of the output format. The first line of each pair is an
7426 LDAP query, and the second is the data that is returned. The attribute called
7427 &%attr1%& has two values, one of them with an embedded comma, whereas
7428 &%attr2%& has only one value. Both attributes are derived from &%attr%&
7429 (they have SUP &%attr%& in their schema definitions).
7430
7431 .code
7432 ldap:///o=base?attr1?sub?(uid=fred)
7433 value1.1,value1,,2
7434
7435 ldap:///o=base?attr2?sub?(uid=fred)
7436 value two
7437
7438 ldap:///o=base?attr?sub?(uid=fred)
7439 value1.1,value1,,2,value two
7440
7441 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7442 attr1="value1.1,value1,,2" attr2="value two"
7443
7444 ldap:///o=base??sub?(uid=fred)
7445 objectClass="top" attr1="value1.1,value1,,2" attr2="value two"
7446 .endd
7447 You can
7448 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7449 results of LDAP lookups.
7450 The &%extract%& operator in string expansions can be used to pick out
7451 individual fields from data that consists of &'key'&=&'value'& pairs.
7452 The &%listextract%& operator should be used to pick out individual values
7453 of attributes, even when only a single value is expected.
7454 The doubling of embedded commas allows you to use the returned data as a
7455 comma separated list (using the "<," syntax for changing the input list separator).
7456
7457
7458
7459
7460 .section "More about NIS+" "SECTnisplus"
7461 .cindex "NIS+ lookup type"
7462 .cindex "lookup" "NIS+"
7463 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7464 and field name. If this is given, the result of a successful query is the
7465 contents of the named field; otherwise the result consists of a concatenation
7466 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7467 values containing spaces are quoted. For example, the query
7468 .code
7469 [name=mg1456],passwd.org_dir
7470 .endd
7471 might return the string
7472 .code
7473 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7474 home=/home/mg1456 shell=/bin/bash shadow=""
7475 .endd
7476 (split over two lines here to fit on the page), whereas
7477 .code
7478 [name=mg1456],passwd.org_dir:gcos
7479 .endd
7480 would just return
7481 .code
7482 Martin Guerre
7483 .endd
7484 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7485 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7486 operator is to double any quote characters within the text.
7487
7488
7489
7490 .section "SQL lookups" "SECTsql"
7491 .cindex "SQL lookup types"
7492 .cindex "MySQL" "lookup type"
7493 .cindex "PostgreSQL lookup type"
7494 .cindex "lookup" "MySQL"
7495 .cindex "lookup" "PostgreSQL"
7496 .cindex "Oracle" "lookup type"
7497 .cindex "lookup" "Oracle"
7498 .cindex "InterBase lookup type"
7499 .cindex "lookup" "InterBase"
7500 .cindex "Redis lookup type"
7501 .cindex lookup Redis
7502 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, Redis,
7503 and SQLite
7504 databases. Queries for these databases contain SQL statements, so an example
7505 might be
7506 .code
7507 ${lookup mysql{select mailbox from users where id='userx'}\
7508   {$value}fail}
7509 .endd
7510 If the result of the query contains more than one field, the data for each
7511 field in the row is returned, preceded by its name, so the result of
7512 .code
7513 ${lookup pgsql{select home,name from users where id='userx'}\
7514   {$value}}
7515 .endd
7516 might be
7517 .code
7518 home=/home/userx name="Mister X"
7519 .endd
7520 Empty values and values containing spaces are double quoted, with embedded
7521 quotes escaped by a backslash. If the result of the query contains just one
7522 field, the value is passed back verbatim, without a field name, for example:
7523 .code
7524 Mister X
7525 .endd
7526 If the result of the query yields more than one row, it is all concatenated,
7527 with a newline between the data for each row.
7528
7529
7530 .section "More about MySQL, PostgreSQL, Oracle, InterBase, and Redis" "SECID72"
7531 .cindex "MySQL" "lookup type"
7532 .cindex "PostgreSQL lookup type"
7533 .cindex "lookup" "MySQL"
7534 .cindex "lookup" "PostgreSQL"
7535 .cindex "Oracle" "lookup type"
7536 .cindex "lookup" "Oracle"
7537 .cindex "InterBase lookup type"
7538 .cindex "lookup" "InterBase"
7539 .cindex "Redis lookup type"
7540 .cindex lookup Redis
7541 If any MySQL, PostgreSQL, Oracle, InterBase or Redis lookups are used, the
7542 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, &%ibase_servers%&,
7543 or &%redis_servers%&
7544 option (as appropriate) must be set to a colon-separated list of server
7545 information.
7546 (For MySQL and PostgreSQL, the global option need not be set if all
7547 queries contain their own server information &-- see section
7548 &<<SECTspeserque>>&.)
7549 For all but Redis
7550 each item in the list is a slash-separated list of four
7551 items: host name, database name, user name, and password. In the case of
7552 Oracle, the host name field is used for the &"service name"&, and the database
7553 name field is not used and should be empty. For example:
7554 .code
7555 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7556 .endd
7557 Because password data is sensitive, you should always precede the setting with
7558 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7559 option. Here is an example where two MySQL servers are listed:
7560 .code
7561 hide mysql_servers = localhost/users/root/secret:\
7562                      otherhost/users/root/othersecret
7563 .endd
7564 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7565 because this is a colon-separated list, the colon has to be doubled. For each
7566 query, these parameter groups are tried in order until a connection is made and
7567 a query is successfully processed. The result of a query may be that no data is
7568 found, but that is still a successful query. In other words, the list of
7569 servers provides a backup facility, not a list of different places to look.
7570
7571 .new
7572 For Redis the global option need not be specified if all queries contain their
7573 own server information &-- see section &<<SECTspeserque>>&.
7574 If specified, the option must be set to a colon-separated list of server
7575 information.
7576 Each item in the list is a slash-separated list of three items:
7577 host, database number, and password.
7578 .olist
7579 The host is required and may be either an IPv4 address and optional
7580 port number (separated by a colon, which needs doubling due to the
7581 higher-level list), or a Unix socket pathname enclosed in parentheses
7582 .next
7583 The database number is optional; if present that number is selected in the backend
7584 .next
7585 The password is optional; if present it is used to authenticate to the backend
7586 .endlist
7587 .wen
7588
7589 .new
7590 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
7591 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
7592 respectively, and the characters single-quote, double-quote, and backslash
7593 itself are escaped with backslashes.
7594
7595 The &%quote_redis%& expansion operator
7596 escapes whitespace and backslash characters with a backslash.
7597 .wen
7598
7599 .section "Specifying the server in the query" "SECTspeserque"
7600 For MySQL, PostgreSQL and Redis lookups (but not currently for Oracle and InterBase),
7601 it is possible to specify a list of servers with an individual query. This is
7602 done by starting the query with
7603 .display
7604 &`servers=`&&'server1:server2:server3:...'&&`;`&
7605 .endd
7606 Each item in the list may take one of two forms:
7607 .olist
7608 If it contains no slashes it is assumed to be just a host name. The appropriate
7609 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
7610 of the same name, and the remaining parameters (database, user, password) are
7611 taken from there.
7612 .next
7613 If it contains any slashes, it is taken as a complete parameter set.
7614 .endlist
7615 The list of servers is used in exactly the same way as the global list.
7616 Once a connection to a server has happened and a query has been
7617 successfully executed, processing of the lookup ceases.
7618
7619 This feature is intended for use in master/slave situations where updates
7620 are occurring and you want to update the master rather than a slave. If the
7621 master is in the list as a backup for reading, you might have a global setting
7622 like this:
7623 .code
7624 mysql_servers = slave1/db/name/pw:\
7625                 slave2/db/name/pw:\
7626                 master/db/name/pw
7627 .endd
7628 In an updating lookup, you could then write:
7629 .code
7630 ${lookup mysql{servers=master; UPDATE ...} }
7631 .endd
7632 That query would then be sent only to the master server. If, on the other hand,
7633 the master is not to be used for reading, and so is not present in the global
7634 option, you can still update it by a query of this form:
7635 .code
7636 ${lookup pgsql{servers=master/db/name/pw; UPDATE ...} }
7637 .endd
7638
7639
7640 .section "Special MySQL features" "SECID73"
7641 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
7642 causes a connection to the server on the local host by means of a Unix domain
7643 socket. An alternate socket can be specified in parentheses.
7644 .new
7645 An option group name for MySQL option files can be specified in square brackets;
7646 the default value is &"exim"&.
7647 .wen
7648 The full syntax of each item in &%mysql_servers%& is:
7649 .display
7650 <&'hostname'&>::<&'port'&>(<&'socket name'&>)[<&'option group'&>]/&&&
7651   <&'database'&>/<&'user'&>/<&'password'&>
7652 .endd
7653 Any of the four sub-parts of the first field can be omitted. For normal use on
7654 the local host it can be left blank or set to just &"localhost"&.
7655
7656 No database need be supplied &-- but if it is absent here, it must be given in
7657 the queries.
7658
7659 If a MySQL query is issued that does not request any data (an insert, update,
7660 or delete command), the result of the lookup is the number of rows affected.
7661
7662 &*Warning*&: This can be misleading. If an update does not actually change
7663 anything (for example, setting a field to the value it already has), the result
7664 is zero because no rows are affected.
7665
7666
7667 .section "Special PostgreSQL features" "SECID74"
7668 PostgreSQL lookups can also use Unix domain socket connections to the database.
7669 This is usually faster and costs less CPU time than a TCP/IP connection.
7670 However it can be used only if the mail server runs on the same machine as the
7671 database server. A configuration line for PostgreSQL via Unix domain sockets
7672 looks like this:
7673 .code
7674 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
7675 .endd
7676 In other words, instead of supplying a host name, a path to the socket is
7677 given. The path name is enclosed in parentheses so that its slashes aren't
7678 visually confused with the delimiters for the other server parameters.
7679
7680 If a PostgreSQL query is issued that does not request any data (an insert,
7681 update, or delete command), the result of the lookup is the number of rows
7682 affected.
7683
7684 .section "More about SQLite" "SECTsqlite"
7685 .cindex "lookup" "SQLite"
7686 .cindex "sqlite lookup type"
7687 SQLite is different to the other SQL lookups because a file name is required in
7688 addition to the SQL query. An SQLite database is a single file, and there is no
7689 daemon as in the other SQL databases. The interface to Exim requires the name
7690 of the file, as an absolute path, to be given at the start of the query. It is
7691 separated from the query by white space. This means that the path name cannot
7692 contain white space. Here is a lookup expansion example:
7693 .code
7694 ${lookup sqlite {/some/thing/sqlitedb \
7695   select name from aliases where id='userx';}}
7696 .endd
7697 In a list, the syntax is similar. For example:
7698 .code
7699 domainlist relay_to_domains = sqlite;/some/thing/sqlitedb \
7700    select * from relays where ip='$sender_host_address';
7701 .endd
7702 The only character affected by the &%quote_sqlite%& operator is a single
7703 quote, which it doubles.
7704
7705 .cindex timeout SQLite
7706 .cindex sqlite "lookup timeout"
7707 The SQLite library handles multiple simultaneous accesses to the database
7708 internally. Multiple readers are permitted, but only one process can
7709 update at once. Attempts to access the database while it is being updated
7710 are rejected after a timeout period, during which the SQLite library
7711 waits for the lock to be released. In Exim, the default timeout is set
7712 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
7713 option.
7714 .ecindex IIDfidalo1
7715 .ecindex IIDfidalo2
7716
7717
7718 . ////////////////////////////////////////////////////////////////////////////
7719 . ////////////////////////////////////////////////////////////////////////////
7720
7721 .chapter "Domain, host, address, and local part lists" &&&
7722          "CHAPdomhosaddlists" &&&
7723          "Domain, host, and address lists"
7724 .scindex IIDdohoadli "lists of domains; hosts; etc."
7725 A number of Exim configuration options contain lists of domains, hosts,
7726 email addresses, or local parts. For example, the &%hold_domains%& option
7727 contains a list of domains whose delivery is currently suspended. These lists
7728 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
7729 arguments to expansion conditions such as &%match_domain%&.
7730
7731 Each item in one of these lists is a pattern to be matched against a domain,
7732 host, email address, or local part, respectively. In the sections below, the
7733 different types of pattern for each case are described, but first we cover some
7734 general facilities that apply to all four kinds of list.
7735
7736 Note that other parts of Exim use a &'string list'& which does not
7737 support all the complexity available in
7738 domain, host, address and local part lists.
7739
7740
7741
7742 .section "Expansion of lists" "SECID75"
7743 .cindex "expansion" "of lists"
7744 Each list is expanded as a single string before it is used. The result of
7745 expansion must be a list, possibly containing empty items, which is split up
7746 into separate items for matching. By default, colon is the separator character,
7747 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
7748 &<<SECTempitelis>>& for details of the list syntax; the second of these
7749 discusses the way to specify empty list items.
7750
7751
7752 If the string expansion is forced to fail, Exim behaves as if the item it is
7753 testing (domain, host, address, or local part) is not in the list. Other
7754 expansion failures cause temporary errors.
7755
7756 If an item in a list is a regular expression, backslashes, dollars and possibly
7757 other special characters in the expression must be protected against
7758 misinterpretation by the string expander. The easiest way to do this is to use
7759 the &`\N`& expansion feature to indicate that the contents of the regular
7760 expression should not be expanded. For example, in an ACL you might have:
7761 .code
7762 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
7763                ${lookup{$domain}lsearch{/badsenders/bydomain}}
7764 .endd
7765 The first item is a regular expression that is protected from expansion by
7766 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
7767 senders based on the receiving domain.
7768
7769
7770
7771
7772 .section "Negated items in lists" "SECID76"
7773 .cindex "list" "negation"
7774 .cindex "negation" "in lists"
7775 Items in a list may be positive or negative. Negative items are indicated by a
7776 leading exclamation mark, which may be followed by optional white space. A list
7777 defines a set of items (domains, etc). When Exim processes one of these lists,
7778 it is trying to find out whether a domain, host, address, or local part
7779 (respectively) is in the set that is defined by the list. It works like this:
7780
7781 The list is scanned from left to right. If a positive item is matched, the
7782 subject that is being checked is in the set; if a negative item is matched, the
7783 subject is not in the set. If the end of the list is reached without the
7784 subject having matched any of the patterns, it is in the set if the last item
7785 was a negative one, but not if it was a positive one. For example, the list in
7786 .code
7787 domainlist relay_to_domains = !a.b.c : *.b.c
7788 .endd
7789 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
7790 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
7791 list is positive. However, if the setting were
7792 .code
7793 domainlist relay_to_domains = !a.b.c
7794 .endd
7795 then all domains other than &'a.b.c'& would match because the last item in the
7796 list is negative. In other words, a list that ends with a negative item behaves
7797 as if it had an extra item &`:*`& on the end.
7798
7799 Another way of thinking about positive and negative items in lists is to read
7800 the connector as &"or"& after a positive item and as &"and"& after a negative
7801 item.
7802
7803
7804
7805 .section "File names in lists" "SECTfilnamlis"
7806 .cindex "list" "file name in"
7807 If an item in a domain, host, address, or local part list is an absolute file
7808 name (beginning with a slash character), each line of the file is read and
7809 processed as if it were an independent item in the list, except that further
7810 file names are not allowed,
7811 and no expansion of the data from the file takes place.
7812 Empty lines in the file are ignored, and the file may also contain comment
7813 lines:
7814
7815 .ilist
7816 For domain and host lists, if a # character appears anywhere in a line of the
7817 file, it and all following characters are ignored.
7818 .next
7819 Because local parts may legitimately contain # characters, a comment in an
7820 address list or local part list file is recognized only if # is preceded by
7821 white space or the start of the line. For example:
7822 .code
7823 not#comment@x.y.z   # but this is a comment
7824 .endd
7825 .endlist
7826
7827 Putting a file name in a list has the same effect as inserting each line of the
7828 file as an item in the list (blank lines and comments excepted). However, there
7829 is one important difference: the file is read each time the list is processed,
7830 so if its contents vary over time, Exim's behaviour changes.
7831
7832 If a file name is preceded by an exclamation mark, the sense of any match
7833 within the file is inverted. For example, if
7834 .code
7835 hold_domains = !/etc/nohold-domains
7836 .endd
7837 and the file contains the lines
7838 .code
7839 !a.b.c
7840 *.b.c
7841 .endd
7842 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
7843 any domain matching &`*.b.c`& is not.
7844
7845
7846
7847 .section "An lsearch file is not an out-of-line list" "SECID77"
7848 As will be described in the sections that follow, lookups can be used in lists
7849 to provide indexed methods of checking list membership. There has been some
7850 confusion about the way &(lsearch)& lookups work in lists. Because
7851 an &(lsearch)& file contains plain text and is scanned sequentially, it is
7852 sometimes thought that it is allowed to contain wild cards and other kinds of
7853 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
7854 always fixed strings, just as for any other single-key lookup type.
7855
7856 If you want to use a file to contain wild-card patterns that form part of a
7857 list, just give the file name on its own, without a search type, as described
7858 in the previous section. You could also use the &(wildlsearch)& or
7859 &(nwildlsearch)&, but there is no advantage in doing this.
7860
7861
7862
7863
7864 .section "Named lists" "SECTnamedlists"
7865 .cindex "named lists"
7866 .cindex "list" "named"
7867 A list of domains, hosts, email addresses, or local parts can be given a name
7868 which is then used to refer to the list elsewhere in the configuration. This is
7869 particularly convenient if the same list is required in several different
7870 places. It also allows lists to be given meaningful names, which can improve
7871 the readability of the configuration. For example, it is conventional to define
7872 a domain list called &'local_domains'& for all the domains that are handled
7873 locally on a host, using a configuration line such as
7874 .code
7875 domainlist local_domains = localhost:my.dom.example
7876 .endd
7877 Named lists are referenced by giving their name preceded by a plus sign, so,
7878 for example, a router that is intended to handle local domains would be
7879 configured with the line
7880 .code
7881 domains = +local_domains
7882 .endd
7883 The first router in a configuration is often one that handles all domains
7884 except the local ones, using a configuration with a negated item like this:
7885 .code
7886 dnslookup:
7887   driver = dnslookup
7888   domains = ! +local_domains
7889   transport = remote_smtp
7890   no_more
7891 .endd
7892 The four kinds of named list are created by configuration lines starting with
7893 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
7894 respectively. Then there follows the name that you are defining, followed by an
7895 equals sign and the list itself. For example:
7896 .code
7897 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
7898 addresslist bad_senders = cdb;/etc/badsenders
7899 .endd
7900 A named list may refer to other named lists:
7901 .code
7902 domainlist  dom1 = first.example : second.example
7903 domainlist  dom2 = +dom1 : third.example
7904 domainlist  dom3 = fourth.example : +dom2 : fifth.example
7905 .endd
7906 &*Warning*&: If the last item in a referenced list is a negative one, the
7907 effect may not be what you intended, because the negation does not propagate
7908 out to the higher level. For example, consider:
7909 .code
7910 domainlist  dom1 = !a.b
7911 domainlist  dom2 = +dom1 : *.b
7912 .endd
7913 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
7914 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
7915 means it matches the second list as well. The effect is not the same as
7916 .code
7917 domainlist  dom2 = !a.b : *.b
7918 .endd
7919 where &'x.y'& does not match. It's best to avoid negation altogether in
7920 referenced lists if you can.
7921
7922 Named lists may have a performance advantage. When Exim is routing an
7923 address or checking an incoming message, it caches the result of tests on named
7924 lists. So, if you have a setting such as
7925 .code
7926 domains = +local_domains
7927 .endd
7928 on several of your routers
7929 or in several ACL statements,
7930 the actual test is done only for the first one. However, the caching works only
7931 if there are no expansions within the list itself or any sublists that it
7932 references. In other words, caching happens only for lists that are known to be
7933 the same each time they are referenced.
7934
7935 By default, there may be up to 16 named lists of each type. This limit can be
7936 extended by changing a compile-time variable. The use of domain and host lists
7937 is recommended for concepts such as local domains, relay domains, and relay
7938 hosts. The default configuration is set up like this.
7939
7940
7941
7942 .section "Named lists compared with macros" "SECID78"
7943 .cindex "list" "named compared with macro"
7944 .cindex "macro" "compared with named list"
7945 At first sight, named lists might seem to be no different from macros in the
7946 configuration file. However, macros are just textual substitutions. If you
7947 write
7948 .code
7949 ALIST = host1 : host2
7950 auth_advertise_hosts = !ALIST
7951 .endd
7952 it probably won't do what you want, because that is exactly the same as
7953 .code
7954 auth_advertise_hosts = !host1 : host2
7955 .endd
7956 Notice that the second host name is not negated. However, if you use a host
7957 list, and write
7958 .code
7959 hostlist alist = host1 : host2
7960 auth_advertise_hosts = ! +alist
7961 .endd
7962 the negation applies to the whole list, and so that is equivalent to
7963 .code
7964 auth_advertise_hosts = !host1 : !host2
7965 .endd
7966
7967
7968 .section "Named list caching" "SECID79"
7969 .cindex "list" "caching of named"
7970 .cindex "caching" "named lists"
7971 While processing a message, Exim caches the result of checking a named list if
7972 it is sure that the list is the same each time. In practice, this means that
7973 the cache operates only if the list contains no $ characters, which guarantees
7974 that it will not change when it is expanded. Sometimes, however, you may have
7975 an expanded list that you know will be the same each time within a given
7976 message. For example:
7977 .code
7978 domainlist special_domains = \
7979            ${lookup{$sender_host_address}cdb{/some/file}}
7980 .endd
7981 This provides a list of domains that depends only on the sending host's IP
7982 address. If this domain list is referenced a number of times (for example,
7983 in several ACL lines, or in several routers) the result of the check is not
7984 cached by default, because Exim does not know that it is going to be the
7985 same list each time.
7986
7987 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
7988 cache the result anyway. For example:
7989 .code
7990 domainlist_cache special_domains = ${lookup{...
7991 .endd
7992 If you do this, you should be absolutely sure that caching is going to do
7993 the right thing in all cases. When in doubt, leave it out.
7994
7995
7996
7997 .section "Domain lists" "SECTdomainlist"
7998 .cindex "domain list" "patterns for"
7999 .cindex "list" "domain list"
8000 Domain lists contain patterns that are to be matched against a mail domain.
8001 The following types of item may appear in domain lists:
8002
8003 .ilist
8004 .cindex "primary host name"
8005 .cindex "host name" "matched in domain list"
8006 .oindex "&%primary_hostname%&"
8007 .cindex "domain list" "matching primary host name"
8008 .cindex "@ in a domain list"
8009 If a pattern consists of a single @ character, it matches the local host name,
8010 as set by the &%primary_hostname%& option (or defaulted). This makes it
8011 possible to use the same configuration file on several different hosts that
8012 differ only in their names.
8013 .next
8014 .cindex "@[] in a domain list"
8015 .cindex "domain list" "matching local IP interfaces"
8016 .cindex "domain literal"
8017 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
8018 in square brackets (as in an email address that contains a domain literal), but
8019 only if that IP address is recognized as local for email routing purposes. The
8020 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
8021 control which of a host's several IP addresses are treated as local.
8022 In today's Internet, the use of domain literals is controversial.
8023 .next
8024 .cindex "@mx_any"
8025 .cindex "@mx_primary"
8026 .cindex "@mx_secondary"
8027 .cindex "domain list" "matching MX pointers to local host"
8028 If a pattern consists of the string &`@mx_any`& it matches any domain that
8029 has an MX record pointing to the local host or to any host that is listed in
8030 .oindex "&%hosts_treat_as_local%&"
8031 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
8032 are similar, except that the first matches only when a primary MX target is the
8033 local host, and the second only when no primary MX target is the local host,
8034 but a secondary MX target is. &"Primary"& means an MX record with the lowest
8035 preference value &-- there may of course be more than one of them.
8036
8037 The MX lookup that takes place when matching a pattern of this type is
8038 performed with the resolver options for widening names turned off. Thus, for
8039 example, a single-component domain will &'not'& be expanded by adding the
8040 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
8041 options of the &(dnslookup)& router for a discussion of domain widening.
8042
8043 Sometimes you may want to ignore certain IP addresses when using one of these
8044 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
8045 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
8046 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
8047 on a router). For example:
8048 .code
8049 domains = @mx_any/ignore=127.0.0.1
8050 .endd
8051 This example matches any domain that has an MX record pointing to one of
8052 the local host's IP addresses other than 127.0.0.1.
8053
8054 The list of IP addresses is in fact processed by the same code that processes
8055 host lists, so it may contain CIDR-coded network specifications and it may also
8056 contain negative items.
8057
8058 Because the list of IP addresses is a sublist within a domain list, you have to
8059 be careful about delimiters if there is more than one address. Like any other
8060 list, the default delimiter can be changed. Thus, you might have:
8061 .code
8062 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
8063           an.other.domain : ...
8064 .endd
8065 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
8066 involved, it is easiest to change the delimiter for the main list as well:
8067 .code
8068 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
8069           an.other.domain ? ...
8070 .endd
8071 .next
8072 .cindex "asterisk" "in domain list"
8073 .cindex "domain list" "asterisk in"
8074 .cindex "domain list" "matching &""ends with""&"
8075 If a pattern starts with an asterisk, the remaining characters of the pattern
8076 are compared with the terminating characters of the domain. The use of &"*"& in
8077 domain lists differs from its use in partial matching lookups. In a domain
8078 list, the character following the asterisk need not be a dot, whereas partial
8079 matching works only in terms of dot-separated components. For example, a domain
8080 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
8081 &'cipher.key.ex'&.
8082
8083 .next
8084 .cindex "regular expressions" "in domain list"
8085 .cindex "domain list" "matching regular expression"
8086 If a pattern starts with a circumflex character, it is treated as a regular
8087 expression, and matched against the domain using a regular expression matching
8088 function. The circumflex is treated as part of the regular expression.
8089 Email domains are case-independent, so this regular expression match is by
8090 default case-independent, but you can make it case-dependent by starting it
8091 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
8092 are given in chapter &<<CHAPregexp>>&.
8093
8094 &*Warning*&: Because domain lists are expanded before being processed, you
8095 must escape any backslash and dollar characters in the regular expression, or
8096 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
8097 it is not to be expanded (unless you really do want to build a regular
8098 expression by expansion, of course).
8099 .next
8100 .cindex "lookup" "in domain list"
8101 .cindex "domain list" "matching by lookup"
8102 If a pattern starts with the name of a single-key lookup type followed by a
8103 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
8104 must be a file name in a suitable format for the lookup type. For example, for
8105 &"cdb;"& it must be an absolute path:
8106 .code
8107 domains = cdb;/etc/mail/local_domains.cdb
8108 .endd
8109 The appropriate type of lookup is done on the file using the domain name as the
8110 key. In most cases, the data that is looked up is not used; Exim is interested
8111 only in whether or not the key is present in the file. However, when a lookup
8112 is used for the &%domains%& option on a router
8113 or a &%domains%& condition in an ACL statement, the data is preserved in the
8114 &$domain_data$& variable and can be referred to in other router options or
8115 other statements in the same ACL.
8116
8117 .next
8118 Any of the single-key lookup type names may be preceded by
8119 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
8120 .code
8121 domains = partial-dbm;/partial/domains
8122 .endd
8123 This causes partial matching logic to be invoked; a description of how this
8124 works is given in section &<<SECTpartiallookup>>&.
8125
8126 .next
8127 .cindex "asterisk" "in lookup type"
8128 Any of the single-key lookup types may be followed by an asterisk. This causes
8129 a default lookup for a key consisting of a single asterisk to be done if the
8130 original lookup fails. This is not a useful feature when using a domain list to
8131 select particular domains (because any domain would match), but it might have
8132 value if the result of the lookup is being used via the &$domain_data$&
8133 expansion variable.
8134 .next
8135 If the pattern starts with the name of a query-style lookup type followed by a
8136 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
8137 pattern must be an appropriate query for the lookup type, as described in
8138 chapter &<<CHAPfdlookup>>&. For example:
8139 .code
8140 hold_domains = mysql;select domain from holdlist \
8141   where domain = '${quote_mysql:$domain}';
8142 .endd
8143 In most cases, the data that is looked up is not used (so for an SQL query, for
8144 example, it doesn't matter what field you select). Exim is interested only in
8145 whether or not the query succeeds. However, when a lookup is used for the
8146 &%domains%& option on a router, the data is preserved in the &$domain_data$&
8147 variable and can be referred to in other options.
8148 .next
8149 .cindex "domain list" "matching literal domain name"
8150 If none of the above cases apply, a caseless textual comparison is made
8151 between the pattern and the domain.
8152 .endlist
8153
8154 Here is an example that uses several different kinds of pattern:
8155 .code
8156 domainlist funny_domains = \
8157   @ : \
8158   lib.unseen.edu : \
8159   *.foundation.fict.example : \
8160   \N^[1-2]\d{3}\.fict\.example$\N : \
8161   partial-dbm;/opt/data/penguin/book : \
8162   nis;domains.byname : \
8163   nisplus;[name=$domain,status=local],domains.org_dir
8164 .endd
8165 There are obvious processing trade-offs among the various matching modes. Using
8166 an asterisk is faster than a regular expression, and listing a few names
8167 explicitly probably is too. The use of a file or database lookup is expensive,
8168 but may be the only option if hundreds of names are required. Because the
8169 patterns are tested in order, it makes sense to put the most commonly matched
8170 patterns earlier.
8171
8172
8173
8174 .section "Host lists" "SECThostlist"
8175 .cindex "host list" "patterns in"
8176 .cindex "list" "host list"
8177 Host lists are used to control what remote hosts are allowed to do. For
8178 example, some hosts may be allowed to use the local host as a relay, and some
8179 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8180 two different ways, by name or by IP address. In a host list, some types of
8181 pattern are matched to a host name, and some are matched to an IP address.
8182 You need to be particularly careful with this when single-key lookups are
8183 involved, to ensure that the right value is being used as the key.
8184
8185
8186 .section "Special host list patterns" "SECID80"
8187 .cindex "empty item in hosts list"
8188 .cindex "host list" "empty string in"
8189 If a host list item is the empty string, it matches only when no remote host is
8190 involved. This is the case when a message is being received from a local
8191 process using SMTP on the standard input, that is, when a TCP/IP connection is
8192 not used.
8193
8194 .cindex "asterisk" "in host list"
8195 The special pattern &"*"& in a host list matches any host or no host. Neither
8196 the IP address nor the name is actually inspected.
8197
8198
8199
8200 .section "Host list patterns that match by IP address" "SECThoslispatip"
8201 .cindex "host list" "matching IP addresses"
8202 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8203 the incoming address actually appears in the IPv6 host as
8204 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8205 list, it is converted into a traditional IPv4 address first. (Not all operating
8206 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8207 concerns.)
8208
8209 The following types of pattern in a host list check the remote host by
8210 inspecting its IP address:
8211
8212 .ilist
8213 If the pattern is a plain domain name (not a regular expression, not starting
8214 with *, not a lookup of any kind), Exim calls the operating system function
8215 to find the associated IP address(es). Exim uses the newer
8216 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8217 This typically causes a forward DNS lookup of the name. The result is compared
8218 with the IP address of the subject host.
8219
8220 If there is a temporary problem (such as a DNS timeout) with the host name
8221 lookup, a temporary error occurs. For example, if the list is being used in an
8222 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8223 temporary SMTP error code. If no IP address can be found for the host name,
8224 what happens is described in section &<<SECTbehipnot>>& below.
8225
8226 .next
8227 .cindex "@ in a host list"
8228 If the pattern is &"@"&, the primary host name is substituted and used as a
8229 domain name, as just described.
8230
8231 .next
8232 If the pattern is an IP address, it is matched against the IP address of the
8233 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8234 IPv6 addresses can be given in colon-separated format, but the colons have to
8235 be doubled so as not to be taken as item separators when the default list
8236 separator is used. IPv6 addresses are recognized even when Exim is compiled
8237 without IPv6 support. This means that if they appear in a host list on an
8238 IPv4-only host, Exim will not treat them as host names. They are just addresses
8239 that can never match a client host.
8240
8241 .next
8242 .cindex "@[] in a host list"
8243 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8244 the local host. For example, if the local host is an IPv4 host with one
8245 interface address 10.45.23.56, these two ACL statements have the same effect:
8246 .code
8247 accept hosts = 127.0.0.1 : 10.45.23.56
8248 accept hosts = @[]
8249 .endd
8250 .next
8251 .cindex "CIDR notation"
8252 If the pattern is an IP address followed by a slash and a mask length (for
8253 example 10.11.42.0/24), it is matched against the IP address of the subject
8254 host under the given mask. This allows, an entire network of hosts to be
8255 included (or excluded) by a single item. The mask uses CIDR notation; it
8256 specifies the number of address bits that must match, starting from the most
8257 significant end of the address.
8258
8259 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8260 of a range of addresses. It is the number of bits in the network portion of the
8261 address. The above example specifies a 24-bit netmask, so it matches all 256
8262 addresses in the 10.11.42.0 network. An item such as
8263 .code
8264 192.168.23.236/31
8265 .endd
8266 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8267 32 for an IPv4 address is the same as no mask at all; just a single address
8268 matches.
8269
8270 Here is another example which shows an IPv4 and an IPv6 network:
8271 .code
8272 recipient_unqualified_hosts = 192.168.0.0/16: \
8273                               3ffe::ffff::836f::::/48
8274 .endd
8275 The doubling of list separator characters applies only when these items
8276 appear inline in a host list. It is not required when indirecting via a file.
8277 For example:
8278 .code
8279 recipient_unqualified_hosts = /opt/exim/unqualnets
8280 .endd
8281 could make use of a file containing
8282 .code
8283 172.16.0.0/12
8284 3ffe:ffff:836f::/48
8285 .endd
8286 to have exactly the same effect as the previous example. When listing IPv6
8287 addresses inline, it is usually more convenient to use the facility for
8288 changing separator characters. This list contains the same two networks:
8289 .code
8290 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8291                                  3ffe:ffff:836f::/48
8292 .endd
8293 The separator is changed to semicolon by the leading &"<;"& at the start of the
8294 list.
8295 .endlist
8296
8297
8298
8299 .section "Host list patterns for single-key lookups by host address" &&&
8300          "SECThoslispatsikey"
8301 .cindex "host list" "lookup of IP address"
8302 When a host is to be identified by a single-key lookup of its complete IP
8303 address, the pattern takes this form:
8304 .display
8305 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8306 .endd
8307 For example:
8308 .code
8309 hosts_lookup = net-cdb;/hosts-by-ip.db
8310 .endd
8311 The text form of the IP address of the subject host is used as the lookup key.
8312 IPv6 addresses are converted to an unabbreviated form, using lower case
8313 letters, with dots as separators because colon is the key terminator in
8314 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8315 quoting the keys, but this is a facility that was added later.] The data
8316 returned by the lookup is not used.
8317
8318 .cindex "IP address" "masking"
8319 .cindex "host list" "masked IP address"
8320 Single-key lookups can also be performed using masked IP addresses, using
8321 patterns of this form:
8322 .display
8323 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8324 .endd
8325 For example:
8326 .code
8327 net24-dbm;/networks.db
8328 .endd
8329 The IP address of the subject host is masked using <&'number'&> as the mask
8330 length. A textual string is constructed from the masked value, followed by the
8331 mask, and this is used as the lookup key. For example, if the host's IP address
8332 is 192.168.34.6, the key that is looked up for the above example is
8333 &"192.168.34.0/24"&.
8334
8335 When an IPv6 address is converted to a string, dots are normally used instead
8336 of colons, so that keys in &(lsearch)& files need not contain colons (which
8337 terminate &(lsearch)& keys). This was implemented some time before the ability
8338 to quote keys was made available in &(lsearch)& files. However, the more
8339 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8340 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8341 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8342 converted using colons and not dots. In all cases, full, unabbreviated IPv6
8343 addresses are always used.
8344
8345 Ideally, it would be nice to tidy up this anomalous situation by changing to
8346 colons in all cases, given that quoting is now available for &(lsearch)&.
8347 However, this would be an incompatible change that might break some existing
8348 configurations.
8349
8350 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8351 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8352 the former case the key strings include the mask value, whereas in the latter
8353 case the IP address is used on its own.
8354
8355
8356
8357 .section "Host list patterns that match by host name" "SECThoslispatnam"
8358 .cindex "host" "lookup failures"
8359 .cindex "unknown host name"
8360 .cindex "host list" "matching host name"
8361 There are several types of pattern that require Exim to know the name of the
8362 remote host. These are either wildcard patterns or lookups by name. (If a
8363 complete hostname is given without any wildcarding, it is used to find an IP
8364 address to match against, as described in section &<<SECThoslispatip>>&
8365 above.)
8366
8367 If the remote host name is not already known when Exim encounters one of these
8368 patterns, it has to be found from the IP address.
8369 Although many sites on the Internet are conscientious about maintaining reverse
8370 DNS data for their hosts, there are also many that do not do this.
8371 Consequently, a name cannot always be found, and this may lead to unwanted
8372 effects. Take care when configuring host lists with wildcarded name patterns.
8373 Consider what will happen if a name cannot be found.
8374
8375 Because of the problems of determining host names from IP addresses, matching
8376 against host names is not as common as matching against IP addresses.
8377
8378 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8379 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8380 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8381 are done can be changed by setting the &%host_lookup_order%& option. For
8382 security, once Exim has found one or more names, it looks up the IP addresses
8383 for these names and compares them with the IP address that it started with.
8384 Only those names whose IP addresses match are accepted. Any other names are
8385 discarded. If no names are left, Exim behaves as if the host name cannot be
8386 found. In the most common case there is only one name and one IP address.
8387
8388 There are some options that control what happens if a host name cannot be
8389 found. These are described in section &<<SECTbehipnot>>& below.
8390
8391 .cindex "host" "alias for"
8392 .cindex "alias for host"
8393 As a result of aliasing, hosts may have more than one name. When processing any
8394 of the following types of pattern, all the host's names are checked:
8395
8396 .ilist
8397 .cindex "asterisk" "in host list"
8398 If a pattern starts with &"*"& the remainder of the item must match the end of
8399 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8400 &'.b.c'&. This special simple form is provided because this is a very common
8401 requirement. Other kinds of wildcarding require the use of a regular
8402 expression.
8403 .next
8404 .cindex "regular expressions" "in host list"
8405 .cindex "host list" "regular expression in"
8406 If the item starts with &"^"& it is taken to be a regular expression which is
8407 matched against the host name. Host names are case-independent, so this regular
8408 expression match is by default case-independent, but you can make it
8409 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
8410 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
8411 example,
8412 .code
8413 ^(a|b)\.c\.d$
8414 .endd
8415 is a regular expression that matches either of the two hosts &'a.c.d'& or
8416 &'b.c.d'&. When a regular expression is used in a host list, you must take care
8417 that backslash and dollar characters are not misinterpreted as part of the
8418 string expansion. The simplest way to do this is to use &`\N`& to mark that
8419 part of the string as non-expandable. For example:
8420 .code
8421 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
8422 .endd
8423 &*Warning*&: If you want to match a complete host name, you must include the
8424 &`$`& terminating metacharacter in the regular expression, as in the above
8425 example. Without it, a match at the start of the host name is all that is
8426 required.
8427 .endlist
8428
8429
8430
8431
8432 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
8433 .cindex "host" "lookup failures, permanent"
8434 While processing a host list, Exim may need to look up an IP address from a
8435 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
8436 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
8437 behaviour when it fails to find the information it is seeking is the same.
8438
8439 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
8440 apply to temporary DNS errors, whose handling is described in the next section.
8441
8442 .cindex "&`+include_unknown`&"
8443 .cindex "&`+ignore_unknown`&"
8444 Exim parses a host list from left to right. If it encounters a permanent
8445 lookup failure in any item in the host list before it has found a match,
8446 Exim treats it as a failure and the default behavior is as if the host
8447 does not match the list. This may not always be what you want to happen.
8448 To change Exim's behaviour, the special items &`+include_unknown`& or
8449 &`+ignore_unknown`& may appear in the list (at top level &-- they are
8450 not recognized in an indirected file).
8451
8452 .ilist
8453 If any item that follows &`+include_unknown`& requires information that
8454 cannot found, Exim behaves as if the host does match the list. For example,
8455 .code
8456 host_reject_connection = +include_unknown:*.enemy.ex
8457 .endd
8458 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
8459 any hosts whose name it cannot find.
8460
8461 .next
8462 If any item that follows &`+ignore_unknown`& requires information that cannot
8463 be found, Exim ignores that item and proceeds to the rest of the list. For
8464 example:
8465 .code
8466 accept hosts = +ignore_unknown : friend.example : \
8467                192.168.4.5
8468 .endd
8469 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
8470 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
8471 name can be found for 192.168.4.5, it is rejected.
8472 .endlist
8473
8474 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
8475 list. The effect of each one lasts until the next, or until the end of the
8476 list.
8477
8478 .section "Mixing wildcarded host names and addresses in host lists" &&&
8479          "SECTmixwilhos"
8480 .cindex "host list" "mixing names and addresses in"
8481
8482 This section explains the host/ip processing logic with the same concepts
8483 as the previous section, but specifically addresses what happens when a
8484 wildcarded hostname is one of the items in the hostlist.
8485
8486 .ilist
8487 If you have name lookups or wildcarded host names and
8488 IP addresses in the same host list, you should normally put the IP
8489 addresses first. For example, in an ACL you could have:
8490 .code
8491 accept hosts = 10.9.8.7 : *.friend.example
8492 .endd
8493 The reason you normally would order it this way lies in the
8494 left-to-right way that Exim processes lists.  It can test IP addresses
8495 without doing any DNS lookups, but when it reaches an item that requires
8496 a host name, it fails if it cannot find a host name to compare with the
8497 pattern. If the above list is given in the opposite order, the
8498 &%accept%& statement fails for a host whose name cannot be found, even
8499 if its IP address is 10.9.8.7.
8500
8501 .next
8502 If you really do want to do the name check first, and still recognize the IP
8503 address, you can rewrite the ACL like this:
8504 .code
8505 accept hosts = *.friend.example
8506 accept hosts = 10.9.8.7
8507 .endd
8508 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
8509 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
8510 &`+ignore_unknown`&, which was discussed in depth in the first example in
8511 this section.
8512 .endlist
8513
8514
8515 .section "Temporary DNS errors when looking up host information" &&&
8516          "SECTtemdnserr"
8517 .cindex "host" "lookup failures, temporary"
8518 .cindex "&`+include_defer`&"
8519 .cindex "&`+ignore_defer`&"
8520 A temporary DNS lookup failure normally causes a defer action (except when
8521 &%dns_again_means_nonexist%& converts it into a permanent error). However,
8522 host lists can include &`+ignore_defer`& and &`+include_defer`&, analogous to
8523 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
8524 section. These options should be used with care, probably only in non-critical
8525 host lists such as whitelists.
8526
8527
8528
8529 .section "Host list patterns for single-key lookups by host name" &&&
8530          "SECThoslispatnamsk"
8531 .cindex "unknown host name"
8532 .cindex "host list" "matching host name"
8533 If a pattern is of the form
8534 .display
8535 <&'single-key-search-type'&>;<&'search-data'&>
8536 .endd
8537 for example
8538 .code
8539 dbm;/host/accept/list
8540 .endd
8541 a single-key lookup is performed, using the host name as its key. If the
8542 lookup succeeds, the host matches the item. The actual data that is looked up
8543 is not used.
8544
8545 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
8546 keys in the file, not IP addresses. If you want to do lookups based on IP
8547 addresses, you must precede the search type with &"net-"& (see section
8548 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
8549 two items in the same list, one doing an address lookup and one doing a name
8550 lookup, both using the same file.
8551
8552
8553
8554 .section "Host list patterns for query-style lookups" "SECID81"
8555 If a pattern is of the form
8556 .display
8557 <&'query-style-search-type'&>;<&'query'&>
8558 .endd
8559 the query is obeyed, and if it succeeds, the host matches the item. The actual
8560 data that is looked up is not used. The variables &$sender_host_address$& and
8561 &$sender_host_name$& can be used in the query. For example:
8562 .code
8563 hosts_lookup = pgsql;\
8564   select ip from hostlist where ip='$sender_host_address'
8565 .endd
8566 The value of &$sender_host_address$& for an IPv6 address contains colons. You
8567 can use the &%sg%& expansion item to change this if you need to. If you want to
8568 use masked IP addresses in database queries, you can use the &%mask%& expansion
8569 operator.
8570
8571 If the query contains a reference to &$sender_host_name$&, Exim automatically
8572 looks up the host name if it has not already done so. (See section
8573 &<<SECThoslispatnam>>& for comments on finding host names.)
8574
8575 Historical note: prior to release 4.30, Exim would always attempt to find a
8576 host name before running the query, unless the search type was preceded by
8577 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
8578 still recognized for query-style lookups, but its presence or absence has no
8579 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
8580 See section &<<SECThoslispatsikey>>&.)
8581
8582
8583
8584
8585
8586 .section "Address lists" "SECTaddresslist"
8587 .cindex "list" "address list"
8588 .cindex "address list" "empty item"
8589 .cindex "address list" "patterns"
8590 Address lists contain patterns that are matched against mail addresses. There
8591 is one special case to be considered: the sender address of a bounce message is
8592 always empty. You can test for this by providing an empty item in an address
8593 list. For example, you can set up a router to process bounce messages by
8594 using this option setting:
8595 .code
8596 senders = :
8597 .endd
8598 The presence of the colon creates an empty item. If you do not provide any
8599 data, the list is empty and matches nothing. The empty sender can also be
8600 detected by a regular expression that matches an empty string,
8601 and by a query-style lookup that succeeds when &$sender_address$& is empty.
8602
8603 Non-empty items in an address list can be straightforward email addresses. For
8604 example:
8605 .code
8606 senders = jbc@askone.example : hs@anacreon.example
8607 .endd
8608 A certain amount of wildcarding is permitted. If a pattern contains an @
8609 character, but is not a regular expression and does not begin with a
8610 semicolon-terminated lookup type (described below), the local part of the
8611 subject address is compared with the local part of the pattern, which may start
8612 with an asterisk. If the local parts match, the domain is checked in exactly
8613 the same way as for a pattern in a domain list. For example, the domain can be
8614 wildcarded, refer to a named list, or be a lookup:
8615 .code
8616 deny senders = *@*.spamming.site:\
8617                *@+hostile_domains:\
8618                bozo@partial-lsearch;/list/of/dodgy/sites:\
8619                *@dbm;/bad/domains.db
8620 .endd
8621 .cindex "local part" "starting with !"
8622 .cindex "address list" "local part starting with !"
8623 If a local part that begins with an exclamation mark is required, it has to be
8624 specified using a regular expression, because otherwise the exclamation mark is
8625 treated as a sign of negation, as is standard in lists.
8626
8627 If a non-empty pattern that is not a regular expression or a lookup does not
8628 contain an @ character, it is matched against the domain part of the subject
8629 address. The only two formats that are recognized this way are a literal
8630 domain, or a domain pattern that starts with *. In both these cases, the effect
8631 is the same as if &`*@`& preceded the pattern. For example:
8632 .code
8633 deny senders = enemy.domain : *.enemy.domain
8634 .endd
8635
8636 The following kinds of more complicated address list pattern can match any
8637 address, including the empty address that is characteristic of bounce message
8638 senders:
8639
8640 .ilist
8641 .cindex "regular expressions" "in address list"
8642 .cindex "address list" "regular expression in"
8643 If (after expansion) a pattern starts with &"^"&, a regular expression match is
8644 done against the complete address, with the pattern as the regular expression.
8645 You must take care that backslash and dollar characters are not misinterpreted
8646 as part of the string expansion. The simplest way to do this is to use &`\N`&
8647 to mark that part of the string as non-expandable. For example:
8648 .code
8649 deny senders = \N^.*this.*@example\.com$\N : \
8650                \N^\d{8}.+@spamhaus.example$\N : ...
8651 .endd
8652 The &`\N`& sequences are removed by the expansion, so these items do indeed
8653 start with &"^"& by the time they are being interpreted as address patterns.
8654
8655 .next
8656 .cindex "address list" "lookup for complete address"
8657 Complete addresses can be looked up by using a pattern that starts with a
8658 lookup type terminated by a semicolon, followed by the data for the lookup. For
8659 example:
8660 .code
8661 deny senders = cdb;/etc/blocked.senders : \
8662   mysql;select address from blocked where \
8663   address='${quote_mysql:$sender_address}'
8664 .endd
8665 Both query-style and single-key lookup types can be used. For a single-key
8666 lookup type, Exim uses the complete address as the key. However, empty keys are
8667 not supported for single-key lookups, so a match against the empty address
8668 always fails. This restriction does not apply to query-style lookups.
8669
8670 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
8671 cannot be used, and is ignored if specified, with an entry being written to the
8672 panic log.
8673 .cindex "*@ with single-key lookup"
8674 However, you can configure lookup defaults, as described in section
8675 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
8676 default. For example, with this lookup:
8677 .code
8678 accept senders = lsearch*@;/some/file
8679 .endd
8680 the file could contains lines like this:
8681 .code
8682 user1@domain1.example
8683 *@domain2.example
8684 .endd
8685 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
8686 that are tried is:
8687 .code
8688 nimrod@jaeger.example
8689 *@jaeger.example
8690 *
8691 .endd
8692 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
8693 would mean that every address matches, thus rendering the test useless.
8694
8695 &*Warning 2*&: Do not confuse these two kinds of item:
8696 .code
8697 deny recipients = dbm*@;/some/file
8698 deny recipients = *@dbm;/some/file
8699 .endd
8700 The first does a whole address lookup, with defaulting, as just described,
8701 because it starts with a lookup type. The second matches the local part and
8702 domain independently, as described in a bullet point below.
8703 .endlist
8704
8705
8706 The following kinds of address list pattern can match only non-empty addresses.
8707 If the subject address is empty, a match against any of these pattern types
8708 always fails.
8709
8710
8711 .ilist
8712 .cindex "@@ with single-key lookup"
8713 .cindex "address list" "@@ lookup type"
8714 .cindex "address list" "split local part and domain"
8715 If a pattern starts with &"@@"& followed by a single-key lookup item
8716 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
8717 split into a local part and a domain. The domain is looked up in the file. If
8718 it is not found, there is no match. If it is found, the data that is looked up
8719 from the file is treated as a colon-separated list of local part patterns, each
8720 of which is matched against the subject local part in turn.
8721
8722 .cindex "asterisk" "in address list"
8723 The lookup may be a partial one, and/or one involving a search for a default
8724 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
8725 patterns that are looked up can be regular expressions or begin with &"*"&, or
8726 even be further lookups. They may also be independently negated. For example,
8727 with
8728 .code
8729 deny senders = @@dbm;/etc/reject-by-domain
8730 .endd
8731 the data from which the DBM file is built could contain lines like
8732 .code
8733 baddomain.com:  !postmaster : *
8734 .endd
8735 to reject all senders except &%postmaster%& from that domain.
8736
8737 .cindex "local part" "starting with !"
8738 If a local part that actually begins with an exclamation mark is required, it
8739 has to be specified using a regular expression. In &(lsearch)& files, an entry
8740 may be split over several lines by indenting the second and subsequent lines,
8741 but the separating colon must still be included at line breaks. White space
8742 surrounding the colons is ignored. For example:
8743 .code
8744 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
8745   spammer3 : spammer4
8746 .endd
8747 As in all colon-separated lists in Exim, a colon can be included in an item by
8748 doubling.
8749
8750 If the last item in the list starts with a right angle-bracket, the remainder
8751 of the item is taken as a new key to look up in order to obtain a continuation
8752 list of local parts. The new key can be any sequence of characters. Thus one
8753 might have entries like
8754 .code
8755 aol.com: spammer1 : spammer 2 : >*
8756 xyz.com: spammer3 : >*
8757 *:       ^\d{8}$
8758 .endd
8759 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
8760 local parts for all domains, in addition to the specific local parts listed for
8761 each domain. Of course, using this feature costs another lookup each time a
8762 chain is followed, but the effort needed to maintain the data is reduced.
8763
8764 .cindex "loop" "in lookups"
8765 It is possible to construct loops using this facility, and in order to catch
8766 them, the chains may be no more than fifty items long.
8767
8768 .next
8769 The @@<&'lookup'&> style of item can also be used with a query-style
8770 lookup, but in this case, the chaining facility is not available. The lookup
8771 can only return a single list of local parts.
8772 .endlist
8773
8774 &*Warning*&: There is an important difference between the address list items
8775 in these two examples:
8776 .code
8777 senders = +my_list
8778 senders = *@+my_list
8779 .endd
8780 In the first one, &`my_list`& is a named address list, whereas in the second
8781 example it is a named domain list.
8782
8783
8784
8785
8786 .section "Case of letters in address lists" "SECTcasletadd"
8787 .cindex "case of local parts"
8788 .cindex "address list" "case forcing"
8789 .cindex "case forcing in address lists"
8790 Domains in email addresses are always handled caselessly, but for local parts
8791 case may be significant on some systems (see &%caseful_local_part%& for how
8792 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
8793 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
8794 blocking lists should be done in a case-independent manner. Since most address
8795 lists in Exim are used for this kind of control, Exim attempts to do this by
8796 default.
8797
8798 The domain portion of an address is always lowercased before matching it to an
8799 address list. The local part is lowercased by default, and any string
8800 comparisons that take place are done caselessly. This means that the data in
8801 the address list itself, in files included as plain file names, and in any file
8802 that is looked up using the &"@@"& mechanism, can be in any case. However, the
8803 keys in files that are looked up by a search type other than &(lsearch)& (which
8804 works caselessly) must be in lower case, because these lookups are not
8805 case-independent.
8806
8807 .cindex "&`+caseful`&"
8808 To allow for the possibility of caseful address list matching, if an item in
8809 an address list is the string &"+caseful"&, the original case of the local
8810 part is restored for any comparisons that follow, and string comparisons are no
8811 longer case-independent. This does not affect the domain, which remains in
8812 lower case. However, although independent matches on the domain alone are still
8813 performed caselessly, regular expressions that match against an entire address
8814 become case-sensitive after &"+caseful"& has been seen.
8815
8816
8817
8818 .section "Local part lists" "SECTlocparlis"
8819 .cindex "list" "local part list"
8820 .cindex "local part" "list"
8821 Case-sensitivity in local part lists is handled in the same way as for address
8822 lists, as just described. The &"+caseful"& item can be used if required. In a
8823 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
8824 set false, the subject is lowercased and the matching is initially
8825 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
8826 matching in the local part list, but not elsewhere in the router. If
8827 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
8828 option is case-sensitive from the start.
8829
8830 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
8831 comments are handled in the same way as address lists &-- they are recognized
8832 only if the # is preceded by white space or the start of the line.
8833 Otherwise, local part lists are matched in the same way as domain lists, except
8834 that the special items that refer to the local host (&`@`&, &`@[]`&,
8835 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
8836 Refer to section &<<SECTdomainlist>>& for details of the other available item
8837 types.
8838 .ecindex IIDdohoadli
8839
8840
8841
8842
8843 . ////////////////////////////////////////////////////////////////////////////
8844 . ////////////////////////////////////////////////////////////////////////////
8845
8846 .chapter "String expansions" "CHAPexpand"
8847 .scindex IIDstrexp "expansion" "of strings"
8848 Many strings in Exim's run time configuration are expanded before use. Some of
8849 them are expanded every time they are used; others are expanded only once.
8850
8851 When a string is being expanded it is copied verbatim from left to right except
8852 when a dollar or backslash character is encountered. A dollar specifies the
8853 start of a portion of the string that is interpreted and replaced as described
8854 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
8855 escape character, as described in the following section.
8856
8857 Whether a string is expanded depends upon the context.  Usually this is solely
8858 dependent upon the option for which a value is sought; in this documentation,
8859 options for which string expansion is performed are marked with &dagger; after
8860 the data type.  ACL rules always expand strings.  A couple of expansion
8861 conditions do not expand some of the brace-delimited branches, for security
8862 reasons.
8863
8864
8865
8866 .section "Literal text in expanded strings" "SECTlittext"
8867 .cindex "expansion" "including literal text"
8868 An uninterpreted dollar can be included in an expanded string by putting a
8869 backslash in front of it. A backslash can be used to prevent any special
8870 character being treated specially in an expansion, including backslash itself.
8871 If the string appears in quotes in the configuration file, two backslashes are
8872 required because the quotes themselves cause interpretation of backslashes when
8873 the string is read in (see section &<<SECTstrings>>&).
8874
8875 .cindex "expansion" "non-expandable substrings"
8876 A portion of the string can specified as non-expandable by placing it between
8877 two occurrences of &`\N`&. This is particularly useful for protecting regular
8878 expressions, which often contain backslashes and dollar signs. For example:
8879 .code
8880 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
8881 .endd
8882 On encountering the first &`\N`&, the expander copies subsequent characters
8883 without interpretation until it reaches the next &`\N`& or the end of the
8884 string.
8885
8886
8887
8888 .section "Character escape sequences in expanded strings" "SECID82"
8889 .cindex "expansion" "escape sequences"
8890 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
8891 expanded string is recognized as an escape sequence for the character newline,
8892 carriage return, or tab, respectively. A backslash followed by up to three
8893 octal digits is recognized as an octal encoding for a single character, and a
8894 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
8895 encoding.
8896
8897 These escape sequences are also recognized in quoted strings when they are read
8898 in. Their interpretation in expansions as well is useful for unquoted strings,
8899 and for other cases such as looked-up strings that are then expanded.
8900
8901
8902 .section "Testing string expansions" "SECID83"
8903 .cindex "expansion" "testing"
8904 .cindex "testing" "string expansion"
8905 .oindex "&%-be%&"
8906 Many expansions can be tested by calling Exim with the &%-be%& option. This
8907 takes the command arguments, or lines from the standard input if there are no
8908 arguments, runs them through the string expansion code, and writes the results
8909 to the standard output. Variables based on configuration values are set up, but
8910 since no message is being processed, variables such as &$local_part$& have no
8911 value. Nevertheless the &%-be%& option can be useful for checking out file and
8912 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
8913 and &%nhash%&.
8914
8915 Exim gives up its root privilege when it is called with the &%-be%& option, and
8916 instead runs under the uid and gid it was called with, to prevent users from
8917 using &%-be%& for reading files to which they do not have access.
8918
8919 .oindex "&%-bem%&"
8920 If you want to test expansions that include variables whose values are taken
8921 from a message, there are two other options that can be used. The &%-bem%&
8922 option is like &%-be%& except that it is followed by a file name. The file is
8923 read as a message before doing the test expansions. For example:
8924 .code
8925 exim -bem /tmp/test.message '$h_subject:'
8926 .endd
8927 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
8928 Exim message identifier. For example:
8929 .code
8930 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
8931 .endd
8932 This loads the message from Exim's spool before doing the test expansions, and
8933 is therefore restricted to admin users.
8934
8935
8936 .section "Forced expansion failure" "SECTforexpfai"
8937 .cindex "expansion" "forced failure"
8938 A number of expansions that are described in the following section have
8939 alternative &"true"& and &"false"& substrings, enclosed in brace characters
8940 (which are sometimes called &"curly brackets"&). Which of the two strings is
8941 used depends on some condition that is evaluated as part of the expansion. If,
8942 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
8943 the entire string expansion fails in a way that can be detected by the code
8944 that requested the expansion. This is called &"forced expansion failure"&, and
8945 its consequences depend on the circumstances. In some cases it is no different
8946 from any other expansion failure, but in others a different action may be
8947 taken. Such variations are mentioned in the documentation of the option that is
8948 being expanded.
8949
8950
8951
8952
8953 .section "Expansion items" "SECTexpansionitems"
8954 The following items are recognized in expanded strings. White space may be used
8955 between sub-items that are keywords or substrings enclosed in braces inside an
8956 outer set of braces, to improve readability. &*Warning*&: Within braces,
8957 white space is significant.
8958
8959 .vlist
8960 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
8961 .cindex "expansion" "variables"
8962 Substitute the contents of the named variable, for example:
8963 .code
8964 $local_part
8965 ${domain}
8966 .endd
8967 The second form can be used to separate the name from subsequent alphanumeric
8968 characters. This form (using braces) is available only for variables; it does
8969 &'not'& apply to message headers. The names of the variables are given in
8970 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
8971 given, the expansion fails.
8972
8973 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
8974 .cindex "expansion" "operators"
8975 The string is first itself expanded, and then the operation specified by
8976 <&'op'&> is applied to it. For example:
8977 .code
8978 ${lc:$local_part}
8979 .endd
8980 The string starts with the first character after the colon, which may be
8981 leading white space. A list of operators is given in section &<<SECTexpop>>&
8982 below. The operator notation is used for simple expansion items that have just
8983 one argument, because it reduces the number of braces and therefore makes the
8984 string easier to understand.
8985
8986 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
8987 This item inserts &"basic"& header lines. It is described with the &%header%&
8988 expansion item below.
8989
8990
8991 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
8992 .cindex "expansion" "calling an acl"
8993 .cindex "&%acl%&" "call from expansion"
8994 The name and zero to nine argument strings are first expanded separately.  The expanded
8995 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
8996 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
8997 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
8998 and may use the variables; if another acl expansion is used the values
8999 are restored after it returns.  If the ACL sets
9000 a value using a "message =" modifier and returns accept or deny, the value becomes
9001 the result of the expansion.
9002 If no message is set and the ACL returns accept or deny
9003 the expansion result is an empty string.
9004 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
9005
9006
9007 .vitem "&*${certextract{*&<&'field'&>&*}{*&<&'certificate'&>&*}&&&
9008        {*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9009 .cindex "expansion" "extracting cerificate fields"
9010 .cindex "&%certextract%&" "certificate fields"
9011 .cindex "certificate" "extracting fields"
9012 The <&'certificate'&> must be a variable of type certificate.
9013 The field name is expanded and used to retrieve the relevant field from
9014 the certificate.  Supported fields are:
9015 .display
9016 &`version        `&
9017 &`serial_number  `&
9018 &`subject        `& RFC4514 DN
9019 &`issuer         `& RFC4514 DN
9020 &`notbefore      `& time
9021 &`notafter       `& time
9022 &`sig_algorithm  `&
9023 &`signature      `&
9024 &`subj_altname   `& tagged list
9025 &`ocsp_uri       `& list
9026 &`crl_uri        `& list
9027 .endd
9028 If the field is found,
9029 <&'string2'&> is expanded, and replaces the whole item;
9030 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9031 variable &$value$& contains the value that has been extracted. Afterwards, it
9032 is restored to any previous value it might have had.
9033
9034 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9035 key is not found. If {<&'string2'&>} is also omitted, the value that was
9036 extracted is used.
9037
9038 Some field names take optional modifiers, appended and separated by commas.
9039
9040 The field selectors marked as "RFC4514" above
9041 output a Distinguished Name string which is
9042 not quite
9043 parseable by Exim as a comma-separated tagged list
9044 (the exceptions being elements containing commas).
9045 RDN elements of a single type may be selected by
9046 a modifier of the type label; if so the expansion
9047 result is a list (newline-separated by default).
9048 The separator may be changed by another modifier of
9049 a right angle-bracket followed immediately by the new separator.
9050 Recognised RDN type labels include "CN", "O", "OU" and "DC".
9051
9052 The field selectors marked as "time" above
9053 take an optional modifier of "int"
9054 for which the result is the number of seconds since epoch.
9055 Otherwise the result is a human-readable string
9056 in the timezone selected by the main "timezone" option.
9057
9058 The field selectors marked as "list" above return a list,
9059 newline-separated by default,
9060 (embedded separator characters in elements are doubled).
9061 The separator may be changed by a modifier of
9062 a right angle-bracket followed immediately by the new separator.
9063
9064 The field selectors marked as "tagged" above
9065 prefix each list element with a type string and an equals sign.
9066 Elements of only one type may be selected by a modifier
9067 which is one of "dns", "uri" or "mail";
9068 if so the element tags are omitted.
9069
9070 If not otherwise noted field values are presented in human-readable form.
9071
9072 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
9073        {*&<&'arg'&>&*}...}*&"
9074 .cindex &%dlfunc%&
9075 This expansion dynamically loads and then calls a locally-written C function.
9076 This functionality is available only if Exim is compiled with
9077 .code
9078 EXPAND_DLFUNC=yes
9079 .endd
9080 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
9081 object so that it doesn't reload the same object file in the same Exim process
9082 (but of course Exim does start new processes frequently).
9083
9084 There may be from zero to eight arguments to the function. When compiling
9085 a local function that is to be called in this way, &_local_scan.h_& should be
9086 included. The Exim variables and functions that are defined by that API
9087 are also available for dynamically loaded functions. The function itself
9088 must have the following type:
9089 .code
9090 int dlfunction(uschar **yield, int argc, uschar *argv[])
9091 .endd
9092 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
9093 function should return one of the following values:
9094
9095 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
9096 into the expanded string that is being built.
9097
9098 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
9099 from &'yield'&, if it is set.
9100
9101 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
9102 taken from &'yield'& if it is set.
9103
9104 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
9105
9106 When compiling a function that is to be used in this way with gcc,
9107 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
9108 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
9109
9110
9111 .vitem "&*${env{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&"
9112 .cindex "expansion" "extracting value from environment"
9113 .cindex "environment" "value from"
9114 The key is first expanded separately, and leading and trailing white space
9115 removed.
9116 This is then searched for as a name in the environment.
9117 If a variable is found then its value is placed in &$value$&
9118 and <&'string1'&> is expanded, otherwise <&'string2'&> is expanded.
9119
9120 Instead of {<&'string2'&>} the word &"fail"& (not in curly brackets) can
9121 appear, for example:
9122 .code
9123 ${env{USER}{$value} fail }
9124 .endd
9125 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9126 {<&'string1'&>} must be present for &"fail"& to be recognized.
9127
9128 If {<&'string2'&>} is omitted an empty string is substituted on
9129 search failure.
9130 If {<&'string1'&>} is omitted the search result is substituted on
9131 search success.
9132
9133
9134 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9135        {*&<&'string3'&>&*}}*&"
9136 .cindex "expansion" "extracting substrings by key"
9137 .cindex "&%extract%&" "substrings by key"
9138 The key and <&'string1'&> are first expanded separately. Leading and trailing
9139 white space is removed from the key (but not from any of the strings). The key
9140 must not consist entirely of digits. The expanded <&'string1'&> must be of the
9141 form:
9142 .display
9143 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
9144 .endd
9145 .vindex "&$value$&"
9146 where the equals signs and spaces (but not both) are optional. If any of the
9147 values contain white space, they must be enclosed in double quotes, and any
9148 values that are enclosed in double quotes are subject to escape processing as
9149 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
9150 for the value that corresponds to the key. The search is case-insensitive. If
9151 the key is found, <&'string2'&> is expanded, and replaces the whole item;
9152 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9153 variable &$value$& contains the value that has been extracted. Afterwards, it
9154 is restored to any previous value it might have had.
9155
9156 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9157 key is not found. If {<&'string2'&>} is also omitted, the value that was
9158 extracted is used. Thus, for example, these two expansions are identical, and
9159 yield &"2001"&:
9160 .code
9161 ${extract{gid}{uid=1984 gid=2001}}
9162 ${extract{gid}{uid=1984 gid=2001}{$value}}
9163 .endd
9164 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
9165 appear, for example:
9166 .code
9167 ${extract{Z}{A=... B=...}{$value} fail }
9168 .endd
9169 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9170 {<&'string2'&>} must be present for &"fail"& to be recognized.
9171
9172
9173 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
9174         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9175 .cindex "expansion" "extracting substrings by number"
9176 .cindex "&%extract%&" "substrings by number"
9177 The <&'number'&> argument must consist entirely of decimal digits,
9178 apart from leading and trailing white space, which is ignored.
9179 This is what distinguishes this form of &%extract%& from the previous kind. It
9180 behaves in the same way, except that, instead of extracting a named field, it
9181 extracts from <&'string1'&> the field whose number is given as the first
9182 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
9183 <&'string3'&> as before.
9184
9185 The fields in the string are separated by any one of the characters in the
9186 separator string. These may include space or tab characters.
9187 The first field is numbered one. If the number is negative, the fields are
9188 counted from the end of the string, with the rightmost one numbered -1. If the
9189 number given is zero, the entire string is returned. If the modulus of the
9190 number is greater than the number of fields in the string, the result is the
9191 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
9192 provided. For example:
9193 .code
9194 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
9195 .endd
9196 yields &"42"&, and
9197 .code
9198 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
9199 .endd
9200 yields &"99"&. Two successive separators mean that the field between them is
9201 empty (for example, the fifth field above).
9202
9203
9204 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
9205 .cindex "list" "selecting by condition"
9206 .cindex "expansion" "selecting from list by condition"
9207 .vindex "&$item$&"
9208 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9209 default, but the separator can be changed in the usual way. For each item
9210 in this list, its value is place in &$item$&, and then the condition is
9211 evaluated. If the condition is true, &$item$& is added to the output as an
9212 item in a new list; if the condition is false, the item is discarded. The
9213 separator used for the output list is the same as the one used for the
9214 input, but a separator setting is not included in the output. For example:
9215 .code
9216 ${filter{a:b:c}{!eq{$item}{b}}
9217 .endd
9218 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
9219 to what it was before. See also the &*map*& and &*reduce*& expansion items.
9220
9221
9222 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9223 .cindex "hash function" "textual"
9224 .cindex "expansion" "textual hash"
9225 This is a textual hashing function, and was the first to be implemented in
9226 early versions of Exim. In current releases, there are other hashing functions
9227 (numeric, MD5, and SHA-1), which are described below.
9228
9229 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
9230 <&'n'&>. If you are using fixed values for these numbers, that is, if
9231 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
9232 use the simpler operator notation that avoids some of the braces:
9233 .code
9234 ${hash_<n>_<m>:<string>}
9235 .endd
9236 The second number is optional (in both notations). If <&'n'&> is greater than
9237 or equal to the length of the string, the expansion item returns the string.
9238 Otherwise it computes a new string of length <&'n'&> by applying a hashing
9239 function to the string. The new string consists of characters taken from the
9240 first <&'m'&> characters of the string
9241 .code
9242 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
9243 .endd
9244 If <&'m'&> is not present the value 26 is used, so that only lower case
9245 letters appear. For example:
9246 .display
9247 &`$hash{3}{monty}}           `&   yields  &`jmg`&
9248 &`$hash{5}{monty}}           `&   yields  &`monty`&
9249 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
9250 .endd
9251
9252 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
9253         &*$h_*&<&'header&~name'&>&*:*&" &&&
9254        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9255         &*$bh_*&<&'header&~name'&>&*:*&" &&&
9256        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9257         &*$rh_*&<&'header&~name'&>&*:*&"
9258 .cindex "expansion" "header insertion"
9259 .vindex "&$header_$&"
9260 .vindex "&$bheader_$&"
9261 .vindex "&$rheader_$&"
9262 .cindex "header lines" "in expansion strings"
9263 .cindex "header lines" "character sets"
9264 .cindex "header lines" "decoding"
9265 Substitute the contents of the named message header line, for example
9266 .code
9267 $header_reply-to:
9268 .endd
9269 The newline that terminates a header line is not included in the expansion, but
9270 internal newlines (caused by splitting the header line over several physical
9271 lines) may be present.
9272
9273 The difference between &%rheader%&, &%bheader%&, and &%header%& is in the way
9274 the data in the header line is interpreted.
9275
9276 .ilist
9277 .cindex "white space" "in header lines"
9278 &%rheader%& gives the original &"raw"& content of the header line, with no
9279 processing at all, and without the removal of leading and trailing white space.
9280
9281 .next
9282 .cindex "base64 encoding" "in header lines"
9283 &%bheader%& removes leading and trailing white space, and then decodes base64
9284 or quoted-printable MIME &"words"& within the header text, but does no
9285 character set translation. If decoding of what looks superficially like a MIME
9286 &"word"& fails, the raw string is returned. If decoding
9287 .cindex "binary zero" "in header line"
9288 produces a binary zero character, it is replaced by a question mark &-- this is
9289 what Exim does for binary zeros that are actually received in header lines.
9290
9291 .next
9292 &%header%& tries to translate the string as decoded by &%bheader%& to a
9293 standard character set. This is an attempt to produce the same string as would
9294 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
9295 returned. Translation is attempted only on operating systems that support the
9296 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
9297 a system Makefile or in &_Local/Makefile_&.
9298 .endlist ilist
9299
9300 In a filter file, the target character set for &%header%& can be specified by a
9301 command of the following form:
9302 .code
9303 headers charset "UTF-8"
9304 .endd
9305 This command affects all references to &$h_$& (or &$header_$&) expansions in
9306 subsequently obeyed filter commands. In the absence of this command, the target
9307 character set in a filter is taken from the setting of the &%headers_charset%&
9308 option in the runtime configuration. The value of this option defaults to the
9309 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
9310 ISO-8859-1.
9311
9312 Header names follow the syntax of RFC 2822, which states that they may contain
9313 any printing characters except space and colon. Consequently, curly brackets
9314 &'do not'& terminate header names, and should not be used to enclose them as
9315 if they were variables. Attempting to do so causes a syntax error.
9316
9317 Only header lines that are common to all copies of a message are visible to
9318 this mechanism. These are the original header lines that are received with the
9319 message, and any that are added by an ACL statement or by a system
9320 filter. Header lines that are added to a particular copy of a message by a
9321 router or transport are not accessible.
9322
9323 For incoming SMTP messages, no header lines are visible in ACLs that are obeyed
9324 before the DATA ACL, because the header structure is not set up until the
9325 message is received. Header lines that are added in a RCPT ACL (for example)
9326 are saved until the message's incoming header lines are available, at which
9327 point they are added. When a DATA ACL is running, however, header lines added
9328 by earlier ACLs are visible.
9329
9330 Upper case and lower case letters are synonymous in header names. If the
9331 following character is white space, the terminating colon may be omitted, but
9332 this is not recommended, because you may then forget it when it is needed. When
9333 white space terminates the header name, this white space is included in the
9334 expanded string.  If the message does not contain the given header, the
9335 expansion item is replaced by an empty string. (See the &%def%& condition in
9336 section &<<SECTexpcond>>& for a means of testing for the existence of a
9337 header.)
9338
9339 If there is more than one header with the same name, they are all concatenated
9340 to form the substitution string, up to a maximum length of 64K. Unless
9341 &%rheader%& is being used, leading and trailing white space is removed from
9342 each header before concatenation, and a completely empty header is ignored. A
9343 newline character is then inserted between non-empty headers, but there is no
9344 newline at the very end. For the &%header%& and &%bheader%& expansion, for
9345 those headers that contain lists of addresses, a comma is also inserted at the
9346 junctions between headers. This does not happen for the &%rheader%& expansion.
9347
9348
9349 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
9350 .cindex "expansion" "hmac hashing"
9351 .cindex &%hmac%&
9352 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
9353 shared secret and some text into a message authentication code, as specified in
9354 RFC 2104. This differs from &`${md5:secret_text...}`& or
9355 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
9356 cryptographic hash, allowing for authentication that is not possible with MD5
9357 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
9358 present. For example:
9359 .code
9360 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
9361 .endd
9362 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
9363 produces:
9364 .code
9365 dd97e3ba5d1a61b5006108f8c8252953
9366 .endd
9367 As an example of how this might be used, you might put in the main part of
9368 an Exim configuration:
9369 .code
9370 SPAMSCAN_SECRET=cohgheeLei2thahw
9371 .endd
9372 In a router or a transport you could then have:
9373 .code
9374 headers_add = \
9375   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
9376   ${hmac{md5}{SPAMSCAN_SECRET}\
9377   {${primary_hostname},${message_exim_id},$h_message-id:}}
9378 .endd
9379 Then given a message, you can check where it was scanned by looking at the
9380 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
9381 this header line is authentic by recomputing the authentication code from the
9382 host name, message ID and the &'Message-id:'& header line. This can be done
9383 using Exim's &%-be%& option, or by other means, for example by using the
9384 &'hmac_md5_hex()'& function in Perl.
9385
9386
9387 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9388 .cindex "expansion" "conditional"
9389 .cindex "&%if%&, expansion item"
9390 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
9391 item; otherwise <&'string2'&> is used. The available conditions are described
9392 in section &<<SECTexpcond>>& below. For example:
9393 .code
9394 ${if eq {$local_part}{postmaster} {yes}{no} }
9395 .endd
9396 The second string need not be present; if it is not and the condition is not
9397 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
9398 be present instead of the second string (without any curly brackets). In this
9399 case, the expansion is forced to fail if the condition is not true (see section
9400 &<<SECTforexpfai>>&).
9401
9402 If both strings are omitted, the result is the string &`true`& if the condition
9403 is true, and the empty string if the condition is false. This makes it less
9404 cumbersome to write custom ACL and router conditions. For example, instead of
9405 .code
9406 condition = ${if >{$acl_m4}{3}{true}{false}}
9407 .endd
9408 you can use
9409 .code
9410 condition = ${if >{$acl_m4}{3}}
9411 .endd
9412
9413
9414
9415 .new
9416 .vitem &*${imapfolder{*&<&'foldername'&>&*}}*&
9417 .cindex expansion "imap folder"
9418 .cindex "&%imapfolder%& expansion item"
9419 This item converts a (possibly multilevel, or with non-ASCII characters)
9420 folder specification to a Maildir name for filesystem use.
9421 For information on internationalisation support see &<<SECTi18nMDA>>&.
9422 .wen
9423
9424
9425
9426 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9427 .cindex "expansion" "string truncation"
9428 .cindex "&%length%& expansion item"
9429 The &%length%& item is used to extract the initial portion of a string. Both
9430 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
9431 you are using a fixed value for the number, that is, if <&'string1'&> does not
9432 change when expanded, you can use the simpler operator notation that avoids
9433 some of the braces:
9434 .code
9435 ${length_<n>:<string>}
9436 .endd
9437 The result of this item is either the first <&'n'&> characters or the whole
9438 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
9439 &%strlen%&, which gives the length of a string.
9440
9441
9442 .vitem "&*${listextract{*&<&'number'&>&*}&&&
9443         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9444 .cindex "expansion" "extracting list elements by number"
9445 .cindex "&%listextract%&" "extract list elements by number"
9446 .cindex "list" "extracting elements by number"
9447 The <&'number'&> argument must consist entirely of decimal digits,
9448 apart from an optional leading minus,
9449 and leading and trailing white space (which is ignored).
9450
9451 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9452 default, but the separator can be changed in the usual way.
9453
9454 The first field of the list is numbered one.
9455 If the number is negative, the fields are
9456 counted from the end of the list, with the rightmost one numbered -1.
9457 The numbered element of the list is extracted and placed in &$value$&,
9458 then <&'string2'&> is expanded as the result.
9459
9460 If the modulus of the
9461 number is zero or greater than the number of fields in the string,
9462 the result is the expansion of <&'string3'&>.
9463
9464 For example:
9465 .code
9466 ${listextract{2}{x:42:99}}
9467 .endd
9468 yields &"42"&, and
9469 .code
9470 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
9471 .endd
9472 yields &"result: 42"&.
9473
9474 If {<&'string3'&>} is omitted, an empty string is used for string3.
9475 If {<&'string2'&>} is also omitted, the value that was
9476 extracted is used.
9477 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
9478
9479
9480 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
9481         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9482 This is the first of one of two different types of lookup item, which are both
9483 described in the next item.
9484
9485 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
9486         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9487 .cindex "expansion" "lookup in"
9488 .cindex "file" "lookups"
9489 .cindex "lookup" "in expanded string"
9490 The two forms of lookup item specify data lookups in files and databases, as
9491 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
9492 lookups, and the second is used for query-style lookups. The <&'key'&>,
9493 <&'file'&>, and <&'query'&> strings are expanded before use.
9494
9495 If there is any white space in a lookup item which is part of a filter command,
9496 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
9497 other place where white space is significant, the lookup item must be enclosed
9498 in double quotes. The use of data lookups in users' filter files may be locked
9499 out by the system administrator.
9500
9501 .vindex "&$value$&"
9502 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
9503 During its expansion, the variable &$value$& contains the data returned by the
9504 lookup. Afterwards it reverts to the value it had previously (at the outer
9505 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
9506 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
9507 string on failure. If <&'string2'&> is provided, it can itself be a nested
9508 lookup, thus providing a mechanism for looking up a default value when the
9509 original lookup fails.
9510
9511 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
9512 data for the outer lookup while the parameters of the second lookup are
9513 expanded, and also while <&'string2'&> of the second lookup is expanded, should
9514 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
9515 appear, and in this case, if the lookup fails, the entire expansion is forced
9516 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
9517 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
9518 successful lookup, and nothing in the case of failure.
9519
9520 For single-key lookups, the string &"partial"& is permitted to precede the
9521 search type in order to do partial matching, and * or *@ may follow a search
9522 type to request default lookups if the key does not match (see sections
9523 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
9524
9525 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
9526 If a partial search is used, the variables &$1$& and &$2$& contain the wild
9527 and non-wild parts of the key during the expansion of the replacement text.
9528 They return to their previous values at the end of the lookup item.
9529
9530 This example looks up the postmaster alias in the conventional alias file:
9531 .code
9532 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
9533 .endd
9534 This example uses NIS+ to look up the full name of the user corresponding to
9535 the local part of an address, forcing the expansion to fail if it is not found:
9536 .code
9537 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
9538   {$value}fail}
9539 .endd
9540
9541
9542 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9543 .cindex "expansion" "list creation"
9544 .vindex "&$item$&"
9545 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9546 default, but the separator can be changed in the usual way. For each item
9547 in this list, its value is place in &$item$&, and then <&'string2'&> is
9548 expanded and added to the output as an item in a new list. The separator used
9549 for the output list is the same as the one used for the input, but a separator
9550 setting is not included in the output. For example:
9551 .code
9552 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
9553 .endd
9554 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
9555 value of &$item$& is restored to what it was before. See also the &*filter*&
9556 and &*reduce*& expansion items.
9557
9558 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9559 .cindex "expansion" "numeric hash"
9560 .cindex "hash function" "numeric"
9561 The three strings are expanded; the first two must yield numbers. Call them
9562 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9563 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9564 can use the simpler operator notation that avoids some of the braces:
9565 .code
9566 ${nhash_<n>_<m>:<string>}
9567 .endd
9568 The second number is optional (in both notations). If there is only one number,
9569 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
9570 processed by a div/mod hash function that returns two numbers, separated by a
9571 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
9572 example,
9573 .code
9574 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
9575 .endd
9576 returns the string &"6/33"&.
9577
9578
9579
9580 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
9581 .cindex "Perl" "use in expanded string"
9582 .cindex "expansion" "calling Perl from"
9583 This item is available only if Exim has been built to include an embedded Perl
9584 interpreter. The subroutine name and the arguments are first separately
9585 expanded, and then the Perl subroutine is called with those arguments. No
9586 additional arguments need be given; the maximum number permitted, including the
9587 name of the subroutine, is nine.
9588
9589 The return value of the subroutine is inserted into the expanded string, unless
9590 the return value is &%undef%&. In that case, the expansion fails in the same
9591 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
9592 Whatever you return is evaluated in a scalar context. For example, if you
9593 return the name of a Perl vector, the return value is the size of the vector,
9594 not its contents.
9595
9596 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
9597 with the error message that was passed to &%die%&. More details of the embedded
9598 Perl facility are given in chapter &<<CHAPperl>>&.
9599
9600 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
9601 out the use of this expansion item in filter files.
9602
9603
9604 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
9605 .cindex "&%prvs%& expansion item"
9606 The first argument is a complete email address and the second is secret
9607 keystring. The third argument, specifying a key number, is optional. If absent,
9608 it defaults to 0. The result of the expansion is a prvs-signed email address,
9609 to be typically used with the &%return_path%& option on an &(smtp)& transport
9610 as part of a bounce address tag validation (BATV) scheme. For more discussion
9611 and an example, see section &<<SECTverifyPRVS>>&.
9612
9613 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
9614         {*&<&'string'&>&*}}*&"
9615 .cindex "&%prvscheck%& expansion item"
9616 This expansion item is the complement of the &%prvs%& item. It is used for
9617 checking prvs-signed addresses. If the expansion of the first argument does not
9618 yield a syntactically valid prvs-signed address, the whole item expands to the
9619 empty string. When the first argument does expand to a syntactically valid
9620 prvs-signed address, the second argument is expanded, with the prvs-decoded
9621 version of the address and the key number extracted from the address in the
9622 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
9623
9624 These two variables can be used in the expansion of the second argument to
9625 retrieve the secret. The validity of the prvs-signed address is then checked
9626 against the secret. The result is stored in the variable &$prvscheck_result$&,
9627 which is empty for failure or &"1"& for success.
9628
9629 The third argument is optional; if it is missing, it defaults to an empty
9630 string. This argument is now expanded. If the result is an empty string, the
9631 result of the expansion is the decoded version of the address. This is the case
9632 whether or not the signature was valid. Otherwise, the result of the expansion
9633 is the expansion of the third argument.
9634
9635 All three variables can be used in the expansion of the third argument.
9636 However, once the expansion is complete, only &$prvscheck_result$& remains set.
9637 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
9638
9639 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
9640 .cindex "expansion" "inserting an entire file"
9641 .cindex "file" "inserting into expansion"
9642 .cindex "&%readfile%& expansion item"
9643 The file name and end-of-line string are first expanded separately. The file is
9644 then read, and its contents replace the entire item. All newline characters in
9645 the file are replaced by the end-of-line string if it is present. Otherwise,
9646 newlines are left in the string.
9647 String expansion is not applied to the contents of the file. If you want this,
9648 you must wrap the item in an &%expand%& operator. If the file cannot be read,
9649 the string expansion fails.
9650
9651 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
9652 locks out the use of this expansion item in filter files.
9653
9654
9655
9656 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
9657         {*&<&'timeout'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
9658 .cindex "expansion" "inserting from a socket"
9659 .cindex "socket, use of in expansion"
9660 .cindex "&%readsocket%& expansion item"
9661 This item inserts data from a Unix domain or TCP socket into the expanded
9662 string. The minimal way of using it uses just two arguments, as in these
9663 examples:
9664 .code
9665 ${readsocket{/socket/name}{request string}}
9666 ${readsocket{inet:some.host:1234}{request string}}
9667 .endd
9668 For a Unix domain socket, the first substring must be the path to the socket.
9669 For an Internet socket, the first substring must contain &`inet:`& followed by
9670 a host name or IP address, followed by a colon and a port, which can be a
9671 number or the name of a TCP port in &_/etc/services_&. An IP address may
9672 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
9673 example:
9674 .code
9675 ${readsocket{inet:[::1]:1234}{request string}}
9676 .endd
9677 Only a single host name may be given, but if looking it up yields more than
9678 one IP address, they are each tried in turn until a connection is made. For
9679 both kinds of socket, Exim makes a connection, writes the request string
9680 (unless it is an empty string) and reads from the socket until an end-of-file
9681 is read. A timeout of 5 seconds is applied. Additional, optional arguments
9682 extend what can be done. Firstly, you can vary the timeout. For example:
9683 .code
9684 ${readsocket{/socket/name}{request string}{3s}}
9685 .endd
9686 A fourth argument allows you to change any newlines that are in the data
9687 that is read, in the same way as for &%readfile%& (see above). This example
9688 turns them into spaces:
9689 .code
9690 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
9691 .endd
9692 As with all expansions, the substrings are expanded before the processing
9693 happens. Errors in these sub-expansions cause the expansion to fail. In
9694 addition, the following errors can occur:
9695
9696 .ilist
9697 Failure to create a socket file descriptor;
9698 .next
9699 Failure to connect the socket;
9700 .next
9701 Failure to write the request string;
9702 .next
9703 Timeout on reading from the socket.
9704 .endlist
9705
9706 By default, any of these errors causes the expansion to fail. However, if
9707 you supply a fifth substring, it is expanded and used when any of the above
9708 errors occurs. For example:
9709 .code
9710 ${readsocket{/socket/name}{request string}{3s}{\n}\
9711   {socket failure}}
9712 .endd
9713 You can test for the existence of a Unix domain socket by wrapping this
9714 expansion in &`${if exists`&, but there is a race condition between that test
9715 and the actual opening of the socket, so it is safer to use the fifth argument
9716 if you want to be absolutely sure of avoiding an expansion error for a
9717 non-existent Unix domain socket, or a failure to connect to an Internet socket.
9718
9719 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
9720 locks out the use of this expansion item in filter files.
9721
9722
9723 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9724 .cindex "expansion" "reducing a list to a scalar"
9725 .cindex "list" "reducing to a scalar"
9726 .vindex "&$value$&"
9727 .vindex "&$item$&"
9728 This operation reduces a list to a single, scalar string. After expansion,
9729 <&'string1'&> is interpreted as a list, colon-separated by default, but the
9730 separator can be changed in the usual way. Then <&'string2'&> is expanded and
9731 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
9732 list is assigned to &$item$& in turn, and <&'string3'&> is expanded for each of
9733 them. The result of that expansion is assigned to &$value$& before the next
9734 iteration. When the end of the list is reached, the final value of &$value$& is
9735 added to the expansion output. The &*reduce*& expansion item can be used in a
9736 number of ways. For example, to add up a list of numbers:
9737 .code
9738 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
9739 .endd
9740 The result of that expansion would be &`6`&. The maximum of a list of numbers
9741 can be found:
9742 .code
9743 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
9744 .endd
9745 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
9746 restored to what they were before. See also the &*filter*& and &*map*&
9747 expansion items.
9748
9749 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
9750 This item inserts &"raw"& header lines. It is described with the &%header%&
9751 expansion item above.
9752
9753 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
9754         {*&<&'string2'&>&*}}*&"
9755 .cindex "expansion" "running a command"
9756 .cindex "&%run%& expansion item"
9757 The command and its arguments are first expanded as one string. The string is
9758 split apart into individual arguments by spaces, and then the command is run
9759 in a separate process, but under the same uid and gid.  As in other command
9760 executions from Exim, a shell is not used by default. If the command requires
9761 a shell, you must explicitly code it.
9762
9763 Since the arguments are split by spaces, when there is a variable expansion
9764 which has an empty result, it will cause the situation that the argument will
9765 simply be omitted when the program is actually executed by Exim. If the
9766 script/program requires a specific number of arguments and the expanded
9767 variable could possibly result in this empty expansion, the variable must be
9768 quoted. This is more difficult if the expanded variable itself could result
9769 in a string containing quotes, because it would interfere with the quotes
9770 around the command arguments. A possible guard against this is to wrap the
9771 variable in the &%sg%& operator to change any quote marks to some other
9772 character.
9773
9774 The standard input for the command exists, but is empty. The standard output
9775 and standard error are set to the same file descriptor.
9776 .cindex "return code" "from &%run%& expansion"
9777 .vindex "&$value$&"
9778 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
9779 and replaces the entire item; during this expansion, the standard output/error
9780 from the command is in the variable &$value$&. If the command fails,
9781 <&'string2'&>, if present, is expanded and used. Once again, during the
9782 expansion, the standard output/error from the command is in the variable
9783 &$value$&.
9784
9785 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
9786 can be the word &"fail"& (not in braces) to force expansion failure if the
9787 command does not succeed. If both strings are omitted, the result is contents
9788 of the standard output/error on success, and nothing on failure.
9789
9790 .vindex "&$run_in_acl$&"
9791 The standard output/error of the command is put in the variable &$value$&.
9792 In this ACL example, the output of a command is logged for the admin to
9793 troubleshoot:
9794 .code
9795 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
9796       log_message  = Output of id: $value
9797 .endd
9798 If the command requires shell idioms, such as the > redirect operator, the
9799 shell must be invoked directly, such as with:
9800 .code
9801 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
9802 .endd
9803
9804 .vindex "&$runrc$&"
9805 The return code from the command is put in the variable &$runrc$&, and this
9806 remains set afterwards, so in a filter file you can do things like this:
9807 .code
9808 if "${run{x y z}{}}$runrc" is 1 then ...
9809   elif $runrc is 2 then ...
9810   ...
9811 endif
9812 .endd
9813 If execution of the command fails (for example, the command does not exist),
9814 the return code is 127 &-- the same code that shells use for non-existent
9815 commands.
9816
9817 &*Warning*&: In a router or transport, you cannot assume the order in which
9818 option values are expanded, except for those preconditions whose order of
9819 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
9820 by the expansion of one option, and use it in another.
9821
9822 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
9823 out the use of this expansion item in filter files.
9824
9825
9826 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
9827 .cindex "expansion" "string substitution"
9828 .cindex "&%sg%& expansion item"
9829 This item works like Perl's substitution operator (s) with the global (/g)
9830 option; hence its name. However, unlike the Perl equivalent, Exim does not
9831 modify the subject string; instead it returns the modified string for insertion
9832 into the overall expansion. The item takes three arguments: the subject string,
9833 a regular expression, and a substitution string. For example:
9834 .code
9835 ${sg{abcdefabcdef}{abc}{xyz}}
9836 .endd
9837 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
9838 if any $ or \ characters are required in the regular expression or in the
9839 substitution string, they have to be escaped. For example:
9840 .code
9841 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
9842 .endd
9843 yields &"defabc"&, and
9844 .code
9845 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
9846 .endd
9847 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
9848 the regular expression from string expansion.
9849
9850
9851
9852 .vitem &*${sort{*&<&'string'&>&*}{*&<&'comparator'&>&*}{*&<&'extractor'&>&*}}*&
9853 .cindex sorting "a list"
9854 .cindex list sorting
9855 .cindex expansion "list sorting"
9856 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9857 default, but the separator can be changed in the usual way.
9858 The <&'comparator'&> argument is interpreted as the operator
9859 of a two-argument expansion condition.
9860 The numeric operators plus ge, gt, le, lt (and ~i variants) are supported.
9861 The comparison should return true when applied to two values
9862 if the first value should sort before the second value.
9863 The <&'extractor'&> expansion is applied repeatedly to elements of the list,
9864 the element being placed in &$item$&,
9865 to give values for comparison.
9866
9867 The item result is a sorted list,
9868 with the original list separator,
9869 of the list elements (in full) of the original.
9870
9871 Examples:
9872 .code
9873 ${sort{3:2:1:4}{<}{$item}}
9874 .endd
9875 sorts a list of numbers, and
9876 .code
9877 ${sort {${lookup dnsdb{>:,,mx=example.com}}} {<} {${listextract{1}{<,$item}}}}
9878 .endd
9879 will sort an MX lookup into priority order.
9880
9881
9882 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9883 .cindex "&%substr%& expansion item"
9884 .cindex "substring extraction"
9885 .cindex "expansion" "substring extraction"
9886 The three strings are expanded; the first two must yield numbers. Call them
9887 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9888 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9889 can use the simpler operator notation that avoids some of the braces:
9890 .code
9891 ${substr_<n>_<m>:<string>}
9892 .endd
9893 The second number is optional (in both notations).
9894 If it is absent in the simpler format, the preceding underscore must also be
9895 omitted.
9896
9897 The &%substr%& item can be used to extract more general substrings than
9898 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
9899 length required. For example
9900 .code
9901 ${substr{3}{2}{$local_part}}
9902 .endd
9903 If the starting offset is greater than the string length the result is the
9904 null string; if the length plus starting offset is greater than the string
9905 length, the result is the right-hand part of the string, starting from the
9906 given offset. The first character in the string has offset zero.
9907
9908 The &%substr%& expansion item can take negative offset values to count
9909 from the right-hand end of its operand. The last character is offset -1, the
9910 second-last is offset -2, and so on. Thus, for example,
9911 .code
9912 ${substr{-5}{2}{1234567}}
9913 .endd
9914 yields &"34"&. If the absolute value of a negative offset is greater than the
9915 length of the string, the substring starts at the beginning of the string, and
9916 the length is reduced by the amount of overshoot. Thus, for example,
9917 .code
9918 ${substr{-5}{2}{12}}
9919 .endd
9920 yields an empty string, but
9921 .code
9922 ${substr{-3}{2}{12}}
9923 .endd
9924 yields &"1"&.
9925
9926 When the second number is omitted from &%substr%&, the remainder of the string
9927 is taken if the offset is positive. If it is negative, all characters in the
9928 string preceding the offset point are taken. For example, an offset of -1 and
9929 no length, as in these semantically identical examples:
9930 .code
9931 ${substr_-1:abcde}
9932 ${substr{-1}{abcde}}
9933 .endd
9934 yields all but the last character of the string, that is, &"abcd"&.
9935
9936
9937
9938 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
9939         {*&<&'replacements'&>&*}}*&"
9940 .cindex "expansion" "character translation"
9941 .cindex "&%tr%& expansion item"
9942 This item does single-character translation on its subject string. The second
9943 argument is a list of characters to be translated in the subject string. Each
9944 matching character is replaced by the corresponding character from the
9945 replacement list. For example
9946 .code
9947 ${tr{abcdea}{ac}{13}}
9948 .endd
9949 yields &`1b3de1`&. If there are duplicates in the second character string, the
9950 last occurrence is used. If the third string is shorter than the second, its
9951 last character is replicated. However, if it is empty, no translation takes
9952 place.
9953 .endlist
9954
9955
9956
9957 .section "Expansion operators" "SECTexpop"
9958 .cindex "expansion" "operators"
9959 For expansion items that perform transformations on a single argument string,
9960 the &"operator"& notation is used because it is simpler and uses fewer braces.
9961 The substring is first expanded before the operation is applied to it. The
9962 following operations can be performed:
9963
9964 .vlist
9965 .vitem &*${address:*&<&'string'&>&*}*&
9966 .cindex "expansion" "RFC 2822 address handling"
9967 .cindex "&%address%& expansion item"
9968 The string is interpreted as an RFC 2822 address, as it might appear in a
9969 header line, and the effective address is extracted from it. If the string does
9970 not parse successfully, the result is empty.
9971
9972
9973 .vitem &*${addresses:*&<&'string'&>&*}*&
9974 .cindex "expansion" "RFC 2822 address handling"
9975 .cindex "&%addresses%& expansion item"
9976 The string (after expansion) is interpreted as a list of addresses in RFC
9977 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
9978 operative address (&'local-part@domain'&) is extracted from each item, and the
9979 result of the expansion is a colon-separated list, with appropriate
9980 doubling of colons should any happen to be present in the email addresses.
9981 Syntactically invalid RFC2822 address items are omitted from the output.
9982
9983 It is possible to specify a character other than colon for the output
9984 separator by starting the string with > followed by the new separator
9985 character. For example:
9986 .code
9987 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
9988 .endd
9989 expands to &`ceo@up.stairs&&sec@base.ment`&. Compare the &*address*& (singular)
9990 expansion item, which extracts the working address from a single RFC2822
9991 address. See the &*filter*&, &*map*&, and &*reduce*& items for ways of
9992 processing lists.
9993
9994 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
9995 a strict interpretation of header line formatting.  Exim parses the bare,
9996 unquoted portion of an email address and if it finds a comma, treats it as an
9997 email address separator. For the example header line:
9998 .code
9999 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
10000 .endd
10001 The first example below demonstrates that Q-encoded email addresses are parsed
10002 properly if it is given the raw header (in this example, &`$rheader_from:`&).
10003 It does not see the comma because it's still encoded as "=2C".  The second
10004 example below is passed the contents of &`$header_from:`&, meaning it gets
10005 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
10006 The third example shows that the presence of a comma is skipped when it is
10007 quoted.
10008 .code
10009 # exim -be '${addresses:From: \
10010 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
10011 user@example.com
10012 # exim -be '${addresses:From: Last, First <user@example.com>}'
10013 Last:user@example.com
10014 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
10015 user@example.com
10016 .endd
10017
10018 .vitem &*${base62:*&<&'digits'&>&*}*&
10019 .cindex "&%base62%& expansion item"
10020 .cindex "expansion" "conversion to base 62"
10021 The string must consist entirely of decimal digits. The number is converted to
10022 base 62 and output as a string of six characters, including leading zeros. In
10023 the few operating environments where Exim uses base 36 instead of base 62 for
10024 its message identifiers (because those systems do not have case-sensitive file
10025 names), base 36 is used by this operator, despite its name. &*Note*&: Just to
10026 be absolutely clear: this is &'not'& base64 encoding.
10027
10028 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
10029 .cindex "&%base62d%& expansion item"
10030 .cindex "expansion" "conversion to base 62"
10031 The string must consist entirely of base-62 digits, or, in operating
10032 environments where Exim uses base 36 instead of base 62 for its message
10033 identifiers, base-36 digits. The number is converted to decimal and output as a
10034 string.
10035
10036 .new
10037 .vitem &*${base64:*&<&'string'&>&*}*&
10038 .cindex "expansion" "base64 encoding"
10039 .cindex "base64 encoding" "in string expansion"
10040 .cindex "&%base64%& expansion item"
10041 .cindex certificate "base64 of DER"
10042 This operator converts a string into one that is base64 encoded.
10043
10044 If the string is a single variable of type certificate,
10045 returns the base64 encoding of the DER form of the certificate.
10046
10047
10048 .vitem &*${base64d:*&<&'string'&>&*}*&
10049 .cindex "expansion" "base64 decoding"
10050 .cindex "base64 decoding" "in string expansion"
10051 .cindex "&%base64d%& expansion item"
10052 This operator converts a base64-encoded string into the un-coded form.
10053 .wen
10054
10055
10056 .vitem &*${domain:*&<&'string'&>&*}*&
10057 .cindex "domain" "extraction"
10058 .cindex "expansion" "domain extraction"
10059 The string is interpreted as an RFC 2822 address and the domain is extracted
10060 from it. If the string does not parse successfully, the result is empty.
10061
10062
10063 .vitem &*${escape:*&<&'string'&>&*}*&
10064 .cindex "expansion" "escaping non-printing characters"
10065 .cindex "&%escape%& expansion item"
10066 If the string contains any non-printing characters, they are converted to
10067 escape sequences starting with a backslash. Whether characters with the most
10068 significant bit set (so-called &"8-bit characters"&) count as printing or not
10069 is controlled by the &%print_topbitchars%& option.
10070
10071
10072 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
10073 .cindex "expansion" "expression evaluation"
10074 .cindex "expansion" "arithmetic expression"
10075 .cindex "&%eval%& expansion item"
10076 These items supports simple arithmetic and bitwise logical operations in
10077 expansion strings. The string (after expansion) must be a conventional
10078 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
10079 logical operators, and parentheses. All operations are carried out using
10080 integer arithmetic. The operator priorities are as follows (the same as in the
10081 C programming language):
10082 .table2 70pt 300pt
10083 .irow &'highest:'& "not (~), negate (-)"
10084 .irow ""   "multiply (*), divide (/), remainder (%)"
10085 .irow ""   "plus (+), minus (-)"
10086 .irow ""   "shift-left (<<), shift-right (>>)"
10087 .irow ""   "and (&&)"
10088 .irow ""   "xor (^)"
10089 .irow &'lowest:'&  "or (|)"
10090 .endtable
10091 Binary operators with the same priority are evaluated from left to right. White
10092 space is permitted before or after operators.
10093
10094 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
10095 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
10096 decimal, even if they start with a leading zero; hexadecimal numbers are not
10097 permitted. This can be useful when processing numbers extracted from dates or
10098 times, which often do have leading zeros.
10099
10100 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
10101 or 1024*1024*1024,
10102 respectively. Negative numbers are supported. The result of the computation is
10103 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
10104
10105 .display
10106 &`${eval:1+1}            `&  yields 2
10107 &`${eval:1+2*3}          `&  yields 7
10108 &`${eval:(1+2)*3}        `&  yields 9
10109 &`${eval:2+42%5}         `&  yields 4
10110 &`${eval:0xc&amp;5}          `&  yields 4
10111 &`${eval:0xc|5}          `&  yields 13
10112 &`${eval:0xc^5}          `&  yields 9
10113 &`${eval:0xc>>1}         `&  yields 6
10114 &`${eval:0xc<<1}         `&  yields 24
10115 &`${eval:~255&amp;0x1234}    `&  yields 4608
10116 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
10117 .endd
10118
10119 As a more realistic example, in an ACL you might have
10120 .code
10121 deny   message = Too many bad recipients
10122        condition =                    \
10123          ${if and {                   \
10124            {>{$rcpt_count}{10}}       \
10125            {                          \
10126            <                          \
10127              {$recipients_count}      \
10128              {${eval:$rcpt_count/2}}  \
10129            }                          \
10130          }{yes}{no}}
10131 .endd
10132 The condition is true if there have been more than 10 RCPT commands and
10133 fewer than half of them have resulted in a valid recipient.
10134
10135
10136 .vitem &*${expand:*&<&'string'&>&*}*&
10137 .cindex "expansion" "re-expansion of substring"
10138 The &%expand%& operator causes a string to be expanded for a second time. For
10139 example,
10140 .code
10141 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
10142 .endd
10143 first looks up a string in a file while expanding the operand for &%expand%&,
10144 and then re-expands what it has found.
10145
10146
10147 .vitem &*${from_utf8:*&<&'string'&>&*}*&
10148 .cindex "Unicode"
10149 .cindex "UTF-8" "conversion from"
10150 .cindex "expansion" "UTF-8 conversion"
10151 .cindex "&%from_utf8%& expansion item"
10152 The world is slowly moving towards Unicode, although there are no standards for
10153 email yet. However, other applications (including some databases) are starting
10154 to store data in Unicode, using UTF-8 encoding. This operator converts from a
10155 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
10156 converted to underscores. The input must be a valid UTF-8 string. If it is not,
10157 the result is an undefined sequence of bytes.
10158
10159 Unicode code points with values less than 256 are compatible with ASCII and
10160 ISO-8859-1 (also known as Latin-1).
10161 For example, character 169 is the copyright symbol in both cases, though the
10162 way it is encoded is different. In UTF-8, more than one byte is needed for
10163 characters with code values greater than 127, whereas ISO-8859-1 is a
10164 single-byte encoding (but thereby limited to 256 characters). This makes
10165 translation from UTF-8 to ISO-8859-1 straightforward.
10166
10167
10168 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10169 .cindex "hash function" "textual"
10170 .cindex "expansion" "textual hash"
10171 The &%hash%& operator is a simpler interface to the hashing function that can
10172 be used when the two parameters are fixed numbers (as opposed to strings that
10173 change when expanded). The effect is the same as
10174 .code
10175 ${hash{<n>}{<m>}{<string>}}
10176 .endd
10177 See the description of the general &%hash%& item above for details. The
10178 abbreviation &%h%& can be used when &%hash%& is used as an operator.
10179
10180
10181
10182 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
10183 .cindex "base64 encoding" "conversion from hex"
10184 .cindex "expansion" "hex to base64"
10185 .cindex "&%hex2b64%& expansion item"
10186 This operator converts a hex string into one that is base64 encoded. This can
10187 be useful for processing the output of the MD5 and SHA-1 hashing functions.
10188
10189
10190
10191 .vitem &*${hexquote:*&<&'string'&>&*}*&
10192 .cindex "quoting" "hex-encoded unprintable characters"
10193 .cindex "&%hexquote%& expansion item"
10194 This operator converts non-printable characters in a string into a hex
10195 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
10196 as is, and other byte values are converted to &`\xNN`&, for example a
10197 byte value 127 is converted to &`\x7f`&.
10198
10199
10200 .new
10201 .vitem &*${ipv6denorm:*&<&'string'&>&*}*&
10202 .cindex "&%ipv6denorm%& expansion item"
10203 .cindex "IP address" normalisation
10204 This expands an IPv6 address to a full eight-element colon-separated set
10205 of hex digits including leading zeroes.
10206 A trailing ipv4-style dotted-decimal set is converted to hex.
10207 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10208
10209 .vitem &*${ipv6norm:*&<&'string'&>&*}*&
10210 .cindex "&%ipv6norm%& expansion item"
10211 .cindex "IP address" normalisation
10212 .cindex "IP address" "canonical form"
10213 This converts an IPv6 address to canonical form.
10214 Leading zeroes of groups are omitted, and the longest
10215 set of zero-valued groups is replaced with a double colon.
10216 A trailing ipv4-style dotted-decimal set is converted to hex.
10217 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10218 .wen
10219
10220
10221 .vitem &*${lc:*&<&'string'&>&*}*&
10222 .cindex "case forcing in strings"
10223 .cindex "string" "case forcing"
10224 .cindex "lower casing"
10225 .cindex "expansion" "case forcing"
10226 .cindex "&%lc%& expansion item"
10227 This forces the letters in the string into lower-case, for example:
10228 .code
10229 ${lc:$local_part}
10230 .endd
10231
10232 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
10233 .cindex "expansion" "string truncation"
10234 .cindex "&%length%& expansion item"
10235 The &%length%& operator is a simpler interface to the &%length%& function that
10236 can be used when the parameter is a fixed number (as opposed to a string that
10237 changes when expanded). The effect is the same as
10238 .code
10239 ${length{<number>}{<string>}}
10240 .endd
10241 See the description of the general &%length%& item above for details. Note that
10242 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
10243 when &%length%& is used as an operator.
10244
10245
10246 .vitem &*${listcount:*&<&'string'&>&*}*&
10247 .cindex "expansion" "list item count"
10248 .cindex "list" "item count"
10249 .cindex "list" "count of items"
10250 .cindex "&%listcount%& expansion item"
10251 The string is interpreted as a list and the number of items is returned.
10252
10253
10254 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
10255 .cindex "expansion" "named list"
10256 .cindex "&%listnamed%& expansion item"
10257 The name is interpreted as a named list and the content of the list is returned,
10258 expanding any referenced lists, re-quoting as needed for colon-separation.
10259 If the optional type is given it must be one of "a", "d", "h" or "l"
10260 and selects address-, domain-, host- or localpart- lists to search among respectively.
10261 Otherwise all types are searched in an undefined order and the first
10262 matching list is returned.
10263
10264
10265 .vitem &*${local_part:*&<&'string'&>&*}*&
10266 .cindex "expansion" "local part extraction"
10267 .cindex "&%local_part%& expansion item"
10268 The string is interpreted as an RFC 2822 address and the local part is
10269 extracted from it. If the string does not parse successfully, the result is
10270 empty.
10271
10272
10273 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
10274 .cindex "masked IP address"
10275 .cindex "IP address" "masking"
10276 .cindex "CIDR notation"
10277 .cindex "expansion" "IP address masking"
10278 .cindex "&%mask%& expansion item"
10279 If the form of the string to be operated on is not an IP address followed by a
10280 slash and an integer (that is, a network address in CIDR notation), the
10281 expansion fails. Otherwise, this operator converts the IP address to binary,
10282 masks off the least significant bits according to the bit count, and converts
10283 the result back to text, with mask appended. For example,
10284 .code
10285 ${mask:10.111.131.206/28}
10286 .endd
10287 returns the string &"10.111.131.192/28"&. Since this operation is expected to
10288 be mostly used for looking up masked addresses in files, the result for an IPv6
10289 address uses dots to separate components instead of colons, because colon
10290 terminates a key string in lsearch files. So, for example,
10291 .code
10292 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
10293 .endd
10294 returns the string
10295 .code
10296 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
10297 .endd
10298 Letters in IPv6 addresses are always output in lower case.
10299
10300
10301 .vitem &*${md5:*&<&'string'&>&*}*&
10302 .cindex "MD5 hash"
10303 .cindex "expansion" "MD5 hash"
10304 .cindex certificate fingerprint
10305 .cindex "&%md5%& expansion item"
10306 The &%md5%& operator computes the MD5 hash value of the string, and returns it
10307 as a 32-digit hexadecimal number, in which any letters are in lower case.
10308
10309 If the string is a single variable of type certificate,
10310 returns the MD5 hash fingerprint of the certificate.
10311
10312
10313 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10314 .cindex "expansion" "numeric hash"
10315 .cindex "hash function" "numeric"
10316 The &%nhash%& operator is a simpler interface to the numeric hashing function
10317 that can be used when the two parameters are fixed numbers (as opposed to
10318 strings that change when expanded). The effect is the same as
10319 .code
10320 ${nhash{<n>}{<m>}{<string>}}
10321 .endd
10322 See the description of the general &%nhash%& item above for details.
10323
10324
10325 .vitem &*${quote:*&<&'string'&>&*}*&
10326 .cindex "quoting" "in string expansions"
10327 .cindex "expansion" "quoting"
10328 .cindex "&%quote%& expansion item"
10329 The &%quote%& operator puts its argument into double quotes if it
10330 is an empty string or
10331 contains anything other than letters, digits, underscores, dots, and hyphens.
10332 Any occurrences of double quotes and backslashes are escaped with a backslash.
10333 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
10334 respectively For example,
10335 .code
10336 ${quote:ab"*"cd}
10337 .endd
10338 becomes
10339 .code
10340 "ab\"*\"cd"
10341 .endd
10342 The place where this is useful is when the argument is a substitution from a
10343 variable or a message header.
10344
10345 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
10346 .cindex "&%quote_local_part%& expansion item"
10347 This operator is like &%quote%&, except that it quotes the string only if
10348 required to do so by the rules of RFC 2822 for quoting local parts. For
10349 example, a plus sign would not cause quoting (but it would for &%quote%&).
10350 If you are creating a new email address from the contents of &$local_part$&
10351 (or any other unknown data), you should always use this operator.
10352
10353
10354 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
10355 .cindex "quoting" "lookup-specific"
10356 This operator applies lookup-specific quoting rules to the string. Each
10357 query-style lookup type has its own quoting rules which are described with
10358 the lookups in chapter &<<CHAPfdlookup>>&. For example,
10359 .code
10360 ${quote_ldap:two * two}
10361 .endd
10362 returns
10363 .code
10364 two%20%5C2A%20two
10365 .endd
10366 For single-key lookup types, no quoting is ever necessary and this operator
10367 yields an unchanged string.
10368
10369
10370 .vitem &*${randint:*&<&'n'&>&*}*&
10371 .cindex "random number"
10372 This operator returns a somewhat random number which is less than the
10373 supplied number and is at least 0.  The quality of this randomness depends
10374 on how Exim was built; the values are not suitable for keying material.
10375 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
10376 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
10377 for versions of GnuTLS with that function.
10378 Otherwise, the implementation may be arc4random(), random() seeded by
10379 srandomdev() or srandom(), or a custom implementation even weaker than
10380 random().
10381
10382
10383 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
10384 .cindex "expansion" "IP address"
10385 This operator reverses an IP address; for IPv4 addresses, the result is in
10386 dotted-quad decimal form, while for IPv6 addresses the result is in
10387 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
10388 for DNS.  For example,
10389 .code
10390 ${reverse_ip:192.0.2.4}
10391 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
10392 .endd
10393 returns
10394 .code
10395 4.2.0.192
10396 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
10397 .endd
10398
10399
10400 .vitem &*${rfc2047:*&<&'string'&>&*}*&
10401 .cindex "expansion" "RFC 2047"
10402 .cindex "RFC 2047" "expansion operator"
10403 .cindex "&%rfc2047%& expansion item"
10404 This operator encodes text according to the rules of RFC 2047. This is an
10405 encoding that is used in header lines to encode non-ASCII characters. It is
10406 assumed that the input string is in the encoding specified by the
10407 &%headers_charset%& option, which gets its default at build time. If the string
10408 contains only characters in the range 33&--126, and no instances of the
10409 characters
10410 .code
10411 ? = ( ) < > @ , ; : \ " . [ ] _
10412 .endd
10413 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
10414 string, using as many &"encoded words"& as necessary to encode all the
10415 characters.
10416
10417
10418 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
10419 .cindex "expansion" "RFC 2047"
10420 .cindex "RFC 2047" "decoding"
10421 .cindex "&%rfc2047d%& expansion item"
10422 This operator decodes strings that are encoded as per RFC 2047. Binary zero
10423 bytes are replaced by question marks. Characters are converted into the
10424 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
10425 not recognized unless &%check_rfc2047_length%& is set false.
10426
10427 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
10428 access a header line, RFC 2047 decoding is done automatically. You do not need
10429 to use this operator as well.
10430
10431
10432
10433 .vitem &*${rxquote:*&<&'string'&>&*}*&
10434 .cindex "quoting" "in regular expressions"
10435 .cindex "regular expressions" "quoting"
10436 .cindex "&%rxquote%& expansion item"
10437 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
10438 characters in its argument. This is useful when substituting the values of
10439 variables or headers inside regular expressions.
10440
10441
10442 .vitem &*${sha1:*&<&'string'&>&*}*&
10443 .cindex "SHA-1 hash"
10444 .cindex "expansion" "SHA-1 hashing"
10445 .cindex certificate fingerprint
10446 .cindex "&%sha2%& expansion item"
10447 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
10448 it as a 40-digit hexadecimal number, in which any letters are in upper case.
10449
10450 If the string is a single variable of type certificate,
10451 returns the SHA-1 hash fingerprint of the certificate.
10452
10453
10454 .vitem &*${sha256:*&<&'certificate'&>&*}*&
10455 .cindex "SHA-256 hash"
10456 .cindex certificate fingerprint
10457 .cindex "expansion" "SHA-256 hashing"
10458 .cindex "&%sha256%& expansion item"
10459 The &%sha256%& operator computes the SHA-256 hash fingerprint of the
10460 certificate,
10461 and returns
10462 it as a 64-digit hexadecimal number, in which any letters are in upper case.
10463 Only arguments which are a single variable of certificate type are supported.
10464
10465
10466 .vitem &*${stat:*&<&'string'&>&*}*&
10467 .cindex "expansion" "statting a file"
10468 .cindex "file" "extracting characteristics"
10469 .cindex "&%stat%& expansion item"
10470 The string, after expansion, must be a file path. A call to the &[stat()]&
10471 function is made for this path. If &[stat()]& fails, an error occurs and the
10472 expansion fails. If it succeeds, the data from the stat replaces the item, as a
10473 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
10474 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
10475 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
10476 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
10477 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
10478 can extract individual fields using the &%extract%& expansion item.
10479
10480 The use of the &%stat%& expansion in users' filter files can be locked out by
10481 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
10482 systems for files larger than 2GB.
10483
10484 .vitem &*${str2b64:*&<&'string'&>&*}*&
10485 .cindex "&%str2b64%& expansion item"
10486 .new
10487 Now deprecated, a synonym for the &%base64%& expansion operator.
10488 .wen
10489
10490
10491
10492 .vitem &*${strlen:*&<&'string'&>&*}*&
10493 .cindex "expansion" "string length"
10494 .cindex "string" "length in expansion"
10495 .cindex "&%strlen%& expansion item"
10496 The item is replace by the length of the expanded string, expressed as a
10497 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
10498
10499
10500 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
10501 .cindex "&%substr%& expansion item"
10502 .cindex "substring extraction"
10503 .cindex "expansion" "substring expansion"
10504 The &%substr%& operator is a simpler interface to the &%substr%& function that
10505 can be used when the two parameters are fixed numbers (as opposed to strings
10506 that change when expanded). The effect is the same as
10507 .code
10508 ${substr{<start>}{<length>}{<string>}}
10509 .endd
10510 See the description of the general &%substr%& item above for details. The
10511 abbreviation &%s%& can be used when &%substr%& is used as an operator.
10512
10513 .vitem &*${time_eval:*&<&'string'&>&*}*&
10514 .cindex "&%time_eval%& expansion item"
10515 .cindex "time interval" "decoding"
10516 This item converts an Exim time interval such as &`2d4h5m`& into a number of
10517 seconds.
10518
10519 .vitem &*${time_interval:*&<&'string'&>&*}*&
10520 .cindex "&%time_interval%& expansion item"
10521 .cindex "time interval" "formatting"
10522 The argument (after sub-expansion) must be a sequence of decimal digits that
10523 represents an interval of time as a number of seconds. It is converted into a
10524 number of larger units and output in Exim's normal time format, for example,
10525 &`1w3d4h2m6s`&.
10526
10527 .vitem &*${uc:*&<&'string'&>&*}*&
10528 .cindex "case forcing in strings"
10529 .cindex "string" "case forcing"
10530 .cindex "upper casing"
10531 .cindex "expansion" "case forcing"
10532 .cindex "&%uc%& expansion item"
10533 This forces the letters in the string into upper-case.
10534
10535 .vitem &*${utf8clean:*&<&'string'&>&*}*&
10536 .cindex "correction of invalid utf-8 sequences in strings"
10537 .cindex "utf-8" "utf-8 sequences"
10538 .cindex "incorrect utf-8"
10539 .cindex "expansion" "utf-8 forcing"
10540 .cindex "&%utf8clean%& expansion item"
10541 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
10542
10543 .new
10544 .vitem "&*${utf8_domain_to_alabel:*&<&'string'&>&*}*&" &&&
10545        "&*${utf8_domain_from_alabel:*&<&'string'&>&*}*&" &&&
10546        "&*${utf8_localpart_to_alabel:*&<&'string'&>&*}*&" &&&
10547        "&*${utf8_localpart_from_alabel:*&<&'string'&>&*}*&"
10548 .cindex expansion UTF-8
10549 .cindex UTF-8 expansion
10550 .cindex EAI
10551 .cindex internationalisation
10552 .cindex "&%utf8_domain_to_alabel%& expansion item"
10553 .cindex "&%utf8_domain_from_alabel%& expansion item"
10554 .cindex "&%utf8_localpart_to_alabel%& expansion item"
10555 .cindex "&%utf8_localpart_from_alabel%& expansion item"
10556 These convert EAI mail name components between UTF-8 and a-label forms.
10557 For information on internationalisation support see &<<SECTi18nMTA>>&.
10558 .wen
10559 .endlist
10560
10561
10562
10563
10564
10565
10566 .section "Expansion conditions" "SECTexpcond"
10567 .scindex IIDexpcond "expansion" "conditions"
10568 The following conditions are available for testing by the &%${if%& construct
10569 while expanding strings:
10570
10571 .vlist
10572 .vitem &*!*&<&'condition'&>
10573 .cindex "expansion" "negating a condition"
10574 .cindex "negation" "in expansion condition"
10575 Preceding any condition with an exclamation mark negates the result of the
10576 condition.
10577
10578 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10579 .cindex "numeric comparison"
10580 .cindex "expansion" "numeric comparison"
10581 There are a number of symbolic operators for doing numeric comparisons. They
10582 are:
10583 .display
10584 &`=   `&   equal
10585 &`==  `&   equal
10586 &`>   `&   greater
10587 &`>=  `&   greater or equal
10588 &`<   `&   less
10589 &`<=  `&   less or equal
10590 .endd
10591 For example:
10592 .code
10593 ${if >{$message_size}{10M} ...
10594 .endd
10595 Note that the general negation operator provides for inequality testing. The
10596 two strings must take the form of optionally signed decimal integers,
10597 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
10598 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
10599 As a special case, the numerical value of an empty string is taken as
10600 zero.
10601
10602 In all cases, a relative comparator OP is testing if <&'string1'&> OP
10603 <&'string2'&>; the above example is checking if &$message_size$& is larger than
10604 10M, not if 10M is larger than &$message_size$&.
10605
10606
10607 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
10608         {*&<&'arg2'&>&*}...}*&
10609 .cindex "expansion" "calling an acl"
10610 .cindex "&%acl%&" "expansion condition"
10611 The name and zero to nine argument strings are first expanded separately.  The expanded
10612 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
10613 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
10614 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
10615 and may use the variables; if another acl expansion is used the values
10616 are restored after it returns.  If the ACL sets
10617 a value using a "message =" modifier the variable $value becomes
10618 the result of the expansion, otherwise it is empty.
10619 If the ACL returns accept the condition is true; if deny, false.
10620 If the ACL returns defer the result is a forced-fail.
10621
10622 .vitem &*bool&~{*&<&'string'&>&*}*&
10623 .cindex "expansion" "boolean parsing"
10624 .cindex "&%bool%& expansion condition"
10625 This condition turns a string holding a true or false representation into
10626 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
10627 (case-insensitively); also integer numbers map to true if non-zero,
10628 false if zero.
10629 An empty string is treated as false.
10630 Leading and trailing whitespace is ignored;
10631 thus a string consisting only of whitespace is false.
10632 All other string values will result in expansion failure.
10633
10634 When combined with ACL variables, this expansion condition will let you
10635 make decisions in one place and act on those decisions in another place.
10636 For example:
10637 .code
10638 ${if bool{$acl_m_privileged_sender} ...
10639 .endd
10640
10641
10642 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
10643 .cindex "expansion" "boolean parsing"
10644 .cindex "&%bool_lax%& expansion condition"
10645 Like &%bool%&, this condition turns a string into a boolean state.  But
10646 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
10647 loose definition that the Router &%condition%& option uses.  The empty string
10648 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
10649 true.  Leading and trailing whitespace is ignored.
10650
10651 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
10652
10653 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10654 .cindex "expansion" "encrypted comparison"
10655 .cindex "encrypted strings, comparing"
10656 .cindex "&%crypteq%& expansion condition"
10657 This condition is included in the Exim binary if it is built to support any
10658 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
10659 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
10660 included in the binary.
10661
10662 The &%crypteq%& condition has two arguments. The first is encrypted and
10663 compared against the second, which is already encrypted. The second string may
10664 be in the LDAP form for storing encrypted strings, which starts with the
10665 encryption type in curly brackets, followed by the data. If the second string
10666 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
10667 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
10668 Typically this will be a field from a password file. An example of an encrypted
10669 string in LDAP form is:
10670 .code
10671 {md5}CY9rzUYh03PK3k6DJie09g==
10672 .endd
10673 If such a string appears directly in an expansion, the curly brackets have to
10674 be quoted, because they are part of the expansion syntax. For example:
10675 .code
10676 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
10677 .endd
10678 The following encryption types (whose names are matched case-independently) are
10679 supported:
10680
10681 .ilist
10682 .cindex "MD5 hash"
10683 .cindex "base64 encoding" "in encrypted password"
10684 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
10685 printable characters to compare with the remainder of the second string. If the
10686 length of the comparison string is 24, Exim assumes that it is base64 encoded
10687 (as in the above example). If the length is 32, Exim assumes that it is a
10688 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
10689 comparison fails.
10690
10691 .next
10692 .cindex "SHA-1 hash"
10693 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
10694 printable characters to compare with the remainder of the second string. If the
10695 length of the comparison string is 28, Exim assumes that it is base64 encoded.
10696 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
10697 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
10698
10699 .next
10700 .cindex "&[crypt()]&"
10701 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
10702 only the first eight characters of the password. However, in modern operating
10703 systems this is no longer true, and in many cases the entire password is used,
10704 whatever its length.
10705
10706 .next
10707 .cindex "&[crypt16()]&"
10708 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
10709 use up to 16 characters of the password in some operating systems. Again, in
10710 modern operating systems, more characters may be used.
10711 .endlist
10712 Exim has its own version of &[crypt16()]&, which is just a double call to
10713 &[crypt()]&. For operating systems that have their own version, setting
10714 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
10715 operating system version instead of its own. This option is set by default in
10716 the OS-dependent &_Makefile_& for those operating systems that are known to
10717 support &[crypt16()]&.
10718
10719 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
10720 it was not using the same algorithm as some operating systems' versions. It
10721 turns out that as well as &[crypt16()]& there is a function called
10722 &[bigcrypt()]& in some operating systems. This may or may not use the same
10723 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
10724
10725 However, since there is now a move away from the traditional &[crypt()]&
10726 functions towards using SHA1 and other algorithms, tidying up this area of
10727 Exim is seen as very low priority.
10728
10729 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
10730 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
10731 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
10732 default is &`{crypt}`&. Whatever the default, you can always use either
10733 function by specifying it explicitly in curly brackets.
10734
10735 .vitem &*def:*&<&'variable&~name'&>
10736 .cindex "expansion" "checking for empty variable"
10737 .cindex "&%def%& expansion condition"
10738 The &%def%& condition must be followed by the name of one of the expansion
10739 variables defined in section &<<SECTexpvar>>&. The condition is true if the
10740 variable does not contain the empty string. For example:
10741 .code
10742 ${if def:sender_ident {from $sender_ident}}
10743 .endd
10744 Note that the variable name is given without a leading &%$%& character. If the
10745 variable does not exist, the expansion fails.
10746
10747 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
10748         &~&*def:h_*&<&'header&~name'&>&*:*&"
10749 .cindex "expansion" "checking header line existence"
10750 This condition is true if a message is being processed and the named header
10751 exists in the message. For example,
10752 .code
10753 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
10754 .endd
10755 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
10756 the header name must be terminated by a colon if white space does not follow.
10757
10758 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10759        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10760 .cindex "string" "comparison"
10761 .cindex "expansion" "string comparison"
10762 .cindex "&%eq%& expansion condition"
10763 .cindex "&%eqi%& expansion condition"
10764 The two substrings are first expanded. The condition is true if the two
10765 resulting strings are identical. For &%eq%& the comparison includes the case of
10766 letters, whereas for &%eqi%& the comparison is case-independent.
10767
10768 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
10769 .cindex "expansion" "file existence test"
10770 .cindex "file" "existence test"
10771 .cindex "&%exists%&, expansion condition"
10772 The substring is first expanded and then interpreted as an absolute path. The
10773 condition is true if the named file (or directory) exists. The existence test
10774 is done by calling the &[stat()]& function. The use of the &%exists%& test in
10775 users' filter files may be locked out by the system administrator.
10776
10777 .vitem &*first_delivery*&
10778 .cindex "delivery" "first"
10779 .cindex "first delivery"
10780 .cindex "expansion" "first delivery test"
10781 .cindex "&%first_delivery%& expansion condition"
10782 This condition, which has no data, is true during a message's first delivery
10783 attempt. It is false during any subsequent delivery attempts.
10784
10785
10786 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
10787        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
10788 .cindex "list" "iterative conditions"
10789 .cindex "expansion" "&*forall*& condition"
10790 .cindex "expansion" "&*forany*& condition"
10791 .vindex "&$item$&"
10792 These conditions iterate over a list. The first argument is expanded to form
10793 the list. By default, the list separator is a colon, but it can be changed by
10794 the normal method. The second argument is interpreted as a condition that is to
10795 be applied to each item in the list in turn. During the interpretation of the
10796 condition, the current list item is placed in a variable called &$item$&.
10797 .ilist
10798 For &*forany*&, interpretation stops if the condition is true for any item, and
10799 the result of the whole condition is true. If the condition is false for all
10800 items in the list, the overall condition is false.
10801 .next
10802 For &*forall*&, interpretation stops if the condition is false for any item,
10803 and the result of the whole condition is false. If the condition is true for
10804 all items in the list, the overall condition is true.
10805 .endlist
10806 Note that negation of &*forany*& means that the condition must be false for all
10807 items for the overall condition to succeed, and negation of &*forall*& means
10808 that the condition must be false for at least one item. In this example, the
10809 list separator is changed to a comma:
10810 .code
10811 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
10812 .endd
10813 The value of &$item$& is saved and restored while &*forany*& or &*forall*& is
10814 being processed, to enable these expansion items to be nested.
10815
10816 To scan a named list, expand it with the &*listnamed*& operator.
10817
10818
10819 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10820        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10821 .cindex "string" "comparison"
10822 .cindex "expansion" "string comparison"
10823 .cindex "&%ge%& expansion condition"
10824 .cindex "&%gei%& expansion condition"
10825 The two substrings are first expanded. The condition is true if the first
10826 string is lexically greater than or equal to the second string. For &%ge%& the
10827 comparison includes the case of letters, whereas for &%gei%& the comparison is
10828 case-independent.
10829
10830 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10831        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10832 .cindex "string" "comparison"
10833 .cindex "expansion" "string comparison"
10834 .cindex "&%gt%& expansion condition"
10835 .cindex "&%gti%& expansion condition"
10836 The two substrings are first expanded. The condition is true if the first
10837 string is lexically greater than the second string. For &%gt%& the comparison
10838 includes the case of letters, whereas for &%gti%& the comparison is
10839 case-independent.
10840
10841 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10842        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10843 .cindex "string" "comparison"
10844 .cindex "list" "iterative conditions"
10845 Both strings are expanded; the second string is treated as a list of simple
10846 strings; if the first string is a member of the second, then the condition
10847 is true.
10848
10849 These are simpler to use versions of the more powerful &*forany*& condition.
10850 Examples, and the &*forany*& equivalents:
10851 .code
10852 ${if inlist{needle}{foo:needle:bar}}
10853   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
10854 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
10855   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
10856 .endd
10857
10858 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
10859        &*isip4&~{*&<&'string'&>&*}*& &&&
10860        &*isip6&~{*&<&'string'&>&*}*&
10861 .cindex "IP address" "testing string format"
10862 .cindex "string" "testing for IP address"
10863 .cindex "&%isip%& expansion condition"
10864 .cindex "&%isip4%& expansion condition"
10865 .cindex "&%isip6%& expansion condition"
10866 The substring is first expanded, and then tested to see if it has the form of
10867 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
10868 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
10869
10870 For an IPv4 address, the test is for four dot-separated components, each of
10871 which consists of from one to three digits. For an IPv6 address, up to eight
10872 colon-separated components are permitted, each containing from one to four
10873 hexadecimal digits. There may be fewer than eight components if an empty
10874 component (adjacent colons) is present. Only one empty component is permitted.
10875
10876 &*Note*&: The checks are just on the form of the address; actual numerical
10877 values are not considered. Thus, for example, 999.999.999.999 passes the IPv4
10878 check. The main use of these tests is to distinguish between IP addresses and
10879 host names, or between IPv4 and IPv6 addresses. For example, you could use
10880 .code
10881 ${if isip4{$sender_host_address}...
10882 .endd
10883 to test which IP version an incoming SMTP connection is using.
10884
10885 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
10886 .cindex "LDAP" "use for authentication"
10887 .cindex "expansion" "LDAP authentication test"
10888 .cindex "&%ldapauth%& expansion condition"
10889 This condition supports user authentication using LDAP. See section
10890 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
10891 queries. For this use, the query must contain a user name and password. The
10892 query itself is not used, and can be empty. The condition is true if the
10893 password is not empty, and the user name and password are accepted by the LDAP
10894 server. An empty password is rejected without calling LDAP because LDAP binds
10895 with an empty password are considered anonymous regardless of the username, and
10896 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
10897 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
10898 this can be used.
10899
10900
10901 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10902        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10903 .cindex "string" "comparison"
10904 .cindex "expansion" "string comparison"
10905 .cindex "&%le%& expansion condition"
10906 .cindex "&%lei%& expansion condition"
10907 The two substrings are first expanded. The condition is true if the first
10908 string is lexically less than or equal to the second string. For &%le%& the
10909 comparison includes the case of letters, whereas for &%lei%& the comparison is
10910 case-independent.
10911
10912 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10913        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10914 .cindex "string" "comparison"
10915 .cindex "expansion" "string comparison"
10916 .cindex "&%lt%& expansion condition"
10917 .cindex "&%lti%& expansion condition"
10918 The two substrings are first expanded. The condition is true if the first
10919 string is lexically less than the second string. For &%lt%& the comparison
10920 includes the case of letters, whereas for &%lti%& the comparison is
10921 case-independent.
10922
10923
10924 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10925 .cindex "expansion" "regular expression comparison"
10926 .cindex "regular expressions" "match in expanded string"
10927 .cindex "&%match%& expansion condition"
10928 The two substrings are first expanded. The second is then treated as a regular
10929 expression and applied to the first. Because of the pre-expansion, if the
10930 regular expression contains dollar, or backslash characters, they must be
10931 escaped. Care must also be taken if the regular expression contains braces
10932 (curly brackets). A closing brace must be escaped so that it is not taken as a
10933 premature termination of <&'string2'&>. The easiest approach is to use the
10934 &`\N`& feature to disable expansion of the regular expression.
10935 For example,
10936 .code
10937 ${if match {$local_part}{\N^\d{3}\N} ...
10938 .endd
10939 If the whole expansion string is in double quotes, further escaping of
10940 backslashes is also required.
10941
10942 The condition is true if the regular expression match succeeds.
10943 The regular expression is not required to begin with a circumflex
10944 metacharacter, but if there is no circumflex, the expression is not anchored,
10945 and it may match anywhere in the subject, not just at the start. If you want
10946 the pattern to match at the end of the subject, you must include the &`$`&
10947 metacharacter at an appropriate point.
10948
10949 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
10950 At the start of an &%if%& expansion the values of the numeric variable
10951 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
10952 succeeds causes them to be reset to the substrings of that condition and they
10953 will have these values during the expansion of the success string. At the end
10954 of the &%if%& expansion, the previous values are restored. After testing a
10955 combination of conditions using &%or%&, the subsequent values of the numeric
10956 variables are those of the condition that succeeded.
10957
10958 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10959 .cindex "&%match_address%& expansion condition"
10960 See &*match_local_part*&.
10961
10962 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10963 .cindex "&%match_domain%& expansion condition"
10964 See &*match_local_part*&.
10965
10966 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10967 .cindex "&%match_ip%& expansion condition"
10968 This condition matches an IP address to a list of IP address patterns. It must
10969 be followed by two argument strings. The first (after expansion) must be an IP
10970 address or an empty string. The second (not expanded) is a restricted host
10971 list that can match only an IP address, not a host name. For example:
10972 .code
10973 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
10974 .endd
10975 The specific types of host list item that are permitted in the list are:
10976
10977 .ilist
10978 An IP address, optionally with a CIDR mask.
10979 .next
10980 A single asterisk, which matches any IP address.
10981 .next
10982 An empty item, which matches only if the IP address is empty. This could be
10983 useful for testing for a locally submitted message or one from specific hosts
10984 in a single test such as
10985 . ==== As this is a nested list, any displays it contains must be indented
10986 . ==== as otherwise they are too far to the left. This comment applies to
10987 . ==== the use of xmlto plus fop. There's no problem when formatting with
10988 . ==== sdop, with or without the extra indent.
10989 .code
10990   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
10991 .endd
10992 where the first item in the list is the empty string.
10993 .next
10994 The item @[] matches any of the local host's interface addresses.
10995 .next
10996 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
10997 even if &`net-`& is not specified. There is never any attempt to turn the IP
10998 address into a host name. The most common type of linear search for
10999 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
11000 masks. For example:
11001 .code
11002   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
11003 .endd
11004 It is of course possible to use other kinds of lookup, and in such a case, you
11005 do need to specify the &`net-`& prefix if you want to specify a specific
11006 address mask, for example:
11007 .code
11008   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
11009 .endd
11010 However, unless you are combining a &%match_ip%& condition with others, it is
11011 just as easy to use the fact that a lookup is itself a condition, and write:
11012 .code
11013   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
11014 .endd
11015 .endlist ilist
11016
11017 Note that <&'string2'&> is not itself subject to string expansion, unless
11018 Exim was built with the EXPAND_LISTMATCH_RHS option.
11019
11020 Consult section &<<SECThoslispatip>>& for further details of these patterns.
11021
11022 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11023 .cindex "domain list" "in expansion condition"
11024 .cindex "address list" "in expansion condition"
11025 .cindex "local part" "list, in expansion condition"
11026 .cindex "&%match_local_part%& expansion condition"
11027 This condition, together with &%match_address%& and &%match_domain%&, make it
11028 possible to test domain, address, and local part lists within expansions. Each
11029 condition requires two arguments: an item and a list to match. A trivial
11030 example is:
11031 .code
11032 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
11033 .endd
11034 In each case, the second argument may contain any of the allowable items for a
11035 list of the appropriate type. Also, because the second argument (after
11036 expansion) is a standard form of list, it is possible to refer to a named list.
11037 Thus, you can use conditions like this:
11038 .code
11039 ${if match_domain{$domain}{+local_domains}{...
11040 .endd
11041 .cindex "&`+caseful`&"
11042 For address lists, the matching starts off caselessly, but the &`+caseful`&
11043 item can be used, as in all address lists, to cause subsequent items to
11044 have their local parts matched casefully. Domains are always matched
11045 caselessly.
11046
11047 Note that <&'string2'&> is not itself subject to string expansion, unless
11048 Exim was built with the EXPAND_LISTMATCH_RHS option.
11049
11050 &*Note*&: Host lists are &'not'& supported in this way. This is because
11051 hosts have two identities: a name and an IP address, and it is not clear
11052 how to specify cleanly how such a test would work. However, IP addresses can be
11053 matched using &%match_ip%&.
11054
11055 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
11056 .cindex "PAM authentication"
11057 .cindex "AUTH" "with PAM"
11058 .cindex "Solaris" "PAM support"
11059 .cindex "expansion" "PAM authentication test"
11060 .cindex "&%pam%& expansion condition"
11061 &'Pluggable Authentication Modules'&
11062 (&url(http://www.kernel.org/pub/linux/libs/pam/)) are a facility that is
11063 available in the latest releases of Solaris and in some GNU/Linux
11064 distributions. The Exim support, which is intended for use in conjunction with
11065 the SMTP AUTH command, is available only if Exim is compiled with
11066 .code
11067 SUPPORT_PAM=yes
11068 .endd
11069 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
11070 in some releases of GNU/Linux &%-ldl%& is also needed.
11071
11072 The argument string is first expanded, and the result must be a
11073 colon-separated list of strings. Leading and trailing white space is ignored.
11074 The PAM module is initialized with the service name &"exim"& and the user name
11075 taken from the first item in the colon-separated data string (<&'string1'&>).
11076 The remaining items in the data string are passed over in response to requests
11077 from the authentication function. In the simple case there will only be one
11078 request, for a password, so the data consists of just two strings.
11079
11080 There can be problems if any of the strings are permitted to contain colon
11081 characters. In the usual way, these have to be doubled to avoid being taken as
11082 separators. If the data is being inserted from a variable, the &%sg%& expansion
11083 item can be used to double any existing colons. For example, the configuration
11084 of a LOGIN authenticator might contain this setting:
11085 .code
11086 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
11087 .endd
11088 For a PLAIN authenticator you could use:
11089 .code
11090 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
11091 .endd
11092 In some operating systems, PAM authentication can be done only from a process
11093 running as root. Since Exim is running as the Exim user when receiving
11094 messages, this means that PAM cannot be used directly in those systems.
11095 A patched version of the &'pam_unix'& module that comes with the
11096 Linux PAM package is available from &url(http://www.e-admin.de/pam_exim/).
11097 The patched module allows one special uid/gid combination, in addition to root,
11098 to authenticate. If you build the patched module to allow the Exim user and
11099 group, PAM can then be used from an Exim authenticator.
11100
11101
11102 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
11103 .cindex "&'pwcheck'& daemon"
11104 .cindex "Cyrus"
11105 .cindex "expansion" "&'pwcheck'& authentication test"
11106 .cindex "&%pwcheck%& expansion condition"
11107 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
11108 This is one way of making it possible for passwords to be checked by a process
11109 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
11110 deprecated. Its replacement is &'saslauthd'& (see below).
11111
11112 The pwcheck support is not included in Exim by default. You need to specify
11113 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
11114 building Exim. For example:
11115 .code
11116 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
11117 .endd
11118 You do not need to install the full Cyrus software suite in order to use
11119 the pwcheck daemon. You can compile and install just the daemon alone
11120 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
11121 access to the &_/var/pwcheck_& directory.
11122
11123 The &%pwcheck%& condition takes one argument, which must be the user name and
11124 password, separated by a colon. For example, in a LOGIN authenticator
11125 configuration, you might have this:
11126 .code
11127 server_condition = ${if pwcheck{$auth1:$auth2}}
11128 .endd
11129 Again, for a PLAIN authenticator configuration, this would be:
11130 .code
11131 server_condition = ${if pwcheck{$auth2:$auth3}}
11132 .endd
11133 .vitem &*queue_running*&
11134 .cindex "queue runner" "detecting when delivering from"
11135 .cindex "expansion" "queue runner test"
11136 .cindex "&%queue_running%& expansion condition"
11137 This condition, which has no data, is true during delivery attempts that are
11138 initiated by queue runner processes, and false otherwise.
11139
11140
11141 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
11142 .cindex "Radius"
11143 .cindex "expansion" "Radius authentication"
11144 .cindex "&%radius%& expansion condition"
11145 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
11146 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
11147 the Radius client configuration file in order to build Exim with Radius
11148 support.
11149
11150 With just that one setting, Exim expects to be linked with the &%radiusclient%&
11151 library, using the original API. If you are using release 0.4.0 or later of
11152 this library, you need to set
11153 .code
11154 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
11155 .endd
11156 in &_Local/Makefile_& when building Exim. You can also link Exim with the
11157 &%libradius%& library that comes with FreeBSD. To do this, set
11158 .code
11159 RADIUS_LIB_TYPE=RADLIB
11160 .endd
11161 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
11162 You may also have to supply a suitable setting in EXTRALIBS so that the
11163 Radius library can be found when Exim is linked.
11164
11165 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
11166 Radius client library, which calls the Radius server. The condition is true if
11167 the authentication is successful. For example:
11168 .code
11169 server_condition = ${if radius{<arguments>}}
11170 .endd
11171
11172
11173 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
11174         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
11175 .cindex "&'saslauthd'& daemon"
11176 .cindex "Cyrus"
11177 .cindex "expansion" "&'saslauthd'& authentication test"
11178 .cindex "&%saslauthd%& expansion condition"
11179 This condition supports user authentication using the Cyrus &'saslauthd'&
11180 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
11181 Using this daemon is one way of making it possible for passwords to be checked
11182 by a process that is not running as root.
11183
11184 The saslauthd support is not included in Exim by default. You need to specify
11185 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
11186 building Exim. For example:
11187 .code
11188 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
11189 .endd
11190 You do not need to install the full Cyrus software suite in order to use
11191 the saslauthd daemon. You can compile and install just the daemon alone
11192 from the Cyrus SASL library.
11193
11194 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
11195 two are mandatory. For example:
11196 .code
11197 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
11198 .endd
11199 The service and the realm are optional (which is why the arguments are enclosed
11200 in their own set of braces). For details of the meaning of the service and
11201 realm, and how to run the daemon, consult the Cyrus documentation.
11202 .endlist vlist
11203
11204
11205
11206 .section "Combining expansion conditions" "SECID84"
11207 .cindex "expansion" "combining conditions"
11208 Several conditions can be tested at once by combining them using the &%and%&
11209 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
11210 conditions on their own, and precede their lists of sub-conditions. Each
11211 sub-condition must be enclosed in braces within the overall braces that contain
11212 the list. No repetition of &%if%& is used.
11213
11214
11215 .vlist
11216 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11217 .cindex "&""or""& expansion condition"
11218 .cindex "expansion" "&""or""& of conditions"
11219 The sub-conditions are evaluated from left to right. The condition is true if
11220 any one of the sub-conditions is true.
11221 For example,
11222 .code
11223 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
11224 .endd
11225 When a true sub-condition is found, the following ones are parsed but not
11226 evaluated. If there are several &"match"& sub-conditions the values of the
11227 numeric variables afterwards are taken from the first one that succeeds.
11228
11229 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11230 .cindex "&""and""& expansion condition"
11231 .cindex "expansion" "&""and""& of conditions"
11232 The sub-conditions are evaluated from left to right. The condition is true if
11233 all of the sub-conditions are true. If there are several &"match"&
11234 sub-conditions, the values of the numeric variables afterwards are taken from
11235 the last one. When a false sub-condition is found, the following ones are
11236 parsed but not evaluated.
11237 .endlist
11238 .ecindex IIDexpcond
11239
11240
11241
11242
11243 .section "Expansion variables" "SECTexpvar"
11244 .cindex "expansion" "variables, list of"
11245 This section contains an alphabetical list of all the expansion variables. Some
11246 of them are available only when Exim is compiled with specific options such as
11247 support for TLS or the content scanning extension.
11248
11249 .vlist
11250 .vitem "&$0$&, &$1$&, etc"
11251 .cindex "numerical variables (&$1$& &$2$& etc)"
11252 When a &%match%& expansion condition succeeds, these variables contain the
11253 captured substrings identified by the regular expression during subsequent
11254 processing of the success string of the containing &%if%& expansion item.
11255 In the expansion condition case
11256 they do not retain their values afterwards; in fact, their previous
11257 values are restored at the end of processing an &%if%& item. The numerical
11258 variables may also be set externally by some other matching process which
11259 precedes the expansion of the string. For example, the commands available in
11260 Exim filter files include an &%if%& command with its own regular expression
11261 matching condition.
11262
11263 .vitem "&$acl_arg1$&, &$acl_arg2$&, etc"
11264 Within an acl condition, expansion condition or expansion item
11265 any arguments are copied to these variables,
11266 any unused variables being made empty.
11267
11268 .vitem "&$acl_c...$&"
11269 Values can be placed in these variables by the &%set%& modifier in an ACL. They
11270 can be given any name that starts with &$acl_c$& and is at least six characters
11271 long, but the sixth character must be either a digit or an underscore. For
11272 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
11273 variables persist throughout the lifetime of an SMTP connection. They can be
11274 used to pass information between ACLs and between different invocations of the
11275 same ACL. When a message is received, the values of these variables are saved
11276 with the message, and can be accessed by filters, routers, and transports
11277 during subsequent delivery.
11278
11279 .vitem "&$acl_m...$&"
11280 These variables are like the &$acl_c...$& variables, except that their values
11281 are reset after a message has been received. Thus, if several messages are
11282 received in one SMTP connection, &$acl_m...$& values are not passed on from one
11283 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
11284 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
11285 message is received, the values of these variables are saved with the message,
11286 and can be accessed by filters, routers, and transports during subsequent
11287 delivery.
11288
11289 .vitem &$acl_narg$&
11290 Within an acl condition, expansion condition or expansion item
11291 this variable has the number of arguments.
11292
11293 .vitem &$acl_verify_message$&
11294 .vindex "&$acl_verify_message$&"
11295 After an address verification has failed, this variable contains the failure
11296 message. It retains its value for use in subsequent modifiers. The message can
11297 be preserved by coding like this:
11298 .code
11299 warn !verify = sender
11300      set acl_m0 = $acl_verify_message
11301 .endd
11302 You can use &$acl_verify_message$& during the expansion of the &%message%& or
11303 &%log_message%& modifiers, to include information about the verification
11304 failure.
11305
11306 .vitem &$address_data$&
11307 .vindex "&$address_data$&"
11308 This variable is set by means of the &%address_data%& option in routers. The
11309 value then remains with the address while it is processed by subsequent routers
11310 and eventually a transport. If the transport is handling multiple addresses,
11311 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
11312 for more details. &*Note*&: The contents of &$address_data$& are visible in
11313 user filter files.
11314
11315 If &$address_data$& is set when the routers are called from an ACL to verify
11316 a recipient address, the final value is still in the variable for subsequent
11317 conditions and modifiers of the ACL statement. If routing the address caused it
11318 to be redirected to just one address, the child address is also routed as part
11319 of the verification, and in this case the final value of &$address_data$& is
11320 from the child's routing.
11321
11322 If &$address_data$& is set when the routers are called from an ACL to verify a
11323 sender address, the final value is also preserved, but this time in
11324 &$sender_address_data$&, to distinguish it from data from a recipient
11325 address.
11326
11327 In both cases (recipient and sender verification), the value does not persist
11328 after the end of the current ACL statement. If you want to preserve
11329 these values for longer, you can save them in ACL variables.
11330
11331 .vitem &$address_file$&
11332 .vindex "&$address_file$&"
11333 When, as a result of aliasing, forwarding, or filtering, a message is directed
11334 to a specific file, this variable holds the name of the file when the transport
11335 is running. At other times, the variable is empty. For example, using the
11336 default configuration, if user &%r2d2%& has a &_.forward_& file containing
11337 .code
11338 /home/r2d2/savemail
11339 .endd
11340 then when the &(address_file)& transport is running, &$address_file$&
11341 contains the text string &`/home/r2d2/savemail`&.
11342 .cindex "Sieve filter" "value of &$address_file$&"
11343 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
11344 then up to the transport configuration to generate an appropriate absolute path
11345 to the relevant file.
11346
11347 .vitem &$address_pipe$&
11348 .vindex "&$address_pipe$&"
11349 When, as a result of aliasing or forwarding, a message is directed to a pipe,
11350 this variable holds the pipe command when the transport is running.
11351
11352 .vitem "&$auth1$& &-- &$auth3$&"
11353 .vindex "&$auth1$&, &$auth2$&, etc"
11354 These variables are used in SMTP authenticators (see chapters
11355 &<<CHAPplaintext>>&&--&<<CHAPtlsauth>>&). Elsewhere, they are empty.
11356
11357 .vitem &$authenticated_id$&
11358 .cindex "authentication" "id"
11359 .vindex "&$authenticated_id$&"
11360 When a server successfully authenticates a client it may be configured to
11361 preserve some of the authentication information in the variable
11362 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
11363 user/password authenticator configuration might preserve the user name for use
11364 in the routers. Note that this is not the same information that is saved in
11365 &$sender_host_authenticated$&.
11366 When a message is submitted locally (that is, not over a TCP connection)
11367 the value of &$authenticated_id$& is normally the login name of the calling
11368 process. However, a trusted user can override this by means of the &%-oMai%&
11369 command line option.
11370
11371 .vitem &$authenticated_fail_id$&
11372 .cindex "authentication" "fail" "id"
11373 .vindex "&$authenticated_fail_id$&"
11374 When an authentication attempt fails, the variable &$authenticated_fail_id$&
11375 will contain the failed authentication id. If more than one authentication
11376 id is attempted, it will contain only the last one. The variable is
11377 available for processing in the ACL's, generally the quit or notquit ACL.
11378 A message to a local recipient could still be accepted without requiring
11379 authentication, which means this variable could also be visible in all of
11380 the ACL's as well.
11381
11382
11383 .vitem &$authenticated_sender$&
11384 .cindex "sender" "authenticated"
11385 .cindex "authentication" "sender"
11386 .cindex "AUTH" "on MAIL command"
11387 .vindex "&$authenticated_sender$&"
11388 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
11389 SMTP MAIL command if it believes the sender is sufficiently trusted, as
11390 described in section &<<SECTauthparamail>>&. Unless the data is the string
11391 &"<>"&, it is set as the authenticated sender of the message, and the value is
11392 available during delivery in the &$authenticated_sender$& variable. If the
11393 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
11394
11395 .vindex "&$qualify_domain$&"
11396 When a message is submitted locally (that is, not over a TCP connection), the
11397 value of &$authenticated_sender$& is an address constructed from the login
11398 name of the calling process and &$qualify_domain$&, except that a trusted user
11399 can override this by means of the &%-oMas%& command line option.
11400
11401
11402 .vitem &$authentication_failed$&
11403 .cindex "authentication" "failure"
11404 .vindex "&$authentication_failed$&"
11405 This variable is set to &"1"& in an Exim server if a client issues an AUTH
11406 command that does not succeed. Otherwise it is set to &"0"&. This makes it
11407 possible to distinguish between &"did not try to authenticate"&
11408 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
11409 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
11410 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
11411 negative response to an AUTH command, including (for example) an attempt to use
11412 an undefined mechanism.
11413
11414 .vitem &$av_failed$&
11415 .cindex "content scanning" "AV scanner failure"
11416 This variable is available when Exim is compiled with the content-scanning
11417 extension. It is set to &"0"& by default, but will be set to &"1"& if any
11418 problem occurs with the virus scanner (specified by &%av_scanner%&) during
11419 the ACL malware condition.
11420
11421 .vitem &$body_linecount$&
11422 .cindex "message body" "line count"
11423 .cindex "body of message" "line count"
11424 .vindex "&$body_linecount$&"
11425 When a message is being received or delivered, this variable contains the
11426 number of lines in the message's body. See also &$message_linecount$&.
11427
11428 .vitem &$body_zerocount$&
11429 .cindex "message body" "binary zero count"
11430 .cindex "body of message" "binary zero count"
11431 .cindex "binary zero" "in message body"
11432 .vindex "&$body_zerocount$&"
11433 When a message is being received or delivered, this variable contains the
11434 number of binary zero bytes (ASCII NULs) in the message's body.
11435
11436 .vitem &$bounce_recipient$&
11437 .vindex "&$bounce_recipient$&"
11438 This is set to the recipient address of a bounce message while Exim is creating
11439 it. It is useful if a customized bounce message text file is in use (see
11440 chapter &<<CHAPemsgcust>>&).
11441
11442 .vitem &$bounce_return_size_limit$&
11443 .vindex "&$bounce_return_size_limit$&"
11444 This contains the value set in the &%bounce_return_size_limit%& option, rounded
11445 up to a multiple of 1000. It is useful when a customized error message text
11446 file is in use (see chapter &<<CHAPemsgcust>>&).
11447
11448 .vitem &$caller_gid$&
11449 .cindex "gid (group id)" "caller"
11450 .vindex "&$caller_gid$&"
11451 The real group id under which the process that called Exim was running. This is
11452 not the same as the group id of the originator of a message (see
11453 &$originator_gid$&). If Exim re-execs itself, this variable in the new
11454 incarnation normally contains the Exim gid.
11455
11456 .vitem &$caller_uid$&
11457 .cindex "uid (user id)" "caller"
11458 .vindex "&$caller_uid$&"
11459 The real user id under which the process that called Exim was running. This is
11460 not the same as the user id of the originator of a message (see
11461 &$originator_uid$&). If Exim re-execs itself, this variable in the new
11462 incarnation normally contains the Exim uid.
11463
11464 .vitem &$callout_address$&
11465 .vindex "&$callout_address$&"
11466 After a callout for verification, spamd or malware daemon service, the
11467 address that was connected to.
11468
11469 .vitem &$compile_number$&
11470 .vindex "&$compile_number$&"
11471 The building process for Exim keeps a count of the number
11472 of times it has been compiled. This serves to distinguish different
11473 compilations of the same version of the program.
11474
11475 .vitem &$config_dir$&
11476 .vindex "&$config_dir$&"
11477 The directory name of the main configuration file. That is, the content of
11478 &$config_file$& with the last component stripped. The value does not
11479 contain the trailing slash. If &$config_file$& does not contain a slash,
11480 &$config_dir$& is ".".
11481
11482 .vitem &$config_file$&
11483 .vindex "&$config_file$&"
11484 The name of the main configuration file Exim is using.
11485
11486 .vitem &$demime_errorlevel$&
11487 .vindex "&$demime_errorlevel$&"
11488 This variable is available when Exim is compiled with
11489 the content-scanning extension and the obsolete &%demime%& condition. For
11490 details, see section &<<SECTdemimecond>>&.
11491
11492 .vitem &$demime_reason$&
11493 .vindex "&$demime_reason$&"
11494 This variable is available when Exim is compiled with the
11495 content-scanning extension and the obsolete &%demime%& condition. For details,
11496 see section &<<SECTdemimecond>>&.
11497
11498 .vitem &$dkim_cur_signer$& &&&
11499        &$dkim_verify_status$& &&&
11500        &$dkim_verify_reason$& &&&
11501        &$dkim_domain$& &&&
11502        &$dkim_identity$& &&&
11503        &$dkim_selector$& &&&
11504        &$dkim_algo$& &&&
11505        &$dkim_canon_body$& &&&
11506        &$dkim_canon_headers$& &&&
11507        &$dkim_copiedheaders$& &&&
11508        &$dkim_bodylength$& &&&
11509        &$dkim_created$& &&&
11510        &$dkim_expires$& &&&
11511        &$dkim_headernames$& &&&
11512        &$dkim_key_testing$& &&&
11513        &$dkim_key_nosubdomains$& &&&
11514        &$dkim_key_srvtype$& &&&
11515        &$dkim_key_granularity$& &&&
11516        &$dkim_key_notes$& &&&
11517        &$dkim_key_length$&
11518 These variables are only available within the DKIM ACL.
11519 For details see chapter &<<CHAPdkim>>&.
11520
11521 .vitem &$dkim_signers$&
11522 .vindex &$dkim_signers$&
11523 When a message has been received this variable contains
11524 a colon-separated list of signer domains and identities for the message.
11525 For details see chapter &<<CHAPdkim>>&.
11526
11527 .vitem &$dnslist_domain$& &&&
11528        &$dnslist_matched$& &&&
11529        &$dnslist_text$& &&&
11530        &$dnslist_value$&
11531 .vindex "&$dnslist_domain$&"
11532 .vindex "&$dnslist_matched$&"
11533 .vindex "&$dnslist_text$&"
11534 .vindex "&$dnslist_value$&"
11535 .cindex "black list (DNS)"
11536 When a DNS (black) list lookup succeeds, these variables are set to contain
11537 the following data from the lookup: the list's domain name, the key that was
11538 looked up, the contents of any associated TXT record, and the value from the
11539 main A record. See section &<<SECID204>>& for more details.
11540
11541 .vitem &$domain$&
11542 .vindex "&$domain$&"
11543 When an address is being routed, or delivered on its own, this variable
11544 contains the domain. Uppercase letters in the domain are converted into lower
11545 case for &$domain$&.
11546
11547 Global address rewriting happens when a message is received, so the value of
11548 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
11549 is set during user filtering, but not during system filtering, because a
11550 message may have many recipients and the system filter is called just once.
11551
11552 When more than one address is being delivered at once (for example, several
11553 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
11554 have the same domain. Transports can be restricted to handling only one domain
11555 at a time if the value of &$domain$& is required at transport time &-- this is
11556 the default for local transports. For further details of the environment in
11557 which local transports are run, see chapter &<<CHAPenvironment>>&.
11558
11559 .oindex "&%delay_warning_condition%&"
11560 At the end of a delivery, if all deferred addresses have the same domain, it is
11561 set in &$domain$& during the expansion of &%delay_warning_condition%&.
11562
11563 The &$domain$& variable is also used in some other circumstances:
11564
11565 .ilist
11566 When an ACL is running for a RCPT command, &$domain$& contains the domain of
11567 the recipient address. The domain of the &'sender'& address is in
11568 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
11569 normally set during the running of the MAIL ACL. However, if the sender address
11570 is verified with a callout during the MAIL ACL, the sender domain is placed in
11571 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
11572 the &(smtp)& transport.
11573
11574 .next
11575 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11576 &$domain$& contains the domain portion of the address that is being rewritten;
11577 it can be used in the expansion of the replacement address, for example, to
11578 rewrite domains by file lookup.
11579
11580 .next
11581 With one important exception, whenever a domain list is being scanned,
11582 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
11583 a &%sender_domains%& condition in an ACL is being processed, the subject domain
11584 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
11585 that, in a RCPT ACL, the sender domain list can be dependent on the
11586 recipient domain (which is what is in &$domain$& at this time).
11587
11588 .next
11589 .cindex "ETRN" "value of &$domain$&"
11590 .oindex "&%smtp_etrn_command%&"
11591 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
11592 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
11593 .endlist
11594
11595
11596 .vitem &$domain_data$&
11597 .vindex "&$domain_data$&"
11598 When the &%domains%& option on a router matches a domain by
11599 means of a lookup, the data read by the lookup is available during the running
11600 of the router as &$domain_data$&. In addition, if the driver routes the
11601 address to a transport, the value is available in that transport. If the
11602 transport is handling multiple addresses, the value from the first address is
11603 used.
11604
11605 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
11606 domain by means of a lookup. The data read by the lookup is available during
11607 the rest of the ACL statement. In all other situations, this variable expands
11608 to nothing.
11609
11610 .vitem &$exim_gid$&
11611 .vindex "&$exim_gid$&"
11612 This variable contains the numerical value of the Exim group id.
11613
11614 .vitem &$exim_path$&
11615 .vindex "&$exim_path$&"
11616 This variable contains the path to the Exim binary.
11617
11618 .vitem &$exim_uid$&
11619 .vindex "&$exim_uid$&"
11620 This variable contains the numerical value of the Exim user id.
11621
11622 .vitem &$exim_version$&
11623 .vindex "&$exim_version$&"
11624 This variable contains the version string of the Exim build.
11625 The first character is a major version number, currently 4.
11626 Then after a dot, the next group of digits is a minor version number.
11627 There may be other characters following the minor version.
11628
11629 .vitem &$found_extension$&
11630 .vindex "&$found_extension$&"
11631 This variable is available when Exim is compiled with the
11632 content-scanning extension and the obsolete &%demime%& condition. For details,
11633 see section &<<SECTdemimecond>>&.
11634
11635 .vitem &$header_$&<&'name'&>
11636 This is not strictly an expansion variable. It is expansion syntax for
11637 inserting the message header line with the given name. Note that the name must
11638 be terminated by colon or white space, because it may contain a wide variety of
11639 characters. Note also that braces must &'not'& be used.
11640
11641 .vitem &$headers_added$&
11642 .vindex "&$headers_added$&"
11643 Within an ACL this variable contains the headers added so far by
11644 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
11645 The headers are a newline-separated list.
11646
11647 .vitem &$home$&
11648 .vindex "&$home$&"
11649 When the &%check_local_user%& option is set for a router, the user's home
11650 directory is placed in &$home$& when the check succeeds. In particular, this
11651 means it is set during the running of users' filter files. A router may also
11652 explicitly set a home directory for use by a transport; this can be overridden
11653 by a setting on the transport itself.
11654
11655 When running a filter test via the &%-bf%& option, &$home$& is set to the value
11656 of the environment variable HOME.
11657
11658 .vitem &$host$&
11659 .vindex "&$host$&"
11660 If a router assigns an address to a transport (any transport), and passes a
11661 list of hosts with the address, the value of &$host$& when the transport starts
11662 to run is the name of the first host on the list. Note that this applies both
11663 to local and remote transports.
11664
11665 .cindex "transport" "filter"
11666 .cindex "filter" "transport filter"
11667 For the &(smtp)& transport, if there is more than one host, the value of
11668 &$host$& changes as the transport works its way through the list. In
11669 particular, when the &(smtp)& transport is expanding its options for encryption
11670 using TLS, or for specifying a transport filter (see chapter
11671 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
11672 is connected.
11673
11674 When used in the client part of an authenticator configuration (see chapter
11675 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
11676 client is connected.
11677
11678
11679 .vitem &$host_address$&
11680 .vindex "&$host_address$&"
11681 This variable is set to the remote host's IP address whenever &$host$& is set
11682 for a remote connection. It is also set to the IP address that is being checked
11683 when the &%ignore_target_hosts%& option is being processed.
11684
11685 .vitem &$host_data$&
11686 .vindex "&$host_data$&"
11687 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
11688 result of the lookup is made available in the &$host_data$& variable. This
11689 allows you, for example, to do things like this:
11690 .code
11691 deny  hosts = net-lsearch;/some/file
11692 message = $host_data
11693 .endd
11694 .vitem &$host_lookup_deferred$&
11695 .cindex "host name" "lookup, failure of"
11696 .vindex "&$host_lookup_deferred$&"
11697 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
11698 message comes from a remote host and there is an attempt to look up the host's
11699 name from its IP address, and the attempt is not successful, one of these
11700 variables is set to &"1"&.
11701
11702 .ilist
11703 If the lookup receives a definite negative response (for example, a DNS lookup
11704 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
11705
11706 .next
11707 If there is any kind of problem during the lookup, such that Exim cannot
11708 tell whether or not the host name is defined (for example, a timeout for a DNS
11709 lookup), &$host_lookup_deferred$& is set to &"1"&.
11710 .endlist ilist
11711
11712 Looking up a host's name from its IP address consists of more than just a
11713 single reverse lookup. Exim checks that a forward lookup of at least one of the
11714 names it receives from a reverse lookup yields the original IP address. If this
11715 is not the case, Exim does not accept the looked up name(s), and
11716 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
11717 IP address (for example, the existence of a PTR record in the DNS) is not
11718 sufficient on its own for the success of a host name lookup. If the reverse
11719 lookup succeeds, but there is a lookup problem such as a timeout when checking
11720 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
11721 &"1"&. See also &$sender_host_name$&.
11722
11723 .vitem &$host_lookup_failed$&
11724 .vindex "&$host_lookup_failed$&"
11725 See &$host_lookup_deferred$&.
11726
11727 .vitem &$host_port$&
11728 .vindex "&$host_port$&"
11729 This variable is set to the remote host's TCP port whenever &$host$& is set
11730 for an outbound connection.
11731
11732
11733 .vitem &$inode$&
11734 .vindex "&$inode$&"
11735 The only time this variable is set is while expanding the &%directory_file%&
11736 option in the &(appendfile)& transport. The variable contains the inode number
11737 of the temporary file which is about to be renamed. It can be used to construct
11738 a unique name for the file.
11739
11740 .vitem &$interface_address$&
11741 .vindex "&$interface_address$&"
11742 This is an obsolete name for &$received_ip_address$&.
11743
11744 .vitem &$interface_port$&
11745 .vindex "&$interface_port$&"
11746 This is an obsolete name for &$received_port$&.
11747
11748 .vitem &$item$&
11749 .vindex "&$item$&"
11750 This variable is used during the expansion of &*forall*& and &*forany*&
11751 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
11752 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
11753 empty.
11754
11755 .vitem &$ldap_dn$&
11756 .vindex "&$ldap_dn$&"
11757 This variable, which is available only when Exim is compiled with LDAP support,
11758 contains the DN from the last entry in the most recently successful LDAP
11759 lookup.
11760
11761 .vitem &$load_average$&
11762 .vindex "&$load_average$&"
11763 This variable contains the system load average, multiplied by 1000 so that it
11764 is an integer. For example, if the load average is 0.21, the value of the
11765 variable is 210. The value is recomputed every time the variable is referenced.
11766
11767 .vitem &$local_part$&
11768 .vindex "&$local_part$&"
11769 When an address is being routed, or delivered on its own, this
11770 variable contains the local part. When a number of addresses are being
11771 delivered together (for example, multiple RCPT commands in an SMTP
11772 session), &$local_part$& is not set.
11773
11774 Global address rewriting happens when a message is received, so the value of
11775 &$local_part$& during routing and delivery is the value after rewriting.
11776 &$local_part$& is set during user filtering, but not during system filtering,
11777 because a message may have many recipients and the system filter is called just
11778 once.
11779
11780 .vindex "&$local_part_prefix$&"
11781 .vindex "&$local_part_suffix$&"
11782 If a local part prefix or suffix has been recognized, it is not included in the
11783 value of &$local_part$& during routing and subsequent delivery. The values of
11784 any prefix or suffix are in &$local_part_prefix$& and
11785 &$local_part_suffix$&, respectively.
11786
11787 When a message is being delivered to a file, pipe, or autoreply transport as a
11788 result of aliasing or forwarding, &$local_part$& is set to the local part of
11789 the parent address, not to the file name or command (see &$address_file$& and
11790 &$address_pipe$&).
11791
11792 When an ACL is running for a RCPT command, &$local_part$& contains the
11793 local part of the recipient address.
11794
11795 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11796 &$local_part$& contains the local part of the address that is being rewritten;
11797 it can be used in the expansion of the replacement address, for example.
11798
11799 In all cases, all quoting is removed from the local part. For example, for both
11800 the addresses
11801 .code
11802 "abc:xyz"@test.example
11803 abc\:xyz@test.example
11804 .endd
11805 the value of &$local_part$& is
11806 .code
11807 abc:xyz
11808 .endd
11809 If you use &$local_part$& to create another address, you should always wrap it
11810 inside a quoting operator. For example, in a &(redirect)& router you could
11811 have:
11812 .code
11813 data = ${quote_local_part:$local_part}@new.domain.example
11814 .endd
11815 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
11816 to process local parts in a case-dependent manner in a router, you can set the
11817 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
11818
11819 .vitem &$local_part_data$&
11820 .vindex "&$local_part_data$&"
11821 When the &%local_parts%& option on a router matches a local part by means of a
11822 lookup, the data read by the lookup is available during the running of the
11823 router as &$local_part_data$&. In addition, if the driver routes the address
11824 to a transport, the value is available in that transport. If the transport is
11825 handling multiple addresses, the value from the first address is used.
11826
11827 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
11828 matches a local part by means of a lookup. The data read by the lookup is
11829 available during the rest of the ACL statement. In all other situations, this
11830 variable expands to nothing.
11831
11832 .vitem &$local_part_prefix$&
11833 .vindex "&$local_part_prefix$&"
11834 When an address is being routed or delivered, and a
11835 specific prefix for the local part was recognized, it is available in this
11836 variable, having been removed from &$local_part$&.
11837
11838 .vitem &$local_part_suffix$&
11839 .vindex "&$local_part_suffix$&"
11840 When an address is being routed or delivered, and a
11841 specific suffix for the local part was recognized, it is available in this
11842 variable, having been removed from &$local_part$&.
11843
11844 .vitem &$local_scan_data$&
11845 .vindex "&$local_scan_data$&"
11846 This variable contains the text returned by the &[local_scan()]& function when
11847 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
11848
11849 .vitem &$local_user_gid$&
11850 .vindex "&$local_user_gid$&"
11851 See &$local_user_uid$&.
11852
11853 .vitem &$local_user_uid$&
11854 .vindex "&$local_user_uid$&"
11855 This variable and &$local_user_gid$& are set to the uid and gid after the
11856 &%check_local_user%& router precondition succeeds. This means that their values
11857 are available for the remaining preconditions (&%senders%&, &%require_files%&,
11858 and &%condition%&), for the &%address_data%& expansion, and for any
11859 router-specific expansions. At all other times, the values in these variables
11860 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
11861
11862 .vitem &$localhost_number$&
11863 .vindex "&$localhost_number$&"
11864 This contains the expanded value of the
11865 &%localhost_number%& option. The expansion happens after the main options have
11866 been read.
11867
11868 .vitem &$log_inodes$&
11869 .vindex "&$log_inodes$&"
11870 The number of free inodes in the disk partition where Exim's
11871 log files are being written. The value is recalculated whenever the variable is
11872 referenced. If the relevant file system does not have the concept of inodes,
11873 the value of is -1. See also the &%check_log_inodes%& option.
11874
11875 .vitem &$log_space$&
11876 .vindex "&$log_space$&"
11877 The amount of free space (as a number of kilobytes) in the disk
11878 partition where Exim's log files are being written. The value is recalculated
11879 whenever the variable is referenced. If the operating system does not have the
11880 ability to find the amount of free space (only true for experimental systems),
11881 the space value is -1. See also the &%check_log_space%& option.
11882
11883
11884 .vitem &$lookup_dnssec_authenticated$&
11885 .vindex "&$lookup_dnssec_authenticated$&"
11886 This variable is set after a DNS lookup done by
11887 a dnsdb lookup expansion, dnslookup router or smtp transport.
11888 .cindex "DNS" "DNSSEC"
11889 It will be empty if &(DNSSEC)& was not requested,
11890 &"no"& if the result was not labelled as authenticated data
11891 and &"yes"& if it was.
11892 Results that are labelled as authoritative answer that match
11893 the &%dns_trust_aa%& configuration variable count also
11894 as authenticated data.
11895
11896 .vitem &$mailstore_basename$&
11897 .vindex "&$mailstore_basename$&"
11898 This variable is set only when doing deliveries in &"mailstore"& format in the
11899 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
11900 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
11901 contains the basename of the files that are being written, that is, the name
11902 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
11903 variable is empty.
11904
11905 .vitem &$malware_name$&
11906 .vindex "&$malware_name$&"
11907 This variable is available when Exim is compiled with the
11908 content-scanning extension. It is set to the name of the virus that was found
11909 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
11910
11911 .vitem &$max_received_linelength$&
11912 .vindex "&$max_received_linelength$&"
11913 .cindex "maximum" "line length"
11914 .cindex "line length" "maximum"
11915 This variable contains the number of bytes in the longest line that was
11916 received as part of the message, not counting the line termination
11917 character(s).
11918
11919 .vitem &$message_age$&
11920 .cindex "message" "age of"
11921 .vindex "&$message_age$&"
11922 This variable is set at the start of a delivery attempt to contain the number
11923 of seconds since the message was received. It does not change during a single
11924 delivery attempt.
11925
11926 .vitem &$message_body$&
11927 .cindex "body of message" "expansion variable"
11928 .cindex "message body" "in expansion"
11929 .cindex "binary zero" "in message body"
11930 .vindex "&$message_body$&"
11931 .oindex "&%message_body_visible%&"
11932 This variable contains the initial portion of a message's body while it is
11933 being delivered, and is intended mainly for use in filter files. The maximum
11934 number of characters of the body that are put into the variable is set by the
11935 &%message_body_visible%& configuration option; the default is 500.
11936
11937 .oindex "&%message_body_newlines%&"
11938 By default, newlines are converted into spaces in &$message_body$&, to make it
11939 easier to search for phrases that might be split over a line break. However,
11940 this can be disabled by setting &%message_body_newlines%& to be true. Binary
11941 zeros are always converted into spaces.
11942
11943 .vitem &$message_body_end$&
11944 .cindex "body of message" "expansion variable"
11945 .cindex "message body" "in expansion"
11946 .vindex "&$message_body_end$&"
11947 This variable contains the final portion of a message's
11948 body while it is being delivered. The format and maximum size are as for
11949 &$message_body$&.
11950
11951 .vitem &$message_body_size$&
11952 .cindex "body of message" "size"
11953 .cindex "message body" "size"
11954 .vindex "&$message_body_size$&"
11955 When a message is being delivered, this variable contains the size of the body
11956 in bytes. The count starts from the character after the blank line that
11957 separates the body from the header. Newlines are included in the count. See
11958 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
11959
11960 .vitem &$message_exim_id$&
11961 .vindex "&$message_exim_id$&"
11962 When a message is being received or delivered, this variable contains the
11963 unique message id that is generated and used by Exim to identify the message.
11964 An id is not created for a message until after its header has been successfully
11965 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
11966 line; it is the local id that Exim assigns to the message, for example:
11967 &`1BXTIK-0001yO-VA`&.
11968
11969 .vitem &$message_headers$&
11970 .vindex &$message_headers$&
11971 This variable contains a concatenation of all the header lines when a message
11972 is being processed, except for lines added by routers or transports. The header
11973 lines are separated by newline characters. Their contents are decoded in the
11974 same way as a header line that is inserted by &%bheader%&.
11975
11976 .vitem &$message_headers_raw$&
11977 .vindex &$message_headers_raw$&
11978 This variable is like &$message_headers$& except that no processing of the
11979 contents of header lines is done.
11980
11981 .vitem &$message_id$&
11982 This is an old name for &$message_exim_id$&. It is now deprecated.
11983
11984 .vitem &$message_linecount$&
11985 .vindex "&$message_linecount$&"
11986 This variable contains the total number of lines in the header and body of the
11987 message. Compare &$body_linecount$&, which is the count for the body only.
11988 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
11989 number of lines received. Before delivery happens (that is, before filters,
11990 routers, and transports run) the count is increased to include the
11991 &'Received:'& header line that Exim standardly adds, and also any other header
11992 lines that are added by ACLs. The blank line that separates the message header
11993 from the body is not counted.
11994
11995 As with the special case of &$message_size$&, during the expansion of the
11996 appendfile transport's maildir_tag option in maildir format, the value of
11997 &$message_linecount$& is the precise size of the number of newlines in the
11998 file that has been written (minus one for the blank line between the
11999 header and the body).
12000
12001 Here is an example of the use of this variable in a DATA ACL:
12002 .code
12003 deny message   = Too many lines in message header
12004      condition = \
12005       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
12006 .endd
12007 In the MAIL and RCPT ACLs, the value is zero because at that stage the
12008 message has not yet been received.
12009
12010 .vitem &$message_size$&
12011 .cindex "size" "of message"
12012 .cindex "message" "size"
12013 .vindex "&$message_size$&"
12014 When a message is being processed, this variable contains its size in bytes. In
12015 most cases, the size includes those headers that were received with the
12016 message, but not those (such as &'Envelope-to:'&) that are added to individual
12017 deliveries as they are written. However, there is one special case: during the
12018 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
12019 doing a delivery in maildir format, the value of &$message_size$& is the
12020 precise size of the file that has been written. See also
12021 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
12022
12023 .cindex "RCPT" "value of &$message_size$&"
12024 While running a per message ACL (mail/rcpt/predata), &$message_size$&
12025 contains the size supplied on the MAIL command, or -1 if no size was given. The
12026 value may not, of course, be truthful.
12027
12028 .vitem &$mime_$&&'xxx'&
12029 A number of variables whose names start with &$mime$& are
12030 available when Exim is compiled with the content-scanning extension. For
12031 details, see section &<<SECTscanmimepart>>&.
12032
12033 .vitem "&$n0$& &-- &$n9$&"
12034 These variables are counters that can be incremented by means
12035 of the &%add%& command in filter files.
12036
12037 .vitem &$original_domain$&
12038 .vindex "&$domain$&"
12039 .vindex "&$original_domain$&"
12040 When a top-level address is being processed for delivery, this contains the
12041 same value as &$domain$&. However, if a &"child"& address (for example,
12042 generated by an alias, forward, or filter file) is being processed, this
12043 variable contains the domain of the original address (lower cased). This
12044 differs from &$parent_domain$& only when there is more than one level of
12045 aliasing or forwarding. When more than one address is being delivered in a
12046 single transport run, &$original_domain$& is not set.
12047
12048 If a new address is created by means of a &%deliver%& command in a system
12049 filter, it is set up with an artificial &"parent"& address. This has the local
12050 part &'system-filter'& and the default qualify domain.
12051
12052 .vitem &$original_local_part$&
12053 .vindex "&$local_part$&"
12054 .vindex "&$original_local_part$&"
12055 When a top-level address is being processed for delivery, this contains the
12056 same value as &$local_part$&, unless a prefix or suffix was removed from the
12057 local part, because &$original_local_part$& always contains the full local
12058 part. When a &"child"& address (for example, generated by an alias, forward, or
12059 filter file) is being processed, this variable contains the full local part of
12060 the original address.
12061
12062 If the router that did the redirection processed the local part
12063 case-insensitively, the value in &$original_local_part$& is in lower case.
12064 This variable differs from &$parent_local_part$& only when there is more than
12065 one level of aliasing or forwarding. When more than one address is being
12066 delivered in a single transport run, &$original_local_part$& is not set.
12067
12068 If a new address is created by means of a &%deliver%& command in a system
12069 filter, it is set up with an artificial &"parent"& address. This has the local
12070 part &'system-filter'& and the default qualify domain.
12071
12072 .vitem &$originator_gid$&
12073 .cindex "gid (group id)" "of originating user"
12074 .cindex "sender" "gid"
12075 .vindex "&$caller_gid$&"
12076 .vindex "&$originator_gid$&"
12077 This variable contains the value of &$caller_gid$& that was set when the
12078 message was received. For messages received via the command line, this is the
12079 gid of the sending user. For messages received by SMTP over TCP/IP, this is
12080 normally the gid of the Exim user.
12081
12082 .vitem &$originator_uid$&
12083 .cindex "uid (user id)" "of originating user"
12084 .cindex "sender" "uid"
12085 .vindex "&$caller_uid$&"
12086 .vindex "&$originaltor_uid$&"
12087 The value of &$caller_uid$& that was set when the message was received. For
12088 messages received via the command line, this is the uid of the sending user.
12089 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
12090 user.
12091
12092 .vitem &$parent_domain$&
12093 .vindex "&$parent_domain$&"
12094 This variable is similar to &$original_domain$& (see
12095 above), except that it refers to the immediately preceding parent address.
12096
12097 .vitem &$parent_local_part$&
12098 .vindex "&$parent_local_part$&"
12099 This variable is similar to &$original_local_part$&
12100 (see above), except that it refers to the immediately preceding parent address.
12101
12102 .vitem &$pid$&
12103 .cindex "pid (process id)" "of current process"
12104 .vindex "&$pid$&"
12105 This variable contains the current process id.
12106
12107 .vitem &$pipe_addresses$&
12108 .cindex "filter" "transport filter"
12109 .cindex "transport" "filter"
12110 .vindex "&$pipe_addresses$&"
12111 This is not an expansion variable, but is mentioned here because the string
12112 &`$pipe_addresses`& is handled specially in the command specification for the
12113 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
12114 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
12115 It cannot be used in general expansion strings, and provokes an &"unknown
12116 variable"& error if encountered.
12117
12118 .vitem &$primary_hostname$&
12119 .vindex "&$primary_hostname$&"
12120 This variable contains the value set by &%primary_hostname%& in the
12121 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
12122 a single-component name, Exim calls &[gethostbyname()]& (or
12123 &[getipnodebyname()]& where available) in an attempt to acquire a fully
12124 qualified host name. See also &$smtp_active_hostname$&.
12125
12126
12127 .new
12128 .vitem &$proxy_host_address$& &&&
12129        &$proxy_host_port$& &&&
12130        &$proxy_target_address$& &&&
12131        &$proxy_target_port$& &&&
12132        &$proxy_session$&
12133 These variables are only available when built with Proxy Protocol
12134 or Socks5 support
12135 For details see chapter &<<SECTproxyInbound>>&.
12136 .wen
12137
12138 .new
12139 .vitem &$prdr_requested$&
12140 .cindex "PRDR" "variable for"
12141 This variable is set to &"yes"& if PRDR was requested by the client for the
12142 current message, otherwise &"no"&.
12143 .wen
12144
12145 .vitem &$prvscheck_address$&
12146 This variable is used in conjunction with the &%prvscheck%& expansion item,
12147 which is described in sections &<<SECTexpansionitems>>& and
12148 &<<SECTverifyPRVS>>&.
12149
12150 .vitem &$prvscheck_keynum$&
12151 This variable is used in conjunction with the &%prvscheck%& expansion item,
12152 which is described in sections &<<SECTexpansionitems>>& and
12153 &<<SECTverifyPRVS>>&.
12154
12155 .vitem &$prvscheck_result$&
12156 This variable is used in conjunction with the &%prvscheck%& expansion item,
12157 which is described in sections &<<SECTexpansionitems>>& and
12158 &<<SECTverifyPRVS>>&.
12159
12160 .vitem &$qualify_domain$&
12161 .vindex "&$qualify_domain$&"
12162 The value set for the &%qualify_domain%& option in the configuration file.
12163
12164 .vitem &$qualify_recipient$&
12165 .vindex "&$qualify_recipient$&"
12166 The value set for the &%qualify_recipient%& option in the configuration file,
12167 or if not set, the value of &$qualify_domain$&.
12168
12169 .vitem &$rcpt_count$&
12170 .vindex "&$rcpt_count$&"
12171 When a message is being received by SMTP, this variable contains the number of
12172 RCPT commands received for the current message. If this variable is used in a
12173 RCPT ACL, its value includes the current command.
12174
12175 .vitem &$rcpt_defer_count$&
12176 .vindex "&$rcpt_defer_count$&"
12177 .cindex "4&'xx'& responses" "count of"
12178 When a message is being received by SMTP, this variable contains the number of
12179 RCPT commands in the current message that have previously been rejected with a
12180 temporary (4&'xx'&) response.
12181
12182 .vitem &$rcpt_fail_count$&
12183 .vindex "&$rcpt_fail_count$&"
12184 When a message is being received by SMTP, this variable contains the number of
12185 RCPT commands in the current message that have previously been rejected with a
12186 permanent (5&'xx'&) response.
12187
12188 .vitem &$received_count$&
12189 .vindex "&$received_count$&"
12190 This variable contains the number of &'Received:'& header lines in the message,
12191 including the one added by Exim (so its value is always greater than zero). It
12192 is available in the DATA ACL, the non-SMTP ACL, and while routing and
12193 delivering.
12194
12195 .vitem &$received_for$&
12196 .vindex "&$received_for$&"
12197 If there is only a single recipient address in an incoming message, this
12198 variable contains that address when the &'Received:'& header line is being
12199 built. The value is copied after recipient rewriting has happened, but before
12200 the &[local_scan()]& function is run.
12201
12202 .vitem &$received_ip_address$&
12203 .vindex "&$received_ip_address$&"
12204 As soon as an Exim server starts processing an incoming TCP/IP connection, this
12205 variable is set to the address of the local IP interface, and &$received_port$&
12206 is set to the local port number. (The remote IP address and port are in
12207 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
12208 the port value is -1 unless it has been set using the &%-oMi%& command line
12209 option.
12210
12211 As well as being useful in ACLs (including the &"connect"& ACL), these variable
12212 could be used, for example, to make the file name for a TLS certificate depend
12213 on which interface and/or port is being used for the incoming connection. The
12214 values of &$received_ip_address$& and &$received_port$& are saved with any
12215 messages that are received, thus making these variables available at delivery
12216 time.
12217 For outbound connections see &$sending_ip_address$&.
12218
12219 .vitem &$received_port$&
12220 .vindex "&$received_port$&"
12221 See &$received_ip_address$&.
12222
12223 .vitem &$received_protocol$&
12224 .vindex "&$received_protocol$&"
12225 When a message is being processed, this variable contains the name of the
12226 protocol by which it was received. Most of the names used by Exim are defined
12227 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
12228 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
12229 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
12230 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
12231 connection and the client was successfully authenticated.
12232
12233 Exim uses the protocol name &"smtps"& for the case when encryption is
12234 automatically set up on connection without the use of STARTTLS (see
12235 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
12236 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
12237 where the client initially uses EHLO, sets up an encrypted connection using
12238 STARTTLS, and then uses HELO afterwards.
12239
12240 The &%-oMr%& option provides a way of specifying a custom protocol name for
12241 messages that are injected locally by trusted callers. This is commonly used to
12242 identify messages that are being re-injected after some kind of scanning.
12243
12244 .vitem &$received_time$&
12245 .vindex "&$received_time$&"
12246 This variable contains the date and time when the current message was received,
12247 as a number of seconds since the start of the Unix epoch.
12248
12249 .vitem &$recipient_data$&
12250 .vindex "&$recipient_data$&"
12251 This variable is set after an indexing lookup success in an ACL &%recipients%&
12252 condition. It contains the data from the lookup, and the value remains set
12253 until the next &%recipients%& test. Thus, you can do things like this:
12254 .display
12255 &`require recipients  = cdb*@;/some/file`&
12256 &`deny    `&&'some further test involving'& &`$recipient_data`&
12257 .endd
12258 &*Warning*&: This variable is set only when a lookup is used as an indexing
12259 method in the address list, using the semicolon syntax as in the example above.
12260 The variable is not set for a lookup that is used as part of the string
12261 expansion that all such lists undergo before being interpreted.
12262
12263 .vitem &$recipient_verify_failure$&
12264 .vindex "&$recipient_verify_failure$&"
12265 In an ACL, when a recipient verification fails, this variable contains
12266 information about the failure. It is set to one of the following words:
12267
12268 .ilist
12269 &"qualify"&: The address was unqualified (no domain), and the message
12270 was neither local nor came from an exempted host.
12271
12272 .next
12273 &"route"&: Routing failed.
12274
12275 .next
12276 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
12277 or before the MAIL command (that is, on initial connection, HELO, or
12278 MAIL).
12279
12280 .next
12281 &"recipient"&: The RCPT command in a callout was rejected.
12282 .next
12283
12284 &"postmaster"&: The postmaster check in a callout was rejected.
12285 .endlist
12286
12287 The main use of this variable is expected to be to distinguish between
12288 rejections of MAIL and rejections of RCPT.
12289
12290 .vitem &$recipients$&
12291 .vindex "&$recipients$&"
12292 This variable contains a list of envelope recipients for a message. A comma and
12293 a space separate the addresses in the replacement text. However, the variable
12294 is not generally available, to prevent exposure of Bcc recipients in
12295 unprivileged users' filter files. You can use &$recipients$& only in these
12296 cases:
12297
12298 .olist
12299 In a system filter file.
12300 .next
12301 In the ACLs associated with the DATA command and with non-SMTP messages, that
12302 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
12303 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
12304 &%acl_not_smtp_mime%&.
12305 .next
12306 From within a &[local_scan()]& function.
12307 .endlist
12308
12309
12310 .vitem &$recipients_count$&
12311 .vindex "&$recipients_count$&"
12312 When a message is being processed, this variable contains the number of
12313 envelope recipients that came with the message. Duplicates are not excluded
12314 from the count. While a message is being received over SMTP, the number
12315 increases for each accepted recipient. It can be referenced in an ACL.
12316
12317
12318 .vitem &$regex_match_string$&
12319 .vindex "&$regex_match_string$&"
12320 This variable is set to contain the matching regular expression after a
12321 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
12322
12323 .vitem "&$regex1$&, &$regex2$&, etc"
12324 .cindex "regex submatch variables (&$1regex$& &$2regex$& etc)"
12325 When a &%regex%& or &%mime_regex%& ACL condition succeeds,
12326 these variables contain the
12327 captured substrings identified by the regular expression.
12328
12329
12330 .vitem &$reply_address$&
12331 .vindex "&$reply_address$&"
12332 When a message is being processed, this variable contains the contents of the
12333 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
12334 contents of the &'From:'& header line. Apart from the removal of leading
12335 white space, the value is not processed in any way. In particular, no RFC 2047
12336 decoding or character code translation takes place.
12337
12338 .vitem &$return_path$&
12339 .vindex "&$return_path$&"
12340 When a message is being delivered, this variable contains the return path &--
12341 the sender field that will be sent as part of the envelope. It is not enclosed
12342 in <> characters. At the start of routing an address, &$return_path$& has the
12343 same value as &$sender_address$&, but if, for example, an incoming message to a
12344 mailing list has been expanded by a router which specifies a different address
12345 for bounce messages, &$return_path$& subsequently contains the new bounce
12346 address, whereas &$sender_address$& always contains the original sender address
12347 that was received with the message. In other words, &$sender_address$& contains
12348 the incoming envelope sender, and &$return_path$& contains the outgoing
12349 envelope sender.
12350
12351 .vitem &$return_size_limit$&
12352 .vindex "&$return_size_limit$&"
12353 This is an obsolete name for &$bounce_return_size_limit$&.
12354
12355 .vitem &$router_name$&
12356 .cindex "router" "name"
12357 .cindex "name" "of router"
12358 .vindex "&$router_name$&"
12359 During the running of a router this variable contains its name.
12360
12361 .vitem &$runrc$&
12362 .cindex "return code" "from &%run%& expansion"
12363 .vindex "&$runrc$&"
12364 This variable contains the return code from a command that is run by the
12365 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
12366 assume the order in which option values are expanded, except for those
12367 preconditions whose order of testing is documented. Therefore, you cannot
12368 reliably expect to set &$runrc$& by the expansion of one option, and use it in
12369 another.
12370
12371 .vitem &$self_hostname$&
12372 .oindex "&%self%&" "value of host name"
12373 .vindex "&$self_hostname$&"
12374 When an address is routed to a supposedly remote host that turns out to be the
12375 local host, what happens is controlled by the &%self%& generic router option.
12376 One of its values causes the address to be passed to another router. When this
12377 happens, &$self_hostname$& is set to the name of the local host that the
12378 original router encountered. In other circumstances its contents are null.
12379
12380 .vitem &$sender_address$&
12381 .vindex "&$sender_address$&"
12382 When a message is being processed, this variable contains the sender's address
12383 that was received in the message's envelope. The case of letters in the address
12384 is retained, in both the local part and the domain. For bounce messages, the
12385 value of this variable is the empty string. See also &$return_path$&.
12386
12387 .vitem &$sender_address_data$&
12388 .vindex "&$address_data$&"
12389 .vindex "&$sender_address_data$&"
12390 If &$address_data$& is set when the routers are called from an ACL to verify a
12391 sender address, the final value is preserved in &$sender_address_data$&, to
12392 distinguish it from data from a recipient address. The value does not persist
12393 after the end of the current ACL statement. If you want to preserve it for
12394 longer, you can save it in an ACL variable.
12395
12396 .vitem &$sender_address_domain$&
12397 .vindex "&$sender_address_domain$&"
12398 The domain portion of &$sender_address$&.
12399
12400 .vitem &$sender_address_local_part$&
12401 .vindex "&$sender_address_local_part$&"
12402 The local part portion of &$sender_address$&.
12403
12404 .vitem &$sender_data$&
12405 .vindex "&$sender_data$&"
12406 This variable is set after a lookup success in an ACL &%senders%& condition or
12407 in a router &%senders%& option. It contains the data from the lookup, and the
12408 value remains set until the next &%senders%& test. Thus, you can do things like
12409 this:
12410 .display
12411 &`require senders      = cdb*@;/some/file`&
12412 &`deny    `&&'some further test involving'& &`$sender_data`&
12413 .endd
12414 &*Warning*&: This variable is set only when a lookup is used as an indexing
12415 method in the address list, using the semicolon syntax as in the example above.
12416 The variable is not set for a lookup that is used as part of the string
12417 expansion that all such lists undergo before being interpreted.
12418
12419 .vitem &$sender_fullhost$&
12420 .vindex "&$sender_fullhost$&"
12421 When a message is received from a remote host, this variable contains the host
12422 name and IP address in a single string. It ends with the IP address in square
12423 brackets, followed by a colon and a port number if the logging of ports is
12424 enabled. The format of the rest of the string depends on whether the host
12425 issued a HELO or EHLO SMTP command, and whether the host name was verified by
12426 looking up its IP address. (Looking up the IP address can be forced by the
12427 &%host_lookup%& option, independent of verification.) A plain host name at the
12428 start of the string is a verified host name; if this is not present,
12429 verification either failed or was not requested. A host name in parentheses is
12430 the argument of a HELO or EHLO command. This is omitted if it is identical to
12431 the verified host name or to the host's IP address in square brackets.
12432
12433 .vitem &$sender_helo_dnssec$&
12434 .vindex "&$sender_helo_dnssec$&"
12435 This boolean variable is true if a successful HELO verification was
12436 .cindex "DNS" "DNSSEC"
12437 done using DNS information the resolver library stated was authenticated data.
12438
12439 .vitem &$sender_helo_name$&
12440 .vindex "&$sender_helo_name$&"
12441 When a message is received from a remote host that has issued a HELO or EHLO
12442 command, the argument of that command is placed in this variable. It is also
12443 set if HELO or EHLO is used when a message is received using SMTP locally via
12444 the &%-bs%& or &%-bS%& options.
12445
12446 .vitem &$sender_host_address$&
12447 .vindex "&$sender_host_address$&"
12448 When a message is received from a remote host using SMTP,
12449 this variable contains that
12450 host's IP address. For locally non-SMTP submitted messages, it is empty.
12451
12452 .vitem &$sender_host_authenticated$&
12453 .vindex "&$sender_host_authenticated$&"
12454 This variable contains the name (not the public name) of the authenticator
12455 driver that successfully authenticated the client from which the message was
12456 received. It is empty if there was no successful authentication. See also
12457 &$authenticated_id$&.
12458
12459 .vitem &$sender_host_dnssec$&
12460 .vindex "&$sender_host_dnssec$&"
12461 If an attempt to populate &$sender_host_name$& has been made
12462 (by reference, &%hosts_lookup%& or
12463 otherwise) then this boolean will have been set true if, and only if, the
12464 resolver library states that both
12465 the reverse and forward DNS were authenticated data.  At all
12466 other times, this variable is false.
12467
12468 .cindex "DNS" "DNSSEC"
12469 It is likely that you will need to coerce DNSSEC support on in the resolver
12470 library, by setting:
12471 .code
12472 dns_dnssec_ok = 1
12473 .endd
12474
12475 Exim does not perform DNSSEC validation itself, instead leaving that to a
12476 validating resolver (e.g. unbound, or bind with suitable configuration).
12477
12478 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
12479 mechanism in the list, then this variable will be false.
12480
12481
12482 .vitem &$sender_host_name$&
12483 .vindex "&$sender_host_name$&"
12484 When a message is received from a remote host, this variable contains the
12485 host's name as obtained by looking up its IP address. For messages received by
12486 other means, this variable is empty.
12487
12488 .vindex "&$host_lookup_failed$&"
12489 If the host name has not previously been looked up, a reference to
12490 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
12491 A looked up name is accepted only if it leads back to the original IP address
12492 via a forward lookup. If either the reverse or the forward lookup fails to find
12493 any data, or if the forward lookup does not yield the original IP address,
12494 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
12495
12496 .vindex "&$host_lookup_deferred$&"
12497 However, if either of the lookups cannot be completed (for example, there is a
12498 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
12499 &$host_lookup_failed$& remains set to &"0"&.
12500
12501 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
12502 host name again if there is a subsequent reference to &$sender_host_name$&
12503 in the same Exim process, but it does try again if &$host_lookup_deferred$&
12504 is set to &"1"&.
12505
12506 Exim does not automatically look up every calling host's name. If you want
12507 maximum efficiency, you should arrange your configuration so that it avoids
12508 these lookups altogether. The lookup happens only if one or more of the
12509 following are true:
12510
12511 .ilist
12512 A string containing &$sender_host_name$& is expanded.
12513 .next
12514 The calling host matches the list in &%host_lookup%&. In the default
12515 configuration, this option is set to *, so it must be changed if lookups are
12516 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
12517 .next
12518 Exim needs the host name in order to test an item in a host list. The items
12519 that require this are described in sections &<<SECThoslispatnam>>& and
12520 &<<SECThoslispatnamsk>>&.
12521 .next
12522 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
12523 In this case, the host name is required to compare with the name quoted in any
12524 EHLO or HELO commands that the client issues.
12525 .next
12526 The remote host issues a EHLO or HELO command that quotes one of the
12527 domains in &%helo_lookup_domains%&. The default value of this option is
12528 . ==== As this is a nested list, any displays it contains must be indented
12529 . ==== as otherwise they are too far to the left.
12530 .code
12531   helo_lookup_domains = @ : @[]
12532 .endd
12533 which causes a lookup if a remote host (incorrectly) gives the server's name or
12534 IP address in an EHLO or HELO command.
12535 .endlist
12536
12537
12538 .vitem &$sender_host_port$&
12539 .vindex "&$sender_host_port$&"
12540 When a message is received from a remote host, this variable contains the port
12541 number that was used on the remote host.
12542
12543 .vitem &$sender_ident$&
12544 .vindex "&$sender_ident$&"
12545 When a message is received from a remote host, this variable contains the
12546 identification received in response to an RFC 1413 request. When a message has
12547 been received locally, this variable contains the login name of the user that
12548 called Exim.
12549
12550 .vitem &$sender_rate_$&&'xxx'&
12551 A number of variables whose names begin &$sender_rate_$& are set as part of the
12552 &%ratelimit%& ACL condition. Details are given in section
12553 &<<SECTratelimiting>>&.
12554
12555 .vitem &$sender_rcvhost$&
12556 .cindex "DNS" "reverse lookup"
12557 .cindex "reverse DNS lookup"
12558 .vindex "&$sender_rcvhost$&"
12559 This is provided specifically for use in &'Received:'& headers. It starts with
12560 either the verified host name (as obtained from a reverse DNS lookup) or, if
12561 there is no verified host name, the IP address in square brackets. After that
12562 there may be text in parentheses. When the first item is a verified host name,
12563 the first thing in the parentheses is the IP address in square brackets,
12564 followed by a colon and a port number if port logging is enabled. When the
12565 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
12566 the parentheses.
12567
12568 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
12569 was used and its argument was not identical to the real host name or IP
12570 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
12571 all three items are present in the parentheses, a newline and tab are inserted
12572 into the string, to improve the formatting of the &'Received:'& header.
12573
12574 .vitem &$sender_verify_failure$&
12575 .vindex "&$sender_verify_failure$&"
12576 In an ACL, when a sender verification fails, this variable contains information
12577 about the failure. The details are the same as for
12578 &$recipient_verify_failure$&.
12579
12580 .vitem &$sending_ip_address$&
12581 .vindex "&$sending_ip_address$&"
12582 This variable is set whenever an outgoing SMTP connection to another host has
12583 been set up. It contains the IP address of the local interface that is being
12584 used. This is useful if a host that has more than one IP address wants to take
12585 on different personalities depending on which one is being used. For incoming
12586 connections, see &$received_ip_address$&.
12587
12588 .vitem &$sending_port$&
12589 .vindex "&$sending_port$&"
12590 This variable is set whenever an outgoing SMTP connection to another host has
12591 been set up. It contains the local port that is being used. For incoming
12592 connections, see &$received_port$&.
12593
12594 .vitem &$smtp_active_hostname$&
12595 .vindex "&$smtp_active_hostname$&"
12596 During an incoming SMTP session, this variable contains the value of the active
12597 host name, as specified by the &%smtp_active_hostname%& option. The value of
12598 &$smtp_active_hostname$& is saved with any message that is received, so its
12599 value can be consulted during routing and delivery.
12600
12601 .vitem &$smtp_command$&
12602 .vindex "&$smtp_command$&"
12603 During the processing of an incoming SMTP command, this variable contains the
12604 entire command. This makes it possible to distinguish between HELO and EHLO in
12605 the HELO ACL, and also to distinguish between commands such as these:
12606 .code
12607 MAIL FROM:<>
12608 MAIL FROM: <>
12609 .endd
12610 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
12611 command, the address in &$smtp_command$& is the original address before any
12612 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
12613 the address after SMTP-time rewriting.
12614
12615 .vitem &$smtp_command_argument$&
12616 .cindex "SMTP" "command, argument for"
12617 .vindex "&$smtp_command_argument$&"
12618 While an ACL is running to check an SMTP command, this variable contains the
12619 argument, that is, the text that follows the command name, with leading white
12620 space removed. Following the introduction of &$smtp_command$&, this variable is
12621 somewhat redundant, but is retained for backwards compatibility.
12622
12623 .vitem &$smtp_count_at_connection_start$&
12624 .vindex "&$smtp_count_at_connection_start$&"
12625 This variable is set greater than zero only in processes spawned by the Exim
12626 daemon for handling incoming SMTP connections. The name is deliberately long,
12627 in order to emphasize what the contents are. When the daemon accepts a new
12628 connection, it increments this variable. A copy of the variable is passed to
12629 the child process that handles the connection, but its value is fixed, and
12630 never changes. It is only an approximation of how many incoming connections
12631 there actually are, because many other connections may come and go while a
12632 single connection is being processed. When a child process terminates, the
12633 daemon decrements its copy of the variable.
12634
12635 .vitem "&$sn0$& &-- &$sn9$&"
12636 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
12637 that were current at the end of the system filter file. This allows a system
12638 filter file to set values that can be tested in users' filter files. For
12639 example, a system filter could set a value indicating how likely it is that a
12640 message is junk mail.
12641
12642 .vitem &$spam_$&&'xxx'&
12643 A number of variables whose names start with &$spam$& are available when Exim
12644 is compiled with the content-scanning extension. For details, see section
12645 &<<SECTscanspamass>>&.
12646
12647
12648 .vitem &$spool_directory$&
12649 .vindex "&$spool_directory$&"
12650 The name of Exim's spool directory.
12651
12652 .vitem &$spool_inodes$&
12653 .vindex "&$spool_inodes$&"
12654 The number of free inodes in the disk partition where Exim's spool files are
12655 being written. The value is recalculated whenever the variable is referenced.
12656 If the relevant file system does not have the concept of inodes, the value of
12657 is -1. See also the &%check_spool_inodes%& option.
12658
12659 .vitem &$spool_space$&
12660 .vindex "&$spool_space$&"
12661 The amount of free space (as a number of kilobytes) in the disk partition where
12662 Exim's spool files are being written. The value is recalculated whenever the
12663 variable is referenced. If the operating system does not have the ability to
12664 find the amount of free space (only true for experimental systems), the space
12665 value is -1. For example, to check in an ACL that there is at least 50
12666 megabytes free on the spool, you could write:
12667 .code
12668 condition = ${if > {$spool_space}{50000}}
12669 .endd
12670 See also the &%check_spool_space%& option.
12671
12672
12673 .vitem &$thisaddress$&
12674 .vindex "&$thisaddress$&"
12675 This variable is set only during the processing of the &%foranyaddress%&
12676 command in a filter file. Its use is explained in the description of that
12677 command, which can be found in the separate document entitled &'Exim's
12678 interfaces to mail filtering'&.
12679
12680 .vitem &$tls_in_bits$&
12681 .vindex "&$tls_in_bits$&"
12682 Contains an approximation of the TLS cipher's bit-strength
12683 on the inbound connection; the meaning of
12684 this depends upon the TLS implementation used.
12685 If TLS has not been negotiated, the value will be 0.
12686 The value of this is automatically fed into the Cyrus SASL authenticator
12687 when acting as a server, to specify the "external SSF" (a SASL term).
12688
12689 The deprecated &$tls_bits$& variable refers to the inbound side
12690 except when used in the context of an outbound SMTP delivery, when it refers to
12691 the outbound.
12692
12693 .vitem &$tls_out_bits$&
12694 .vindex "&$tls_out_bits$&"
12695 Contains an approximation of the TLS cipher's bit-strength
12696 on an outbound SMTP connection; the meaning of
12697 this depends upon the TLS implementation used.
12698 If TLS has not been negotiated, the value will be 0.
12699
12700 .vitem &$tls_in_ourcert$&
12701 .vindex "&$tls_in_ourcert$&"
12702 .cindex certificate veriables
12703 This variable refers to the certificate presented to the peer of an
12704 inbound connection when the message was received.
12705 It is only useful as the argument of a
12706 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12707 or a &%def%& condition.
12708
12709 .vitem &$tls_in_peercert$&
12710 .vindex "&$tls_in_peercert$&"
12711 This variable refers to the certificate presented by the peer of an
12712 inbound connection when the message was received.
12713 It is only useful as the argument of a
12714 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12715 or a &%def%& condition.
12716 If certificate verification fails it may refer to a failing chain element
12717 which is not the leaf.
12718
12719 .vitem &$tls_out_ourcert$&
12720 .vindex "&$tls_out_ourcert$&"
12721 This variable refers to the certificate presented to the peer of an
12722 outbound connection.  It is only useful as the argument of a
12723 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12724 or a &%def%& condition.
12725
12726 .vitem &$tls_out_peercert$&
12727 .vindex "&$tls_out_peercert$&"
12728 This variable refers to the certificate presented by the peer of an
12729 outbound connection.  It is only useful as the argument of a
12730 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12731 or a &%def%& condition.
12732 If certificate verification fails it may refer to a failing chain element
12733 which is not the leaf.
12734
12735 .vitem &$tls_in_certificate_verified$&
12736 .vindex "&$tls_in_certificate_verified$&"
12737 This variable is set to &"1"& if a TLS certificate was verified when the
12738 message was received, and &"0"& otherwise.
12739
12740 The deprecated &$tls_certificate_verified$& variable refers to the inbound side
12741 except when used in the context of an outbound SMTP delivery, when it refers to
12742 the outbound.
12743
12744 .vitem &$tls_out_certificate_verified$&
12745 .vindex "&$tls_out_certificate_verified$&"
12746 This variable is set to &"1"& if a TLS certificate was verified when an
12747 outbound SMTP connection was made,
12748 and &"0"& otherwise.
12749
12750 .vitem &$tls_in_cipher$&
12751 .vindex "&$tls_in_cipher$&"
12752 .vindex "&$tls_cipher$&"
12753 When a message is received from a remote host over an encrypted SMTP
12754 connection, this variable is set to the cipher suite that was negotiated, for
12755 example DES-CBC3-SHA. In other circumstances, in particular, for message
12756 received over unencrypted connections, the variable is empty. Testing
12757 &$tls_cipher$& for emptiness is one way of distinguishing between encrypted and
12758 non-encrypted connections during ACL processing.
12759
12760 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
12761 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
12762 becomes the same as &$tls_out_cipher$&.
12763
12764 .vitem &$tls_out_cipher$&
12765 .vindex "&$tls_out_cipher$&"
12766 This variable is
12767 cleared before any outgoing SMTP connection is made,
12768 and then set to the outgoing cipher suite if one is negotiated. See chapter
12769 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
12770 details of the &(smtp)& transport.
12771
12772 .vitem &$tls_in_ocsp$&
12773 .vindex "&$tls_in_ocsp$&"
12774 When a message is received from a remote client connection
12775 the result of any OCSP request from the client is encoded in this variable:
12776 .code
12777 0 OCSP proof was not requested (default value)
12778 1 No response to request
12779 2 Response not verified
12780 3 Verification failed
12781 4 Verification succeeded
12782 .endd
12783
12784 .vitem &$tls_out_ocsp$&
12785 .vindex "&$tls_out_ocsp$&"
12786 When a message is sent to a remote host connection
12787 the result of any OCSP request made is encoded in this variable.
12788 See &$tls_in_ocsp$& for values.
12789
12790 .vitem &$tls_in_peerdn$&
12791 .vindex "&$tls_in_peerdn$&"
12792 .vindex "&$tls_peerdn$&"
12793 .cindex certificate "extracting fields"
12794 When a message is received from a remote host over an encrypted SMTP
12795 connection, and Exim is configured to request a certificate from the client,
12796 the value of the Distinguished Name of the certificate is made available in the
12797 &$tls_in_peerdn$& during subsequent processing.
12798 If certificate verification fails it may refer to a failing chain element
12799 which is not the leaf.
12800
12801 The deprecated &$tls_peerdn$& variable refers to the inbound side
12802 except when used in the context of an outbound SMTP delivery, when it refers to
12803 the outbound.
12804
12805 .vitem &$tls_out_peerdn$&
12806 .vindex "&$tls_out_peerdn$&"
12807 When a message is being delivered to a remote host over an encrypted SMTP
12808 connection, and Exim is configured to request a certificate from the server,
12809 the value of the Distinguished Name of the certificate is made available in the
12810 &$tls_out_peerdn$& during subsequent processing.
12811 If certificate verification fails it may refer to a failing chain element
12812 which is not the leaf.
12813
12814 .vitem &$tls_in_sni$&
12815 .vindex "&$tls_in_sni$&"
12816 .vindex "&$tls_sni$&"
12817 .cindex "TLS" "Server Name Indication"
12818 When a TLS session is being established, if the client sends the Server
12819 Name Indication extension, the value will be placed in this variable.
12820 If the variable appears in &%tls_certificate%& then this option and
12821 some others, described in &<<SECTtlssni>>&,
12822 will be re-expanded early in the TLS session, to permit
12823 a different certificate to be presented (and optionally a different key to be
12824 used) to the client, based upon the value of the SNI extension.
12825
12826 The deprecated &$tls_sni$& variable refers to the inbound side
12827 except when used in the context of an outbound SMTP delivery, when it refers to
12828 the outbound.
12829
12830 .vitem &$tls_out_sni$&
12831 .vindex "&$tls_out_sni$&"
12832 .cindex "TLS" "Server Name Indication"
12833 During outbound
12834 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
12835 the transport.
12836
12837 .vitem &$tod_bsdinbox$&
12838 .vindex "&$tod_bsdinbox$&"
12839 The time of day and the date, in the format required for BSD-style mailbox
12840 files, for example: Thu Oct 17 17:14:09 1995.
12841
12842 .vitem &$tod_epoch$&
12843 .vindex "&$tod_epoch$&"
12844 The time and date as a number of seconds since the start of the Unix epoch.
12845
12846 .vitem &$tod_epoch_l$&
12847 .vindex "&$tod_epoch_l$&"
12848 The time and date as a number of microseconds since the start of the Unix epoch.
12849
12850 .vitem &$tod_full$&
12851 .vindex "&$tod_full$&"
12852 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
12853 +0100. The timezone is always given as a numerical offset from UTC, with
12854 positive values used for timezones that are ahead (east) of UTC, and negative
12855 values for those that are behind (west).
12856
12857 .vitem &$tod_log$&
12858 .vindex "&$tod_log$&"
12859 The time and date in the format used for writing Exim's log files, for example:
12860 1995-10-12 15:32:29, but without a timezone.
12861
12862 .vitem &$tod_logfile$&
12863 .vindex "&$tod_logfile$&"
12864 This variable contains the date in the format yyyymmdd. This is the format that
12865 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
12866 flag.
12867
12868 .vitem &$tod_zone$&
12869 .vindex "&$tod_zone$&"
12870 This variable contains the numerical value of the local timezone, for example:
12871 -0500.
12872
12873 .vitem &$tod_zulu$&
12874 .vindex "&$tod_zulu$&"
12875 This variable contains the UTC date and time in &"Zulu"& format, as specified
12876 by ISO 8601, for example: 20030221154023Z.
12877
12878 .vitem &$transport_name$&
12879 .cindex "transport" "name"
12880 .cindex "name" "of transport"
12881 .vindex "&$transport_name$&"
12882 During the running of a transport, this variable contains its name.
12883
12884 .vitem &$value$&
12885 .vindex "&$value$&"
12886 This variable contains the result of an expansion lookup, extraction operation,
12887 or external command, as described above. It is also used during a
12888 &*reduce*& expansion.
12889
12890 .vitem &$verify_mode$&
12891 .vindex "&$verify_mode$&"
12892 While a router or transport is being run in verify mode
12893 or for cutthrough delivery,
12894 contains "S" for sender-verification or "R" for recipient-verification.
12895 Otherwise, empty.
12896
12897 .vitem &$version_number$&
12898 .vindex "&$version_number$&"
12899 The version number of Exim.
12900
12901 .vitem &$warn_message_delay$&
12902 .vindex "&$warn_message_delay$&"
12903 This variable is set only during the creation of a message warning about a
12904 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
12905
12906 .vitem &$warn_message_recipients$&
12907 .vindex "&$warn_message_recipients$&"
12908 This variable is set only during the creation of a message warning about a
12909 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
12910 .endlist
12911 .ecindex IIDstrexp
12912
12913
12914
12915 . ////////////////////////////////////////////////////////////////////////////
12916 . ////////////////////////////////////////////////////////////////////////////
12917
12918 .chapter "Embedded Perl" "CHAPperl"
12919 .scindex IIDperl "Perl" "calling from Exim"
12920 Exim can be built to include an embedded Perl interpreter. When this is done,
12921 Perl subroutines can be called as part of the string expansion process. To make
12922 use of the Perl support, you need version 5.004 or later of Perl installed on
12923 your system. To include the embedded interpreter in the Exim binary, include
12924 the line
12925 .code
12926 EXIM_PERL = perl.o
12927 .endd
12928 in your &_Local/Makefile_& and then build Exim in the normal way.
12929
12930
12931 .section "Setting up so Perl can be used" "SECID85"
12932 .oindex "&%perl_startup%&"
12933 Access to Perl subroutines is via a global configuration option called
12934 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
12935 no &%perl_startup%& option in the Exim configuration file then no Perl
12936 interpreter is started and there is almost no overhead for Exim (since none of
12937 the Perl library will be paged in unless used). If there is a &%perl_startup%&
12938 option then the associated value is taken to be Perl code which is executed in
12939 a newly created Perl interpreter.
12940
12941 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
12942 need backslashes before any characters to escape special meanings. The option
12943 should usually be something like
12944 .code
12945 perl_startup = do '/etc/exim.pl'
12946 .endd
12947 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
12948 use from Exim. Exim can be configured either to start up a Perl interpreter as
12949 soon as it is entered, or to wait until the first time it is needed. Starting
12950 the interpreter at the beginning ensures that it is done while Exim still has
12951 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
12952 fact used in a particular run. Also, note that this does not mean that Exim is
12953 necessarily running as root when Perl is called at a later time. By default,
12954 the interpreter is started only when it is needed, but this can be changed in
12955 two ways:
12956
12957 .ilist
12958 .oindex "&%perl_at_start%&"
12959 Setting &%perl_at_start%& (a boolean option) in the configuration requests
12960 a startup when Exim is entered.
12961 .next
12962 The command line option &%-ps%& also requests a startup when Exim is entered,
12963 overriding the setting of &%perl_at_start%&.
12964 .endlist
12965
12966 There is also a command line option &%-pd%& (for delay) which suppresses the
12967 initial startup, even if &%perl_at_start%& is set.
12968
12969
12970 .section "Calling Perl subroutines" "SECID86"
12971 When the configuration file includes a &%perl_startup%& option you can make use
12972 of the string expansion item to call the Perl subroutines that are defined
12973 by the &%perl_startup%& code. The operator is used in any of the following
12974 forms:
12975 .code
12976 ${perl{foo}}
12977 ${perl{foo}{argument}}
12978 ${perl{foo}{argument1}{argument2} ... }
12979 .endd
12980 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
12981 arguments may be passed. Passing more than this results in an expansion failure
12982 with an error message of the form
12983 .code
12984 Too many arguments passed to Perl subroutine "foo" (max is 8)
12985 .endd
12986 The return value of the Perl subroutine is evaluated in a scalar context before
12987 it is passed back to Exim to be inserted into the expanded string. If the
12988 return value is &'undef'&, the expansion is forced to fail in the same way as
12989 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
12990 by obeying Perl's &%die%& function, the expansion fails with the error message
12991 that was passed to &%die%&.
12992
12993
12994 .section "Calling Exim functions from Perl" "SECID87"
12995 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
12996 is available to call back into Exim's string expansion function. For example,
12997 the Perl code
12998 .code
12999 my $lp = Exim::expand_string('$local_part');
13000 .endd
13001 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
13002 Note those are single quotes and not double quotes to protect against
13003 &$local_part$& being interpolated as a Perl variable.
13004
13005 If the string expansion is forced to fail by a &"fail"& item, the result of
13006 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
13007 expansion string, the Perl call from the original expansion string fails with
13008 an appropriate error message, in the same way as if &%die%& were used.
13009
13010 .cindex "debugging" "from embedded Perl"
13011 .cindex "log" "writing from embedded Perl"
13012 Two other Exim functions are available for use from within Perl code.
13013 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
13014 debugging is enabled. If you want a newline at the end, you must supply it.
13015 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
13016 timestamp. In this case, you should not supply a terminating newline.
13017
13018
13019 .section "Use of standard output and error by Perl" "SECID88"
13020 .cindex "Perl" "standard output and error"
13021 You should not write to the standard error or output streams from within your
13022 Perl code, as it is not defined how these are set up. In versions of Exim
13023 before 4.50, it is possible for the standard output or error to refer to the
13024 SMTP connection during message reception via the daemon. Writing to this stream
13025 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
13026 error streams are connected to &_/dev/null_& in the daemon. The chaos is
13027 avoided, but the output is lost.
13028
13029 .cindex "Perl" "use of &%warn%&"
13030 The Perl &%warn%& statement writes to the standard error stream by default.
13031 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
13032 you have no control. When Exim starts up the Perl interpreter, it arranges for
13033 output from the &%warn%& statement to be written to the Exim main log. You can
13034 change this by including appropriate Perl magic somewhere in your Perl code.
13035 For example, to discard &%warn%& output completely, you need this:
13036 .code
13037 $SIG{__WARN__} = sub { };
13038 .endd
13039 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
13040 example, the code for the subroutine is empty, so it does nothing, but you can
13041 include any Perl code that you like. The text of the &%warn%& message is passed
13042 as the first subroutine argument.
13043 .ecindex IIDperl
13044
13045
13046 . ////////////////////////////////////////////////////////////////////////////
13047 . ////////////////////////////////////////////////////////////////////////////
13048
13049 .chapter "Starting the daemon and the use of network interfaces" &&&
13050          "CHAPinterfaces" &&&
13051          "Starting the daemon"
13052 .cindex "daemon" "starting"
13053 .cindex "interface" "listening"
13054 .cindex "network interface"
13055 .cindex "interface" "network"
13056 .cindex "IP address" "for listening"
13057 .cindex "daemon" "listening IP addresses"
13058 .cindex "TCP/IP" "setting listening interfaces"
13059 .cindex "TCP/IP" "setting listening ports"
13060 A host that is connected to a TCP/IP network may have one or more physical
13061 hardware network interfaces. Each of these interfaces may be configured as one
13062 or more &"logical"& interfaces, which are the entities that a program actually
13063 works with. Each of these logical interfaces is associated with an IP address.
13064 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
13065 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
13066 knowledge about the host's interfaces for use in three different circumstances:
13067
13068 .olist
13069 When a listening daemon is started, Exim needs to know which interfaces
13070 and ports to listen on.
13071 .next
13072 When Exim is routing an address, it needs to know which IP addresses
13073 are associated with local interfaces. This is required for the correct
13074 processing of MX lists by removing the local host and others with the
13075 same or higher priority values. Also, Exim needs to detect cases
13076 when an address is routed to an IP address that in fact belongs to the
13077 local host. Unless the &%self%& router option or the &%allow_localhost%&
13078 option of the smtp transport is set (as appropriate), this is treated
13079 as an error situation.
13080 .next
13081 When Exim connects to a remote host, it may need to know which interface to use
13082 for the outgoing connection.
13083 .endlist
13084
13085
13086 Exim's default behaviour is likely to be appropriate in the vast majority
13087 of cases. If your host has only one interface, and you want all its IP
13088 addresses to be treated in the same way, and you are using only the
13089 standard SMTP port, you should not need to take any special action. The
13090 rest of this chapter does not apply to you.
13091
13092 In a more complicated situation you may want to listen only on certain
13093 interfaces, or on different ports, and for this reason there are a number of
13094 options that can be used to influence Exim's behaviour. The rest of this
13095 chapter describes how they operate.
13096
13097 When a message is received over TCP/IP, the interface and port that were
13098 actually used are set in &$received_ip_address$& and &$received_port$&.
13099
13100
13101
13102 .section "Starting a listening daemon" "SECID89"
13103 When a listening daemon is started (by means of the &%-bd%& command line
13104 option), the interfaces and ports on which it listens are controlled by the
13105 following options:
13106
13107 .ilist
13108 &%daemon_smtp_ports%& contains a list of default ports
13109 or service names.
13110 (For backward compatibility, this option can also be specified in the singular.)
13111 .next
13112 &%local_interfaces%& contains list of interface IP addresses on which to
13113 listen. Each item may optionally also specify a port.
13114 .endlist
13115
13116 The default list separator in both cases is a colon, but this can be changed as
13117 described in section &<<SECTlistconstruct>>&. When IPv6 addresses are involved,
13118 it is usually best to change the separator to avoid having to double all the
13119 colons. For example:
13120 .code
13121 local_interfaces = <; 127.0.0.1 ; \
13122                       192.168.23.65 ; \
13123                       ::1 ; \
13124                       3ffe:ffff:836f::fe86:a061
13125 .endd
13126 There are two different formats for specifying a port along with an IP address
13127 in &%local_interfaces%&:
13128
13129 .olist
13130 The port is added onto the address with a dot separator. For example, to listen
13131 on port 1234 on two different IP addresses:
13132 .code
13133 local_interfaces = <; 192.168.23.65.1234 ; \
13134                       3ffe:ffff:836f::fe86:a061.1234
13135 .endd
13136 .next
13137 The IP address is enclosed in square brackets, and the port is added
13138 with a colon separator, for example:
13139 .code
13140 local_interfaces = <; [192.168.23.65]:1234 ; \
13141                       [3ffe:ffff:836f::fe86:a061]:1234
13142 .endd
13143 .endlist
13144
13145 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
13146 default setting contains just one port:
13147 .code
13148 daemon_smtp_ports = smtp
13149 .endd
13150 If more than one port is listed, each interface that does not have its own port
13151 specified listens on all of them. Ports that are listed in
13152 &%daemon_smtp_ports%& can be identified either by name (defined in
13153 &_/etc/services_&) or by number. However, when ports are given with individual
13154 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
13155
13156
13157
13158 .section "Special IP listening addresses" "SECID90"
13159 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
13160 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
13161 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
13162 instead of setting up separate listening sockets for each interface. The
13163 default value of &%local_interfaces%& is
13164 .code
13165 local_interfaces = 0.0.0.0
13166 .endd
13167 when Exim is built without IPv6 support; otherwise it is:
13168 .code
13169 local_interfaces = <; ::0 ; 0.0.0.0
13170 .endd
13171 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
13172
13173
13174
13175 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
13176 The &%-oX%& command line option can be used to override the values of
13177 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
13178 instance. Another way of doing this would be to use macros and the &%-D%&
13179 option. However, &%-oX%& can be used by any admin user, whereas modification of
13180 the runtime configuration by &%-D%& is allowed only when the caller is root or
13181 exim.
13182
13183 The value of &%-oX%& is a list of items. The default colon separator can be
13184 changed in the usual way if required. If there are any items that do not
13185 contain dots or colons (that is, are not IP addresses), the value of
13186 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
13187 items that do contain dots or colons, the value of &%local_interfaces%& is
13188 replaced by those items. Thus, for example,
13189 .code
13190 -oX 1225
13191 .endd
13192 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
13193 whereas
13194 .code
13195 -oX 192.168.34.5.1125
13196 .endd
13197 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
13198 (However, since &%local_interfaces%& now contains no items without ports, the
13199 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
13200
13201
13202
13203 .section "Support for the obsolete SSMTP (or SMTPS) protocol" "SECTsupobssmt"
13204 .cindex "ssmtp protocol"
13205 .cindex "smtps protocol"
13206 .cindex "SMTP" "ssmtp protocol"
13207 .cindex "SMTP" "smtps protocol"
13208 Exim supports the obsolete SSMTP protocol (also known as SMTPS) that was used
13209 before the STARTTLS command was standardized for SMTP. Some legacy clients
13210 still use this protocol. If the &%tls_on_connect_ports%& option is set to a
13211 list of port numbers or service names,
13212 connections to those ports must use SSMTP. The most
13213 common use of this option is expected to be
13214 .code
13215 tls_on_connect_ports = 465
13216 .endd
13217 because 465 is the usual port number used by the legacy clients. There is also
13218 a command line option &%-tls-on-connect%&, which forces all ports to behave in
13219 this way when a daemon is started.
13220
13221 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
13222 daemon to listen on those ports. You must still specify them in
13223 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
13224 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
13225 connections via the daemon.)
13226
13227
13228
13229
13230 .section "IPv6 address scopes" "SECID92"
13231 .cindex "IPv6" "address scopes"
13232 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
13233 can, in principle, have the same link-local IPv6 address on different
13234 interfaces. Thus, additional information is needed, over and above the IP
13235 address, to distinguish individual interfaces. A convention of using a
13236 percent sign followed by something (often the interface name) has been
13237 adopted in some cases, leading to addresses like this:
13238 .code
13239 fe80::202:b3ff:fe03:45c1%eth0
13240 .endd
13241 To accommodate this usage, a percent sign followed by an arbitrary string is
13242 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
13243 to convert a textual IPv6 address for actual use. This function recognizes the
13244 percent convention in operating systems that support it, and it processes the
13245 address appropriately. Unfortunately, some older libraries have problems with
13246 &[getaddrinfo()]&. If
13247 .code
13248 IPV6_USE_INET_PTON=yes
13249 .endd
13250 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
13251 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
13252 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
13253 function.) Of course, this means that the additional functionality of
13254 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
13255
13256 .section "Disabling IPv6" "SECID93"
13257 .cindex "IPv6" "disabling"
13258 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
13259 run on a host whose kernel does not support IPv6. The binary will fall back to
13260 using IPv4, but it may waste resources looking up AAAA records, and trying to
13261 connect to IPv6 addresses, causing delays to mail delivery. If you set the
13262 .oindex "&%disable_ipv6%&"
13263 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
13264 activities take place. AAAA records are never looked up, and any IPv6 addresses
13265 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
13266 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
13267 to handle IPv6 literal addresses.
13268
13269 On the other hand, when IPv6 is in use, there may be times when you want to
13270 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
13271 option to globally suppress the lookup of AAAA records for specified domains,
13272 and you can use the &%ignore_target_hosts%& generic router option to ignore
13273 IPv6 addresses in an individual router.
13274
13275
13276
13277 .section "Examples of starting a listening daemon" "SECID94"
13278 The default case in an IPv6 environment is
13279 .code
13280 daemon_smtp_ports = smtp
13281 local_interfaces = <; ::0 ; 0.0.0.0
13282 .endd
13283 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
13284 Either one or two sockets may be used, depending on the characteristics of
13285 the TCP/IP stack. (This is complicated and messy; for more information,
13286 read the comments in the &_daemon.c_& source file.)
13287
13288 To specify listening on ports 25 and 26 on all interfaces:
13289 .code
13290 daemon_smtp_ports = 25 : 26
13291 .endd
13292 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
13293 .code
13294 local_interfaces = <; ::0.25     ; ::0.26 \
13295                       0.0.0.0.25 ; 0.0.0.0.26
13296 .endd
13297 To listen on the default port on all IPv4 interfaces, and on port 26 on the
13298 IPv4 loopback address only:
13299 .code
13300 local_interfaces = 0.0.0.0 : 127.0.0.1.26
13301 .endd
13302 To specify listening on the default port on specific interfaces only:
13303 .code
13304 local_interfaces = 10.0.0.67 : 192.168.34.67
13305 .endd
13306 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
13307
13308
13309
13310 .section "Recognizing the local host" "SECTreclocipadd"
13311 The &%local_interfaces%& option is also used when Exim needs to determine
13312 whether or not an IP address refers to the local host. That is, the IP
13313 addresses of all the interfaces on which a daemon is listening are always
13314 treated as local.
13315
13316 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
13317 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
13318 available interfaces from the operating system, and extracts the relevant
13319 (that is, IPv4 or IPv6) addresses to use for checking.
13320
13321 Some systems set up large numbers of virtual interfaces in order to provide
13322 many virtual web servers. In this situation, you may want to listen for
13323 email on only a few of the available interfaces, but nevertheless treat all
13324 interfaces as local when routing. You can do this by setting
13325 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
13326 &"all"& wildcard values. These addresses are recognized as local, but are not
13327 used for listening. Consider this example:
13328 .code
13329 local_interfaces = <; 127.0.0.1 ; ::1 ; \
13330                       192.168.53.235 ; \
13331                       3ffe:2101:12:1:a00:20ff:fe86:a061
13332
13333 extra_local_interfaces = <; ::0 ; 0.0.0.0
13334 .endd
13335 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
13336 address, but all available interface addresses are treated as local when
13337 Exim is routing.
13338
13339 In some environments the local host name may be in an MX list, but with an IP
13340 address that is not assigned to any local interface. In other cases it may be
13341 desirable to treat other host names as if they referred to the local host. Both
13342 these cases can be handled by setting the &%hosts_treat_as_local%& option.
13343 This contains host names rather than IP addresses. When a host is referenced
13344 during routing, either via an MX record or directly, it is treated as the local
13345 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
13346 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
13347
13348
13349
13350 .section "Delivering to a remote host" "SECID95"
13351 Delivery to a remote host is handled by the smtp transport. By default, it
13352 allows the system's TCP/IP functions to choose which interface to use (if
13353 there is more than one) when connecting to a remote host. However, the
13354 &%interface%& option can be set to specify which interface is used. See the
13355 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
13356 details.
13357
13358
13359
13360
13361 . ////////////////////////////////////////////////////////////////////////////
13362 . ////////////////////////////////////////////////////////////////////////////
13363
13364 .chapter "Main configuration" "CHAPmainconfig"
13365 .scindex IIDconfima "configuration file" "main section"
13366 .scindex IIDmaiconf "main configuration"
13367 The first part of the run time configuration file contains three types of item:
13368
13369 .ilist
13370 Macro definitions: These lines start with an upper case letter. See section
13371 &<<SECTmacrodefs>>& for details of macro processing.
13372 .next
13373 Named list definitions: These lines start with one of the words &"domainlist"&,
13374 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
13375 section &<<SECTnamedlists>>&.
13376 .next
13377 Main configuration settings: Each setting occupies one line of the file
13378 (with possible continuations). If any setting is preceded by the word
13379 &"hide"&, the &%-bP%& command line option displays its value to admin users
13380 only. See section &<<SECTcos>>& for a description of the syntax of these option
13381 settings.
13382 .endlist
13383
13384 This chapter specifies all the main configuration options, along with their
13385 types and default values. For ease of finding a particular option, they appear
13386 in alphabetical order in section &<<SECTalomo>>& below. However, because there
13387 are now so many options, they are first listed briefly in functional groups, as
13388 an aid to finding the name of the option you are looking for. Some options are
13389 listed in more than one group.
13390
13391 .section "Miscellaneous" "SECID96"
13392 .table2
13393 .row &%bi_command%&                  "to run for &%-bi%& command line option"
13394 .row &%disable_ipv6%&                "do no IPv6 processing"
13395 .row &%keep_malformed%&              "for broken files &-- should not happen"
13396 .row &%localhost_number%&            "for unique message ids in clusters"
13397 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
13398 .row &%message_body_visible%&        "how much to show in &$message_body$&"
13399 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
13400 .row &%print_topbitchars%&           "top-bit characters are printing"
13401 .row &%timezone%&                    "force time zone"
13402 .endtable
13403
13404
13405 .section "Exim parameters" "SECID97"
13406 .table2
13407 .row &%exim_group%&                  "override compiled-in value"
13408 .row &%exim_path%&                   "override compiled-in value"
13409 .row &%exim_user%&                   "override compiled-in value"
13410 .row &%primary_hostname%&            "default from &[uname()]&"
13411 .row &%split_spool_directory%&       "use multiple directories"
13412 .row &%spool_directory%&             "override compiled-in value"
13413 .endtable
13414
13415
13416
13417 .section "Privilege controls" "SECID98"
13418 .table2
13419 .row &%admin_groups%&                "groups that are Exim admin users"
13420 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
13421 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
13422 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
13423 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
13424 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
13425 .row &%never_users%&                 "do not run deliveries as these"
13426 .row &%prod_requires_admin%&         "forced delivery requires admin user"
13427 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
13428 .row &%trusted_groups%&              "groups that are trusted"
13429 .row &%trusted_users%&               "users that are trusted"
13430 .endtable
13431
13432
13433
13434 .section "Logging" "SECID99"
13435 .table2
13436 .row &%event_action%&                "custom logging"
13437 .row &%hosts_connection_nolog%&      "exemption from connect logging"
13438 .row &%log_file_path%&               "override compiled-in value"
13439 .row &%log_selector%&                "set/unset optional logging"
13440 .row &%log_timezone%&                "add timezone to log lines"
13441 .row &%message_logs%&                "create per-message logs"
13442 .row &%preserve_message_logs%&       "after message completion"
13443 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
13444 .row &%slow_lookup_log%&             "control logging of slow DNS lookups"
13445 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
13446 .row &%syslog_facility%&             "set syslog &""facility""& field"
13447 .row &%syslog_processname%&          "set syslog &""ident""& field"
13448 .row &%syslog_timestamp%&            "timestamp syslog lines"
13449 .row &%write_rejectlog%&             "control use of message log"
13450 .endtable
13451
13452
13453
13454 .section "Frozen messages" "SECID100"
13455 .table2
13456 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
13457 .row &%freeze_tell%&                 "send message when freezing"
13458 .row &%move_frozen_messages%&        "to another directory"
13459 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
13460 .endtable
13461
13462
13463
13464 .section "Data lookups" "SECID101"
13465 .table2
13466 .row &%ibase_servers%&               "InterBase servers"
13467 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
13468 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
13469 .row &%ldap_cert_file%&              "client cert file for LDAP"
13470 .row &%ldap_cert_key%&               "client key file for LDAP"
13471 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
13472 .row &%ldap_default_servers%&        "used if no server in query"
13473 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
13474 .row &%ldap_start_tls%&              "require TLS within LDAP"
13475 .row &%ldap_version%&                "set protocol version"
13476 .row &%lookup_open_max%&             "lookup files held open"
13477 .row &%mysql_servers%&               "default MySQL servers"
13478 .row &%oracle_servers%&              "Oracle servers"
13479 .row &%pgsql_servers%&               "default PostgreSQL servers"
13480 .row &%sqlite_lock_timeout%&         "as it says"
13481 .endtable
13482
13483
13484
13485 .section "Message ids" "SECID102"
13486 .table2
13487 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
13488 .row &%message_id_header_text%&      "ditto"
13489 .endtable
13490
13491
13492
13493 .section "Embedded Perl Startup" "SECID103"
13494 .table2
13495 .row &%perl_at_start%&               "always start the interpreter"
13496 .row &%perl_startup%&                "code to obey when starting Perl"
13497 .endtable
13498
13499
13500
13501 .section "Daemon" "SECID104"
13502 .table2
13503 .row &%daemon_smtp_ports%&           "default ports"
13504 .row &%daemon_startup_retries%&      "number of times to retry"
13505 .row &%daemon_startup_sleep%&        "time to sleep between tries"
13506 .row &%extra_local_interfaces%&      "not necessarily listened on"
13507 .row &%local_interfaces%&            "on which to listen, with optional ports"
13508 .row &%pid_file_path%&               "override compiled-in value"
13509 .row &%queue_run_max%&               "maximum simultaneous queue runners"
13510 .endtable
13511
13512
13513
13514 .section "Resource control" "SECID105"
13515 .table2
13516 .row &%check_log_inodes%&            "before accepting a message"
13517 .row &%check_log_space%&             "before accepting a message"
13518 .row &%check_spool_inodes%&          "before accepting a message"
13519 .row &%check_spool_space%&           "before accepting a message"
13520 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
13521 .row &%queue_only_load%&             "queue incoming if load high"
13522 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13523 .row &%queue_run_max%&               "maximum simultaneous queue runners"
13524 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13525 .row &%smtp_accept_max%&             "simultaneous incoming connections"
13526 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
13527 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
13528 .row &%smtp_accept_max_per_connection%& "messages per connection"
13529 .row &%smtp_accept_max_per_host%&    "connections from one host"
13530 .row &%smtp_accept_queue%&           "queue mail if more connections"
13531 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
13532                                            connection"
13533 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
13534 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
13535 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
13536 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
13537 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
13538 .endtable
13539
13540
13541
13542 .section "Policy controls" "SECID106"
13543 .table2
13544 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
13545 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
13546 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
13547 .row &%acl_smtp_auth%&               "ACL for AUTH"
13548 .row &%acl_smtp_connect%&            "ACL for connection"
13549 .row &%acl_smtp_data%&               "ACL for DATA"
13550 .row &%acl_smtp_data_prdr%&          "ACL for DATA, per-recipient"
13551 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
13552 .row &%acl_smtp_etrn%&               "ACL for ETRN"
13553 .row &%acl_smtp_expn%&               "ACL for EXPN"
13554 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
13555 .row &%acl_smtp_mail%&               "ACL for MAIL"
13556 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
13557 .row &%acl_smtp_mime%&               "ACL for MIME parts"
13558 .row &%acl_smtp_notquit%&            "ACL for non-QUIT terminations"
13559 .row &%acl_smtp_predata%&            "ACL for start of data"
13560 .row &%acl_smtp_quit%&               "ACL for QUIT"
13561 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
13562 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
13563 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
13564 .row &%av_scanner%&                  "specify virus scanner"
13565 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13566                                       words""&"
13567 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
13568 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
13569 .row &%header_maxsize%&              "total size of message header"
13570 .row &%header_line_maxsize%&         "individual header line limit"
13571 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
13572 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
13573 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
13574 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
13575 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
13576 .row &%host_lookup%&                 "host name looked up for these hosts"
13577 .row &%host_lookup_order%&           "order of DNS and local name lookups"
13578 .row &%hosts_proxy%&                 "use proxy protocol for these hosts"
13579 .row &%host_reject_connection%&      "reject connection from these hosts"
13580 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
13581 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
13582 .row &%message_size_limit%&          "for all messages"
13583 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
13584 .row &%spamd_address%&               "set interface to SpamAssassin"
13585 .row &%strict_acl_vars%&             "object to unset ACL variables"
13586 .endtable
13587
13588
13589
13590 .section "Callout cache" "SECID107"
13591 .table2
13592 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
13593                                          item"
13594 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
13595                                          item"
13596 .row &%callout_negative_expire%&     "timeout for negative address cache item"
13597 .row &%callout_positive_expire%&     "timeout for positive address cache item"
13598 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
13599 .endtable
13600
13601
13602
13603 .section "TLS" "SECID108"
13604 .table2
13605 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
13606 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
13607 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
13608 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13609 .row &%tls_certificate%&             "location of server certificate"
13610 .row &%tls_crl%&                     "certificate revocation list"
13611 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
13612 .row &%tls_dhparam%&                 "DH parameters for server"
13613 .row &%tls_eccurve%&                 "EC curve selection for server"
13614 .row &%tls_ocsp_file%&               "location of server certificate status proof"
13615 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
13616 .row &%tls_privatekey%&              "location of server private key"
13617 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
13618 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
13619 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
13620 .row &%tls_verify_certificates%&     "expected client certificates"
13621 .row &%tls_verify_hosts%&            "insist on client certificate verify"
13622 .endtable
13623
13624
13625
13626 .section "Local user handling" "SECID109"
13627 .table2
13628 .row &%finduser_retries%&            "useful in NIS environments"
13629 .row &%gecos_name%&                  "used when creating &'Sender:'&"
13630 .row &%gecos_pattern%&               "ditto"
13631 .row &%max_username_length%&         "for systems that truncate"
13632 .row &%unknown_login%&               "used when no login name found"
13633 .row &%unknown_username%&            "ditto"
13634 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
13635 .row &%uucp_from_sender%&            "ditto"
13636 .endtable
13637
13638
13639
13640 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
13641 .table2
13642 .row &%header_maxsize%&              "total size of message header"
13643 .row &%header_line_maxsize%&         "individual header line limit"
13644 .row &%message_size_limit%&          "applies to all messages"
13645 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
13646 .row &%received_header_text%&        "expanded to make &'Received:'&"
13647 .row &%received_headers_max%&        "for mail loop detection"
13648 .row &%recipients_max%&              "limit per message"
13649 .row &%recipients_max_reject%&       "permanently reject excess recipients"
13650 .endtable
13651
13652
13653
13654
13655 .section "Non-SMTP incoming messages" "SECID111"
13656 .table2
13657 .row &%receive_timeout%&             "for non-SMTP messages"
13658 .endtable
13659
13660
13661
13662
13663
13664 .section "Incoming SMTP messages" "SECID112"
13665 See also the &'Policy controls'& section above.
13666
13667 .table2
13668 .row &%dkim_verify_signers%&         "DKIM domain for which DKIM ACL is run"
13669 .row &%host_lookup%&                 "host name looked up for these hosts"
13670 .row &%host_lookup_order%&           "order of DNS and local name lookups"
13671 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
13672 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
13673 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
13674 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
13675 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
13676 .row &%smtp_accept_max%&             "simultaneous incoming connections"
13677 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
13678 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
13679 .row &%smtp_accept_max_per_connection%& "messages per connection"
13680 .row &%smtp_accept_max_per_host%&    "connections from one host"
13681 .row &%smtp_accept_queue%&           "queue mail if more connections"
13682 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
13683                                            connection"
13684 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
13685 .row &%smtp_active_hostname%&        "host name to use in messages"
13686 .row &%smtp_banner%&                 "text for welcome banner"
13687 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
13688 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
13689 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
13690 .row &%smtp_etrn_command%&           "what to run for ETRN"
13691 .row &%smtp_etrn_serialize%&         "only one at once"
13692 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
13693 .row &%smtp_max_unknown_commands%&   "before dropping connection"
13694 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
13695 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
13696 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
13697 .row &%smtp_receive_timeout%&        "per command or data line"
13698 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
13699 .row &%smtp_return_error_details%&   "give detail on rejections"
13700 .endtable
13701
13702
13703
13704 .section "SMTP extensions" "SECID113"
13705 .table2
13706 .row &%accept_8bitmime%&             "advertise 8BITMIME"
13707 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
13708 .row &%dsn_advertise_hosts%&         "advertise DSN extensions to these hosts"
13709 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
13710 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
13711 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
13712 .row &%prdr_enable%&                 "advertise PRDR to all hosts"
13713 .row &%smtputf8_advertise_hosts%&    "advertise SMTPUTF8 to these hosts"
13714 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13715 .endtable
13716
13717
13718
13719 .section "Processing messages" "SECID114"
13720 .table2
13721 .row &%allow_domain_literals%&       "recognize domain literal syntax"
13722 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
13723 .row &%allow_utf8_domains%&          "in addresses"
13724 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13725                                       words""&"
13726 .row &%delivery_date_remove%&        "from incoming messages"
13727 .row &%envelope_to_remove%&          "from incoming messages"
13728 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
13729 .row &%headers_charset%&             "default for translations"
13730 .row &%qualify_domain%&              "default for senders"
13731 .row &%qualify_recipient%&           "default for recipients"
13732 .row &%return_path_remove%&          "from incoming messages"
13733 .row &%strip_excess_angle_brackets%& "in addresses"
13734 .row &%strip_trailing_dot%&          "at end of addresses"
13735 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
13736 .endtable
13737
13738
13739
13740 .section "System filter" "SECID115"
13741 .table2
13742 .row &%system_filter%&               "locate system filter"
13743 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
13744                                             directory"
13745 .row &%system_filter_file_transport%& "transport for delivery to a file"
13746 .row &%system_filter_group%&         "group for filter running"
13747 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
13748 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
13749 .row &%system_filter_user%&          "user for filter running"
13750 .endtable
13751
13752
13753
13754 .section "Routing and delivery" "SECID116"
13755 .table2
13756 .row &%disable_ipv6%&                "do no IPv6 processing"
13757 .row &%dns_again_means_nonexist%&    "for broken domains"
13758 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
13759 .row &%dns_dnssec_ok%&               "parameter for resolver"
13760 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
13761 .row &%dns_retrans%&                 "parameter for resolver"
13762 .row &%dns_retry%&                   "parameter for resolver"
13763 .row &%dns_trust_aa%&                "DNS zones trusted as authentic"
13764 .row &%dns_use_edns0%&               "parameter for resolver"
13765 .row &%hold_domains%&                "hold delivery for these domains"
13766 .row &%local_interfaces%&            "for routing checks"
13767 .row &%queue_domains%&               "no immediate delivery for these"
13768 .row &%queue_only%&                  "no immediate delivery at all"
13769 .row &%queue_only_file%&             "no immediate delivery if file exists"
13770 .row &%queue_only_load%&             "no immediate delivery if load is high"
13771 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13772 .row &%queue_only_override%&         "allow command line to override"
13773 .row &%queue_run_in_order%&          "order of arrival"
13774 .row &%queue_run_max%&               "of simultaneous queue runners"
13775 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
13776 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13777 .row &%remote_sort_domains%&         "order of remote deliveries"
13778 .row &%retry_data_expire%&           "timeout for retry data"
13779 .row &%retry_interval_max%&          "safety net for retry rules"
13780 .endtable
13781
13782
13783
13784 .section "Bounce and warning messages" "SECID117"
13785 .table2
13786 .row &%bounce_message_file%&         "content of bounce"
13787 .row &%bounce_message_text%&         "content of bounce"
13788 .row &%bounce_return_body%&          "include body if returning message"
13789 .row &%bounce_return_linesize_limit%& "limit on returned message line length"
13790 .row &%bounce_return_message%&       "include original message in bounce"
13791 .row &%bounce_return_size_limit%&    "limit on returned message"
13792 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
13793 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
13794 .row &%errors_copy%&                 "copy bounce messages"
13795 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
13796 .row &%delay_warning%&               "time schedule"
13797 .row &%delay_warning_condition%&     "condition for warning messages"
13798 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
13799 .row &%smtp_return_error_details%&   "give detail on rejections"
13800 .row &%warn_message_file%&           "content of warning message"
13801 .endtable
13802
13803
13804
13805 .section "Alphabetical list of main options" "SECTalomo"
13806 Those options that undergo string expansion before use are marked with
13807 &dagger;.
13808
13809 .option accept_8bitmime main boolean true
13810 .cindex "8BITMIME"
13811 .cindex "8-bit characters"
13812 .cindex "log" "selectors"
13813 .cindex "log" "8BITMIME"
13814 This option causes Exim to send 8BITMIME in its response to an SMTP
13815 EHLO command, and to accept the BODY= parameter on MAIL commands.
13816 However, though Exim is 8-bit clean, it is not a protocol converter, and it
13817 takes no steps to do anything special with messages received by this route.
13818
13819 Historically Exim kept this option off by default, but the maintainers
13820 feel that in today's Internet, this causes more problems than it solves.
13821 It now defaults to true.
13822 A more detailed analysis of the issues is provided by Dan Bernstein:
13823 .display
13824 &url(http://cr.yp.to/smtp/8bitmime.html)
13825 .endd
13826
13827 To log received 8BITMIME status use
13828 .code
13829 log_selector = +8bitmime
13830 .endd
13831
13832 .option acl_not_smtp main string&!! unset
13833 .cindex "&ACL;" "for non-SMTP messages"
13834 .cindex "non-SMTP messages" "ACLs for"
13835 This option defines the ACL that is run when a non-SMTP message has been
13836 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
13837 further details.
13838
13839 .option acl_not_smtp_mime main string&!! unset
13840 This option defines the ACL that is run for individual MIME parts of non-SMTP
13841 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
13842 SMTP messages.
13843
13844 .option acl_not_smtp_start main string&!! unset
13845 .cindex "&ACL;" "at start of non-SMTP message"
13846 .cindex "non-SMTP messages" "ACLs for"
13847 This option defines the ACL that is run before Exim starts reading a
13848 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
13849
13850 .option acl_smtp_auth main string&!! unset
13851 .cindex "&ACL;" "setting up for SMTP commands"
13852 .cindex "AUTH" "ACL for"
13853 This option defines the ACL that is run when an SMTP AUTH command is
13854 received. See chapter &<<CHAPACL>>& for further details.
13855
13856 .option acl_smtp_connect main string&!! unset
13857 .cindex "&ACL;" "on SMTP connection"
13858 This option defines the ACL that is run when an SMTP connection is received.
13859 See chapter &<<CHAPACL>>& for further details.
13860
13861 .option acl_smtp_data main string&!! unset
13862 .cindex "DATA" "ACL for"
13863 This option defines the ACL that is run after an SMTP DATA command has been
13864 processed and the message itself has been received, but before the final
13865 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
13866
13867 .option acl_smtp_data_prdr main string&!! accept
13868 .cindex "PRDR" "ACL for"
13869 .cindex "DATA" "PRDR ACL for"
13870 .cindex "&ACL;" "PRDR-related"
13871 .cindex "&ACL;" "per-user data processing"
13872 This option defines the ACL that,
13873 if the PRDR feature has been negotiated,
13874 is run for each recipient after an SMTP DATA command has been
13875 processed and the message itself has been received, but before the
13876 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
13877
13878 .option acl_smtp_dkim main string&!! unset
13879 .cindex DKIM "ACL for"
13880 This option defines the ACL that is run for each DKIM signature
13881 of a received message.
13882 See chapter &<<CHAPdkim>>& for further details.
13883
13884 .option acl_smtp_etrn main string&!! unset
13885 .cindex "ETRN" "ACL for"
13886 This option defines the ACL that is run when an SMTP ETRN command is
13887 received. See chapter &<<CHAPACL>>& for further details.
13888
13889 .option acl_smtp_expn main string&!! unset
13890 .cindex "EXPN" "ACL for"
13891 This option defines the ACL that is run when an SMTP EXPN command is
13892 received. See chapter &<<CHAPACL>>& for further details.
13893
13894 .option acl_smtp_helo main string&!! unset
13895 .cindex "EHLO" "ACL for"
13896 .cindex "HELO" "ACL for"
13897 This option defines the ACL that is run when an SMTP EHLO or HELO
13898 command is received. See chapter &<<CHAPACL>>& for further details.
13899
13900
13901 .option acl_smtp_mail main string&!! unset
13902 .cindex "MAIL" "ACL for"
13903 This option defines the ACL that is run when an SMTP MAIL command is
13904 received. See chapter &<<CHAPACL>>& for further details.
13905
13906 .option acl_smtp_mailauth main string&!! unset
13907 .cindex "AUTH" "on MAIL command"
13908 This option defines the ACL that is run when there is an AUTH parameter on
13909 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
13910 &<<CHAPSMTPAUTH>>& for details of authentication.
13911
13912 .option acl_smtp_mime main string&!! unset
13913 .cindex "MIME content scanning" "ACL for"
13914 This option is available when Exim is built with the content-scanning
13915 extension. It defines the ACL that is run for each MIME part in a message. See
13916 section &<<SECTscanmimepart>>& for details.
13917
13918 .option acl_smtp_notquit main string&!! unset
13919 .cindex "not-QUIT, ACL for"
13920 This option defines the ACL that is run when an SMTP session
13921 ends without a QUIT command being received.
13922 See chapter &<<CHAPACL>>& for further details.
13923
13924 .option acl_smtp_predata main string&!! unset
13925 This option defines the ACL that is run when an SMTP DATA command is
13926 received, before the message itself is received. See chapter &<<CHAPACL>>& for
13927 further details.
13928
13929 .option acl_smtp_quit main string&!! unset
13930 .cindex "QUIT, ACL for"
13931 This option defines the ACL that is run when an SMTP QUIT command is
13932 received. See chapter &<<CHAPACL>>& for further details.
13933
13934 .option acl_smtp_rcpt main string&!! unset
13935 .cindex "RCPT" "ACL for"
13936 This option defines the ACL that is run when an SMTP RCPT command is
13937 received. See chapter &<<CHAPACL>>& for further details.
13938
13939 .option acl_smtp_starttls main string&!! unset
13940 .cindex "STARTTLS, ACL for"
13941 This option defines the ACL that is run when an SMTP STARTTLS command is
13942 received. See chapter &<<CHAPACL>>& for further details.
13943
13944 .option acl_smtp_vrfy main string&!! unset
13945 .cindex "VRFY" "ACL for"
13946 This option defines the ACL that is run when an SMTP VRFY command is
13947 received. See chapter &<<CHAPACL>>& for further details.
13948
13949 .option admin_groups main "string list&!!" unset
13950 .cindex "admin user"
13951 This option is expanded just once, at the start of Exim's processing. If the
13952 current group or any of the supplementary groups of an Exim caller is in this
13953 colon-separated list, the caller has admin privileges. If all your system
13954 programmers are in a specific group, for example, you can give them all Exim
13955 admin privileges by putting that group in &%admin_groups%&. However, this does
13956 not permit them to read Exim's spool files (whose group owner is the Exim gid).
13957 To permit this, you have to add individuals to the Exim group.
13958
13959 .option allow_domain_literals main boolean false
13960 .cindex "domain literal"
13961 If this option is set, the RFC 2822 domain literal format is permitted in
13962 email addresses. The option is not set by default, because the domain literal
13963 format is not normally required these days, and few people know about it. It
13964 has, however, been exploited by mail abusers.
13965
13966 Unfortunately, it seems that some DNS black list maintainers are using this
13967 format to report black listing to postmasters. If you want to accept messages
13968 addressed to your hosts by IP address, you need to set
13969 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
13970 domains (defined in the named domain list &%local_domains%& in the default
13971 configuration). This &"magic string"& matches the domain literal form of all
13972 the local host's IP addresses.
13973
13974
13975 .option allow_mx_to_ip main boolean false
13976 .cindex "MX record" "pointing to IP address"
13977 It appears that more and more DNS zone administrators are breaking the rules
13978 and putting domain names that look like IP addresses on the right hand side of
13979 MX records. Exim follows the rules and rejects this, giving an error message
13980 that explains the misconfiguration. However, some other MTAs support this
13981 practice, so to avoid &"Why can't Exim do this?"& complaints,
13982 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
13983 recommended, except when you have no other choice.
13984
13985 .option allow_utf8_domains main boolean false
13986 .cindex "domain" "UTF-8 characters in"
13987 .cindex "UTF-8" "in domain name"
13988 Lots of discussion is going on about internationalized domain names. One
13989 camp is strongly in favour of just using UTF-8 characters, and it seems
13990 that at least two other MTAs permit this. This option allows Exim users to
13991 experiment if they wish.
13992
13993 If it is set true, Exim's domain parsing function allows valid
13994 UTF-8 multicharacters to appear in domain name components, in addition to
13995 letters, digits, and hyphens. However, just setting this option is not
13996 enough; if you want to look up these domain names in the DNS, you must also
13997 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
13998 suitable setting is:
13999 .code
14000 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
14001   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
14002 .endd
14003 Alternatively, you can just disable this feature by setting
14004 .code
14005 dns_check_names_pattern =
14006 .endd
14007 That is, set the option to an empty string so that no check is done.
14008
14009
14010 .option auth_advertise_hosts main "host list&!!" *
14011 .cindex "authentication" "advertising"
14012 .cindex "AUTH" "advertising"
14013 If any server authentication mechanisms are configured, Exim advertises them in
14014 response to an EHLO command only if the calling host matches this list.
14015 Otherwise, Exim does not advertise AUTH.
14016 Exim does not accept AUTH commands from clients to which it has not
14017 advertised the availability of AUTH. The advertising of individual
14018 authentication mechanisms can be controlled by the use of the
14019 &%server_advertise_condition%& generic authenticator option on the individual
14020 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
14021
14022 Certain mail clients (for example, Netscape) require the user to provide a name
14023 and password for authentication if AUTH is advertised, even though it may
14024 not be needed (the host may accept messages from hosts on its local LAN without
14025 authentication, for example). The &%auth_advertise_hosts%& option can be used
14026 to make these clients more friendly by excluding them from the set of hosts to
14027 which Exim advertises AUTH.
14028
14029 .cindex "AUTH" "advertising when encrypted"
14030 If you want to advertise the availability of AUTH only when the connection
14031 is encrypted using TLS, you can make use of the fact that the value of this
14032 option is expanded, with a setting like this:
14033 .code
14034 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
14035 .endd
14036 .vindex "&$tls_in_cipher$&"
14037 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
14038 the expansion is empty, thus matching no hosts. Otherwise, the result of the
14039 expansion is *, which matches all hosts.
14040
14041
14042 .option auto_thaw main time 0s
14043 .cindex "thawing messages"
14044 .cindex "unfreezing messages"
14045 If this option is set to a time greater than zero, a queue runner will try a
14046 new delivery attempt on any frozen message, other than a bounce message, if
14047 this much time has passed since it was frozen. This may result in the message
14048 being re-frozen if nothing has changed since the last attempt. It is a way of
14049 saying &"keep on trying, even though there are big problems"&.
14050
14051 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
14052 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
14053 thought to be very useful any more, and its use should probably be avoided.
14054
14055
14056 .option av_scanner main string "see below"
14057 This option is available if Exim is built with the content-scanning extension.
14058 It specifies which anti-virus scanner to use. The default value is:
14059 .code
14060 sophie:/var/run/sophie
14061 .endd
14062 If the value of &%av_scanner%& starts with a dollar character, it is expanded
14063 before use. See section &<<SECTscanvirus>>& for further details.
14064
14065
14066 .option bi_command main string unset
14067 .oindex "&%-bi%&"
14068 This option supplies the name of a command that is run when Exim is called with
14069 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
14070 just the command name, it is not a complete command line. If an argument is
14071 required, it must come from the &%-oA%& command line option.
14072
14073
14074 .option bounce_message_file main string unset
14075 .cindex "bounce message" "customizing"
14076 .cindex "customizing" "bounce message"
14077 This option defines a template file containing paragraphs of text to be used
14078 for constructing bounce messages.  Details of the file's contents are given in
14079 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
14080
14081
14082 .option bounce_message_text main string unset
14083 When this option is set, its contents are included in the default bounce
14084 message immediately after &"This message was created automatically by mail
14085 delivery software."& It is not used if &%bounce_message_file%& is set.
14086
14087 .option bounce_return_body main boolean true
14088 .cindex "bounce message" "including body"
14089 This option controls whether the body of an incoming message is included in a
14090 bounce message when &%bounce_return_message%& is true. The default setting
14091 causes the entire message, both header and body, to be returned (subject to the
14092 value of &%bounce_return_size_limit%&). If this option is false, only the
14093 message header is included. In the case of a non-SMTP message containing an
14094 error that is detected during reception, only those header lines preceding the
14095 point at which the error was detected are returned.
14096 .cindex "bounce message" "including original"
14097
14098 .option bounce_return_linesize_limit main integer 998
14099 .cindex "size" "of bounce lines, limit"
14100 .cindex "bounce message" "line length limit"
14101 .cindex "limit" "bounce message line length"
14102 This option sets a limit in bytes on the line length of messages
14103 that are returned to senders due to delivery problems,
14104 when &%bounce_return_message%& is true.
14105 The default value corresponds to RFC limits.
14106 If the message being returned has lines longer than this value it is
14107 treated as if the &%bounce_return_size_limit%& (below) restriction was exceeded.
14108
14109 The option also applies to bounces returned when an error is detected
14110 during reception of a messsage.
14111 In this case lines from the original are truncated.
14112
14113 The option does not apply to messages generated by an &(autoreply)& transport.
14114
14115
14116 .option bounce_return_message main boolean true
14117 If this option is set false, none of the original message is included in
14118 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
14119 &%bounce_return_body%&.
14120
14121
14122 .option bounce_return_size_limit main integer 100K
14123 .cindex "size" "of bounce, limit"
14124 .cindex "bounce message" "size limit"
14125 .cindex "limit" "bounce message size"
14126 This option sets a limit in bytes on the size of messages that are returned to
14127 senders as part of bounce messages when &%bounce_return_message%& is true. The
14128 limit should be less than the value of the global &%message_size_limit%& and of
14129 any &%message_size_limit%& settings on transports, to allow for the bounce text
14130 that Exim generates. If this option is set to zero there is no limit.
14131
14132 When the body of any message that is to be included in a bounce message is
14133 greater than the limit, it is truncated, and a comment pointing this out is
14134 added at the top. The actual cutoff may be greater than the value given, owing
14135 to the use of buffering for transferring the message in chunks (typically 8K in
14136 size). The idea is to save bandwidth on those undeliverable 15-megabyte
14137 messages.
14138
14139 .option bounce_sender_authentication main string unset
14140 .cindex "bounce message" "sender authentication"
14141 .cindex "authentication" "bounce message"
14142 .cindex "AUTH" "on bounce message"
14143 This option provides an authenticated sender address that is sent with any
14144 bounce messages generated by Exim that are sent over an authenticated SMTP
14145 connection. A typical setting might be:
14146 .code
14147 bounce_sender_authentication = mailer-daemon@my.domain.example
14148 .endd
14149 which would cause bounce messages to be sent using the SMTP command:
14150 .code
14151 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
14152 .endd
14153 The value of &%bounce_sender_authentication%& must always be a complete email
14154 address.
14155
14156 .option callout_domain_negative_expire main time 3h
14157 .cindex "caching" "callout timeouts"
14158 .cindex "callout" "caching timeouts"
14159 This option specifies the expiry time for negative callout cache data for a
14160 domain. See section &<<SECTcallver>>& for details of callout verification, and
14161 section &<<SECTcallvercache>>& for details of the caching.
14162
14163
14164 .option callout_domain_positive_expire main time 7d
14165 This option specifies the expiry time for positive callout cache data for a
14166 domain. See section &<<SECTcallver>>& for details of callout verification, and
14167 section &<<SECTcallvercache>>& for details of the caching.
14168
14169
14170 .option callout_negative_expire main time 2h
14171 This option specifies the expiry time for negative callout cache data for an
14172 address. See section &<<SECTcallver>>& for details of callout verification, and
14173 section &<<SECTcallvercache>>& for details of the caching.
14174
14175
14176 .option callout_positive_expire main time 24h
14177 This option specifies the expiry time for positive callout cache data for an
14178 address. See section &<<SECTcallver>>& for details of callout verification, and
14179 section &<<SECTcallvercache>>& for details of the caching.
14180
14181
14182 .option callout_random_local_part main string&!! "see below"
14183 This option defines the &"random"& local part that can be used as part of
14184 callout verification. The default value is
14185 .code
14186 $primary_hostname-$tod_epoch-testing
14187 .endd
14188 See section &<<CALLaddparcall>>& for details of how this value is used.
14189
14190
14191 .option check_log_inodes main integer 0
14192 See &%check_spool_space%& below.
14193
14194
14195 .option check_log_space main integer 0
14196 See &%check_spool_space%& below.
14197
14198 .oindex "&%check_rfc2047_length%&"
14199 .cindex "RFC 2047" "disabling length check"
14200 .option check_rfc2047_length main boolean true
14201 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
14202 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
14203 word; strings to be encoded that exceed this length are supposed to use
14204 multiple encoded words. By default, Exim does not recognize encoded words that
14205 exceed the maximum length. However, it seems that some software, in violation
14206 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
14207 set false, Exim recognizes encoded words of any length.
14208
14209
14210 .option check_spool_inodes main integer 0
14211 See &%check_spool_space%& below.
14212
14213
14214 .option check_spool_space main integer 0
14215 .cindex "checking disk space"
14216 .cindex "disk space, checking"
14217 .cindex "spool directory" "checking space"
14218 The four &%check_...%& options allow for checking of disk resources before a
14219 message is accepted.
14220
14221 .vindex "&$log_inodes$&"
14222 .vindex "&$log_space$&"
14223 .vindex "&$spool_inodes$&"
14224 .vindex "&$spool_space$&"
14225 When any of these options are set, they apply to all incoming messages. If you
14226 want to apply different checks to different kinds of message, you can do so by
14227 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
14228 &$spool_space$& in an ACL with appropriate additional conditions.
14229
14230
14231 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
14232 either value is greater than zero, for example:
14233 .code
14234 check_spool_space = 10M
14235 check_spool_inodes = 100
14236 .endd
14237 The spool partition is the one that contains the directory defined by
14238 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
14239 transit.
14240
14241 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
14242 files are written if either is greater than zero. These should be set only if
14243 &%log_file_path%& and &%spool_directory%& refer to different partitions.
14244
14245 If there is less space or fewer inodes than requested, Exim refuses to accept
14246 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
14247 error response to the MAIL command. If ESMTP is in use and there was a
14248 SIZE parameter on the MAIL command, its value is added to the
14249 &%check_spool_space%& value, and the check is performed even if
14250 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
14251
14252 The values for &%check_spool_space%& and &%check_log_space%& are held as a
14253 number of kilobytes. If a non-multiple of 1024 is specified, it is rounded up.
14254
14255 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
14256 failure a message is written to stderr and Exim exits with a non-zero code, as
14257 it obviously cannot send an error message of any kind.
14258
14259 .option daemon_smtp_ports main string &`smtp`&
14260 .cindex "port" "for daemon"
14261 .cindex "TCP/IP" "setting listening ports"
14262 This option specifies one or more default SMTP ports on which the Exim daemon
14263 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
14264 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
14265
14266 .option daemon_startup_retries main integer 9
14267 .cindex "daemon startup, retrying"
14268 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
14269 the daemon at startup when it cannot immediately bind a listening socket
14270 (typically because the socket is already in use): &%daemon_startup_retries%&
14271 defines the number of retries after the first failure, and
14272 &%daemon_startup_sleep%& defines the length of time to wait between retries.
14273
14274 .option daemon_startup_sleep main time 30s
14275 See &%daemon_startup_retries%&.
14276
14277 .option delay_warning main "time list" 24h
14278 .cindex "warning of delay"
14279 .cindex "delay warning, specifying"
14280 When a message is delayed, Exim sends a warning message to the sender at
14281 intervals specified by this option. The data is a colon-separated list of times
14282 after which to send warning messages. If the value of the option is an empty
14283 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
14284 message has been on the queue for longer than the last time, the last interval
14285 between the times is used to compute subsequent warning times. For example,
14286 with
14287 .code
14288 delay_warning = 4h:8h:24h
14289 .endd
14290 the first message is sent after 4 hours, the second after 8 hours, and
14291 the third one after 24 hours. After that, messages are sent every 16 hours,
14292 because that is the interval between the last two times on the list. If you set
14293 just one time, it specifies the repeat interval. For example, with:
14294 .code
14295 delay_warning = 6h
14296 .endd
14297 messages are repeated every six hours. To stop warnings after a given time, set
14298 a very large time at the end of the list. For example:
14299 .code
14300 delay_warning = 2h:12h:99d
14301 .endd
14302 Note that the option is only evaluated at the time a delivery attempt fails,
14303 which depends on retry and queue-runner configuration.
14304 Typically retries will be configured more frequently than warning messages.
14305
14306 .option delay_warning_condition main string&!! "see below"
14307 .vindex "&$domain$&"
14308 The string is expanded at the time a warning message might be sent. If all the
14309 deferred addresses have the same domain, it is set in &$domain$& during the
14310 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
14311 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
14312 &"false"& (the comparison being done caselessly) then the warning message is
14313 not sent. The default is:
14314 .code
14315 delay_warning_condition = ${if or {\
14316   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
14317   { match{$h_precedence:}{(?i)bulk|list|junk} }\
14318   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
14319   } {no}{yes}}
14320 .endd
14321 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
14322 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
14323 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
14324 &"auto-replied"& in an &'Auto-Submitted:'& header.
14325
14326 .option deliver_drop_privilege main boolean false
14327 .cindex "unprivileged delivery"
14328 .cindex "delivery" "unprivileged"
14329 If this option is set true, Exim drops its root privilege at the start of a
14330 delivery process, and runs as the Exim user throughout. This severely restricts
14331 the kinds of local delivery that are possible, but is viable in certain types
14332 of configuration. There is a discussion about the use of root privilege in
14333 chapter &<<CHAPsecurity>>&.
14334
14335 .option deliver_queue_load_max main fixed-point unset
14336 .cindex "load average"
14337 .cindex "queue runner" "abandoning"
14338 When this option is set, a queue run is abandoned if the system load average
14339 becomes greater than the value of the option. The option has no effect on
14340 ancient operating systems on which Exim cannot determine the load average.
14341 See also &%queue_only_load%& and &%smtp_load_reserve%&.
14342
14343
14344 .option delivery_date_remove main boolean true
14345 .cindex "&'Delivery-date:'& header line"
14346 Exim's transports have an option for adding a &'Delivery-date:'& header to a
14347 message when it is delivered, in exactly the same way as &'Return-path:'& is
14348 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
14349 should not be present in incoming messages, and this option causes them to be
14350 removed at the time the message is received, to avoid any problems that might
14351 occur when a delivered message is subsequently sent on to some other recipient.
14352
14353 .option disable_fsync main boolean false
14354 .cindex "&[fsync()]&, disabling"
14355 This option is available only if Exim was built with the compile-time option
14356 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
14357 a runtime configuration generates an &"unknown option"& error. You should not
14358 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
14359 really, really, really understand what you are doing. &'No pre-compiled
14360 distributions of Exim should ever make this option available.'&
14361
14362 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
14363 updated files' data to be written to disc before continuing. Unexpected events
14364 such as crashes and power outages may cause data to be lost or scrambled.
14365 Here be Dragons. &*Beware.*&
14366
14367
14368 .option disable_ipv6 main boolean false
14369 .cindex "IPv6" "disabling"
14370 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
14371 activities take place. AAAA records are never looked up, and any IPv6 addresses
14372 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
14373 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
14374 to handle IPv6 literal addresses.
14375
14376
14377 .option dkim_verify_signers main "domain list&!!" $dkim_signers
14378 .cindex DKIM "controlling calls to the ACL"
14379 This option gives a list of DKIM domains for which the DKIM ACL is run.
14380 It is expanded after the message is received; by default it runs
14381 the ACL once for each signature in the message.
14382 See chapter &<<CHAPdkim>>&.
14383
14384
14385 .option dns_again_means_nonexist main "domain list&!!" unset
14386 .cindex "DNS" "&""try again""& response; overriding"
14387 DNS lookups give a &"try again"& response for the DNS errors
14388 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
14389 keep trying to deliver a message, or to give repeated temporary errors to
14390 incoming mail. Sometimes the effect is caused by a badly set up name server and
14391 may persist for a long time. If a domain which exhibits this problem matches
14392 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
14393 This option should be used with care. You can make it apply to reverse lookups
14394 by a setting such as this:
14395 .code
14396 dns_again_means_nonexist = *.in-addr.arpa
14397 .endd
14398 This option applies to all DNS lookups that Exim does. It also applies when the
14399 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
14400 since these are most likely to be caused by DNS lookup problems. The
14401 &(dnslookup)& router has some options of its own for controlling what happens
14402 when lookups for MX or SRV records give temporary errors. These more specific
14403 options are applied after this global option.
14404
14405 .option dns_check_names_pattern main string "see below"
14406 .cindex "DNS" "pre-check of name syntax"
14407 When this option is set to a non-empty string, it causes Exim to check domain
14408 names for characters that are not allowed in host names before handing them to
14409 the DNS resolver, because some resolvers give temporary errors for names that
14410 contain unusual characters. If a domain name contains any unwanted characters,
14411 a &"not found"& result is forced, and the resolver is not called. The check is
14412 done by matching the domain name against a regular expression, which is the
14413 value of this option. The default pattern is
14414 .code
14415 dns_check_names_pattern = \
14416   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
14417 .endd
14418 which permits only letters, digits, slashes, and hyphens in components, but
14419 they must start and end with a letter or digit. Slashes are not, in fact,
14420 permitted in host names, but they are found in certain NS records (which can be
14421 accessed in Exim by using a &%dnsdb%& lookup). If you set
14422 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
14423 empty string.
14424
14425 .option dns_csa_search_limit main integer 5
14426 This option controls the depth of parental searching for CSA SRV records in the
14427 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
14428
14429 .option dns_csa_use_reverse main boolean true
14430 This option controls whether or not an IP address, given as a CSA domain, is
14431 reversed and looked up in the reverse DNS, as described in more detail in
14432 section &<<SECTverifyCSA>>&.
14433
14434
14435 .option dns_dnssec_ok main integer -1
14436 .cindex "DNS" "resolver options"
14437 .cindex "DNS" "DNSSEC"
14438 If this option is set to a non-negative number then Exim will initialise the
14439 DNS resolver library to either use or not use DNSSEC, overriding the system
14440 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
14441
14442 If the resolver library does not support DNSSEC then this option has no effect.
14443
14444
14445 .option dns_ipv4_lookup main "domain list&!!" unset
14446 .cindex "IPv6" "DNS lookup for AAAA records"
14447 .cindex "DNS" "IPv6 lookup for AAAA records"
14448 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
14449 looks for IPv6 address records (AAAA records) as well as IPv4 address records
14450 (A records) when trying to find IP addresses for hosts, unless the host's
14451 domain matches this list.
14452
14453 This is a fudge to help with name servers that give big delays or otherwise do
14454 not work for the AAAA record type. In due course, when the world's name
14455 servers have all been upgraded, there should be no need for this option.
14456
14457
14458 .option dns_retrans main time 0s
14459 .cindex "DNS" "resolver options"
14460 .cindex timeout "dns lookup"
14461 .cindex "DNS" timeout
14462 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
14463 retransmission and retry parameters for DNS lookups. Values of zero (the
14464 defaults) leave the system default settings unchanged. The first value is the
14465 time between retries, and the second is the number of retries. It isn't
14466 totally clear exactly how these settings affect the total time a DNS lookup may
14467 take. I haven't found any documentation about timeouts on DNS lookups; these
14468 parameter values are available in the external resolver interface structure,
14469 but nowhere does it seem to describe how they are used or what you might want
14470 to set in them.
14471 See also the &%slow_lookup_log%& option.
14472
14473
14474 .option dns_retry main integer 0
14475 See &%dns_retrans%& above.
14476
14477
14478 .option dns_trust_aa main "domain list&!!" unset
14479 .cindex "DNS" "resolver options"
14480 .cindex "DNS" "DNSSEC"
14481 If this option is set then lookup results marked with the AA bit
14482 (Authoritative Answer) are trusted the same way as if they were
14483 DNSSEC-verified. The authority section's name of the answer must
14484 match with this expanded domain list.
14485
14486 Use this option only if you talk directly to a resolver that is
14487 authoritative for some zones and does not set the AD (Authentic Data)
14488 bit in the answer. Some DNS servers may have an configuration option to
14489 mark the answers from their own zones as verified (they set the AD bit).
14490 Others do not have this option. It is considered as poor practice using
14491 a resolver that is an authoritative server for some zones.
14492
14493 Use this option only if you really have to (e.g. if you want
14494 to use DANE for remote delivery to a server that is listed in the DNS
14495 zones that your resolver is authoritative for).
14496
14497 If the DNS answer packet has the AA bit set and contains resource record
14498 in the answer section, the name of the first NS record appearing in the
14499 authority section is compared against the list. If the answer packet is
14500 authoritative but the answer section is empty, the name of the first SOA
14501 record in the authoritative section is used instead.
14502
14503 .cindex "DNS" "resolver options"
14504 .option dns_use_edns0 main integer -1
14505 .cindex "DNS" "resolver options"
14506 .cindex "DNS" "EDNS0"
14507 If this option is set to a non-negative number then Exim will initialise the
14508 DNS resolver library to either use or not use EDNS0 extensions, overriding
14509 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
14510 on.
14511
14512 If the resolver library does not support EDNS0 then this option has no effect.
14513
14514
14515 .option drop_cr main boolean false
14516 This is an obsolete option that is now a no-op. It used to affect the way Exim
14517 handled CR and LF characters in incoming messages. What happens now is
14518 described in section &<<SECTlineendings>>&.
14519
14520 .option dsn_advertise_hosts main "host list&!!" unset
14521 .cindex "bounce messages" "success"
14522 .cindex "DSN" "success"
14523 .cindex "Delivery Status Notification" "success"
14524 DSN extensions (RFC3461) will be advertised in the EHLO message to,
14525 and accepted from, these hosts.
14526 Hosts may use the NOTIFY and ENVID options on RCPT TO commands,
14527 and RET and ORCPT options on MAIL FROM commands.
14528 A NOTIFY=SUCCESS option requests success-DSN messages.
14529 A NOTIFY= option with no argument requests that no delay or failure DSNs
14530 are sent.
14531
14532 .option dsn_from main "string&!!" "see below"
14533 .cindex "&'From:'& header line" "in bounces"
14534 .cindex "bounce messages" "&'From:'& line, specifying"
14535 This option can be used to vary the contents of &'From:'& header lines in
14536 bounces and other automatically generated messages (&"Delivery Status
14537 Notifications"& &-- hence the name of the option). The default setting is:
14538 .code
14539 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
14540 .endd
14541 The value is expanded every time it is needed. If the expansion fails, a
14542 panic is logged, and the default value is used.
14543
14544 .option envelope_to_remove main boolean true
14545 .cindex "&'Envelope-to:'& header line"
14546 Exim's transports have an option for adding an &'Envelope-to:'& header to a
14547 message when it is delivered, in exactly the same way as &'Return-path:'& is
14548 handled. &'Envelope-to:'& records the original recipient address from the
14549 message's envelope that caused the delivery to happen. Such headers should not
14550 be present in incoming messages, and this option causes them to be removed at
14551 the time the message is received, to avoid any problems that might occur when a
14552 delivered message is subsequently sent on to some other recipient.
14553
14554
14555 .option errors_copy main "string list&!!" unset
14556 .cindex "bounce message" "copy to other address"
14557 .cindex "copy of bounce message"
14558 Setting this option causes Exim to send bcc copies of bounce messages that it
14559 generates to other addresses. &*Note*&: This does not apply to bounce messages
14560 coming from elsewhere. The value of the option is a colon-separated list of
14561 items. Each item consists of a pattern, terminated by white space, followed by
14562 a comma-separated list of email addresses. If a pattern contains spaces, it
14563 must be enclosed in double quotes.
14564
14565 Each pattern is processed in the same way as a single item in an address list
14566 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
14567 the bounce message, the message is copied to the addresses on the list. The
14568 items are scanned in order, and once a matching one is found, no further items
14569 are examined. For example:
14570 .code
14571 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
14572               rqps@mydomain   hostmaster@mydomain.example,\
14573                               postmaster@mydomain.example
14574 .endd
14575 .vindex "&$domain$&"
14576 .vindex "&$local_part$&"
14577 The address list is expanded before use. The expansion variables &$local_part$&
14578 and &$domain$& are set from the original recipient of the error message, and if
14579 there was any wildcard matching in the pattern, the expansion
14580 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
14581 variables &$0$&, &$1$&, etc. are set in the normal way.
14582
14583
14584 .option errors_reply_to main string unset
14585 .cindex "bounce message" "&'Reply-to:'& in"
14586 By default, Exim's bounce and delivery warning messages contain the header line
14587 .display
14588 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
14589 .endd
14590 .oindex &%quota_warn_message%&
14591 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
14592 A warning message that is generated by the &%quota_warn_message%& option in an
14593 &(appendfile)& transport may contain its own &'From:'& header line that
14594 overrides the default.
14595
14596 Experience shows that people reply to bounce messages. If the
14597 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
14598 and warning messages. For example:
14599 .code
14600 errors_reply_to = postmaster@my.domain.example
14601 .endd
14602 The value of the option is not expanded. It must specify a valid RFC 2822
14603 address. However, if a warning message that is generated by the
14604 &%quota_warn_message%& option in an &(appendfile)& transport contain its
14605 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
14606 not used.
14607
14608
14609 .new
14610 .option event_action main string&!! unset
14611 .cindex events
14612 This option declares a string to be expanded for Exim's events mechanism.
14613 For details see &<<CHAPevents>>&.
14614 .wen
14615
14616
14617 .option exim_group main string "compile-time configured"
14618 .cindex "gid (group id)" "Exim's own"
14619 .cindex "Exim group"
14620 This option changes the gid under which Exim runs when it gives up root
14621 privilege. The default value is compiled into the binary. The value of this
14622 option is used only when &%exim_user%& is also set. Unless it consists entirely
14623 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
14624 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
14625 security issues.
14626
14627
14628 .option exim_path main string "see below"
14629 .cindex "Exim binary, path name"
14630 This option specifies the path name of the Exim binary, which is used when Exim
14631 needs to re-exec itself. The default is set up to point to the file &'exim'& in
14632 the directory configured at compile time by the BIN_DIRECTORY setting. It
14633 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
14634 other place.
14635 &*Warning*&: Do not use a macro to define the value of this option, because
14636 you will break those Exim utilities that scan the configuration file to find
14637 where the binary is. (They then use the &%-bP%& option to extract option
14638 settings such as the value of &%spool_directory%&.)
14639
14640
14641 .option exim_user main string "compile-time configured"
14642 .cindex "uid (user id)" "Exim's own"
14643 .cindex "Exim user"
14644 This option changes the uid under which Exim runs when it gives up root
14645 privilege. The default value is compiled into the binary. Ownership of the run
14646 time configuration file and the use of the &%-C%& and &%-D%& command line
14647 options is checked against the values in the binary, not what is set here.
14648
14649 Unless it consists entirely of digits, the string is looked up using
14650 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
14651 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
14652 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
14653
14654
14655 .option extra_local_interfaces main "string list" unset
14656 This option defines network interfaces that are to be considered local when
14657 routing, but which are not used for listening by the daemon. See section
14658 &<<SECTreclocipadd>>& for details.
14659
14660
14661 . Allow this long option name to split; give it unsplit as a fifth argument
14662 . for the automatic .oindex that is generated by .option.
14663
14664 .option "extract_addresses_remove_arguments" main boolean true &&&
14665          extract_addresses_remove_arguments
14666 .oindex "&%-t%&"
14667 .cindex "command line" "addresses with &%-t%&"
14668 .cindex "Sendmail compatibility" "&%-t%& option"
14669 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
14670 are present on the command line when the &%-t%& option is used to build an
14671 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
14672 line addresses are removed from the recipients list. This is also how Smail
14673 behaves. However, other Sendmail documentation (the O'Reilly book) states that
14674 command line addresses are added to those obtained from the header lines. When
14675 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
14676 argument headers. If it is set false, Exim adds rather than removes argument
14677 addresses.
14678
14679
14680 .option finduser_retries main integer 0
14681 .cindex "NIS, retrying user lookups"
14682 On systems running NIS or other schemes in which user and group information is
14683 distributed from a remote system, there can be times when &[getpwnam()]& and
14684 related functions fail, even when given valid data, because things time out.
14685 Unfortunately these failures cannot be distinguished from genuine &"not found"&
14686 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
14687 many extra times to find a user or a group, waiting for one second between
14688 retries.
14689
14690 .cindex "&_/etc/passwd_&" "multiple reading of"
14691 You should not set this option greater than zero if your user information is in
14692 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
14693 search the file multiple times for non-existent users, and also cause delay.
14694
14695
14696
14697 .option freeze_tell main "string list, comma separated" unset
14698 .cindex "freezing messages" "sending a message when freezing"
14699 On encountering certain errors, or when configured to do so in a system filter,
14700 ACL, or special router, Exim freezes a message. This means that no further
14701 delivery attempts take place until an administrator thaws the message, or the
14702 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
14703 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
14704 warning message whenever it freezes something, unless the message it is
14705 freezing is a locally-generated bounce message. (Without this exception there
14706 is the possibility of looping.) The warning message is sent to the addresses
14707 supplied as the comma-separated value of this option. If several of the
14708 message's addresses cause freezing, only a single message is sent. If the
14709 freezing was automatic, the reason(s) for freezing can be found in the message
14710 log. If you configure freezing in a filter or ACL, you must arrange for any
14711 logging that you require.
14712
14713
14714 .option gecos_name main string&!! unset
14715 .cindex "HP-UX"
14716 .cindex "&""gecos""& field, parsing"
14717 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
14718 password file to hold other information in addition to users' real names. Exim
14719 looks up this field for use when it is creating &'Sender:'& or &'From:'&
14720 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
14721 of the field are used unchanged, except that, if an ampersand is encountered,
14722 it is replaced by the user's login name with the first character forced to
14723 upper case, since this is a convention that is observed on many systems.
14724
14725 When these options are set, &%gecos_pattern%& is treated as a regular
14726 expression that is to be applied to the field (again with && replaced by the
14727 login name), and if it matches, &%gecos_name%& is expanded and used as the
14728 user's name.
14729
14730 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
14731 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
14732 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
14733 name terminates at the first comma, the following can be used:
14734 .code
14735 gecos_pattern = ([^,]*)
14736 gecos_name = $1
14737 .endd
14738
14739 .option gecos_pattern main string unset
14740 See &%gecos_name%& above.
14741
14742
14743 .option gnutls_compat_mode main boolean unset
14744 This option controls whether GnuTLS is used in compatibility mode in an Exim
14745 server. This reduces security slightly, but improves interworking with older
14746 implementations of TLS.
14747
14748
14749 option gnutls_allow_auto_pkcs11 main boolean unset
14750 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
14751 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
14752
14753 See
14754 &url(http://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
14755 for documentation.
14756
14757
14758
14759 .option headers_charset main string "see below"
14760 This option sets a default character set for translating from encoded MIME
14761 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
14762 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
14763 ultimate default is ISO-8859-1. For more details see the description of header
14764 insertions in section &<<SECTexpansionitems>>&.
14765
14766
14767
14768 .option header_maxsize main integer "see below"
14769 .cindex "header section" "maximum size of"
14770 .cindex "limit" "size of message header section"
14771 This option controls the overall maximum size of a message's header
14772 section. The default is the value of HEADER_MAXSIZE in
14773 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
14774 sections are rejected.
14775
14776
14777 .option header_line_maxsize main integer 0
14778 .cindex "header lines" "maximum size of"
14779 .cindex "limit" "size of one header line"
14780 This option limits the length of any individual header line in a message, after
14781 all the continuations have been joined together. Messages with individual
14782 header lines that are longer than the limit are rejected. The default value of
14783 zero means &"no limit"&.
14784
14785
14786
14787
14788 .option helo_accept_junk_hosts main "host list&!!" unset
14789 .cindex "HELO" "accepting junk data"
14790 .cindex "EHLO" "accepting junk data"
14791 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
14792 mail, and gives an error response for invalid data. Unfortunately, there are
14793 some SMTP clients that send syntactic junk. They can be accommodated by setting
14794 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
14795 if you want to do semantic checking.
14796 See also &%helo_allow_chars%& for a way of extending the permitted character
14797 set.
14798
14799
14800 .option helo_allow_chars main string unset
14801 .cindex "HELO" "underscores in"
14802 .cindex "EHLO" "underscores in"
14803 .cindex "underscore in EHLO/HELO"
14804 This option can be set to a string of rogue characters that are permitted in
14805 all EHLO and HELO names in addition to the standard letters, digits,
14806 hyphens, and dots. If you really must allow underscores, you can set
14807 .code
14808 helo_allow_chars = _
14809 .endd
14810 Note that the value is one string, not a list.
14811
14812
14813 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
14814 .cindex "HELO" "forcing reverse lookup"
14815 .cindex "EHLO" "forcing reverse lookup"
14816 If the domain given by a client in a HELO or EHLO command matches this
14817 list, a reverse lookup is done in order to establish the host's true name. The
14818 default forces a lookup if the client host gives the server's name or any of
14819 its IP addresses (in brackets), something that broken clients have been seen to
14820 do.
14821
14822
14823 .option helo_try_verify_hosts main "host list&!!" unset
14824 .cindex "HELO verifying" "optional"
14825 .cindex "EHLO" "verifying, optional"
14826 By default, Exim just checks the syntax of HELO and EHLO commands (see
14827 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
14828 to do more extensive checking of the data supplied by these commands. The ACL
14829 condition &`verify = helo`& is provided to make this possible.
14830 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
14831 to force the check to occur. From release 4.53 onwards, this is no longer
14832 necessary. If the check has not been done before &`verify = helo`& is
14833 encountered, it is done at that time. Consequently, this option is obsolete.
14834 Its specification is retained here for backwards compatibility.
14835
14836 When an EHLO or HELO command is received, if the calling host matches
14837 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
14838 EHLO command either:
14839
14840 .ilist
14841 is an IP literal matching the calling address of the host, or
14842 .next
14843 .cindex "DNS" "reverse lookup"
14844 .cindex "reverse DNS lookup"
14845 matches the host name that Exim obtains by doing a reverse lookup of the
14846 calling host address, or
14847 .next
14848 when looked up in DNS yields the calling host address.
14849 .endlist
14850
14851 However, the EHLO or HELO command is not rejected if any of the checks
14852 fail. Processing continues, but the result of the check is remembered, and can
14853 be detected later in an ACL by the &`verify = helo`& condition.
14854
14855 If DNS was used for successful verification, the variable
14856 .cindex "DNS" "DNSSEC"
14857 &$helo_verify_dnssec$& records the DNSSEC status of the lookups.
14858
14859 .option helo_verify_hosts main "host list&!!" unset
14860 .cindex "HELO verifying" "mandatory"
14861 .cindex "EHLO" "verifying, mandatory"
14862 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
14863 backwards compatibility. For hosts that match this option, Exim checks the host
14864 name given in the HELO or EHLO in the same way as for
14865 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
14866 rejected with a 550 error, and entries are written to the main and reject logs.
14867 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
14868 error.
14869
14870 .option hold_domains main "domain list&!!" unset
14871 .cindex "domain" "delaying delivery"
14872 .cindex "delivery" "delaying certain domains"
14873 This option allows mail for particular domains to be held on the queue
14874 manually. The option is overridden if a message delivery is forced with the
14875 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
14876 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
14877 item in &%hold_domains%&, no routing or delivery for that address is done, and
14878 it is deferred every time the message is looked at.
14879
14880 This option is intended as a temporary operational measure for delaying the
14881 delivery of mail while some problem is being sorted out, or some new
14882 configuration tested. If you just want to delay the processing of some
14883 domains until a queue run occurs, you should use &%queue_domains%& or
14884 &%queue_smtp_domains%&, not &%hold_domains%&.
14885
14886 A setting of &%hold_domains%& does not override Exim's code for removing
14887 messages from the queue if they have been there longer than the longest retry
14888 time in any retry rule. If you want to hold messages for longer than the normal
14889 retry times, insert a dummy retry rule with a long retry time.
14890
14891
14892 .option host_lookup main "host list&!!" unset
14893 .cindex "host name" "lookup, forcing"
14894 Exim does not look up the name of a calling host from its IP address unless it
14895 is required to compare against some host list, or the host matches
14896 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
14897 option (which normally contains IP addresses rather than host names). The
14898 default configuration file contains
14899 .code
14900 host_lookup = *
14901 .endd
14902 which causes a lookup to happen for all hosts. If the expense of these lookups
14903 is felt to be too great, the setting can be changed or removed.
14904
14905 After a successful reverse lookup, Exim does a forward lookup on the name it
14906 has obtained, to verify that it yields the IP address that it started with. If
14907 this check fails, Exim behaves as if the name lookup failed.
14908
14909 .vindex "&$host_lookup_failed$&"
14910 .vindex "&$sender_host_name$&"
14911 After any kind of failure, the host name (in &$sender_host_name$&) remains
14912 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
14913 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
14914 &`verify = reverse_host_lookup`& in ACLs.
14915
14916
14917 .option host_lookup_order main "string list" &`bydns:byaddr`&
14918 This option specifies the order of different lookup methods when Exim is trying
14919 to find a host name from an IP address. The default is to do a DNS lookup
14920 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
14921 if that fails. You can change the order of these lookups, or omit one entirely,
14922 if you want.
14923
14924 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
14925 multiple PTR records in the DNS and the IP address is not listed in
14926 &_/etc/hosts_&. Different operating systems give different results in this
14927 case. That is why the default tries a DNS lookup first.
14928
14929
14930
14931 .option host_reject_connection main "host list&!!" unset
14932 .cindex "host" "rejecting connections from"
14933 If this option is set, incoming SMTP calls from the hosts listed are rejected
14934 as soon as the connection is made.
14935 This option is obsolete, and retained only for backward compatibility, because
14936 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
14937 connections immediately.
14938
14939 The ability to give an immediate rejection (either by this option or using an
14940 ACL) is provided for use in unusual cases. Many hosts will just try again,
14941 sometimes without much delay. Normally, it is better to use an ACL to reject
14942 incoming messages at a later stage, such as after RCPT commands. See
14943 chapter &<<CHAPACL>>&.
14944
14945
14946 .option hosts_connection_nolog main "host list&!!" unset
14947 .cindex "host" "not logging connections from"
14948 This option defines a list of hosts for which connection logging does not
14949 happen, even though the &%smtp_connection%& log selector is set. For example,
14950 you might want not to log SMTP connections from local processes, or from
14951 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
14952 the daemon; you should therefore strive to restrict its value to a short inline
14953 list of IP addresses and networks. To disable logging SMTP connections from
14954 local processes, you must create a host list with an empty item. For example:
14955 .code
14956 hosts_connection_nolog = :
14957 .endd
14958 If the &%smtp_connection%& log selector is not set, this option has no effect.
14959
14960
14961
14962 .new
14963 .option hosts_proxy main "host list&!!" unset
14964 .cindex proxy "proxy protocol"
14965 This option enables use of Proxy Protocol proxies for incoming
14966 connections.  For details see &<<SECTproxyInbound>>&.
14967 .wen
14968
14969
14970 .option hosts_treat_as_local main "domain list&!!" unset
14971 .cindex "local host" "domains treated as"
14972 .cindex "host" "treated as local"
14973 If this option is set, any host names that match the domain list are treated as
14974 if they were the local host when Exim is scanning host lists obtained from MX
14975 records
14976 or other sources. Note that the value of this option is a domain list, not a
14977 host list, because it is always used to check host names, not IP addresses.
14978
14979 This option also applies when Exim is matching the special items
14980 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
14981 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
14982 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
14983 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
14984 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
14985 interfaces and recognizing the local host.
14986
14987
14988 .option ibase_servers main "string list" unset
14989 .cindex "InterBase" "server list"
14990 This option provides a list of InterBase servers and associated connection data,
14991 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
14992 The option is available only if Exim has been built with InterBase support.
14993
14994
14995
14996 .option ignore_bounce_errors_after main time 10w
14997 .cindex "bounce message" "discarding"
14998 .cindex "discarding bounce message"
14999 This option affects the processing of bounce messages that cannot be delivered,
15000 that is, those that suffer a permanent delivery failure. (Bounce messages that
15001 suffer temporary delivery failures are of course retried in the usual way.)
15002
15003 After a permanent delivery failure, bounce messages are frozen,
15004 because there is no sender to whom they can be returned. When a frozen bounce
15005 message has been on the queue for more than the given time, it is unfrozen at
15006 the next queue run, and a further delivery is attempted. If delivery fails
15007 again, the bounce message is discarded. This makes it possible to keep failed
15008 bounce messages around for a shorter time than the normal maximum retry time
15009 for frozen messages. For example,
15010 .code
15011 ignore_bounce_errors_after = 12h
15012 .endd
15013 retries failed bounce message deliveries after 12 hours, discarding any further
15014 failures. If the value of this option is set to a zero time period, bounce
15015 failures are discarded immediately. Setting a very long time (as in the default
15016 value) has the effect of disabling this option. For ways of automatically
15017 dealing with other kinds of frozen message, see &%auto_thaw%& and
15018 &%timeout_frozen_after%&.
15019
15020
15021 .option ignore_fromline_hosts main "host list&!!" unset
15022 .cindex "&""From""& line"
15023 .cindex "UUCP" "&""From""& line"
15024 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
15025 the headers of a message. By default this is treated as the start of the
15026 message's body, which means that any following headers are not recognized as
15027 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
15028 match those hosts that insist on sending it. If the sender is actually a local
15029 process rather than a remote host, and is using &%-bs%& to inject the messages,
15030 &%ignore_fromline_local%& must be set to achieve this effect.
15031
15032
15033 .option ignore_fromline_local main boolean false
15034 See &%ignore_fromline_hosts%& above.
15035
15036
15037 .option keep_malformed main time 4d
15038 This option specifies the length of time to keep messages whose spool files
15039 have been corrupted in some way. This should, of course, never happen. At the
15040 next attempt to deliver such a message, it gets removed. The incident is
15041 logged.
15042
15043
15044 .option ldap_ca_cert_dir main string unset
15045 .cindex "LDAP", "TLS CA certificate directory"
15046 .cindex certificate "directory for LDAP"
15047 This option indicates which directory contains CA certificates for verifying
15048 a TLS certificate presented by an LDAP server.
15049 While Exim does not provide a default value, your SSL library may.
15050 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
15051 and constrained to be a directory.
15052
15053
15054 .option ldap_ca_cert_file main string unset
15055 .cindex "LDAP", "TLS CA certificate file"
15056 .cindex certificate "file for LDAP"
15057 This option indicates which file contains CA certificates for verifying
15058 a TLS certificate presented by an LDAP server.
15059 While Exim does not provide a default value, your SSL library may.
15060 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
15061 and constrained to be a file.
15062
15063
15064 .option ldap_cert_file main string unset
15065 .cindex "LDAP" "TLS client certificate file"
15066 .cindex certificate "file for LDAP"
15067 This option indicates which file contains an TLS client certificate which
15068 Exim should present to the LDAP server during TLS negotiation.
15069 Should be used together with &%ldap_cert_key%&.
15070
15071
15072 .option ldap_cert_key main string unset
15073 .cindex "LDAP" "TLS client key file"
15074 .cindex certificate "key for LDAP"
15075 This option indicates which file contains the secret/private key to use
15076 to prove identity to the LDAP server during TLS negotiation.
15077 Should be used together with &%ldap_cert_file%&, which contains the
15078 identity to be proven.
15079
15080
15081 .option ldap_cipher_suite main string unset
15082 .cindex "LDAP" "TLS cipher suite"
15083 This controls the TLS cipher-suite negotiation during TLS negotiation with
15084 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
15085 cipher-suite options with OpenSSL (as used by LDAP client libraries).
15086
15087
15088 .option ldap_default_servers main "string list" unset
15089 .cindex "LDAP" "default servers"
15090 This option provides a list of LDAP servers which are tried in turn when an
15091 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
15092 details of LDAP queries. This option is available only when Exim has been built
15093 with LDAP support.
15094
15095
15096 .option ldap_require_cert main string unset.
15097 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
15098 This should be one of the values "hard", "demand", "allow", "try" or "never".
15099 A value other than one of these is interpreted as "never".
15100 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
15101 Although Exim does not set a default, the LDAP library probably defaults
15102 to hard/demand.
15103
15104
15105 .option ldap_start_tls main boolean false
15106 .cindex "LDAP" "whether or not to negotiate TLS"
15107 If set, Exim will attempt to negotiate TLS with the LDAP server when
15108 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
15109 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
15110 of SSL-on-connect.
15111 In the event of failure to negotiate TLS, the action taken is controlled
15112 by &%ldap_require_cert%&.
15113
15114
15115 .option ldap_version main integer unset
15116 .cindex "LDAP" "protocol version, forcing"
15117 This option can be used to force Exim to set a specific protocol version for
15118 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
15119 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
15120 the LDAP headers; otherwise it is 2. This option is available only when Exim
15121 has been built with LDAP support.
15122
15123
15124
15125 .option local_from_check main boolean true
15126 .cindex "&'Sender:'& header line" "disabling addition of"
15127 .cindex "&'From:'& header line" "disabling checking of"
15128 When a message is submitted locally (that is, not over a TCP/IP connection) by
15129 an untrusted user, Exim removes any existing &'Sender:'& header line, and
15130 checks that the &'From:'& header line matches the login of the calling user and
15131 the domain specified by &%qualify_domain%&.
15132
15133 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
15134 locally submitted message is automatically qualified by Exim, unless the
15135 &%-bnq%& command line option is used.
15136
15137 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
15138 on the local part. If the &'From:'& header line does not match, Exim adds a
15139 &'Sender:'& header with an address constructed from the calling user's login
15140 and the default qualify domain.
15141
15142 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
15143 and no &'Sender:'& header is ever added. If, in addition, you want to retain
15144 &'Sender:'& header lines supplied by untrusted users, you must also set
15145 &%local_sender_retain%& to be true.
15146
15147 .cindex "envelope sender"
15148 These options affect only the header lines in the message. The envelope sender
15149 is still forced to be the login id at the qualify domain unless
15150 &%untrusted_set_sender%& permits the user to supply an envelope sender.
15151
15152 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
15153 request similar header line checking. See section &<<SECTthesenhea>>&, which
15154 has more details about &'Sender:'& processing.
15155
15156
15157
15158
15159 .option local_from_prefix main string unset
15160 When Exim checks the &'From:'& header line of locally submitted messages for
15161 matching the login id (see &%local_from_check%& above), it can be configured to
15162 ignore certain prefixes and suffixes in the local part of the address. This is
15163 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
15164 appropriate lists, in the same form as the &%local_part_prefix%& and
15165 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
15166 example, if
15167 .code
15168 local_from_prefix = *-
15169 .endd
15170 is set, a &'From:'& line containing
15171 .code
15172 From: anything-user@your.domain.example
15173 .endd
15174 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
15175 matches the actual sender address that is constructed from the login name and
15176 qualify domain.
15177
15178
15179 .option local_from_suffix main string unset
15180 See &%local_from_prefix%& above.
15181
15182
15183 .option local_interfaces main "string list" "see below"
15184 This option controls which network interfaces are used by the daemon for
15185 listening; they are also used to identify the local host when routing. Chapter
15186 &<<CHAPinterfaces>>& contains a full description of this option and the related
15187 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
15188 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
15189 &%local_interfaces%& is
15190 .code
15191 local_interfaces = 0.0.0.0
15192 .endd
15193 when Exim is built without IPv6 support; otherwise it is
15194 .code
15195 local_interfaces = <; ::0 ; 0.0.0.0
15196 .endd
15197
15198 .option local_scan_timeout main time 5m
15199 .cindex "timeout" "for &[local_scan()]& function"
15200 .cindex "&[local_scan()]& function" "timeout"
15201 This timeout applies to the &[local_scan()]& function (see chapter
15202 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
15203 the incoming message is rejected with a temporary error if it is an SMTP
15204 message. For a non-SMTP message, the message is dropped and Exim ends with a
15205 non-zero code. The incident is logged on the main and reject logs.
15206
15207
15208
15209 .option local_sender_retain main boolean false
15210 .cindex "&'Sender:'& header line" "retaining from local submission"
15211 When a message is submitted locally (that is, not over a TCP/IP connection) by
15212 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
15213 do not want this to happen, you must set &%local_sender_retain%&, and you must
15214 also set &%local_from_check%& to be false (Exim will complain if you do not).
15215 See also the ACL modifier &`control = suppress_local_fixups`&. Section
15216 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
15217
15218
15219
15220
15221 .option localhost_number main string&!! unset
15222 .cindex "host" "locally unique number for"
15223 .cindex "message ids" "with multiple hosts"
15224 .vindex "&$localhost_number$&"
15225 Exim's message ids are normally unique only within the local host. If
15226 uniqueness among a set of hosts is required, each host must set a different
15227 value for the &%localhost_number%& option. The string is expanded immediately
15228 after reading the configuration file (so that a number can be computed from the
15229 host name, for example) and the result of the expansion must be a number in the
15230 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
15231 systems). This is available in subsequent string expansions via the variable
15232 &$localhost_number$&. When &%localhost_number is set%&, the final two
15233 characters of the message id, instead of just being a fractional part of the
15234 time, are computed from the time and the local host number as described in
15235 section &<<SECTmessiden>>&.
15236
15237
15238
15239 .option log_file_path main "string list&!!" "set at compile time"
15240 .cindex "log" "file path for"
15241 This option sets the path which is used to determine the names of Exim's log
15242 files, or indicates that logging is to be to syslog, or both. It is expanded
15243 when Exim is entered, so it can, for example, contain a reference to the host
15244 name. If no specific path is set for the log files at compile or run time,
15245 or if the option is unset at run time (i.e.  &`log_file_path = `&)
15246 they are written in a sub-directory called &_log_& in Exim's spool directory.
15247 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
15248 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
15249 used. If this string is fixed at your installation (contains no expansion
15250 variables) it is recommended that you do not set this option in the
15251 configuration file, but instead supply the path using LOG_FILE_PATH in
15252 &_Local/Makefile_& so that it is available to Exim for logging errors detected
15253 early on &-- in particular, failure to read the configuration file.
15254
15255
15256 .option log_selector main string unset
15257 .cindex "log" "selectors"
15258 This option can be used to reduce or increase the number of things that Exim
15259 writes to its log files. Its argument is made up of names preceded by plus or
15260 minus characters. For example:
15261 .code
15262 log_selector = +arguments -retry_defer
15263 .endd
15264 A list of possible names and what they control is given in the chapter on
15265 logging, in section &<<SECTlogselector>>&.
15266
15267
15268 .option log_timezone main boolean false
15269 .cindex "log" "timezone for entries"
15270 .vindex "&$tod_log$&"
15271 .vindex "&$tod_zone$&"
15272 By default, the timestamps on log lines are in local time without the
15273 timezone. This means that if your timezone changes twice a year, the timestamps
15274 in log lines are ambiguous for an hour when the clocks go back. One way of
15275 avoiding this problem is to set the timezone to UTC. An alternative is to set
15276 &%log_timezone%& true. This turns on the addition of the timezone offset to
15277 timestamps in log lines. Turning on this option can add quite a lot to the size
15278 of log files because each line is extended by 6 characters. Note that the
15279 &$tod_log$& variable contains the log timestamp without the zone, but there is
15280 another variable called &$tod_zone$& that contains just the timezone offset.
15281
15282
15283 .option lookup_open_max main integer 25
15284 .cindex "too many open files"
15285 .cindex "open files, too many"
15286 .cindex "file" "too many open"
15287 .cindex "lookup" "maximum open files"
15288 .cindex "limit" "open files for lookups"
15289 This option limits the number of simultaneously open files for single-key
15290 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
15291 Exim normally keeps these files open during routing, because often the same
15292 file is required several times. If the limit is reached, Exim closes the least
15293 recently used file. Note that if you are using the &'ndbm'& library, it
15294 actually opens two files for each logical DBM database, though it still counts
15295 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
15296 open files"& errors with NDBM, you need to reduce the value of
15297 &%lookup_open_max%&.
15298
15299
15300 .option max_username_length main integer 0
15301 .cindex "length of login name"
15302 .cindex "user name" "maximum length"
15303 .cindex "limit" "user name length"
15304 Some operating systems are broken in that they truncate long arguments to
15305 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
15306 this option is set greater than zero, any attempt to call &[getpwnam()]& with
15307 an argument that is longer behaves as if &[getpwnam()]& failed.
15308
15309
15310 .option message_body_newlines main bool false
15311 .cindex "message body" "newlines in variables"
15312 .cindex "newline" "in message body variables"
15313 .vindex "&$message_body$&"
15314 .vindex "&$message_body_end$&"
15315 By default, newlines in the message body are replaced by spaces when setting
15316 the &$message_body$& and &$message_body_end$& expansion variables. If this
15317 option is set true, this no longer happens.
15318
15319
15320 .option message_body_visible main integer 500
15321 .cindex "body of message" "visible size"
15322 .cindex "message body" "visible size"
15323 .vindex "&$message_body$&"
15324 .vindex "&$message_body_end$&"
15325 This option specifies how much of a message's body is to be included in the
15326 &$message_body$& and &$message_body_end$& expansion variables.
15327
15328
15329 .option message_id_header_domain main string&!! unset
15330 .cindex "&'Message-ID:'& header line"
15331 If this option is set, the string is expanded and used as the right hand side
15332 (domain) of the &'Message-ID:'& header that Exim creates if a
15333 locally-originated incoming message does not have one. &"Locally-originated"&
15334 means &"not received over TCP/IP."&
15335 Otherwise, the primary host name is used.
15336 Only letters, digits, dot and hyphen are accepted; any other characters are
15337 replaced by hyphens. If the expansion is forced to fail, or if the result is an
15338 empty string, the option is ignored.
15339
15340
15341 .option message_id_header_text main string&!! unset
15342 If this variable is set, the string is expanded and used to augment the text of
15343 the &'Message-id:'& header that Exim creates if a locally-originated incoming
15344 message does not have one. The text of this header is required by RFC 2822 to
15345 take the form of an address. By default, Exim uses its internal message id as
15346 the local part, and the primary host name as the domain. If this option is set,
15347 it is expanded, and provided the expansion is not forced to fail, and does not
15348 yield an empty string, the result is inserted into the header immediately
15349 before the @, separated from the internal message id by a dot. Any characters
15350 that are illegal in an address are automatically converted into hyphens. This
15351 means that variables such as &$tod_log$& can be used, because the spaces and
15352 colons will become hyphens.
15353
15354
15355 .option message_logs main boolean true
15356 .cindex "message logs" "disabling"
15357 .cindex "log" "message log; disabling"
15358 If this option is turned off, per-message log files are not created in the
15359 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
15360 Exim, by reducing the number of files involved in handling a message from a
15361 minimum of four (header spool file, body spool file, delivery journal, and
15362 per-message log) to three. The other major I/O activity is Exim's main log,
15363 which is not affected by this option.
15364
15365
15366 .option message_size_limit main string&!! 50M
15367 .cindex "message" "size limit"
15368 .cindex "limit" "message size"
15369 .cindex "size" "of message, limit"
15370 This option limits the maximum size of message that Exim will process. The
15371 value is expanded for each incoming connection so, for example, it can be made
15372 to depend on the IP address of the remote host for messages arriving via
15373 TCP/IP. After expansion, the value must be a sequence of decimal digits,
15374 optionally followed by K or M.
15375
15376 &*Note*&: This limit cannot be made to depend on a message's sender or any
15377 other properties of an individual message, because it has to be advertised in
15378 the server's response to EHLO. String expansion failure causes a temporary
15379 error. A value of zero means no limit, but its use is not recommended. See also
15380 &%bounce_return_size_limit%&.
15381
15382 Incoming SMTP messages are failed with a 552 error if the limit is
15383 exceeded; locally-generated messages either get a stderr message or a delivery
15384 failure message to the sender, depending on the &%-oe%& setting. Rejection of
15385 an oversized message is logged in both the main and the reject logs. See also
15386 the generic transport option &%message_size_limit%&, which limits the size of
15387 message that an individual transport can process.
15388
15389 If you use a virus-scanner and set this option to to a value larger than the
15390 maximum size that your virus-scanner is configured to support, you may get
15391 failures triggered by large mails.  The right size to configure for the
15392 virus-scanner depends upon what data is passed and the options in use but it's
15393 probably safest to just set it to a little larger than this value.  E.g., with a
15394 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
15395 some problems may result.
15396
15397 A value of 0 will disable size limit checking; Exim will still advertise the
15398 SIZE extension in an EHLO response, but without a limit, so as to permit
15399 SMTP clients to still indicate the message size along with the MAIL verb.
15400
15401
15402 .option move_frozen_messages main boolean false
15403 .cindex "frozen messages" "moving"
15404 This option, which is available only if Exim has been built with the setting
15405 .code
15406 SUPPORT_MOVE_FROZEN_MESSAGES=yes
15407 .endd
15408 in &_Local/Makefile_&, causes frozen messages and their message logs to be
15409 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
15410 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
15411 standard utilities for handling such moved messages, and they do not show up in
15412 lists generated by &%-bp%& or by the Exim monitor.
15413
15414
15415 .option mua_wrapper main boolean false
15416 Setting this option true causes Exim to run in a very restrictive mode in which
15417 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
15418 contains a full description of this facility.
15419
15420
15421
15422 .option mysql_servers main "string list" unset
15423 .cindex "MySQL" "server list"
15424 This option provides a list of MySQL servers and associated connection data, to
15425 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
15426 option is available only if Exim has been built with MySQL support.
15427
15428
15429 .option never_users main "string list&!!" unset
15430 This option is expanded just once, at the start of Exim's processing. Local
15431 message deliveries are normally run in processes that are setuid to the
15432 recipient, and remote deliveries are normally run under Exim's own uid and gid.
15433 It is usually desirable to prevent any deliveries from running as root, as a
15434 safety precaution.
15435
15436 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
15437 list of users that must not be used for local deliveries. This list is fixed in
15438 the binary and cannot be overridden by the configuration file. By default, it
15439 contains just the single user name &"root"&. The &%never_users%& runtime option
15440 can be used to add more users to the fixed list.
15441
15442 If a message is to be delivered as one of the users on the fixed list or the
15443 &%never_users%& list, an error occurs, and delivery is deferred. A common
15444 example is
15445 .code
15446 never_users = root:daemon:bin
15447 .endd
15448 Including root is redundant if it is also on the fixed list, but it does no
15449 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
15450 transport driver.
15451
15452
15453 .option openssl_options main "string list" "+no_sslv2 +single_dh_use"
15454 .cindex "OpenSSL "compatibility options"
15455 This option allows an administrator to adjust the SSL options applied
15456 by OpenSSL to connections.  It is given as a space-separated list of items,
15457 each one to be +added or -subtracted from the current value.
15458
15459 This option is only available if Exim is built against OpenSSL.  The values
15460 available for this option vary according to the age of your OpenSSL install.
15461 The &"all"& value controls a subset of flags which are available, typically
15462 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
15463 list the values known on your system and Exim should support all the
15464 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
15465 names lose the leading &"SSL_OP_"& and are lower-cased.
15466
15467 Note that adjusting the options can have severe impact upon the security of
15468 SSL as used by Exim.  It is possible to disable safety checks and shoot
15469 yourself in the foot in various unpleasant ways.  This option should not be
15470 adjusted lightly.  An unrecognised item will be detected at startup, by
15471 invoking Exim with the &%-bV%& flag.
15472
15473 The option affects Exim operating both as a server and as a client.
15474
15475 Historical note: prior to release 4.80, Exim defaulted this value to
15476 "+dont_insert_empty_fragments", which may still be needed for compatibility
15477 with some clients, but which lowers security by increasing exposure to
15478 some now infamous attacks.
15479
15480 Examples:
15481 .code
15482 # Make both old MS and old Eudora happy:
15483 openssl_options = -all +microsoft_big_sslv3_buffer \
15484                        +dont_insert_empty_fragments
15485
15486 # Disable older protocol versions:
15487 openssl_options = +no_sslv2 +no_sslv3
15488 .endd
15489
15490 Possible options may include:
15491 .ilist
15492 &`all`&
15493 .next
15494 &`allow_unsafe_legacy_renegotiation`&
15495 .next
15496 &`cipher_server_preference`&
15497 .next
15498 &`dont_insert_empty_fragments`&
15499 .next
15500 &`ephemeral_rsa`&
15501 .next
15502 &`legacy_server_connect`&
15503 .next
15504 &`microsoft_big_sslv3_buffer`&
15505 .next
15506 &`microsoft_sess_id_bug`&
15507 .next
15508 &`msie_sslv2_rsa_padding`&
15509 .next
15510 &`netscape_challenge_bug`&
15511 .next
15512 &`netscape_reuse_cipher_change_bug`&
15513 .next
15514 &`no_compression`&
15515 .next
15516 &`no_session_resumption_on_renegotiation`&
15517 .next
15518 &`no_sslv2`&
15519 .next
15520 &`no_sslv3`&
15521 .next
15522 &`no_ticket`&
15523 .next
15524 &`no_tlsv1`&
15525 .next
15526 &`no_tlsv1_1`&
15527 .next
15528 &`no_tlsv1_2`&
15529 .next
15530 &`safari_ecdhe_ecdsa_bug`&
15531 .next
15532 &`single_dh_use`&
15533 .next
15534 &`single_ecdh_use`&
15535 .next
15536 &`ssleay_080_client_dh_bug`&
15537 .next
15538 &`sslref2_reuse_cert_type_bug`&
15539 .next
15540 &`tls_block_padding_bug`&
15541 .next
15542 &`tls_d5_bug`&
15543 .next
15544 &`tls_rollback_bug`&
15545 .endlist
15546
15547 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
15548 all clients connecting using the MacOS SecureTransport TLS facility prior
15549 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
15550 to negotiate TLS then this option value might help, provided that your OpenSSL
15551 release is new enough to contain this work-around.  This may be a situation
15552 where you have to upgrade OpenSSL to get buggy clients working.
15553
15554
15555 .option oracle_servers main "string list" unset
15556 .cindex "Oracle" "server list"
15557 This option provides a list of Oracle servers and associated connection data,
15558 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
15559 The option is available only if Exim has been built with Oracle support.
15560
15561
15562 .option percent_hack_domains main "domain list&!!" unset
15563 .cindex "&""percent hack""&"
15564 .cindex "source routing" "in email address"
15565 .cindex "address" "source-routed"
15566 The &"percent hack"& is the convention whereby a local part containing a
15567 percent sign is re-interpreted as a new email address, with the percent
15568 replaced by @. This is sometimes called &"source routing"&, though that term is
15569 also applied to RFC 2822 addresses that begin with an @ character. If this
15570 option is set, Exim implements the percent facility for those domains listed,
15571 but no others. This happens before an incoming SMTP address is tested against
15572 an ACL.
15573
15574 &*Warning*&: The &"percent hack"& has often been abused by people who are
15575 trying to get round relaying restrictions. For this reason, it is best avoided
15576 if at all possible. Unfortunately, a number of less security-conscious MTAs
15577 implement it unconditionally. If you are running Exim on a gateway host, and
15578 routing mail through to internal MTAs without processing the local parts, it is
15579 a good idea to reject recipient addresses with percent characters in their
15580 local parts. Exim's default configuration does this.
15581
15582
15583 .option perl_at_start main boolean false
15584 This option is available only when Exim is built with an embedded Perl
15585 interpreter. See chapter &<<CHAPperl>>& for details of its use.
15586
15587
15588 .option perl_startup main string unset
15589 This option is available only when Exim is built with an embedded Perl
15590 interpreter. See chapter &<<CHAPperl>>& for details of its use.
15591
15592
15593 .option pgsql_servers main "string list" unset
15594 .cindex "PostgreSQL lookup type" "server list"
15595 This option provides a list of PostgreSQL servers and associated connection
15596 data, to be used in conjunction with &(pgsql)& lookups (see section
15597 &<<SECID72>>&). The option is available only if Exim has been built with
15598 PostgreSQL support.
15599
15600
15601 .option pid_file_path main string&!! "set at compile time"
15602 .cindex "daemon" "pid file path"
15603 .cindex "pid file, path for"
15604 This option sets the name of the file to which the Exim daemon writes its
15605 process id. The string is expanded, so it can contain, for example, references
15606 to the host name:
15607 .code
15608 pid_file_path = /var/log/$primary_hostname/exim.pid
15609 .endd
15610 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
15611 spool directory.
15612 The value set by the option can be overridden by the &%-oP%& command line
15613 option. A pid file is not written if a &"non-standard"& daemon is run by means
15614 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
15615
15616
15617 .option pipelining_advertise_hosts main "host list&!!" *
15618 .cindex "PIPELINING" "suppressing advertising"
15619 This option can be used to suppress the advertisement of the SMTP
15620 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
15621 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
15622 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
15623 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
15624 that clients will use it; &"out of order"& commands that are &"expected"& do
15625 not count as protocol errors (see &%smtp_max_synprot_errors%&).
15626
15627
15628 .option prdr_enable main boolean false
15629 .cindex "PRDR" "enabling on server"
15630 This option can be used to enable the Per-Recipient Data Response extension
15631 to SMTP, defined by Eric Hall.
15632 If the option is set, PRDR is advertised by Exim when operating as a server.
15633 If the client requests PRDR, and more than one recipient, for a message
15634 an additional ACL is called for each recipient after the message content
15635 is received.  See section &<<SECTPRDRACL>>&.
15636
15637 .option preserve_message_logs main boolean false
15638 .cindex "message logs" "preserving"
15639 If this option is set, message log files are not deleted when messages are
15640 completed. Instead, they are moved to a sub-directory of the spool directory
15641 called &_msglog.OLD_&, where they remain available for statistical or debugging
15642 purposes. This is a dangerous option to set on systems with any appreciable
15643 volume of mail. Use with care!
15644
15645
15646 .option primary_hostname main string "see below"
15647 .cindex "name" "of local host"
15648 .cindex "host" "name of local"
15649 .cindex "local host" "name of"
15650 .vindex "&$primary_hostname$&"
15651 This specifies the name of the current host. It is used in the default EHLO or
15652 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
15653 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
15654 The value is also used by default in some SMTP response messages from an Exim
15655 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
15656
15657 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
15658 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
15659 contains only one component, Exim passes it to &[gethostbyname()]& (or
15660 &[getipnodebyname()]& when available) in order to obtain the fully qualified
15661 version. The variable &$primary_hostname$& contains the host name, whether set
15662 explicitly by this option, or defaulted.
15663
15664
15665 .option print_topbitchars main boolean false
15666 .cindex "printing characters"
15667 .cindex "8-bit characters"
15668 By default, Exim considers only those characters whose codes lie in the range
15669 32&--126 to be printing characters. In a number of circumstances (for example,
15670 when writing log entries) non-printing characters are converted into escape
15671 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
15672 is set, code values of 128 and above are also considered to be printing
15673 characters.
15674
15675 This option also affects the header syntax checks performed by the
15676 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
15677 the user's full name when constructing From: and Sender: addresses (as
15678 described in section &<<SECTconstr>>&). Setting this option can cause
15679 Exim to generate eight bit message headers that do not conform to the
15680 standards.
15681
15682
15683 .option process_log_path main string unset
15684 .cindex "process log path"
15685 .cindex "log" "process log"
15686 .cindex "&'exiwhat'&"
15687 This option sets the name of the file to which an Exim process writes its
15688 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
15689 utility script. If this option is unset, the file called &_exim-process.info_&
15690 in Exim's spool directory is used. The ability to specify the name explicitly
15691 can be useful in environments where two different Exims are running, using
15692 different spool directories.
15693
15694
15695 .option prod_requires_admin main boolean true
15696 .oindex "&%-M%&"
15697 .oindex "&%-R%&"
15698 .oindex "&%-q%&"
15699 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
15700 admin user unless &%prod_requires_admin%& is set false. See also
15701 &%queue_list_requires_admin%&.
15702
15703
15704 .option qualify_domain main string "see below"
15705 .cindex "domain" "for qualifying addresses"
15706 .cindex "address" "qualification"
15707 This option specifies the domain name that is added to any envelope sender
15708 addresses that do not have a domain qualification. It also applies to
15709 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
15710 are accepted by default only for locally-generated messages. Qualification is
15711 also applied to addresses in header lines such as &'From:'& and &'To:'& for
15712 locally-generated messages, unless the &%-bnq%& command line option is used.
15713
15714 Messages from external sources must always contain fully qualified addresses,
15715 unless the sending host matches &%sender_unqualified_hosts%& or
15716 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
15717 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
15718 necessary. Internally, Exim always works with fully qualified envelope
15719 addresses. If &%qualify_domain%& is not set, it defaults to the
15720 &%primary_hostname%& value.
15721
15722
15723 .option qualify_recipient main string "see below"
15724 This option allows you to specify a different domain for qualifying recipient
15725 addresses to the one that is used for senders. See &%qualify_domain%& above.
15726
15727
15728
15729 .option queue_domains main "domain list&!!" unset
15730 .cindex "domain" "specifying non-immediate delivery"
15731 .cindex "queueing incoming messages"
15732 .cindex "message" "queueing certain domains"
15733 This option lists domains for which immediate delivery is not required.
15734 A delivery process is started whenever a message is received, but only those
15735 domains that do not match are processed. All other deliveries wait until the
15736 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
15737
15738
15739 .option queue_list_requires_admin main boolean true
15740 .oindex "&%-bp%&"
15741 The &%-bp%& command-line option, which lists the messages that are on the
15742 queue, requires the caller to be an admin user unless
15743 &%queue_list_requires_admin%& is set false. See also &%prod_requires_admin%&.
15744
15745
15746 .option queue_only main boolean false
15747 .cindex "queueing incoming messages"
15748 .cindex "message" "queueing unconditionally"
15749 If &%queue_only%& is set, a delivery process is not automatically started
15750 whenever a message is received. Instead, the message waits on the queue for the
15751 next queue run. Even if &%queue_only%& is false, incoming messages may not get
15752 delivered immediately when certain conditions (such as heavy load) occur.
15753
15754 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
15755 and &%-odi%& command line options override &%queue_only%& unless
15756 &%queue_only_override%& is set false. See also &%queue_only_file%&,
15757 &%queue_only_load%&, and &%smtp_accept_queue%&.
15758
15759
15760 .option queue_only_file main string unset
15761 .cindex "queueing incoming messages"
15762 .cindex "message" "queueing by file existence"
15763 This option can be set to a colon-separated list of absolute path names, each
15764 one optionally preceded by &"smtp"&. When Exim is receiving a message,
15765 it tests for the existence of each listed path using a call to &[stat()]&. For
15766 each path that exists, the corresponding queueing option is set.
15767 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
15768 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
15769 .code
15770 queue_only_file = smtp/some/file
15771 .endd
15772 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
15773 &_/some/file_& exists.
15774
15775
15776 .option queue_only_load main fixed-point unset
15777 .cindex "load average"
15778 .cindex "queueing incoming messages"
15779 .cindex "message" "queueing by load"
15780 If the system load average is higher than this value, incoming messages from
15781 all sources are queued, and no automatic deliveries are started. If this
15782 happens during local or remote SMTP input, all subsequent messages received on
15783 the same SMTP connection are queued by default, whatever happens to the load in
15784 the meantime, but this can be changed by setting &%queue_only_load_latch%&
15785 false.
15786
15787 Deliveries will subsequently be performed by queue runner processes. This
15788 option has no effect on ancient operating systems on which Exim cannot
15789 determine the load average. See also &%deliver_queue_load_max%& and
15790 &%smtp_load_reserve%&.
15791
15792
15793 .option queue_only_load_latch main boolean true
15794 .cindex "load average" "re-evaluating per message"
15795 When this option is true (the default), once one message has been queued
15796 because the load average is higher than the value set by &%queue_only_load%&,
15797 all subsequent messages received on the same SMTP connection are also queued.
15798 This is a deliberate choice; even though the load average may fall below the
15799 threshold, it doesn't seem right to deliver later messages on the same
15800 connection when not delivering earlier ones. However, there are special
15801 circumstances such as very long-lived connections from scanning appliances
15802 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
15803 should be set false. This causes the value of the load average to be
15804 re-evaluated for each message.
15805
15806
15807 .option queue_only_override main boolean true
15808 .cindex "queueing incoming messages"
15809 When this option is true, the &%-od%&&'x'& command line options override the
15810 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
15811 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
15812 to override; they are accepted, but ignored.
15813
15814
15815 .option queue_run_in_order main boolean false
15816 .cindex "queue runner" "processing messages in order"
15817 If this option is set, queue runs happen in order of message arrival instead of
15818 in an arbitrary order. For this to happen, a complete list of the entire queue
15819 must be set up before the deliveries start. When the queue is all held in a
15820 single directory (the default), a single list is created for both the ordered
15821 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
15822 single list is not created when &%queue_run_in_order%& is false. In this case,
15823 the sub-directories are processed one at a time (in a random order), and this
15824 avoids setting up one huge list for the whole queue. Thus, setting
15825 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
15826 when the queue is large, because of the extra work in setting up the single,
15827 large list. In most situations, &%queue_run_in_order%& should not be set.
15828
15829
15830
15831 .option queue_run_max main integer 5
15832 .cindex "queue runner" "maximum number of"
15833 This controls the maximum number of queue runner processes that an Exim daemon
15834 can run simultaneously. This does not mean that it starts them all at once,
15835 but rather that if the maximum number are still running when the time comes to
15836 start another one, it refrains from starting another one. This can happen with
15837 very large queues and/or very sluggish deliveries. This option does not,
15838 however, interlock with other processes, so additional queue runners can be
15839 started by other means, or by killing and restarting the daemon.
15840
15841 Setting this option to zero does not suppress queue runs; rather, it disables
15842 the limit, allowing any number of simultaneous queue runner processes to be
15843 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
15844 the daemon's command line.
15845
15846 .option queue_smtp_domains main "domain list&!!" unset
15847 .cindex "queueing incoming messages"
15848 .cindex "message" "queueing remote deliveries"
15849 When this option is set, a delivery process is started whenever a message is
15850 received, routing is performed, and local deliveries take place.
15851 However, if any SMTP deliveries are required for domains that match
15852 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
15853 message waits on the queue for the next queue run. Since routing of the message
15854 has taken place, Exim knows to which remote hosts it must be delivered, and so
15855 when the queue run happens, multiple messages for the same host are delivered
15856 over a single SMTP connection. The &%-odqs%& command line option causes all
15857 SMTP deliveries to be queued in this way, and is equivalent to setting
15858 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
15859 &%queue_domains%&.
15860
15861
15862 .option receive_timeout main time 0s
15863 .cindex "timeout" "for non-SMTP input"
15864 This option sets the timeout for accepting a non-SMTP message, that is, the
15865 maximum time that Exim waits when reading a message on the standard input. If
15866 the value is zero, it will wait for ever. This setting is overridden by the
15867 &%-or%& command line option. The timeout for incoming SMTP messages is
15868 controlled by &%smtp_receive_timeout%&.
15869
15870 .option received_header_text main string&!! "see below"
15871 .cindex "customizing" "&'Received:'& header"
15872 .cindex "&'Received:'& header line" "customizing"
15873 This string defines the contents of the &'Received:'& message header that is
15874 added to each message, except for the timestamp, which is automatically added
15875 on at the end (preceded by a semicolon). The string is expanded each time it is
15876 used. If the expansion yields an empty string, no &'Received:'& header line is
15877 added to the message. Otherwise, the string should start with the text
15878 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
15879 header lines. The default setting is:
15880
15881 .code
15882 received_header_text = Received: \
15883   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
15884   {${if def:sender_ident \
15885   {from ${quote_local_part:$sender_ident} }}\
15886   ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
15887   by $primary_hostname \
15888   ${if def:received_protocol {with $received_protocol}} \
15889   ${if def:tls_in_cipher {($tls_in_cipher)\n\t}}\
15890   (Exim $version_number)\n\t\
15891   ${if def:sender_address \
15892   {(envelope-from <$sender_address>)\n\t}}\
15893   id $message_exim_id\
15894   ${if def:received_for {\n\tfor $received_for}}
15895 .endd
15896
15897 The reference to the TLS cipher is omitted when Exim is built without TLS
15898 support. The use of conditional expansions ensures that this works for both
15899 locally generated messages and messages received from remote hosts, giving
15900 header lines such as the following:
15901 .code
15902 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
15903 by marley.carol.example with esmtp (Exim 4.00)
15904 (envelope-from <bob@carol.example>)
15905 id 16IOWa-00019l-00
15906 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
15907 Received: by scrooge.carol.example with local (Exim 4.00)
15908 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
15909 .endd
15910 Until the body of the message has been received, the timestamp is the time when
15911 the message started to be received. Once the body has arrived, and all policy
15912 checks have taken place, the timestamp is updated to the time at which the
15913 message was accepted.
15914
15915
15916 .option received_headers_max main integer 30
15917 .cindex "loop" "prevention"
15918 .cindex "mail loop prevention"
15919 .cindex "&'Received:'& header line" "counting"
15920 When a message is to be delivered, the number of &'Received:'& headers is
15921 counted, and if it is greater than this parameter, a mail loop is assumed to
15922 have occurred, the delivery is abandoned, and an error message is generated.
15923 This applies to both local and remote deliveries.
15924
15925
15926 .option recipient_unqualified_hosts main "host list&!!" unset
15927 .cindex "unqualified addresses"
15928 .cindex "host" "unqualified addresses from"
15929 This option lists those hosts from which Exim is prepared to accept unqualified
15930 recipient addresses in message envelopes. The addresses are made fully
15931 qualified by the addition of the &%qualify_recipient%& value. This option also
15932 affects message header lines. Exim does not reject unqualified recipient
15933 addresses in headers, but it qualifies them only if the message came from a
15934 host that matches &%recipient_unqualified_hosts%&,
15935 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
15936 option was not set.
15937
15938
15939 .option recipients_max main integer 0
15940 .cindex "limit" "number of recipients"
15941 .cindex "recipient" "maximum number"
15942 If this option is set greater than zero, it specifies the maximum number of
15943 original recipients for any message. Additional recipients that are generated
15944 by aliasing or forwarding do not count. SMTP messages get a 452 response for
15945 all recipients over the limit; earlier recipients are delivered as normal.
15946 Non-SMTP messages with too many recipients are failed, and no deliveries are
15947 done.
15948
15949 .cindex "RCPT" "maximum number of incoming"
15950 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
15951 RCPT commands in a single message.
15952
15953
15954 .option recipients_max_reject main boolean false
15955 If this option is set true, Exim rejects SMTP messages containing too many
15956 recipients by giving 552 errors to the surplus RCPT commands, and a 554
15957 error to the eventual DATA command. Otherwise (the default) it gives a 452
15958 error to the surplus RCPT commands and accepts the message on behalf of the
15959 initial set of recipients. The remote server should then re-send the message
15960 for the remaining recipients at a later time.
15961
15962
15963 .option remote_max_parallel main integer 2
15964 .cindex "delivery" "parallelism for remote"
15965 This option controls parallel delivery of one message to a number of remote
15966 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
15967 does all the remote deliveries for a message one by one. Otherwise, if a single
15968 message has to be delivered to more than one remote host, or if several copies
15969 have to be sent to the same remote host, up to &%remote_max_parallel%&
15970 deliveries are done simultaneously. If more than &%remote_max_parallel%&
15971 deliveries are required, the maximum number of processes are started, and as
15972 each one finishes, another is begun. The order of starting processes is the
15973 same as if sequential delivery were being done, and can be controlled by the
15974 &%remote_sort_domains%& option. If parallel delivery takes place while running
15975 with debugging turned on, the debugging output from each delivery process is
15976 tagged with its process id.
15977
15978 This option controls only the maximum number of parallel deliveries for one
15979 message in one Exim delivery process. Because Exim has no central queue
15980 manager, there is no way of controlling the total number of simultaneous
15981 deliveries if the configuration allows a delivery attempt as soon as a message
15982 is received.
15983
15984 .cindex "number of deliveries"
15985 .cindex "delivery" "maximum number of"
15986 If you want to control the total number of deliveries on the system, you
15987 need to set the &%queue_only%& option. This ensures that all incoming messages
15988 are added to the queue without starting a delivery process. Then set up an Exim
15989 daemon to start queue runner processes at appropriate intervals (probably
15990 fairly often, for example, every minute), and limit the total number of queue
15991 runners by setting the &%queue_run_max%& parameter. Because each queue runner
15992 delivers only one message at a time, the maximum number of deliveries that can
15993 then take place at once is &%queue_run_max%& multiplied by
15994 &%remote_max_parallel%&.
15995
15996 If it is purely remote deliveries you want to control, use
15997 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
15998 doing the SMTP routing before queueing, so that several messages for the same
15999 host will eventually get delivered down the same connection.
16000
16001
16002 .option remote_sort_domains main "domain list&!!" unset
16003 .cindex "sorting remote deliveries"
16004 .cindex "delivery" "sorting remote"
16005 When there are a number of remote deliveries for a message, they are sorted by
16006 domain into the order given by this list. For example,
16007 .code
16008 remote_sort_domains = *.cam.ac.uk:*.uk
16009 .endd
16010 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
16011 then to those in the &%uk%& domain, then to any others.
16012
16013
16014 .option retry_data_expire main time 7d
16015 .cindex "hints database" "data expiry"
16016 This option sets a &"use before"& time on retry information in Exim's hints
16017 database. Any older retry data is ignored. This means that, for example, once a
16018 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
16019 past failures.
16020
16021
16022 .option retry_interval_max main time 24h
16023 .cindex "retry" "limit on interval"
16024 .cindex "limit" "on retry interval"
16025 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
16026 intervals between delivery attempts for messages that cannot be delivered
16027 straight away. This option sets an overall limit to the length of time between
16028 retries. It cannot be set greater than 24 hours; any attempt to do so forces
16029 the default value.
16030
16031
16032 .option return_path_remove main boolean true
16033 .cindex "&'Return-path:'& header line" "removing"
16034 RFC 2821, section 4.4, states that an SMTP server must insert a
16035 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
16036 The &'Return-path:'& header preserves the sender address as received in the
16037 MAIL command. This description implies that this header should not be present
16038 in an incoming message. If &%return_path_remove%& is true, any existing
16039 &'Return-path:'& headers are removed from messages at the time they are
16040 received. Exim's transports have options for adding &'Return-path:'& headers at
16041 the time of delivery. They are normally used only for final local deliveries.
16042
16043
16044 .option return_size_limit main integer 100K
16045 This option is an obsolete synonym for &%bounce_return_size_limit%&.
16046
16047
16048 .option rfc1413_hosts main "host list&!!" @[]
16049 .cindex "RFC 1413"
16050 .cindex "host" "for RFC 1413 calls"
16051 RFC 1413 identification calls are made to any client host which matches
16052 an item in the list.
16053 The default value specifies just this host, being any local interface
16054 for the system.
16055
16056 .option rfc1413_query_timeout main time 0s
16057 .cindex "RFC 1413" "query timeout"
16058 .cindex "timeout" "for RFC 1413 call"
16059 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
16060 no RFC 1413 calls are ever made.
16061
16062
16063 .option sender_unqualified_hosts main "host list&!!" unset
16064 .cindex "unqualified addresses"
16065 .cindex "host" "unqualified addresses from"
16066 This option lists those hosts from which Exim is prepared to accept unqualified
16067 sender addresses. The addresses are made fully qualified by the addition of
16068 &%qualify_domain%&. This option also affects message header lines. Exim does
16069 not reject unqualified addresses in headers that contain sender addresses, but
16070 it qualifies them only if the message came from a host that matches
16071 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
16072 using TCP/IP), and the &%-bnq%& option was not set.
16073
16074
16075 .option slow_lookup_log main integer 0
16076 .cindex "logging" "slow lookups"
16077 .cindex "dns" "logging slow lookups"
16078 This option controls logging of slow lookups.
16079 If the value is nonzero it is taken as a number of milliseconds
16080 and lookups taking longer than this are logged.
16081 Currently this applies only to DNS lookups.
16082
16083
16084
16085 .option smtp_accept_keepalive main boolean true
16086 .cindex "keepalive" "on incoming connection"
16087 This option controls the setting of the SO_KEEPALIVE option on incoming
16088 TCP/IP socket connections. When set, it causes the kernel to probe idle
16089 connections periodically, by sending packets with &"old"& sequence numbers. The
16090 other end of the connection should send an acknowledgment if the connection is
16091 still okay or a reset if the connection has been aborted. The reason for doing
16092 this is that it has the beneficial effect of freeing up certain types of
16093 connection that can get stuck when the remote host is disconnected without
16094 tidying up the TCP/IP call properly. The keepalive mechanism takes several
16095 hours to detect unreachable hosts.
16096
16097
16098
16099 .option smtp_accept_max main integer 20
16100 .cindex "limit" "incoming SMTP connections"
16101 .cindex "SMTP" "incoming connection count"
16102 .cindex "inetd"
16103 This option specifies the maximum number of simultaneous incoming SMTP calls
16104 that Exim will accept. It applies only to the listening daemon; there is no
16105 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
16106 value is set to zero, no limit is applied. However, it is required to be
16107 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
16108 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
16109
16110 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
16111 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
16112 that limit has not been reached for the client host, &%smtp_accept_reserve%&
16113 and &%smtp_load_reserve%& are then checked before accepting the connection.
16114
16115
16116 .option smtp_accept_max_nonmail main integer 10
16117 .cindex "limit" "non-mail SMTP commands"
16118 .cindex "SMTP" "limiting non-mail commands"
16119 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
16120 the connection if there are too many. This option defines &"too many"&. The
16121 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
16122 client looping sending EHLO, for example. The check is applied only if the
16123 client host matches &%smtp_accept_max_nonmail_hosts%&.
16124
16125 When a new message is expected, one occurrence of RSET is not counted. This
16126 allows a client to send one RSET between messages (this is not necessary,
16127 but some clients do it). Exim also allows one uncounted occurrence of HELO
16128 or EHLO, and one occurrence of STARTTLS between messages. After
16129 starting up a TLS session, another EHLO is expected, and so it too is not
16130 counted. The first occurrence of AUTH in a connection, or immediately
16131 following STARTTLS is not counted. Otherwise, all commands other than
16132 MAIL, RCPT, DATA, and QUIT are counted.
16133
16134
16135 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
16136 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
16137 check by setting this option. The default value makes it apply to all hosts. By
16138 changing the value, you can exclude any badly-behaved hosts that you have to
16139 live with.
16140
16141
16142 . Allow this long option name to split; give it unsplit as a fifth argument
16143 . for the automatic .oindex that is generated by .option.
16144 . We insert " &~&~" which is both pretty nasty visually and results in
16145 . non-searchable text.  HowItWorks.txt mentions an option for inserting
16146 . zero-width-space, which would be nicer visually and results in (at least)
16147 . html that Firefox will split on when it's forced to reflow (rather than
16148 . inserting a horizontal scrollbar).  However, the text is still not
16149 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
16150 . the option name to split.
16151
16152 .option "smtp_accept_max_per_connection" main integer 1000 &&&
16153          smtp_accept_max_per_connection
16154 .cindex "SMTP" "limiting incoming message count"
16155 .cindex "limit" "messages per SMTP connection"
16156 The value of this option limits the number of MAIL commands that Exim is
16157 prepared to accept over a single SMTP connection, whether or not each command
16158 results in the transfer of a message. After the limit is reached, a 421
16159 response is given to subsequent MAIL commands. This limit is a safety
16160 precaution against a client that goes mad (incidents of this type have been
16161 seen).
16162
16163
16164 .option smtp_accept_max_per_host main string&!! unset
16165 .cindex "limit" "SMTP connections from one host"
16166 .cindex "host" "limiting SMTP connections from"
16167 This option restricts the number of simultaneous IP connections from a single
16168 host (strictly, from a single IP address) to the Exim daemon. The option is
16169 expanded, to enable different limits to be applied to different hosts by
16170 reference to &$sender_host_address$&. Once the limit is reached, additional
16171 connection attempts from the same host are rejected with error code 421. This
16172 is entirely independent of &%smtp_accept_reserve%&. The option's default value
16173 of zero imposes no limit. If this option is set greater than zero, it is
16174 required that &%smtp_accept_max%& be non-zero.
16175
16176 &*Warning*&: When setting this option you should not use any expansion
16177 constructions that take an appreciable amount of time. The expansion and test
16178 happen in the main daemon loop, in order to reject additional connections
16179 without forking additional processes (otherwise a denial-of-service attack
16180 could cause a vast number or processes to be created). While the daemon is
16181 doing this processing, it cannot accept any other incoming connections.
16182
16183
16184
16185 .option smtp_accept_queue main integer 0
16186 .cindex "SMTP" "incoming connection count"
16187 .cindex "queueing incoming messages"
16188 .cindex "message" "queueing by SMTP connection count"
16189 If the number of simultaneous incoming SMTP connections being handled via the
16190 listening daemon exceeds this value, messages received by SMTP are just placed
16191 on the queue; no delivery processes are started automatically. The count is
16192 fixed at the start of an SMTP connection. It cannot be updated in the
16193 subprocess that receives messages, and so the queueing or not queueing applies
16194 to all messages received in the same connection.
16195
16196 A value of zero implies no limit, and clearly any non-zero value is useful only
16197 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
16198 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
16199 various &%-od%&&'x'& command line options.
16200
16201
16202 . See the comment on smtp_accept_max_per_connection
16203
16204 .option "smtp_accept_queue_per_connection" main integer 10 &&&
16205          smtp_accept_queue_per_connection
16206 .cindex "queueing incoming messages"
16207 .cindex "message" "queueing by message count"
16208 This option limits the number of delivery processes that Exim starts
16209 automatically when receiving messages via SMTP, whether via the daemon or by
16210 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
16211 and the number of messages received in a single SMTP session exceeds this
16212 number, subsequent messages are placed on the queue, but no delivery processes
16213 are started. This helps to limit the number of Exim processes when a server
16214 restarts after downtime and there is a lot of mail waiting for it on other
16215 systems. On large systems, the default should probably be increased, and on
16216 dial-in client systems it should probably be set to zero (that is, disabled).
16217
16218
16219 .option smtp_accept_reserve main integer 0
16220 .cindex "SMTP" "incoming call count"
16221 .cindex "host" "reserved"
16222 When &%smtp_accept_max%& is set greater than zero, this option specifies a
16223 number of SMTP connections that are reserved for connections from the hosts
16224 that are specified in &%smtp_reserve_hosts%&. The value set in
16225 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
16226 restricted to this number of connections; the option specifies a minimum number
16227 of connection slots for them, not a maximum. It is a guarantee that this group
16228 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
16229 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
16230 individual host.
16231
16232 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
16233 set to 5, once there are 45 active connections (from any hosts), new
16234 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
16235 provided the other criteria for acceptance are met.
16236
16237
16238 .option smtp_active_hostname main string&!! unset
16239 .cindex "host" "name in SMTP responses"
16240 .cindex "SMTP" "host name in responses"
16241 .vindex "&$primary_hostname$&"
16242 This option is provided for multi-homed servers that want to masquerade as
16243 several different hosts. At the start of an incoming SMTP connection, its value
16244 is expanded and used instead of the value of &$primary_hostname$& in SMTP
16245 responses. For example, it is used as domain name in the response to an
16246 incoming HELO or EHLO command.
16247
16248 .vindex "&$smtp_active_hostname$&"
16249 The active hostname is placed in the &$smtp_active_hostname$& variable, which
16250 is saved with any messages that are received. It is therefore available for use
16251 in routers and transports when the message is later delivered.
16252
16253 If this option is unset, or if its expansion is forced to fail, or if the
16254 expansion results in an empty string, the value of &$primary_hostname$& is
16255 used. Other expansion failures cause a message to be written to the main and
16256 panic logs, and the SMTP command receives a temporary error. Typically, the
16257 value of &%smtp_active_hostname%& depends on the incoming interface address.
16258 For example:
16259 .code
16260 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
16261   {cox.mydomain}{box.mydomain}}
16262 .endd
16263
16264 Although &$smtp_active_hostname$& is primarily concerned with incoming
16265 messages, it is also used as the default for HELO commands in callout
16266 verification if there is no remote transport from which to obtain a
16267 &%helo_data%& value.
16268
16269 .option smtp_banner main string&!! "see below"
16270 .cindex "SMTP" "welcome banner"
16271 .cindex "banner for SMTP"
16272 .cindex "welcome banner for SMTP"
16273 .cindex "customizing" "SMTP banner"
16274 This string, which is expanded every time it is used, is output as the initial
16275 positive response to an SMTP connection. The default setting is:
16276 .code
16277 smtp_banner = $smtp_active_hostname ESMTP Exim \
16278   $version_number $tod_full
16279 .endd
16280 Failure to expand the string causes a panic error. If you want to create a
16281 multiline response to the initial SMTP connection, use &"\n"& in the string at
16282 appropriate points, but not at the end. Note that the 220 code is not included
16283 in this string. Exim adds it automatically (several times in the case of a
16284 multiline response).
16285
16286
16287 .option smtp_check_spool_space main boolean true
16288 .cindex "checking disk space"
16289 .cindex "disk space, checking"
16290 .cindex "spool directory" "checking space"
16291 When this option is set, if an incoming SMTP session encounters the SIZE
16292 option on a MAIL command, it checks that there is enough space in the
16293 spool directory's partition to accept a message of that size, while still
16294 leaving free the amount specified by &%check_spool_space%& (even if that value
16295 is zero). If there isn't enough space, a temporary error code is returned.
16296
16297
16298 .option smtp_connect_backlog main integer 20
16299 .cindex "connection backlog"
16300 .cindex "SMTP" "connection backlog"
16301 .cindex "backlog of connections"
16302 This option specifies a maximum number of waiting SMTP connections. Exim passes
16303 this value to the TCP/IP system when it sets up its listener. Once this number
16304 of connections are waiting for the daemon's attention, subsequent connection
16305 attempts are refused at the TCP/IP level. At least, that is what the manuals
16306 say; in some circumstances such connection attempts have been observed to time
16307 out instead. For large systems it is probably a good idea to increase the
16308 value (to 50, say). It also gives some protection against denial-of-service
16309 attacks by SYN flooding.
16310
16311
16312 .option smtp_enforce_sync main boolean true
16313 .cindex "SMTP" "synchronization checking"
16314 .cindex "synchronization checking in SMTP"
16315 The SMTP protocol specification requires the client to wait for a response from
16316 the server at certain points in the dialogue. Without PIPELINING these
16317 synchronization points are after every command; with PIPELINING they are
16318 fewer, but they still exist.
16319
16320 Some spamming sites send out a complete set of SMTP commands without waiting
16321 for any response. Exim protects against this by rejecting a message if the
16322 client has sent further input when it should not have. The error response &"554
16323 SMTP synchronization error"& is sent, and the connection is dropped. Testing
16324 for this error cannot be perfect because of transmission delays (unexpected
16325 input may be on its way but not yet received when Exim checks). However, it
16326 does detect many instances.
16327
16328 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
16329 If you want to disable the check selectively (for example, only for certain
16330 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
16331 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
16332
16333
16334
16335 .option smtp_etrn_command main string&!! unset
16336 .cindex "ETRN" "command to be run"
16337 .vindex "&$domain$&"
16338 If this option is set, the given command is run whenever an SMTP ETRN
16339 command is received from a host that is permitted to issue such commands (see
16340 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
16341 are independently expanded. The expansion variable &$domain$& is set to the
16342 argument of the ETRN command, and no syntax checking is done on it. For
16343 example:
16344 .code
16345 smtp_etrn_command = /etc/etrn_command $domain \
16346                     $sender_host_address
16347 .endd
16348 A new process is created to run the command, but Exim does not wait for it to
16349 complete. Consequently, its status cannot be checked. If the command cannot be
16350 run, a line is written to the panic log, but the ETRN caller still receives
16351 a 250 success response. Exim is normally running under its own uid when
16352 receiving SMTP, so it is not possible for it to change the uid before running
16353 the command.
16354
16355
16356 .option smtp_etrn_serialize main boolean true
16357 .cindex "ETRN" "serializing"
16358 When this option is set, it prevents the simultaneous execution of more than
16359 one identical command as a result of ETRN in an SMTP connection. See
16360 section &<<SECTETRN>>& for details.
16361
16362
16363 .option smtp_load_reserve main fixed-point unset
16364 .cindex "load average"
16365 If the system load average ever gets higher than this, incoming SMTP calls are
16366 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
16367 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
16368 the load is over the limit. The option has no effect on ancient operating
16369 systems on which Exim cannot determine the load average. See also
16370 &%deliver_queue_load_max%& and &%queue_only_load%&.
16371
16372
16373
16374 .option smtp_max_synprot_errors main integer 3
16375 .cindex "SMTP" "limiting syntax and protocol errors"
16376 .cindex "limit" "SMTP syntax and protocol errors"
16377 Exim rejects SMTP commands that contain syntax or protocol errors. In
16378 particular, a syntactically invalid email address, as in this command:
16379 .code
16380 RCPT TO:<abc xyz@a.b.c>
16381 .endd
16382 causes immediate rejection of the command, before any other tests are done.
16383 (The ACL cannot be run if there is no valid address to set up for it.) An
16384 example of a protocol error is receiving RCPT before MAIL. If there are
16385 too many syntax or protocol errors in one SMTP session, the connection is
16386 dropped. The limit is set by this option.
16387
16388 .cindex "PIPELINING" "expected errors"
16389 When the PIPELINING extension to SMTP is in use, some protocol errors are
16390 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
16391 Exim assumes that PIPELINING will be used if it advertises it (see
16392 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
16393 not count towards the limit.
16394
16395
16396
16397 .option smtp_max_unknown_commands main integer 3
16398 .cindex "SMTP" "limiting unknown commands"
16399 .cindex "limit" "unknown SMTP commands"
16400 If there are too many unrecognized commands in an incoming SMTP session, an
16401 Exim server drops the connection. This is a defence against some kinds of abuse
16402 that subvert web
16403 clients
16404 into making connections to SMTP ports; in these circumstances, a number of
16405 non-SMTP command lines are sent first.
16406
16407
16408
16409 .option smtp_ratelimit_hosts main "host list&!!" unset
16410 .cindex "SMTP" "rate limiting"
16411 .cindex "limit" "rate of message arrival"
16412 .cindex "RCPT" "rate limiting"
16413 Some sites find it helpful to be able to limit the rate at which certain hosts
16414 can send them messages, and the rate at which an individual message can specify
16415 recipients.
16416
16417 Exim has two rate-limiting facilities. This section describes the older
16418 facility, which can limit rates within a single connection. The newer
16419 &%ratelimit%& ACL condition can limit rates across all connections. See section
16420 &<<SECTratelimiting>>& for details of the newer facility.
16421
16422 When a host matches &%smtp_ratelimit_hosts%&, the values of
16423 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
16424 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
16425 respectively. Each option, if set, must contain a set of four comma-separated
16426 values:
16427
16428 .ilist
16429 A threshold, before which there is no rate limiting.
16430 .next
16431 An initial time delay. Unlike other times in Exim, numbers with decimal
16432 fractional parts are allowed here.
16433 .next
16434 A factor by which to increase the delay each time.
16435 .next
16436 A maximum value for the delay. This should normally be less than 5 minutes,
16437 because after that time, the client is liable to timeout the SMTP command.
16438 .endlist
16439
16440 For example, these settings have been used successfully at the site which
16441 first suggested this feature, for controlling mail from their customers:
16442 .code
16443 smtp_ratelimit_mail = 2,0.5s,1.05,4m
16444 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
16445 .endd
16446 The first setting specifies delays that are applied to MAIL commands after
16447 two have been received over a single connection. The initial delay is 0.5
16448 seconds, increasing by a factor of 1.05 each time. The second setting applies
16449 delays to RCPT commands when more than four occur in a single message.
16450
16451
16452 .option smtp_ratelimit_mail main string unset
16453 See &%smtp_ratelimit_hosts%& above.
16454
16455
16456 .option smtp_ratelimit_rcpt main string unset
16457 See &%smtp_ratelimit_hosts%& above.
16458
16459
16460 .option smtp_receive_timeout main time&!! 5m
16461 .cindex "timeout" "for SMTP input"
16462 .cindex "SMTP" "input timeout"
16463 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
16464 input, including batch SMTP. If a line of input (either an SMTP command or a
16465 data line) is not received within this time, the SMTP connection is dropped and
16466 the message is abandoned.
16467 A line is written to the log containing one of the following messages:
16468 .code
16469 SMTP command timeout on connection from...
16470 SMTP data timeout on connection from...
16471 .endd
16472 The former means that Exim was expecting to read an SMTP command; the latter
16473 means that it was in the DATA phase, reading the contents of a message.
16474
16475 If the first character of the option is a &"$"& the option is
16476 expanded before use and may depend on
16477 &$sender_host_name$&, &$sender_host_address$& and &$sender_host_port$&.
16478
16479
16480 .oindex "&%-os%&"
16481 The value set by this option can be overridden by the
16482 &%-os%& command-line option. A setting of zero time disables the timeout, but
16483 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
16484 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
16485 timeout is controlled by &%receive_timeout%& and &%-or%&.
16486
16487
16488 .option smtp_reserve_hosts main "host list&!!" unset
16489 This option defines hosts for which SMTP connections are reserved; see
16490 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
16491
16492
16493 .option smtp_return_error_details main boolean false
16494 .cindex "SMTP" "details policy failures"
16495 .cindex "policy control" "rejection, returning details"
16496 In the default state, Exim uses bland messages such as
16497 &"Administrative prohibition"& when it rejects SMTP commands for policy
16498 reasons. Many sysadmins like this because it gives away little information
16499 to spammers. However, some other sysadmins who are applying strict checking
16500 policies want to give out much fuller information about failures. Setting
16501 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
16502 example, instead of &"Administrative prohibition"&, it might give:
16503 .code
16504 550-Rejected after DATA: '>' missing at end of address:
16505 550 failing address in "From" header is: <user@dom.ain
16506 .endd
16507
16508
16509 .new
16510 .option smtputf8_advertise_hosts main "host list&!!" *
16511 .cindex "SMTPUTF8" "advertising"
16512 When Exim is built with support for internationalised mail names,
16513 the availability therof is advertised in
16514 response to EHLO only to those client hosts that match this option. See
16515 chapter &<<CHAPi18n>>& for details of Exim's support for internationalisation.
16516 .wen
16517
16518
16519 .option spamd_address main string "see below"
16520 This option is available when Exim is compiled with the content-scanning
16521 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
16522 The default value is
16523 .code
16524 127.0.0.1 783
16525 .endd
16526 See section &<<SECTscanspamass>>& for more details.
16527
16528
16529
16530 .option split_spool_directory main boolean false
16531 .cindex "multiple spool directories"
16532 .cindex "spool directory" "split"
16533 .cindex "directories, multiple"
16534 If this option is set, it causes Exim to split its input directory into 62
16535 subdirectories, each with a single alphanumeric character as its name. The
16536 sixth character of the message id is used to allocate messages to
16537 subdirectories; this is the least significant base-62 digit of the time of
16538 arrival of the message.
16539
16540 Splitting up the spool in this way may provide better performance on systems
16541 where there are long mail queues, by reducing the number of files in any one
16542 directory. The msglog directory is also split up in a similar way to the input
16543 directory; however, if &%preserve_message_logs%& is set, all old msglog files
16544 are still placed in the single directory &_msglog.OLD_&.
16545
16546 It is not necessary to take any special action for existing messages when
16547 changing &%split_spool_directory%&. Exim notices messages that are in the
16548 &"wrong"& place, and continues to process them. If the option is turned off
16549 after a period of being on, the subdirectories will eventually empty and be
16550 automatically deleted.
16551
16552 When &%split_spool_directory%& is set, the behaviour of queue runner processes
16553 changes. Instead of creating a list of all messages in the queue, and then
16554 trying to deliver each one in turn, it constructs a list of those in one
16555 sub-directory and tries to deliver them, before moving on to the next
16556 sub-directory. The sub-directories are processed in a random order. This
16557 spreads out the scanning of the input directories, and uses less memory. It is
16558 particularly beneficial when there are lots of messages on the queue. However,
16559 if &%queue_run_in_order%& is set, none of this new processing happens. The
16560 entire queue has to be scanned and sorted before any deliveries can start.
16561
16562
16563 .option spool_directory main string&!! "set at compile time"
16564 .cindex "spool directory" "path to"
16565 This defines the directory in which Exim keeps its spool, that is, the messages
16566 it is waiting to deliver. The default value is taken from the compile-time
16567 configuration setting, if there is one. If not, this option must be set. The
16568 string is expanded, so it can contain, for example, a reference to
16569 &$primary_hostname$&.
16570
16571 If the spool directory name is fixed on your installation, it is recommended
16572 that you set it at build time rather than from this option, particularly if the
16573 log files are being written to the spool directory (see &%log_file_path%&).
16574 Otherwise log files cannot be used for errors that are detected early on, such
16575 as failures in the configuration file.
16576
16577 By using this option to override the compiled-in path, it is possible to run
16578 tests of Exim without using the standard spool.
16579
16580 .option sqlite_lock_timeout main time 5s
16581 .cindex "sqlite lookup type" "lock timeout"
16582 This option controls the timeout that the &(sqlite)& lookup uses when trying to
16583 access an SQLite database. See section &<<SECTsqlite>>& for more details.
16584
16585 .option strict_acl_vars main boolean false
16586 .cindex "&ACL;" "variables, handling unset"
16587 This option controls what happens if a syntactically valid but undefined ACL
16588 variable is referenced. If it is false (the default), an empty string
16589 is substituted; if it is true, an error is generated. See section
16590 &<<SECTaclvariables>>& for details of ACL variables.
16591
16592 .option strip_excess_angle_brackets main boolean false
16593 .cindex "angle brackets, excess"
16594 If this option is set, redundant pairs of angle brackets round &"route-addr"&
16595 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
16596 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
16597 passed on to another MTA, the excess angle brackets are not passed on. If this
16598 option is not set, multiple pairs of angle brackets cause a syntax error.
16599
16600
16601 .option strip_trailing_dot main boolean false
16602 .cindex "trailing dot on domain"
16603 .cindex "dot" "trailing on domain"
16604 If this option is set, a trailing dot at the end of a domain in an address is
16605 ignored. If this is in the envelope and the message is passed on to another
16606 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
16607 domain causes a syntax error.
16608 However, addresses in header lines are checked only when an ACL requests header
16609 syntax checking.
16610
16611
16612 .option syslog_duplication main boolean true
16613 .cindex "syslog" "duplicate log lines; suppressing"
16614 When Exim is logging to syslog, it writes the log lines for its three
16615 separate logs at different syslog priorities so that they can in principle
16616 be separated on the logging hosts. Some installations do not require this
16617 separation, and in those cases, the duplication of certain log lines is a
16618 nuisance. If &%syslog_duplication%& is set false, only one copy of any
16619 particular log line is written to syslog. For lines that normally go to
16620 both the main log and the reject log, the reject log version (possibly
16621 containing message header lines) is written, at LOG_NOTICE priority.
16622 Lines that normally go to both the main and the panic log are written at
16623 the LOG_ALERT priority.
16624
16625
16626 .option syslog_facility main string unset
16627 .cindex "syslog" "facility; setting"
16628 This option sets the syslog &"facility"& name, used when Exim is logging to
16629 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
16630 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
16631 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
16632 details of Exim's logging.
16633
16634
16635
16636 .option syslog_processname main string &`exim`&
16637 .cindex "syslog" "process name; setting"
16638 This option sets the syslog &"ident"& name, used when Exim is logging to
16639 syslog. The value must be no longer than 32 characters. See chapter
16640 &<<CHAPlog>>& for details of Exim's logging.
16641
16642
16643
16644 .option syslog_timestamp main boolean true
16645 .cindex "syslog" "timestamps"
16646 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
16647 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
16648 details of Exim's logging.
16649
16650
16651 .option system_filter main string&!! unset
16652 .cindex "filter" "system filter"
16653 .cindex "system filter" "specifying"
16654 .cindex "Sieve filter" "not available for system filter"
16655 This option specifies an Exim filter file that is applied to all messages at
16656 the start of each delivery attempt, before any routing is done. System filters
16657 must be Exim filters; they cannot be Sieve filters. If the system filter
16658 generates any deliveries to files or pipes, or any new mail messages, the
16659 appropriate &%system_filter_..._transport%& option(s) must be set, to define
16660 which transports are to be used. Details of this facility are given in chapter
16661 &<<CHAPsystemfilter>>&.
16662
16663
16664 .option system_filter_directory_transport main string&!! unset
16665 .vindex "&$address_file$&"
16666 This sets the name of the transport driver that is to be used when the
16667 &%save%& command in a system message filter specifies a path ending in &"/"&,
16668 implying delivery of each message into a separate file in some directory.
16669 During the delivery, the variable &$address_file$& contains the path name.
16670
16671
16672 .option system_filter_file_transport main string&!! unset
16673 .cindex "file" "transport for system filter"
16674 This sets the name of the transport driver that is to be used when the &%save%&
16675 command in a system message filter specifies a path not ending in &"/"&. During
16676 the delivery, the variable &$address_file$& contains the path name.
16677
16678 .option system_filter_group main string unset
16679 .cindex "gid (group id)" "system filter"
16680 This option is used only when &%system_filter_user%& is also set. It sets the
16681 gid under which the system filter is run, overriding any gid that is associated
16682 with the user. The value may be numerical or symbolic.
16683
16684 .option system_filter_pipe_transport main string&!! unset
16685 .cindex "&(pipe)& transport" "for system filter"
16686 .vindex "&$address_pipe$&"
16687 This specifies the transport driver that is to be used when a &%pipe%& command
16688 is used in a system filter. During the delivery, the variable &$address_pipe$&
16689 contains the pipe command.
16690
16691
16692 .option system_filter_reply_transport main string&!! unset
16693 .cindex "&(autoreply)& transport" "for system filter"
16694 This specifies the transport driver that is to be used when a &%mail%& command
16695 is used in a system filter.
16696
16697
16698 .option system_filter_user main string unset
16699 .cindex "uid (user id)" "system filter"
16700 If this option is set to root, the system filter is run in the main Exim
16701 delivery process, as root.  Otherwise, the system filter runs in a separate
16702 process, as the given user, defaulting to the Exim run-time user.
16703 Unless the string consists entirely of digits, it
16704 is looked up in the password data. Failure to find the named user causes a
16705 configuration error. The gid is either taken from the password data, or
16706 specified by &%system_filter_group%&. When the uid is specified numerically,
16707 &%system_filter_group%& is required to be set.
16708
16709 If the system filter generates any pipe, file, or reply deliveries, the uid
16710 under which the filter is run is used when transporting them, unless a
16711 transport option overrides.
16712
16713
16714 .option tcp_nodelay main boolean true
16715 .cindex "daemon" "TCP_NODELAY on sockets"
16716 .cindex "Nagle algorithm"
16717 .cindex "TCP_NODELAY on listening sockets"
16718 If this option is set false, it stops the Exim daemon setting the
16719 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
16720 turns off the &"Nagle algorithm"&, which is a way of improving network
16721 performance in interactive (character-by-character) situations. Turning it off
16722 should improve Exim's performance a bit, so that is what happens by default.
16723 However, it appears that some broken clients cannot cope, and time out. Hence
16724 this option. It affects only those sockets that are set up for listening by the
16725 daemon. Sockets created by the smtp transport for delivering mail always set
16726 TCP_NODELAY.
16727
16728
16729 .option timeout_frozen_after main time 0s
16730 .cindex "frozen messages" "timing out"
16731 .cindex "timeout" "frozen messages"
16732 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
16733 message of any kind that has been on the queue for longer than the given time
16734 is automatically cancelled at the next queue run. If the frozen message is a
16735 bounce message, it is just discarded; otherwise, a bounce is sent to the
16736 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
16737 If you want to timeout frozen bounce messages earlier than other kinds of
16738 frozen message, see &%ignore_bounce_errors_after%&.
16739
16740 &*Note:*& the default value of zero means no timeouts; with this setting,
16741 frozen messages remain on the queue forever (except for any frozen bounce
16742 messages that are released by &%ignore_bounce_errors_after%&).
16743
16744
16745 .option timezone main string unset
16746 .cindex "timezone, setting"
16747 The value of &%timezone%& is used to set the environment variable TZ while
16748 running Exim (if it is different on entry). This ensures that all timestamps
16749 created by Exim are in the required timezone. If you want all your timestamps
16750 to be in UTC (aka GMT) you should set
16751 .code
16752 timezone = UTC
16753 .endd
16754 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
16755 or, if that is not set, from the value of the TZ environment variable when Exim
16756 is built. If &%timezone%& is set to the empty string, either at build or run
16757 time, any existing TZ variable is removed from the environment when Exim
16758 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
16759 unfortunately not all, operating systems.
16760
16761
16762 .new
16763 .option tls_advertise_hosts main "host list&!!" *
16764 .wen
16765 .cindex "TLS" "advertising"
16766 .cindex "encryption" "on SMTP connection"
16767 .cindex "SMTP" "encrypted connection"
16768 When Exim is built with support for TLS encrypted connections, the availability
16769 of the STARTTLS command to set up an encrypted session is advertised in
16770 response to EHLO only to those client hosts that match this option. See
16771 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
16772 .new
16773 Note that the default value requires that a certificate be supplied
16774 using the &%tls_certificate%& option.  If no certificate is available then
16775 the &%tls_advertise_hosts%& option should be set empty.
16776 .wen
16777
16778
16779 .option tls_certificate main string&!! unset
16780 .cindex "TLS" "server certificate; location of"
16781 .cindex "certificate" "server, location of"
16782 The value of this option is expanded, and must then be the absolute path to a
16783 file which contains the server's certificates. The server's private key is also
16784 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
16785 &<<CHAPTLS>>& for further details.
16786
16787 &*Note*&: The certificates defined by this option are used only when Exim is
16788 receiving incoming messages as a server. If you want to supply certificates for
16789 use when sending messages as a client, you must set the &%tls_certificate%&
16790 option in the relevant &(smtp)& transport.
16791
16792 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
16793 if the OpenSSL build supports TLS extensions and the TLS client sends the
16794 Server Name Indication extension, then this option and others documented in
16795 &<<SECTtlssni>>& will be re-expanded.
16796
16797 .option tls_crl main string&!! unset
16798 .cindex "TLS" "server certificate revocation list"
16799 .cindex "certificate" "revocation list for server"
16800 This option specifies a certificate revocation list. The expanded value must
16801 be the name of a file that contains a CRL in PEM format.
16802
16803 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16804
16805
16806 .option tls_dh_max_bits main integer 2236
16807 .cindex "TLS" "D-H bit count"
16808 The number of bits used for Diffie-Hellman key-exchange may be suggested by
16809 the chosen TLS library.  That value might prove to be too high for
16810 interoperability.  This option provides a maximum clamp on the value
16811 suggested, trading off security for interoperability.
16812
16813 The value must be at least 1024.
16814
16815 The value 2236 was chosen because, at time of adding the option, it was the
16816 hard-coded maximum value supported by the NSS cryptographic library, as used
16817 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
16818
16819 If you prefer more security and are willing to break some clients, raise this
16820 number.
16821
16822 Note that the value passed to GnuTLS for *generating* a new prime may be a
16823 little less than this figure, because GnuTLS is inexact and may produce a
16824 larger prime than requested.
16825
16826
16827 .option tls_dhparam main string&!! unset
16828 .cindex "TLS" "D-H parameters for server"
16829 The value of this option is expanded and indicates the source of DH parameters
16830 to be used by Exim.
16831
16832 If it is a filename starting with a &`/`&, then it names a file from which DH
16833 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
16834 PKCS#3 representation of the DH prime.  If the file does not exist, for
16835 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
16836 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
16837 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
16838 and treated as though the &%tls_dhparam%& were set to "none".
16839
16840 If this option expands to the string "none", then no DH parameters will be
16841 loaded by Exim.
16842
16843 If this option expands to the string "historic" and Exim is using GnuTLS, then
16844 Exim will attempt to load a file from inside the spool directory.  If the file
16845 does not exist, Exim will attempt to create it.
16846 See section &<<SECTgnutlsparam>>& for further details.
16847
16848 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
16849 a default DH prime; the default is the 2048 bit prime described in section
16850 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
16851 in IKE is assigned number 23.
16852
16853 Otherwise, the option must expand to the name used by Exim for any of a number
16854 of DH primes specified in RFC 2409, RFC 3526 and RFC 5114.  As names, Exim uses
16855 "ike" followed by the number used by IKE, of "default" which corresponds to
16856 "ike23".
16857
16858 The available primes are:
16859 &`ike1`&, &`ike2`&, &`ike5`&,
16860 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
16861 &`ike22`&, &`ike23`& (aka &`default`&) and &`ike24`&.
16862
16863 Some of these will be too small to be accepted by clients.
16864 Some may be too large to be accepted by clients.
16865
16866 The TLS protocol does not negotiate an acceptable size for this; clients tend
16867 to hard-drop connections if what is offered by the server is unacceptable,
16868 whether too large or too small, and there's no provision for the client to
16869 tell the server what these constraints are.  Thus, as a server operator, you
16870 need to make an educated guess as to what is most likely to work for your
16871 userbase.
16872
16873 Some known size constraints suggest that a bit-size in the range 2048 to 2236
16874 is most likely to maximise interoperability.  The upper bound comes from
16875 applications using the Mozilla Network Security Services (NSS) library, which
16876 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
16877 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
16878 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
16879 acceptable bound from 1024 to 2048.
16880
16881
16882 .option tls_eccurve main string&!! prime256v1
16883 .cindex TLS "EC cryptography"
16884 If built with a recent-enough version of OpenSSL,
16885 this option selects a EC curve for use by Exim.
16886
16887 Curve names of the form &'prime256v1'& are accepted.
16888 For even more-recent library versions, names of the form &'P-512'&
16889 are also accepted, plus the special value &'auto'&
16890 which tell the library to choose.
16891
16892 If the option is set to an empty string, no EC curves will be enabled.
16893
16894
16895 .option tls_ocsp_file main string&!! unset
16896 .cindex TLS "certificate status"
16897 .cindex TLS "OCSP proof file"
16898 This option
16899 must if set expand to the absolute path to a file which contains a current
16900 status proof for the server's certificate, as obtained from the
16901 Certificate Authority.
16902
16903 .new
16904 Usable for GnuTLS 3.4.4 or 3.3.17 or OpenSSL 1.1.0 (or later).
16905 .wen
16906
16907
16908 .option tls_on_connect_ports main "string list" unset
16909 .cindex SSMTP
16910 .cindex SMTPS
16911 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
16912 operate the obsolete SSMTP (SMTPS) protocol, where a TLS session is immediately
16913 set up without waiting for the client to issue a STARTTLS command. For
16914 further details, see section &<<SECTsupobssmt>>&.
16915
16916
16917
16918 .option tls_privatekey main string&!! unset
16919 .cindex "TLS" "server private key; location of"
16920 The value of this option is expanded, and must then be the absolute path to a
16921 file which contains the server's private key. If this option is unset, or if
16922 the expansion is forced to fail, or the result is an empty string, the private
16923 key is assumed to be in the same file as the server's certificates. See chapter
16924 &<<CHAPTLS>>& for further details.
16925
16926 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16927
16928
16929 .option tls_remember_esmtp main boolean false
16930 .cindex "TLS" "esmtp state; remembering"
16931 .cindex "TLS" "broken clients"
16932 If this option is set true, Exim violates the RFCs by remembering that it is in
16933 &"esmtp"& state after successfully negotiating a TLS session. This provides
16934 support for broken clients that fail to send a new EHLO after starting a
16935 TLS session.
16936
16937
16938 .option tls_require_ciphers main string&!! unset
16939 .cindex "TLS" "requiring specific ciphers"
16940 .cindex "cipher" "requiring specific"
16941 This option controls which ciphers can be used for incoming TLS connections.
16942 The &(smtp)& transport has an option of the same name for controlling outgoing
16943 connections. This option is expanded for each connection, so can be varied for
16944 different clients if required. The value of this option must be a list of
16945 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
16946 in somewhat different ways. If GnuTLS is being used, the client controls the
16947 preference order of the available ciphers. Details are given in sections
16948 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
16949
16950
16951 .option tls_try_verify_hosts main "host list&!!" unset
16952 .cindex "TLS" "client certificate verification"
16953 .cindex "certificate" "verification of client"
16954 See &%tls_verify_hosts%& below.
16955
16956
16957 .option tls_verify_certificates main string&!! system
16958 .cindex "TLS" "client certificate verification"
16959 .cindex "certificate" "verification of client"
16960 The value of this option is expanded, and must then be either the
16961 word "system"
16962 or the absolute path to
16963 a file or directory containing permitted certificates for clients that
16964 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&.
16965
16966 The "system" value for the option will use a
16967 system default location compiled into the SSL library.
16968 This is not available for GnuTLS versions preceding 3.0.20,
16969 and will be taken as empty; an explicit location
16970 must be specified.
16971
16972 The use of a directory for the option value is not available for GnuTLS versions
16973 preceding 3.3.6 and a single file must be used.
16974
16975 With OpenSSL the certificates specified
16976 explicitly
16977 either by file or directory
16978 are added to those given by the system default location.
16979
16980 These certificates should be for the certificate authorities trusted, rather
16981 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
16982 the value is a file then the certificates are sent by Exim as a server to
16983 connecting clients, defining the list of accepted certificate authorities.
16984 Thus the values defined should be considered public data.  To avoid this,
16985 use the explicit directory version.
16986
16987 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16988
16989 A forced expansion failure or setting to an empty string is equivalent to
16990 being unset.
16991
16992
16993 .option tls_verify_hosts main "host list&!!" unset
16994 .cindex "TLS" "client certificate verification"
16995 .cindex "certificate" "verification of client"
16996 This option, along with &%tls_try_verify_hosts%&, controls the checking of
16997 certificates from clients. The expected certificates are defined by
16998 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
16999 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
17000 &%tls_verify_certificates%& is not set.
17001
17002 Any client that matches &%tls_verify_hosts%& is constrained by
17003 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
17004 present one of the listed certificates. If it does not, the connection is
17005 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
17006 the host to use TLS. It can still send SMTP commands through unencrypted
17007 connections. Forcing a client to use TLS has to be done separately using an
17008 ACL to reject inappropriate commands when the connection is not encrypted.
17009
17010 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
17011 matches this option (but not &%tls_verify_hosts%&), Exim requests a
17012 certificate and checks it against &%tls_verify_certificates%&, but does not
17013 abort the connection if there is no certificate or if it does not match. This
17014 state can be detected in an ACL, which makes it possible to implement policies
17015 such as &"accept for relay only if a verified certificate has been received,
17016 but accept for local delivery if encrypted, even without a verified
17017 certificate"&.
17018
17019 Client hosts that match neither of these lists are not asked to present
17020 certificates.
17021
17022
17023 .option trusted_groups main "string list&!!" unset
17024 .cindex "trusted groups"
17025 .cindex "groups" "trusted"
17026 This option is expanded just once, at the start of Exim's processing. If this
17027 option is set, any process that is running in one of the listed groups, or
17028 which has one of them as a supplementary group, is trusted. The groups can be
17029 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
17030 details of what trusted callers are permitted to do. If neither
17031 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
17032 are trusted.
17033
17034 .option trusted_users main "string list&!!" unset
17035 .cindex "trusted users"
17036 .cindex "user" "trusted"
17037 This option is expanded just once, at the start of Exim's processing. If this
17038 option is set, any process that is running as one of the listed users is
17039 trusted. The users can be specified numerically or by name. See section
17040 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
17041 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
17042 Exim user are trusted.
17043
17044 .option unknown_login main string&!! unset
17045 .cindex "uid (user id)" "unknown caller"
17046 .vindex "&$caller_uid$&"
17047 This is a specialized feature for use in unusual configurations. By default, if
17048 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
17049 gives up. The &%unknown_login%& option can be used to set a login name to be
17050 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
17051 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
17052 is used for the user's real name (gecos field), unless this has been set by the
17053 &%-F%& option.
17054
17055 .option unknown_username main string unset
17056 See &%unknown_login%&.
17057
17058 .option untrusted_set_sender main "address list&!!" unset
17059 .cindex "trusted users"
17060 .cindex "sender" "setting by untrusted user"
17061 .cindex "untrusted user setting sender"
17062 .cindex "user" "untrusted setting sender"
17063 .cindex "envelope sender"
17064 When an untrusted user submits a message to Exim using the standard input, Exim
17065 normally creates an envelope sender address from the user's login and the
17066 default qualification domain. Data from the &%-f%& option (for setting envelope
17067 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
17068 is used) is ignored.
17069
17070 However, untrusted users are permitted to set an empty envelope sender address,
17071 to declare that a message should never generate any bounces. For example:
17072 .code
17073 exim -f '<>' user@domain.example
17074 .endd
17075 .vindex "&$sender_ident$&"
17076 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
17077 other envelope sender addresses in a controlled way. When it is set, untrusted
17078 users are allowed to set envelope sender addresses that match any of the
17079 patterns in the list. Like all address lists, the string is expanded. The
17080 identity of the user is in &$sender_ident$&, so you can, for example, restrict
17081 users to setting senders that start with their login ids
17082 followed by a hyphen
17083 by a setting like this:
17084 .code
17085 untrusted_set_sender = ^$sender_ident-
17086 .endd
17087 If you want to allow untrusted users to set envelope sender addresses without
17088 restriction, you can use
17089 .code
17090 untrusted_set_sender = *
17091 .endd
17092 The &%untrusted_set_sender%& option applies to all forms of local input, but
17093 only to the setting of the envelope sender. It does not permit untrusted users
17094 to use the other options which trusted user can use to override message
17095 parameters. Furthermore, it does not stop Exim from removing an existing
17096 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
17097 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
17098 overriding these actions. The handling of the &'Sender:'& header is also
17099 described in section &<<SECTthesenhea>>&.
17100
17101 The log line for a message's arrival shows the envelope sender following
17102 &"<="&. For local messages, the user's login always follows, after &"U="&. In
17103 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
17104 envelope sender address, the user's login is shown in parentheses after the
17105 sender address.
17106
17107
17108 .option uucp_from_pattern main string "see below"
17109 .cindex "&""From""& line"
17110 .cindex "UUCP" "&""From""& line"
17111 Some applications that pass messages to an MTA via a command line interface use
17112 an initial line starting with &"From&~"& to pass the envelope sender. In
17113 particular, this is used by UUCP software. Exim recognizes such a line by means
17114 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
17115 matches, the sender address is constructed by expanding the contents of
17116 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
17117 default pattern recognizes lines in the following two forms:
17118 .code
17119 From ph10 Fri Jan  5 12:35 GMT 1996
17120 From ph10 Fri, 7 Jan 97 14:00:00 GMT
17121 .endd
17122 The pattern can be seen by running
17123 .code
17124 exim -bP uucp_from_pattern
17125 .endd
17126 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
17127 year in the second case. The first word after &"From&~"& is matched in the
17128 regular expression by a parenthesized subpattern. The default value for
17129 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
17130 (&"ph10"& in the example above) as the message's sender. See also
17131 &%ignore_fromline_hosts%&.
17132
17133
17134 .option uucp_from_sender main string&!! &`$1`&
17135 See &%uucp_from_pattern%& above.
17136
17137
17138 .option warn_message_file main string unset
17139 .cindex "warning of delay" "customizing the message"
17140 .cindex "customizing" "warning message"
17141 This option defines a template file containing paragraphs of text to be used
17142 for constructing the warning message which is sent by Exim when a message has
17143 been on the queue for a specified amount of time, as specified by
17144 &%delay_warning%&. Details of the file's contents are given in chapter
17145 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
17146
17147
17148 .option write_rejectlog main boolean true
17149 .cindex "reject log" "disabling"
17150 If this option is set false, Exim no longer writes anything to the reject log.
17151 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
17152 .ecindex IIDconfima
17153 .ecindex IIDmaiconf
17154
17155
17156
17157
17158 . ////////////////////////////////////////////////////////////////////////////
17159 . ////////////////////////////////////////////////////////////////////////////
17160
17161 .chapter "Generic options for routers" "CHAProutergeneric"
17162 .scindex IIDgenoprou1 "options" "generic; for routers"
17163 .scindex IIDgenoprou2 "generic options" "router"
17164 This chapter describes the generic options that apply to all routers.
17165 Those that are preconditions are marked with &Dagger; in the &"use"& field.
17166
17167 For a general description of how a router operates, see sections
17168 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
17169 which the preconditions are tested. The order of expansion of the options that
17170 provide data for a transport is: &%errors_to%&, &%headers_add%&,
17171 &%headers_remove%&, &%transport%&.
17172
17173
17174
17175 .option address_data routers string&!! unset
17176 .cindex "router" "data attached to address"
17177 The string is expanded just before the router is run, that is, after all the
17178 precondition tests have succeeded. If the expansion is forced to fail, the
17179 router declines, the value of &%address_data%& remains unchanged, and the
17180 &%more%& option controls what happens next. Other expansion failures cause
17181 delivery of the address to be deferred.
17182
17183 .vindex "&$address_data$&"
17184 When the expansion succeeds, the value is retained with the address, and can be
17185 accessed using the variable &$address_data$& in the current router, subsequent
17186 routers, and the eventual transport.
17187
17188 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
17189 that runs a user's filter file, the contents of &$address_data$& are accessible
17190 in the filter. This is not normally a problem, because such data is usually
17191 either not confidential or it &"belongs"& to the current user, but if you do
17192 put confidential data into &$address_data$& you need to remember this point.
17193
17194 Even if the router declines or passes, the value of &$address_data$& remains
17195 with the address, though it can be changed by another &%address_data%& setting
17196 on a subsequent router. If a router generates child addresses, the value of
17197 &$address_data$& propagates to them. This also applies to the special kind of
17198 &"child"& that is generated by a router with the &%unseen%& option.
17199
17200 The idea of &%address_data%& is that you can use it to look up a lot of data
17201 for the address once, and then pick out parts of the data later. For example,
17202 you could use a single LDAP lookup to return a string of the form
17203 .code
17204 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
17205 .endd
17206 In the transport you could pick out the mailbox by a setting such as
17207 .code
17208 file = ${extract{mailbox}{$address_data}}
17209 .endd
17210 This makes the configuration file less messy, and also reduces the number of
17211 lookups (though Exim does cache lookups).
17212
17213 .vindex "&$sender_address_data$&"
17214 .vindex "&$address_data$&"
17215 The &%address_data%& facility is also useful as a means of passing information
17216 from one router to another, and from a router to a transport. In addition, if
17217 &$address_data$& is set by a router when verifying a recipient address from an
17218 ACL, it remains available for use in the rest of the ACL statement. After
17219 verifying a sender, the value is transferred to &$sender_address_data$&.
17220
17221
17222
17223 .option address_test routers&!? boolean true
17224 .oindex "&%-bt%&"
17225 .cindex "router" "skipping when address testing"
17226 If this option is set false, the router is skipped when routing is being tested
17227 by means of the &%-bt%& command line option. This can be a convenience when
17228 your first router sends messages to an external scanner, because it saves you
17229 having to set the &"already scanned"& indicator when testing real address
17230 routing.
17231
17232
17233
17234 .option cannot_route_message routers string&!! unset
17235 .cindex "router" "customizing &""cannot route""& message"
17236 .cindex "customizing" "&""cannot route""& message"
17237 This option specifies a text message that is used when an address cannot be
17238 routed because Exim has run out of routers. The default message is
17239 &"Unrouteable address"&. This option is useful only on routers that have
17240 &%more%& set false, or on the very last router in a configuration, because the
17241 value that is used is taken from the last router that is considered. This
17242 includes a router that is skipped because its preconditions are not met, as
17243 well as a router that declines. For example, using the default configuration,
17244 you could put:
17245 .code
17246 cannot_route_message = Remote domain not found in DNS
17247 .endd
17248 on the first router, which is a &(dnslookup)& router with &%more%& set false,
17249 and
17250 .code
17251 cannot_route_message = Unknown local user
17252 .endd
17253 on the final router that checks for local users. If string expansion fails for
17254 this option, the default message is used. Unless the expansion failure was
17255 explicitly forced, a message about the failure is written to the main and panic
17256 logs, in addition to the normal message about the routing failure.
17257
17258
17259 .option caseful_local_part routers boolean false
17260 .cindex "case of local parts"
17261 .cindex "router" "case of local parts"
17262 By default, routers handle the local parts of addresses in a case-insensitive
17263 manner, though the actual case is preserved for transmission with the message.
17264 If you want the case of letters to be significant in a router, you must set
17265 this option true. For individual router options that contain address or local
17266 part lists (for example, &%local_parts%&), case-sensitive matching can be
17267 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
17268 more details.
17269
17270 .vindex "&$local_part$&"
17271 .vindex "&$original_local_part$&"
17272 .vindex "&$parent_local_part$&"
17273 The value of the &$local_part$& variable is forced to lower case while a
17274 router is running unless &%caseful_local_part%& is set. When a router assigns
17275 an address to a transport, the value of &$local_part$& when the transport runs
17276 is the same as it was in the router. Similarly, when a router generates child
17277 addresses by aliasing or forwarding, the values of &$original_local_part$&
17278 and &$parent_local_part$& are those that were used by the redirecting router.
17279
17280 This option applies to the processing of an address by a router. When a
17281 recipient address is being processed in an ACL, there is a separate &%control%&
17282 modifier that can be used to specify case-sensitive processing within the ACL
17283 (see section &<<SECTcontrols>>&).
17284
17285
17286
17287 .option check_local_user routers&!? boolean false
17288 .cindex "local user, checking in router"
17289 .cindex "router" "checking for local user"
17290 .cindex "&_/etc/passwd_&"
17291 .vindex "&$home$&"
17292 When this option is true, Exim checks that the local part of the recipient
17293 address (with affixes removed if relevant) is the name of an account on the
17294 local system. The check is done by calling the &[getpwnam()]& function rather
17295 than trying to read &_/etc/passwd_& directly. This means that other methods of
17296 holding password data (such as NIS) are supported. If the local part is a local
17297 user, &$home$& is set from the password data, and can be tested in other
17298 preconditions that are evaluated after this one (the order of evaluation is
17299 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
17300 overridden by &%router_home_directory%&. If the local part is not a local user,
17301 the router is skipped.
17302
17303 If you want to check that the local part is either the name of a local user
17304 or matches something else, you cannot combine &%check_local_user%& with a
17305 setting of &%local_parts%&, because that specifies the logical &'and'& of the
17306 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
17307 setting to achieve this. For example:
17308 .code
17309 local_parts = passwd;$local_part : lsearch;/etc/other/users
17310 .endd
17311 Note, however, that the side effects of &%check_local_user%& (such as setting
17312 up a home directory) do not occur when a &(passwd)& lookup is used in a
17313 &%local_parts%& (or any other) precondition.
17314
17315
17316
17317 .option condition routers&!? string&!! unset
17318 .cindex "router" "customized precondition"
17319 This option specifies a general precondition test that has to succeed for the
17320 router to be called. The &%condition%& option is the last precondition to be
17321 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
17322 result is a forced failure, or an empty string, or one of the strings &"0"& or
17323 &"no"& or &"false"& (checked without regard to the case of the letters), the
17324 router is skipped, and the address is offered to the next one.
17325
17326 If the result is any other value, the router is run (as this is the last
17327 precondition to be evaluated, all the other preconditions must be true).
17328
17329 This option is unusual in that multiple &%condition%& options may be present.
17330 All &%condition%& options must succeed.
17331
17332 The &%condition%& option provides a means of applying custom conditions to the
17333 running of routers. Note that in the case of a simple conditional expansion,
17334 the default expansion values are exactly what is wanted. For example:
17335 .code
17336 condition = ${if >{$message_age}{600}}
17337 .endd
17338 Because of the default behaviour of the string expansion, this is equivalent to
17339 .code
17340 condition = ${if >{$message_age}{600}{true}{}}
17341 .endd
17342
17343 A multiple condition example, which succeeds:
17344 .code
17345 condition = ${if >{$message_age}{600}}
17346 condition = ${if !eq{${lc:$local_part}}{postmaster}}
17347 condition = foobar
17348 .endd
17349
17350 If the expansion fails (other than forced failure) delivery is deferred. Some
17351 of the other precondition options are common special cases that could in fact
17352 be specified using &%condition%&.
17353
17354 Historical note: We have &%condition%& on ACLs and on Routers.  Routers
17355 are far older, and use one set of semantics.  ACLs are newer and when
17356 they were created, the ACL &%condition%& process was given far stricter
17357 parse semantics.  The &%bool{}%& expansion condition uses the same rules as
17358 ACLs.  The &%bool_lax{}%& expansion condition uses the same rules as
17359 Routers.  More pointedly, the &%bool_lax{}%& was written to match the existing
17360 Router rules processing behavior.
17361
17362 This is best illustrated in an example:
17363 .code
17364 # If used in an ACL condition will fail with a syntax error, but
17365 # in a router condition any extra characters are treated as a string
17366
17367 $ exim -be '${if eq {${lc:GOOGLE.com}} {google.com}} {yes} {no}}'
17368 true {yes} {no}}
17369
17370 $ exim -be '${if eq {${lc:WHOIS.com}} {google.com}} {yes} {no}}'
17371  {yes} {no}}
17372 .endd
17373 In each example above, the &%if%& statement actually ends after
17374 &"{google.com}}"&.  Since no true or false braces were defined, the
17375 default &%if%& behavior is to return a boolean true or a null answer
17376 (which evaluates to false). The rest of the line is then treated as a
17377 string. So the first example resulted in the boolean answer &"true"&
17378 with the string &" {yes} {no}}"& appended to it. The second example
17379 resulted in the null output (indicating false) with the string
17380 &" {yes} {no}}"& appended to it.
17381
17382 In fact you can put excess forward braces in too.  In the router
17383 &%condition%&, Exim's parser only looks for &"{"& symbols when they
17384 mean something, like after a &"$"& or when required as part of a
17385 conditional.  But otherwise &"{"& and &"}"& are treated as ordinary
17386 string characters.
17387
17388 Thus, in a Router, the above expansion strings will both always evaluate
17389 true, as the result of expansion is a non-empty string which doesn't
17390 match an explicit false value.  This can be tricky to debug.  By
17391 contrast, in an ACL either of those strings will always result in an
17392 expansion error because the result doesn't look sufficiently boolean.
17393
17394
17395 .option debug_print routers string&!! unset
17396 .cindex "testing" "variables in drivers"
17397 If this option is set and debugging is enabled (see the &%-d%& command line
17398 option) or in address-testing mode (see the &%-bt%& command line option),
17399 the string is expanded and included in the debugging output.
17400 If expansion of the string fails, the error message is written to the debugging
17401 output, and Exim carries on processing.
17402 This option is provided to help with checking out the values of variables and
17403 so on when debugging router configurations. For example, if a &%condition%&
17404 option appears not to be working, &%debug_print%& can be used to output the
17405 variables it references. The output happens after checks for &%domains%&,
17406 &%local_parts%&, and &%check_local_user%& but before any other preconditions
17407 are tested. A newline is added to the text if it does not end with one.
17408 The variable &$router_name$& contains the name of the router.
17409
17410
17411
17412 .option disable_logging routers boolean false
17413 If this option is set true, nothing is logged for any routing errors
17414 or for any deliveries caused by this router. You should not set this option
17415 unless you really, really know what you are doing. See also the generic
17416 transport option of the same name.
17417
17418 .option dnssec_request_domains routers "domain list&!!" unset
17419 .cindex "MX record" "security"
17420 .cindex "DNSSEC" "MX lookup"
17421 .cindex "security" "MX lookup"
17422 .cindex "DNS" "DNSSEC"
17423 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
17424 the dnssec request bit set.
17425 This applies to all of the SRV, MX, AAAA, A lookup sequence.
17426
17427 .option dnssec_require_domains routers "domain list&!!" unset
17428 .cindex "MX record" "security"
17429 .cindex "DNSSEC" "MX lookup"
17430 .cindex "security" "MX lookup"
17431 .cindex "DNS" "DNSSEC"
17432 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
17433 the dnssec request bit set.  Any returns not having the Authenticated Data bit
17434 (AD bit) set will be ignored and logged as a host-lookup failure.
17435 This applies to all of the SRV, MX, AAAA, A lookup sequence.
17436
17437
17438 .option domains routers&!? "domain list&!!" unset
17439 .cindex "router" "restricting to specific domains"
17440 .vindex "&$domain_data$&"
17441 If this option is set, the router is skipped unless the current domain matches
17442 the list. If the match is achieved by means of a file lookup, the data that the
17443 lookup returned for the domain is placed in &$domain_data$& for use in string
17444 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
17445 a list of the order in which preconditions are evaluated.
17446
17447
17448
17449 .option driver routers string unset
17450 This option must always be set. It specifies which of the available routers is
17451 to be used.
17452
17453
17454 .option dsn_lasthop routers boolean false
17455 .cindex "DSN" "success"
17456 .cindex "Delivery Status Notification" "success"
17457 If this option is set true, and extended DSN (RFC3461) processing is in effect,
17458 Exim will not pass on DSN requests to downstream DSN-aware hosts but will
17459 instead send a success DSN as if the next hop does not support DSN.
17460 Not effective on redirect routers.
17461
17462
17463
17464 .option errors_to routers string&!! unset
17465 .cindex "envelope sender"
17466 .cindex "router" "changing address for errors"
17467 If a router successfully handles an address, it may assign the address to a
17468 transport for delivery or it may generate child addresses. In both cases, if
17469 there is a delivery problem during later processing, the resulting bounce
17470 message is sent to the address that results from expanding this string,
17471 provided that the address verifies successfully. The &%errors_to%& option is
17472 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
17473
17474 The &%errors_to%& setting associated with an address can be overridden if it
17475 subsequently passes through other routers that have their own &%errors_to%&
17476 settings, or if the message is delivered by a transport with a &%return_path%&
17477 setting.
17478
17479 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
17480 the expansion fails to verify, the errors address associated with the incoming
17481 address is used. At top level, this is the envelope sender. A non-forced
17482 expansion failure causes delivery to be deferred.
17483
17484 If an address for which &%errors_to%& has been set ends up being delivered over
17485 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
17486 any bounces that are generated by other MTAs on the delivery route are also
17487 sent there. You can set &%errors_to%& to the empty string by either of these
17488 settings:
17489 .code
17490 errors_to =
17491 errors_to = ""
17492 .endd
17493 An expansion item that yields an empty string has the same effect. If you do
17494 this, a locally detected delivery error for addresses processed by this router
17495 no longer gives rise to a bounce message; the error is discarded. If the
17496 address is delivered to a remote host, the return path is set to &`<>`&, unless
17497 overridden by the &%return_path%& option on the transport.
17498
17499 .vindex "&$address_data$&"
17500 If for some reason you want to discard local errors, but use a non-empty
17501 MAIL command for remote delivery, you can preserve the original return
17502 path in &$address_data$& in the router, and reinstate it in the transport by
17503 setting &%return_path%&.
17504
17505 The most common use of &%errors_to%& is to direct mailing list bounces to the
17506 manager of the list, as described in section &<<SECTmailinglists>>&, or to
17507 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
17508
17509
17510
17511 .option expn routers&!? boolean true
17512 .cindex "address" "testing"
17513 .cindex "testing" "addresses"
17514 .cindex "EXPN" "router skipping"
17515 .cindex "router" "skipping for EXPN"
17516 If this option is turned off, the router is skipped when testing an address
17517 as a result of processing an SMTP EXPN command. You might, for example,
17518 want to turn it off on a router for users' &_.forward_& files, while leaving it
17519 on for the system alias file.
17520 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17521 are evaluated.
17522
17523 The use of the SMTP EXPN command is controlled by an ACL (see chapter
17524 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
17525 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
17526
17527
17528
17529 .option fail_verify routers boolean false
17530 .cindex "router" "forcing verification failure"
17531 Setting this option has the effect of setting both &%fail_verify_sender%& and
17532 &%fail_verify_recipient%& to the same value.
17533
17534
17535
17536 .option fail_verify_recipient routers boolean false
17537 If this option is true and an address is accepted by this router when
17538 verifying a recipient, verification fails.
17539
17540
17541
17542 .option fail_verify_sender routers boolean false
17543 If this option is true and an address is accepted by this router when
17544 verifying a sender, verification fails.
17545
17546
17547
17548 .option fallback_hosts routers "string list" unset
17549 .cindex "router" "fallback hosts"
17550 .cindex "fallback" "hosts specified on router"
17551 String expansion is not applied to this option. The argument must be a
17552 colon-separated list of host names or IP addresses. The list separator can be
17553 changed (see section &<<SECTlistconstruct>>&), and a port can be specified with
17554 each name or address. In fact, the format of each item is exactly the same as
17555 defined for the list of hosts in a &(manualroute)& router (see section
17556 &<<SECTformatonehostitem>>&).
17557
17558 If a router queues an address for a remote transport, this host list is
17559 associated with the address, and used instead of the transport's fallback host
17560 list. If &%hosts_randomize%& is set on the transport, the order of the list is
17561 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
17562 transport for further details.
17563
17564
17565 .option group routers string&!! "see below"
17566 .cindex "gid (group id)" "local delivery"
17567 .cindex "local transports" "uid and gid"
17568 .cindex "transport" "local"
17569 .cindex "router" "setting group"
17570 When a router queues an address for a transport, and the transport does not
17571 specify a group, the group given here is used when running the delivery
17572 process.
17573 The group may be specified numerically or by name. If expansion fails, the
17574 error is logged and delivery is deferred.
17575 The default is unset, unless &%check_local_user%& is set, when the default
17576 is taken from the password information. See also &%initgroups%& and &%user%&
17577 and the discussion in chapter &<<CHAPenvironment>>&.
17578
17579
17580
17581 .option headers_add routers list&!! unset
17582 .cindex "header lines" "adding"
17583 .cindex "router" "adding header lines"
17584 This option specifies a list of text headers,
17585 newline-separated (by default, changeable in the usual way),
17586 that is associated with any addresses that are accepted by the router.
17587 Each item is separately expanded, at routing time.  However, this
17588 option has no effect when an address is just being verified. The way in which
17589 the text is used to add header lines at transport time is described in section
17590 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
17591 message is in the process of being transported. This means that references to
17592 header lines in string expansions in the transport's configuration do not
17593 &"see"& the added header lines.
17594
17595 The &%headers_add%& option is expanded after &%errors_to%&, but before
17596 &%headers_remove%& and &%transport%&. If an item is empty, or if
17597 an item expansion is forced to fail, the item has no effect. Other expansion
17598 failures are treated as configuration errors.
17599
17600 Unlike most options, &%headers_add%& can be specified multiple times
17601 for a router; all listed headers are added.
17602
17603 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
17604 router that has the &%one_time%& option set.
17605
17606 .cindex "duplicate addresses"
17607 .oindex "&%unseen%&"
17608 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
17609 additions are deleted when the address is passed on to subsequent routers.
17610 For a &%redirect%& router, if a generated address is the same as the incoming
17611 address, this can lead to duplicate addresses with different header
17612 modifications. Exim does not do duplicate deliveries (except, in certain
17613 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
17614 which of the duplicates is discarded, so this ambiguous situation should be
17615 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
17616
17617
17618
17619 .option headers_remove routers list&!! unset
17620 .cindex "header lines" "removing"
17621 .cindex "router" "removing header lines"
17622 This option specifies a list of text headers,
17623 colon-separated (by default, changeable in the usual way),
17624 that is associated with any addresses that are accepted by the router.
17625 Each item is separately expanded, at routing time.  However, this
17626 option has no effect when an address is just being verified. The way in which
17627 the text is used to remove header lines at transport time is described in
17628 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
17629 the message is in the process of being transported. This means that references
17630 to header lines in string expansions in the transport's configuration still
17631 &"see"& the original header lines.
17632
17633 The &%headers_remove%& option is expanded after &%errors_to%& and
17634 &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail,
17635 the item has no effect. Other expansion failures are treated as configuration
17636 errors.
17637
17638 Unlike most options, &%headers_remove%& can be specified multiple times
17639 for a router; all listed headers are removed.
17640
17641 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
17642 router that has the &%one_time%& option set.
17643
17644 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
17645 removal requests are deleted when the address is passed on to subsequent
17646 routers, and this can lead to problems with duplicates -- see the similar
17647 warning for &%headers_add%& above.
17648
17649 &*Warning 3*&: Because of the separate expansion of the list items,
17650 items that contain a list separator must have it doubled.
17651 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
17652
17653
17654
17655 .option ignore_target_hosts routers "host list&!!" unset
17656 .cindex "IP address" "discarding"
17657 .cindex "router" "discarding IP addresses"
17658 Although this option is a host list, it should normally contain IP address
17659 entries rather than names. If any host that is looked up by the router has an
17660 IP address that matches an item in this list, Exim behaves as if that IP
17661 address did not exist. This option allows you to cope with rogue DNS entries
17662 like
17663 .code
17664 remote.domain.example.  A  127.0.0.1
17665 .endd
17666 by setting
17667 .code
17668 ignore_target_hosts = 127.0.0.1
17669 .endd
17670 on the relevant router. If all the hosts found by a &(dnslookup)& router are
17671 discarded in this way, the router declines. In a conventional configuration, an
17672 attempt to mail to such a domain would normally provoke the &"unrouteable
17673 domain"& error, and an attempt to verify an address in the domain would fail.
17674 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
17675 router declines if presented with one of the listed addresses.
17676
17677 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
17678 means of the first or the second of the following settings, respectively:
17679 .code
17680 ignore_target_hosts = 0.0.0.0/0
17681 ignore_target_hosts = <; 0::0/0
17682 .endd
17683 The pattern in the first line matches all IPv4 addresses, whereas the pattern
17684 in the second line matches all IPv6 addresses.
17685
17686 This option may also be useful for ignoring link-local and site-local IPv6
17687 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
17688 is expanded before use as a list, it is possible to make it dependent on the
17689 domain that is being routed.
17690
17691 .vindex "&$host_address$&"
17692 During its expansion, &$host_address$& is set to the IP address that is being
17693 checked.
17694
17695 .option initgroups routers boolean false
17696 .cindex "additional groups"
17697 .cindex "groups" "additional"
17698 .cindex "local transports" "uid and gid"
17699 .cindex "transport" "local"
17700 If the router queues an address for a transport, and this option is true, and
17701 the uid supplied by the router is not overridden by the transport, the
17702 &[initgroups()]& function is called when running the transport to ensure that
17703 any additional groups associated with the uid are set up. See also &%group%&
17704 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
17705
17706
17707
17708 .option local_part_prefix routers&!? "string list" unset
17709 .cindex "router" "prefix for local part"
17710 .cindex "prefix" "for local part, used in router"
17711 If this option is set, the router is skipped unless the local part starts with
17712 one of the given strings, or &%local_part_prefix_optional%& is true. See
17713 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
17714 evaluated.
17715
17716 The list is scanned from left to right, and the first prefix that matches is
17717 used. A limited form of wildcard is available; if the prefix begins with an
17718 asterisk, it matches the longest possible sequence of arbitrary characters at
17719 the start of the local part. An asterisk should therefore always be followed by
17720 some character that does not occur in normal local parts.
17721 .cindex "multiple mailboxes"
17722 .cindex "mailbox" "multiple"
17723 Wildcarding can be used to set up multiple user mailboxes, as described in
17724 section &<<SECTmulbox>>&.
17725
17726 .vindex "&$local_part$&"
17727 .vindex "&$local_part_prefix$&"
17728 During the testing of the &%local_parts%& option, and while the router is
17729 running, the prefix is removed from the local part, and is available in the
17730 expansion variable &$local_part_prefix$&. When a message is being delivered, if
17731 the router accepts the address, this remains true during subsequent delivery by
17732 a transport. In particular, the local part that is transmitted in the RCPT
17733 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
17734 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
17735 the relevant transport.
17736
17737 When an address is being verified, &%local_part_prefix%& affects only the
17738 behaviour of the router. If the callout feature of verification is in use, this
17739 means that the full address, including the prefix, will be used during the
17740 callout.
17741
17742 The prefix facility is commonly used to handle local parts of the form
17743 &%owner-something%&. Another common use is to support local parts of the form
17744 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
17745 to tell a user their forwarding is broken &-- by placing a router like this one
17746 immediately before the router that handles &_.forward_& files:
17747 .code
17748 real_localuser:
17749   driver = accept
17750   local_part_prefix = real-
17751   check_local_user
17752   transport = local_delivery
17753 .endd
17754 For security, it would probably be a good idea to restrict the use of this
17755 router to locally-generated messages, using a condition such as this:
17756 .code
17757   condition = ${if match {$sender_host_address}\
17758                          {\N^(|127\.0\.0\.1)$\N}}
17759 .endd
17760
17761 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
17762 both conditions must be met if not optional. Care must be taken if wildcards
17763 are used in both a prefix and a suffix on the same router. Different
17764 separator characters must be used to avoid ambiguity.
17765
17766
17767 .option local_part_prefix_optional routers boolean false
17768 See &%local_part_prefix%& above.
17769
17770
17771
17772 .option local_part_suffix routers&!? "string list" unset
17773 .cindex "router" "suffix for local part"
17774 .cindex "suffix for local part" "used in router"
17775 This option operates in the same way as &%local_part_prefix%&, except that the
17776 local part must end (rather than start) with the given string, the
17777 &%local_part_suffix_optional%& option determines whether the suffix is
17778 mandatory, and the wildcard * character, if present, must be the last
17779 character of the suffix. This option facility is commonly used to handle local
17780 parts of the form &%something-request%& and multiple user mailboxes of the form
17781 &%username-foo%&.
17782
17783
17784 .option local_part_suffix_optional routers boolean false
17785 See &%local_part_suffix%& above.
17786
17787
17788
17789 .option local_parts routers&!? "local part list&!!" unset
17790 .cindex "router" "restricting to specific local parts"
17791 .cindex "local part" "checking in router"
17792 The router is run only if the local part of the address matches the list.
17793 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17794 are evaluated, and
17795 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
17796 string is expanded, it is possible to make it depend on the domain, for
17797 example:
17798 .code
17799 local_parts = dbm;/usr/local/specials/$domain
17800 .endd
17801 .vindex "&$local_part_data$&"
17802 If the match is achieved by a lookup, the data that the lookup returned
17803 for the local part is placed in the variable &$local_part_data$& for use in
17804 expansions of the router's private options. You might use this option, for
17805 example, if you have a large number of local virtual domains, and you want to
17806 send all postmaster mail to the same place without having to set up an alias in
17807 each virtual domain:
17808 .code
17809 postmaster:
17810   driver = redirect
17811   local_parts = postmaster
17812   data = postmaster@real.domain.example
17813 .endd
17814
17815
17816 .option log_as_local routers boolean "see below"
17817 .cindex "log" "delivery line"
17818 .cindex "delivery" "log line format"
17819 Exim has two logging styles for delivery, the idea being to make local
17820 deliveries stand out more visibly from remote ones. In the &"local"& style, the
17821 recipient address is given just as the local part, without a domain. The use of
17822 this style is controlled by this option. It defaults to true for the &(accept)&
17823 router, and false for all the others. This option applies only when a
17824 router assigns an address to a transport. It has no effect on routers that
17825 redirect addresses.
17826
17827
17828
17829 .option more routers boolean&!! true
17830 The result of string expansion for this option must be a valid boolean value,
17831 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
17832 result causes an error, and delivery is deferred. If the expansion is forced to
17833 fail, the default value for the option (true) is used. Other failures cause
17834 delivery to be deferred.
17835
17836 If this option is set false, and the router declines to handle the address, no
17837 further routers are tried, routing fails, and the address is bounced.
17838 .oindex "&%self%&"
17839 However, if the router explicitly passes an address to the following router by
17840 means of the setting
17841 .code
17842 self = pass
17843 .endd
17844 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
17845 does not affect the behaviour if one of the precondition tests fails. In that
17846 case, the address is always passed to the next router.
17847
17848 Note that &%address_data%& is not considered to be a precondition. If its
17849 expansion is forced to fail, the router declines, and the value of &%more%&
17850 controls what happens next.
17851
17852
17853 .option pass_on_timeout routers boolean false
17854 .cindex "timeout" "of router"
17855 .cindex "router" "timeout"
17856 If a router times out during a host lookup, it normally causes deferral of the
17857 address. If &%pass_on_timeout%& is set, the address is passed on to the next
17858 router, overriding &%no_more%&. This may be helpful for systems that are
17859 intermittently connected to the Internet, or those that want to pass to a smart
17860 host any messages that cannot immediately be delivered.
17861
17862 There are occasional other temporary errors that can occur while doing DNS
17863 lookups. They are treated in the same way as a timeout, and this option
17864 applies to all of them.
17865
17866
17867
17868 .option pass_router routers string unset
17869 .cindex "router" "go to after &""pass""&"
17870 Routers that recognize the generic &%self%& option (&(dnslookup)&,
17871 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
17872 routing to continue, and overriding a false setting of &%more%&. When one of
17873 these routers returns &"pass"&, the address is normally handed on to the next
17874 router in sequence. This can be changed by setting &%pass_router%& to the name
17875 of another router. However (unlike &%redirect_router%&) the named router must
17876 be below the current router, to avoid loops. Note that this option applies only
17877 to the special case of &"pass"&. It does not apply when a router returns
17878 &"decline"& because it cannot handle an address.
17879
17880
17881
17882 .option redirect_router routers string unset
17883 .cindex "router" "start at after redirection"
17884 Sometimes an administrator knows that it is pointless to reprocess addresses
17885 generated from alias or forward files with the same router again. For
17886 example, if an alias file translates real names into login ids there is no
17887 point searching the alias file a second time, especially if it is a large file.
17888
17889 The &%redirect_router%& option can be set to the name of any router instance.
17890 It causes the routing of any generated addresses to start at the named router
17891 instead of at the first router. This option has no effect if the router in
17892 which it is set does not generate new addresses.
17893
17894
17895
17896 .option require_files routers&!? "string list&!!" unset
17897 .cindex "file" "requiring for router"
17898 .cindex "router" "requiring file existence"
17899 This option provides a general mechanism for predicating the running of a
17900 router on the existence or non-existence of certain files or directories.
17901 Before running a router, as one of its precondition tests, Exim works its way
17902 through the &%require_files%& list, expanding each item separately.
17903
17904 Because the list is split before expansion, any colons in expansion items must
17905 be doubled, or the facility for using a different list separator must be used.
17906 If any expansion is forced to fail, the item is ignored. Other expansion
17907 failures cause routing of the address to be deferred.
17908
17909 If any expanded string is empty, it is ignored. Otherwise, except as described
17910 below, each string must be a fully qualified file path, optionally preceded by
17911 &"!"&. The paths are passed to the &[stat()]& function to test for the
17912 existence of the files or directories. The router is skipped if any paths not
17913 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
17914
17915 .cindex "NFS"
17916 If &[stat()]& cannot determine whether a file exists or not, delivery of
17917 the message is deferred. This can happen when NFS-mounted filesystems are
17918 unavailable.
17919
17920 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
17921 options, so you cannot use it to check for the existence of a file in which to
17922 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
17923 full list of the order in which preconditions are evaluated.) However, as
17924 these options are all expanded, you can use the &%exists%& expansion condition
17925 to make such tests. The &%require_files%& option is intended for checking files
17926 that the router may be going to use internally, or which are needed by a
17927 transport (for example &_.procmailrc_&).
17928
17929 During delivery, the &[stat()]& function is run as root, but there is a
17930 facility for some checking of the accessibility of a file by another user.
17931 This is not a proper permissions check, but just a &"rough"& check that
17932 operates as follows:
17933
17934 If an item in a &%require_files%& list does not contain any forward slash
17935 characters, it is taken to be the user (and optional group, separated by a
17936 comma) to be checked for subsequent files in the list. If no group is specified
17937 but the user is specified symbolically, the gid associated with the uid is
17938 used. For example:
17939 .code
17940 require_files = mail:/some/file
17941 require_files = $local_part:$home/.procmailrc
17942 .endd
17943 If a user or group name in a &%require_files%& list does not exist, the
17944 &%require_files%& condition fails.
17945
17946 Exim performs the check by scanning along the components of the file path, and
17947 checking the access for the given uid and gid. It checks for &"x"& access on
17948 directories, and &"r"& access on the final file. Note that this means that file
17949 access control lists, if the operating system has them, are ignored.
17950
17951 &*Warning 1*&: When the router is being run to verify addresses for an
17952 incoming SMTP message, Exim is not running as root, but under its own uid. This
17953 may affect the result of a &%require_files%& check. In particular, &[stat()]&
17954 may yield the error EACCES (&"Permission denied"&). This means that the Exim
17955 user is not permitted to read one of the directories on the file's path.
17956
17957 &*Warning 2*&: Even when Exim is running as root while delivering a message,
17958 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
17959 without root access. In this case, if a check for access by a particular user
17960 is requested, Exim creates a subprocess that runs as that user, and tries the
17961 check again in that process.
17962
17963 The default action for handling an unresolved EACCES is to consider it to
17964 be caused by a configuration error, and routing is deferred because the
17965 existence or non-existence of the file cannot be determined. However, in some
17966 circumstances it may be desirable to treat this condition as if the file did
17967 not exist. If the file name (or the exclamation mark that precedes the file
17968 name for non-existence) is preceded by a plus sign, the EACCES error is treated
17969 as if the file did not exist. For example:
17970 .code
17971 require_files = +/some/file
17972 .endd
17973 If the router is not an essential part of verification (for example, it
17974 handles users' &_.forward_& files), another solution is to set the &%verify%&
17975 option false so that the router is skipped when verifying.
17976
17977
17978
17979 .option retry_use_local_part routers boolean "see below"
17980 .cindex "hints database" "retry keys"
17981 .cindex "local part" "in retry keys"
17982 When a delivery suffers a temporary routing failure, a retry record is created
17983 in Exim's hints database. For addresses whose routing depends only on the
17984 domain, the key for the retry record should not involve the local part, but for
17985 other addresses, both the domain and the local part should be included.
17986 Usually, remote routing is of the former kind, and local routing is of the
17987 latter kind.
17988
17989 This option controls whether the local part is used to form the key for retry
17990 hints for addresses that suffer temporary errors while being handled by this
17991 router. The default value is true for any router that has &%check_local_user%&
17992 set, and false otherwise. Note that this option does not apply to hints keys
17993 for transport delays; they are controlled by a generic transport option of the
17994 same name.
17995
17996 The setting of &%retry_use_local_part%& applies only to the router on which it
17997 appears. If the router generates child addresses, they are routed
17998 independently; this setting does not become attached to them.
17999
18000
18001
18002 .option router_home_directory routers string&!! unset
18003 .cindex "router" "home directory for"
18004 .cindex "home directory" "for router"
18005 .vindex "&$home$&"
18006 This option sets a home directory for use while the router is running. (Compare
18007 &%transport_home_directory%&, which sets a home directory for later
18008 transporting.) In particular, if used on a &(redirect)& router, this option
18009 sets a value for &$home$& while a filter is running. The value is expanded;
18010 forced expansion failure causes the option to be ignored &-- other failures
18011 cause the router to defer.
18012
18013 Expansion of &%router_home_directory%& happens immediately after the
18014 &%check_local_user%& test (if configured), before any further expansions take
18015 place.
18016 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18017 are evaluated.)
18018 While the router is running, &%router_home_directory%& overrides the value of
18019 &$home$& that came from &%check_local_user%&.
18020
18021 When a router accepts an address and assigns it to a local transport (including
18022 the cases when a &(redirect)& router generates a pipe, file, or autoreply
18023 delivery), the home directory setting for the transport is taken from the first
18024 of these values that is set:
18025
18026 .ilist
18027 The &%home_directory%& option on the transport;
18028 .next
18029 The &%transport_home_directory%& option on the router;
18030 .next
18031 The password data if &%check_local_user%& is set on the router;
18032 .next
18033 The &%router_home_directory%& option on the router.
18034 .endlist
18035
18036 In other words, &%router_home_directory%& overrides the password data for the
18037 router, but not for the transport.
18038
18039
18040
18041 .option self routers string freeze
18042 .cindex "MX record" "pointing to local host"
18043 .cindex "local host" "MX pointing to"
18044 This option applies to those routers that use a recipient address to find a
18045 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
18046 and &(manualroute)& routers.
18047 Certain configurations of the &(queryprogram)& router can also specify a list
18048 of remote hosts.
18049 Usually such routers are configured to send the message to a remote host via an
18050 &(smtp)& transport. The &%self%& option specifies what happens when the first
18051 host on the list turns out to be the local host.
18052 The way in which Exim checks for the local host is described in section
18053 &<<SECTreclocipadd>>&.
18054
18055 Normally this situation indicates either an error in Exim's configuration (for
18056 example, the router should be configured not to process this domain), or an
18057 error in the DNS (for example, the MX should not point to this host). For this
18058 reason, the default action is to log the incident, defer the address, and
18059 freeze the message. The following alternatives are provided for use in special
18060 cases:
18061
18062 .vlist
18063 .vitem &%defer%&
18064 Delivery of the message is tried again later, but the message is not frozen.
18065
18066 .vitem "&%reroute%&: <&'domain'&>"
18067 The domain is changed to the given domain, and the address is passed back to
18068 be reprocessed by the routers. No rewriting of headers takes place. This
18069 behaviour is essentially a redirection.
18070
18071 .vitem "&%reroute: rewrite:%& <&'domain'&>"
18072 The domain is changed to the given domain, and the address is passed back to be
18073 reprocessed by the routers. Any headers that contain the original domain are
18074 rewritten.
18075
18076 .vitem &%pass%&
18077 .oindex "&%more%&"
18078 .vindex "&$self_hostname$&"
18079 The router passes the address to the next router, or to the router named in the
18080 &%pass_router%& option if it is set. This overrides &%no_more%&. During
18081 subsequent routing and delivery, the variable &$self_hostname$& contains the
18082 name of the local host that the router encountered. This can be used to
18083 distinguish between different cases for hosts with multiple names. The
18084 combination
18085 .code
18086 self = pass
18087 no_more
18088 .endd
18089 ensures that only those addresses that routed to the local host are passed on.
18090 Without &%no_more%&, addresses that were declined for other reasons would also
18091 be passed to the next router.
18092
18093 .vitem &%fail%&
18094 Delivery fails and an error report is generated.
18095
18096 .vitem &%send%&
18097 .cindex "local host" "sending to"
18098 The anomaly is ignored and the address is queued for the transport. This
18099 setting should be used with extreme caution. For an &(smtp)& transport, it
18100 makes sense only in cases where the program that is listening on the SMTP port
18101 is not this version of Exim. That is, it must be some other MTA, or Exim with a
18102 different configuration file that handles the domain in another way.
18103 .endlist
18104
18105
18106
18107 .option senders routers&!? "address list&!!" unset
18108 .cindex "router" "checking senders"
18109 If this option is set, the router is skipped unless the message's sender
18110 address matches something on the list.
18111 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18112 are evaluated.
18113
18114 There are issues concerning verification when the running of routers is
18115 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
18116 setting, it sets the sender to the null string. When using the &%-bt%& option
18117 to check a configuration file, it is necessary also to use the &%-f%& option to
18118 set an appropriate sender. For incoming mail, the sender is unset when
18119 verifying the sender, but is available when verifying any recipients. If the
18120 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
18121 matters.
18122
18123
18124 .option translate_ip_address routers string&!! unset
18125 .cindex "IP address" "translating"
18126 .cindex "packet radio"
18127 .cindex "router" "IP address translation"
18128 There exist some rare networking situations (for example, packet radio) where
18129 it is helpful to be able to translate IP addresses generated by normal routing
18130 mechanisms into other IP addresses, thus performing a kind of manual IP
18131 routing. This should be done only if the normal IP routing of the TCP/IP stack
18132 is inadequate or broken. Because this is an extremely uncommon requirement, the
18133 code to support this option is not included in the Exim binary unless
18134 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
18135
18136 .vindex "&$host_address$&"
18137 The &%translate_ip_address%& string is expanded for every IP address generated
18138 by the router, with the generated address set in &$host_address$&. If the
18139 expansion is forced to fail, no action is taken.
18140 For any other expansion error, delivery of the message is deferred.
18141 If the result of the expansion is an IP address, that replaces the original
18142 address; otherwise the result is assumed to be a host name &-- this is looked
18143 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
18144 produce one or more replacement IP addresses. For example, to subvert all IP
18145 addresses in some specific networks, this could be added to a router:
18146 .code
18147 translate_ip_address = \
18148   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
18149     {$value}fail}}
18150 .endd
18151 The file would contain lines like
18152 .code
18153 10.2.3.128/26    some.host
18154 10.8.4.34/26     10.44.8.15
18155 .endd
18156 You should not make use of this facility unless you really understand what you
18157 are doing.
18158
18159
18160
18161 .option transport routers string&!! unset
18162 This option specifies the transport to be used when a router accepts an address
18163 and sets it up for delivery. A transport is never needed if a router is used
18164 only for verification. The value of the option is expanded at routing time,
18165 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
18166 and result must be the name of one of the configured transports. If it is not,
18167 delivery is deferred.
18168
18169 The &%transport%& option is not used by the &(redirect)& router, but it does
18170 have some private options that set up transports for pipe and file deliveries
18171 (see chapter &<<CHAPredirect>>&).
18172
18173
18174
18175 .option transport_current_directory routers string&!! unset
18176 .cindex "current directory for local transport"
18177 This option associates a current directory with any address that is routed
18178 to a local transport. This can happen either because a transport is
18179 explicitly configured for the router, or because it generates a delivery to a
18180 file or a pipe. During the delivery process (that is, at transport time), this
18181 option string is expanded and is set as the current directory, unless
18182 overridden by a setting on the transport.
18183 If the expansion fails for any reason, including forced failure, an error is
18184 logged, and delivery is deferred.
18185 See chapter &<<CHAPenvironment>>& for details of the local delivery
18186 environment.
18187
18188
18189
18190
18191 .option transport_home_directory routers string&!! "see below"
18192 .cindex "home directory" "for local transport"
18193 This option associates a home directory with any address that is routed to a
18194 local transport. This can happen either because a transport is explicitly
18195 configured for the router, or because it generates a delivery to a file or a
18196 pipe. During the delivery process (that is, at transport time), the option
18197 string is expanded and is set as the home directory, unless overridden by a
18198 setting of &%home_directory%& on the transport.
18199 If the expansion fails for any reason, including forced failure, an error is
18200 logged, and delivery is deferred.
18201
18202 If the transport does not specify a home directory, and
18203 &%transport_home_directory%& is not set for the router, the home directory for
18204 the transport is taken from the password data if &%check_local_user%& is set for
18205 the router. Otherwise it is taken from &%router_home_directory%& if that option
18206 is set; if not, no home directory is set for the transport.
18207
18208 See chapter &<<CHAPenvironment>>& for further details of the local delivery
18209 environment.
18210
18211
18212
18213
18214 .option unseen routers boolean&!! false
18215 .cindex "router" "carrying on after success"
18216 The result of string expansion for this option must be a valid boolean value,
18217 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
18218 result causes an error, and delivery is deferred. If the expansion is forced to
18219 fail, the default value for the option (false) is used. Other failures cause
18220 delivery to be deferred.
18221
18222 When this option is set true, routing does not cease if the router accepts the
18223 address. Instead, a copy of the incoming address is passed to the next router,
18224 overriding a false setting of &%more%&. There is little point in setting
18225 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
18226 the value of &%unseen%& contains expansion items (and therefore, presumably, is
18227 sometimes true and sometimes false).
18228
18229 .cindex "copy of message (&%unseen%& option)"
18230 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
18231 qualifier in filter files. It can be used to cause copies of messages to be
18232 delivered to some other destination, while also carrying out a normal delivery.
18233 In effect, the current address is made into a &"parent"& that has two children
18234 &-- one that is delivered as specified by this router, and a clone that goes on
18235 to be routed further. For this reason, &%unseen%& may not be combined with the
18236 &%one_time%& option in a &(redirect)& router.
18237
18238 &*Warning*&: Header lines added to the address (or specified for removal) by
18239 this router or by previous routers affect the &"unseen"& copy of the message
18240 only. The clone that continues to be processed by further routers starts with
18241 no added headers and none specified for removal. For a &%redirect%& router, if
18242 a generated address is the same as the incoming address, this can lead to
18243 duplicate addresses with different header modifications. Exim does not do
18244 duplicate deliveries (except, in certain circumstances, to pipes -- see section
18245 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
18246 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
18247 &%redirect%& router may be of help.
18248
18249 Unlike the handling of header modifications, any data that was set by the
18250 &%address_data%& option in the current or previous routers &'is'& passed on to
18251 subsequent routers.
18252
18253
18254 .option user routers string&!! "see below"
18255 .cindex "uid (user id)" "local delivery"
18256 .cindex "local transports" "uid and gid"
18257 .cindex "transport" "local"
18258 .cindex "router" "user for filter processing"
18259 .cindex "filter" "user for processing"
18260 When a router queues an address for a transport, and the transport does not
18261 specify a user, the user given here is used when running the delivery process.
18262 The user may be specified numerically or by name. If expansion fails, the
18263 error is logged and delivery is deferred.
18264 This user is also used by the &(redirect)& router when running a filter file.
18265 The default is unset, except when &%check_local_user%& is set. In this case,
18266 the default is taken from the password information. If the user is specified as
18267 a name, and &%group%& is not set, the group associated with the user is used.
18268 See also &%initgroups%& and &%group%& and the discussion in chapter
18269 &<<CHAPenvironment>>&.
18270
18271
18272
18273 .option verify routers&!? boolean true
18274 Setting this option has the effect of setting &%verify_sender%& and
18275 &%verify_recipient%& to the same value.
18276
18277
18278 .option verify_only routers&!? boolean false
18279 .cindex "EXPN" "with &%verify_only%&"
18280 .oindex "&%-bv%&"
18281 .cindex "router" "used only when verifying"
18282 If this option is set, the router is used only when verifying an address,
18283 delivering in cutthrough mode or
18284 testing with the &%-bv%& option, not when actually doing a delivery, testing
18285 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
18286 restricted to verifying only senders or recipients by means of
18287 &%verify_sender%& and &%verify_recipient%&.
18288
18289 &*Warning*&: When the router is being run to verify addresses for an incoming
18290 SMTP message, Exim is not running as root, but under its own uid. If the router
18291 accesses any files, you need to make sure that they are accessible to the Exim
18292 user or group.
18293
18294
18295 .option verify_recipient routers&!? boolean true
18296 If this option is false, the router is skipped when verifying recipient
18297 addresses,
18298 delivering in cutthrough mode
18299 or testing recipient verification using &%-bv%&.
18300 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18301 are evaluated.
18302 See also the &$verify_mode$& variable.
18303
18304
18305 .option verify_sender routers&!? boolean true
18306 If this option is false, the router is skipped when verifying sender addresses
18307 or testing sender verification using &%-bvs%&.
18308 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18309 are evaluated.
18310 See also the &$verify_mode$& variable.
18311 .ecindex IIDgenoprou1
18312 .ecindex IIDgenoprou2
18313
18314
18315
18316
18317
18318
18319 . ////////////////////////////////////////////////////////////////////////////
18320 . ////////////////////////////////////////////////////////////////////////////
18321
18322 .chapter "The accept router" "CHID4"
18323 .cindex "&(accept)& router"
18324 .cindex "routers" "&(accept)&"
18325 The &(accept)& router has no private options of its own. Unless it is being
18326 used purely for verification (see &%verify_only%&) a transport is required to
18327 be defined by the generic &%transport%& option. If the preconditions that are
18328 specified by generic options are met, the router accepts the address and queues
18329 it for the given transport. The most common use of this router is for setting
18330 up deliveries to local mailboxes. For example:
18331 .code
18332 localusers:
18333   driver = accept
18334   domains = mydomain.example
18335   check_local_user
18336   transport = local_delivery
18337 .endd
18338 The &%domains%& condition in this example checks the domain of the address, and
18339 &%check_local_user%& checks that the local part is the login of a local user.
18340 When both preconditions are met, the &(accept)& router runs, and queues the
18341 address for the &(local_delivery)& transport.
18342
18343
18344
18345
18346
18347
18348 . ////////////////////////////////////////////////////////////////////////////
18349 . ////////////////////////////////////////////////////////////////////////////
18350
18351 .chapter "The dnslookup router" "CHAPdnslookup"
18352 .scindex IIDdnsrou1 "&(dnslookup)& router"
18353 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
18354 The &(dnslookup)& router looks up the hosts that handle mail for the
18355 recipient's domain in the DNS. A transport must always be set for this router,
18356 unless &%verify_only%& is set.
18357
18358 If SRV support is configured (see &%check_srv%& below), Exim first searches for
18359 SRV records. If none are found, or if SRV support is not configured,
18360 MX records are looked up. If no MX records exist, address records are sought.
18361 However, &%mx_domains%& can be set to disable the direct use of address
18362 records.
18363
18364 MX records of equal priority are sorted by Exim into a random order. Exim then
18365 looks for address records for the host names obtained from MX or SRV records.
18366 When a host has more than one IP address, they are sorted into a random order,
18367 except that IPv6 addresses are always sorted before IPv4 addresses. If all the
18368 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
18369 generic option, the router declines.
18370
18371 Unless they have the highest priority (lowest MX value), MX records that point
18372 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
18373 are discarded, together with any other MX records of equal or lower priority.
18374
18375 .cindex "MX record" "pointing to local host"
18376 .cindex "local host" "MX pointing to"
18377 .oindex "&%self%&" "in &(dnslookup)& router"
18378 If the host pointed to by the highest priority MX record, or looked up as an
18379 address record, is the local host, or matches &%hosts_treat_as_local%&, what
18380 happens is controlled by the generic &%self%& option.
18381
18382
18383 .section "Problems with DNS lookups" "SECTprowitdnsloo"
18384 There have been problems with DNS servers when SRV records are looked up.
18385 Some misbehaving servers return a DNS error or timeout when a non-existent
18386 SRV record is sought. Similar problems have in the past been reported for
18387 MX records. The global &%dns_again_means_nonexist%& option can help with this
18388 problem, but it is heavy-handed because it is a global option.
18389
18390 For this reason, there are two options, &%srv_fail_domains%& and
18391 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
18392 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
18393 an attempt to look up an SRV or MX record causes one of these results, and the
18394 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
18395 such record"&. In the case of an SRV lookup, this means that the router
18396 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
18397 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
18398 case routing fails.
18399
18400
18401 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
18402 .cindex "&(dnslookup)& router" "declines"
18403 There are a few cases where a &(dnslookup)& router will decline to accept
18404 an address; if such a router is expected to handle "all remaining non-local
18405 domains", then it is important to set &%no_more%&.
18406
18407 The router will defer rather than decline if the domain
18408 is found in the &%fail_defer_domains%& router option.
18409
18410 Reasons for a &(dnslookup)& router to decline currently include:
18411 .ilist
18412 The domain does not exist in DNS
18413 .next
18414 The domain exists but the MX record's host part is just "."; this is a common
18415 convention (borrowed from SRV) used to indicate that there is no such service
18416 for this domain and to not fall back to trying A/AAAA records.
18417 .next
18418 Ditto, but for SRV records, when &%check_srv%& is set on this router.
18419 .next
18420 MX record points to a non-existent host.
18421 .next
18422 MX record points to an IP address and the main section option
18423 &%allow_mx_to_ip%& is not set.
18424 .next
18425 MX records exist and point to valid hosts, but all hosts resolve only to
18426 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
18427 .next
18428 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
18429 &%dns_check_names_pattern%& for handling one variant of this)
18430 .next
18431 &%check_secondary_mx%& is set on this router but the local host can
18432 not be found in the MX records (see below)
18433 .endlist
18434
18435
18436
18437
18438 .section "Private options for dnslookup" "SECID118"
18439 .cindex "options" "&(dnslookup)& router"
18440 The private options for the &(dnslookup)& router are as follows:
18441
18442 .option check_secondary_mx dnslookup boolean false
18443 .cindex "MX record" "checking for secondary"
18444 If this option is set, the router declines unless the local host is found in
18445 (and removed from) the list of hosts obtained by MX lookup. This can be used to
18446 process domains for which the local host is a secondary mail exchanger
18447 differently to other domains. The way in which Exim decides whether a host is
18448 the local host is described in section &<<SECTreclocipadd>>&.
18449
18450
18451 .option check_srv dnslookup string&!! unset
18452 .cindex "SRV record" "enabling use of"
18453 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
18454 addition to MX and address records. The support is disabled by default. To
18455 enable SRV support, set the &%check_srv%& option to the name of the service
18456 required. For example,
18457 .code
18458 check_srv = smtp
18459 .endd
18460 looks for SRV records that refer to the normal smtp service. The option is
18461 expanded, so the service name can vary from message to message or address
18462 to address. This might be helpful if SRV records are being used for a
18463 submission service. If the expansion is forced to fail, the &%check_srv%&
18464 option is ignored, and the router proceeds to look for MX records in the
18465 normal way.
18466
18467 When the expansion succeeds, the router searches first for SRV records for
18468 the given service (it assumes TCP protocol). A single SRV record with a
18469 host name that consists of just a single dot indicates &"no such service for
18470 this domain"&; if this is encountered, the router declines. If other kinds of
18471 SRV record are found, they are used to construct a host list for delivery
18472 according to the rules of RFC 2782. MX records are not sought in this case.
18473
18474 When no SRV records are found, MX records (and address records) are sought in
18475 the traditional way. In other words, SRV records take precedence over MX
18476 records, just as MX records take precedence over address records. Note that
18477 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
18478 defined it. It is apparently believed that MX records are sufficient for email
18479 and that SRV records should not be used for this purpose. However, SRV records
18480 have an additional &"weight"& feature which some people might find useful when
18481 trying to split an SMTP load between hosts of different power.
18482
18483 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
18484 when there is a DNS lookup error.
18485
18486
18487
18488
18489 .option fail_defer_domains dnslookup "domain list&!!" unset
18490 .cindex "MX record" "not found"
18491 DNS lookups for domains matching &%fail_defer_domains%&
18492 which find no matching record will cause the router to defer
18493 rather than the default behaviour of decline.
18494 This maybe be useful for queueing messages for a newly created
18495 domain while the DNS configuration is not ready.
18496 However, it will result in any message with mistyped domains
18497 also being queued.
18498
18499
18500 .option mx_domains dnslookup "domain list&!!" unset
18501 .cindex "MX record" "required to exist"
18502 .cindex "SRV record" "required to exist"
18503 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
18504 record in order to be recognized. (The name of this option could be improved.)
18505 For example, if all the mail hosts in &'fict.example'& are known to have MX
18506 records, except for those in &'discworld.fict.example'&, you could use this
18507 setting:
18508 .code
18509 mx_domains = ! *.discworld.fict.example : *.fict.example
18510 .endd
18511 This specifies that messages addressed to a domain that matches the list but
18512 has no MX record should be bounced immediately instead of being routed using
18513 the address record.
18514
18515
18516 .option mx_fail_domains dnslookup "domain list&!!" unset
18517 If the DNS lookup for MX records for one of the domains in this list causes a
18518 DNS lookup error, Exim behaves as if no MX records were found. See section
18519 &<<SECTprowitdnsloo>>& for more discussion.
18520
18521
18522
18523
18524 .option qualify_single dnslookup boolean true
18525 .cindex "DNS" "resolver options"
18526 .cindex "DNS" "qualifying single-component names"
18527 When this option is true, the resolver option RES_DEFNAMES is set for DNS
18528 lookups. Typically, but not standardly, this causes the resolver to qualify
18529 single-component names with the default domain. For example, on a machine
18530 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
18531 &'thesaurus.ref.example'& inside the resolver. For details of what your
18532 resolver actually does, consult your man pages for &'resolver'& and
18533 &'resolv.conf'&.
18534
18535
18536
18537 .option rewrite_headers dnslookup boolean true
18538 .cindex "rewriting" "header lines"
18539 .cindex "header lines" "rewriting"
18540 If the domain name in the address that is being processed is not fully
18541 qualified, it may be expanded to its full form by a DNS lookup. For example, if
18542 an address is specified as &'dormouse@teaparty'&, the domain might be
18543 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
18544 occur as a result of setting the &%widen_domains%& option. If
18545 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
18546 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
18547 header lines of the message are rewritten with the full domain name.
18548
18549 This option should be turned off only when it is known that no message is
18550 ever going to be sent outside an environment where the abbreviation makes
18551 sense.
18552
18553 When an MX record is looked up in the DNS and matches a wildcard record, name
18554 servers normally return a record containing the name that has been looked up,
18555 making it impossible to detect whether a wildcard was present or not. However,
18556 some name servers have recently been seen to return the wildcard entry. If the
18557 name returned by a DNS lookup begins with an asterisk, it is not used for
18558 header rewriting.
18559
18560
18561 .option same_domain_copy_routing dnslookup boolean false
18562 .cindex "address" "copying routing"
18563 Addresses with the same domain are normally routed by the &(dnslookup)& router
18564 to the same list of hosts. However, this cannot be presumed, because the router
18565 options and preconditions may refer to the local part of the address. By
18566 default, therefore, Exim routes each address in a message independently. DNS
18567 servers run caches, so repeated DNS lookups are not normally expensive, and in
18568 any case, personal messages rarely have more than a few recipients.
18569
18570 If you are running mailing lists with large numbers of subscribers at the same
18571 domain, and you are using a &(dnslookup)& router which is independent of the
18572 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
18573 lookups for identical domains in one message. In this case, when &(dnslookup)&
18574 routes an address to a remote transport, any other unrouted addresses in the
18575 message that have the same domain are automatically given the same routing
18576 without processing them independently,
18577 provided the following conditions are met:
18578
18579 .ilist
18580 No router that processed the address specified &%headers_add%& or
18581 &%headers_remove%&.
18582 .next
18583 The router did not change the address in any way, for example, by &"widening"&
18584 the domain.
18585 .endlist
18586
18587
18588
18589
18590 .option search_parents dnslookup boolean false
18591 .cindex "DNS" "resolver options"
18592 When this option is true, the resolver option RES_DNSRCH is set for DNS
18593 lookups. This is different from the &%qualify_single%& option in that it
18594 applies to domains containing dots. Typically, but not standardly, it causes
18595 the resolver to search for the name in the current domain and in parent
18596 domains. For example, on a machine in the &'fict.example'& domain, if looking
18597 up &'teaparty.wonderland'& failed, the resolver would try
18598 &'teaparty.wonderland.fict.example'&. For details of what your resolver
18599 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
18600
18601 Setting this option true can cause problems in domains that have a wildcard MX
18602 record, because any domain that does not have its own MX record matches the
18603 local wildcard.
18604
18605
18606
18607 .option srv_fail_domains dnslookup "domain list&!!" unset
18608 If the DNS lookup for SRV records for one of the domains in this list causes a
18609 DNS lookup error, Exim behaves as if no SRV records were found. See section
18610 &<<SECTprowitdnsloo>>& for more discussion.
18611
18612
18613
18614
18615 .option widen_domains dnslookup "string list" unset
18616 .cindex "domain" "partial; widening"
18617 If a DNS lookup fails and this option is set, each of its strings in turn is
18618 added onto the end of the domain, and the lookup is tried again. For example,
18619 if
18620 .code
18621 widen_domains = fict.example:ref.example
18622 .endd
18623 is set and a lookup of &'klingon.dictionary'& fails,
18624 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
18625 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
18626 and &%search_parents%& options can cause some widening to be undertaken inside
18627 the DNS resolver. &%widen_domains%& is not applied to sender addresses
18628 when verifying, unless &%rewrite_headers%& is false (not the default).
18629
18630
18631 .section "Effect of qualify_single and search_parents" "SECID119"
18632 When a domain from an envelope recipient is changed by the resolver as a result
18633 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
18634 corresponding address in the message's header lines unless &%rewrite_headers%&
18635 is set false. Exim then re-routes the address, using the full domain.
18636
18637 These two options affect only the DNS lookup that takes place inside the router
18638 for the domain of the address that is being routed. They do not affect lookups
18639 such as that implied by
18640 .code
18641 domains = @mx_any
18642 .endd
18643 that may happen while processing a router precondition before the router is
18644 entered. No widening ever takes place for these lookups.
18645 .ecindex IIDdnsrou1
18646 .ecindex IIDdnsrou2
18647
18648
18649
18650
18651
18652
18653
18654
18655
18656 . ////////////////////////////////////////////////////////////////////////////
18657 . ////////////////////////////////////////////////////////////////////////////
18658
18659 .chapter "The ipliteral router" "CHID5"
18660 .cindex "&(ipliteral)& router"
18661 .cindex "domain literal" "routing"
18662 .cindex "routers" "&(ipliteral)&"
18663 This router has no private options. Unless it is being used purely for
18664 verification (see &%verify_only%&) a transport is required to be defined by the
18665 generic &%transport%& option. The router accepts the address if its domain part
18666 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
18667 router handles the address
18668 .code
18669 root@[192.168.1.1]
18670 .endd
18671 by setting up delivery to the host with that IP address. IPv4 domain literals
18672 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
18673 are similar, but the address is preceded by &`ipv6:`&. For example:
18674 .code
18675 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
18676 .endd
18677 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
18678 grounds that sooner or later somebody will try it.
18679
18680 .oindex "&%self%&" "in &(ipliteral)& router"
18681 If the IP address matches something in &%ignore_target_hosts%&, the router
18682 declines. If an IP literal turns out to refer to the local host, the generic
18683 &%self%& option determines what happens.
18684
18685 The RFCs require support for domain literals; however, their use is
18686 controversial in today's Internet. If you want to use this router, you must
18687 also set the main configuration option &%allow_domain_literals%&. Otherwise,
18688 Exim will not recognize the domain literal syntax in addresses.
18689
18690
18691
18692 . ////////////////////////////////////////////////////////////////////////////
18693 . ////////////////////////////////////////////////////////////////////////////
18694
18695 .chapter "The iplookup router" "CHID6"
18696 .cindex "&(iplookup)& router"
18697 .cindex "routers" "&(iplookup)&"
18698 The &(iplookup)& router was written to fulfil a specific requirement in
18699 Cambridge University (which in fact no longer exists). For this reason, it is
18700 not included in the binary of Exim by default. If you want to include it, you
18701 must set
18702 .code
18703 ROUTER_IPLOOKUP=yes
18704 .endd
18705 in your &_Local/Makefile_& configuration file.
18706
18707 The &(iplookup)& router routes an address by sending it over a TCP or UDP
18708 connection to one or more specific hosts. The host can then return the same or
18709 a different address &-- in effect rewriting the recipient address in the
18710 message's envelope. The new address is then passed on to subsequent routers. If
18711 this process fails, the address can be passed on to other routers, or delivery
18712 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
18713 must not be specified for it.
18714
18715 .cindex "options" "&(iplookup)& router"
18716 .option hosts iplookup string unset
18717 This option must be supplied. Its value is a colon-separated list of host
18718 names. The hosts are looked up using &[gethostbyname()]&
18719 (or &[getipnodebyname()]& when available)
18720 and are tried in order until one responds to the query. If none respond, what
18721 happens is controlled by &%optional%&.
18722
18723
18724 .option optional iplookup boolean false
18725 If &%optional%& is true, if no response is obtained from any host, the address
18726 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
18727 delivery to the address is deferred.
18728
18729
18730 .option port iplookup integer 0
18731 .cindex "port" "&(iplookup)& router"
18732 This option must be supplied. It specifies the port number for the TCP or UDP
18733 call.
18734
18735
18736 .option protocol iplookup string udp
18737 This option can be set to &"udp"& or &"tcp"& to specify which of the two
18738 protocols is to be used.
18739
18740
18741 .option query iplookup string&!! "see below"
18742 This defines the content of the query that is sent to the remote hosts. The
18743 default value is:
18744 .code
18745 $local_part@$domain $local_part@$domain
18746 .endd
18747 The repetition serves as a way of checking that a response is to the correct
18748 query in the default case (see &%response_pattern%& below).
18749
18750
18751 .option reroute iplookup string&!! unset
18752 If this option is not set, the rerouted address is precisely the byte string
18753 returned by the remote host, up to the first white space, if any. If set, the
18754 string is expanded to form the rerouted address. It can include parts matched
18755 in the response by &%response_pattern%& by means of numeric variables such as
18756 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
18757 whether or not a pattern is in use. In all cases, the rerouted address must end
18758 up in the form &'local_part@domain'&.
18759
18760
18761 .option response_pattern iplookup string unset
18762 This option can be set to a regular expression that is applied to the string
18763 returned from the remote host. If the pattern does not match the response, the
18764 router declines. If &%response_pattern%& is not set, no checking of the
18765 response is done, unless the query was defaulted, in which case there is a
18766 check that the text returned after the first white space is the original
18767 address. This checks that the answer that has been received is in response to
18768 the correct question. For example, if the response is just a new domain, the
18769 following could be used:
18770 .code
18771 response_pattern = ^([^@]+)$
18772 reroute = $local_part@$1
18773 .endd
18774
18775 .option timeout iplookup time 5s
18776 This specifies the amount of time to wait for a response from the remote
18777 machine. The same timeout is used for the &[connect()]& function for a TCP
18778 call. It does not apply to UDP.
18779
18780
18781
18782
18783 . ////////////////////////////////////////////////////////////////////////////
18784 . ////////////////////////////////////////////////////////////////////////////
18785
18786 .chapter "The manualroute router" "CHID7"
18787 .scindex IIDmanrou1 "&(manualroute)& router"
18788 .scindex IIDmanrou2 "routers" "&(manualroute)&"
18789 .cindex "domain" "manually routing"
18790 The &(manualroute)& router is so-called because it provides a way of manually
18791 routing an address according to its domain. It is mainly used when you want to
18792 route addresses to remote hosts according to your own rules, bypassing the
18793 normal DNS routing that looks up MX records. However, &(manualroute)& can also
18794 route to local transports, a facility that may be useful if you want to save
18795 messages for dial-in hosts in local files.
18796
18797 The &(manualroute)& router compares a list of domain patterns with the domain
18798 it is trying to route. If there is no match, the router declines. Each pattern
18799 has associated with it a list of hosts and some other optional data, which may
18800 include a transport. The combination of a pattern and its data is called a
18801 &"routing rule"&. For patterns that do not have an associated transport, the
18802 generic &%transport%& option must specify a transport, unless the router is
18803 being used purely for verification (see &%verify_only%&).
18804
18805 .vindex "&$host$&"
18806 In the case of verification, matching the domain pattern is sufficient for the
18807 router to accept the address. When actually routing an address for delivery,
18808 an address that matches a domain pattern is queued for the associated
18809 transport. If the transport is not a local one, a host list must be associated
18810 with the pattern; IP addresses are looked up for the hosts, and these are
18811 passed to the transport along with the mail address. For local transports, a
18812 host list is optional. If it is present, it is passed in &$host$& as a single
18813 text string.
18814
18815 The list of routing rules can be provided as an inline string in
18816 &%route_list%&, or the data can be obtained by looking up the domain in a file
18817 or database by setting &%route_data%&. Only one of these settings may appear in
18818 any one instance of &(manualroute)&. The format of routing rules is described
18819 below, following the list of private options.
18820
18821
18822 .section "Private options for manualroute" "SECTprioptman"
18823
18824 .cindex "options" "&(manualroute)& router"
18825 The private options for the &(manualroute)& router are as follows:
18826
18827 .option host_all_ignored manualroute string defer
18828 See &%host_find_failed%&.
18829
18830 .option host_find_failed manualroute string freeze
18831 This option controls what happens when &(manualroute)& tries to find an IP
18832 address for a host, and the host does not exist. The option can be set to one
18833 of the following values:
18834 .code
18835 decline
18836 defer
18837 fail
18838 freeze
18839 ignore
18840 pass
18841 .endd
18842 The default (&"freeze"&) assumes that this state is a serious configuration
18843 error. The difference between &"pass"& and &"decline"& is that the former
18844 forces the address to be passed to the next router (or the router defined by
18845 &%pass_router%&),
18846 .oindex "&%more%&"
18847 overriding &%no_more%&, whereas the latter passes the address to the next
18848 router only if &%more%& is true.
18849
18850 The value &"ignore"& causes Exim to completely ignore a host whose IP address
18851 cannot be found. If all the hosts in the list are ignored, the behaviour is
18852 controlled by the &%host_all_ignored%& option. This takes the same values
18853 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
18854
18855 The &%host_find_failed%& option applies only to a definite &"does not exist"&
18856 state; if a host lookup gets a temporary error, delivery is deferred unless the
18857 generic &%pass_on_timeout%& option is set.
18858
18859
18860 .option hosts_randomize manualroute boolean false
18861 .cindex "randomized host list"
18862 .cindex "host" "list of; randomized"
18863 If this option is set, the order of the items in a host list in a routing rule
18864 is randomized each time the list is used, unless an option in the routing rule
18865 overrides (see below). Randomizing the order of a host list can be used to do
18866 crude load sharing. However, if more than one mail address is routed by the
18867 same router to the same host list, the host lists are considered to be the same
18868 (even though they may be randomized into different orders) for the purpose of
18869 deciding whether to batch the deliveries into a single SMTP transaction.
18870
18871 When &%hosts_randomize%& is true, a host list may be split
18872 into groups whose order is separately randomized. This makes it possible to
18873 set up MX-like behaviour. The boundaries between groups are indicated by an
18874 item that is just &`+`& in the host list. For example:
18875 .code
18876 route_list = * host1:host2:host3:+:host4:host5
18877 .endd
18878 The order of the first three hosts and the order of the last two hosts is
18879 randomized for each use, but the first three always end up before the last two.
18880 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
18881 randomized host list is passed to an &(smtp)& transport that also has
18882 &%hosts_randomize set%&, the list is not re-randomized.
18883
18884
18885 .option route_data manualroute string&!! unset
18886 If this option is set, it must expand to yield the data part of a routing rule.
18887 Typically, the expansion string includes a lookup based on the domain. For
18888 example:
18889 .code
18890 route_data = ${lookup{$domain}dbm{/etc/routes}}
18891 .endd
18892 If the expansion is forced to fail, or the result is an empty string, the
18893 router declines. Other kinds of expansion failure cause delivery to be
18894 deferred.
18895
18896
18897 .option route_list manualroute "string list" unset
18898 This string is a list of routing rules, in the form defined below. Note that,
18899 unlike most string lists, the items are separated by semicolons. This is so
18900 that they may contain colon-separated host lists.
18901
18902
18903 .option same_domain_copy_routing manualroute boolean false
18904 .cindex "address" "copying routing"
18905 Addresses with the same domain are normally routed by the &(manualroute)&
18906 router to the same list of hosts. However, this cannot be presumed, because the
18907 router options and preconditions may refer to the local part of the address. By
18908 default, therefore, Exim routes each address in a message independently. DNS
18909 servers run caches, so repeated DNS lookups are not normally expensive, and in
18910 any case, personal messages rarely have more than a few recipients.
18911
18912 If you are running mailing lists with large numbers of subscribers at the same
18913 domain, and you are using a &(manualroute)& router which is independent of the
18914 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
18915 lookups for identical domains in one message. In this case, when
18916 &(manualroute)& routes an address to a remote transport, any other unrouted
18917 addresses in the message that have the same domain are automatically given the
18918 same routing without processing them independently. However, this is only done
18919 if &%headers_add%& and &%headers_remove%& are unset.
18920
18921
18922
18923
18924 .section "Routing rules in route_list" "SECID120"
18925 The value of &%route_list%& is a string consisting of a sequence of routing
18926 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
18927 entered as two semicolons. Alternatively, the list separator can be changed as
18928 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
18929 Empty rules are ignored. The format of each rule is
18930 .display
18931 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
18932 .endd
18933 The following example contains two rules, each with a simple domain pattern and
18934 no options:
18935 .code
18936 route_list = \
18937   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
18938   thes.ref.example  mail-3.ref.example:mail-4.ref.example
18939 .endd
18940 The three parts of a rule are separated by white space. The pattern and the
18941 list of hosts can be enclosed in quotes if necessary, and if they are, the
18942 usual quoting rules apply. Each rule in a &%route_list%& must start with a
18943 single domain pattern, which is the only mandatory item in the rule. The
18944 pattern is in the same format as one item in a domain list (see section
18945 &<<SECTdomainlist>>&),
18946 except that it may not be the name of an interpolated file.
18947 That is, it may be wildcarded, or a regular expression, or a file or database
18948 lookup (with semicolons doubled, because of the use of semicolon as a separator
18949 in a &%route_list%&).
18950
18951 The rules in &%route_list%& are searched in order until one of the patterns
18952 matches the domain that is being routed. The list of hosts and then options are
18953 then used as described below. If there is no match, the router declines. When
18954 &%route_list%& is set, &%route_data%& must not be set.
18955
18956
18957
18958 .section "Routing rules in route_data" "SECID121"
18959 The use of &%route_list%& is convenient when there are only a small number of
18960 routing rules. For larger numbers, it is easier to use a file or database to
18961 hold the routing information, and use the &%route_data%& option instead.
18962 The value of &%route_data%& is a list of hosts, followed by (optional) options.
18963 Most commonly, &%route_data%& is set as a string that contains an
18964 expansion lookup. For example, suppose we place two routing rules in a file
18965 like this:
18966 .code
18967 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
18968 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
18969 .endd
18970 This data can be accessed by setting
18971 .code
18972 route_data = ${lookup{$domain}lsearch{/the/file/name}}
18973 .endd
18974 Failure of the lookup results in an empty string, causing the router to
18975 decline. However, you do not have to use a lookup in &%route_data%&. The only
18976 requirement is that the result of expanding the string is a list of hosts,
18977 possibly followed by options, separated by white space. The list of hosts must
18978 be enclosed in quotes if it contains white space.
18979
18980
18981
18982
18983 .section "Format of the list of hosts" "SECID122"
18984 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
18985 always separately expanded before use. If the expansion fails, the router
18986 declines. The result of the expansion must be a colon-separated list of names
18987 and/or IP addresses, optionally also including ports. The format of each item
18988 in the list is described in the next section. The list separator can be changed
18989 as described in section &<<SECTlistconstruct>>&.
18990
18991 If the list of hosts was obtained from a &%route_list%& item, the following
18992 variables are set during its expansion:
18993
18994 .ilist
18995 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
18996 If the domain was matched against a regular expression, the numeric variables
18997 &$1$&, &$2$&, etc. may be set. For example:
18998 .code
18999 route_list = ^domain(\d+)   host-$1.text.example
19000 .endd
19001 .next
19002 &$0$& is always set to the entire domain.
19003 .next
19004 &$1$& is also set when partial matching is done in a file lookup.
19005
19006 .next
19007 .vindex "&$value$&"
19008 If the pattern that matched the domain was a lookup item, the data that was
19009 looked up is available in the expansion variable &$value$&. For example:
19010 .code
19011 route_list = lsearch;;/some/file.routes  $value
19012 .endd
19013 .endlist
19014
19015 Note the doubling of the semicolon in the pattern that is necessary because
19016 semicolon is the default route list separator.
19017
19018
19019
19020 .section "Format of one host item" "SECTformatonehostitem"
19021 Each item in the list of hosts is either a host name or an IP address,
19022 optionally with an attached port number. When no port is given, an IP address
19023 is not enclosed in brackets. When a port is specified, it overrides the port
19024 specification on the transport. The port is separated from the name or address
19025 by a colon. This leads to some complications:
19026
19027 .ilist
19028 Because colon is the default separator for the list of hosts, either
19029 the colon that specifies a port must be doubled, or the list separator must
19030 be changed. The following two examples have the same effect:
19031 .code
19032 route_list = * "host1.tld::1225 : host2.tld::1226"
19033 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
19034 .endd
19035 .next
19036 When IPv6 addresses are involved, it gets worse, because they contain
19037 colons of their own. To make this case easier, it is permitted to
19038 enclose an IP address (either v4 or v6) in square brackets if a port
19039 number follows. For example:
19040 .code
19041 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
19042 .endd
19043 .endlist
19044
19045 .section "How the list of hosts is used" "SECThostshowused"
19046 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
19047 the hosts is tried, in the order specified, when carrying out the SMTP
19048 delivery. However, the order can be changed by setting the &%hosts_randomize%&
19049 option, either on the router (see section &<<SECTprioptman>>& above), or on the
19050 transport.
19051
19052 Hosts may be listed by name or by IP address. An unadorned name in the list of
19053 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
19054 interpreted as an indirection to a sublist of hosts obtained by looking up MX
19055 records in the DNS. For example:
19056 .code
19057 route_list = *  x.y.z:p.q.r/MX:e.f.g
19058 .endd
19059 If this feature is used with a port specifier, the port must come last. For
19060 example:
19061 .code
19062 route_list = *  dom1.tld/mx::1225
19063 .endd
19064 If the &%hosts_randomize%& option is set, the order of the items in the list is
19065 randomized before any lookups are done. Exim then scans the list; for any name
19066 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
19067 be an interface on the local host and the item is not the first in the list,
19068 Exim discards it and any subsequent items. If it is the first item, what
19069 happens is controlled by the
19070 .oindex "&%self%&" "in &(manualroute)& router"
19071 &%self%& option of the router.
19072
19073 A name on the list that is followed by &`/MX`& is replaced with the list of
19074 hosts obtained by looking up MX records for the name. This is always a DNS
19075 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
19076 below) are not relevant here. The order of these hosts is determined by the
19077 preference values in the MX records, according to the usual rules. Because
19078 randomizing happens before the MX lookup, it does not affect the order that is
19079 defined by MX preferences.
19080
19081 If the local host is present in the sublist obtained from MX records, but is
19082 not the most preferred host in that list, it and any equally or less
19083 preferred hosts are removed before the sublist is inserted into the main list.
19084
19085 If the local host is the most preferred host in the MX list, what happens
19086 depends on where in the original list of hosts the &`/MX`& item appears. If it
19087 is not the first item (that is, there are previous hosts in the main list),
19088 Exim discards this name and any subsequent items in the main list.
19089
19090 If the MX item is first in the list of hosts, and the local host is the
19091 most preferred host, what happens is controlled by the &%self%& option of the
19092 router.
19093
19094 DNS failures when lookup up the MX records are treated in the same way as DNS
19095 failures when looking up IP addresses: &%pass_on_timeout%& and
19096 &%host_find_failed%& are used when relevant.
19097
19098 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
19099 whether obtained from an MX lookup or not.
19100
19101
19102
19103 .section "How the options are used" "SECThowoptused"
19104 The options are a sequence of words; in practice no more than three are ever
19105 present. One of the words can be the name of a transport; this overrides the
19106 &%transport%& option on the router for this particular routing rule only. The
19107 other words (if present) control randomization of the list of hosts on a
19108 per-rule basis, and how the IP addresses of the hosts are to be found when
19109 routing to a remote transport. These options are as follows:
19110
19111 .ilist
19112 &%randomize%&: randomize the order of the hosts in this list, overriding the
19113 setting of &%hosts_randomize%& for this routing rule only.
19114 .next
19115 &%no_randomize%&: do not randomize the order of the hosts in this list,
19116 overriding the setting of &%hosts_randomize%& for this routing rule only.
19117 .next
19118 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
19119 find IP addresses. This function may ultimately cause a DNS lookup, but it may
19120 also look in &_/etc/hosts_& or other sources of information.
19121 .next
19122 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
19123 no address records are found. If there is a temporary DNS error (such as a
19124 timeout), delivery is deferred.
19125 .endlist
19126
19127 For example:
19128 .code
19129 route_list = domain1  host1:host2:host3  randomize bydns;\
19130              domain2  host4:host5
19131 .endd
19132 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
19133 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
19134 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
19135 or &[gethostbyname()]&, and the result of the lookup is the result of that
19136 call.
19137
19138 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
19139 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
19140 instead of TRY_AGAIN. That is why the default action is to try a DNS
19141 lookup first. Only if that gives a definite &"no such host"& is the local
19142 function called.
19143
19144
19145
19146 If no IP address for a host can be found, what happens is controlled by the
19147 &%host_find_failed%& option.
19148
19149 .vindex "&$host$&"
19150 When an address is routed to a local transport, IP addresses are not looked up.
19151 The host list is passed to the transport in the &$host$& variable.
19152
19153
19154
19155 .section "Manualroute examples" "SECID123"
19156 In some of the examples that follow, the presence of the &%remote_smtp%&
19157 transport, as defined in the default configuration file, is assumed:
19158
19159 .ilist
19160 .cindex "smart host" "example router"
19161 The &(manualroute)& router can be used to forward all external mail to a
19162 &'smart host'&. If you have set up, in the main part of the configuration, a
19163 named domain list that contains your local domains, for example:
19164 .code
19165 domainlist local_domains = my.domain.example
19166 .endd
19167 You can arrange for all other domains to be routed to a smart host by making
19168 your first router something like this:
19169 .code
19170 smart_route:
19171   driver = manualroute
19172   domains = !+local_domains
19173   transport = remote_smtp
19174   route_list = * smarthost.ref.example
19175 .endd
19176 This causes all non-local addresses to be sent to the single host
19177 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
19178 they are tried in order
19179 (but you can use &%hosts_randomize%& to vary the order each time).
19180 Another way of configuring the same thing is this:
19181 .code
19182 smart_route:
19183   driver = manualroute
19184   transport = remote_smtp
19185   route_list = !+local_domains  smarthost.ref.example
19186 .endd
19187 There is no difference in behaviour between these two routers as they stand.
19188 However, they behave differently if &%no_more%& is added to them. In the first
19189 example, the router is skipped if the domain does not match the &%domains%&
19190 precondition; the following router is always tried. If the router runs, it
19191 always matches the domain and so can never decline. Therefore, &%no_more%&
19192 would have no effect. In the second case, the router is never skipped; it
19193 always runs. However, if it doesn't match the domain, it declines. In this case
19194 &%no_more%& would prevent subsequent routers from running.
19195
19196 .next
19197 .cindex "mail hub example"
19198 A &'mail hub'& is a host which receives mail for a number of domains via MX
19199 records in the DNS and delivers it via its own private routing mechanism. Often
19200 the final destinations are behind a firewall, with the mail hub being the one
19201 machine that can connect to machines both inside and outside the firewall. The
19202 &(manualroute)& router is usually used on a mail hub to route incoming messages
19203 to the correct hosts. For a small number of domains, the routing can be inline,
19204 using the &%route_list%& option, but for a larger number a file or database
19205 lookup is easier to manage.
19206
19207 If the domain names are in fact the names of the machines to which the mail is
19208 to be sent by the mail hub, the configuration can be quite simple. For
19209 example:
19210 .code
19211 hub_route:
19212   driver = manualroute
19213   transport = remote_smtp
19214   route_list = *.rhodes.tvs.example  $domain
19215 .endd
19216 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
19217 whose names are the same as the mail domains. A similar approach can be taken
19218 if the host name can be obtained from the domain name by a string manipulation
19219 that the expansion facilities can handle. Otherwise, a lookup based on the
19220 domain can be used to find the host:
19221 .code
19222 through_firewall:
19223   driver = manualroute
19224   transport = remote_smtp
19225   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
19226 .endd
19227 The result of the lookup must be the name or IP address of the host (or
19228 hosts) to which the address is to be routed. If the lookup fails, the route
19229 data is empty, causing the router to decline. The address then passes to the
19230 next router.
19231
19232 .next
19233 .cindex "batched SMTP output example"
19234 .cindex "SMTP" "batched outgoing; example"
19235 You can use &(manualroute)& to deliver messages to pipes or files in batched
19236 SMTP format for onward transportation by some other means. This is one way of
19237 storing mail for a dial-up host when it is not connected. The route list entry
19238 can be as simple as a single domain name in a configuration like this:
19239 .code
19240 save_in_file:
19241   driver = manualroute
19242   transport = batchsmtp_appendfile
19243   route_list = saved.domain.example
19244 .endd
19245 though often a pattern is used to pick up more than one domain. If there are
19246 several domains or groups of domains with different transport requirements,
19247 different transports can be listed in the routing information:
19248 .code
19249 save_in_file:
19250   driver = manualroute
19251   route_list = \
19252     *.saved.domain1.example  $domain  batch_appendfile; \
19253     *.saved.domain2.example  \
19254       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
19255       batch_pipe
19256 .endd
19257 .vindex "&$domain$&"
19258 .vindex "&$host$&"
19259 The first of these just passes the domain in the &$host$& variable, which
19260 doesn't achieve much (since it is also in &$domain$&), but the second does a
19261 file lookup to find a value to pass, causing the router to decline to handle
19262 the address if the lookup fails.
19263
19264 .next
19265 .cindex "UUCP" "example of router for"
19266 Routing mail directly to UUCP software is a specific case of the use of
19267 &(manualroute)& in a gateway to another mail environment. This is an example of
19268 one way it can be done:
19269 .code
19270 # Transport
19271 uucp:
19272   driver = pipe
19273   user = nobody
19274   command = /usr/local/bin/uux -r - \
19275     ${substr_-5:$host}!rmail ${local_part}
19276   return_fail_output = true
19277
19278 # Router
19279 uucphost:
19280   transport = uucp
19281   driver = manualroute
19282   route_data = \
19283     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
19284 .endd
19285 The file &_/usr/local/exim/uucphosts_& contains entries like
19286 .code
19287 darksite.ethereal.example:           darksite.UUCP
19288 .endd
19289 It can be set up more simply without adding and removing &".UUCP"& but this way
19290 makes clear the distinction between the domain name
19291 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
19292 .endlist
19293 .ecindex IIDmanrou1
19294 .ecindex IIDmanrou2
19295
19296
19297
19298
19299
19300
19301
19302
19303 . ////////////////////////////////////////////////////////////////////////////
19304 . ////////////////////////////////////////////////////////////////////////////
19305
19306 .chapter "The queryprogram router" "CHAPdriverlast"
19307 .scindex IIDquerou1 "&(queryprogram)& router"
19308 .scindex IIDquerou2 "routers" "&(queryprogram)&"
19309 .cindex "routing" "by external program"
19310 The &(queryprogram)& router routes an address by running an external command
19311 and acting on its output. This is an expensive way to route, and is intended
19312 mainly for use in lightly-loaded systems, or for performing experiments.
19313 However, if it is possible to use the precondition options (&%domains%&,
19314 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
19315 be used in special cases, even on a busy host. There are the following private
19316 options:
19317 .cindex "options" "&(queryprogram)& router"
19318
19319 .option command queryprogram string&!! unset
19320 This option must be set. It specifies the command that is to be run. The
19321 command is split up into a command name and arguments, and then each is
19322 expanded separately (exactly as for a &(pipe)& transport, described in chapter
19323 &<<CHAPpipetransport>>&).
19324
19325
19326 .option command_group queryprogram string unset
19327 .cindex "gid (group id)" "in &(queryprogram)& router"
19328 This option specifies a gid to be set when running the command while routing an
19329 address for deliver. It must be set if &%command_user%& specifies a numerical
19330 uid. If it begins with a digit, it is interpreted as the numerical value of the
19331 gid. Otherwise it is looked up using &[getgrnam()]&.
19332
19333
19334 .option command_user queryprogram string unset
19335 .cindex "uid (user id)" "for &(queryprogram)&"
19336 This option must be set. It specifies the uid which is set when running the
19337 command while routing an address for delivery. If the value begins with a digit,
19338 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
19339 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
19340 not set, a value for the gid also.
19341
19342 &*Warning:*& Changing uid and gid is possible only when Exim is running as
19343 root, which it does during a normal delivery in a conventional configuration.
19344 However, when an address is being verified during message reception, Exim is
19345 usually running as the Exim user, not as root. If the &(queryprogram)& router
19346 is called from a non-root process, Exim cannot change uid or gid before running
19347 the command. In this circumstance the command runs under the current uid and
19348 gid.
19349
19350
19351 .option current_directory queryprogram string /
19352 This option specifies an absolute path which is made the current directory
19353 before running the command.
19354
19355
19356 .option timeout queryprogram time 1h
19357 If the command does not complete within the timeout period, its process group
19358 is killed and the message is frozen. A value of zero time specifies no
19359 timeout.
19360
19361
19362 The standard output of the command is connected to a pipe, which is read when
19363 the command terminates. It should consist of a single line of output,
19364 containing up to five fields, separated by white space. The maximum length of
19365 the line is 1023 characters. Longer lines are silently truncated. The first
19366 field is one of the following words (case-insensitive):
19367
19368 .ilist
19369 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
19370 below).
19371 .next
19372 &'Decline'&: the router declines; pass the address to the next router, unless
19373 &%no_more%& is set.
19374 .next
19375 &'Fail'&: routing failed; do not pass the address to any more routers. Any
19376 subsequent text on the line is an error message. If the router is run as part
19377 of address verification during an incoming SMTP message, the message is
19378 included in the SMTP response.
19379 .next
19380 &'Defer'&: routing could not be completed at this time; try again later. Any
19381 subsequent text on the line is an error message which is logged. It is not
19382 included in any SMTP response.
19383 .next
19384 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
19385 .next
19386 &'Pass'&: pass the address to the next router (or the router specified by
19387 &%pass_router%&), overriding &%no_more%&.
19388 .next
19389 &'Redirect'&: the message is redirected. The remainder of the line is a list of
19390 new addresses, which are routed independently, starting with the first router,
19391 or the router specified by &%redirect_router%&, if set.
19392 .endlist
19393
19394 When the first word is &'accept'&, the remainder of the line consists of a
19395 number of keyed data values, as follows (split into two lines here, to fit on
19396 the page):
19397 .code
19398 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
19399 LOOKUP=byname|bydns DATA=<text>
19400 .endd
19401 The data items can be given in any order, and all are optional. If no transport
19402 is included, the transport specified by the generic &%transport%& option is
19403 used. The list of hosts and the lookup type are needed only if the transport is
19404 an &(smtp)& transport that does not itself supply a list of hosts.
19405
19406 The format of the list of hosts is the same as for the &(manualroute)& router.
19407 As well as host names and IP addresses with optional port numbers, as described
19408 in section &<<SECTformatonehostitem>>&, it may contain names followed by
19409 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
19410 (see section &<<SECThostshowused>>&).
19411
19412 If the lookup type is not specified, Exim behaves as follows when trying to
19413 find an IP address for each host: First, a DNS lookup is done. If this yields
19414 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
19415 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
19416 result of the lookup is the result of that call.
19417
19418 .vindex "&$address_data$&"
19419 If the DATA field is set, its value is placed in the &$address_data$&
19420 variable. For example, this return line
19421 .code
19422 accept hosts=x1.y.example:x2.y.example data="rule1"
19423 .endd
19424 routes the address to the default transport, passing a list of two hosts. When
19425 the transport runs, the string &"rule1"& is in &$address_data$&.
19426 .ecindex IIDquerou1
19427 .ecindex IIDquerou2
19428
19429
19430
19431
19432 . ////////////////////////////////////////////////////////////////////////////
19433 . ////////////////////////////////////////////////////////////////////////////
19434
19435 .chapter "The redirect router" "CHAPredirect"
19436 .scindex IIDredrou1 "&(redirect)& router"
19437 .scindex IIDredrou2 "routers" "&(redirect)&"
19438 .cindex "alias file" "in a &(redirect)& router"
19439 .cindex "address redirection" "&(redirect)& router"
19440 The &(redirect)& router handles several kinds of address redirection. Its most
19441 common uses are for resolving local part aliases from a central alias file
19442 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
19443 files, but it has many other potential uses. The incoming address can be
19444 redirected in several different ways:
19445
19446 .ilist
19447 It can be replaced by one or more new addresses which are themselves routed
19448 independently.
19449 .next
19450 It can be routed to be delivered to a given file or directory.
19451 .next
19452 It can be routed to be delivered to a specified pipe command.
19453 .next
19454 It can cause an automatic reply to be generated.
19455 .next
19456 It can be forced to fail, optionally with a custom error message.
19457 .next
19458 It can be temporarily deferred, optionally with a custom message.
19459 .next
19460 It can be discarded.
19461 .endlist
19462
19463 The generic &%transport%& option must not be set for &(redirect)& routers.
19464 However, there are some private options which define transports for delivery to
19465 files and pipes, and for generating autoreplies. See the &%file_transport%&,
19466 &%pipe_transport%& and &%reply_transport%& descriptions below.
19467
19468 If success DSNs have been requested
19469 .cindex "DSN" "success"
19470 .cindex "Delivery Status Notification" "success"
19471 redirection triggers one and the DSN options are not passed any further.
19472
19473
19474
19475 .section "Redirection data" "SECID124"
19476 The router operates by interpreting a text string which it obtains either by
19477 expanding the contents of the &%data%& option, or by reading the entire
19478 contents of a file whose name is given in the &%file%& option. These two
19479 options are mutually exclusive. The first is commonly used for handling system
19480 aliases, in a configuration like this:
19481 .code
19482 system_aliases:
19483   driver = redirect
19484   data = ${lookup{$local_part}lsearch{/etc/aliases}}
19485 .endd
19486 If the lookup fails, the expanded string in this example is empty. When the
19487 expansion of &%data%& results in an empty string, the router declines. A forced
19488 expansion failure also causes the router to decline; other expansion failures
19489 cause delivery to be deferred.
19490
19491 A configuration using &%file%& is commonly used for handling users'
19492 &_.forward_& files, like this:
19493 .code
19494 userforward:
19495   driver = redirect
19496   check_local_user
19497   file = $home/.forward
19498   no_verify
19499 .endd
19500 If the file does not exist, or causes no action to be taken (for example, it is
19501 empty or consists only of comments), the router declines. &*Warning*&: This
19502 is not the case when the file contains syntactically valid items that happen to
19503 yield empty addresses, for example, items containing only RFC 2822 address
19504 comments.
19505
19506
19507
19508 .section "Forward files and address verification" "SECID125"
19509 .cindex "address redirection" "while verifying"
19510 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
19511 &_.forward_& files, as in the example above. There are two reasons for this:
19512
19513 .ilist
19514 When Exim is receiving an incoming SMTP message from a remote host, it is
19515 running under the Exim uid, not as root. Exim is unable to change uid to read
19516 the file as the user, and it may not be able to read it as the Exim user. So in
19517 practice the router may not be able to operate.
19518 .next
19519 However, even when the router can operate, the existence of a &_.forward_& file
19520 is unimportant when verifying an address. What should be checked is whether the
19521 local part is a valid user name or not. Cutting out the redirection processing
19522 saves some resources.
19523 .endlist
19524
19525
19526
19527
19528
19529
19530 .section "Interpreting redirection data" "SECID126"
19531 .cindex "Sieve filter" "specifying in redirection data"
19532 .cindex "filter" "specifying in redirection data"
19533 The contents of the data string, whether obtained from &%data%& or &%file%&,
19534 can be interpreted in two different ways:
19535
19536 .ilist
19537 If the &%allow_filter%& option is set true, and the data begins with the text
19538 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
19539 &'filtering'& instructions in the form of an Exim or Sieve filter file,
19540 respectively. Details of the syntax and semantics of filter files are described
19541 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
19542 document is intended for use by end users.
19543 .next
19544 Otherwise, the data must be a comma-separated list of redirection items, as
19545 described in the next section.
19546 .endlist
19547
19548 When a message is redirected to a file (a &"mail folder"&), the file name given
19549 in a non-filter redirection list must always be an absolute path. A filter may
19550 generate a relative path &-- how this is handled depends on the transport's
19551 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
19552 for the &(appendfile)& transport.
19553
19554
19555
19556 .section "Items in a non-filter redirection list" "SECTitenonfilred"
19557 .cindex "address redirection" "non-filter list items"
19558 When the redirection data is not an Exim or Sieve filter, for example, if it
19559 comes from a conventional alias or forward file, it consists of a list of
19560 addresses, file names, pipe commands, or certain special items (see section
19561 &<<SECTspecitredli>>& below). The special items can be individually enabled or
19562 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
19563 depending on their default values. The items in the list are separated by
19564 commas or newlines.
19565 If a comma is required in an item, the entire item must be enclosed in double
19566 quotes.
19567
19568 Lines starting with a # character are comments, and are ignored, and # may
19569 also appear following a comma, in which case everything between the # and the
19570 next newline character is ignored.
19571
19572 If an item is entirely enclosed in double quotes, these are removed. Otherwise
19573 double quotes are retained because some forms of mail address require their use
19574 (but never to enclose the entire address). In the following description,
19575 &"item"& refers to what remains after any surrounding double quotes have been
19576 removed.
19577
19578 .vindex "&$local_part$&"
19579 &*Warning*&: If you use an Exim expansion to construct a redirection address,
19580 and the expansion contains a reference to &$local_part$&, you should make use
19581 of the &%quote_local_part%& expansion operator, in case the local part contains
19582 special characters. For example, to redirect all mail for the domain
19583 &'obsolete.example'&, retaining the existing local part, you could use this
19584 setting:
19585 .code
19586 data = ${quote_local_part:$local_part}@newdomain.example
19587 .endd
19588
19589
19590 .section "Redirecting to a local mailbox" "SECTredlocmai"
19591 .cindex "routing" "loops in"
19592 .cindex "loop" "while routing, avoidance of"
19593 .cindex "address redirection" "to local mailbox"
19594 A redirection item may safely be the same as the address currently under
19595 consideration. This does not cause a routing loop, because a router is
19596 automatically skipped if any ancestor of the address that is being processed
19597 is the same as the current address and was processed by the current router.
19598 Such an address is therefore passed to the following routers, so it is handled
19599 as if there were no redirection. When making this loop-avoidance test, the
19600 complete local part, including any prefix or suffix, is used.
19601
19602 .cindex "address redirection" "local part without domain"
19603 Specifying the same local part without a domain is a common usage in personal
19604 filter files when the user wants to have messages delivered to the local
19605 mailbox and also forwarded elsewhere. For example, the user whose login is
19606 &'cleo'& might have a &_.forward_& file containing this:
19607 .code
19608 cleo, cleopatra@egypt.example
19609 .endd
19610 .cindex "backslash in alias file"
19611 .cindex "alias file" "backslash in"
19612 For compatibility with other MTAs, such unqualified local parts may be
19613 preceded by &"\"&, but this is not a requirement for loop prevention. However,
19614 it does make a difference if more than one domain is being handled
19615 synonymously.
19616
19617 If an item begins with &"\"& and the rest of the item parses as a valid RFC
19618 2822 address that does not include a domain, the item is qualified using the
19619 domain of the incoming address. In the absence of a leading &"\"&, unqualified
19620 addresses are qualified using the value in &%qualify_recipient%&, but you can
19621 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
19622
19623 Care must be taken if there are alias names for local users.
19624 Consider an MTA handling a single local domain where the system alias file
19625 contains:
19626 .code
19627 Sam.Reman: spqr
19628 .endd
19629 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
19630 messages in the local mailbox, and also forward copies elsewhere. He creates
19631 this forward file:
19632 .code
19633 Sam.Reman, spqr@reme.elsewhere.example
19634 .endd
19635 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
19636 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
19637 second time round, because it has previously routed it,
19638 and the following routers presumably cannot handle the alias. The forward file
19639 should really contain
19640 .code
19641 spqr, spqr@reme.elsewhere.example
19642 .endd
19643 but because this is such a common error, the &%check_ancestor%& option (see
19644 below) exists to provide a way to get round it. This is normally set on a
19645 &(redirect)& router that is handling users' &_.forward_& files.
19646
19647
19648
19649 .section "Special items in redirection lists" "SECTspecitredli"
19650 In addition to addresses, the following types of item may appear in redirection
19651 lists (that is, in non-filter redirection data):
19652
19653 .ilist
19654 .cindex "pipe" "in redirection list"
19655 .cindex "address redirection" "to pipe"
19656 An item is treated as a pipe command if it begins with &"|"& and does not parse
19657 as a valid RFC 2822 address that includes a domain. A transport for running the
19658 command must be specified by the &%pipe_transport%& option.
19659 Normally, either the router or the transport specifies a user and a group under
19660 which to run the delivery. The default is to use the Exim user and group.
19661
19662 Single or double quotes can be used for enclosing the individual arguments of
19663 the pipe command; no interpretation of escapes is done for single quotes. If
19664 the command contains a comma character, it is necessary to put the whole item
19665 in double quotes, for example:
19666 .code
19667 "|/some/command ready,steady,go"
19668 .endd
19669 since items in redirection lists are terminated by commas. Do not, however,
19670 quote just the command. An item such as
19671 .code
19672 |"/some/command ready,steady,go"
19673 .endd
19674 is interpreted as a pipe with a rather strange command name, and no arguments.
19675
19676 Note that the above example assumes that the text comes from a lookup source
19677 of some sort, so that the quotes are part of the data.  If composing a
19678 redirect router with a &%data%& option directly specifying this command, the
19679 quotes will be used by the configuration parser to define the extent of one
19680 string, but will not be passed down into the redirect router itself.  There
19681 are two main approaches to get around this: escape quotes to be part of the
19682 data itself, or avoid using this mechanism and instead create a custom
19683 transport with the &%command%& option set and reference that transport from
19684 an &%accept%& router.
19685
19686 .next
19687 .cindex "file" "in redirection list"
19688 .cindex "address redirection" "to file"
19689 An item is interpreted as a path name if it begins with &"/"& and does not
19690 parse as a valid RFC 2822 address that includes a domain. For example,
19691 .code
19692 /home/world/minbari
19693 .endd
19694 is treated as a file name, but
19695 .code
19696 /s=molari/o=babylon/@x400gate.way
19697 .endd
19698 is treated as an address. For a file name, a transport must be specified using
19699 the &%file_transport%& option. However, if the generated path name ends with a
19700 forward slash character, it is interpreted as a directory name rather than a
19701 file name, and &%directory_transport%& is used instead.
19702
19703 Normally, either the router or the transport specifies a user and a group under
19704 which to run the delivery. The default is to use the Exim user and group.
19705
19706 .cindex "&_/dev/null_&"
19707 However, if a redirection item is the path &_/dev/null_&, delivery to it is
19708 bypassed at a high level, and the log entry shows &"**bypassed**"&
19709 instead of a transport name. In this case the user and group are not used.
19710
19711 .next
19712 .cindex "included address list"
19713 .cindex "address redirection" "included external list"
19714 If an item is of the form
19715 .code
19716 :include:<path name>
19717 .endd
19718 a list of further items is taken from the given file and included at that
19719 point. &*Note*&: Such a file can not be a filter file; it is just an
19720 out-of-line addition to the list. The items in the included list are separated
19721 by commas or newlines and are not subject to expansion. If this is the first
19722 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
19723 the alias name. This example is incorrect:
19724 .code
19725 list1    :include:/opt/lists/list1
19726 .endd
19727 It must be given as
19728 .code
19729 list1:   :include:/opt/lists/list1
19730 .endd
19731 .next
19732 .cindex "address redirection" "to black hole"
19733 Sometimes you want to throw away mail to a particular local part. Making the
19734 &%data%& option expand to an empty string does not work, because that causes
19735 the router to decline. Instead, the alias item
19736 .cindex "black hole"
19737 .cindex "abandoning mail"
19738 &':blackhole:'& can be used. It does what its name implies. No delivery is
19739 done, and no error message is generated. This has the same effect as specifying
19740 &_/dev/null_& as a destination, but it can be independently disabled.
19741
19742 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
19743 delivery is done for the original local part, even if other redirection items
19744 are present. If you are generating a multi-item list (for example, by reading a
19745 database) and need the ability to provide a no-op item, you must use
19746 &_/dev/null_&.
19747
19748 .next
19749 .cindex "delivery" "forcing failure"
19750 .cindex "delivery" "forcing deferral"
19751 .cindex "failing delivery" "forcing"
19752 .cindex "deferred delivery, forcing"
19753 .cindex "customizing" "failure message"
19754 An attempt to deliver a particular address can be deferred or forced to fail by
19755 redirection items of the form
19756 .code
19757 :defer:
19758 :fail:
19759 .endd
19760 respectively. When a redirection list contains such an item, it applies
19761 to the entire redirection; any other items in the list are ignored. Any
19762 text following &':fail:'& or &':defer:'& is placed in the error text
19763 associated with the failure. For example, an alias file might contain:
19764 .code
19765 X.Employee:  :fail: Gone away, no forwarding address
19766 .endd
19767 In the case of an address that is being verified from an ACL or as the subject
19768 of a
19769 .cindex "VRFY" "error text, display of"
19770 VRFY command, the text is included in the SMTP error response by
19771 default.
19772 .cindex "EXPN" "error text, display of"
19773 The text is not included in the response to an EXPN command. In non-SMTP cases
19774 the text is included in the error message that Exim generates.
19775
19776 .cindex "SMTP" "error codes"
19777 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
19778 &':fail:'&. However, if the message starts with three digits followed by a
19779 space, optionally followed by an extended code of the form &'n.n.n'&, also
19780 followed by a space, and the very first digit is the same as the default error
19781 code, the code from the message is used instead. If the very first digit is
19782 incorrect, a panic error is logged, and the default code is used. You can
19783 suppress the use of the supplied code in a redirect router by setting the
19784 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
19785 ignored.
19786
19787 .vindex "&$acl_verify_message$&"
19788 In an ACL, an explicitly provided message overrides the default, but the
19789 default message is available in the variable &$acl_verify_message$& and can
19790 therefore be included in a custom message if this is desired.
19791
19792 Normally the error text is the rest of the redirection list &-- a comma does
19793 not terminate it &-- but a newline does act as a terminator. Newlines are not
19794 normally present in alias expansions. In &(lsearch)& lookups they are removed
19795 as part of the continuation process, but they may exist in other kinds of
19796 lookup and in &':include:'& files.
19797
19798 During routing for message delivery (as opposed to verification), a redirection
19799 containing &':fail:'& causes an immediate failure of the incoming address,
19800 whereas &':defer:'& causes the message to remain on the queue so that a
19801 subsequent delivery attempt can happen at a later time. If an address is
19802 deferred for too long, it will ultimately fail, because the normal retry
19803 rules still apply.
19804
19805 .next
19806 .cindex "alias file" "exception to default"
19807 Sometimes it is useful to use a single-key search type with a default (see
19808 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
19809 for exceptions to the default. These can be handled by aliasing them to
19810 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
19811 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
19812 results in an empty redirection list has the same effect.
19813 .endlist
19814
19815
19816 .section "Duplicate addresses" "SECTdupaddr"
19817 .cindex "duplicate addresses"
19818 .cindex "address duplicate, discarding"
19819 .cindex "pipe" "duplicated"
19820 Exim removes duplicate addresses from the list to which it is delivering, so as
19821 to deliver just one copy to each address. This does not apply to deliveries
19822 routed to pipes by different immediate parent addresses, but an indirect
19823 aliasing scheme of the type
19824 .code
19825 pipe:       |/some/command $local_part
19826 localpart1: pipe
19827 localpart2: pipe
19828 .endd
19829 does not work with a message that is addressed to both local parts, because
19830 when the second is aliased to the intermediate local part &"pipe"& it gets
19831 discarded as being the same as a previously handled address. However, a scheme
19832 such as
19833 .code
19834 localpart1: |/some/command $local_part
19835 localpart2: |/some/command $local_part
19836 .endd
19837 does result in two different pipe deliveries, because the immediate parents of
19838 the pipes are distinct.
19839
19840
19841
19842 .section "Repeated redirection expansion" "SECID128"
19843 .cindex "repeated redirection expansion"
19844 .cindex "address redirection" "repeated for each delivery attempt"
19845 When a message cannot be delivered to all of its recipients immediately,
19846 leading to two or more delivery attempts, redirection expansion is carried out
19847 afresh each time for those addresses whose children were not all previously
19848 delivered. If redirection is being used as a mailing list, this can lead to new
19849 members of the list receiving copies of old messages. The &%one_time%& option
19850 can be used to avoid this.
19851
19852
19853 .section "Errors in redirection lists" "SECID129"
19854 .cindex "address redirection" "errors"
19855 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
19856 error is skipped, and an entry is written to the main log. This may be useful
19857 for mailing lists that are automatically managed. Otherwise, if an error is
19858 detected while generating the list of new addresses, the original address is
19859 deferred. See also &%syntax_errors_to%&.
19860
19861
19862
19863 .section "Private options for the redirect router" "SECID130"
19864
19865 .cindex "options" "&(redirect)& router"
19866 The private options for the &(redirect)& router are as follows:
19867
19868
19869 .option allow_defer redirect boolean false
19870 Setting this option allows the use of &':defer:'& in non-filter redirection
19871 data, or the &%defer%& command in an Exim filter file.
19872
19873
19874 .option allow_fail redirect boolean false
19875 .cindex "failing delivery" "from filter"
19876 If this option is true, the &':fail:'& item can be used in a redirection list,
19877 and the &%fail%& command may be used in an Exim filter file.
19878
19879
19880 .option allow_filter redirect boolean false
19881 .cindex "filter" "enabling use of"
19882 .cindex "Sieve filter" "enabling use of"
19883 Setting this option allows Exim to interpret redirection data that starts with
19884 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
19885 are some features of Exim filter files that some administrators may wish to
19886 lock out; see the &%forbid_filter_%&&'xxx'& options below.
19887
19888 It is also possible to lock out Exim filters or Sieve filters while allowing
19889 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
19890
19891
19892 The filter is run using the uid and gid set by the generic &%user%& and
19893 &%group%& options. These take their defaults from the password data if
19894 &%check_local_user%& is set, so in the normal case of users' personal filter
19895 files, the filter is run as the relevant user. When &%allow_filter%& is set
19896 true, Exim insists that either &%check_local_user%& or &%user%& is set.
19897
19898
19899
19900 .option allow_freeze redirect boolean false
19901 .cindex "freezing messages" "allowing in filter"
19902 Setting this option allows the use of the &%freeze%& command in an Exim filter.
19903 This command is more normally encountered in system filters, and is disabled by
19904 default for redirection filters because it isn't something you usually want to
19905 let ordinary users do.
19906
19907
19908
19909 .option check_ancestor redirect boolean false
19910 This option is concerned with handling generated addresses that are the same
19911 as some address in the list of redirection ancestors of the current address.
19912 Although it is turned off by default in the code, it is set in the default
19913 configuration file for handling users' &_.forward_& files. It is recommended
19914 for this use of the &(redirect)& router.
19915
19916 When &%check_ancestor%& is set, if a generated address (including the domain)
19917 is the same as any ancestor of the current address, it is replaced by a copy of
19918 the current address. This helps in the case where local part A is aliased to B,
19919 and B has a &_.forward_& file pointing back to A. For example, within a single
19920 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
19921 &_&~jb/.forward_& contains:
19922 .code
19923 \Joe.Bloggs, <other item(s)>
19924 .endd
19925 Without the &%check_ancestor%& setting, either local part (&"jb"& or
19926 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
19927 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
19928 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
19929 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
19930 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
19931 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
19932 original address. See also the &%repeat_use%& option below.
19933
19934
19935 .option check_group redirect boolean "see below"
19936 When the &%file%& option is used, the group owner of the file is checked only
19937 when this option is set. The permitted groups are those listed in the
19938 &%owngroups%& option, together with the user's default group if
19939 &%check_local_user%& is set. If the file has the wrong group, routing is
19940 deferred. The default setting for this option is true if &%check_local_user%&
19941 is set and the &%modemask%& option permits the group write bit, or if the
19942 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
19943
19944
19945
19946 .option check_owner redirect boolean "see below"
19947 When the &%file%& option is used, the owner of the file is checked only when
19948 this option is set. If &%check_local_user%& is set, the local user is
19949 permitted; otherwise the owner must be one of those listed in the &%owners%&
19950 option. The default value for this option is true if &%check_local_user%& or
19951 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
19952
19953
19954 .option data redirect string&!! unset
19955 This option is mutually exclusive with &%file%&. One or other of them must be
19956 set, but not both. The contents of &%data%& are expanded, and then used as the
19957 list of forwarding items, or as a set of filtering instructions. If the
19958 expansion is forced to fail, or the result is an empty string or a string that
19959 has no effect (consists entirely of comments), the router declines.
19960
19961 When filtering instructions are used, the string must begin with &"#Exim
19962 filter"&, and all comments in the string, including this initial one, must be
19963 terminated with newline characters. For example:
19964 .code
19965 data = #Exim filter\n\
19966        if $h_to: contains Exim then save $home/mail/exim endif
19967 .endd
19968 If you are reading the data from a database where newlines cannot be included,
19969 you can use the &${sg}$& expansion item to turn the escape string of your
19970 choice into a newline.
19971
19972
19973 .option directory_transport redirect string&!! unset
19974 A &(redirect)& router sets up a direct delivery to a directory when a path name
19975 ending with a slash is specified as a new &"address"&. The transport used is
19976 specified by this option, which, after expansion, must be the name of a
19977 configured transport. This should normally be an &(appendfile)& transport.
19978
19979
19980 .option file redirect string&!! unset
19981 This option specifies the name of a file that contains the redirection data. It
19982 is mutually exclusive with the &%data%& option. The string is expanded before
19983 use; if the expansion is forced to fail, the router declines. Other expansion
19984 failures cause delivery to be deferred. The result of a successful expansion
19985 must be an absolute path. The entire file is read and used as the redirection
19986 data. If the data is an empty string or a string that has no effect (consists
19987 entirely of comments), the router declines.
19988
19989 .cindex "NFS" "checking for file existence"
19990 If the attempt to open the file fails with a &"does not exist"& error, Exim
19991 runs a check on the containing directory,
19992 unless &%ignore_enotdir%& is true (see below).
19993 If the directory does not appear to exist, delivery is deferred. This can
19994 happen when users' &_.forward_& files are in NFS-mounted directories, and there
19995 is a mount problem. If the containing directory does exist, but the file does
19996 not, the router declines.
19997
19998
19999 .option file_transport redirect string&!! unset
20000 .vindex "&$address_file$&"
20001 A &(redirect)& router sets up a direct delivery to a file when a path name not
20002 ending in a slash is specified as a new &"address"&. The transport used is
20003 specified by this option, which, after expansion, must be the name of a
20004 configured transport. This should normally be an &(appendfile)& transport. When
20005 it is running, the file name is in &$address_file$&.
20006
20007
20008 .option filter_prepend_home redirect boolean true
20009 When this option is true, if a &(save)& command in an Exim filter specifies a
20010 relative path, and &$home$& is defined, it is automatically prepended to the
20011 relative path. If this option is set false, this action does not happen. The
20012 relative path is then passed to the transport unmodified.
20013
20014
20015 .option forbid_blackhole redirect boolean false
20016 If this option is true, the &':blackhole:'& item may not appear in a
20017 redirection list.
20018
20019
20020 .option forbid_exim_filter redirect boolean false
20021 If this option is set true, only Sieve filters are permitted when
20022 &%allow_filter%& is true.
20023
20024
20025
20026
20027 .option forbid_file redirect boolean false
20028 .cindex "delivery" "to file; forbidding"
20029 .cindex "Sieve filter" "forbidding delivery to a file"
20030 .cindex "Sieve filter" "&""keep""& facility; disabling"
20031 If this option is true, this router may not generate a new address that
20032 specifies delivery to a local file or directory, either from a filter or from a
20033 conventional forward file. This option is forced to be true if &%one_time%& is
20034 set. It applies to Sieve filters as well as to Exim filters, but if true, it
20035 locks out the Sieve's &"keep"& facility.
20036
20037
20038 .option forbid_filter_dlfunc redirect boolean false
20039 .cindex "filter" "locking out certain features"
20040 If this option is true, string expansions in Exim filters are not allowed to
20041 make use of the &%dlfunc%& expansion facility to run dynamically loaded
20042 functions.
20043
20044 .option forbid_filter_existstest redirect boolean false
20045 .cindex "expansion" "statting a file"
20046 If this option is true, string expansions in Exim filters are not allowed to
20047 make use of the &%exists%& condition or the &%stat%& expansion item.
20048
20049 .option forbid_filter_logwrite redirect boolean false
20050 If this option is true, use of the logging facility in Exim filters is not
20051 permitted. Logging is in any case available only if the filter is being run
20052 under some unprivileged uid (which is normally the case for ordinary users'
20053 &_.forward_& files).
20054
20055
20056 .option forbid_filter_lookup redirect boolean false
20057 If this option is true, string expansions in Exim filter files are not allowed
20058 to make use of &%lookup%& items.
20059
20060
20061 .option forbid_filter_perl redirect boolean false
20062 This option has an effect only if Exim is built with embedded Perl support. If
20063 it is true, string expansions in Exim filter files are not allowed to make use
20064 of the embedded Perl support.
20065
20066
20067 .option forbid_filter_readfile redirect boolean false
20068 If this option is true, string expansions in Exim filter files are not allowed
20069 to make use of &%readfile%& items.
20070
20071
20072 .option forbid_filter_readsocket redirect boolean false
20073 If this option is true, string expansions in Exim filter files are not allowed
20074 to make use of &%readsocket%& items.
20075
20076
20077 .option forbid_filter_reply redirect boolean false
20078 If this option is true, this router may not generate an automatic reply
20079 message. Automatic replies can be generated only from Exim or Sieve filter
20080 files, not from traditional forward files. This option is forced to be true if
20081 &%one_time%& is set.
20082
20083
20084 .option forbid_filter_run redirect boolean false
20085 If this option is true, string expansions in Exim filter files are not allowed
20086 to make use of &%run%& items.
20087
20088
20089 .option forbid_include redirect boolean false
20090 If this option is true, items of the form
20091 .code
20092 :include:<path name>
20093 .endd
20094 are not permitted in non-filter redirection lists.
20095
20096
20097 .option forbid_pipe redirect boolean false
20098 .cindex "delivery" "to pipe; forbidding"
20099 If this option is true, this router may not generate a new address which
20100 specifies delivery to a pipe, either from an Exim filter or from a conventional
20101 forward file. This option is forced to be true if &%one_time%& is set.
20102
20103
20104 .option forbid_sieve_filter redirect boolean false
20105 If this option is set true, only Exim filters are permitted when
20106 &%allow_filter%& is true.
20107
20108
20109 .cindex "SMTP" "error codes"
20110 .option forbid_smtp_code redirect boolean false
20111 If this option is set true, any SMTP error codes that are present at the start
20112 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
20113 the default codes (451 and 550, respectively) are always used.
20114
20115
20116
20117
20118 .option hide_child_in_errmsg redirect boolean false
20119 .cindex "bounce message" "redirection details; suppressing"
20120 If this option is true, it prevents Exim from quoting a child address if it
20121 generates a bounce or delay message for it. Instead it says &"an address
20122 generated from <&'the top level address'&>"&. Of course, this applies only to
20123 bounces generated locally. If a message is forwarded to another host, &'its'&
20124 bounce may well quote the generated address.
20125
20126
20127 .option ignore_eacces redirect boolean false
20128 .cindex "EACCES"
20129 If this option is set and an attempt to open a redirection file yields the
20130 EACCES error (permission denied), the &(redirect)& router behaves as if the
20131 file did not exist.
20132
20133
20134 .option ignore_enotdir redirect boolean false
20135 .cindex "ENOTDIR"
20136 If this option is set and an attempt to open a redirection file yields the
20137 ENOTDIR error (something on the path is not a directory), the &(redirect)&
20138 router behaves as if the file did not exist.
20139
20140 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
20141 router that has the &%file%& option set discovers that the file does not exist
20142 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
20143 against unmounted NFS directories. If the parent can not be statted, delivery
20144 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
20145 is set, because that option tells Exim to ignore &"something on the path is not
20146 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
20147 that some operating systems give ENOENT where others give ENOTDIR.
20148
20149
20150
20151 .option include_directory redirect string unset
20152 If this option is set, the path names of any &':include:'& items in a
20153 redirection list must start with this directory.
20154
20155
20156 .option modemask redirect "octal integer" 022
20157 This specifies mode bits which must not be set for a file specified by the
20158 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
20159
20160
20161 .option one_time redirect boolean false
20162 .cindex "one-time aliasing/forwarding expansion"
20163 .cindex "alias file" "one-time expansion"
20164 .cindex "forward file" "one-time expansion"
20165 .cindex "mailing lists" "one-time expansion"
20166 .cindex "address redirection" "one-time expansion"
20167 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
20168 files each time it tries to deliver a message causes a problem when one or more
20169 of the generated addresses fails be delivered at the first attempt. The problem
20170 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
20171 but of what happens when the redirection list changes during the time that the
20172 message is on Exim's queue. This is particularly true in the case of mailing
20173 lists, where new subscribers might receive copies of messages that were posted
20174 before they subscribed.
20175
20176 If &%one_time%& is set and any addresses generated by the router fail to
20177 deliver at the first attempt, the failing addresses are added to the message as
20178 &"top level"& addresses, and the parent address that generated them is marked
20179 &"delivered"&. Thus, redirection does not happen again at the next delivery
20180 attempt.
20181
20182 &*Warning 1*&: Any header line addition or removal that is specified by this
20183 router would be lost if delivery did not succeed at the first attempt. For this
20184 reason, the &%headers_add%& and &%headers_remove%& generic options are not
20185 permitted when &%one_time%& is set.
20186
20187 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
20188 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
20189 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
20190
20191 &*Warning 3*&: The &%unseen%& generic router option may not be set with
20192 &%one_time%&.
20193
20194 The original top-level address is remembered with each of the generated
20195 addresses, and is output in any log messages. However, any intermediate parent
20196 addresses are not recorded. This makes a difference to the log only if
20197 &%all_parents%& log selector is set. It is expected that &%one_time%& will
20198 typically be used for mailing lists, where there is normally just one level of
20199 expansion.
20200
20201
20202 .option owners redirect "string list" unset
20203 .cindex "ownership" "alias file"
20204 .cindex "ownership" "forward file"
20205 .cindex "alias file" "ownership"
20206 .cindex "forward file" "ownership"
20207 This specifies a list of permitted owners for the file specified by &%file%&.
20208 This list is in addition to the local user when &%check_local_user%& is set.
20209 See &%check_owner%& above.
20210
20211
20212 .option owngroups redirect "string list" unset
20213 This specifies a list of permitted groups for the file specified by &%file%&.
20214 The list is in addition to the local user's primary group when
20215 &%check_local_user%& is set. See &%check_group%& above.
20216
20217
20218 .option pipe_transport redirect string&!! unset
20219 .vindex "&$address_pipe$&"
20220 A &(redirect)& router sets up a direct delivery to a pipe when a string
20221 starting with a vertical bar character is specified as a new &"address"&. The
20222 transport used is specified by this option, which, after expansion, must be the
20223 name of a configured transport. This should normally be a &(pipe)& transport.
20224 When the transport is run, the pipe command is in &$address_pipe$&.
20225
20226
20227 .option qualify_domain redirect string&!! unset
20228 .vindex "&$qualify_recipient$&"
20229 If this option is set, and an unqualified address (one without a domain) is
20230 generated, and that address would normally be qualified by the global setting
20231 in &%qualify_recipient%&, it is instead qualified with the domain specified by
20232 expanding this string. If the expansion fails, the router declines. If you want
20233 to revert to the default, you can have the expansion generate
20234 &$qualify_recipient$&.
20235
20236 This option applies to all unqualified addresses generated by Exim filters,
20237 but for traditional &_.forward_& files, it applies only to addresses that are
20238 not preceded by a backslash. Sieve filters cannot generate unqualified
20239 addresses.
20240
20241 .option qualify_preserve_domain redirect boolean false
20242 .cindex "domain" "in redirection; preserving"
20243 .cindex "preserving domain in redirection"
20244 .cindex "address redirection" "domain; preserving"
20245 If this option is set, the router's local &%qualify_domain%& option must not be
20246 set (a configuration error occurs if it is). If an unqualified address (one
20247 without a domain) is generated, it is qualified with the domain of the parent
20248 address (the immediately preceding ancestor) instead of the global
20249 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
20250 this applies whether or not the address is preceded by a backslash.
20251
20252
20253 .option repeat_use redirect boolean true
20254 If this option is set false, the router is skipped for a child address that has
20255 any ancestor that was routed by this router. This test happens before any of
20256 the other preconditions are tested. Exim's default anti-looping rules skip
20257 only when the ancestor is the same as the current address. See also
20258 &%check_ancestor%& above and the generic &%redirect_router%& option.
20259
20260
20261 .option reply_transport redirect string&!! unset
20262 A &(redirect)& router sets up an automatic reply when a &%mail%& or
20263 &%vacation%& command is used in a filter file. The transport used is specified
20264 by this option, which, after expansion, must be the name of a configured
20265 transport. This should normally be an &(autoreply)& transport. Other transports
20266 are unlikely to do anything sensible or useful.
20267
20268
20269 .option rewrite redirect boolean true
20270 .cindex "address redirection" "disabling rewriting"
20271 If this option is set false, addresses generated by the router are not
20272 subject to address rewriting. Otherwise, they are treated like new addresses
20273 and are rewritten according to the global rewriting rules.
20274
20275
20276 .option sieve_subaddress redirect string&!! unset
20277 The value of this option is passed to a Sieve filter to specify the
20278 :subaddress part of an address.
20279
20280 .option sieve_useraddress redirect string&!! unset
20281 The value of this option is passed to a Sieve filter to specify the :user part
20282 of an address. However, if it is unset, the entire original local part
20283 (including any prefix or suffix) is used for :user.
20284
20285
20286 .option sieve_vacation_directory redirect string&!! unset
20287 .cindex "Sieve filter" "vacation directory"
20288 To enable the &"vacation"& extension for Sieve filters, you must set
20289 &%sieve_vacation_directory%& to the directory where vacation databases are held
20290 (do not put anything else in that directory), and ensure that the
20291 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
20292 needs their own directory; Exim will create it if necessary.
20293
20294
20295
20296 .option skip_syntax_errors redirect boolean false
20297 .cindex "forward file" "broken"
20298 .cindex "address redirection" "broken files"
20299 .cindex "alias file" "broken"
20300 .cindex "broken alias or forward files"
20301 .cindex "ignoring faulty addresses"
20302 .cindex "skipping faulty addresses"
20303 .cindex "error" "skipping bad syntax"
20304 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
20305 non-filter redirection data are skipped, and each failing address is logged. If
20306 &%syntax_errors_to%& is set, a message is sent to the address it defines,
20307 giving details of the failures. If &%syntax_errors_text%& is set, its contents
20308 are expanded and placed at the head of the error message generated by
20309 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
20310 be the same address as the generic &%errors_to%& option. The
20311 &%skip_syntax_errors%& option is often used when handling mailing lists.
20312
20313 If all the addresses in a redirection list are skipped because of syntax
20314 errors, the router declines to handle the original address, and it is passed to
20315 the following routers.
20316
20317 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
20318 error in the filter causes filtering to be abandoned without any action being
20319 taken. The incident is logged, and the router declines to handle the address,
20320 so it is passed to the following routers.
20321
20322 .cindex "Sieve filter" "syntax errors in"
20323 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
20324 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
20325 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
20326
20327 &%skip_syntax_errors%& can be used to specify that errors in users' forward
20328 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
20329 option, used with an address that does not get redirected, can be used to
20330 notify users of these errors, by means of a router like this:
20331 .code
20332 userforward:
20333   driver = redirect
20334   allow_filter
20335   check_local_user
20336   file = $home/.forward
20337   file_transport = address_file
20338   pipe_transport = address_pipe
20339   reply_transport = address_reply
20340   no_verify
20341   skip_syntax_errors
20342   syntax_errors_to = real-$local_part@$domain
20343   syntax_errors_text = \
20344    This is an automatically generated message. An error has\n\
20345    been found in your .forward file. Details of the error are\n\
20346    reported below. While this error persists, you will receive\n\
20347    a copy of this message for every message that is addressed\n\
20348    to you. If your .forward file is a filter file, or if it is\n\
20349    a non-filter file containing no valid forwarding addresses,\n\
20350    a copy of each incoming message will be put in your normal\n\
20351    mailbox. If a non-filter file contains at least one valid\n\
20352    forwarding address, forwarding to the valid addresses will\n\
20353    happen, and those will be the only deliveries that occur.
20354 .endd
20355 You also need a router to ensure that local addresses that are prefixed by
20356 &`real-`& are recognized, but not forwarded or filtered. For example, you could
20357 put this immediately before the &(userforward)& router:
20358 .code
20359 real_localuser:
20360   driver = accept
20361   check_local_user
20362   local_part_prefix = real-
20363   transport = local_delivery
20364 .endd
20365 For security, it would probably be a good idea to restrict the use of this
20366 router to locally-generated messages, using a condition such as this:
20367 .code
20368   condition = ${if match {$sender_host_address}\
20369                          {\N^(|127\.0\.0\.1)$\N}}
20370 .endd
20371
20372
20373 .option syntax_errors_text redirect string&!! unset
20374 See &%skip_syntax_errors%& above.
20375
20376
20377 .option syntax_errors_to redirect string unset
20378 See &%skip_syntax_errors%& above.
20379 .ecindex IIDredrou1
20380 .ecindex IIDredrou2
20381
20382
20383
20384
20385
20386
20387 . ////////////////////////////////////////////////////////////////////////////
20388 . ////////////////////////////////////////////////////////////////////////////
20389
20390 .chapter "Environment for running local transports" "CHAPenvironment" &&&
20391          "Environment for local transports"
20392 .scindex IIDenvlotra1 "local transports" "environment for"
20393 .scindex IIDenvlotra2 "environment for local transports"
20394 .scindex IIDenvlotra3 "transport" "local; environment for"
20395 Local transports handle deliveries to files and pipes. (The &(autoreply)&
20396 transport can be thought of as similar to a pipe.) Exim always runs transports
20397 in subprocesses, under specified uids and gids. Typical deliveries to local
20398 mailboxes run under the uid and gid of the local user.
20399
20400 Exim also sets a specific current directory while running the transport; for
20401 some transports a home directory setting is also relevant. The &(pipe)&
20402 transport is the only one that sets up environment variables; see section
20403 &<<SECTpipeenv>>& for details.
20404
20405 The values used for the uid, gid, and the directories may come from several
20406 different places. In many cases, the router that handles the address associates
20407 settings with that address as a result of its &%check_local_user%&, &%group%&,
20408 or &%user%& options. However, values may also be given in the transport's own
20409 configuration, and these override anything that comes from the router.
20410
20411
20412
20413 .section "Concurrent deliveries" "SECID131"
20414 .cindex "concurrent deliveries"
20415 .cindex "simultaneous deliveries"
20416 If two different messages for the same local recipient arrive more or less
20417 simultaneously, the two delivery processes are likely to run concurrently. When
20418 the &(appendfile)& transport is used to write to a file, Exim applies locking
20419 rules to stop concurrent processes from writing to the same file at the same
20420 time.
20421
20422 However, when you use a &(pipe)& transport, it is up to you to arrange any
20423 locking that is needed. Here is a silly example:
20424 .code
20425 my_transport:
20426   driver = pipe
20427   command = /bin/sh -c 'cat >>/some/file'
20428 .endd
20429 This is supposed to write the message at the end of the file. However, if two
20430 messages arrive at the same time, the file will be scrambled. You can use the
20431 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
20432 file using the same algorithm that Exim itself uses.
20433
20434
20435
20436
20437 .section "Uids and gids" "SECTenvuidgid"
20438 .cindex "local transports" "uid and gid"
20439 .cindex "transport" "local; uid and gid"
20440 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
20441 overrides any group that the router set in the address, even if &%user%& is not
20442 set for the transport. This makes it possible, for example, to run local mail
20443 delivery under the uid of the recipient (set by the router), but in a special
20444 group (set by the transport). For example:
20445 .code
20446 # Routers ...
20447 # User/group are set by check_local_user in this router
20448 local_users:
20449   driver = accept
20450   check_local_user
20451   transport = group_delivery
20452
20453 # Transports ...
20454 # This transport overrides the group
20455 group_delivery:
20456   driver = appendfile
20457   file = /var/spool/mail/$local_part
20458   group = mail
20459 .endd
20460 If &%user%& is set for a transport, its value overrides what is set in the
20461 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
20462 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
20463 set.
20464
20465 .oindex "&%initgroups%&"
20466 When the uid is taken from the transport's configuration, the &[initgroups()]&
20467 function is called for the groups associated with that uid if the
20468 &%initgroups%& option is set for the transport. When the uid is not specified
20469 by the transport, but is associated with the address by a router, the option
20470 for calling &[initgroups()]& is taken from the router configuration.
20471
20472 .cindex "&(pipe)& transport" "uid for"
20473 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
20474 is set and &%user%& is not set, the uid of the process that called Exim to
20475 receive the message is used, and if &%group%& is not set, the corresponding
20476 original gid is also used.
20477
20478 This is the detailed preference order for obtaining a gid; the first of the
20479 following that is set is used:
20480
20481 .ilist
20482 A &%group%& setting of the transport;
20483 .next
20484 A &%group%& setting of the router;
20485 .next
20486 A gid associated with a user setting of the router, either as a result of
20487 &%check_local_user%& or an explicit non-numeric &%user%& setting;
20488 .next
20489 The group associated with a non-numeric &%user%& setting of the transport;
20490 .next
20491 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
20492 the uid is the creator's uid;
20493 .next
20494 The Exim gid if the Exim uid is being used as a default.
20495 .endlist
20496
20497 If, for example, the user is specified numerically on the router and there are
20498 no group settings, no gid is available. In this situation, an error occurs.
20499 This is different for the uid, for which there always is an ultimate default.
20500 The first of the following that is set is used:
20501
20502 .ilist
20503 A &%user%& setting of the transport;
20504 .next
20505 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
20506 .next
20507 A &%user%& setting of the router;
20508 .next
20509 A &%check_local_user%& setting of the router;
20510 .next
20511 The Exim uid.
20512 .endlist
20513
20514 Of course, an error will still occur if the uid that is chosen is on the
20515 &%never_users%& list.
20516
20517
20518
20519
20520
20521 .section "Current and home directories" "SECID132"
20522 .cindex "current directory for local transport"
20523 .cindex "home directory" "for local transport"
20524 .cindex "transport" "local; home directory for"
20525 .cindex "transport" "local; current directory for"
20526 Routers may set current and home directories for local transports by means of
20527 the &%transport_current_directory%& and &%transport_home_directory%& options.
20528 However, if the transport's &%current_directory%& or &%home_directory%& options
20529 are set, they override the router's values. In detail, the home directory
20530 for a local transport is taken from the first of these values that is set:
20531
20532 .ilist
20533 The &%home_directory%& option on the transport;
20534 .next
20535 The &%transport_home_directory%& option on the router;
20536 .next
20537 The password data if &%check_local_user%& is set on the router;
20538 .next
20539 The &%router_home_directory%& option on the router.
20540 .endlist
20541
20542 The current directory is taken from the first of these values that is set:
20543
20544 .ilist
20545 The &%current_directory%& option on the transport;
20546 .next
20547 The &%transport_current_directory%& option on the router.
20548 .endlist
20549
20550
20551 If neither the router nor the transport sets a current directory, Exim uses the
20552 value of the home directory, if it is set. Otherwise it sets the current
20553 directory to &_/_& before running a local transport.
20554
20555
20556
20557 .section "Expansion variables derived from the address" "SECID133"
20558 .vindex "&$domain$&"
20559 .vindex "&$local_part$&"
20560 .vindex "&$original_domain$&"
20561 Normally a local delivery is handling a single address, and in that case the
20562 variables such as &$domain$& and &$local_part$& are set during local
20563 deliveries. However, in some circumstances more than one address may be handled
20564 at once (for example, while writing batch SMTP for onward transmission by some
20565 other means). In this case, the variables associated with the local part are
20566 never set, &$domain$& is set only if all the addresses have the same domain,
20567 and &$original_domain$& is never set.
20568 .ecindex IIDenvlotra1
20569 .ecindex IIDenvlotra2
20570 .ecindex IIDenvlotra3
20571
20572
20573
20574
20575
20576
20577
20578 . ////////////////////////////////////////////////////////////////////////////
20579 . ////////////////////////////////////////////////////////////////////////////
20580
20581 .chapter "Generic options for transports" "CHAPtransportgeneric"
20582 .scindex IIDgenoptra1 "generic options" "transport"
20583 .scindex IIDgenoptra2 "options" "generic; for transports"
20584 .scindex IIDgenoptra3 "transport" "generic options for"
20585 The following generic options apply to all transports:
20586
20587
20588 .option body_only transports boolean false
20589 .cindex "transport" "body only"
20590 .cindex "message" "transporting body only"
20591 .cindex "body of message" "transporting"
20592 If this option is set, the message's headers are not transported. It is
20593 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
20594 or &(pipe)& transports, the settings of &%message_prefix%& and
20595 &%message_suffix%& should be checked, because this option does not
20596 automatically suppress them.
20597
20598
20599 .option current_directory transports string&!! unset
20600 .cindex "transport" "current directory for"
20601 This specifies the current directory that is to be set while running the
20602 transport, overriding any value that may have been set by the router.
20603 If the expansion fails for any reason, including forced failure, an error is
20604 logged, and delivery is deferred.
20605
20606
20607 .option disable_logging transports boolean false
20608 If this option is set true, nothing is logged for any
20609 deliveries by the transport or for any
20610 transport errors. You should not set this option unless you really, really know
20611 what you are doing.
20612
20613
20614 .option debug_print transports string&!! unset
20615 .cindex "testing" "variables in drivers"
20616 If this option is set and debugging is enabled (see the &%-d%& command line
20617 option), the string is expanded and included in the debugging output when the
20618 transport is run.
20619 If expansion of the string fails, the error message is written to the debugging
20620 output, and Exim carries on processing.
20621 This facility is provided to help with checking out the values of variables and
20622 so on when debugging driver configurations. For example, if a &%headers_add%&
20623 option is not working properly, &%debug_print%& could be used to output the
20624 variables it references. A newline is added to the text if it does not end with
20625 one.
20626 The variables &$transport_name$& and &$router_name$& contain the name of the
20627 transport and the router that called it.
20628
20629 .option delivery_date_add transports boolean false
20630 .cindex "&'Delivery-date:'& header line"
20631 If this option is true, a &'Delivery-date:'& header is added to the message.
20632 This gives the actual time the delivery was made. As this is not a standard
20633 header, Exim has a configuration option (&%delivery_date_remove%&) which
20634 requests its removal from incoming messages, so that delivered messages can
20635 safely be resent to other recipients.
20636
20637
20638 .option driver transports string unset
20639 This specifies which of the available transport drivers is to be used.
20640 There is no default, and this option must be set for every transport.
20641
20642
20643 .option envelope_to_add transports boolean false
20644 .cindex "&'Envelope-to:'& header line"
20645 If this option is true, an &'Envelope-to:'& header is added to the message.
20646 This gives the original address(es) in the incoming envelope that caused this
20647 delivery to happen. More than one address may be present if the transport is
20648 configured to handle several addresses at once, or if more than one original
20649 address was redirected to the same final address. As this is not a standard
20650 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
20651 its removal from incoming messages, so that delivered messages can safely be
20652 resent to other recipients.
20653
20654
20655 .option event_action transports string&!! unset
20656 .cindex events
20657 This option declares a string to be expanded for Exim's events mechanism.
20658 For details see &<<CHAPevents>>&.
20659 .wen
20660
20661
20662 .option group transports string&!! "Exim group"
20663 .cindex "transport" "group; specifying"
20664 This option specifies a gid for running the transport process, overriding any
20665 value that the router supplies, and also overriding any value associated with
20666 &%user%& (see below).
20667
20668
20669 .option headers_add transports list&!! unset
20670 .cindex "header lines" "adding in transport"
20671 .cindex "transport" "header lines; adding"
20672 This option specifies a list of text headers,
20673 newline-separated (by default, changeable in the usual way),
20674 which are (separately) expanded and added to the header
20675 portion of a message as it is transported, as described in section
20676 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
20677 routers. If the result of the expansion is an empty string, or if the expansion
20678 is forced to fail, no action is taken. Other expansion failures are treated as
20679 errors and cause the delivery to be deferred.
20680
20681 Unlike most options, &%headers_add%& can be specified multiple times
20682 for a transport; all listed headers are added.
20683
20684
20685 .option headers_only transports boolean false
20686 .cindex "transport" "header lines only"
20687 .cindex "message" "transporting headers only"
20688 .cindex "header lines" "transporting"
20689 If this option is set, the message's body is not transported. It is mutually
20690 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
20691 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
20692 checked, since this option does not automatically suppress them.
20693
20694
20695 .option headers_remove transports list&!! unset
20696 .cindex "header lines" "removing"
20697 .cindex "transport" "header lines; removing"
20698 This option specifies a list of header names,
20699 colon-separated (by default, changeable in the usual way);
20700 these headers are omitted from the message as it is transported, as described
20701 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
20702 routers.
20703 Each list item is separately expanded.
20704 If the result of the expansion is an empty string, or if the expansion
20705 is forced to fail, no action is taken. Other expansion failures are treated as
20706 errors and cause the delivery to be deferred.
20707
20708 Unlike most options, &%headers_remove%& can be specified multiple times
20709 for a router; all listed headers are removed.
20710
20711 &*Warning*&: Because of the separate expansion of the list items,
20712 items that contain a list separator must have it doubled.
20713 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
20714
20715
20716
20717 .option headers_rewrite transports string unset
20718 .cindex "transport" "header lines; rewriting"
20719 .cindex "rewriting" "at transport time"
20720 This option allows addresses in header lines to be rewritten at transport time,
20721 that is, as the message is being copied to its destination. The contents of the
20722 option are a colon-separated list of rewriting rules. Each rule is in exactly
20723 the same form as one of the general rewriting rules that are applied when a
20724 message is received. These are described in chapter &<<CHAPrewrite>>&. For
20725 example,
20726 .code
20727 headers_rewrite = a@b c@d f : \
20728                   x@y w@z
20729 .endd
20730 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
20731 &'w@z'& in all address-bearing header lines. The rules are applied to the
20732 header lines just before they are written out at transport time, so they affect
20733 only those copies of the message that pass through the transport. However, only
20734 the message's original header lines, and any that were added by a system
20735 filter, are rewritten. If a router or transport adds header lines, they are not
20736 affected by this option. These rewriting rules are &'not'& applied to the
20737 envelope. You can change the return path using &%return_path%&, but you cannot
20738 change envelope recipients at this time.
20739
20740
20741 .option home_directory transports string&!! unset
20742 .cindex "transport" "home directory for"
20743 .vindex "&$home$&"
20744 This option specifies a home directory setting for a local transport,
20745 overriding any value that may be set by the router. The home directory is
20746 placed in &$home$& while expanding the transport's private options. It is also
20747 used as the current directory if no current directory is set by the
20748 &%current_directory%& option on the transport or the
20749 &%transport_current_directory%& option on the router. If the expansion fails
20750 for any reason, including forced failure, an error is logged, and delivery is
20751 deferred.
20752
20753
20754 .option initgroups transports boolean false
20755 .cindex "additional groups"
20756 .cindex "groups" "additional"
20757 .cindex "transport" "group; additional"
20758 If this option is true and the uid for the delivery process is provided by the
20759 transport, the &[initgroups()]& function is called when running the transport
20760 to ensure that any additional groups associated with the uid are set up.
20761
20762
20763 .new
20764 .option max_parallel transports integer&!! unset
20765 .cindex limit "transport parallelism"
20766 .cindex transport "parallel processes"
20767 .cindex transport "concurrency limit"
20768 .cindex "delivery" "parallelism for transport"
20769 If this option is set and expands to an integer greater than zero
20770 it limits the number of concurrent runs of the transport.
20771 The control does not apply to shadow transports.
20772
20773 .cindex "hints database" "transport concurrency control"
20774 Exim implements this control by means of a hints database in which a record is
20775 incremented whenever a transport process is beaing created. The record
20776 is decremented and possibly removed when the process terminates.
20777 Obviously there is scope for
20778 records to get left lying around if there is a system or program crash. To
20779 guard against this, Exim ignores any records that are more than six hours old.
20780
20781 If you use this option, you should also arrange to delete the
20782 relevant hints database whenever your system reboots. The names of the files
20783 start with &_misc_& and they are kept in the &_spool/db_& directory. There
20784 may be one or two files, depending on the type of DBM in use. The same files
20785 are used for ETRN and smtp transport serialization.
20786 .wen
20787
20788
20789 .option message_size_limit transports string&!! 0
20790 .cindex "limit" "message size per transport"
20791 .cindex "size" "of message, limit"
20792 .cindex "transport" "message size; limiting"
20793 This option controls the size of messages passed through the transport. It is
20794 expanded before use; the result of the expansion must be a sequence of decimal
20795 digits, optionally followed by K or M. If the expansion fails for any reason,
20796 including forced failure, or if the result is not of the required form,
20797 delivery is deferred. If the value is greater than zero and the size of a
20798 message exceeds this limit, the address is failed. If there is any chance that
20799 the resulting bounce message could be routed to the same transport, you should
20800 ensure that &%return_size_limit%& is less than the transport's
20801 &%message_size_limit%&, as otherwise the bounce message will fail to get
20802 delivered.
20803
20804
20805
20806 .option rcpt_include_affixes transports boolean false
20807 .cindex "prefix" "for local part, including in envelope"
20808 .cindex "suffix for local part" "including in envelope"
20809 .cindex "local part" "prefix"
20810 .cindex "local part" "suffix"
20811 When this option is false (the default), and an address that has had any
20812 affixes (prefixes or suffixes) removed from the local part is delivered by any
20813 form of SMTP or LMTP, the affixes are not included. For example, if a router
20814 that contains
20815 .code
20816 local_part_prefix = *-
20817 .endd
20818 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
20819 is delivered with
20820 .code
20821 RCPT TO:<xyz@some.domain>
20822 .endd
20823 This is also the case when an ACL-time callout is being used to verify a
20824 recipient address. However, if &%rcpt_include_affixes%& is set true, the
20825 whole local part is included in the RCPT command. This option applies to BSMTP
20826 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
20827 &(lmtp)& and &(smtp)& transports.
20828
20829
20830 .option retry_use_local_part transports boolean "see below"
20831 .cindex "hints database" "retry keys"
20832 When a delivery suffers a temporary failure, a retry record is created
20833 in Exim's hints database. For remote deliveries, the key for the retry record
20834 is based on the name and/or IP address of the failing remote host. For local
20835 deliveries, the key is normally the entire address, including both the local
20836 part and the domain. This is suitable for most common cases of local delivery
20837 temporary failure &-- for example, exceeding a mailbox quota should delay only
20838 deliveries to that mailbox, not to the whole domain.
20839
20840 However, in some special cases you may want to treat a temporary local delivery
20841 as a failure associated with the domain, and not with a particular local part.
20842 (For example, if you are storing all mail for some domain in files.) You can do
20843 this by setting &%retry_use_local_part%& false.
20844
20845 For all the local transports, its default value is true. For remote transports,
20846 the default value is false for tidiness, but changing the value has no effect
20847 on a remote transport in the current implementation.
20848
20849
20850 .option return_path transports string&!! unset
20851 .cindex "envelope sender"
20852 .cindex "transport" "return path; changing"
20853 .cindex "return path" "changing in transport"
20854 If this option is set, the string is expanded at transport time and replaces
20855 the existing return path (envelope sender) value in the copy of the message
20856 that is being delivered. An empty return path is permitted. This feature is
20857 designed for remote deliveries, where the value of this option is used in the
20858 SMTP MAIL command. If you set &%return_path%& for a local transport, the
20859 only effect is to change the address that is placed in the &'Return-path:'&
20860 header line, if one is added to the message (see the next option).
20861
20862 &*Note:*& A changed return path is not logged unless you add
20863 &%return_path_on_delivery%& to the log selector.
20864
20865 .vindex "&$return_path$&"
20866 The expansion can refer to the existing value via &$return_path$&. This is
20867 either the message's envelope sender, or an address set by the
20868 &%errors_to%& option on a router. If the expansion is forced to fail, no
20869 replacement occurs; if it fails for another reason, delivery is deferred. This
20870 option can be used to support VERP (Variable Envelope Return Paths) &-- see
20871 section &<<SECTverp>>&.
20872
20873 &*Note*&: If a delivery error is detected locally, including the case when a
20874 remote server rejects a message at SMTP time, the bounce message is not sent to
20875 the value of this option. It is sent to the previously set errors address.
20876 This defaults to the incoming sender address, but can be changed by setting
20877 &%errors_to%& in a router.
20878
20879
20880
20881 .option return_path_add transports boolean false
20882 .cindex "&'Return-path:'& header line"
20883 If this option is true, a &'Return-path:'& header is added to the message.
20884 Although the return path is normally available in the prefix line of BSD
20885 mailboxes, this is commonly not displayed by MUAs, and so the user does not
20886 have easy access to it.
20887
20888 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
20889 the delivery SMTP server makes the final delivery"&. This implies that this
20890 header should not be present in incoming messages. Exim has a configuration
20891 option, &%return_path_remove%&, which requests removal of this header from
20892 incoming messages, so that delivered messages can safely be resent to other
20893 recipients.
20894
20895
20896 .option shadow_condition transports string&!! unset
20897 See &%shadow_transport%& below.
20898
20899
20900 .option shadow_transport transports string unset
20901 .cindex "shadow transport"
20902 .cindex "transport" "shadow"
20903 A local transport may set the &%shadow_transport%& option to the name of
20904 another local transport. Shadow remote transports are not supported.
20905
20906 Whenever a delivery to the main transport succeeds, and either
20907 &%shadow_condition%& is unset, or its expansion does not result in the empty
20908 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
20909 passed to the shadow transport, with the same delivery address or addresses. If
20910 expansion fails, no action is taken except that non-forced expansion failures
20911 cause a log line to be written.
20912
20913 The result of the shadow transport is discarded and does not affect the
20914 subsequent processing of the message. Only a single level of shadowing is
20915 provided; the &%shadow_transport%& option is ignored on any transport when it
20916 is running as a shadow. Options concerned with output from pipes are also
20917 ignored. The log line for the successful delivery has an item added on the end,
20918 of the form
20919 .code
20920 ST=<shadow transport name>
20921 .endd
20922 If the shadow transport did not succeed, the error message is put in
20923 parentheses afterwards. Shadow transports can be used for a number of different
20924 purposes, including keeping more detailed log information than Exim normally
20925 provides, and implementing automatic acknowledgment policies based on message
20926 headers that some sites insist on.
20927
20928
20929 .option transport_filter transports string&!! unset
20930 .cindex "transport" "filter"
20931 .cindex "filter" "transport filter"
20932 This option sets up a filtering (in the Unix shell sense) process for messages
20933 at transport time. It should not be confused with mail filtering as set up by
20934 individual users or via a system filter.
20935 .new
20936 If unset, or expanding to an empty string, no filtering is done.
20937 .wen
20938
20939 When the message is about to be written out, the command specified by
20940 &%transport_filter%& is started up in a separate, parallel process, and
20941 the entire message, including the header lines, is passed to it on its standard
20942 input (this in fact is done from a third process, to avoid deadlock). The
20943 command must be specified as an absolute path.
20944
20945 The lines of the message that are written to the transport filter are
20946 terminated by newline (&"\n"&). The message is passed to the filter before any
20947 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
20948 lines beginning with a dot, and also before any processing implied by the
20949 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
20950 &(pipe)& transports.
20951
20952 The standard error for the filter process is set to the same destination as its
20953 standard output; this is read and written to the message's ultimate
20954 destination. The process that writes the message to the filter, the
20955 filter itself, and the original process that reads the result and delivers it
20956 are all run in parallel, like a shell pipeline.
20957
20958 The filter can perform any transformations it likes, but of course should take
20959 care not to break RFC 2822 syntax. Exim does not check the result, except to
20960 test for a final newline when SMTP is in use. All messages transmitted over
20961 SMTP must end with a newline, so Exim supplies one if it is missing.
20962
20963 .cindex "content scanning" "per user"
20964 A transport filter can be used to provide content-scanning on a per-user basis
20965 at delivery time if the only required effect of the scan is to modify the
20966 message. For example, a content scan could insert a new header line containing
20967 a spam score. This could be interpreted by a filter in the user's MUA. It is
20968 not possible to discard a message at this stage.
20969
20970 .cindex "SMTP" "SIZE"
20971 A problem might arise if the filter increases the size of a message that is
20972 being sent down an SMTP connection. If the receiving SMTP server has indicated
20973 support for the SIZE parameter, Exim will have sent the size of the message
20974 at the start of the SMTP session. If what is actually sent is substantially
20975 more, the server might reject the message. This can be worked round by setting
20976 the &%size_addition%& option on the &(smtp)& transport, either to allow for
20977 additions to the message, or to disable the use of SIZE altogether.
20978
20979 .vindex "&$pipe_addresses$&"
20980 The value of the &%transport_filter%& option is the command string for starting
20981 the filter, which is run directly from Exim, not under a shell. The string is
20982 parsed by Exim in the same way as a command string for the &(pipe)& transport:
20983 Exim breaks it up into arguments and then expands each argument separately (see
20984 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
20985 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
20986 of arguments, one for each address that applies to this delivery. (This isn't
20987 an ideal name for this feature here, but as it was already implemented for the
20988 &(pipe)& transport, it seemed sensible not to change it.)
20989
20990 .vindex "&$host$&"
20991 .vindex "&$host_address$&"
20992 The expansion variables &$host$& and &$host_address$& are available when the
20993 transport is a remote one. They contain the name and IP address of the host to
20994 which the message is being sent. For example:
20995 .code
20996 transport_filter = /some/directory/transport-filter.pl \
20997   $host $host_address $sender_address $pipe_addresses
20998 .endd
20999
21000 Two problems arise if you want to use more complicated expansion items to
21001 generate transport filter commands, both of which due to the fact that the
21002 command is split up &'before'& expansion.
21003 .ilist
21004 If an expansion item contains white space, you must quote it, so that it is all
21005 part of the same command item. If the entire option setting is one such
21006 expansion item, you have to take care what kind of quoting you use. For
21007 example:
21008 .code
21009 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
21010 .endd
21011 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
21012 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
21013 stripped by Exim when it read the option's value. When the value is used, if
21014 the single quotes were missing, the line would be split into two items,
21015 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
21016 Exim tried to expand the first one.
21017 .next
21018 Except for the special case of &$pipe_addresses$& that is mentioned above, an
21019 expansion cannot generate multiple arguments, or a command name followed by
21020 arguments. Consider this example:
21021 .code
21022 transport_filter = ${lookup{$host}lsearch{/a/file}\
21023                     {$value}{/bin/cat}}
21024 .endd
21025 The result of the lookup is interpreted as the name of the command, even
21026 if it contains white space. The simplest way round this is to use a shell:
21027 .code
21028 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
21029                                {$value}{/bin/cat}}
21030 .endd
21031 .endlist
21032
21033 The filter process is run under the same uid and gid as the normal delivery.
21034 For remote deliveries this is the Exim uid/gid by default. The command should
21035 normally yield a zero return code. Transport filters are not supposed to fail.
21036 A non-zero code is taken to mean that the transport filter encountered some
21037 serious problem. Delivery of the message is deferred; the message remains on
21038 the queue and is tried again later. It is not possible to cause a message to be
21039 bounced from a transport filter.
21040
21041 If a transport filter is set on an autoreply transport, the original message is
21042 passed through the filter as it is being copied into the newly generated
21043 message, which happens if the &%return_message%& option is set.
21044
21045
21046 .option transport_filter_timeout transports time 5m
21047 .cindex "transport" "filter, timeout"
21048 When Exim is reading the output of a transport filter, it applies a timeout
21049 that can be set by this option. Exceeding the timeout is normally treated as a
21050 temporary delivery failure. However, if a transport filter is used with a
21051 &(pipe)& transport, a timeout in the transport filter is treated in the same
21052 way as a timeout in the pipe command itself. By default, a timeout is a hard
21053 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
21054 becomes a temporary error.
21055
21056
21057 .option user transports string&!! "Exim user"
21058 .cindex "uid (user id)" "local delivery"
21059 .cindex "transport" "user, specifying"
21060 This option specifies the user under whose uid the delivery process is to be
21061 run, overriding any uid that may have been set by the router. If the user is
21062 given as a name, the uid is looked up from the password data, and the
21063 associated group is taken as the value of the gid to be used if the &%group%&
21064 option is not set.
21065
21066 For deliveries that use local transports, a user and group are normally
21067 specified explicitly or implicitly (for example, as a result of
21068 &%check_local_user%&) by the router or transport.
21069
21070 .cindex "hints database" "access by remote transport"
21071 For remote transports, you should leave this option unset unless you really are
21072 sure you know what you are doing. When a remote transport is running, it needs
21073 to be able to access Exim's hints databases, because each host may have its own
21074 retry data.
21075 .ecindex IIDgenoptra1
21076 .ecindex IIDgenoptra2
21077 .ecindex IIDgenoptra3
21078
21079
21080
21081
21082
21083
21084 . ////////////////////////////////////////////////////////////////////////////
21085 . ////////////////////////////////////////////////////////////////////////////
21086
21087 .chapter "Address batching in local transports" "CHAPbatching" &&&
21088          "Address batching"
21089 .cindex "transport" "local; address batching in"
21090 The only remote transport (&(smtp)&) is normally configured to handle more than
21091 one address at a time, so that when several addresses are routed to the same
21092 remote host, just one copy of the message is sent. Local transports, however,
21093 normally handle one address at a time. That is, a separate instance of the
21094 transport is run for each address that is routed to the transport. A separate
21095 copy of the message is delivered each time.
21096
21097 .cindex "batched local delivery"
21098 .oindex "&%batch_max%&"
21099 .oindex "&%batch_id%&"
21100 In special cases, it may be desirable to handle several addresses at once in a
21101 local transport, for example:
21102
21103 .ilist
21104 In an &(appendfile)& transport, when storing messages in files for later
21105 delivery by some other means, a single copy of the message with multiple
21106 recipients saves space.
21107 .next
21108 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
21109 a single copy saves time, and is the normal way LMTP is expected to work.
21110 .next
21111 In a &(pipe)& transport, when passing the message
21112 to a scanner program or
21113 to some other delivery mechanism such as UUCP, multiple recipients may be
21114 acceptable.
21115 .endlist
21116
21117 These three local transports all have the same options for controlling multiple
21118 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
21119 repeating the information for each transport, these options are described here.
21120
21121 The &%batch_max%& option specifies the maximum number of addresses that can be
21122 delivered together in a single run of the transport. Its default value is one
21123 (no batching). When more than one address is routed to a transport that has a
21124 &%batch_max%& value greater than one, the addresses are delivered in a batch
21125 (that is, in a single run of the transport with multiple recipients), subject
21126 to certain conditions:
21127
21128 .ilist
21129 .vindex "&$local_part$&"
21130 If any of the transport's options contain a reference to &$local_part$&, no
21131 batching is possible.
21132 .next
21133 .vindex "&$domain$&"
21134 If any of the transport's options contain a reference to &$domain$&, only
21135 addresses with the same domain are batched.
21136 .next
21137 .cindex "customizing" "batching condition"
21138 If &%batch_id%& is set, it is expanded for each address, and only those
21139 addresses with the same expanded value are batched. This allows you to specify
21140 customized batching conditions. Failure of the expansion for any reason,
21141 including forced failure, disables batching, but it does not stop the delivery
21142 from taking place.
21143 .next
21144 Batched addresses must also have the same errors address (where to send
21145 delivery errors), the same header additions and removals, the same user and
21146 group for the transport, and if a host list is present, the first host must
21147 be the same.
21148 .endlist
21149
21150 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
21151 both when the file or pipe command is specified in the transport, and when it
21152 is specified by a &(redirect)& router, but all the batched addresses must of
21153 course be routed to the same file or pipe command. These two transports have an
21154 option called &%use_bsmtp%&, which causes them to deliver the message in
21155 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
21156 &%check_string%& and &%escape_string%& options are forced to the values
21157 .code
21158 check_string = "."
21159 escape_string = ".."
21160 .endd
21161 when batched SMTP is in use. A full description of the batch SMTP mechanism is
21162 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
21163 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
21164
21165 .cindex "&'Envelope-to:'& header line"
21166 If the generic &%envelope_to_add%& option is set for a batching transport, the
21167 &'Envelope-to:'& header that is added to the message contains all the addresses
21168 that are being processed together. If you are using a batching &(appendfile)&
21169 transport without &%use_bsmtp%&, the only way to preserve the recipient
21170 addresses is to set the &%envelope_to_add%& option.
21171
21172 .cindex "&(pipe)& transport" "with multiple addresses"
21173 .vindex "&$pipe_addresses$&"
21174 If you are using a &(pipe)& transport without BSMTP, and setting the
21175 transport's &%command%& option, you can include &$pipe_addresses$& as part of
21176 the command. This is not a true variable; it is a bit of magic that causes each
21177 of the recipient addresses to be inserted into the command as a separate
21178 argument. This provides a way of accessing all the addresses that are being
21179 delivered in the batch. &*Note:*& This is not possible for pipe commands that
21180 are specified by a &(redirect)& router.
21181
21182
21183
21184
21185 . ////////////////////////////////////////////////////////////////////////////
21186 . ////////////////////////////////////////////////////////////////////////////
21187
21188 .chapter "The appendfile transport" "CHAPappendfile"
21189 .scindex IIDapptra1 "&(appendfile)& transport"
21190 .scindex IIDapptra2 "transports" "&(appendfile)&"
21191 .cindex "directory creation"
21192 .cindex "creating directories"
21193 The &(appendfile)& transport delivers a message by appending it to an existing
21194 file, or by creating an entirely new file in a specified directory. Single
21195 files to which messages are appended can be in the traditional Unix mailbox
21196 format, or optionally in the MBX format supported by the Pine MUA and
21197 University of Washington IMAP daemon, &'inter alia'&. When each message is
21198 being delivered as a separate file, &"maildir"& format can optionally be used
21199 to give added protection against failures that happen part-way through the
21200 delivery. A third form of separate-file delivery known as &"mailstore"& is also
21201 supported. For all file formats, Exim attempts to create as many levels of
21202 directory as necessary, provided that &%create_directory%& is set.
21203
21204 The code for the optional formats is not included in the Exim binary by
21205 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
21206 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
21207 included.
21208
21209 .cindex "quota" "system"
21210 Exim recognizes system quota errors, and generates an appropriate message. Exim
21211 also supports its own quota control within the transport, for use when the
21212 system facility is unavailable or cannot be used for some reason.
21213
21214 If there is an error while appending to a file (for example, quota exceeded or
21215 partition filled), Exim attempts to reset the file's length and last
21216 modification time back to what they were before. If there is an error while
21217 creating an entirely new file, the new file is removed.
21218
21219 Before appending to a file, a number of security checks are made, and the
21220 file is locked. A detailed description is given below, after the list of
21221 private options.
21222
21223 The &(appendfile)& transport is most commonly used for local deliveries to
21224 users' mailboxes. However, it can also be used as a pseudo-remote transport for
21225 putting messages into files for remote delivery by some means other than Exim.
21226 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
21227 option).
21228
21229
21230
21231 .section "The file and directory options" "SECTfildiropt"
21232 The &%file%& option specifies a single file, to which the message is appended;
21233 the &%directory%& option specifies a directory, in which a new file containing
21234 the message is created. Only one of these two options can be set, and for
21235 normal deliveries to mailboxes, one of them &'must'& be set.
21236
21237 .vindex "&$address_file$&"
21238 .vindex "&$local_part$&"
21239 However, &(appendfile)& is also used for delivering messages to files or
21240 directories whose names (or parts of names) are obtained from alias,
21241 forwarding, or filtering operations (for example, a &%save%& command in a
21242 user's Exim filter). When such a transport is running, &$local_part$& contains
21243 the local part that was aliased or forwarded, and &$address_file$& contains the
21244 name (or partial name) of the file or directory generated by the redirection
21245 operation. There are two cases:
21246
21247 .ilist
21248 If neither &%file%& nor &%directory%& is set, the redirection operation
21249 must specify an absolute path (one that begins with &`/`&). This is the most
21250 common case when users with local accounts use filtering to sort mail into
21251 different folders. See for example, the &(address_file)& transport in the
21252 default configuration. If the path ends with a slash, it is assumed to be the
21253 name of a directory. A delivery to a directory can also be forced by setting
21254 &%maildir_format%& or &%mailstore_format%&.
21255 .next
21256 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
21257 used to determine the file or directory name for the delivery. Normally, the
21258 contents of &$address_file$& are used in some way in the string expansion.
21259 .endlist
21260
21261
21262 .cindex "Sieve filter" "configuring &(appendfile)&"
21263 .cindex "Sieve filter" "relative mailbox path handling"
21264 As an example of the second case, consider an environment where users do not
21265 have home directories. They may be permitted to use Exim filter commands of the
21266 form:
21267 .code
21268 save folder23
21269 .endd
21270 or Sieve filter commands of the form:
21271 .code
21272 require "fileinto";
21273 fileinto "folder23";
21274 .endd
21275 In this situation, the expansion of &%file%& or &%directory%& in the transport
21276 must transform the relative path into an appropriate absolute file name. In the
21277 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
21278 is used as a result of a &"keep"& action in the filter. This example shows one
21279 way of handling this requirement:
21280 .code
21281 file = ${if eq{$address_file}{inbox} \
21282             {/var/mail/$local_part} \
21283             {${if eq{${substr_0_1:$address_file}}{/} \
21284                   {$address_file} \
21285                   {$home/mail/$address_file} \
21286             }} \
21287        }
21288 .endd
21289 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
21290 location, absolute paths are used without change, and other folders are in the
21291 &_mail_& directory within the home directory.
21292
21293 &*Note 1*&: While processing an Exim filter, a relative path such as
21294 &_folder23_& is turned into an absolute path if a home directory is known to
21295 the router. In particular, this is the case if &%check_local_user%& is set. If
21296 you want to prevent this happening at routing time, you can set
21297 &%router_home_directory%& empty. This forces the router to pass the relative
21298 path to the transport.
21299
21300 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
21301 the &%file%& or &%directory%& option is still used if it is set.
21302
21303
21304
21305
21306 .section "Private options for appendfile" "SECID134"
21307 .cindex "options" "&(appendfile)& transport"
21308
21309
21310
21311 .option allow_fifo appendfile boolean false
21312 .cindex "fifo (named pipe)"
21313 .cindex "named pipe (fifo)"
21314 .cindex "pipe" "named (fifo)"
21315 Setting this option permits delivery to named pipes (FIFOs) as well as to
21316 regular files. If no process is reading the named pipe at delivery time, the
21317 delivery is deferred.
21318
21319
21320 .option allow_symlink appendfile boolean false
21321 .cindex "symbolic link" "to mailbox"
21322 .cindex "mailbox" "symbolic link"
21323 By default, &(appendfile)& will not deliver if the path name for the file is
21324 that of a symbolic link. Setting this option relaxes that constraint, but there
21325 are security issues involved in the use of symbolic links. Be sure you know
21326 what you are doing if you set this. Details of exactly what this option affects
21327 are included in the discussion which follows this list of options.
21328
21329
21330 .option batch_id appendfile string&!! unset
21331 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21332 However, batching is automatically disabled for &(appendfile)& deliveries that
21333 happen as a result of forwarding or aliasing or other redirection directly to a
21334 file.
21335
21336
21337 .option batch_max appendfile integer 1
21338 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21339
21340
21341 .option check_group appendfile boolean false
21342 When this option is set, the group owner of the file defined by the &%file%&
21343 option is checked to see that it is the same as the group under which the
21344 delivery process is running. The default setting is false because the default
21345 file mode is 0600, which means that the group is irrelevant.
21346
21347
21348 .option check_owner appendfile boolean true
21349 When this option is set, the owner of the file defined by the &%file%& option
21350 is checked to ensure that it is the same as the user under which the delivery
21351 process is running.
21352
21353
21354 .option check_string appendfile string "see below"
21355 .cindex "&""From""& line"
21356 As &(appendfile)& writes the message, the start of each line is tested for
21357 matching &%check_string%&, and if it does, the initial matching characters are
21358 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
21359 a literal string, not a regular expression, and the case of any letters it
21360 contains is significant.
21361
21362 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
21363 are forced to &"."& and &".."& respectively, and any settings in the
21364 configuration are ignored. Otherwise, they default to &"From&~"& and
21365 &">From&~"& when the &%file%& option is set, and unset when any of the
21366 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
21367
21368 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
21369 suitable for traditional &"BSD"& mailboxes, where a line beginning with
21370 &"From&~"& indicates the start of a new message. All four options need changing
21371 if another format is used. For example, to deliver to mailboxes in MMDF format:
21372 .cindex "MMDF format mailbox"
21373 .cindex "mailbox" "MMDF format"
21374 .code
21375 check_string = "\1\1\1\1\n"
21376 escape_string = "\1\1\1\1 \n"
21377 message_prefix = "\1\1\1\1\n"
21378 message_suffix = "\1\1\1\1\n"
21379 .endd
21380 .option create_directory appendfile boolean true
21381 .cindex "directory creation"
21382 When this option is true, Exim attempts to create any missing superior
21383 directories for the file that it is about to write. A created directory's mode
21384 is given by the &%directory_mode%& option.
21385
21386 The group ownership of a newly created directory is highly dependent on the
21387 operating system (and possibly the file system) that is being used. For
21388 example, in Solaris, if the parent directory has the setgid bit set, its group
21389 is propagated to the child; if not, the currently set group is used. However,
21390 in FreeBSD, the parent's group is always used.
21391
21392
21393
21394 .option create_file appendfile string anywhere
21395 This option constrains the location of files and directories that are created
21396 by this transport. It applies to files defined by the &%file%& option and
21397 directories defined by the &%directory%& option. In the case of maildir
21398 delivery, it applies to the top level directory, not the maildir directories
21399 beneath.
21400
21401 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
21402 &"belowhome"&. In the second and third cases, a home directory must have been
21403 set for the transport. This option is not useful when an explicit file name is
21404 given for normal mailbox deliveries. It is intended for the case when file
21405 names are generated from users' &_.forward_& files. These are usually handled
21406 by an &(appendfile)& transport called &%address_file%&. See also
21407 &%file_must_exist%&.
21408
21409
21410 .option directory appendfile string&!! unset
21411 This option is mutually exclusive with the &%file%& option, but one of &%file%&
21412 or &%directory%& must be set, unless the delivery is the direct result of a
21413 redirection (see section &<<SECTfildiropt>>&).
21414
21415 When &%directory%& is set, the string is expanded, and the message is delivered
21416 into a new file or files in or below the given directory, instead of being
21417 appended to a single mailbox file. A number of different formats are provided
21418 (see &%maildir_format%& and &%mailstore_format%&), and see section
21419 &<<SECTopdir>>& for further details of this form of delivery.
21420
21421
21422 .option directory_file appendfile string&!! "see below"
21423 .cindex "base62"
21424 .vindex "&$inode$&"
21425 When &%directory%& is set, but neither &%maildir_format%& nor
21426 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
21427 whose name is obtained by expanding this string. The default value is:
21428 .code
21429 q${base62:$tod_epoch}-$inode
21430 .endd
21431 This generates a unique name from the current time, in base 62 form, and the
21432 inode of the file. The variable &$inode$& is available only when expanding this
21433 option.
21434
21435
21436 .option directory_mode appendfile "octal integer" 0700
21437 If &(appendfile)& creates any directories as a result of the
21438 &%create_directory%& option, their mode is specified by this option.
21439
21440
21441 .option escape_string appendfile string "see description"
21442 See &%check_string%& above.
21443
21444
21445 .option file appendfile string&!! unset
21446 This option is mutually exclusive with the &%directory%& option, but one of
21447 &%file%& or &%directory%& must be set, unless the delivery is the direct result
21448 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
21449 specifies a single file, to which the message is appended. One or more of
21450 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
21451 &%file%&.
21452
21453 .cindex "NFS" "lock file"
21454 .cindex "locking files"
21455 .cindex "lock files"
21456 If you are using more than one host to deliver over NFS into the same
21457 mailboxes, you should always use lock files.
21458
21459 The string value is expanded for each delivery, and must yield an absolute
21460 path. The most common settings of this option are variations on one of these
21461 examples:
21462 .code
21463 file = /var/spool/mail/$local_part
21464 file = /home/$local_part/inbox
21465 file = $home/inbox
21466 .endd
21467 .cindex "&""sticky""& bit"
21468 In the first example, all deliveries are done into the same directory. If Exim
21469 is configured to use lock files (see &%use_lockfile%& below) it must be able to
21470 create a file in the directory, so the &"sticky"& bit must be turned on for
21471 deliveries to be possible, or alternatively the &%group%& option can be used to
21472 run the delivery under a group id which has write access to the directory.
21473
21474
21475
21476 .option file_format appendfile string unset
21477 .cindex "file" "mailbox; checking existing format"
21478 This option requests the transport to check the format of an existing file
21479 before adding to it. The check consists of matching a specific string at the
21480 start of the file. The value of the option consists of an even number of
21481 colon-separated strings. The first of each pair is the test string, and the
21482 second is the name of a transport. If the transport associated with a matched
21483 string is not the current transport, control is passed over to the other
21484 transport. For example, suppose the standard &(local_delivery)& transport has
21485 this added to it:
21486 .code
21487 file_format = "From       : local_delivery :\
21488                \1\1\1\1\n : local_mmdf_delivery"
21489 .endd
21490 Mailboxes that begin with &"From"& are still handled by this transport, but if
21491 a mailbox begins with four binary ones followed by a newline, control is passed
21492 to a transport called &%local_mmdf_delivery%&, which presumably is configured
21493 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
21494 is assumed to match the current transport. If the start of a mailbox doesn't
21495 match any string, or if the transport named for a given string is not defined,
21496 delivery is deferred.
21497
21498
21499 .option file_must_exist appendfile boolean false
21500 If this option is true, the file specified by the &%file%& option must exist.
21501 A temporary error occurs if it does not, causing delivery to be deferred.
21502 If this option is false, the file is created if it does not exist.
21503
21504
21505 .option lock_fcntl_timeout appendfile time 0s
21506 .cindex "timeout" "mailbox locking"
21507 .cindex "mailbox" "locking, blocking and non-blocking"
21508 .cindex "locking files"
21509 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
21510 when locking an open mailbox file. If the call fails, the delivery process
21511 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
21512 Non-blocking calls are used so that the file is not kept open during the wait
21513 for the lock; the reason for this is to make it as safe as possible for
21514 deliveries over NFS in the case when processes might be accessing an NFS
21515 mailbox without using a lock file. This should not be done, but
21516 misunderstandings and hence misconfigurations are not unknown.
21517
21518 On a busy system, however, the performance of a non-blocking lock approach is
21519 not as good as using a blocking lock with a timeout. In this case, the waiting
21520 is done inside the system call, and Exim's delivery process acquires the lock
21521 and can proceed as soon as the previous lock holder releases it.
21522
21523 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
21524 timeout, are used. There may still be some retrying: the maximum number of
21525 retries is
21526 .code
21527 (lock_retries * lock_interval) / lock_fcntl_timeout
21528 .endd
21529 rounded up to the next whole number. In other words, the total time during
21530 which &(appendfile)& is trying to get a lock is roughly the same, unless
21531 &%lock_fcntl_timeout%& is set very large.
21532
21533 You should consider setting this option if you are getting a lot of delayed
21534 local deliveries because of errors of the form
21535 .code
21536 failed to lock mailbox /some/file (fcntl)
21537 .endd
21538
21539 .option lock_flock_timeout appendfile time 0s
21540 This timeout applies to file locking when using &[flock()]& (see
21541 &%use_flock%&); the timeout operates in a similar manner to
21542 &%lock_fcntl_timeout%&.
21543
21544
21545 .option lock_interval appendfile time 3s
21546 This specifies the time to wait between attempts to lock the file. See below
21547 for details of locking.
21548
21549
21550 .option lock_retries appendfile integer 10
21551 This specifies the maximum number of attempts to lock the file. A value of zero
21552 is treated as 1. See below for details of locking.
21553
21554
21555 .option lockfile_mode appendfile "octal integer" 0600
21556 This specifies the mode of the created lock file, when a lock file is being
21557 used (see &%use_lockfile%& and &%use_mbx_lock%&).
21558
21559
21560 .option lockfile_timeout appendfile time 30m
21561 .cindex "timeout" "mailbox locking"
21562 When a lock file is being used (see &%use_lockfile%&), if a lock file already
21563 exists and is older than this value, it is assumed to have been left behind by
21564 accident, and Exim attempts to remove it.
21565
21566
21567 .option mailbox_filecount appendfile string&!! unset
21568 .cindex "mailbox" "specifying size of"
21569 .cindex "size" "of mailbox"
21570 If this option is set, it is expanded, and the result is taken as the current
21571 number of files in the mailbox. It must be a decimal number, optionally
21572 followed by K or M. This provides a way of obtaining this information from an
21573 external source that maintains the data.
21574
21575
21576 .option mailbox_size appendfile string&!! unset
21577 .cindex "mailbox" "specifying size of"
21578 .cindex "size" "of mailbox"
21579 If this option is set, it is expanded, and the result is taken as the current
21580 size the mailbox. It must be a decimal number, optionally followed by K or M.
21581 This provides a way of obtaining this information from an external source that
21582 maintains the data. This is likely to be helpful for maildir deliveries where
21583 it is computationally expensive to compute the size of a mailbox.
21584
21585
21586
21587 .option maildir_format appendfile boolean false
21588 .cindex "maildir format" "specifying"
21589 If this option is set with the &%directory%& option, the delivery is into a new
21590 file, in the &"maildir"& format that is used by other mail software. When the
21591 transport is activated directly from a &(redirect)& router (for example, the
21592 &(address_file)& transport in the default configuration), setting
21593 &%maildir_format%& causes the path received from the router to be treated as a
21594 directory, whether or not it ends with &`/`&. This option is available only if
21595 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
21596 &<<SECTmaildirdelivery>>& below for further details.
21597
21598
21599 .option maildir_quota_directory_regex appendfile string "See below"
21600 .cindex "maildir format" "quota; directories included in"
21601 .cindex "quota" "maildir; directories included in"
21602 This option is relevant only when &%maildir_use_size_file%& is set. It defines
21603 a regular expression for specifying directories, relative to the quota
21604 directory (see &%quota_directory%&), that should be included in the quota
21605 calculation. The default value is:
21606 .code
21607 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
21608 .endd
21609 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
21610 (directories whose names begin with a dot). If you want to exclude the
21611 &_Trash_&
21612 folder from the count (as some sites do), you need to change this setting to
21613 .code
21614 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
21615 .endd
21616 This uses a negative lookahead in the regular expression to exclude the
21617 directory whose name is &_.Trash_&. When a directory is excluded from quota
21618 calculations, quota processing is bypassed for any messages that are delivered
21619 directly into that directory.
21620
21621
21622 .option maildir_retries appendfile integer 10
21623 This option specifies the number of times to retry when writing a file in
21624 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
21625
21626
21627 .option maildir_tag appendfile string&!! unset
21628 This option applies only to deliveries in maildir format, and is described in
21629 section &<<SECTmaildirdelivery>>& below.
21630
21631
21632 .option maildir_use_size_file appendfile&!! boolean false
21633 .cindex "maildir format" "&_maildirsize_& file"
21634 The result of string expansion for this option must be a valid boolean value.
21635 If it is true, it enables support for &_maildirsize_& files. Exim
21636 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
21637 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
21638 value is zero. See &%maildir_quota_directory_regex%& above and section
21639 &<<SECTmaildirdelivery>>& below for further details.
21640
21641 .option maildirfolder_create_regex appendfile string unset
21642 .cindex "maildir format" "&_maildirfolder_& file"
21643 .cindex "&_maildirfolder_&, creating"
21644 The value of this option is a regular expression. If it is unset, it has no
21645 effect. Otherwise, before a maildir delivery takes place, the pattern is
21646 matched against the name of the maildir directory, that is, the directory
21647 containing the &_new_& and &_tmp_& subdirectories that will be used for the
21648 delivery. If there is a match, Exim checks for the existence of a file called
21649 &_maildirfolder_& in the directory, and creates it if it does not exist.
21650 See section &<<SECTmaildirdelivery>>& for more details.
21651
21652
21653 .option mailstore_format appendfile boolean false
21654 .cindex "mailstore format" "specifying"
21655 If this option is set with the &%directory%& option, the delivery is into two
21656 new files in  &"mailstore"& format. The option is available only if
21657 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
21658 below for further details.
21659
21660
21661 .option mailstore_prefix appendfile string&!! unset
21662 This option applies only to deliveries in mailstore format, and is described in
21663 section &<<SECTopdir>>& below.
21664
21665
21666 .option mailstore_suffix appendfile string&!! unset
21667 This option applies only to deliveries in mailstore format, and is described in
21668 section &<<SECTopdir>>& below.
21669
21670
21671 .option mbx_format appendfile boolean false
21672 .cindex "locking files"
21673 .cindex "file" "locking"
21674 .cindex "file" "MBX format"
21675 .cindex "MBX format, specifying"
21676 This option is available only if Exim has been compiled with SUPPORT_MBX
21677 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
21678 the message is appended to the mailbox file in MBX format instead of
21679 traditional Unix format. This format is supported by Pine4 and its associated
21680 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
21681
21682 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
21683 automatically changed by the use of &%mbx_format%&. They should normally be set
21684 empty when using MBX format, so this option almost always appears in this
21685 combination:
21686 .code
21687 mbx_format = true
21688 message_prefix =
21689 message_suffix =
21690 .endd
21691 If none of the locking options are mentioned in the configuration,
21692 &%use_mbx_lock%& is assumed and the other locking options default to false. It
21693 is possible to specify the other kinds of locking with &%mbx_format%&, but
21694 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
21695 interworks with &'c-client'&, providing for shared access to the mailbox. It
21696 should not be used if any program that does not use this form of locking is
21697 going to access the mailbox, nor should it be used if the mailbox file is NFS
21698 mounted, because it works only when the mailbox is accessed from a single host.
21699
21700 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
21701 the standard version of &'c-client'&, because as long as it has a mailbox open
21702 (this means for the whole of a Pine or IMAP session), Exim will not be able to
21703 append messages to it.
21704
21705
21706 .option message_prefix appendfile string&!! "see below"
21707 .cindex "&""From""& line"
21708 The string specified here is expanded and output at the start of every message.
21709 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
21710 in which case it is:
21711 .code
21712 message_prefix = "From ${if def:return_path{$return_path}\
21713   {MAILER-DAEMON}} $tod_bsdinbox\n"
21714 .endd
21715 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21716 &`\n`& to &`\r\n`& in &%message_prefix%&.
21717
21718 .option message_suffix appendfile string&!! "see below"
21719 The string specified here is expanded and output at the end of every message.
21720 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
21721 in which case it is a single newline character. The suffix can be suppressed by
21722 setting
21723 .code
21724 message_suffix =
21725 .endd
21726 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21727 &`\n`& to &`\r\n`& in &%message_suffix%&.
21728
21729 .option mode appendfile "octal integer" 0600
21730 If the output file is created, it is given this mode. If it already exists and
21731 has wider permissions, they are reduced to this mode. If it has narrower
21732 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
21733 if the delivery is the result of a &%save%& command in a filter file specifying
21734 a particular mode, the mode of the output file is always forced to take that
21735 value, and this option is ignored.
21736
21737
21738 .option mode_fail_narrower appendfile boolean true
21739 This option applies in the case when an existing mailbox file has a narrower
21740 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
21741 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
21742 continues with the delivery attempt, using the existing mode of the file.
21743
21744
21745 .option notify_comsat appendfile boolean false
21746 If this option is true, the &'comsat'& daemon is notified after every
21747 successful delivery to a user mailbox. This is the daemon that notifies logged
21748 on users about incoming mail.
21749
21750
21751 .option quota appendfile string&!! unset
21752 .cindex "quota" "imposed by Exim"
21753 This option imposes a limit on the size of the file to which Exim is appending,
21754 or to the total space used in the directory tree when the &%directory%& option
21755 is set. In the latter case, computation of the space used is expensive, because
21756 all the files in the directory (and any sub-directories) have to be
21757 individually inspected and their sizes summed. (See &%quota_size_regex%& and
21758 &%maildir_use_size_file%& for ways to avoid this in environments where users
21759 have no shell access to their mailboxes).
21760
21761 As there is no interlock against two simultaneous deliveries into a
21762 multi-file mailbox, it is possible for the quota to be overrun in this case.
21763 For single-file mailboxes, of course, an interlock is a necessity.
21764
21765 A file's size is taken as its &'used'& value. Because of blocking effects, this
21766 may be a lot less than the actual amount of disk space allocated to the file.
21767 If the sizes of a number of files are being added up, the rounding effect can
21768 become quite noticeable, especially on systems that have large block sizes.
21769 Nevertheless, it seems best to stick to the &'used'& figure, because this is
21770 the obvious value which users understand most easily.
21771
21772 The value of the option is expanded, and must then be a numerical value
21773 (decimal point allowed), optionally followed by one of the letters K, M, or G,
21774 for kilobytes, megabytes, or gigabytes. If Exim is running on a system with
21775 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
21776 be handled.
21777
21778 &*Note*&: A value of zero is interpreted as &"no quota"&.
21779
21780 The expansion happens while Exim is running as root, before it changes uid for
21781 the delivery. This means that files that are inaccessible to the end user can
21782 be used to hold quota values that are looked up in the expansion. When delivery
21783 fails because this quota is exceeded, the handling of the error is as for
21784 system quota failures.
21785
21786 By default, Exim's quota checking mimics system quotas, and restricts the
21787 mailbox to the specified maximum size, though the value is not accurate to the
21788 last byte, owing to separator lines and additional headers that may get added
21789 during message delivery. When a mailbox is nearly full, large messages may get
21790 refused even though small ones are accepted, because the size of the current
21791 message is added to the quota when the check is made. This behaviour can be
21792 changed by setting &%quota_is_inclusive%& false. When this is done, the check
21793 for exceeding the quota does not include the current message. Thus, deliveries
21794 continue until the quota has been exceeded; thereafter, no further messages are
21795 delivered. See also &%quota_warn_threshold%&.
21796
21797
21798 .option quota_directory appendfile string&!! unset
21799 This option defines the directory to check for quota purposes when delivering
21800 into individual files. The default is the delivery directory, or, if a file
21801 called &_maildirfolder_& exists in a maildir directory, the parent of the
21802 delivery directory.
21803
21804
21805 .option quota_filecount appendfile string&!! 0
21806 This option applies when the &%directory%& option is set. It limits the total
21807 number of files in the directory (compare the inode limit in system quotas). It
21808 can only be used if &%quota%& is also set. The value is expanded; an expansion
21809 failure causes delivery to be deferred. A value of zero is interpreted as
21810 &"no quota"&.
21811
21812
21813 .option quota_is_inclusive appendfile boolean true
21814 See &%quota%& above.
21815
21816
21817 .option quota_size_regex appendfile string unset
21818 This option applies when one of the delivery modes that writes a separate file
21819 for each message is being used. When Exim wants to find the size of one of
21820 these files in order to test the quota, it first checks &%quota_size_regex%&.
21821 If this is set to a regular expression that matches the file name, and it
21822 captures one string, that string is interpreted as a representation of the
21823 file's size. The value of &%quota_size_regex%& is not expanded.
21824
21825 This feature is useful only when users have no shell access to their mailboxes
21826 &-- otherwise they could defeat the quota simply by renaming the files. This
21827 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
21828 the file length to the file name. For example:
21829 .code
21830 maildir_tag = ,S=$message_size
21831 quota_size_regex = ,S=(\d+)
21832 .endd
21833 An alternative to &$message_size$& is &$message_linecount$&, which contains the
21834 number of lines in the message.
21835
21836 The regular expression should not assume that the length is at the end of the
21837 file name (even though &%maildir_tag%& puts it there) because maildir MUAs
21838 sometimes add other information onto the ends of message file names.
21839
21840 Section &<<SECID136>>& contains further information.
21841
21842
21843 .option quota_warn_message appendfile string&!! "see below"
21844 See below for the use of this option. If it is not set when
21845 &%quota_warn_threshold%& is set, it defaults to
21846 .code
21847 quota_warn_message = "\
21848   To: $local_part@$domain\n\
21849   Subject: Your mailbox\n\n\
21850   This message is automatically created \
21851   by mail delivery software.\n\n\
21852   The size of your mailbox has exceeded \
21853   a warning threshold that is\n\
21854   set by the system administrator.\n"
21855 .endd
21856
21857
21858 .option quota_warn_threshold appendfile string&!! 0
21859 .cindex "quota" "warning threshold"
21860 .cindex "mailbox" "size warning"
21861 .cindex "size" "of mailbox"
21862 This option is expanded in the same way as &%quota%& (see above). If the
21863 resulting value is greater than zero, and delivery of the message causes the
21864 size of the file or total space in the directory tree to cross the given
21865 threshold, a warning message is sent. If &%quota%& is also set, the threshold
21866 may be specified as a percentage of it by following the value with a percent
21867 sign. For example:
21868 .code
21869 quota = 10M
21870 quota_warn_threshold = 75%
21871 .endd
21872 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
21873 percent sign is ignored.
21874
21875 The warning message itself is specified by the &%quota_warn_message%& option,
21876 and it must start with a &'To:'& header line containing the recipient(s) of the
21877 warning message. These do not necessarily have to include the recipient(s) of
21878 the original message. A &'Subject:'& line should also normally be supplied. You
21879 can include any other header lines that you want. If you do not include a
21880 &'From:'& line, the default is:
21881 .code
21882 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
21883 .endd
21884 .oindex &%errors_reply_to%&
21885 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
21886 option.
21887
21888 The &%quota%& option does not have to be set in order to use this option; they
21889 are independent of one another except when the threshold is specified as a
21890 percentage.
21891
21892
21893 .option use_bsmtp appendfile boolean false
21894 .cindex "envelope sender"
21895 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
21896 format, with the envelope sender and recipient(s) included as SMTP commands. If
21897 you want to include a leading HELO command with such messages, you can do
21898 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
21899 for details of batch SMTP.
21900
21901
21902 .option use_crlf appendfile boolean false
21903 .cindex "carriage return"
21904 .cindex "linefeed"
21905 This option causes lines to be terminated with the two-character CRLF sequence
21906 (carriage return, linefeed) instead of just a linefeed character. In the case
21907 of batched SMTP, the byte sequence written to the file is then an exact image
21908 of what would be sent down a real SMTP connection.
21909
21910 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
21911 (which are used to supply the traditional &"From&~"& and blank line separators
21912 in Berkeley-style mailboxes) are written verbatim, so must contain their own
21913 carriage return characters if these are needed. In cases where these options
21914 have non-empty defaults, the values end with a single linefeed, so they must be
21915 changed to end with &`\r\n`& if &%use_crlf%& is set.
21916
21917
21918 .option use_fcntl_lock appendfile boolean "see below"
21919 This option controls the use of the &[fcntl()]& function to lock a file for
21920 exclusive use when a message is being appended. It is set by default unless
21921 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
21922 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
21923 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
21924
21925
21926 .option use_flock_lock appendfile boolean false
21927 This option is provided to support the use of &[flock()]& for file locking, for
21928 the few situations where it is needed. Most modern operating systems support
21929 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
21930 each other. Exim uses &[fcntl()]& locking by default.
21931
21932 This option is required only if you are using an operating system where
21933 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
21934 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
21935 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
21936
21937 .cindex "Solaris" "&[flock()]& support"
21938 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
21939 have it (and some, I think, provide a not quite right version built on top of
21940 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
21941 the ability to use it, and any attempt to do so will cause a configuration
21942 error.
21943
21944 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
21945 is just being mapped onto &[fcntl()]& by the OS).
21946
21947
21948 .option use_lockfile appendfile boolean "see below"
21949 If this option is turned off, Exim does not attempt to create a lock file when
21950 appending to a mailbox file. In this situation, the only locking is by
21951 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
21952 sure that every MUA that is ever going to look at your users' mailboxes uses
21953 &[fcntl()]& rather than a lock file, and even then only when you are not
21954 delivering over NFS from more than one host.
21955
21956 .cindex "NFS" "lock file"
21957 In order to append to an NFS file safely from more than one host, it is
21958 necessary to take out a lock &'before'& opening the file, and the lock file
21959 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
21960 file corruption.
21961
21962 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
21963 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
21964 except when &%mbx_format%& is set.
21965
21966
21967 .option use_mbx_lock appendfile boolean "see below"
21968 This option is available only if Exim has been compiled with SUPPORT_MBX
21969 set in &_Local/Makefile_&. Setting the option specifies that special MBX
21970 locking rules be used. It is set by default if &%mbx_format%& is set and none
21971 of the locking options are mentioned in the configuration. The locking rules
21972 are the same as are used by the &'c-client'& library that underlies Pine and
21973 the IMAP4 and POP daemons that come with it (see the discussion below). The
21974 rules allow for shared access to the mailbox. However, this kind of locking
21975 does not work when the mailbox is NFS mounted.
21976
21977 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
21978 &%use_flock_lock%& to control what kind of locking is used in implementing the
21979 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
21980 without &%use_fcntl_lock%& or &%use_flock_lock%&.
21981
21982
21983
21984
21985 .section "Operational details for appending" "SECTopappend"
21986 .cindex "appending to a file"
21987 .cindex "file" "appending"
21988 Before appending to a file, the following preparations are made:
21989
21990 .ilist
21991 If the name of the file is &_/dev/null_&, no action is taken, and a success
21992 return is given.
21993
21994 .next
21995 .cindex "directory creation"
21996 If any directories on the file's path are missing, Exim creates them if the
21997 &%create_directory%& option is set. A created directory's mode is given by the
21998 &%directory_mode%& option.
21999
22000 .next
22001 If &%file_format%& is set, the format of an existing file is checked. If this
22002 indicates that a different transport should be used, control is passed to that
22003 transport.
22004
22005 .next
22006 .cindex "file" "locking"
22007 .cindex "locking files"
22008 .cindex "NFS" "lock file"
22009 If &%use_lockfile%& is set, a lock file is built in a way that will work
22010 reliably over NFS, as follows:
22011
22012 .olist
22013 Create a &"hitching post"& file whose name is that of the lock file with the
22014 current time, primary host name, and process id added, by opening for writing
22015 as a new file. If this fails with an access error, delivery is deferred.
22016 .next
22017 Close the hitching post file, and hard link it to the lock file name.
22018 .next
22019 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
22020 Unlink the hitching post name.
22021 .next
22022 Otherwise, use &[stat()]& to get information about the hitching post file, and
22023 then unlink hitching post name. If the number of links is exactly two, creation
22024 of the lock file succeeded but something (for example, an NFS server crash and
22025 restart) caused this fact not to be communicated to the &[link()]& call.
22026 .next
22027 If creation of the lock file failed, wait for &%lock_interval%& and try again,
22028 up to &%lock_retries%& times. However, since any program that writes to a
22029 mailbox should complete its task very quickly, it is reasonable to time out old
22030 lock files that are normally the result of user agent and system crashes. If an
22031 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
22032 it before trying again.
22033 .endlist olist
22034
22035 .next
22036 A call is made to &[lstat()]& to discover whether the main file exists, and if
22037 so, what its characteristics are. If &[lstat()]& fails for any reason other
22038 than non-existence, delivery is deferred.
22039
22040 .next
22041 .cindex "symbolic link" "to mailbox"
22042 .cindex "mailbox" "symbolic link"
22043 If the file does exist and is a symbolic link, delivery is deferred, unless the
22044 &%allow_symlink%& option is set, in which case the ownership of the link is
22045 checked, and then &[stat()]& is called to find out about the real file, which
22046 is then subjected to the checks below. The check on the top-level link
22047 ownership prevents one user creating a link for another's mailbox in a sticky
22048 directory, though allowing symbolic links in this case is definitely not a good
22049 idea. If there is a chain of symbolic links, the intermediate ones are not
22050 checked.
22051
22052 .next
22053 If the file already exists but is not a regular file, or if the file's owner
22054 and group (if the group is being checked &-- see &%check_group%& above) are
22055 different from the user and group under which the delivery is running,
22056 delivery is deferred.
22057
22058 .next
22059 If the file's permissions are more generous than specified, they are reduced.
22060 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
22061 is set false, in which case the delivery is tried using the existing
22062 permissions.
22063
22064 .next
22065 The file's inode number is saved, and the file is then opened for appending.
22066 If this fails because the file has vanished, &(appendfile)& behaves as if it
22067 hadn't existed (see below). For any other failures, delivery is deferred.
22068
22069 .next
22070 If the file is opened successfully, check that the inode number hasn't
22071 changed, that it is still a regular file, and that the owner and permissions
22072 have not changed. If anything is wrong, defer delivery and freeze the message.
22073
22074 .next
22075 If the file did not exist originally, defer delivery if the &%file_must_exist%&
22076 option is set. Otherwise, check that the file is being created in a permitted
22077 directory if the &%create_file%& option is set (deferring on failure), and then
22078 open for writing as a new file, with the O_EXCL and O_CREAT options,
22079 except when dealing with a symbolic link (the &%allow_symlink%& option must be
22080 set). In this case, which can happen if the link points to a non-existent file,
22081 the file is opened for writing using O_CREAT but not O_EXCL, because
22082 that prevents link following.
22083
22084 .next
22085 .cindex "loop" "while file testing"
22086 If opening fails because the file exists, obey the tests given above for
22087 existing files. However, to avoid looping in a situation where the file is
22088 being continuously created and destroyed, the exists/not-exists loop is broken
22089 after 10 repetitions, and the message is then frozen.
22090
22091 .next
22092 If opening fails with any other error, defer delivery.
22093
22094 .next
22095 .cindex "file" "locking"
22096 .cindex "locking files"
22097 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
22098 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
22099 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
22100 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
22101 file, and an exclusive lock on the file whose name is
22102 .code
22103 /tmp/.<device-number>.<inode-number>
22104 .endd
22105 using the device and inode numbers of the open mailbox file, in accordance with
22106 the MBX locking rules. This file is created with a mode that is specified by
22107 the &%lockfile_mode%& option.
22108
22109 If Exim fails to lock the file, there are two possible courses of action,
22110 depending on the value of the locking timeout. This is obtained from
22111 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
22112
22113 If the timeout value is zero, the file is closed, Exim waits for
22114 &%lock_interval%&, and then goes back and re-opens the file as above and tries
22115 to lock it again. This happens up to &%lock_retries%& times, after which the
22116 delivery is deferred.
22117
22118 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
22119 &[flock()]& are used (with the given timeout), so there has already been some
22120 waiting involved by the time locking fails. Nevertheless, Exim does not give up
22121 immediately. It retries up to
22122 .code
22123 (lock_retries * lock_interval) / <timeout>
22124 .endd
22125 times (rounded up).
22126 .endlist
22127
22128 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
22129 and/or &[flock()]& locks) and then deletes the lock file if one was created.
22130
22131
22132 .section "Operational details for delivery to a new file" "SECTopdir"
22133 .cindex "delivery" "to single file"
22134 .cindex "&""From""& line"
22135 When the &%directory%& option is set instead of &%file%&, each message is
22136 delivered into a newly-created file or set of files. When &(appendfile)& is
22137 activated directly from a &(redirect)& router, neither &%file%& nor
22138 &%directory%& is normally set, because the path for delivery is supplied by the
22139 router. (See for example, the &(address_file)& transport in the default
22140 configuration.) In this case, delivery is to a new file if either the path name
22141 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
22142
22143 No locking is required while writing the message to a new file, so the various
22144 locking options of the transport are ignored. The &"From"& line that by default
22145 separates messages in a single file is not normally needed, nor is the escaping
22146 of message lines that start with &"From"&, and there is no need to ensure a
22147 newline at the end of each message. Consequently, the default values for
22148 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
22149 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
22150
22151 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
22152 the files in the delivery directory by default. However, you can specify a
22153 different directory by setting &%quota_directory%&. Also, for maildir
22154 deliveries (see below) the &_maildirfolder_& convention is honoured.
22155
22156
22157 .cindex "maildir format"
22158 .cindex "mailstore format"
22159 There are three different ways in which delivery to individual files can be
22160 done, controlled by the settings of the &%maildir_format%& and
22161 &%mailstore_format%& options. Note that code to support maildir or mailstore
22162 formats is not included in the binary unless SUPPORT_MAILDIR or
22163 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
22164
22165 .cindex "directory creation"
22166 In all three cases an attempt is made to create the directory and any necessary
22167 sub-directories if they do not exist, provided that the &%create_directory%&
22168 option is set (the default). The location of a created directory can be
22169 constrained by setting &%create_file%&. A created directory's mode is given by
22170 the &%directory_mode%& option. If creation fails, or if the
22171 &%create_directory%& option is not set when creation is required, delivery is
22172 deferred.
22173
22174
22175
22176 .section "Maildir delivery" "SECTmaildirdelivery"
22177 .cindex "maildir format" "description of"
22178 If the &%maildir_format%& option is true, Exim delivers each message by writing
22179 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
22180 directory that is defined by the &%directory%& option (the &"delivery
22181 directory"&). If the delivery is successful, the file is renamed into the
22182 &_new_& subdirectory.
22183
22184 In the file name, <&'stime'&> is the current time of day in seconds, and
22185 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
22186 Exim checks that the time-of-day clock has moved on by at least one microsecond
22187 before terminating the delivery process. This guarantees uniqueness for the
22188 file name. However, as a precaution, Exim calls &[stat()]& for the file before
22189 opening it. If any response other than ENOENT (does not exist) is given,
22190 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
22191
22192 Before Exim carries out a maildir delivery, it ensures that subdirectories
22193 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
22194 do not exist, Exim tries to create them and any superior directories in their
22195 path, subject to the &%create_directory%& and &%create_file%& options. If the
22196 &%maildirfolder_create_regex%& option is set, and the regular expression it
22197 contains matches the delivery directory, Exim also ensures that a file called
22198 &_maildirfolder_& exists in the delivery directory. If a missing directory or
22199 &_maildirfolder_& file cannot be created, delivery is deferred.
22200
22201 These features make it possible to use Exim to create all the necessary files
22202 and directories in a maildir mailbox, including subdirectories for maildir++
22203 folders. Consider this example:
22204 .code
22205 maildir_format = true
22206 directory = /var/mail/$local_part\
22207            ${if eq{$local_part_suffix}{}{}\
22208            {/.${substr_1:$local_part_suffix}}}
22209 maildirfolder_create_regex = /\.[^/]+$
22210 .endd
22211 If &$local_part_suffix$& is empty (there was no suffix for the local part),
22212 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
22213 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
22214 not match this name, so Exim will not look for or create the file
22215 &_/var/mail/pimbo/maildirfolder_&, though it will create
22216 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
22217
22218 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
22219 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
22220 does match &%maildirfolder_create_regex%&. In this case, Exim will create
22221 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
22222 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
22223
22224 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
22225 not inadvertently match the toplevel maildir directory, because a
22226 &_maildirfolder_& file at top level would completely break quota calculations.
22227
22228 .cindex "quota" "in maildir delivery"
22229 .cindex "maildir++"
22230 If Exim is required to check a &%quota%& setting before a maildir delivery, and
22231 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
22232 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
22233 Exim assumes the directory is a maildir++ folder directory, which is one level
22234 down from the user's top level mailbox directory. This causes it to start at
22235 the parent directory instead of the current directory when calculating the
22236 amount of space used.
22237
22238 One problem with delivering into a multi-file mailbox is that it is
22239 computationally expensive to compute the size of the mailbox for quota
22240 checking. Various approaches have been taken to reduce the amount of work
22241 needed. The next two sections describe two of them. A third alternative is to
22242 use some external process for maintaining the size data, and use the expansion
22243 of the &%mailbox_size%& option as a way of importing it into Exim.
22244
22245
22246
22247
22248 .section "Using tags to record message sizes" "SECID135"
22249 If &%maildir_tag%& is set, the string is expanded for each delivery.
22250 When the maildir file is renamed into the &_new_& sub-directory, the
22251 tag is added to its name. However, if adding the tag takes the length of the
22252 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
22253 the tag is dropped and the maildir file is created with no tag.
22254
22255
22256 .vindex "&$message_size$&"
22257 Tags can be used to encode the size of files in their names; see
22258 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
22259 happens after the message has been written. The value of the &$message_size$&
22260 variable is set to the number of bytes actually written. If the expansion is
22261 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
22262 be deferred. The expanded tag may contain any printing characters except &"/"&.
22263 Non-printing characters in the string are ignored; if the resulting string is
22264 empty, it is ignored. If it starts with an alphanumeric character, a leading
22265 colon is inserted; this default has not proven to be the path that popular
22266 maildir implementations have chosen (but changing it in Exim would break
22267 backwards compatibility).
22268
22269 For one common implementation, you might set:
22270 .code
22271 maildir_tag = ,S=${message_size}
22272 .endd
22273 but you should check the documentation of the other software to be sure.
22274
22275 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
22276 as this allows Exim to extract the size from your tag, instead of having to
22277 &[stat()]& each message file.
22278
22279
22280 .section "Using a maildirsize file" "SECID136"
22281 .cindex "quota" "in maildir delivery"
22282 .cindex "maildir format" "&_maildirsize_& file"
22283 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
22284 storing quota and message size information in a file called &_maildirsize_&
22285 within the toplevel maildir directory. If this file does not exist, Exim
22286 creates it, setting the quota from the &%quota%& option of the transport. If
22287 the maildir directory itself does not exist, it is created before any attempt
22288 to write a &_maildirsize_& file.
22289
22290 The &_maildirsize_& file is used to hold information about the sizes of
22291 messages in the maildir, thus speeding up quota calculations. The quota value
22292 in the file is just a cache; if the quota is changed in the transport, the new
22293 value overrides the cached value when the next message is delivered. The cache
22294 is maintained for the benefit of other programs that access the maildir and
22295 need to know the quota.
22296
22297 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
22298 file is maintained (with a zero quota setting), but no quota is imposed.
22299
22300 A regular expression is available for controlling which directories in the
22301 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
22302 See the description of the &%maildir_quota_directory_regex%& option above for
22303 details.
22304
22305
22306 .section "Mailstore delivery" "SECID137"
22307 .cindex "mailstore format" "description of"
22308 If the &%mailstore_format%& option is true, each message is written as two
22309 files in the given directory. A unique base name is constructed from the
22310 message id and the current delivery process, and the files that are written use
22311 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
22312 contains the message's envelope, and the &_.msg_& file contains the message
22313 itself. The base name is placed in the variable &$mailstore_basename$&.
22314
22315 During delivery, the envelope is first written to a file with the suffix
22316 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
22317 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
22318 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
22319 file before accessing either of them. An alternative approach is to wait for
22320 the absence of a &_.tmp_& file.
22321
22322 The envelope file starts with any text defined by the &%mailstore_prefix%&
22323 option, expanded and terminated by a newline if there isn't one. Then follows
22324 the sender address on one line, then all the recipient addresses, one per line.
22325 There can be more than one recipient only if the &%batch_max%& option is set
22326 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
22327 appended to the file, followed by a newline if it does not end with one.
22328
22329 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
22330 failure, it is ignored. Other expansion errors are treated as serious
22331 configuration errors, and delivery is deferred. The variable
22332 &$mailstore_basename$& is available for use during these expansions.
22333
22334
22335 .section "Non-special new file delivery" "SECID138"
22336 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
22337 file is created directly in the named directory. For example, when delivering
22338 messages into files in batched SMTP format for later delivery to some host (see
22339 section &<<SECTbatchSMTP>>&), a setting such as
22340 .code
22341 directory = /var/bsmtp/$host
22342 .endd
22343 might be used. A message is written to a file with a temporary name, which is
22344 then renamed when the delivery is complete. The final name is obtained by
22345 expanding the contents of the &%directory_file%& option.
22346 .ecindex IIDapptra1
22347 .ecindex IIDapptra2
22348
22349
22350
22351
22352
22353
22354 . ////////////////////////////////////////////////////////////////////////////
22355 . ////////////////////////////////////////////////////////////////////////////
22356
22357 .chapter "The autoreply transport" "CHID8"
22358 .scindex IIDauttra1 "transports" "&(autoreply)&"
22359 .scindex IIDauttra2 "&(autoreply)& transport"
22360 The &(autoreply)& transport is not a true transport in that it does not cause
22361 the message to be transmitted. Instead, it generates a new mail message as an
22362 automatic reply to the incoming message. &'References:'& and
22363 &'Auto-Submitted:'& header lines are included. These are constructed according
22364 to the rules in RFCs 2822 and 3834, respectively.
22365
22366 If the router that passes the message to this transport does not have the
22367 &%unseen%& option set, the original message (for the current recipient) is not
22368 delivered anywhere. However, when the &%unseen%& option is set on the router
22369 that passes the message to this transport, routing of the address continues, so
22370 another router can set up a normal message delivery.
22371
22372
22373 The &(autoreply)& transport is usually run as the result of mail filtering, a
22374 &"vacation"& message being the standard example. However, it can also be run
22375 directly from a router like any other transport. To reduce the possibility of
22376 message cascades, messages created by the &(autoreply)& transport always have
22377 empty envelope sender addresses, like bounce messages.
22378
22379 The parameters of the message to be sent can be specified in the configuration
22380 by options described below. However, these are used only when the address
22381 passed to the transport does not contain its own reply information. When the
22382 transport is run as a consequence of a
22383 &%mail%&
22384 or &%vacation%& command in a filter file, the parameters of the message are
22385 supplied by the filter, and passed with the address. The transport's options
22386 that define the message are then ignored (so they are not usually set in this
22387 case). The message is specified entirely by the filter or by the transport; it
22388 is never built from a mixture of options. However, the &%file_optional%&,
22389 &%mode%&, and &%return_message%& options apply in all cases.
22390
22391 &(Autoreply)& is implemented as a local transport. When used as a result of a
22392 command in a user's filter file, &(autoreply)& normally runs under the uid and
22393 gid of the user, and with appropriate current and home directories (see chapter
22394 &<<CHAPenvironment>>&).
22395
22396 There is a subtle difference between routing a message to a &(pipe)& transport
22397 that generates some text to be returned to the sender, and routing it to an
22398 &(autoreply)& transport. This difference is noticeable only if more than one
22399 address from the same message is so handled. In the case of a pipe, the
22400 separate outputs from the different addresses are gathered up and returned to
22401 the sender in a single message, whereas if &(autoreply)& is used, a separate
22402 message is generated for each address that is passed to it.
22403
22404 Non-printing characters are not permitted in the header lines generated for the
22405 message that &(autoreply)& creates, with the exception of newlines that are
22406 immediately followed by white space. If any non-printing characters are found,
22407 the transport defers.
22408 Whether characters with the top bit set count as printing characters or not is
22409 controlled by the &%print_topbitchars%& global option.
22410
22411 If any of the generic options for manipulating headers (for example,
22412 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
22413 of the original message that is included in the generated message when
22414 &%return_message%& is set. They do not apply to the generated message itself.
22415
22416 .vindex "&$sender_address$&"
22417 If the &(autoreply)& transport receives return code 2 from Exim when it submits
22418 the message, indicating that there were no recipients, it does not treat this
22419 as an error. This means that autoreplies sent to &$sender_address$& when this
22420 is empty (because the incoming message is a bounce message) do not cause
22421 problems. They are just discarded.
22422
22423
22424
22425 .section "Private options for autoreply" "SECID139"
22426 .cindex "options" "&(autoreply)& transport"
22427
22428 .option bcc autoreply string&!! unset
22429 This specifies the addresses that are to receive &"blind carbon copies"& of the
22430 message when the message is specified by the transport.
22431
22432
22433 .option cc autoreply string&!! unset
22434 This specifies recipients of the message and the contents of the &'Cc:'& header
22435 when the message is specified by the transport.
22436
22437
22438 .option file autoreply string&!! unset
22439 The contents of the file are sent as the body of the message when the message
22440 is specified by the transport. If both &%file%& and &%text%& are set, the text
22441 string comes first.
22442
22443
22444 .option file_expand autoreply boolean false
22445 If this is set, the contents of the file named by the &%file%& option are
22446 subjected to string expansion as they are added to the message.
22447
22448
22449 .option file_optional autoreply boolean false
22450 If this option is true, no error is generated if the file named by the &%file%&
22451 option or passed with the address does not exist or cannot be read.
22452
22453
22454 .option from autoreply string&!! unset
22455 This specifies the contents of the &'From:'& header when the message is
22456 specified by the transport.
22457
22458
22459 .option headers autoreply string&!! unset
22460 This specifies additional RFC 2822 headers that are to be added to the message
22461 when the message is specified by the transport. Several can be given by using
22462 &"\n"& to separate them. There is no check on the format.
22463
22464
22465 .option log autoreply string&!! unset
22466 This option names a file in which a record of every message sent is logged when
22467 the message is specified by the transport.
22468
22469
22470 .option mode autoreply "octal integer" 0600
22471 If either the log file or the &"once"& file has to be created, this mode is
22472 used.
22473
22474
22475 .option never_mail autoreply "address list&!!" unset
22476 If any run of the transport creates a message with a recipient that matches any
22477 item in the list, that recipient is quietly discarded. If all recipients are
22478 discarded, no message is created. This applies both when the recipients are
22479 generated by a filter and when they are specified in the transport.
22480
22481
22482
22483 .option once autoreply string&!! unset
22484 This option names a file or DBM database in which a record of each &'To:'&
22485 recipient is kept when the message is specified by the transport. &*Note*&:
22486 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
22487
22488 If &%once%& is unset, or is set to an empty string, the message is always sent.
22489 By default, if &%once%& is set to a non-empty file name, the message
22490 is not sent if a potential recipient is already listed in the database.
22491 However, if the &%once_repeat%& option specifies a time greater than zero, the
22492 message is sent if that much time has elapsed since a message was last sent to
22493 this recipient. A setting of zero time for &%once_repeat%& (the default)
22494 prevents a message from being sent a second time &-- in this case, zero means
22495 infinity.
22496
22497 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
22498 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
22499 greater than zero, it changes the way Exim implements the &%once%& option.
22500 Instead of using a DBM file to record every recipient it sends to, it uses a
22501 regular file, whose size will never get larger than the given value.
22502
22503 In the file, Exim keeps a linear list of recipient addresses and the times at
22504 which they were sent messages. If the file is full when a new address needs to
22505 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
22506 means that a given recipient may receive multiple messages, but at
22507 unpredictable intervals that depend on the rate of turnover of addresses in the
22508 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
22509
22510
22511 .option once_file_size autoreply integer 0
22512 See &%once%& above.
22513
22514
22515 .option once_repeat autoreply time&!! 0s
22516 See &%once%& above.
22517 After expansion, the value of this option must be a valid time value.
22518
22519
22520 .option reply_to autoreply string&!! unset
22521 This specifies the contents of the &'Reply-To:'& header when the message is
22522 specified by the transport.
22523
22524
22525 .option return_message autoreply boolean false
22526 If this is set, a copy of the original message is returned with the new
22527 message, subject to the maximum size set in the &%return_size_limit%& global
22528 configuration option.
22529
22530
22531 .option subject autoreply string&!! unset
22532 This specifies the contents of the &'Subject:'& header when the message is
22533 specified by the transport. It is tempting to quote the original subject in
22534 automatic responses. For example:
22535 .code
22536 subject = Re: $h_subject:
22537 .endd
22538 There is a danger in doing this, however. It may allow a third party to
22539 subscribe your users to an opt-in mailing list, provided that the list accepts
22540 bounce messages as subscription confirmations. Well-managed lists require a
22541 non-bounce message to confirm a subscription, so the danger is relatively
22542 small.
22543
22544
22545
22546 .option text autoreply string&!! unset
22547 This specifies a single string to be used as the body of the message when the
22548 message is specified by the transport. If both &%text%& and &%file%& are set,
22549 the text comes first.
22550
22551
22552 .option to autoreply string&!! unset
22553 This specifies recipients of the message and the contents of the &'To:'& header
22554 when the message is specified by the transport.
22555 .ecindex IIDauttra1
22556 .ecindex IIDauttra2
22557
22558
22559
22560
22561 . ////////////////////////////////////////////////////////////////////////////
22562 . ////////////////////////////////////////////////////////////////////////////
22563
22564 .chapter "The lmtp transport" "CHAPLMTP"
22565 .cindex "transports" "&(lmtp)&"
22566 .cindex "&(lmtp)& transport"
22567 .cindex "LMTP" "over a pipe"
22568 .cindex "LMTP" "over a socket"
22569 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
22570 specified command
22571 or by interacting with a Unix domain socket.
22572 This transport is something of a cross between the &(pipe)& and &(smtp)&
22573 transports. Exim also has support for using LMTP over TCP/IP; this is
22574 implemented as an option for the &(smtp)& transport. Because LMTP is expected
22575 to be of minority interest, the default build-time configure in &_src/EDITME_&
22576 has it commented out. You need to ensure that
22577 .code
22578 TRANSPORT_LMTP=yes
22579 .endd
22580 .cindex "options" "&(lmtp)& transport"
22581 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
22582 included in the Exim binary. The private options of the &(lmtp)& transport are
22583 as follows:
22584
22585 .option batch_id lmtp string&!! unset
22586 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22587
22588
22589 .option batch_max lmtp integer 1
22590 This limits the number of addresses that can be handled in a single delivery.
22591 Most LMTP servers can handle several addresses at once, so it is normally a
22592 good idea to increase this value. See the description of local delivery
22593 batching in chapter &<<CHAPbatching>>&.
22594
22595
22596 .option command lmtp string&!! unset
22597 This option must be set if &%socket%& is not set. The string is a command which
22598 is run in a separate process. It is split up into a command name and list of
22599 arguments, each of which is separately expanded (so expansion cannot change the
22600 number of arguments). The command is run directly, not via a shell. The message
22601 is passed to the new process using the standard input and output to operate the
22602 LMTP protocol.
22603
22604 .option ignore_quota lmtp boolean false
22605 .cindex "LMTP" "ignoring quota errors"
22606 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
22607 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
22608 in its response to the LHLO command.
22609
22610 .option socket lmtp string&!! unset
22611 This option must be set if &%command%& is not set. The result of expansion must
22612 be the name of a Unix domain socket. The transport connects to the socket and
22613 delivers the message to it using the LMTP protocol.
22614
22615
22616 .option timeout lmtp time 5m
22617 The transport is aborted if the created process or Unix domain socket does not
22618 respond to LMTP commands or message input within this timeout. Delivery
22619 is deferred, and will be tried again later. Here is an example of a typical
22620 LMTP transport:
22621 .code
22622 lmtp:
22623   driver = lmtp
22624   command = /some/local/lmtp/delivery/program
22625   batch_max = 20
22626   user = exim
22627 .endd
22628 This delivers up to 20 addresses at a time, in a mixture of domains if
22629 necessary, running as the user &'exim'&.
22630
22631
22632
22633 . ////////////////////////////////////////////////////////////////////////////
22634 . ////////////////////////////////////////////////////////////////////////////
22635
22636 .chapter "The pipe transport" "CHAPpipetransport"
22637 .scindex IIDpiptra1 "transports" "&(pipe)&"
22638 .scindex IIDpiptra2 "&(pipe)& transport"
22639 The &(pipe)& transport is used to deliver messages via a pipe to a command
22640 running in another process. One example is the use of &(pipe)& as a
22641 pseudo-remote transport for passing messages to some other delivery mechanism
22642 (such as UUCP). Another is the use by individual users to automatically process
22643 their incoming messages. The &(pipe)& transport can be used in one of the
22644 following ways:
22645
22646 .ilist
22647 .vindex "&$local_part$&"
22648 A router routes one address to a transport in the normal way, and the
22649 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
22650 contains the local part of the address (as usual), and the command that is run
22651 is specified by the &%command%& option on the transport.
22652 .next
22653 .vindex "&$pipe_addresses$&"
22654 If the &%batch_max%& option is set greater than 1 (the default is 1), the
22655 transport can handle more than one address in a single run. In this case, when
22656 more than one address is routed to the transport, &$local_part$& is not set
22657 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
22658 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
22659 that are routed to the transport.
22660 .next
22661 .vindex "&$address_pipe$&"
22662 A router redirects an address directly to a pipe command (for example, from an
22663 alias or forward file). In this case, &$address_pipe$& contains the text of the
22664 pipe command, and the &%command%& option on the transport is ignored unless
22665 &%force_command%& is set. If only one address is being transported
22666 (&%batch_max%& is not greater than one, or only one address was redirected to
22667 this pipe command), &$local_part$& contains the local part that was redirected.
22668 .endlist
22669
22670
22671 The &(pipe)& transport is a non-interactive delivery method. Exim can also
22672 deliver messages over pipes using the LMTP interactive protocol. This is
22673 implemented by the &(lmtp)& transport.
22674
22675 In the case when &(pipe)& is run as a consequence of an entry in a local user's
22676 &_.forward_& file, the command runs under the uid and gid of that user. In
22677 other cases, the uid and gid have to be specified explicitly, either on the
22678 transport or on the router that handles the address. Current and &"home"&
22679 directories are also controllable. See chapter &<<CHAPenvironment>>& for
22680 details of the local delivery environment and chapter &<<CHAPbatching>>&
22681 for a discussion of local delivery batching.
22682
22683
22684 .section "Concurrent delivery" "SECID140"
22685 If two messages arrive at almost the same time, and both are routed to a pipe
22686 delivery, the two pipe transports may be run concurrently. You must ensure that
22687 any pipe commands you set up are robust against this happening. If the commands
22688 write to a file, the &%exim_lock%& utility might be of use.
22689 .new
22690 Alternatively the &%max_parallel%& option could be used with a value
22691 of "1" to enforce serialization.
22692 .wen
22693
22694
22695
22696
22697 .section "Returned status and data" "SECID141"
22698 .cindex "&(pipe)& transport" "returned data"
22699 If the command exits with a non-zero return code, the delivery is deemed to
22700 have failed, unless either the &%ignore_status%& option is set (in which case
22701 the return code is treated as zero), or the return code is one of those listed
22702 in the &%temp_errors%& option, which are interpreted as meaning &"try again
22703 later"&. In this case, delivery is deferred. Details of a permanent failure are
22704 logged, but are not included in the bounce message, which merely contains
22705 &"local delivery failed"&.
22706
22707 If the command exits on a signal and the &%freeze_signal%& option is set then
22708 the message will be frozen in the queue. If that option is not set, a bounce
22709 will be sent as normal.
22710
22711 If the return code is greater than 128 and the command being run is a shell
22712 script, it normally means that the script was terminated by a signal whose
22713 value is the return code minus 128. The &%freeze_signal%& option does not
22714 apply in this case.
22715
22716 If Exim is unable to run the command (that is, if &[execve()]& fails), the
22717 return code is set to 127. This is the value that a shell returns if it is
22718 asked to run a non-existent command. The wording for the log line suggests that
22719 a non-existent command may be the problem.
22720
22721 The &%return_output%& option can affect the result of a pipe delivery. If it is
22722 set and the command produces any output on its standard output or standard
22723 error streams, the command is considered to have failed, even if it gave a zero
22724 return code or if &%ignore_status%& is set. The output from the command is
22725 included as part of the bounce message. The &%return_fail_output%& option is
22726 similar, except that output is returned only when the command exits with a
22727 failure return code, that is, a value other than zero or a code that matches
22728 &%temp_errors%&.
22729
22730
22731
22732 .section "How the command is run" "SECThowcommandrun"
22733 .cindex "&(pipe)& transport" "path for command"
22734 The command line is (by default) broken down into a command name and arguments
22735 by the &(pipe)& transport itself. The &%allow_commands%& and
22736 &%restrict_to_path%& options can be used to restrict the commands that may be
22737 run.
22738
22739 .cindex "quoting" "in pipe command"
22740 Unquoted arguments are delimited by white space. If an argument appears in
22741 double quotes, backslash is interpreted as an escape character in the usual
22742 way. If an argument appears in single quotes, no escaping is done.
22743
22744 String expansion is applied to the command line except when it comes from a
22745 traditional &_.forward_& file (commands from a filter file are expanded). The
22746 expansion is applied to each argument in turn rather than to the whole line.
22747 For this reason, any string expansion item that contains white space must be
22748 quoted so as to be contained within a single argument. A setting such as
22749 .code
22750 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
22751 .endd
22752 will not work, because the expansion item gets split between several
22753 arguments. You have to write
22754 .code
22755 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
22756 .endd
22757 to ensure that it is all in one argument. The expansion is done in this way,
22758 argument by argument, so that the number of arguments cannot be changed as a
22759 result of expansion, and quotes or backslashes in inserted variables do not
22760 interact with external quoting. However, this leads to problems if you want to
22761 generate multiple arguments (or the command name plus arguments) from a single
22762 expansion. In this situation, the simplest solution is to use a shell. For
22763 example:
22764 .code
22765 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
22766 .endd
22767
22768 .cindex "transport" "filter"
22769 .cindex "filter" "transport filter"
22770 .vindex "&$pipe_addresses$&"
22771 Special handling takes place when an argument consists of precisely the text
22772 &`$pipe_addresses`&. This is not a general expansion variable; the only
22773 place this string is recognized is when it appears as an argument for a pipe or
22774 transport filter command. It causes each address that is being handled to be
22775 inserted in the argument list at that point &'as a separate argument'&. This
22776 avoids any problems with spaces or shell metacharacters, and is of use when a
22777 &(pipe)& transport is handling groups of addresses in a batch.
22778
22779 If &%force_command%& is enabled on the transport, Special handling takes place
22780 for an argument that consists of precisely the text &`$address_pipe`&.  It
22781 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
22782 argument is inserted in the argument list at that point
22783 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
22784 the only item in the argument; in fact, if it were then &%force_command%&
22785 should behave as a no-op.  Rather, it should be used to adjust the command
22786 run while preserving the argument vector separation.
22787
22788 After splitting up into arguments and expansion, the resulting command is run
22789 in a subprocess directly from the transport, &'not'& under a shell. The
22790 message that is being delivered is supplied on the standard input, and the
22791 standard output and standard error are both connected to a single pipe that is
22792 read by Exim. The &%max_output%& option controls how much output the command
22793 may produce, and the &%return_output%& and &%return_fail_output%& options
22794 control what is done with it.
22795
22796 Not running the command under a shell (by default) lessens the security risks
22797 in cases when a command from a user's filter file is built out of data that was
22798 taken from an incoming message. If a shell is required, it can of course be
22799 explicitly specified as the command to be run. However, there are circumstances
22800 where existing commands (for example, in &_.forward_& files) expect to be run
22801 under a shell and cannot easily be modified. To allow for these cases, there is
22802 an option called &%use_shell%&, which changes the way the &(pipe)& transport
22803 works. Instead of breaking up the command line as just described, it expands it
22804 as a single string and passes the result to &_/bin/sh_&. The
22805 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
22806 with &%use_shell%&, and the whole mechanism is inherently less secure.
22807
22808
22809
22810 .section "Environment variables" "SECTpipeenv"
22811 .cindex "&(pipe)& transport" "environment for command"
22812 .cindex "environment for pipe transport"
22813 The environment variables listed below are set up when the command is invoked.
22814 This list is a compromise for maximum compatibility with other MTAs. Note that
22815 the &%environment%& option can be used to add additional variables to this
22816 environment.
22817 .display
22818 &`DOMAIN            `&   the domain of the address
22819 &`HOME              `&   the home directory, if set
22820 &`HOST              `&   the host name when called from a router (see below)
22821 &`LOCAL_PART        `&   see below
22822 &`LOCAL_PART_PREFIX `&   see below
22823 &`LOCAL_PART_SUFFIX `&   see below
22824 &`LOGNAME           `&   see below
22825 &`MESSAGE_ID        `&   Exim's local ID for the message
22826 &`PATH              `&   as specified by the &%path%& option below
22827 &`QUALIFY_DOMAIN    `&   the sender qualification domain
22828 &`RECIPIENT         `&   the complete recipient address
22829 &`SENDER            `&   the sender of the message (empty if a bounce)
22830 &`SHELL             `&   &`/bin/sh`&
22831 &`TZ                `&   the value of the &%timezone%& option, if set
22832 &`USER              `&   see below
22833 .endd
22834 When a &(pipe)& transport is called directly from (for example) an &(accept)&
22835 router, LOCAL_PART is set to the local part of the address. When it is
22836 called as a result of a forward or alias expansion, LOCAL_PART is set to
22837 the local part of the address that was expanded. In both cases, any affixes are
22838 removed from the local part, and made available in LOCAL_PART_PREFIX and
22839 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
22840 same value as LOCAL_PART for compatibility with other MTAs.
22841
22842 .cindex "HOST"
22843 HOST is set only when a &(pipe)& transport is called from a router that
22844 associates hosts with an address, typically when using &(pipe)& as a
22845 pseudo-remote transport. HOST is set to the first host name specified by
22846 the router.
22847
22848 .cindex "HOME"
22849 If the transport's generic &%home_directory%& option is set, its value is used
22850 for the HOME environment variable. Otherwise, a home directory may be set
22851 by the router's &%transport_home_directory%& option, which defaults to the
22852 user's home directory if &%check_local_user%& is set.
22853
22854
22855 .section "Private options for pipe" "SECID142"
22856 .cindex "options" "&(pipe)& transport"
22857
22858
22859
22860 .option allow_commands pipe "string list&!!" unset
22861 .cindex "&(pipe)& transport" "permitted commands"
22862 The string is expanded, and is then interpreted as a colon-separated list of
22863 permitted commands. If &%restrict_to_path%& is not set, the only commands
22864 permitted are those in the &%allow_commands%& list. They need not be absolute
22865 paths; the &%path%& option is still used for relative paths. If
22866 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
22867 in the &%allow_commands%& list, or a name without any slashes that is found on
22868 the path. In other words, if neither &%allow_commands%& nor
22869 &%restrict_to_path%& is set, there is no restriction on the command, but
22870 otherwise only commands that are permitted by one or the other are allowed. For
22871 example, if
22872 .code
22873 allow_commands = /usr/bin/vacation
22874 .endd
22875 and &%restrict_to_path%& is not set, the only permitted command is
22876 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
22877 &%use_shell%& is set.
22878
22879
22880 .option batch_id pipe string&!! unset
22881 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22882
22883
22884 .option batch_max pipe integer 1
22885 This limits the number of addresses that can be handled in a single delivery.
22886 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22887
22888
22889 .option check_string pipe string unset
22890 As &(pipe)& writes the message, the start of each line is tested for matching
22891 &%check_string%&, and if it does, the initial matching characters are replaced
22892 by the contents of &%escape_string%&, provided both are set. The value of
22893 &%check_string%& is a literal string, not a regular expression, and the case of
22894 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
22895 of &%check_string%& and &%escape_string%& are forced to values that implement
22896 the SMTP escaping protocol. Any settings made in the configuration file are
22897 ignored.
22898
22899
22900 .option command pipe string&!! unset
22901 This option need not be set when &(pipe)& is being used to deliver to pipes
22902 obtained directly from address redirections. In other cases, the option must be
22903 set, to provide a command to be run. It need not yield an absolute path (see
22904 the &%path%& option below). The command is split up into separate arguments by
22905 Exim, and each argument is separately expanded, as described in section
22906 &<<SECThowcommandrun>>& above.
22907
22908
22909 .option environment pipe string&!! unset
22910 .cindex "&(pipe)& transport" "environment for command"
22911 .cindex "environment for &(pipe)& transport"
22912 This option is used to add additional variables to the environment in which the
22913 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
22914 a string which is expanded, and then interpreted as a colon-separated list of
22915 environment settings of the form <&'name'&>=<&'value'&>.
22916
22917
22918 .option escape_string pipe string unset
22919 See &%check_string%& above.
22920
22921
22922 .option freeze_exec_fail pipe boolean false
22923 .cindex "exec failure"
22924 .cindex "failure of exec"
22925 .cindex "&(pipe)& transport" "failure of exec"
22926 Failure to exec the command in a pipe transport is by default treated like
22927 any other failure while running the command. However, if &%freeze_exec_fail%&
22928 is set, failure to exec is treated specially, and causes the message to be
22929 frozen, whatever the setting of &%ignore_status%&.
22930
22931
22932 .option freeze_signal pipe boolean false
22933 .cindex "signal exit"
22934 .cindex "&(pipe)& transport", "signal exit"
22935 Normally if the process run by a command in a pipe transport exits on a signal,
22936 a bounce message is sent. If &%freeze_signal%& is set, the message will be
22937 frozen in Exim's queue instead.
22938
22939
22940 .option force_command pipe boolean false
22941 .cindex "force command"
22942 .cindex "&(pipe)& transport", "force command"
22943 Normally when a router redirects an address directly to a pipe command
22944 the &%command%& option on the transport is ignored.  If &%force_command%&
22945 is set, the &%command%& option will used. This is especially
22946 useful for forcing a wrapper or additional argument to be added to the
22947 command. For example:
22948 .code
22949 command = /usr/bin/remote_exec myhost -- $address_pipe
22950 force_command
22951 .endd
22952
22953 Note that &$address_pipe$& is handled specially in &%command%& when
22954 &%force_command%& is set, expanding out to the original argument vector as
22955 separate items, similarly to a Unix shell &`"$@"`& construct.
22956
22957
22958 .option ignore_status pipe boolean false
22959 If this option is true, the status returned by the subprocess that is set up to
22960 run the command is ignored, and Exim behaves as if zero had been returned.
22961 Otherwise, a non-zero status or termination by signal causes an error return
22962 from the transport unless the status value is one of those listed in
22963 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
22964
22965 &*Note*&: This option does not apply to timeouts, which do not return a status.
22966 See the &%timeout_defer%& option for how timeouts are handled.
22967
22968
22969 .option log_defer_output pipe boolean false
22970 .cindex "&(pipe)& transport" "logging output"
22971 If this option is set, and the status returned by the command is
22972 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
22973 and any output was produced on stdout or stderr, the first line of it is
22974 written to the main log.
22975
22976
22977 .option log_fail_output pipe boolean false
22978 If this option is set, and the command returns any output on stdout or
22979 stderr, and also ends with a return code that is neither zero nor one of
22980 the return codes listed in &%temp_errors%& (that is, the delivery
22981 failed), the first line of output is written to the main log. This
22982 option and &%log_output%& are mutually exclusive.  Only one of them may
22983 be set.
22984
22985
22986 .option log_output pipe boolean false
22987 If this option is set and the command returns any output on stdout or
22988 stderr, the first line of output is written to the main log, whatever
22989 the return code. This option and &%log_fail_output%& are mutually
22990 exclusive. Only one of them may be set.
22991
22992
22993 .option max_output pipe integer 20K
22994 This specifies the maximum amount of output that the command may produce on its
22995 standard output and standard error file combined. If the limit is exceeded, the
22996 process running the command is killed. This is intended as a safety measure to
22997 catch runaway processes. The limit is applied independently of the settings of
22998 the options that control what is done with such output (for example,
22999 &%return_output%&). Because of buffering effects, the amount of output may
23000 exceed the limit by a small amount before Exim notices.
23001
23002
23003 .option message_prefix pipe string&!! "see below"
23004 The string specified here is expanded and output at the start of every message.
23005 The default is unset if &%use_bsmtp%& is set. Otherwise it is
23006 .code
23007 message_prefix = \
23008   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
23009   ${tod_bsdinbox}\n
23010 .endd
23011 .cindex "Cyrus"
23012 .cindex "&%tmail%&"
23013 .cindex "&""From""& line"
23014 This is required by the commonly used &_/usr/bin/vacation_& program.
23015 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
23016 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
23017 setting
23018 .code
23019 message_prefix =
23020 .endd
23021 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23022 &`\n`& to &`\r\n`& in &%message_prefix%&.
23023
23024
23025 .option message_suffix pipe string&!! "see below"
23026 The string specified here is expanded and output at the end of every message.
23027 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
23028 The suffix can be suppressed by setting
23029 .code
23030 message_suffix =
23031 .endd
23032 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23033 &`\n`& to &`\r\n`& in &%message_suffix%&.
23034
23035
23036 .option path pipe string "see below"
23037 This option specifies the string that is set up in the PATH environment
23038 variable of the subprocess. The default is:
23039 .code
23040 /bin:/usr/bin
23041 .endd
23042 If the &%command%& option does not yield an absolute path name, the command is
23043 sought in the PATH directories, in the usual way. &*Warning*&: This does not
23044 apply to a command specified as a transport filter.
23045
23046
23047 .option permit_coredump pipe boolean false
23048 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
23049 a core-dump of a pipe command, enable this command.  This enables core-dumps
23050 during delivery and affects both the Exim binary and the pipe command run.
23051 It is recommended that this option remain off unless and until you have a need
23052 for it and that this only be enabled when needed, as the risk of excessive
23053 resource consumption can be quite high.  Note also that Exim is typically
23054 installed as a setuid binary and most operating systems will inhibit coredumps
23055 of these by default, so further OS-specific action may be required.
23056
23057
23058 .option pipe_as_creator pipe boolean false
23059 .cindex "uid (user id)" "local delivery"
23060 If the generic &%user%& option is not set and this option is true, the delivery
23061 process is run under the uid that was in force when Exim was originally called
23062 to accept the message. If the group id is not otherwise set (via the generic
23063 &%group%& option), the gid that was in force when Exim was originally called to
23064 accept the message is used.
23065
23066
23067 .option restrict_to_path pipe boolean false
23068 When this option is set, any command name not listed in &%allow_commands%& must
23069 contain no slashes. The command is searched for only in the directories listed
23070 in the &%path%& option. This option is intended for use in the case when a pipe
23071 command has been generated from a user's &_.forward_& file. This is usually
23072 handled by a &(pipe)& transport called &%address_pipe%&.
23073
23074
23075 .option return_fail_output pipe boolean false
23076 If this option is true, and the command produced any output and ended with a
23077 return code other than zero or one of the codes listed in &%temp_errors%& (that
23078 is, the delivery failed), the output is returned in the bounce message.
23079 However, if the message has a null sender (that is, it is itself a bounce
23080 message), output from the command is discarded. This option and
23081 &%return_output%& are mutually exclusive. Only one of them may be set.
23082
23083
23084
23085 .option return_output pipe boolean false
23086 If this option is true, and the command produced any output, the delivery is
23087 deemed to have failed whatever the return code from the command, and the output
23088 is returned in the bounce message. Otherwise, the output is just discarded.
23089 However, if the message has a null sender (that is, it is a bounce message),
23090 output from the command is always discarded, whatever the setting of this
23091 option. This option and &%return_fail_output%& are mutually exclusive. Only one
23092 of them may be set.
23093
23094
23095
23096 .option temp_errors pipe "string list" "see below"
23097 .cindex "&(pipe)& transport" "temporary failure"
23098 This option contains either a colon-separated list of numbers, or a single
23099 asterisk. If &%ignore_status%& is false
23100 and &%return_output%& is not set,
23101 and the command exits with a non-zero return code, the failure is treated as
23102 temporary and the delivery is deferred if the return code matches one of the
23103 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
23104 codes are treated as permanent errors. The default setting contains the codes
23105 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
23106 compiled on a system that does not define these macros, it assumes values of 75
23107 and 73, respectively.
23108
23109
23110 .option timeout pipe time 1h
23111 If the command fails to complete within this time, it is killed. This normally
23112 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
23113 specifies no timeout. In order to ensure that any subprocesses created by the
23114 command are also killed, Exim makes the initial process a process group leader,
23115 and kills the whole process group on a timeout. However, this can be defeated
23116 if one of the processes starts a new process group.
23117
23118 .option timeout_defer pipe boolean false
23119 A timeout in a &(pipe)& transport, either in the command that the transport
23120 runs, or in a transport filter that is associated with it, is by default
23121 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
23122 is set true, both kinds of timeout become temporary errors, causing the
23123 delivery to be deferred.
23124
23125 .option umask pipe "octal integer" 022
23126 This specifies the umask setting for the subprocess that runs the command.
23127
23128
23129 .option use_bsmtp pipe boolean false
23130 .cindex "envelope sender"
23131 If this option is set true, the &(pipe)& transport writes messages in &"batch
23132 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
23133 commands. If you want to include a leading HELO command with such messages,
23134 you can do so by setting the &%message_prefix%& option. See section
23135 &<<SECTbatchSMTP>>& for details of batch SMTP.
23136
23137 .option use_classresources pipe boolean false
23138 .cindex "class resources (BSD)"
23139 This option is available only when Exim is running on FreeBSD, NetBSD, or
23140 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
23141 resource limits when a &(pipe)& transport is run to perform a delivery. The
23142 limits for the uid under which the pipe is to run are obtained from the login
23143 class database.
23144
23145
23146 .option use_crlf pipe boolean false
23147 .cindex "carriage return"
23148 .cindex "linefeed"
23149 This option causes lines to be terminated with the two-character CRLF sequence
23150 (carriage return, linefeed) instead of just a linefeed character. In the case
23151 of batched SMTP, the byte sequence written to the pipe is then an exact image
23152 of what would be sent down a real SMTP connection.
23153
23154 The contents of the &%message_prefix%& and &%message_suffix%& options are
23155 written verbatim, so must contain their own carriage return characters if these
23156 are needed. When &%use_bsmtp%& is not set, the default values for both
23157 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
23158 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
23159
23160
23161 .option use_shell pipe boolean false
23162 .vindex "&$pipe_addresses$&"
23163 If this option is set, it causes the command to be passed to &_/bin/sh_&
23164 instead of being run directly from the transport, as described in section
23165 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
23166 where the command is expected to be run under a shell and cannot easily be
23167 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
23168 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
23169 command is expanded as a single string, and handed to &_/bin/sh_& as data for
23170 its &%-c%& option.
23171
23172
23173
23174 .section "Using an external local delivery agent" "SECID143"
23175 .cindex "local delivery" "using an external agent"
23176 .cindex "&'procmail'&"
23177 .cindex "external local delivery"
23178 .cindex "delivery" "&'procmail'&"
23179 .cindex "delivery" "by external agent"
23180 The &(pipe)& transport can be used to pass all messages that require local
23181 delivery to a separate local delivery agent such as &%procmail%&. When doing
23182 this, care must be taken to ensure that the pipe is run under an appropriate
23183 uid and gid. In some configurations one wants this to be a uid that is trusted
23184 by the delivery agent to supply the correct sender of the message. It may be
23185 necessary to recompile or reconfigure the delivery agent so that it trusts an
23186 appropriate user. The following is an example transport and router
23187 configuration for &%procmail%&:
23188 .code
23189 # transport
23190 procmail_pipe:
23191   driver = pipe
23192   command = /usr/local/bin/procmail -d $local_part
23193   return_path_add
23194   delivery_date_add
23195   envelope_to_add
23196   check_string = "From "
23197   escape_string = ">From "
23198   umask = 077
23199   user = $local_part
23200   group = mail
23201
23202 # router
23203 procmail:
23204   driver = accept
23205   check_local_user
23206   transport = procmail_pipe
23207 .endd
23208 In this example, the pipe is run as the local user, but with the group set to
23209 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
23210 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
23211 user to supply a correct sender address. If you do not specify either a
23212 &%group%& or a &%user%& option, the pipe command is run as the local user. The
23213 home directory is the user's home directory by default.
23214
23215 &*Note*&: The command that the pipe transport runs does &'not'& begin with
23216 .code
23217 IFS=" "
23218 .endd
23219 as shown in some &%procmail%& documentation, because Exim does not by default
23220 use a shell to run pipe commands.
23221
23222 .cindex "Cyrus"
23223 The next example shows a transport and a router for a system where local
23224 deliveries are handled by the Cyrus IMAP server.
23225 .code
23226 # transport
23227 local_delivery_cyrus:
23228   driver = pipe
23229   command = /usr/cyrus/bin/deliver \
23230             -m ${substr_1:$local_part_suffix} -- $local_part
23231   user = cyrus
23232   group = mail
23233   return_output
23234   log_output
23235   message_prefix =
23236   message_suffix =
23237
23238 # router
23239 local_user_cyrus:
23240   driver = accept
23241   check_local_user
23242   local_part_suffix = .*
23243   transport = local_delivery_cyrus
23244 .endd
23245 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
23246 &%return_output%& to cause any text written by Cyrus to be returned to the
23247 sender.
23248 .ecindex IIDpiptra1
23249 .ecindex IIDpiptra2
23250
23251
23252 . ////////////////////////////////////////////////////////////////////////////
23253 . ////////////////////////////////////////////////////////////////////////////
23254
23255 .chapter "The smtp transport" "CHAPsmtptrans"
23256 .scindex IIDsmttra1 "transports" "&(smtp)&"
23257 .scindex IIDsmttra2 "&(smtp)& transport"
23258 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
23259 or LMTP protocol. The list of hosts to try can either be taken from the address
23260 that is being processed (having been set up by the router), or specified
23261 explicitly for the transport. Timeout and retry processing (see chapter
23262 &<<CHAPretry>>&) is applied to each IP address independently.
23263
23264
23265 .section "Multiple messages on a single connection" "SECID144"
23266 The sending of multiple messages over a single TCP/IP connection can arise in
23267 two ways:
23268
23269 .ilist
23270 If a message contains more than &%max_rcpt%& (see below) addresses that are
23271 routed to the same host, more than one copy of the message has to be sent to
23272 that host. In this situation, multiple copies may be sent in a single run of
23273 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
23274 does when it has too many addresses to send in one message also depends on the
23275 value of the global &%remote_max_parallel%& option. Details are given in
23276 section &<<SECToutSMTPTCP>>&.)
23277 .next
23278 .cindex "hints database" "remembering routing"
23279 When a message has been successfully delivered over a TCP/IP connection, Exim
23280 looks in its hints database to see if there are any other messages awaiting a
23281 connection to the same host. If there are, a new delivery process is started
23282 for one of them, and the current TCP/IP connection is passed on to it. The new
23283 process may in turn send multiple copies and possibly create yet another
23284 process.
23285 .endlist
23286
23287
23288 For each copy sent over the same TCP/IP connection, a sequence counter is
23289 incremented, and if it ever gets to the value of &%connection_max_messages%&,
23290 no further messages are sent over that connection.
23291
23292
23293
23294 .section "Use of the $host and $host_address variables" "SECID145"
23295 .vindex "&$host$&"
23296 .vindex "&$host_address$&"
23297 At the start of a run of the &(smtp)& transport, the values of &$host$& and
23298 &$host_address$& are the name and IP address of the first host on the host list
23299 passed by the router. However, when the transport is about to connect to a
23300 specific host, and while it is connected to that host, &$host$& and
23301 &$host_address$& are set to the values for that host. These are the values
23302 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
23303 &%serialize_hosts%&, and the various TLS options are expanded.
23304
23305
23306 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
23307 .vindex &$tls_bits$&
23308 .vindex &$tls_cipher$&
23309 .vindex &$tls_peerdn$&
23310 .vindex &$tls_sni$&
23311 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
23312 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
23313 are the values that were set when the message was received.
23314 These are the values that are used for options that are expanded before any
23315 SMTP connections are made. Just before each connection is made, these four
23316 variables are emptied. If TLS is subsequently started, they are set to the
23317 appropriate values for the outgoing connection, and these are the values that
23318 are in force when any authenticators are run and when the
23319 &%authenticated_sender%& option is expanded.
23320
23321 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
23322 and will be removed in a future release.
23323
23324
23325 .section "Private options for smtp" "SECID146"
23326 .cindex "options" "&(smtp)& transport"
23327 The private options of the &(smtp)& transport are as follows:
23328
23329
23330 .option address_retry_include_sender smtp boolean true
23331 .cindex "4&'xx'& responses" "retrying after"
23332 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
23333 is the combination of sender and recipient that is delayed in subsequent queue
23334 runs until the retry time is reached. You can delay the recipient without
23335 reference to the sender (which is what earlier versions of Exim did), by
23336 setting &%address_retry_include_sender%& false. However, this can lead to
23337 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
23338
23339 .option allow_localhost smtp boolean false
23340 .cindex "local host" "sending to"
23341 .cindex "fallback" "hosts specified on transport"
23342 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
23343 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
23344 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
23345 the delivery anyway. This should be used only in special cases when the
23346 configuration ensures that no looping will result (for example, a differently
23347 configured Exim is listening on the port to which the message is sent).
23348
23349
23350 .option authenticated_sender smtp string&!! unset
23351 .cindex "Cyrus"
23352 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
23353 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
23354 overriding any existing authenticated sender value. If the string expansion is
23355 forced to fail, the option is ignored. Other expansion failures cause delivery
23356 to be deferred. If the result of expansion is an empty string, that is also
23357 ignored.
23358
23359 The expansion happens after the outgoing connection has been made and TLS
23360 started, if required. This means that the &$host$&, &$host_address$&,
23361 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
23362 particular connection.
23363
23364 If the SMTP session is not authenticated, the expansion of
23365 &%authenticated_sender%& still happens (and can cause the delivery to be
23366 deferred if it fails), but no AUTH= item is added to MAIL commands
23367 unless &%authenticated_sender_force%& is true.
23368
23369 This option allows you to use the &(smtp)& transport in LMTP mode to
23370 deliver mail to Cyrus IMAP and provide the proper local part as the
23371 &"authenticated sender"&, via a setting such as:
23372 .code
23373 authenticated_sender = $local_part
23374 .endd
23375 This removes the need for IMAP subfolders to be assigned special ACLs to
23376 allow direct delivery to those subfolders.
23377
23378 Because of expected uses such as that just described for Cyrus (when no
23379 domain is involved), there is no checking on the syntax of the provided
23380 value.
23381
23382
23383 .option authenticated_sender_force smtp boolean false
23384 If this option is set true, the &%authenticated_sender%& option's value
23385 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
23386 authenticated as a client.
23387
23388
23389 .option command_timeout smtp time 5m
23390 This sets a timeout for receiving a response to an SMTP command that has been
23391 sent out. It is also used when waiting for the initial banner line from the
23392 remote host. Its value must not be zero.
23393
23394
23395 .option connect_timeout smtp time 5m
23396 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
23397 to a remote host. A setting of zero allows the system timeout (typically
23398 several minutes) to act. To have any effect, the value of this option must be
23399 less than the system timeout. However, it has been observed that on some
23400 systems there is no system timeout, which is why the default value for this
23401 option is 5 minutes, a value recommended by RFC 1123.
23402
23403
23404 .option connection_max_messages smtp integer 500
23405 .cindex "SMTP" "passed connection"
23406 .cindex "SMTP" "multiple deliveries"
23407 .cindex "multiple SMTP deliveries"
23408 This controls the maximum number of separate message deliveries that are sent
23409 over a single TCP/IP connection. If the value is zero, there is no limit.
23410 For testing purposes, this value can be overridden by the &%-oB%& command line
23411 option.
23412
23413
23414 .option data_timeout smtp time 5m
23415 This sets a timeout for the transmission of each block in the data portion of
23416 the message. As a result, the overall timeout for a message depends on the size
23417 of the message. Its value must not be zero. See also &%final_timeout%&.
23418
23419
23420 .option delay_after_cutoff smtp boolean true
23421 This option controls what happens when all remote IP addresses for a given
23422 domain have been inaccessible for so long that they have passed their retry
23423 cutoff times.
23424
23425 In the default state, if the next retry time has not been reached for any of
23426 them, the address is bounced without trying any deliveries. In other words,
23427 Exim delays retrying an IP address after the final cutoff time until a new
23428 retry time is reached, and can therefore bounce an address without ever trying
23429 a delivery, when machines have been down for a long time. Some people are
23430 unhappy at this prospect, so...
23431
23432 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
23433 addresses are past their final cutoff time, Exim tries to deliver to those
23434 IP addresses that have not been tried since the message arrived. If there are
23435 none, of if they all fail, the address is bounced. In other words, it does not
23436 delay when a new message arrives, but immediately tries those expired IP
23437 addresses that haven't been tried since the message arrived. If there is a
23438 continuous stream of messages for the dead hosts, unsetting
23439 &%delay_after_cutoff%& means that there will be many more attempts to deliver
23440 to them.
23441
23442
23443 .option dns_qualify_single smtp boolean true
23444 If the &%hosts%& or &%fallback_hosts%& option is being used,
23445 and the &%gethostbyname%& option is false,
23446 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
23447 in chapter &<<CHAPdnslookup>>& for more details.
23448
23449
23450 .option dns_search_parents smtp boolean false
23451 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
23452 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
23453 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
23454 details.
23455
23456
23457 .option dnssec_request_domains smtp "domain list&!!" unset
23458 .cindex "MX record" "security"
23459 .cindex "DNSSEC" "MX lookup"
23460 .cindex "security" "MX lookup"
23461 .cindex "DNS" "DNSSEC"
23462 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
23463 the dnssec request bit set.
23464 This applies to all of the SRV, MX, AAAA, A lookup sequence.
23465
23466
23467
23468 .option dnssec_require_domains smtp "domain list&!!" unset
23469 .cindex "MX record" "security"
23470 .cindex "DNSSEC" "MX lookup"
23471 .cindex "security" "MX lookup"
23472 .cindex "DNS" "DNSSEC"
23473 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
23474 the dnssec request bit set.  Any returns not having the Authenticated Data bit
23475 (AD bit) set will be ignored and logged as a host-lookup failure.
23476 This applies to all of the SRV, MX, AAAA, A lookup sequence.
23477
23478
23479
23480 .option dscp smtp string&!! unset
23481 .cindex "DCSP" "outbound"
23482 This option causes the DSCP value associated with a socket to be set to one
23483 of a number of fixed strings or to numeric value.
23484 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
23485 Common values include &`throughput`&, &`mincost`&, and on newer systems
23486 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
23487
23488 The outbound packets from Exim will be marked with this value in the header
23489 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
23490 that these values will have any effect, not be stripped by networking
23491 equipment, or do much of anything without cooperation with your Network
23492 Engineer and those of all network operators between the source and destination.
23493
23494
23495 .option fallback_hosts smtp "string list" unset
23496 .cindex "fallback" "hosts specified on transport"
23497 String expansion is not applied to this option. The argument must be a
23498 colon-separated list of host names or IP addresses, optionally also including
23499 port numbers, though the separator can be changed, as described in section
23500 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
23501 item in a &%route_list%& setting for the &(manualroute)& router, as described
23502 in section &<<SECTformatonehostitem>>&.
23503
23504 Fallback hosts can also be specified on routers, which associate them with the
23505 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
23506 &%fallback_hosts%& specified on the transport is used only if the address does
23507 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
23508 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
23509 However, &%hosts_randomize%& does apply to fallback host lists.
23510
23511 If Exim is unable to deliver to any of the hosts for a particular address, and
23512 the errors are not permanent rejections, the address is put on a separate
23513 transport queue with its host list replaced by the fallback hosts, unless the
23514 address was routed via MX records and the current host was in the original MX
23515 list. In that situation, the fallback host list is not used.
23516
23517 Once normal deliveries are complete, the fallback queue is delivered by
23518 re-running the same transports with the new host lists. If several failing
23519 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
23520 copy of the message is sent.
23521
23522 The resolution of the host names on the fallback list is controlled by the
23523 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
23524 both to cases when the host list comes with the address and when it is taken
23525 from &%hosts%&. This option provides a &"use a smart host only if delivery
23526 fails"& facility.
23527
23528
23529 .option final_timeout smtp time 10m
23530 This is the timeout that applies while waiting for the response to the final
23531 line containing just &"."& that terminates a message. Its value must not be
23532 zero.
23533
23534 .option gethostbyname smtp boolean false
23535 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
23536 being used, names are looked up using &[gethostbyname()]&
23537 (or &[getipnodebyname()]& when available)
23538 instead of using the DNS. Of course, that function may in fact use the DNS, but
23539 it may also consult other sources of information such as &_/etc/hosts_&.
23540
23541 .option gnutls_compat_mode smtp boolean unset
23542 This option controls whether GnuTLS is used in compatibility mode in an Exim
23543 server. This reduces security slightly, but improves interworking with older
23544 implementations of TLS.
23545
23546 .option helo_data smtp string&!! "see below"
23547 .cindex "HELO" "argument, setting"
23548 .cindex "EHLO" "argument, setting"
23549 .cindex "LHLO argument setting"
23550 The value of this option is expanded after a connection to a another host has
23551 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
23552 command that starts the outgoing SMTP or LMTP session. The default value of the
23553 option is:
23554 .code
23555 $primary_hostname
23556 .endd
23557 During the expansion, the variables &$host$& and &$host_address$& are set to
23558 the identity of the remote host, and the variables &$sending_ip_address$& and
23559 &$sending_port$& are set to the local IP address and port number that are being
23560 used. These variables can be used to generate different values for different
23561 servers or different local IP addresses. For example, if you want the string
23562 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
23563 interface address, you could use this:
23564 .code
23565 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
23566   {$primary_hostname}}
23567 .endd
23568 The use of &%helo_data%& applies both to sending messages and when doing
23569 callouts.
23570
23571 .option hosts smtp "string list&!!" unset
23572 Hosts are associated with an address by a router such as &(dnslookup)&, which
23573 finds the hosts by looking up the address domain in the DNS, or by
23574 &(manualroute)&, which has lists of hosts in its configuration. However,
23575 email addresses can be passed to the &(smtp)& transport by any router, and not
23576 all of them can provide an associated list of hosts.
23577
23578 The &%hosts%& option specifies a list of hosts to be used if the address being
23579 processed does not have any hosts associated with it. The hosts specified by
23580 &%hosts%& are also used, whether or not the address has its own hosts, if
23581 &%hosts_override%& is set.
23582
23583 The string is first expanded, before being interpreted as a colon-separated
23584 list of host names or IP addresses, possibly including port numbers. The
23585 separator may be changed to something other than colon, as described in section
23586 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
23587 item in a &%route_list%& setting for the &(manualroute)& router, as described
23588 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
23589 of the &(manualroute)& router is not available here.
23590
23591 If the expansion fails, delivery is deferred. Unless the failure was caused by
23592 the inability to complete a lookup, the error is logged to the panic log as
23593 well as the main log. Host names are looked up either by searching directly for
23594 address records in the DNS or by calling &[gethostbyname()]& (or
23595 &[getipnodebyname()]& when available), depending on the setting of the
23596 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
23597 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
23598 address are used.
23599
23600 During delivery, the hosts are tried in order, subject to their retry status,
23601 unless &%hosts_randomize%& is set.
23602
23603
23604 .option hosts_avoid_esmtp smtp "host list&!!" unset
23605 .cindex "ESMTP, avoiding use of"
23606 .cindex "HELO" "forcing use of"
23607 .cindex "EHLO" "avoiding use of"
23608 .cindex "PIPELINING" "avoiding the use of"
23609 This option is for use with broken hosts that announce ESMTP facilities (for
23610 example, PIPELINING) and then fail to implement them properly. When a host
23611 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
23612 start of the SMTP session. This means that it cannot use any of the ESMTP
23613 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
23614
23615
23616 .option hosts_avoid_pipelining smtp "host list&!!" unset
23617 .cindex "PIPELINING" "avoiding the use of"
23618 Exim will not use the SMTP PIPELINING extension when delivering to any host
23619 that matches this list, even if the server host advertises PIPELINING support.
23620
23621
23622 .option hosts_avoid_tls smtp "host list&!!" unset
23623 .cindex "TLS" "avoiding for certain hosts"
23624 Exim will not try to start a TLS session when delivering to any host that
23625 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
23626
23627 .option hosts_verify_avoid_tls smtp "host list&!!" unset
23628 .cindex "TLS" "avoiding for certain hosts"
23629 Exim will not try to start a TLS session for a verify callout,
23630 or when delivering in cutthrough mode,
23631 to any host that matches this list.
23632
23633
23634 .option hosts_max_try smtp integer 5
23635 .cindex "host" "maximum number to try"
23636 .cindex "limit" "number of hosts tried"
23637 .cindex "limit" "number of MX tried"
23638 .cindex "MX record" "maximum tried"
23639 This option limits the number of IP addresses that are tried for any one
23640 delivery in cases where there are temporary delivery errors. Section
23641 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
23642
23643
23644 .option hosts_max_try_hardlimit smtp integer 50
23645 This is an additional check on the maximum number of IP addresses that Exim
23646 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
23647 why it exists.
23648
23649
23650
23651 .option hosts_nopass_tls smtp "host list&!!" unset
23652 .cindex "TLS" "passing connection"
23653 .cindex "multiple SMTP deliveries"
23654 .cindex "TLS" "multiple message deliveries"
23655 For any host that matches this list, a connection on which a TLS session has
23656 been started will not be passed to a new delivery process for sending another
23657 message on the same connection. See section &<<SECTmulmessam>>& for an
23658 explanation of when this might be needed.
23659
23660
23661 .option hosts_override smtp boolean false
23662 If this option is set and the &%hosts%& option is also set, any hosts that are
23663 attached to the address are ignored, and instead the hosts specified by the
23664 &%hosts%& option are always used. This option does not apply to
23665 &%fallback_hosts%&.
23666
23667
23668 .option hosts_randomize smtp boolean false
23669 .cindex "randomized host list"
23670 .cindex "host" "list of; randomized"
23671 .cindex "fallback" "randomized hosts"
23672 If this option is set, and either the list of hosts is taken from the
23673 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
23674 were not obtained from MX records (this includes fallback hosts from the
23675 router), and were not randomized by the router, the order of trying the hosts
23676 is randomized each time the transport runs. Randomizing the order of a host
23677 list can be used to do crude load sharing.
23678
23679 When &%hosts_randomize%& is true, a host list may be split into groups whose
23680 order is separately randomized. This makes it possible to set up MX-like
23681 behaviour. The boundaries between groups are indicated by an item that is just
23682 &`+`& in the host list. For example:
23683 .code
23684 hosts = host1:host2:host3:+:host4:host5
23685 .endd
23686 The order of the first three hosts and the order of the last two hosts is
23687 randomized for each use, but the first three always end up before the last two.
23688 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
23689
23690 .option hosts_require_auth smtp "host list&!!" unset
23691 .cindex "authentication" "required by client"
23692 This option provides a list of servers for which authentication must succeed
23693 before Exim will try to transfer a message. If authentication fails for
23694 servers which are not in this list, Exim tries to send unauthenticated. If
23695 authentication fails for one of these servers, delivery is deferred. This
23696 temporary error is detectable in the retry rules, so it can be turned into a
23697 hard failure if required. See also &%hosts_try_auth%&, and chapter
23698 &<<CHAPSMTPAUTH>>& for details of authentication.
23699
23700
23701 .option hosts_request_ocsp smtp "host list&!!" *
23702 .cindex "TLS" "requiring for certain servers"
23703 Exim will request a Certificate Status on a
23704 TLS session for any host that matches this list.
23705 &%tls_verify_certificates%& should also be set for the transport.
23706
23707 .option hosts_require_ocsp smtp "host list&!!" unset
23708 .cindex "TLS" "requiring for certain servers"
23709 Exim will request, and check for a valid Certificate Status being given, on a
23710 TLS session for any host that matches this list.
23711 &%tls_verify_certificates%& should also be set for the transport.
23712
23713 .option hosts_require_tls smtp "host list&!!" unset
23714 .cindex "TLS" "requiring for certain servers"
23715 Exim will insist on using a TLS session when delivering to any host that
23716 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
23717 &*Note*&: This option affects outgoing mail only. To insist on TLS for
23718 incoming messages, use an appropriate ACL.
23719
23720 .option hosts_try_auth smtp "host list&!!" unset
23721 .cindex "authentication" "optional in client"
23722 This option provides a list of servers to which, provided they announce
23723 authentication support, Exim will attempt to authenticate as a client when it
23724 connects. If authentication fails, Exim will try to transfer the message
23725 unauthenticated. See also &%hosts_require_auth%&, and chapter
23726 &<<CHAPSMTPAUTH>>& for details of authentication.
23727
23728 .option hosts_try_prdr smtp "host list&!!" *
23729 .cindex "PRDR" "enabling, optional in client"
23730 This option provides a list of servers to which, provided they announce
23731 PRDR support, Exim will attempt to negotiate PRDR
23732 for multi-recipient messages.
23733 The option can usually be left as default.
23734
23735 .option interface smtp "string list&!!" unset
23736 .cindex "bind IP address"
23737 .cindex "IP address" "binding"
23738 .vindex "&$host$&"
23739 .vindex "&$host_address$&"
23740 This option specifies which interface to bind to when making an outgoing SMTP
23741 call. The value is an IP address, not an interface name such as
23742 &`eth0`&. Do not confuse this with the interface address that was used when a
23743 message was received, which is in &$received_ip_address$&, formerly known as
23744 &$interface_address$&. The name was changed to minimize confusion with the
23745 outgoing interface address. There is no variable that contains an outgoing
23746 interface address because, unless it is set by this option, its value is
23747 unknown.
23748
23749 During the expansion of the &%interface%& option the variables &$host$& and
23750 &$host_address$& refer to the host to which a connection is about to be made
23751 during the expansion of the string. Forced expansion failure, or an empty
23752 string result causes the option to be ignored. Otherwise, after expansion, the
23753 string must be a list of IP addresses, colon-separated by default, but the
23754 separator can be changed in the usual way. For example:
23755 .code
23756 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
23757 .endd
23758 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
23759 connection. If none of them are the correct type, the option is ignored. If
23760 &%interface%& is not set, or is ignored, the system's IP functions choose which
23761 interface to use if the host has more than one.
23762
23763
23764 .option keepalive smtp boolean true
23765 .cindex "keepalive" "on outgoing connection"
23766 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
23767 connections. When set, it causes the kernel to probe idle connections
23768 periodically, by sending packets with &"old"& sequence numbers. The other end
23769 of the connection should send a acknowledgment if the connection is still okay
23770 or a reset if the connection has been aborted. The reason for doing this is
23771 that it has the beneficial effect of freeing up certain types of connection
23772 that can get stuck when the remote host is disconnected without tidying up the
23773 TCP/IP call properly. The keepalive mechanism takes several hours to detect
23774 unreachable hosts.
23775
23776
23777 .option lmtp_ignore_quota smtp boolean false
23778 .cindex "LMTP" "ignoring quota errors"
23779 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
23780 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
23781 has advertised support for IGNOREQUOTA in its response to the LHLO command.
23782
23783 .option max_rcpt smtp integer 100
23784 .cindex "RCPT" "maximum number of outgoing"
23785 This option limits the number of RCPT commands that are sent in a single
23786 SMTP message transaction. Each set of addresses is treated independently, and
23787 so can cause parallel connections to the same host if &%remote_max_parallel%&
23788 permits this.
23789
23790
23791 .option multi_domain smtp boolean&!! true
23792 .vindex "&$domain$&"
23793 When this option is set, the &(smtp)& transport can handle a number of
23794 addresses containing a mixture of different domains provided they all resolve
23795 to the same list of hosts. Turning the option off restricts the transport to
23796 handling only one domain at a time. This is useful if you want to use
23797 &$domain$& in an expansion for the transport, because it is set only when there
23798 is a single domain involved in a remote delivery.
23799
23800 It is expanded per-address and can depend on any of
23801 &$address_data$&, &$domain_data$&, &$local_part_data$&,
23802 &$host$&, &$host_address$& and &$host_port$&.
23803
23804 .option port smtp string&!! "see below"
23805 .cindex "port" "sending TCP/IP"
23806 .cindex "TCP/IP" "setting outgoing port"
23807 This option specifies the TCP/IP port on the server to which Exim connects.
23808 &*Note:*& Do not confuse this with the port that was used when a message was
23809 received, which is in &$received_port$&, formerly known as &$interface_port$&.
23810 The name was changed to minimize confusion with the outgoing port. There is no
23811 variable that contains an outgoing port.
23812
23813 If the value of this option begins with a digit it is taken as a port number;
23814 otherwise it is looked up using &[getservbyname()]&. The default value is
23815 normally &"smtp"&, but if &%protocol%& is set to &"lmtp"&, the default is
23816 &"lmtp"&. If the expansion fails, or if a port number cannot be found, delivery
23817 is deferred.
23818
23819
23820
23821 .option protocol smtp string smtp
23822 .cindex "LMTP" "over TCP/IP"
23823 .cindex "ssmtp protocol" "outbound"
23824 .cindex "TLS" "SSL-on-connect outbound"
23825 .vindex "&$port$&"
23826 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
23827 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
23828 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
23829 deliveries into closed message stores. Exim also has support for running LMTP
23830 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
23831
23832 If this option is set to &"smtps"&, the default value for the &%port%& option
23833 changes to &"smtps"&, and the transport initiates TLS immediately after
23834 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
23835 The Internet standards bodies strongly discourage use of this mode.
23836
23837
23838 .option retry_include_ip_address smtp boolean&!! true
23839 Exim normally includes both the host name and the IP address in the key it
23840 constructs for indexing retry data after a temporary delivery failure. This
23841 means that when one of several IP addresses for a host is failing, it gets
23842 tried periodically (controlled by the retry rules), but use of the other IP
23843 addresses is not affected.
23844
23845 However, in some dialup environments hosts are assigned a different IP address
23846 each time they connect. In this situation the use of the IP address as part of
23847 the retry key leads to undesirable behaviour. Setting this option false causes
23848 Exim to use only the host name.
23849 Since it is expanded it can be made to depend on the host or domain.
23850
23851
23852 .option serialize_hosts smtp "host list&!!" unset
23853 .cindex "serializing connections"
23854 .cindex "host" "serializing connections"
23855 Because Exim operates in a distributed manner, if several messages for the same
23856 host arrive at around the same time, more than one simultaneous connection to
23857 the remote host can occur. This is not usually a problem except when there is a
23858 slow link between the hosts. In that situation it may be helpful to restrict
23859 Exim to one connection at a time. This can be done by setting
23860 &%serialize_hosts%& to match the relevant hosts.
23861
23862 .cindex "hints database" "serializing deliveries to a host"
23863 Exim implements serialization by means of a hints database in which a record is
23864 written whenever a process connects to one of the restricted hosts. The record
23865 is deleted when the connection is completed. Obviously there is scope for
23866 records to get left lying around if there is a system or program crash. To
23867 guard against this, Exim ignores any records that are more than six hours old.
23868
23869 If you set up this kind of serialization, you should also arrange to delete the
23870 relevant hints database whenever your system reboots. The names of the files
23871 start with &_misc_& and they are kept in the &_spool/db_& directory. There
23872 may be one or two files, depending on the type of DBM in use. The same files
23873 are used for ETRN serialization.
23874
23875 .new
23876 See also the &%max_parallel%& generic transport option.
23877 .wen
23878
23879
23880 .option size_addition smtp integer 1024
23881 .cindex "SMTP" "SIZE"
23882 .cindex "message" "size issue for transport filter"
23883 .cindex "size" "of message"
23884 .cindex "transport" "filter"
23885 .cindex "filter" "transport filter"
23886 If a remote SMTP server indicates that it supports the SIZE option of the
23887 MAIL command, Exim uses this to pass over the message size at the start of
23888 an SMTP transaction. It adds the value of &%size_addition%& to the value it
23889 sends, to allow for headers and other text that may be added during delivery by
23890 configuration options or in a transport filter. It may be necessary to increase
23891 this if a lot of text is added to messages.
23892
23893 Alternatively, if the value of &%size_addition%& is set negative, it disables
23894 the use of the SIZE option altogether.
23895
23896
23897 .new
23898 .option socks_proxy smtp string&!! unset
23899 .cindex proxy SOCKS
23900 This option enables use of SOCKS proxies for connections made by the
23901 transport.  For details see &<<SECTproxySOCKS>>&.
23902 .wen
23903
23904
23905 .option tls_certificate smtp string&!! unset
23906 .cindex "TLS" "client certificate, location of"
23907 .cindex "certificate" "client, location of"
23908 .vindex "&$host$&"
23909 .vindex "&$host_address$&"
23910 The value of this option must be the absolute path to a file which contains the
23911 client's certificate, for possible use when sending a message over an encrypted
23912 connection. The values of &$host$& and &$host_address$& are set to the name and
23913 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
23914 details of TLS.
23915
23916 &*Note*&: This option must be set if you want Exim to be able to use a TLS
23917 certificate when sending messages as a client. The global option of the same
23918 name specifies the certificate for Exim as a server; it is not automatically
23919 assumed that the same certificate should be used when Exim is operating as a
23920 client.
23921
23922
23923 .option tls_crl smtp string&!! unset
23924 .cindex "TLS" "client certificate revocation list"
23925 .cindex "certificate" "revocation list for client"
23926 This option specifies a certificate revocation list. The expanded value must
23927 be the name of a file that contains a CRL in PEM format.
23928
23929
23930 .option tls_dh_min_bits smtp integer 1024
23931 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
23932 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
23933 key agreement is negotiated, the server will provide a large prime number
23934 for use.  This option establishes the minimum acceptable size of that number.
23935 If the parameter offered by the server is too small, then the TLS handshake
23936 will fail.
23937
23938 Only supported when using GnuTLS.
23939
23940
23941 .option tls_privatekey smtp string&!! unset
23942 .cindex "TLS" "client private key, location of"
23943 .vindex "&$host$&"
23944 .vindex "&$host_address$&"
23945 The value of this option must be the absolute path to a file which contains the
23946 client's private key. This is used when sending a message over an encrypted
23947 connection using a client certificate. The values of &$host$& and
23948 &$host_address$& are set to the name and address of the server during the
23949 expansion. If this option is unset, or the expansion is forced to fail, or the
23950 result is an empty string, the private key is assumed to be in the same file as
23951 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
23952
23953
23954 .option tls_require_ciphers smtp string&!! unset
23955 .cindex "TLS" "requiring specific ciphers"
23956 .cindex "cipher" "requiring specific"
23957 .vindex "&$host$&"
23958 .vindex "&$host_address$&"
23959 The value of this option must be a list of permitted cipher suites, for use
23960 when setting up an outgoing encrypted connection. (There is a global option of
23961 the same name for controlling incoming connections.) The values of &$host$& and
23962 &$host_address$& are set to the name and address of the server during the
23963 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
23964 is used in different ways by OpenSSL and GnuTLS (see sections
23965 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
23966 ciphers is a preference order.
23967
23968
23969
23970 .option tls_sni smtp string&!! unset
23971 .cindex "TLS" "Server Name Indication"
23972 .vindex "&$tls_sni$&"
23973 If this option is set then it sets the $tls_out_sni variable and causes any
23974 TLS session to pass this value as the Server Name Indication extension to
23975 the remote side, which can be used by the remote side to select an appropriate
23976 certificate and private key for the session.
23977
23978 See &<<SECTtlssni>>& for more information.
23979
23980 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
23981 TLS extensions.
23982
23983
23984
23985
23986 .option tls_tempfail_tryclear smtp boolean true
23987 .cindex "4&'xx'& responses" "to STARTTLS"
23988 When the server host is not in &%hosts_require_tls%&, and there is a problem in
23989 setting up a TLS session, this option determines whether or not Exim should try
23990 to deliver the message unencrypted. If it is set false, delivery to the
23991 current host is deferred; if there are other hosts, they are tried. If this
23992 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
23993 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
23994 TLS negotiation fails, Exim closes the current connection (because it is in an
23995 unknown state), opens a new one to the same host, and then tries the delivery
23996 in clear.
23997
23998
23999 .option tls_try_verify_hosts smtp "host list&!!" *
24000 .cindex "TLS" "server certificate verification"
24001 .cindex "certificate" "verification of server"
24002 This option gives a list of hosts for which, on encrypted connections,
24003 certificate verification will be tried but need not succeed.
24004 The &%tls_verify_certificates%& option must also be set.
24005 Note that unless the host is in this list
24006 TLS connections will be denied to hosts using self-signed certificates
24007 when &%tls_verify_certificates%& is matched.
24008 The &$tls_out_certificate_verified$& variable is set when
24009 certificate verification succeeds.
24010
24011
24012 .option tls_verify_cert_hostnames smtp "host list&!!" *
24013 .cindex "TLS" "server certificate hostname verification"
24014 .cindex "certificate" "verification of server"
24015 This option give a list of hosts for which,
24016 while verifying the server certificate,
24017 checks will be included on the host name
24018 (note that this will generally be the result of a DNS MX lookup)
24019 versus Subject and Subject-Alternate-Name fields.  Wildcard names are permitted
24020 limited to being the initial component of a 3-or-more component FQDN.
24021
24022 There is no equivalent checking on client certificates.
24023
24024
24025 .option tls_verify_certificates smtp string&!! system
24026 .cindex "TLS" "server certificate verification"
24027 .cindex "certificate" "verification of server"
24028 .vindex "&$host$&"
24029 .vindex "&$host_address$&"
24030 The value of this option must be either the
24031 word "system"
24032 or the absolute path to
24033 a file or directory containing permitted certificates for servers,
24034 for use when setting up an encrypted connection.
24035
24036 The "system" value for the option will use a location compiled into the SSL library.
24037 This is not available for GnuTLS versions preceding 3.0.20; a value of "system"
24038 is taken as empty and an explicit location
24039 must be specified.
24040
24041 The use of a directory for the option value is not available for GnuTLS versions
24042 preceding 3.3.6 and a single file must be used.
24043
24044 With OpenSSL the certificates specified
24045 explicitly
24046 either by file or directory
24047 are added to those given by the system default location.
24048
24049 The values of &$host$& and
24050 &$host_address$& are set to the name and address of the server during the
24051 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
24052
24053 For back-compatibility,
24054 if neither tls_verify_hosts nor tls_try_verify_hosts are set
24055 (a single-colon empty list counts as being set)
24056 and certificate verification fails the TLS connection is closed.
24057
24058
24059 .option tls_verify_hosts smtp "host list&!!" unset
24060 .cindex "TLS" "server certificate verification"
24061 .cindex "certificate" "verification of server"
24062 This option gives a list of hosts for which. on encrypted connections,
24063 certificate verification must succeed.
24064 The &%tls_verify_certificates%& option must also be set.
24065 If both this option and &%tls_try_verify_hosts%& are unset
24066 operation is as if this option selected all hosts.
24067
24068
24069
24070
24071 .section "How the limits for the number of hosts to try are used" &&&
24072          "SECTvalhosmax"
24073 .cindex "host" "maximum number to try"
24074 .cindex "limit" "hosts; maximum number tried"
24075 There are two options that are concerned with the number of hosts that are
24076 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
24077 &%hosts_max_try_hardlimit%&.
24078
24079
24080 The &%hosts_max_try%& option limits the number of hosts that are tried
24081 for a single delivery. However, despite the term &"host"& in its name, the
24082 option actually applies to each IP address independently. In other words, a
24083 multihomed host is treated as several independent hosts, just as it is for
24084 retrying.
24085
24086 Many of the larger ISPs have multiple MX records which often point to
24087 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
24088 created as a result of routing one of these domains.
24089
24090 Trying every single IP address on such a long list does not seem sensible; if
24091 several at the top of the list fail, it is reasonable to assume there is some
24092 problem that is likely to affect all of them. Roughly speaking, the value of
24093 &%hosts_max_try%& is the maximum number that are tried before deferring the
24094 delivery. However, the logic cannot be quite that simple.
24095
24096 Firstly, IP addresses that are skipped because their retry times have not
24097 arrived do not count, and in addition, addresses that are past their retry
24098 limits are also not counted, even when they are tried. This means that when
24099 some IP addresses are past their retry limits, more than the value of
24100 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
24101 that all IP addresses are considered before timing out an email address (but
24102 see below for an exception).
24103
24104 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
24105 list to see if there is a subsequent host with a different (higher valued) MX.
24106 If there is, that host is considered next, and the current IP address is used
24107 but not counted. This behaviour helps in the case of a domain with a retry rule
24108 that hardly ever delays any hosts, as is now explained:
24109
24110 Consider the case of a long list of hosts with one MX value, and a few with a
24111 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
24112 hosts at the top of the list are tried at first. With the default retry rule,
24113 which specifies increasing retry times, the higher MX hosts are eventually
24114 tried when those at the top of the list are skipped because they have not
24115 reached their retry times.
24116
24117 However, it is common practice to put a fixed short retry time on domains for
24118 large ISPs, on the grounds that their servers are rarely down for very long.
24119 Unfortunately, these are exactly the domains that tend to resolve to long lists
24120 of hosts. The short retry time means that the lowest MX hosts are tried every
24121 time. The attempts may be in a different order because of random sorting, but
24122 without the special MX check, the higher MX hosts would never be tried until
24123 all the lower MX hosts had timed out (which might be several days), because
24124 there are always some lower MX hosts that have reached their retry times. With
24125 the special check, Exim considers at least one IP address from each MX value at
24126 every delivery attempt, even if the &%hosts_max_try%& limit has already been
24127 reached.
24128
24129 The above logic means that &%hosts_max_try%& is not a hard limit, and in
24130 particular, Exim normally eventually tries all the IP addresses before timing
24131 out an email address. When &%hosts_max_try%& was implemented, this seemed a
24132 reasonable thing to do. Recently, however, some lunatic DNS configurations have
24133 been set up with hundreds of IP addresses for some domains. It can
24134 take a very long time indeed for an address to time out in these cases.
24135
24136 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
24137 Exim never tries more than this number of IP addresses; if it hits this limit
24138 and they are all timed out, the email address is bounced, even though not all
24139 possible IP addresses have been tried.
24140 .ecindex IIDsmttra1
24141 .ecindex IIDsmttra2
24142
24143
24144
24145
24146
24147 . ////////////////////////////////////////////////////////////////////////////
24148 . ////////////////////////////////////////////////////////////////////////////
24149
24150 .chapter "Address rewriting" "CHAPrewrite"
24151 .scindex IIDaddrew "rewriting" "addresses"
24152 There are some circumstances in which Exim automatically rewrites domains in
24153 addresses. The two most common are when an address is given without a domain
24154 (referred to as an &"unqualified address"&) or when an address contains an
24155 abbreviated domain that is expanded by DNS lookup.
24156
24157 Unqualified envelope addresses are accepted only for locally submitted
24158 messages, or for messages that are received from hosts matching
24159 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
24160 appropriate. Unqualified addresses in header lines are qualified if they are in
24161 locally submitted messages, or messages from hosts that are permitted to send
24162 unqualified envelope addresses. Otherwise, unqualified addresses in header
24163 lines are neither qualified nor rewritten.
24164
24165 One situation in which Exim does &'not'& automatically rewrite a domain is
24166 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
24167 such a domain should be rewritten using the &"canonical"& name, and some MTAs
24168 do this. The new RFCs do not contain this suggestion.
24169
24170
24171 .section "Explicitly configured address rewriting" "SECID147"
24172 This chapter describes the rewriting rules that can be used in the
24173 main rewrite section of the configuration file, and also in the generic
24174 &%headers_rewrite%& option that can be set on any transport.
24175
24176 Some people believe that configured address rewriting is a Mortal Sin.
24177 Others believe that life is not possible without it. Exim provides the
24178 facility; you do not have to use it.
24179
24180 The main rewriting rules that appear in the &"rewrite"& section of the
24181 configuration file are applied to addresses in incoming messages, both envelope
24182 addresses and addresses in header lines. Each rule specifies the types of
24183 address to which it applies.
24184
24185 Whether or not addresses in header lines are rewritten depends on the origin of
24186 the headers and the type of rewriting. Global rewriting, that is, rewriting
24187 rules from the rewrite section of the configuration file, is applied only to
24188 those headers that were received with the message. Header lines that are added
24189 by ACLs or by a system filter or by individual routers or transports (which
24190 are specific to individual recipient addresses) are not rewritten by the global
24191 rules.
24192
24193 Rewriting at transport time, by means of the &%headers_rewrite%& option,
24194 applies all headers except those added by routers and transports. That is, as
24195 well as the headers that were received with the message, it also applies to
24196 headers that were added by an ACL or a system filter.
24197
24198
24199 In general, rewriting addresses from your own system or domain has some
24200 legitimacy. Rewriting other addresses should be done only with great care and
24201 in special circumstances. The author of Exim believes that rewriting should be
24202 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
24203 Although it can sometimes be used as a routing tool, this is very strongly
24204 discouraged.
24205
24206 There are two commonly encountered circumstances where rewriting is used, as
24207 illustrated by these examples:
24208
24209 .ilist
24210 The company whose domain is &'hitch.fict.example'& has a number of hosts that
24211 exchange mail with each other behind a firewall, but there is only a single
24212 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
24213 &'hitch.fict.example'& when sending mail off-site.
24214 .next
24215 A host rewrites the local parts of its own users so that, for example,
24216 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
24217 .endlist
24218
24219
24220
24221 .section "When does rewriting happen?" "SECID148"
24222 .cindex "rewriting" "timing of"
24223 .cindex "&ACL;" "rewriting addresses in"
24224 Configured address rewriting can take place at several different stages of a
24225 message's processing.
24226
24227 .vindex "&$sender_address$&"
24228 At the start of an ACL for MAIL, the sender address may have been rewritten
24229 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
24230 ordinary rewrite rules have yet been applied. If, however, the sender address
24231 is verified in the ACL, it is rewritten before verification, and remains
24232 rewritten thereafter. The subsequent value of &$sender_address$& is the
24233 rewritten address. This also applies if sender verification happens in a
24234 RCPT ACL. Otherwise, when the sender address is not verified, it is
24235 rewritten as soon as a message's header lines have been received.
24236
24237 .vindex "&$domain$&"
24238 .vindex "&$local_part$&"
24239 Similarly, at the start of an ACL for RCPT, the current recipient's address
24240 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
24241 rewrite rules have yet been applied to it. However, the behaviour is different
24242 from the sender address when a recipient is verified. The address is rewritten
24243 for the verification, but the rewriting is not remembered at this stage. The
24244 value of &$local_part$& and &$domain$& after verification are always the same
24245 as they were before (that is, they contain the unrewritten &-- except for
24246 SMTP-time rewriting &-- address).
24247
24248 As soon as a message's header lines have been received, all the envelope
24249 recipient addresses are permanently rewritten, and rewriting is also applied to
24250 the addresses in the header lines (if configured). This happens before adding
24251 any header lines that were specified in MAIL or RCPT ACLs, and
24252 .cindex "&[local_scan()]& function" "address rewriting; timing of"
24253 before the DATA ACL and &[local_scan()]& functions are run.
24254
24255 When an address is being routed, either for delivery or for verification,
24256 rewriting is applied immediately to child addresses that are generated by
24257 redirection, unless &%no_rewrite%& is set on the router.
24258
24259 .cindex "envelope sender" "rewriting at transport time"
24260 .cindex "rewriting" "at transport time"
24261 .cindex "header lines" "rewriting at transport time"
24262 At transport time, additional rewriting of addresses in header lines can be
24263 specified by setting the generic &%headers_rewrite%& option on a transport.
24264 This option contains rules that are identical in form to those in the rewrite
24265 section of the configuration file. They are applied to the original message
24266 header lines and any that were added by ACLs or a system filter. They are not
24267 applied to header lines that are added by routers or the transport.
24268
24269 The outgoing envelope sender can be rewritten by means of the &%return_path%&
24270 transport option. However, it is not possible to rewrite envelope recipients at
24271 transport time.
24272
24273
24274
24275
24276 .section "Testing the rewriting rules that apply on input" "SECID149"
24277 .cindex "rewriting" "testing"
24278 .cindex "testing" "rewriting"
24279 Exim's input rewriting configuration appears in a part of the run time
24280 configuration file headed by &"begin rewrite"&. It can be tested by the
24281 &%-brw%& command line option. This takes an address (which can be a full RFC
24282 2822 address) as its argument. The output is a list of how the address would be
24283 transformed by the rewriting rules for each of the different places it might
24284 appear in an incoming message, that is, for each different header and for the
24285 envelope sender and recipient fields. For example,
24286 .code
24287 exim -brw ph10@exim.workshop.example
24288 .endd
24289 might produce the output
24290 .code
24291 sender: Philip.Hazel@exim.workshop.example
24292 from: Philip.Hazel@exim.workshop.example
24293 to: ph10@exim.workshop.example
24294 cc: ph10@exim.workshop.example
24295 bcc: ph10@exim.workshop.example
24296 reply-to: Philip.Hazel@exim.workshop.example
24297 env-from: Philip.Hazel@exim.workshop.example
24298 env-to: ph10@exim.workshop.example
24299 .endd
24300 which shows that rewriting has been set up for that address when used in any of
24301 the source fields, but not when it appears as a recipient address. At the
24302 present time, there is no equivalent way of testing rewriting rules that are
24303 set for a particular transport.
24304
24305
24306 .section "Rewriting rules" "SECID150"
24307 .cindex "rewriting" "rules"
24308 The rewrite section of the configuration file consists of lines of rewriting
24309 rules in the form
24310 .display
24311 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
24312 .endd
24313 Rewriting rules that are specified for the &%headers_rewrite%& generic
24314 transport option are given as a colon-separated list. Each item in the list
24315 takes the same form as a line in the main rewriting configuration (except that
24316 any colons must be doubled, of course).
24317
24318 The formats of source patterns and replacement strings are described below.
24319 Each is terminated by white space, unless enclosed in double quotes, in which
24320 case normal quoting conventions apply inside the quotes. The flags are single
24321 characters which may appear in any order. Spaces and tabs between them are
24322 ignored.
24323
24324 For each address that could potentially be rewritten, the rules are scanned in
24325 order, and replacements for the address from earlier rules can themselves be
24326 replaced by later rules (but see the &"q"& and &"R"& flags).
24327
24328 The order in which addresses are rewritten is undefined, may change between
24329 releases, and must not be relied on, with one exception: when a message is
24330 received, the envelope sender is always rewritten first, before any header
24331 lines are rewritten. For example, the replacement string for a rewrite of an
24332 address in &'To:'& must not assume that the message's address in &'From:'& has
24333 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
24334 that the envelope sender has already been rewritten.
24335
24336 .vindex "&$domain$&"
24337 .vindex "&$local_part$&"
24338 The variables &$local_part$& and &$domain$& can be used in the replacement
24339 string to refer to the address that is being rewritten. Note that lookup-driven
24340 rewriting can be done by a rule of the form
24341 .code
24342 *@*   ${lookup ...
24343 .endd
24344 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
24345 refer to the address that is being rewritten.
24346
24347
24348 .section "Rewriting patterns" "SECID151"
24349 .cindex "rewriting" "patterns"
24350 .cindex "address list" "in a rewriting pattern"
24351 The source pattern in a rewriting rule is any item which may appear in an
24352 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
24353 single-item address list, which means that it is expanded before being tested
24354 against the address. As always, if you use a regular expression as a pattern,
24355 you must take care to escape dollar and backslash characters, or use the &`\N`&
24356 facility to suppress string expansion within the regular expression.
24357
24358 Domains in patterns should be given in lower case. Local parts in patterns are
24359 case-sensitive. If you want to do case-insensitive matching of local parts, you
24360 can use a regular expression that starts with &`^(?i)`&.
24361
24362 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
24363 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
24364 depending on the type of match which occurred. These can be used in the
24365 replacement string to insert portions of the incoming address. &$0$& always
24366 refers to the complete incoming address. When a regular expression is used, the
24367 numerical variables are set from its capturing subexpressions. For other types
24368 of pattern they are set as follows:
24369
24370 .ilist
24371 If a local part or domain starts with an asterisk, the numerical variables
24372 refer to the character strings matched by asterisks, with &$1$& associated with
24373 the first asterisk, and &$2$& with the second, if present. For example, if the
24374 pattern
24375 .code
24376 *queen@*.fict.example
24377 .endd
24378 is matched against the address &'hearts-queen@wonderland.fict.example'& then
24379 .code
24380 $0 = hearts-queen@wonderland.fict.example
24381 $1 = hearts-
24382 $2 = wonderland
24383 .endd
24384 Note that if the local part does not start with an asterisk, but the domain
24385 does, it is &$1$& that contains the wild part of the domain.
24386
24387 .next
24388 If the domain part of the pattern is a partial lookup, the wild and fixed parts
24389 of the domain are placed in the next available numerical variables. Suppose,
24390 for example, that the address &'foo@bar.baz.example'& is processed by a
24391 rewriting rule of the form
24392 .display
24393 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
24394 .endd
24395 and the key in the file that matches the domain is &`*.baz.example`&. Then
24396 .code
24397 $1 = foo
24398 $2 = bar
24399 $3 = baz.example
24400 .endd
24401 If the address &'foo@baz.example'& is looked up, this matches the same
24402 wildcard file entry, and in this case &$2$& is set to the empty string, but
24403 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
24404 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
24405 whole domain. For non-partial domain lookups, no numerical variables are set.
24406 .endlist
24407
24408
24409 .section "Rewriting replacements" "SECID152"
24410 .cindex "rewriting" "replacements"
24411 If the replacement string for a rule is a single asterisk, addresses that
24412 match the pattern and the flags are &'not'& rewritten, and no subsequent
24413 rewriting rules are scanned. For example,
24414 .code
24415 hatta@lookingglass.fict.example  *  f
24416 .endd
24417 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
24418 &'From:'& headers.
24419
24420 .vindex "&$domain$&"
24421 .vindex "&$local_part$&"
24422 If the replacement string is not a single asterisk, it is expanded, and must
24423 yield a fully qualified address. Within the expansion, the variables
24424 &$local_part$& and &$domain$& refer to the address that is being rewritten.
24425 Any letters they contain retain their original case &-- they are not lower
24426 cased. The numerical variables are set up according to the type of pattern that
24427 matched the address, as described above. If the expansion is forced to fail by
24428 the presence of &"fail"& in a conditional or lookup item, rewriting by the
24429 current rule is abandoned, but subsequent rules may take effect. Any other
24430 expansion failure causes the entire rewriting operation to be abandoned, and an
24431 entry written to the panic log.
24432
24433
24434
24435 .section "Rewriting flags" "SECID153"
24436 There are three different kinds of flag that may appear on rewriting rules:
24437
24438 .ilist
24439 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
24440 c, f, h, r, s, t.
24441 .next
24442 A flag that specifies rewriting at SMTP time: S.
24443 .next
24444 Flags that control the rewriting process: Q, q, R, w.
24445 .endlist
24446
24447 For rules that are part of the &%headers_rewrite%& generic transport option,
24448 E, F, T, and S are not permitted.
24449
24450
24451
24452 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
24453          "SECID154"
24454 .cindex "rewriting" "flags"
24455 If none of the following flag letters, nor the &"S"& flag (see section
24456 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
24457 and to both the sender and recipient fields of the envelope, whereas a
24458 transport-time rewriting rule just applies to all headers. Otherwise, the
24459 rewriting rule is skipped unless the relevant addresses are being processed.
24460 .display
24461 &`E`&       rewrite all envelope fields
24462 &`F`&       rewrite the envelope From field
24463 &`T`&       rewrite the envelope To field
24464 &`b`&       rewrite the &'Bcc:'& header
24465 &`c`&       rewrite the &'Cc:'& header
24466 &`f`&       rewrite the &'From:'& header
24467 &`h`&       rewrite all headers
24468 &`r`&       rewrite the &'Reply-To:'& header
24469 &`s`&       rewrite the &'Sender:'& header
24470 &`t`&       rewrite the &'To:'& header
24471 .endd
24472 "All headers" means all of the headers listed above that can be selected
24473 individually, plus their &'Resent-'& versions. It does not include
24474 other headers such as &'Subject:'& etc.
24475
24476 You should be particularly careful about rewriting &'Sender:'& headers, and
24477 restrict this to special known cases in your own domains.
24478
24479
24480 .section "The SMTP-time rewriting flag" "SECTrewriteS"
24481 .cindex "SMTP" "rewriting malformed addresses"
24482 .cindex "RCPT" "rewriting argument of"
24483 .cindex "MAIL" "rewriting argument of"
24484 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
24485 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
24486 before any other processing; even before syntax checking. The pattern is
24487 required to be a regular expression, and it is matched against the whole of the
24488 data for the command, including any surrounding angle brackets.
24489
24490 .vindex "&$domain$&"
24491 .vindex "&$local_part$&"
24492 This form of rewrite rule allows for the handling of addresses that are not
24493 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
24494 input). Because the input is not required to be a syntactically valid address,
24495 the variables &$local_part$& and &$domain$& are not available during the
24496 expansion of the replacement string. The result of rewriting replaces the
24497 original address in the MAIL or RCPT command.
24498
24499
24500 .section "Flags controlling the rewriting process" "SECID155"
24501 There are four flags which control the way the rewriting process works. These
24502 take effect only when a rule is invoked, that is, when the address is of the
24503 correct type (matches the flags) and matches the pattern:
24504
24505 .ilist
24506 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
24507 unqualified local part. It is qualified with &%qualify_recipient%&. In the
24508 absence of &"Q"& the rewritten address must always include a domain.
24509 .next
24510 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
24511 even if no rewriting actually takes place because of a &"fail"& in the
24512 expansion. The &"q"& flag is not effective if the address is of the wrong type
24513 (does not match the flags) or does not match the pattern.
24514 .next
24515 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
24516 address, up to ten times. It can be combined with the &"q"& flag, to stop
24517 rewriting once it fails to match (after at least one successful rewrite).
24518 .next
24519 .cindex "rewriting" "whole addresses"
24520 When an address in a header is rewritten, the rewriting normally applies only
24521 to the working part of the address, with any comments and RFC 2822 &"phrase"&
24522 left unchanged. For example, rewriting might change
24523 .code
24524 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
24525 .endd
24526 into
24527 .code
24528 From: Ford Prefect <prefectf@hitch.fict.example>
24529 .endd
24530 .cindex "RFC 2047"
24531 Sometimes there is a need to replace the whole address item, and this can be
24532 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
24533 causes an address in a header line to be rewritten, the entire address is
24534 replaced, not just the working part. The replacement must be a complete RFC
24535 2822 address, including the angle brackets if necessary. If text outside angle
24536 brackets contains a character whose value is greater than 126 or less than 32
24537 (except for tab), the text is encoded according to RFC 2047. The character set
24538 is taken from &%headers_charset%&, which gets its default at build time.
24539
24540 When the &"w"& flag is set on a rule that causes an envelope address to be
24541 rewritten, all but the working part of the replacement address is discarded.
24542 .endlist
24543
24544
24545 .section "Rewriting examples" "SECID156"
24546 Here is an example of the two common rewriting paradigms:
24547 .code
24548 *@*.hitch.fict.example  $1@hitch.fict.example
24549 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
24550                      {$value}fail}@hitch.fict.example bctfrF
24551 .endd
24552 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
24553 the string expansion to fail if the lookup does not succeed. In this context it
24554 has the effect of leaving the original address unchanged, but Exim goes on to
24555 consider subsequent rewriting rules, if any, because the &"q"& flag is not
24556 present in that rule. An alternative to &"fail"& would be to supply &$1$&
24557 explicitly, which would cause the rewritten address to be the same as before,
24558 at the cost of a small bit of processing. Not supplying either of these is an
24559 error, since the rewritten address would then contain no local part.
24560
24561 The first example above replaces the domain with a superior, more general
24562 domain. This may not be desirable for certain local parts. If the rule
24563 .code
24564 root@*.hitch.fict.example  *
24565 .endd
24566 were inserted before the first rule, rewriting would be suppressed for the
24567 local part &'root'& at any domain ending in &'hitch.fict.example'&.
24568
24569 Rewriting can be made conditional on a number of tests, by making use of
24570 &${if$& in the expansion item. For example, to apply a rewriting rule only to
24571 messages that originate outside the local host:
24572 .code
24573 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
24574                          {$1@hitch.fict.example}fail}"
24575 .endd
24576 The replacement string is quoted in this example because it contains white
24577 space.
24578
24579 .cindex "rewriting" "bang paths"
24580 .cindex "bang paths" "rewriting"
24581 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
24582 an address it treats it as an unqualified local part which it qualifies with
24583 the local qualification domain (if the source of the message is local or if the
24584 remote host is permitted to send unqualified addresses). Rewriting can
24585 sometimes be used to handle simple bang paths with a fixed number of
24586 components. For example, the rule
24587 .code
24588 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
24589 .endd
24590 rewrites a two-component bang path &'host.name!user'& as the domain address
24591 &'user@host.name'&. However, there is a security implication in using this as
24592 a global rewriting rule for envelope addresses. It can provide a backdoor
24593 method for using your system as a relay, because the incoming addresses appear
24594 to be local. If the bang path addresses are received via SMTP, it is safer to
24595 use the &"S"& flag to rewrite them as they are received, so that relay checking
24596 can be done on the rewritten addresses.
24597 .ecindex IIDaddrew
24598
24599
24600
24601
24602
24603 . ////////////////////////////////////////////////////////////////////////////
24604 . ////////////////////////////////////////////////////////////////////////////
24605
24606 .chapter "Retry configuration" "CHAPretry"
24607 .scindex IIDretconf1 "retry" "configuration, description of"
24608 .scindex IIDregconf2 "configuration file" "retry section"
24609 The &"retry"& section of the runtime configuration file contains a list of
24610 retry rules that control how often Exim tries to deliver messages that cannot
24611 be delivered at the first attempt. If there are no retry rules (the section is
24612 empty or not present), there are no retries. In this situation, temporary
24613 errors are treated as permanent. The default configuration contains a single,
24614 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
24615 line option can be used to test which retry rule will be used for a given
24616 address, domain and error.
24617
24618 The most common cause of retries is temporary failure to deliver to a remote
24619 host because the host is down, or inaccessible because of a network problem.
24620 Exim's retry processing in this case is applied on a per-host (strictly, per IP
24621 address) basis, not on a per-message basis. Thus, if one message has recently
24622 been delayed, delivery of a new message to the same host is not immediately
24623 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
24624 log selector is set, the message
24625 .cindex "retry" "time not reached"
24626 &"retry time not reached"& is written to the main log whenever a delivery is
24627 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
24628 the handling of errors during remote deliveries.
24629
24630 Retry processing applies to routing as well as to delivering, except as covered
24631 in the next paragraph. The retry rules do not distinguish between these
24632 actions. It is not possible, for example, to specify different behaviour for
24633 failures to route the domain &'snark.fict.example'& and failures to deliver to
24634 the host &'snark.fict.example'&. I didn't think anyone would ever need this
24635 added complication, so did not implement it. However, although they share the
24636 same retry rule, the actual retry times for routing and transporting a given
24637 domain are maintained independently.
24638
24639 When a delivery is not part of a queue run (typically an immediate delivery on
24640 receipt of a message), the routers are always run, and local deliveries are
24641 always attempted, even if retry times are set for them. This makes for better
24642 behaviour if one particular message is causing problems (for example, causing
24643 quota overflow, or provoking an error in a filter file). If such a delivery
24644 suffers a temporary failure, the retry data is updated as normal, and
24645 subsequent delivery attempts from queue runs occur only when the retry time for
24646 the local address is reached.
24647
24648 .section "Changing retry rules" "SECID157"
24649 If you change the retry rules in your configuration, you should consider
24650 whether or not to delete the retry data that is stored in Exim's spool area in
24651 files with names like &_db/retry_&. Deleting any of Exim's hints files is
24652 always safe; that is why they are called &"hints"&.
24653
24654 The hints retry data contains suggested retry times based on the previous
24655 rules. In the case of a long-running problem with a remote host, it might
24656 record the fact that the host has timed out. If your new rules increase the
24657 timeout time for such a host, you should definitely remove the old retry data
24658 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
24659 messages that it should now be retaining.
24660
24661
24662
24663 .section "Format of retry rules" "SECID158"
24664 .cindex "retry" "rules"
24665 Each retry rule occupies one line and consists of three or four parts,
24666 separated by white space: a pattern, an error name, an optional list of sender
24667 addresses, and a list of retry parameters. The pattern and sender lists must be
24668 enclosed in double quotes if they contain white space. The rules are searched
24669 in order until one is found where the pattern, error name, and sender list (if
24670 present) match the failing host or address, the error that occurred, and the
24671 message's sender, respectively.
24672
24673
24674 The pattern is any single item that may appear in an address list (see section
24675 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
24676 which means that it is expanded before being tested against the address that
24677 has been delayed. A negated address list item is permitted. Address
24678 list processing treats a plain domain name as if it were preceded by &"*@"&,
24679 which makes it possible for many retry rules to start with just a domain. For
24680 example,
24681 .code
24682 lookingglass.fict.example        *  F,24h,30m;
24683 .endd
24684 provides a rule for any address in the &'lookingglass.fict.example'& domain,
24685 whereas
24686 .code
24687 alice@lookingglass.fict.example  *  F,24h,30m;
24688 .endd
24689 applies only to temporary failures involving the local part &%alice%&.
24690 In practice, almost all rules start with a domain name pattern without a local
24691 part.
24692
24693 .cindex "regular expressions" "in retry rules"
24694 &*Warning*&: If you use a regular expression in a retry rule pattern, it
24695 must match a complete address, not just a domain, because that is how regular
24696 expressions work in address lists.
24697 .display
24698 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
24699 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
24700 .endd
24701
24702
24703 .section "Choosing which retry rule to use for address errors" "SECID159"
24704 When Exim is looking for a retry rule after a routing attempt has failed (for
24705 example, after a DNS timeout), each line in the retry configuration is tested
24706 against the complete address only if &%retry_use_local_part%& is set for the
24707 router. Otherwise, only the domain is used, except when matching against a
24708 regular expression, when the local part of the address is replaced with &"*"&.
24709 A domain on its own can match a domain pattern, or a pattern that starts with
24710 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
24711 &%check_local_user%& is true, and false for other routers.
24712
24713 Similarly, when Exim is looking for a retry rule after a local delivery has
24714 failed (for example, after a mailbox full error), each line in the retry
24715 configuration is tested against the complete address only if
24716 &%retry_use_local_part%& is set for the transport (it defaults true for all
24717 local transports).
24718
24719 .cindex "4&'xx'& responses" "retry rules for"
24720 However, when Exim is looking for a retry rule after a remote delivery attempt
24721 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
24722 whole address is always used as the key when searching the retry rules. The
24723 rule that is found is used to create a retry time for the combination of the
24724 failing address and the message's sender. It is the combination of sender and
24725 recipient that is delayed in subsequent queue runs until its retry time is
24726 reached. You can delay the recipient without regard to the sender by setting
24727 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
24728 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
24729 commands.
24730
24731
24732
24733 .section "Choosing which retry rule to use for host and message errors" &&&
24734          "SECID160"
24735 For a temporary error that is not related to an individual address (for
24736 example, a connection timeout), each line in the retry configuration is checked
24737 twice. First, the name of the remote host is used as a domain name (preceded by
24738 &"*@"& when matching a regular expression). If this does not match the line,
24739 the domain from the email address is tried in a similar fashion. For example,
24740 suppose the MX records for &'a.b.c.example'& are
24741 .code
24742 a.b.c.example  MX  5  x.y.z.example
24743                MX  6  p.q.r.example
24744                MX  7  m.n.o.example
24745 .endd
24746 and the retry rules are
24747 .code
24748 p.q.r.example    *      F,24h,30m;
24749 a.b.c.example    *      F,4d,45m;
24750 .endd
24751 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
24752 first rule matches neither the host nor the domain, so Exim looks at the second
24753 rule. This does not match the host, but it does match the domain, so it is used
24754 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
24755 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
24756 first retry rule is used, because it matches the host.
24757
24758 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
24759 first rule to determine retry times, but for all the other hosts for the domain
24760 &'a.b.c.example'&, the second rule is used. The second rule is also used if
24761 routing to &'a.b.c.example'& suffers a temporary failure.
24762
24763 &*Note*&: The host name is used when matching the patterns, not its IP address.
24764 However, if a message is routed directly to an IP address without the use of a
24765 host name, for example, if a &(manualroute)& router contains a setting such as:
24766 .code
24767 route_list = *.a.example  192.168.34.23
24768 .endd
24769 then the &"host name"& that is used when searching for a retry rule is the
24770 textual form of the IP address.
24771
24772 .section "Retry rules for specific errors" "SECID161"
24773 .cindex "retry" "specific errors; specifying"
24774 The second field in a retry rule is the name of a particular error, or an
24775 asterisk, which matches any error. The errors that can be tested for are:
24776
24777 .vlist
24778 .vitem &%auth_failed%&
24779 Authentication failed when trying to send to a host in the
24780 &%hosts_require_auth%& list in an &(smtp)& transport.
24781
24782 .vitem &%data_4xx%&
24783 A 4&'xx'& error was received for an outgoing DATA command, either immediately
24784 after the command, or after sending the message's data.
24785
24786 .vitem &%mail_4xx%&
24787 A 4&'xx'& error was received for an outgoing MAIL command.
24788
24789 .vitem &%rcpt_4xx%&
24790 A 4&'xx'& error was received for an outgoing RCPT command.
24791 .endlist
24792
24793 For the three 4&'xx'& errors, either the first or both of the x's can be given
24794 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
24795 recognize 452 errors given to RCPT commands for addresses in a certain domain,
24796 and have retries every ten minutes with a one-hour timeout, you could set up a
24797 retry rule of this form:
24798 .code
24799 the.domain.name  rcpt_452   F,1h,10m
24800 .endd
24801 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
24802 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
24803
24804 .vlist
24805 .vitem &%lost_connection%&
24806 A server unexpectedly closed the SMTP connection. There may, of course,
24807 legitimate reasons for this (host died, network died), but if it repeats a lot
24808 for the same host, it indicates something odd.
24809
24810 .vitem &%lookup%&
24811 A DNS lookup for a host failed.
24812 Note that a &%dnslookup%& router will need to have matched
24813 its &%fail_defer_domains%& option for this retry type to be usable.
24814 Also note that a &%manualroute%& router will probably need
24815 its &%host_find_failed%& option set to &%defer%&.
24816
24817 .vitem &%refused_MX%&
24818 A connection to a host obtained from an MX record was refused.
24819
24820 .vitem &%refused_A%&
24821 A connection to a host not obtained from an MX record was refused.
24822
24823 .vitem &%refused%&
24824 A connection was refused.
24825
24826 .vitem &%timeout_connect_MX%&
24827 A connection attempt to a host obtained from an MX record timed out.
24828
24829 .vitem &%timeout_connect_A%&
24830 A connection attempt to a host not obtained from an MX record timed out.
24831
24832 .vitem &%timeout_connect%&
24833 A connection attempt timed out.
24834
24835 .vitem &%timeout_MX%&
24836 There was a timeout while connecting or during an SMTP session with a host
24837 obtained from an MX record.
24838
24839 .vitem &%timeout_A%&
24840 There was a timeout while connecting or during an SMTP session with a host not
24841 obtained from an MX record.
24842
24843 .vitem &%timeout%&
24844 There was a timeout while connecting or during an SMTP session.
24845
24846 .vitem &%tls_required%&
24847 The server was required to use TLS (it matched &%hosts_require_tls%& in the
24848 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
24849 to STARTTLS, or there was a problem setting up the TLS connection.
24850
24851 .vitem &%quota%&
24852 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
24853 transport.
24854
24855 .vitem &%quota_%&<&'time'&>
24856 .cindex "quota" "error testing in retry rule"
24857 .cindex "retry" "quota error testing"
24858 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
24859 transport, and the mailbox has not been accessed for <&'time'&>. For example,
24860 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
24861 for four days.
24862 .endlist
24863
24864 .cindex "mailbox" "time of last read"
24865 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
24866 timeouts when the mailbox is full and is not being read by its owner. Ideally,
24867 it should be based on the last time that the user accessed the mailbox.
24868 However, it is not always possible to determine this. Exim uses the following
24869 heuristic rules:
24870
24871 .ilist
24872 If the mailbox is a single file, the time of last access (the &"atime"&) is
24873 used. As no new messages are being delivered (because the mailbox is over
24874 quota), Exim does not access the file, so this is the time of last user access.
24875 .next
24876 .cindex "maildir format" "time of last read"
24877 For a maildir delivery, the time of last modification of the &_new_&
24878 subdirectory is used. As the mailbox is over quota, no new files are created in
24879 the &_new_& subdirectory, because no new messages are being delivered. Any
24880 change to the &_new_& subdirectory is therefore assumed to be the result of an
24881 MUA moving a new message to the &_cur_& directory when it is first read. The
24882 time that is used is therefore the last time that the user read a new message.
24883 .next
24884 For other kinds of multi-file mailbox, the time of last access cannot be
24885 obtained, so a retry rule that uses this type of error field is never matched.
24886 .endlist
24887
24888 The quota errors apply both to system-enforced quotas and to Exim's own quota
24889 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
24890 when a local delivery is deferred because a partition is full (the ENOSPC
24891 error).
24892
24893
24894
24895 .section "Retry rules for specified senders" "SECID162"
24896 .cindex "retry" "rules; sender-specific"
24897 You can specify retry rules that apply only when the failing message has a
24898 specific sender. In particular, this can be used to define retry rules that
24899 apply only to bounce messages. The third item in a retry rule can be of this
24900 form:
24901 .display
24902 &`senders=`&<&'address list'&>
24903 .endd
24904 The retry timings themselves are then the fourth item. For example:
24905 .code
24906 *   rcpt_4xx   senders=:   F,1h,30m
24907 .endd
24908 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
24909 host. If the address list contains white space, it must be enclosed in quotes.
24910 For example:
24911 .code
24912 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
24913 .endd
24914 &*Warning*&: This facility can be unhelpful if it is used for host errors
24915 (which do not depend on the recipient). The reason is that the sender is used
24916 only to match the retry rule. Once the rule has been found for a host error,
24917 its contents are used to set a retry time for the host, and this will apply to
24918 all messages, not just those with specific senders.
24919
24920 When testing retry rules using &%-brt%&, you can supply a sender using the
24921 &%-f%& command line option, like this:
24922 .code
24923 exim -f "" -brt user@dom.ain
24924 .endd
24925 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
24926 list is never matched.
24927
24928
24929
24930
24931
24932 .section "Retry parameters" "SECID163"
24933 .cindex "retry" "parameters in rules"
24934 The third (or fourth, if a senders list is present) field in a retry rule is a
24935 sequence of retry parameter sets, separated by semicolons. Each set consists of
24936 .display
24937 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
24938 .endd
24939 The letter identifies the algorithm for computing a new retry time; the cutoff
24940 time is the time beyond which this algorithm no longer applies, and the
24941 arguments vary the algorithm's action. The cutoff time is measured from the
24942 time that the first failure for the domain (combined with the local part if
24943 relevant) was detected, not from the time the message was received.
24944
24945 .cindex "retry" "algorithms"
24946 .cindex "retry" "fixed intervals"
24947 .cindex "retry" "increasing intervals"
24948 .cindex "retry" "random intervals"
24949 The available algorithms are:
24950
24951 .ilist
24952 &'F'&: retry at fixed intervals. There is a single time parameter specifying
24953 the interval.
24954 .next
24955 &'G'&: retry at geometrically increasing intervals. The first argument
24956 specifies a starting value for the interval, and the second a multiplier, which
24957 is used to increase the size of the interval at each retry.
24958 .next
24959 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
24960 retry, the previous interval is multiplied by the factor in order to get a
24961 maximum for the next interval. The minimum interval is the first argument of
24962 the parameter, and an actual interval is chosen randomly between them. Such a
24963 rule has been found to be helpful in cluster configurations when all the
24964 members of the cluster restart at once, and may therefore synchronize their
24965 queue processing times.
24966 .endlist
24967
24968 When computing the next retry time, the algorithm definitions are scanned in
24969 order until one whose cutoff time has not yet passed is reached. This is then
24970 used to compute a new retry time that is later than the current time. In the
24971 case of fixed interval retries, this simply means adding the interval to the
24972 current time. For geometrically increasing intervals, retry intervals are
24973 computed from the rule's parameters until one that is greater than the previous
24974 interval is found. The main configuration variable
24975 .cindex "limit" "retry interval"
24976 .cindex "retry" "interval, maximum"
24977 .oindex "&%retry_interval_max%&"
24978 &%retry_interval_max%& limits the maximum interval between retries. It
24979 cannot be set greater than &`24h`&, which is its default value.
24980
24981 A single remote domain may have a number of hosts associated with it, and each
24982 host may have more than one IP address. Retry algorithms are selected on the
24983 basis of the domain name, but are applied to each IP address independently. If,
24984 for example, a host has two IP addresses and one is unusable, Exim will
24985 generate retry times for it and will not try to use it until its next retry
24986 time comes. Thus the good IP address is likely to be tried first most of the
24987 time.
24988
24989 .cindex "hints database" "use for retrying"
24990 Retry times are hints rather than promises. Exim does not make any attempt to
24991 run deliveries exactly at the computed times. Instead, a queue runner process
24992 starts delivery processes for delayed messages periodically, and these attempt
24993 new deliveries only for those addresses that have passed their next retry time.
24994 If a new message arrives for a deferred address, an immediate delivery attempt
24995 occurs only if the address has passed its retry time. In the absence of new
24996 messages, the minimum time between retries is the interval between queue runner
24997 processes. There is not much point in setting retry times of five minutes if
24998 your queue runners happen only once an hour, unless there are a significant
24999 number of incoming messages (which might be the case on a system that is
25000 sending everything to a smart host, for example).
25001
25002 The data in the retry hints database can be inspected by using the
25003 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
25004 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
25005 &'exinext'& utility script can be used to find out what the next retry times
25006 are for the hosts associated with a particular mail domain, and also for local
25007 deliveries that have been deferred.
25008
25009
25010 .section "Retry rule examples" "SECID164"
25011 Here are some example retry rules:
25012 .code
25013 alice@wonderland.fict.example quota_5d  F,7d,3h
25014 wonderland.fict.example       quota_5d
25015 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
25016 lookingglass.fict.example     *         F,24h,30m;
25017 *                 refused_A   F,2h,20m;
25018 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
25019 .endd
25020 The first rule sets up special handling for mail to
25021 &'alice@wonderland.fict.example'& when there is an over-quota error and the
25022 mailbox has not been read for at least 5 days. Retries continue every three
25023 hours for 7 days. The second rule handles over-quota errors for all other local
25024 parts at &'wonderland.fict.example'&; the absence of a local part has the same
25025 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
25026 fail are bounced immediately if the mailbox has not been read for at least 5
25027 days.
25028
25029 The third rule handles all other errors at &'wonderland.fict.example'&; retries
25030 happen every 15 minutes for an hour, then with geometrically increasing
25031 intervals until two days have passed since a delivery first failed. After the
25032 first hour there is a delay of one hour, then two hours, then four hours, and
25033 so on (this is a rather extreme example).
25034
25035 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
25036 They happen every 30 minutes for 24 hours only. The remaining two rules handle
25037 all other domains, with special action for connection refusal from hosts that
25038 were not obtained from an MX record.
25039
25040 The final rule in a retry configuration should always have asterisks in the
25041 first two fields so as to provide a general catch-all for any addresses that do
25042 not have their own special handling. This example tries every 15 minutes for 2
25043 hours, then with intervals starting at one hour and increasing by a factor of
25044 1.5 up to 16 hours, then every 8 hours up to 5 days.
25045
25046
25047
25048 .section "Timeout of retry data" "SECID165"
25049 .cindex "timeout" "of retry data"
25050 .oindex "&%retry_data_expire%&"
25051 .cindex "hints database" "data expiry"
25052 .cindex "retry" "timeout of data"
25053 Exim timestamps the data that it writes to its retry hints database. When it
25054 consults the data during a delivery it ignores any that is older than the value
25055 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
25056 been tried for 7 days, Exim will try to deliver to it immediately a message
25057 arrives, and if that fails, it will calculate a retry time as if it were
25058 failing for the first time.
25059
25060 This improves the behaviour for messages routed to rarely-used hosts such as MX
25061 backups. If such a host was down at one time, and happens to be down again when
25062 Exim tries a month later, using the old retry data would imply that it had been
25063 down all the time, which is not a justified assumption.
25064
25065 If a host really is permanently dead, this behaviour causes a burst of retries
25066 every now and again, but only if messages routed to it are rare. If there is a
25067 message at least once every 7 days the retry data never expires.
25068
25069
25070
25071
25072 .section "Long-term failures" "SECID166"
25073 .cindex "delivery failure, long-term"
25074 .cindex "retry" "after long-term failure"
25075 Special processing happens when an email address has been failing for so long
25076 that the cutoff time for the last algorithm is reached. For example, using the
25077 default retry rule:
25078 .code
25079 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
25080 .endd
25081 the cutoff time is four days. Reaching the retry cutoff is independent of how
25082 long any specific message has been failing; it is the length of continuous
25083 failure for the recipient address that counts.
25084
25085 When the cutoff time is reached for a local delivery, or for all the IP
25086 addresses associated with a remote delivery, a subsequent delivery failure
25087 causes Exim to give up on the address, and a bounce message is generated.
25088 In order to cater for new messages that use the failing address, a next retry
25089 time is still computed from the final algorithm, and is used as follows:
25090
25091 For local deliveries, one delivery attempt is always made for any subsequent
25092 messages. If this delivery fails, the address fails immediately. The
25093 post-cutoff retry time is not used.
25094
25095 If the delivery is remote, there are two possibilities, controlled by the
25096 .oindex "&%delay_after_cutoff%&"
25097 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
25098 default. Until the post-cutoff retry time for one of the IP addresses is
25099 reached, the failing email address is bounced immediately, without a delivery
25100 attempt taking place. After that time, one new delivery attempt is made to
25101 those IP addresses that are past their retry times, and if that still fails,
25102 the address is bounced and new retry times are computed.
25103
25104 In other words, when all the hosts for a given email address have been failing
25105 for a long time, Exim bounces rather then defers until one of the hosts' retry
25106 times is reached. Then it tries once, and bounces if that attempt fails. This
25107 behaviour ensures that few resources are wasted in repeatedly trying to deliver
25108 to a broken destination, but if the host does recover, Exim will eventually
25109 notice.
25110
25111 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
25112 addresses are past their final cutoff time, Exim tries to deliver to those IP
25113 addresses that have not been tried since the message arrived. If there are
25114 no suitable IP addresses, or if they all fail, the address is bounced. In other
25115 words, it does not delay when a new message arrives, but tries the expired
25116 addresses immediately, unless they have been tried since the message arrived.
25117 If there is a continuous stream of messages for the failing domains, setting
25118 &%delay_after_cutoff%& false means that there will be many more attempts to
25119 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
25120 true.
25121
25122 .section "Deliveries that work intermittently" "SECID167"
25123 .cindex "retry" "intermittently working deliveries"
25124 Some additional logic is needed to cope with cases where a host is
25125 intermittently available, or when a message has some attribute that prevents
25126 its delivery when others to the same address get through. In this situation,
25127 because some messages are successfully delivered, the &"retry clock"& for the
25128 host or address keeps getting reset by the successful deliveries, and so
25129 failing messages remain on the queue for ever because the cutoff time is never
25130 reached.
25131
25132 Two exceptional actions are applied to prevent this happening. The first
25133 applies to errors that are related to a message rather than a remote host.
25134 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
25135 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
25136 commands, and quota failures. For this type of error, if a message's arrival
25137 time is earlier than the &"first failed"& time for the error, the earlier time
25138 is used when scanning the retry rules to decide when to try next and when to
25139 time out the address.
25140
25141 The exceptional second action applies in all cases. If a message has been on
25142 the queue for longer than the cutoff time of any applicable retry rule for a
25143 given address, a delivery is attempted for that address, even if it is not yet
25144 time, and if this delivery fails, the address is timed out. A new retry time is
25145 not computed in this case, so that other messages for the same address are
25146 considered immediately.
25147 .ecindex IIDretconf1
25148 .ecindex IIDregconf2
25149
25150
25151
25152
25153
25154
25155 . ////////////////////////////////////////////////////////////////////////////
25156 . ////////////////////////////////////////////////////////////////////////////
25157
25158 .chapter "SMTP authentication" "CHAPSMTPAUTH"
25159 .scindex IIDauthconf1 "SMTP" "authentication configuration"
25160 .scindex IIDauthconf2 "authentication"
25161 The &"authenticators"& section of Exim's run time configuration is concerned
25162 with SMTP authentication. This facility is an extension to the SMTP protocol,
25163 described in RFC 2554, which allows a client SMTP host to authenticate itself
25164 to a server. This is a common way for a server to recognize clients that are
25165 permitted to use it as a relay. SMTP authentication is not of relevance to the
25166 transfer of mail between servers that have no managerial connection with each
25167 other.
25168
25169 .cindex "AUTH" "description of"
25170 Very briefly, the way SMTP authentication works is as follows:
25171
25172 .ilist
25173 The server advertises a number of authentication &'mechanisms'& in response to
25174 the client's EHLO command.
25175 .next
25176 The client issues an AUTH command, naming a specific mechanism. The command
25177 may, optionally, contain some authentication data.
25178 .next
25179 The server may issue one or more &'challenges'&, to which the client must send
25180 appropriate responses. In simple authentication mechanisms, the challenges are
25181 just prompts for user names and passwords. The server does not have to issue
25182 any challenges &-- in some mechanisms the relevant data may all be transmitted
25183 with the AUTH command.
25184 .next
25185 The server either accepts or denies authentication.
25186 .next
25187 If authentication succeeds, the client may optionally make use of the AUTH
25188 option on the MAIL command to pass an authenticated sender in subsequent
25189 mail transactions. Authentication lasts for the remainder of the SMTP
25190 connection.
25191 .next
25192 If authentication fails, the client may give up, or it may try a different
25193 authentication mechanism, or it may try transferring mail over the
25194 unauthenticated connection.
25195 .endlist
25196
25197 If you are setting up a client, and want to know which authentication
25198 mechanisms the server supports, you can use Telnet to connect to port 25 (the
25199 SMTP port) on the server, and issue an EHLO command. The response to this
25200 includes the list of supported mechanisms. For example:
25201 .display
25202 &`$ `&&*&`telnet server.example 25`&*&
25203 &`Trying 192.168.34.25...`&
25204 &`Connected to server.example.`&
25205 &`Escape character is &#x0027;^]&#x0027;.`&
25206 &`220 server.example ESMTP Exim 4.20 ...`&
25207 &*&`ehlo client.example`&*&
25208 &`250-server.example Hello client.example [10.8.4.5]`&
25209 &`250-SIZE 52428800`&
25210 &`250-PIPELINING`&
25211 &`250-AUTH PLAIN`&
25212 &`250 HELP`&
25213 .endd
25214 The second-last line of this example output shows that the server supports
25215 authentication using the PLAIN mechanism. In Exim, the different authentication
25216 mechanisms are configured by specifying &'authenticator'& drivers. Like the
25217 routers and transports, which authenticators are included in the binary is
25218 controlled by build-time definitions. The following are currently available,
25219 included by setting
25220 .code
25221 AUTH_CRAM_MD5=yes
25222 AUTH_CYRUS_SASL=yes
25223 AUTH_DOVECOT=yes
25224 AUTH_GSASL=yes
25225 AUTH_HEIMDAL_GSSAPI=yes
25226 AUTH_PLAINTEXT=yes
25227 AUTH_SPA=yes
25228 AUTH_TLS=yes
25229 .endd
25230 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
25231 authentication mechanism (RFC 2195), and the second provides an interface to
25232 the Cyrus SASL authentication library.
25233 The third is an interface to Dovecot's authentication system, delegating the
25234 work via a socket interface.
25235 The fourth provides an interface to the GNU SASL authentication library, which
25236 provides mechanisms but typically not data sources.
25237 The fifth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
25238 supporting setting a server keytab.
25239 The sixth can be configured to support
25240 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
25241 not formally documented, but used by several MUAs. The seventh authenticator
25242 supports Microsoft's &'Secure Password Authentication'& mechanism.
25243 The eighth is an Exim authenticator but not an SMTP one;
25244 instead it can use information from a TLS negotiation.
25245
25246 The authenticators are configured using the same syntax as other drivers (see
25247 section &<<SECTfordricon>>&). If no authenticators are required, no
25248 authentication section need be present in the configuration file. Each
25249 authenticator can in principle have both server and client functions. When Exim
25250 is receiving SMTP mail, it is acting as a server; when it is sending out
25251 messages over SMTP, it is acting as a client. Authenticator configuration
25252 options are provided for use in both these circumstances.
25253
25254 To make it clear which options apply to which situation, the prefixes
25255 &%server_%& and &%client_%& are used on option names that are specific to
25256 either the server or the client function, respectively. Server and client
25257 functions are disabled if none of their options are set. If an authenticator is
25258 to be used for both server and client functions, a single definition, using
25259 both sets of options, is required. For example:
25260 .code
25261 cram:
25262   driver = cram_md5
25263   public_name = CRAM-MD5
25264   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
25265   client_name = ph10
25266   client_secret = secret2
25267 .endd
25268 The &%server_%& option is used when Exim is acting as a server, and the
25269 &%client_%& options when it is acting as a client.
25270
25271 Descriptions of the individual authenticators are given in subsequent chapters.
25272 The remainder of this chapter covers the generic options for the
25273 authenticators, followed by general discussion of the way authentication works
25274 in Exim.
25275
25276 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
25277 per-mechanism basis.  Please read carefully to determine which variables hold
25278 account labels such as usercodes and which hold passwords or other
25279 authenticating data.
25280
25281 Note that some mechanisms support two different identifiers for accounts: the
25282 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
25283 and &'authz'& are commonly encountered.  The American spelling is standard here.
25284 Conceptually, authentication data such as passwords are tied to the identifier
25285 used to authenticate; servers may have rules to permit one user to act as a
25286 second user, so that after login the session is treated as though that second
25287 user had logged in.  That second user is the &'authorization id'&.  A robust
25288 configuration might confirm that the &'authz'& field is empty or matches the
25289 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
25290 as verified data, the &'authz'& as an unverified request which the server might
25291 choose to honour.
25292
25293 A &'realm'& is a text string, typically a domain name, presented by a server
25294 to a client to help it select an account and credentials to use.  In some
25295 mechanisms, the client and server provably agree on the realm, but clients
25296 typically can not treat the realm as secure data to be blindly trusted.
25297
25298
25299
25300 .section "Generic options for authenticators" "SECID168"
25301 .cindex "authentication" "generic options"
25302 .cindex "options" "generic; for authenticators"
25303
25304 .option client_condition authenticators string&!! unset
25305 When Exim is authenticating as a client, it skips any authenticator whose
25306 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
25307 used, for example, to skip plain text authenticators when the connection is not
25308 encrypted by a setting such as:
25309 .code
25310 client_condition = ${if !eq{$tls_out_cipher}{}}
25311 .endd
25312
25313
25314 .option client_set_id authenticators string&!! unset
25315 When client authentication succeeds, this condition is expanded; the
25316 result is used in the log lines for outbound messages.
25317 Typically it will be the user name used for authentication.
25318
25319
25320 .option driver authenticators string unset
25321 This option must always be set. It specifies which of the available
25322 authenticators is to be used.
25323
25324
25325 .option public_name authenticators string unset
25326 This option specifies the name of the authentication mechanism that the driver
25327 implements, and by which it is known to the outside world. These names should
25328 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
25329 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
25330 defaults to the driver's instance name.
25331
25332
25333 .option server_advertise_condition authenticators string&!! unset
25334 When a server is about to advertise an authentication mechanism, the condition
25335 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
25336 mechanism is not advertised.
25337 If the expansion fails, the mechanism is not advertised. If the failure was not
25338 forced, and was not caused by a lookup defer, the incident is logged.
25339 See section &<<SECTauthexiser>>& below for further discussion.
25340
25341
25342 .option server_condition authenticators string&!! unset
25343 This option must be set for a &%plaintext%& server authenticator, where it
25344 is used directly to control authentication. See section &<<SECTplainserver>>&
25345 for details.
25346
25347 For the &(gsasl)& authenticator, this option is required for various
25348 mechanisms; see chapter &<<CHAPgsasl>>& for details.
25349
25350 For the other authenticators, &%server_condition%& can be used as an additional
25351 authentication or authorization mechanism that is applied after the other
25352 authenticator conditions succeed. If it is set, it is expanded when the
25353 authenticator would otherwise return a success code. If the expansion is forced
25354 to fail, authentication fails. Any other expansion failure causes a temporary
25355 error code to be returned. If the result of a successful expansion is an empty
25356 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
25357 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
25358 other result, a temporary error code is returned, with the expanded string as
25359 the error text.
25360
25361
25362 .option server_debug_print authenticators string&!! unset
25363 If this option is set and authentication debugging is enabled (see the &%-d%&
25364 command line option), the string is expanded and included in the debugging
25365 output when the authenticator is run as a server. This can help with checking
25366 out the values of variables.
25367 If expansion of the string fails, the error message is written to the debugging
25368 output, and Exim carries on processing.
25369
25370
25371 .option server_set_id authenticators string&!! unset
25372 .vindex "&$authenticated_id$&"
25373 When an Exim server successfully authenticates a client, this string is
25374 expanded using data from the authentication, and preserved for any incoming
25375 messages in the variable &$authenticated_id$&. It is also included in the log
25376 lines for incoming messages. For example, a user/password authenticator
25377 configuration might preserve the user name that was used to authenticate, and
25378 refer to it subsequently during delivery of the message.
25379 If expansion fails, the option is ignored.
25380
25381
25382 .option server_mail_auth_condition authenticators string&!! unset
25383 This option allows a server to discard authenticated sender addresses supplied
25384 as part of MAIL commands in SMTP connections that are authenticated by the
25385 driver on which &%server_mail_auth_condition%& is set. The option is not used
25386 as part of the authentication process; instead its (unexpanded) value is
25387 remembered for later use.
25388 How it is used is described in the following section.
25389
25390
25391
25392
25393
25394 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
25395 .cindex "authentication" "sender; authenticated"
25396 .cindex "AUTH" "on MAIL command"
25397 When a client supplied an AUTH= item on a MAIL command, Exim applies
25398 the following checks before accepting it as the authenticated sender of the
25399 message:
25400
25401 .ilist
25402 If the connection is not using extended SMTP (that is, HELO was used rather
25403 than EHLO), the use of AUTH= is a syntax error.
25404 .next
25405 If the value of the AUTH= parameter is &"<>"&, it is ignored.
25406 .next
25407 .vindex "&$authenticated_sender$&"
25408 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
25409 running, the value of &$authenticated_sender$& is set to the value obtained
25410 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
25411 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
25412 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
25413 given for the MAIL command.
25414 .next
25415 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
25416 is accepted and placed in &$authenticated_sender$& only if the client has
25417 authenticated.
25418 .next
25419 If the AUTH= value was accepted by either of the two previous rules, and
25420 the client has authenticated, and the authenticator has a setting for the
25421 &%server_mail_auth_condition%&, the condition is checked at this point. The
25422 valued that was saved from the authenticator is expanded. If the expansion
25423 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
25424 &$authenticated_sender$& is deleted. If the expansion yields any other value,
25425 the value of &$authenticated_sender$& is retained and passed on with the
25426 message.
25427 .endlist
25428
25429
25430 When &$authenticated_sender$& is set for a message, it is passed on to other
25431 hosts to which Exim authenticates as a client. Do not confuse this value with
25432 &$authenticated_id$&, which is a string obtained from the authentication
25433 process, and which is not usually a complete email address.
25434
25435 .vindex "&$sender_address$&"
25436 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
25437 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
25438 therefore make use of &$authenticated_sender$&. The converse is not true: the
25439 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
25440 ACL is run.
25441
25442
25443
25444 .section "Authentication on an Exim server" "SECTauthexiser"
25445 .cindex "authentication" "on an Exim server"
25446 When Exim receives an EHLO command, it advertises the public names of those
25447 authenticators that are configured as servers, subject to the following
25448 conditions:
25449
25450 .ilist
25451 The client host must match &%auth_advertise_hosts%& (default *).
25452 .next
25453 It the &%server_advertise_condition%& option is set, its expansion must not
25454 yield the empty string, &"0"&, &"no"&, or &"false"&.
25455 .endlist
25456
25457 The order in which the authenticators are defined controls the order in which
25458 the mechanisms are advertised.
25459
25460 Some mail clients (for example, some versions of Netscape) require the user to
25461 provide a name and password for authentication whenever AUTH is advertised,
25462 even though authentication may not in fact be needed (for example, Exim may be
25463 set up to allow unconditional relaying from the client by an IP address check).
25464 You can make such clients more friendly by not advertising AUTH to them.
25465 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
25466 that runs for RCPT) to relay without authentication, you should set
25467 .code
25468 auth_advertise_hosts = ! 10.9.8.0/24
25469 .endd
25470 so that no authentication mechanisms are advertised to them.
25471
25472 The &%server_advertise_condition%& controls the advertisement of individual
25473 authentication mechanisms. For example, it can be used to restrict the
25474 advertisement of a particular mechanism to encrypted connections, by a setting
25475 such as:
25476 .code
25477 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
25478 .endd
25479 .vindex "&$tls_in_cipher$&"
25480 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
25481 yields &"yes"&, which allows the advertisement to happen.
25482
25483 When an Exim server receives an AUTH command from a client, it rejects it
25484 immediately if AUTH was not advertised in response to an earlier EHLO
25485 command. This is the case if
25486
25487 .ilist
25488 The client host does not match &%auth_advertise_hosts%&; or
25489 .next
25490 No authenticators are configured with server options; or
25491 .next
25492 Expansion of &%server_advertise_condition%& blocked the advertising of all the
25493 server authenticators.
25494 .endlist
25495
25496
25497 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
25498 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
25499 AUTH is accepted from any client host.
25500
25501 If AUTH is not rejected by the ACL, Exim searches its configuration for a
25502 server authentication mechanism that was advertised in response to EHLO and
25503 that matches the one named in the AUTH command. If it finds one, it runs
25504 the appropriate authentication protocol, and authentication either succeeds or
25505 fails. If there is no matching advertised mechanism, the AUTH command is
25506 rejected with a 504 error.
25507
25508 .vindex "&$received_protocol$&"
25509 .vindex "&$sender_host_authenticated$&"
25510 When a message is received from an authenticated host, the value of
25511 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
25512 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
25513 public name) of the authenticator driver that successfully authenticated the
25514 client from which the message was received. This variable is empty if there was
25515 no successful authentication.
25516
25517
25518
25519
25520 .section "Testing server authentication" "SECID169"
25521 .cindex "authentication" "testing a server"
25522 .cindex "AUTH" "testing a server"
25523 .cindex "base64 encoding" "creating authentication test data"
25524 Exim's &%-bh%& option can be useful for testing server authentication
25525 configurations. The data for the AUTH command has to be sent using base64
25526 encoding. A quick way to produce such data for testing is the following Perl
25527 script:
25528 .code
25529 use MIME::Base64;
25530 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
25531 .endd
25532 .cindex "binary zero" "in authentication data"
25533 This interprets its argument as a Perl string, and then encodes it. The
25534 interpretation as a Perl string allows binary zeros, which are required for
25535 some kinds of authentication, to be included in the data. For example, a
25536 command line to run this script on such data might be
25537 .code
25538 encode '\0user\0password'
25539 .endd
25540 Note the use of single quotes to prevent the shell interpreting the
25541 backslashes, so that they can be interpreted by Perl to specify characters
25542 whose code value is zero.
25543
25544 &*Warning 1*&: If either of the user or password strings starts with an octal
25545 digit, you must use three zeros instead of one after the leading backslash. If
25546 you do not, the octal digit that starts your string will be incorrectly
25547 interpreted as part of the code for the first character.
25548
25549 &*Warning 2*&: If there are characters in the strings that Perl interprets
25550 specially, you must use a Perl escape to prevent them being misinterpreted. For
25551 example, a command such as
25552 .code
25553 encode '\0user@domain.com\0pas$$word'
25554 .endd
25555 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
25556
25557 If you have the &%mimencode%& command installed, another way to do produce
25558 base64-encoded strings is to run the command
25559 .code
25560 echo -e -n `\0user\0password' | mimencode
25561 .endd
25562 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
25563 in the argument, and the &%-n%& option specifies no newline at the end of its
25564 output. However, not all versions of &%echo%& recognize these options, so you
25565 should check your version before relying on this suggestion.
25566
25567
25568
25569 .section "Authentication by an Exim client" "SECID170"
25570 .cindex "authentication" "on an Exim client"
25571 The &(smtp)& transport has two options called &%hosts_require_auth%& and
25572 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
25573 announces support for authentication, and the host matches an entry in either
25574 of these options, Exim (as a client) tries to authenticate as follows:
25575
25576 .ilist
25577 For each authenticator that is configured as a client, in the order in which
25578 they are defined in the configuration, it searches the authentication
25579 mechanisms announced by the server for one whose name matches the public name
25580 of the authenticator.
25581 .next
25582 .vindex "&$host$&"
25583 .vindex "&$host_address$&"
25584 When it finds one that matches, it runs the authenticator's client code. The
25585 variables &$host$& and &$host_address$& are available for any string expansions
25586 that the client might do. They are set to the server's name and IP address. If
25587 any expansion is forced to fail, the authentication attempt is abandoned, and
25588 Exim moves on to the next authenticator. Otherwise an expansion failure causes
25589 delivery to be deferred.
25590 .next
25591 If the result of the authentication attempt is a temporary error or a timeout,
25592 Exim abandons trying to send the message to the host for the moment. It will
25593 try again later. If there are any backup hosts available, they are tried in the
25594 usual way.
25595 .next
25596 If the response to authentication is a permanent error (5&'xx'& code), Exim
25597 carries on searching the list of authenticators and tries another one if
25598 possible. If all authentication attempts give permanent errors, or if there are
25599 no attempts because no mechanisms match (or option expansions force failure),
25600 what happens depends on whether the host matches &%hosts_require_auth%& or
25601 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
25602 delivery is deferred. The error can be detected in the retry rules, and thereby
25603 turned into a permanent error if you wish. In the second case, Exim tries to
25604 deliver the message unauthenticated.
25605 .endlist
25606
25607 .cindex "AUTH" "on MAIL command"
25608 When Exim has authenticated itself to a remote server, it adds the AUTH
25609 parameter to the MAIL commands it sends, if it has an authenticated sender for
25610 the message. If the message came from a remote host, the authenticated sender
25611 is the one that was receiving on an incoming MAIL command, provided that the
25612 incoming connection was authenticated and the &%server_mail_auth%& condition
25613 allowed the authenticated sender to be retained. If a local process calls Exim
25614 to send a message, the sender address that is built from the login name and
25615 &%qualify_domain%& is treated as authenticated. However, if the
25616 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
25617 the authenticated sender that was received with the message.
25618 .ecindex IIDauthconf1
25619 .ecindex IIDauthconf2
25620
25621
25622
25623
25624
25625
25626 . ////////////////////////////////////////////////////////////////////////////
25627 . ////////////////////////////////////////////////////////////////////////////
25628
25629 .chapter "The plaintext authenticator" "CHAPplaintext"
25630 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
25631 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
25632 The &(plaintext)& authenticator can be configured to support the PLAIN and
25633 LOGIN authentication mechanisms, both of which transfer authentication data as
25634 plain (unencrypted) text (though base64 encoded). The use of plain text is a
25635 security risk; you are strongly advised to insist on the use of SMTP encryption
25636 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
25637 use unencrypted plain text, you should not use the same passwords for SMTP
25638 connections as you do for login accounts.
25639
25640 .section "Plaintext options" "SECID171"
25641 .cindex "options" "&(plaintext)& authenticator (server)"
25642 When configured as a server, &(plaintext)& uses the following options:
25643
25644 .option server_condition authenticators string&!! unset
25645 This is actually a global authentication option, but it must be set in order to
25646 configure the &(plaintext)& driver as a server. Its use is described below.
25647
25648 .option server_prompts plaintext string&!! unset
25649 The contents of this option, after expansion, must be a colon-separated list of
25650 prompt strings. If expansion fails, a temporary authentication rejection is
25651 given.
25652
25653 .section "Using plaintext in a server" "SECTplainserver"
25654 .cindex "AUTH" "in &(plaintext)& authenticator"
25655 .cindex "binary zero" "in &(plaintext)& authenticator"
25656 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
25657         "in &(plaintext)& authenticator"
25658 .vindex "&$auth1$&, &$auth2$&, etc"
25659 .cindex "base64 encoding" "in &(plaintext)& authenticator"
25660
25661 When running as a server, &(plaintext)& performs the authentication test by
25662 expanding a string. The data sent by the client with the AUTH command, or in
25663 response to subsequent prompts, is base64 encoded, and so may contain any byte
25664 values when decoded. If any data is supplied with the command, it is treated as
25665 a list of strings, separated by NULs (binary zeros), the first three of which
25666 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
25667 (neither LOGIN nor PLAIN uses more than three strings).
25668
25669 For compatibility with previous releases of Exim, the values are also placed in
25670 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
25671 variables for this purpose is now deprecated, as it can lead to confusion in
25672 string expansions that also use them for other things.
25673
25674 If there are more strings in &%server_prompts%& than the number of strings
25675 supplied with the AUTH command, the remaining prompts are used to obtain more
25676 data. Each response from the client may be a list of NUL-separated strings.
25677
25678 .vindex "&$authenticated_id$&"
25679 Once a sufficient number of data strings have been received,
25680 &%server_condition%& is expanded. If the expansion is forced to fail,
25681 authentication fails. Any other expansion failure causes a temporary error code
25682 to be returned. If the result of a successful expansion is an empty string,
25683 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
25684 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
25685 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
25686 For any other result, a temporary error code is returned, with the expanded
25687 string as the error text
25688
25689 &*Warning*&: If you use a lookup in the expansion to find the user's
25690 password, be sure to make the authentication fail if the user is unknown.
25691 There are good and bad examples at the end of the next section.
25692
25693
25694
25695 .section "The PLAIN authentication mechanism" "SECID172"
25696 .cindex "PLAIN authentication mechanism"
25697 .cindex "authentication" "PLAIN mechanism"
25698 .cindex "binary zero" "in &(plaintext)& authenticator"
25699 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
25700 sent as one item of data (that is, one combined string containing two NUL
25701 separators). The data is sent either as part of the AUTH command, or
25702 subsequently in response to an empty prompt from the server.
25703
25704 The second and third strings are a user name and a corresponding password.
25705 Using a single fixed user name and password as an example, this could be
25706 configured as follows:
25707 .code
25708 fixed_plain:
25709   driver = plaintext
25710   public_name = PLAIN
25711   server_prompts = :
25712   server_condition = \
25713     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
25714   server_set_id = $auth2
25715 .endd
25716 Note that the default result strings from &%if%& (&"true"& or an empty string)
25717 are exactly what we want here, so they need not be specified. Obviously, if the
25718 password contains expansion-significant characters such as dollar, backslash,
25719 or closing brace, they have to be escaped.
25720
25721 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
25722 the end of a string list are ignored). If all the data comes as part of the
25723 AUTH command, as is commonly the case, the prompt is not used. This
25724 authenticator is advertised in the response to EHLO as
25725 .code
25726 250-AUTH PLAIN
25727 .endd
25728 and a client host can authenticate itself by sending the command
25729 .code
25730 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
25731 .endd
25732 As this contains three strings (more than the number of prompts), no further
25733 data is required from the client. Alternatively, the client may just send
25734 .code
25735 AUTH PLAIN
25736 .endd
25737 to initiate authentication, in which case the server replies with an empty
25738 prompt. The client must respond with the combined data string.
25739
25740 The data string is base64 encoded, as required by the RFC. This example,
25741 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
25742 represents a zero byte. This is split up into three strings, the first of which
25743 is empty. The &%server_condition%& option in the authenticator checks that the
25744 second two are &`username`& and &`mysecret`& respectively.
25745
25746 Having just one fixed user name and password, as in this example, is not very
25747 realistic, though for a small organization with only a handful of
25748 authenticating clients it could make sense.
25749
25750 A more sophisticated instance of this authenticator could use the user name in
25751 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
25752 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
25753 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
25754 This is an incorrect example:
25755 .code
25756 server_condition = \
25757   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
25758 .endd
25759 The expansion uses the user name (&$auth2$&) as the key to look up a password,
25760 which it then compares to the supplied password (&$auth3$&). Why is this example
25761 incorrect? It works fine for existing users, but consider what happens if a
25762 non-existent user name is given. The lookup fails, but as no success/failure
25763 strings are given for the lookup, it yields an empty string. Thus, to defeat
25764 the authentication, all a client has to do is to supply a non-existent user
25765 name and an empty password. The correct way of writing this test is:
25766 .code
25767 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
25768   {${if eq{$value}{$auth3}}} {false}}
25769 .endd
25770 In this case, if the lookup succeeds, the result is checked; if the lookup
25771 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
25772 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
25773 always fails if its second argument is empty. However, the second way of
25774 writing the test makes the logic clearer.
25775
25776
25777 .section "The LOGIN authentication mechanism" "SECID173"
25778 .cindex "LOGIN authentication mechanism"
25779 .cindex "authentication" "LOGIN mechanism"
25780 The LOGIN authentication mechanism is not documented in any RFC, but is in use
25781 in a number of programs. No data is sent with the AUTH command. Instead, a
25782 user name and password are supplied separately, in response to prompts. The
25783 plaintext authenticator can be configured to support this as in this example:
25784 .code
25785 fixed_login:
25786   driver = plaintext
25787   public_name = LOGIN
25788   server_prompts = User Name : Password
25789   server_condition = \
25790     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
25791   server_set_id = $auth1
25792 .endd
25793 Because of the way plaintext operates, this authenticator accepts data supplied
25794 with the AUTH command (in contravention of the specification of LOGIN), but
25795 if the client does not supply it (as is the case for LOGIN clients), the prompt
25796 strings are used to obtain two data items.
25797
25798 Some clients are very particular about the precise text of the prompts. For
25799 example, Outlook Express is reported to recognize only &"Username:"& and
25800 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
25801 strings. It uses the &%ldapauth%& expansion condition to check the user
25802 name and password by binding to an LDAP server:
25803 .code
25804 login:
25805   driver = plaintext
25806   public_name = LOGIN
25807   server_prompts = Username:: : Password::
25808   server_condition = ${if and{{ \
25809     !eq{}{$auth1} }{ \
25810     ldapauth{\
25811       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
25812       pass=${quote:$auth2} \
25813       ldap://ldap.example.org/} }} }
25814   server_set_id = uid=$auth1,ou=people,o=example.org
25815 .endd
25816 We have to check that the username is not empty before using it, because LDAP
25817 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
25818 operator to correctly quote the DN for authentication. However, the basic
25819 &%quote%& operator, rather than any of the LDAP quoting operators, is the
25820 correct one to use for the password, because quoting is needed only to make
25821 the password conform to the Exim syntax. At the LDAP level, the password is an
25822 uninterpreted string.
25823
25824
25825 .section "Support for different kinds of authentication" "SECID174"
25826 A number of string expansion features are provided for the purpose of
25827 interfacing to different ways of user authentication. These include checking
25828 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
25829 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
25830 &<<SECTexpcond>>&.
25831
25832
25833
25834
25835 .section "Using plaintext in a client" "SECID175"
25836 .cindex "options" "&(plaintext)& authenticator (client)"
25837 The &(plaintext)& authenticator has two client options:
25838
25839 .option client_ignore_invalid_base64 plaintext boolean false
25840 If the client receives a server prompt that is not a valid base64 string,
25841 authentication is abandoned by default. However, if this option is set true,
25842 the error in the challenge is ignored and the client sends the response as
25843 usual.
25844
25845 .option client_send plaintext string&!! unset
25846 The string is a colon-separated list of authentication data strings. Each
25847 string is independently expanded before being sent to the server. The first
25848 string is sent with the AUTH command; any more strings are sent in response
25849 to prompts from the server. Before each string is expanded, the value of the
25850 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
25851 with &$auth1$& for the first prompt. Up to three prompts are stored in this
25852 way. Thus, the prompt that is received in response to sending the first string
25853 (with the AUTH command) can be used in the expansion of the second string, and
25854 so on. If an invalid base64 string is received when
25855 &%client_ignore_invalid_base64%& is set, an empty string is put in the
25856 &$auth$&<&'n'&> variable.
25857
25858 &*Note*&: You cannot use expansion to create multiple strings, because
25859 splitting takes priority and happens first.
25860
25861 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
25862 the data, further processing is applied to each string before it is sent. If
25863 there are any single circumflex characters in the string, they are converted to
25864 NULs. Should an actual circumflex be required as data, it must be doubled in
25865 the string.
25866
25867 This is an example of a client configuration that implements the PLAIN
25868 authentication mechanism with a fixed user name and password:
25869 .code
25870 fixed_plain:
25871   driver = plaintext
25872   public_name = PLAIN
25873   client_send = ^username^mysecret
25874 .endd
25875 The lack of colons means that the entire text is sent with the AUTH
25876 command, with the circumflex characters converted to NULs. A similar example
25877 that uses the LOGIN mechanism is:
25878 .code
25879 fixed_login:
25880   driver = plaintext
25881   public_name = LOGIN
25882   client_send = : username : mysecret
25883 .endd
25884 The initial colon means that the first string is empty, so no data is sent with
25885 the AUTH command itself. The remaining strings are sent in response to
25886 prompts.
25887 .ecindex IIDplaiauth1
25888 .ecindex IIDplaiauth2
25889
25890
25891
25892
25893 . ////////////////////////////////////////////////////////////////////////////
25894 . ////////////////////////////////////////////////////////////////////////////
25895
25896 .chapter "The cram_md5 authenticator" "CHID9"
25897 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
25898 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
25899 .cindex "CRAM-MD5 authentication mechanism"
25900 .cindex "authentication" "CRAM-MD5 mechanism"
25901 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
25902 sends a challenge string to the client, and the response consists of a user
25903 name and the CRAM-MD5 digest of the challenge string combined with a secret
25904 string (password) which is known to both server and client. Thus, the secret
25905 is not sent over the network as plain text, which makes this authenticator more
25906 secure than &(plaintext)&. However, the downside is that the secret has to be
25907 available in plain text at either end.
25908
25909
25910 .section "Using cram_md5 as a server" "SECID176"
25911 .cindex "options" "&(cram_md5)& authenticator (server)"
25912 This authenticator has one server option, which must be set to configure the
25913 authenticator as a server:
25914
25915 .option server_secret cram_md5 string&!! unset
25916 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
25917 When the server receives the client's response, the user name is placed in
25918 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
25919 obtain the password for that user. The server then computes the CRAM-MD5 digest
25920 that the client should have sent, and checks that it received the correct
25921 string. If the expansion of &%server_secret%& is forced to fail, authentication
25922 fails. If the expansion fails for some other reason, a temporary error code is
25923 returned to the client.
25924
25925 For compatibility with previous releases of Exim, the user name is also placed
25926 in &$1$&. However, the use of this variables for this purpose is now
25927 deprecated, as it can lead to confusion in string expansions that also use
25928 numeric variables for other things.
25929
25930 For example, the following authenticator checks that the user name given by the
25931 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
25932 user name, authentication fails.
25933 .code
25934 fixed_cram:
25935   driver = cram_md5
25936   public_name = CRAM-MD5
25937   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
25938   server_set_id = $auth1
25939 .endd
25940 .vindex "&$authenticated_id$&"
25941 If authentication succeeds, the setting of &%server_set_id%& preserves the user
25942 name in &$authenticated_id$&. A more typical configuration might look up the
25943 secret string in a file, using the user name as the key. For example:
25944 .code
25945 lookup_cram:
25946   driver = cram_md5
25947   public_name = CRAM-MD5
25948   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
25949                   {$value}fail}
25950   server_set_id = $auth1
25951 .endd
25952 Note that this expansion explicitly forces failure if the lookup fails
25953 because &$auth1$& contains an unknown user name.
25954
25955 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
25956 using the relevant libraries, you need to know the realm to specify in the
25957 lookup and then ask for the &"userPassword"& attribute for that user in that
25958 realm, with:
25959 .code
25960 cyrusless_crammd5:
25961   driver = cram_md5
25962   public_name = CRAM-MD5
25963   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
25964                   dbmjz{/etc/sasldb2}{$value}fail}
25965   server_set_id = $auth1
25966 .endd
25967
25968 .section "Using cram_md5 as a client" "SECID177"
25969 .cindex "options" "&(cram_md5)& authenticator (client)"
25970 When used as a client, the &(cram_md5)& authenticator has two options:
25971
25972
25973
25974 .option client_name cram_md5 string&!! "the primary host name"
25975 This string is expanded, and the result used as the user name data when
25976 computing the response to the server's challenge.
25977
25978
25979 .option client_secret cram_md5 string&!! unset
25980 This option must be set for the authenticator to work as a client. Its value is
25981 expanded and the result used as the secret string when computing the response.
25982
25983
25984 .vindex "&$host$&"
25985 .vindex "&$host_address$&"
25986 Different user names and secrets can be used for different servers by referring
25987 to &$host$& or &$host_address$& in the options. Forced failure of either
25988 expansion string is treated as an indication that this authenticator is not
25989 prepared to handle this case. Exim moves on to the next configured client
25990 authenticator. Any other expansion failure causes Exim to give up trying to
25991 send the message to the current server.
25992
25993 A simple example configuration of a &(cram_md5)& authenticator, using fixed
25994 strings, is:
25995 .code
25996 fixed_cram:
25997   driver = cram_md5
25998   public_name = CRAM-MD5
25999   client_name = ph10
26000   client_secret = secret
26001 .endd
26002 .ecindex IIDcramauth1
26003 .ecindex IIDcramauth2
26004
26005
26006
26007 . ////////////////////////////////////////////////////////////////////////////
26008 . ////////////////////////////////////////////////////////////////////////////
26009
26010 .chapter "The cyrus_sasl authenticator" "CHID10"
26011 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
26012 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
26013 .cindex "Cyrus" "SASL library"
26014 .cindex "Kerberos"
26015 The code for this authenticator was provided by Matthew Byng-Maddick of A L
26016 Digital Ltd (&url(http://www.aldigital.co.uk)).
26017
26018 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
26019 library implementation of the RFC 2222 (&"Simple Authentication and Security
26020 Layer"&). This library supports a number of authentication mechanisms,
26021 including PLAIN and LOGIN, but also several others that Exim does not support
26022 directly. In particular, there is support for Kerberos authentication.
26023
26024 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
26025 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
26026 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
26027 name of the driver to determine which mechanism to support.
26028
26029 Where access to some kind of secret file is required, for example in GSSAPI
26030 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
26031 user, and that the Cyrus SASL library has no way of escalating privileges
26032 by default. You may also find you need to set environment variables,
26033 depending on the driver you are using.
26034
26035 The application name provided by Exim is &"exim"&, so various SASL options may
26036 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
26037 Kerberos, note that because of limitations in the GSSAPI interface,
26038 changing the server keytab might need to be communicated down to the Kerberos
26039 layer independently. The mechanism for doing so is dependent upon the Kerberos
26040 implementation.
26041
26042 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
26043 may be set to point to an alternative keytab file. Exim will pass this
26044 variable through from its own inherited environment when started as root or the
26045 Exim user. The keytab file needs to be readable by the Exim user.
26046 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
26047 environment variable.  In practice, for those releases, the Cyrus authenticator
26048 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
26049 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
26050
26051
26052 .section "Using cyrus_sasl as a server" "SECID178"
26053 The &(cyrus_sasl)& authenticator has four private options. It puts the username
26054 (on a successful authentication) into &$auth1$&. For compatibility with
26055 previous releases of Exim, the username is also placed in &$1$&. However, the
26056 use of this variable for this purpose is now deprecated, as it can lead to
26057 confusion in string expansions that also use numeric variables for other
26058 things.
26059
26060
26061 .option server_hostname cyrus_sasl string&!! "see below"
26062 This option selects the hostname that is used when communicating with the
26063 library. The default value is &`$primary_hostname`&. It is up to the underlying
26064 SASL plug-in what it does with this data.
26065
26066
26067 .option server_mech cyrus_sasl string "see below"
26068 This option selects the authentication mechanism this driver should use. The
26069 default is the value of the generic &%public_name%& option. This option allows
26070 you to use a different underlying mechanism from the advertised name. For
26071 example:
26072 .code
26073 sasl:
26074   driver = cyrus_sasl
26075   public_name = X-ANYTHING
26076   server_mech = CRAM-MD5
26077   server_set_id = $auth1
26078 .endd
26079
26080 .option server_realm cyrus_sasl string&!! unset
26081 This specifies the SASL realm that the server claims to be in.
26082
26083
26084 .option server_service cyrus_sasl string &`smtp`&
26085 This is the SASL service that the server claims to implement.
26086
26087
26088 For straightforward cases, you do not need to set any of the authenticator's
26089 private options. All you need to do is to specify an appropriate mechanism as
26090 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
26091 PLAIN, you could have two authenticators as follows:
26092 .code
26093 sasl_cram_md5:
26094   driver = cyrus_sasl
26095   public_name = CRAM-MD5
26096   server_set_id = $auth1
26097
26098 sasl_plain:
26099   driver = cyrus_sasl
26100   public_name = PLAIN
26101   server_set_id = $auth2
26102 .endd
26103 Cyrus SASL does implement the LOGIN authentication method, even though it is
26104 not a standard method. It is disabled by default in the source distribution,
26105 but it is present in many binary distributions.
26106 .ecindex IIDcyrauth1
26107 .ecindex IIDcyrauth2
26108
26109
26110
26111
26112 . ////////////////////////////////////////////////////////////////////////////
26113 . ////////////////////////////////////////////////////////////////////////////
26114 .chapter "The dovecot authenticator" "CHAPdovecot"
26115 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
26116 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
26117 This authenticator is an interface to the authentication facility of the
26118 Dovecot POP/IMAP server, which can support a number of authentication methods.
26119 Note that Dovecot must be configured to use auth-client not auth-userdb.
26120 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
26121 to use the same mechanisms for SMTP authentication. This is a server
26122 authenticator only. There is only one option:
26123
26124 .option server_socket dovecot string unset
26125
26126 This option must specify the socket that is the interface to Dovecot
26127 authentication. The &%public_name%& option must specify an authentication
26128 mechanism that Dovecot is configured to support. You can have several
26129 authenticators for different mechanisms. For example:
26130 .code
26131 dovecot_plain:
26132   driver = dovecot
26133   public_name = PLAIN
26134   server_socket = /var/run/dovecot/auth-client
26135   server_set_id = $auth1
26136
26137 dovecot_ntlm:
26138   driver = dovecot
26139   public_name = NTLM
26140   server_socket = /var/run/dovecot/auth-client
26141   server_set_id = $auth1
26142 .endd
26143 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
26144 &$received_ip_address$& (that is, the connection is local), the &"secured"&
26145 option is passed in the Dovecot authentication command. If, for a TLS
26146 connection, a client certificate has been verified, the &"valid-client-cert"&
26147 option is passed. When authentication succeeds, the identity of the user
26148 who authenticated is placed in &$auth1$&.
26149 .ecindex IIDdcotauth1
26150 .ecindex IIDdcotauth2
26151
26152
26153 . ////////////////////////////////////////////////////////////////////////////
26154 . ////////////////////////////////////////////////////////////////////////////
26155 .chapter "The gsasl authenticator" "CHAPgsasl"
26156 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
26157 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
26158 .cindex "authentication" "GNU SASL"
26159 .cindex "authentication" "SASL"
26160 .cindex "authentication" "EXTERNAL"
26161 .cindex "authentication" "ANONYMOUS"
26162 .cindex "authentication" "PLAIN"
26163 .cindex "authentication" "LOGIN"
26164 .cindex "authentication" "DIGEST-MD5"
26165 .cindex "authentication" "CRAM-MD5"
26166 .cindex "authentication" "SCRAM-SHA-1"
26167 The &(gsasl)& authenticator provides server integration for the GNU SASL
26168 library and the mechanisms it provides.  This is new as of the 4.80 release
26169 and there are a few areas where the library does not let Exim smoothly
26170 scale to handle future authentication mechanisms, so no guarantee can be
26171 made that any particular new authentication mechanism will be supported
26172 without code changes in Exim.
26173
26174
26175 .option server_channelbinding gsasl boolean false
26176 Some authentication mechanisms are able to use external context at both ends
26177 of the session to bind the authentication to that context, and fail the
26178 authentication process if that context differs.  Specifically, some TLS
26179 ciphersuites can provide identifying information about the cryptographic
26180 context.
26181
26182 This means that certificate identity and verification becomes a non-issue,
26183 as a man-in-the-middle attack will cause the correct client and server to
26184 see different identifiers and authentication will fail.
26185
26186 This is currently only supported when using the GnuTLS library.  This is
26187 only usable by mechanisms which support "channel binding"; at time of
26188 writing, that's the SCRAM family.
26189
26190 This defaults off to ensure smooth upgrade across Exim releases, in case
26191 this option causes some clients to start failing.  Some future release
26192 of Exim may switch the default to be true.
26193
26194
26195 .option server_hostname gsasl string&!! "see below"
26196 This option selects the hostname that is used when communicating with the
26197 library. The default value is &`$primary_hostname`&.
26198 Some mechanisms will use this data.
26199
26200
26201 .option server_mech gsasl string "see below"
26202 This option selects the authentication mechanism this driver should use. The
26203 default is the value of the generic &%public_name%& option. This option allows
26204 you to use a different underlying mechanism from the advertised name. For
26205 example:
26206 .code
26207 sasl:
26208   driver = gsasl
26209   public_name = X-ANYTHING
26210   server_mech = CRAM-MD5
26211   server_set_id = $auth1
26212 .endd
26213
26214
26215 .option server_password gsasl string&!! unset
26216 Various mechanisms need access to the cleartext password on the server, so
26217 that proof-of-possession can be demonstrated on the wire, without sending
26218 the password itself.
26219
26220 The data available for lookup varies per mechanism.
26221 In all cases, &$auth1$& is set to the &'authentication id'&.
26222 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
26223 if available, else the empty string.
26224 The &$auth3$& variable will always be the &'realm'& if available,
26225 else the empty string.
26226
26227 A forced failure will cause authentication to defer.
26228
26229 If using this option, it may make sense to set the &%server_condition%&
26230 option to be simply "true".
26231
26232
26233 .option server_realm gsasl string&!! unset
26234 This specifies the SASL realm that the server claims to be in.
26235 Some mechanisms will use this data.
26236
26237
26238 .option server_scram_iter gsasl string&!! unset
26239 This option provides data for the SCRAM family of mechanisms.
26240 &$auth1$& is not available at evaluation time.
26241 (This may change, as we receive feedback on use)
26242
26243
26244 .option server_scram_salt gsasl string&!! unset
26245 This option provides data for the SCRAM family of mechanisms.
26246 &$auth1$& is not available at evaluation time.
26247 (This may change, as we receive feedback on use)
26248
26249
26250 .option server_service gsasl string &`smtp`&
26251 This is the SASL service that the server claims to implement.
26252 Some mechanisms will use this data.
26253
26254
26255 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
26256 .vindex "&$auth1$&, &$auth2$&, etc"
26257 These may be set when evaluating specific options, as detailed above.
26258 They will also be set when evaluating &%server_condition%&.
26259
26260 Unless otherwise stated below, the &(gsasl)& integration will use the following
26261 meanings for these variables:
26262
26263 .ilist
26264 .vindex "&$auth1$&"
26265 &$auth1$&: the &'authentication id'&
26266 .next
26267 .vindex "&$auth2$&"
26268 &$auth2$&: the &'authorization id'&
26269 .next
26270 .vindex "&$auth3$&"
26271 &$auth3$&: the &'realm'&
26272 .endlist
26273
26274 On a per-mechanism basis:
26275
26276 .ilist
26277 .cindex "authentication" "EXTERNAL"
26278 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
26279 the &%server_condition%& option must be present.
26280 .next
26281 .cindex "authentication" "ANONYMOUS"
26282 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
26283 the &%server_condition%& option must be present.
26284 .next
26285 .cindex "authentication" "GSSAPI"
26286 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
26287 &$auth2$& will be set to the &'authorization id'&,
26288 the &%server_condition%& option must be present.
26289 .endlist
26290
26291 An &'anonymous token'& is something passed along as an unauthenticated
26292 identifier; this is analogous to FTP anonymous authentication passing an
26293 email address, or software-identifier@, as the "password".
26294
26295
26296 An example showing the password having the realm specified in the callback
26297 and demonstrating a Cyrus SASL to GSASL migration approach is:
26298 .code
26299 gsasl_cyrusless_crammd5:
26300   driver = gsasl
26301   public_name = CRAM-MD5
26302   server_realm = imap.example.org
26303   server_password = ${lookup{$auth1:$auth3:userPassword}\
26304                     dbmjz{/etc/sasldb2}{$value}fail}
26305   server_set_id = ${quote:$auth1}
26306   server_condition = yes
26307 .endd
26308
26309
26310 . ////////////////////////////////////////////////////////////////////////////
26311 . ////////////////////////////////////////////////////////////////////////////
26312
26313 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
26314 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
26315 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
26316 .cindex "authentication" "GSSAPI"
26317 .cindex "authentication" "Kerberos"
26318 The &(heimdal_gssapi)& authenticator provides server integration for the
26319 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
26320 reliably.
26321
26322 .option server_hostname heimdal_gssapi string&!! "see below"
26323 This option selects the hostname that is used, with &%server_service%&,
26324 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
26325 identifier.  The default value is &`$primary_hostname`&.
26326
26327 .option server_keytab heimdal_gssapi string&!! unset
26328 If set, then Heimdal will not use the system default keytab (typically
26329 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
26330 The value should be a pathname, with no &"file:"& prefix.
26331
26332 .option server_service heimdal_gssapi string&!! "smtp"
26333 This option specifies the service identifier used, in conjunction with
26334 &%server_hostname%&, for building the identifier for finding credentials
26335 from the keytab.
26336
26337
26338 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
26339 Beware that these variables will typically include a realm, thus will appear
26340 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
26341 not verified, so a malicious client can set it to anything.
26342
26343 The &$auth1$& field should be safely trustable as a value from the Key
26344 Distribution Center.  Note that these are not quite email addresses.
26345 Each identifier is for a role, and so the left-hand-side may include a
26346 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
26347
26348 .vindex "&$auth1$&, &$auth2$&, etc"
26349 .ilist
26350 .vindex "&$auth1$&"
26351 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
26352 .next
26353 .vindex "&$auth2$&"
26354 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
26355 authentication.  If that was empty, this will also be set to the
26356 GSS Display Name.
26357 .endlist
26358
26359
26360 . ////////////////////////////////////////////////////////////////////////////
26361 . ////////////////////////////////////////////////////////////////////////////
26362
26363 .chapter "The spa authenticator" "CHAPspa"
26364 .scindex IIDspaauth1 "&(spa)& authenticator"
26365 .scindex IIDspaauth2 "authenticators" "&(spa)&"
26366 .cindex "authentication" "Microsoft Secure Password"
26367 .cindex "authentication" "NTLM"
26368 .cindex "Microsoft Secure Password Authentication"
26369 .cindex "NTLM authentication"
26370 The &(spa)& authenticator provides client support for Microsoft's &'Secure
26371 Password Authentication'& mechanism,
26372 which is also sometimes known as NTLM (NT LanMan). The code for client side of
26373 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
26374 taken from the Samba project (&url(http://www.samba.org)). The code for the
26375 server side was subsequently contributed by Tom Kistner. The mechanism works as
26376 follows:
26377
26378 .ilist
26379 After the AUTH command has been accepted, the client sends an SPA
26380 authentication request based on the user name and optional domain.
26381 .next
26382 The server sends back a challenge.
26383 .next
26384 The client builds a challenge response which makes use of the user's password
26385 and sends it to the server, which then accepts or rejects it.
26386 .endlist
26387
26388 Encryption is used to protect the password in transit.
26389
26390
26391
26392 .section "Using spa as a server" "SECID179"
26393 .cindex "options" "&(spa)& authenticator (server)"
26394 The &(spa)& authenticator has just one server option:
26395
26396 .option server_password spa string&!! unset
26397 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
26398 This option is expanded, and the result must be the cleartext password for the
26399 authenticating user, whose name is at this point in &$auth1$&. For
26400 compatibility with previous releases of Exim, the user name is also placed in
26401 &$1$&. However, the use of this variable for this purpose is now deprecated, as
26402 it can lead to confusion in string expansions that also use numeric variables
26403 for other things. For example:
26404 .code
26405 spa:
26406   driver = spa
26407   public_name = NTLM
26408   server_password = \
26409     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
26410 .endd
26411 If the expansion is forced to fail, authentication fails. Any other expansion
26412 failure causes a temporary error code to be returned.
26413
26414
26415
26416
26417
26418 .section "Using spa as a client" "SECID180"
26419 .cindex "options" "&(spa)& authenticator (client)"
26420 The &(spa)& authenticator has the following client options:
26421
26422
26423
26424 .option client_domain spa string&!! unset
26425 This option specifies an optional domain for the authentication.
26426
26427
26428 .option client_password spa string&!! unset
26429 This option specifies the user's password, and must be set.
26430
26431
26432 .option client_username spa string&!! unset
26433 This option specifies the user name, and must be set. Here is an example of a
26434 configuration of this authenticator for use with the mail servers at
26435 &'msn.com'&:
26436 .code
26437 msn:
26438   driver = spa
26439   public_name = MSN
26440   client_username = msn/msn_username
26441   client_password = msn_plaintext_password
26442   client_domain = DOMAIN_OR_UNSET
26443 .endd
26444 .ecindex IIDspaauth1
26445 .ecindex IIDspaauth2
26446
26447
26448
26449
26450
26451 . ////////////////////////////////////////////////////////////////////////////
26452 . ////////////////////////////////////////////////////////////////////////////
26453
26454 .chapter "The tls authenticator" "CHAPtlsauth"
26455 .scindex IIDtlsauth1 "&(tls)& authenticator"
26456 .scindex IIDtlsauth2 "authenticators" "&(tls)&"
26457 .cindex "authentication" "Client Certificate"
26458 .cindex "authentication" "X509"
26459 .cindex "Certificate-based authentication"
26460 The &(tls)& authenticator provides server support for
26461 authentication based on client certificates.
26462
26463 It is not an SMTP authentication mechanism and is not
26464 advertised by the server as part of the SMTP EHLO response.
26465 It is an Exim authenticator in the sense that it affects
26466 the protocol element of the log line, can be tested for
26467 by the &%authenticated%& ACL condition, and can set
26468 the &$authenticated_id$& variable.
26469
26470 The client must present a verifiable certificate,
26471 for which it must have been requested via the
26472 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
26473 (see &<<CHAPTLS>>&).
26474
26475 If an authenticator of this type is configured it is
26476 run before any SMTP-level communication is done,
26477 and can authenticate the connection.
26478 If it does, SMTP authentication is not offered.
26479
26480 A maximum of one authenticator of this type may be present.
26481
26482
26483 .cindex "options" "&(tls)& authenticator (server)"
26484 The &(tls)& authenticator has three server options:
26485
26486 .option server_param1 tls string&!! unset
26487 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(tls)& authenticator"
26488 This option is expanded after the TLS negotiation and
26489 the result is placed in &$auth1$&.
26490 If the expansion is forced to fail, authentication fails. Any other expansion
26491 failure causes a temporary error code to be returned.
26492
26493 .option server_param2 tls string&!! unset
26494 .option server_param3 tls string&!! unset
26495 As above, for &$auth2$& and &$auth3$&.
26496
26497 &%server_param1%& may also be spelled &%server_param%&.
26498
26499
26500 Example:
26501 .code
26502 tls:
26503   driver = tls
26504   server_param1 =     ${certextract {subj_altname,mail,>:} \
26505                                     {$tls_in_peercert}}
26506   server_condition =  ${if forany {$auth1} \
26507                             {!= {0} \
26508                                 {${lookup ldap{ldap:///\
26509                          mailname=${quote_ldap_dn:${lc:$item}},\
26510                          ou=users,LDAP_DC?mailid} {$value}{0} \
26511                        }    }   } }
26512   server_set_id =     ${if = {1}{${listcount:$auth1}} {$auth1}{}}
26513 .endd
26514 This accepts a client certificate that is verifiable against any
26515 of your configured trust-anchors
26516 which usually means the full set of public CAs)
26517 and which has a SAN with a good account name.
26518 Note that the client cert is on the wire in-clear, including the SAN,
26519 whereas a plaintext SMTP AUTH done inside TLS is not.
26520
26521 . An alternative might use
26522 . .code
26523 .   server_param1 = ${sha256:$tls_in_peercert}
26524 . .endd
26525 . to require one of a set of specific certs that define a given account
26526 . (the verification is still required, but mostly irrelevant).
26527 . This would help for per-device use.
26528
26529 . However, for the future we really need support for checking a
26530 . user cert in LDAP - which probably wants a base-64 DER.
26531
26532 .ecindex IIDtlsauth1
26533 .ecindex IIDtlsauth2
26534
26535
26536 Note that because authentication is traditionally an SMTP operation,
26537 the &%authenticated%& ACL condition cannot be used in
26538 a connect- or helo-ACL.
26539
26540
26541
26542 . ////////////////////////////////////////////////////////////////////////////
26543 . ////////////////////////////////////////////////////////////////////////////
26544
26545 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
26546          "Encrypted SMTP connections"
26547 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
26548 .scindex IIDencsmtp2 "SMTP" "encryption"
26549 .cindex "TLS" "on SMTP connection"
26550 .cindex "OpenSSL"
26551 .cindex "GnuTLS"
26552 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
26553 Sockets Layer), is implemented by making use of the OpenSSL library or the
26554 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
26555 cryptographic code in the Exim distribution itself for implementing TLS. In
26556 order to use this feature you must install OpenSSL or GnuTLS, and then build a
26557 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
26558 You also need to understand the basic concepts of encryption at a managerial
26559 level, and in particular, the way that public keys, private keys, and
26560 certificates are used.
26561
26562 RFC 3207 defines how SMTP connections can make use of encryption. Once a
26563 connection is established, the client issues a STARTTLS command. If the
26564 server accepts this, the client and the server negotiate an encryption
26565 mechanism. If the negotiation succeeds, the data that subsequently passes
26566 between them is encrypted.
26567
26568 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
26569 and if so, what cipher suite is in use, whether the client supplied a
26570 certificate, and whether or not that certificate was verified. This makes it
26571 possible for an Exim server to deny or accept certain commands based on the
26572 encryption state.
26573
26574 &*Warning*&: Certain types of firewall and certain anti-virus products can
26575 disrupt TLS connections. You need to turn off SMTP scanning for these products
26576 in order to get TLS to work.
26577
26578
26579
26580 .section "Support for the legacy &""ssmtp""& (aka &""smtps""&) protocol" &&&
26581          "SECID284"
26582 .cindex "ssmtp protocol"
26583 .cindex "smtps protocol"
26584 .cindex "SMTP" "ssmtp protocol"
26585 .cindex "SMTP" "smtps protocol"
26586 Early implementations of encrypted SMTP used a different TCP port from normal
26587 SMTP, and expected an encryption negotiation to start immediately, instead of
26588 waiting for a STARTTLS command from the client using the standard SMTP
26589 port. The protocol was called &"ssmtp"& or &"smtps"&, and port 465 was
26590 allocated for this purpose.
26591
26592 This approach was abandoned when encrypted SMTP was standardized, but there are
26593 still some legacy clients that use it. Exim supports these clients by means of
26594 the &%tls_on_connect_ports%& global option. Its value must be a list of port
26595 numbers; the most common use is expected to be:
26596 .code
26597 tls_on_connect_ports = 465
26598 .endd
26599 The port numbers specified by this option apply to all SMTP connections, both
26600 via the daemon and via &'inetd'&. You still need to specify all the ports that
26601 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
26602 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
26603 an extra port &-- rather, it specifies different behaviour on a port that is
26604 defined elsewhere.
26605
26606 There is also a &%-tls-on-connect%& command line option. This overrides
26607 &%tls_on_connect_ports%&; it forces the legacy behaviour for all ports.
26608
26609
26610
26611
26612
26613
26614 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
26615 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
26616 The first TLS support in Exim was implemented using OpenSSL. Support for GnuTLS
26617 followed later, when the first versions of GnuTLS were released. To build Exim
26618 to use GnuTLS, you need to set
26619 .code
26620 USE_GNUTLS=yes
26621 .endd
26622 in Local/Makefile, in addition to
26623 .code
26624 SUPPORT_TLS=yes
26625 .endd
26626 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
26627 include files and libraries for GnuTLS can be found.
26628
26629 There are some differences in usage when using GnuTLS instead of OpenSSL:
26630
26631 .ilist
26632 The &%tls_verify_certificates%& option
26633 cannot be the path of a directory
26634 for GnuTLS versions before 3.3.6
26635 (for later versions, or OpenSSL, it can be either).
26636 .next
26637 The default value for &%tls_dhparam%& differs for historical reasons.
26638 .next
26639 .vindex "&$tls_in_peerdn$&"
26640 .vindex "&$tls_out_peerdn$&"
26641 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
26642 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
26643 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
26644 .next
26645 OpenSSL identifies cipher suites using hyphens as separators, for example:
26646 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
26647 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
26648 in a cipher list. To make life simpler, Exim changes underscores to hyphens
26649 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
26650 to handle its own older variants) when processing lists of cipher suites in the
26651 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
26652 option).
26653 .next
26654 The &%tls_require_ciphers%& options operate differently, as described in the
26655 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
26656 .next
26657 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
26658 When using OpenSSL, this option is ignored.
26659 (If an API is found to let OpenSSL be configured in this way,
26660 let the Exim Maintainers know and we'll likely use it).
26661 .next
26662 Some other recently added features may only be available in one or the other.
26663 This should be documented with the feature.  If the documentation does not
26664 explicitly state that the feature is infeasible in the other TLS
26665 implementation, then patches are welcome.
26666 .endlist
26667
26668
26669 .section "GnuTLS parameter computation" "SECTgnutlsparam"
26670 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
26671 an explicit path; if the latter, then the text about generation still applies,
26672 but not the chosen filename.
26673 By default, as of Exim 4.80 a hard-coded D-H prime is used.
26674 See the documentation of &%tls_dhparam%& for more information.
26675
26676 GnuTLS uses D-H parameters that may take a substantial amount of time
26677 to compute. It is unreasonable to re-compute them for every TLS session.
26678 Therefore, Exim keeps this data in a file in its spool directory, called
26679 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
26680 of bits requested.
26681 The file is owned by the Exim user and is readable only by
26682 its owner. Every Exim process that start up GnuTLS reads the D-H
26683 parameters from this file. If the file does not exist, the first Exim process
26684 that needs it computes the data and writes it to a temporary file which is
26685 renamed once it is complete. It does not matter if several Exim processes do
26686 this simultaneously (apart from wasting a few resources). Once a file is in
26687 place, new Exim processes immediately start using it.
26688
26689 For maximum security, the parameters that are stored in this file should be
26690 recalculated periodically, the frequency depending on your paranoia level.
26691 If you are avoiding using the fixed D-H primes published in RFCs, then you
26692 are concerned about some advanced attacks and will wish to do this; if you do
26693 not regenerate then you might as well stick to the standard primes.
26694
26695 Arranging this is easy in principle; just delete the file when you want new
26696 values to be computed. However, there may be a problem. The calculation of new
26697 parameters needs random numbers, and these are obtained from &_/dev/random_&.
26698 If the system is not very active, &_/dev/random_& may delay returning data
26699 until enough randomness (entropy) is available. This may cause Exim to hang for
26700 a substantial amount of time, causing timeouts on incoming connections.
26701
26702 The solution is to generate the parameters externally to Exim. They are stored
26703 in &_gnutls-params-N_& in PEM format, which means that they can be
26704 generated externally using the &(certtool)& command that is part of GnuTLS.
26705
26706 To replace the parameters with new ones, instead of deleting the file
26707 and letting Exim re-create it, you can generate new parameters using
26708 &(certtool)& and, when this has been done, replace Exim's cache file by
26709 renaming. The relevant commands are something like this:
26710 .code
26711 # ls
26712 [ look for file; assume gnutls-params-2236 is the most recent ]
26713 # rm -f new-params
26714 # touch new-params
26715 # chown exim:exim new-params
26716 # chmod 0600 new-params
26717 # certtool --generate-dh-params --bits 2236 >>new-params
26718 # openssl dhparam -noout -text -in new-params | head
26719 [ check the first line, make sure it's not more than 2236;
26720   if it is, then go back to the start ("rm") and repeat
26721   until the size generated is at most the size requested ]
26722 # chmod 0400 new-params
26723 # mv new-params gnutls-params-2236
26724 .endd
26725 If Exim never has to generate the parameters itself, the possibility of
26726 stalling is removed.
26727
26728 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
26729 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
26730 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
26731 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
26732 and Exim does so.  This attempt to remove Exim from TLS policy decisions
26733 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
26734 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
26735 which applies to all D-H usage, client or server.  If the value returned by
26736 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
26737 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
26738 limit, which is still much higher than Exim historically used.
26739
26740 The filename and bits used will change as the GnuTLS maintainers change the
26741 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
26742 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
26743 2432 bits, while NSS is limited to 2236 bits.
26744
26745 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
26746 increase the chance of the generated prime actually being within acceptable
26747 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
26748 procedure above.  There is no sane procedure available to Exim to double-check
26749 the size of the generated prime, so it might still be too large.
26750
26751
26752 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
26753 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
26754 .oindex "&%tls_require_ciphers%&" "OpenSSL"
26755 There is a function in the OpenSSL library that can be passed a list of cipher
26756 suites before the cipher negotiation takes place. This specifies which ciphers
26757 are acceptable. The list is colon separated and may contain names like
26758 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
26759 directly to this function call.
26760 Many systems will install the OpenSSL manual-pages, so you may have
26761 &'ciphers(1)'& available to you.
26762 The following quotation from the OpenSSL
26763 documentation specifies what forms of item are allowed in the cipher string:
26764
26765 .ilist
26766 It can consist of a single cipher suite such as RC4-SHA.
26767 .next
26768 It can represent a list of cipher suites containing a certain algorithm,
26769 or cipher suites of a certain type. For example SHA1 represents all
26770 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
26771 SSL v3 algorithms.
26772 .next
26773 Lists of cipher suites can be combined in a single cipher string using
26774 the + character. This is used as a logical and operation. For example
26775 SHA1+DES represents all cipher suites containing the SHA1 and the DES
26776 algorithms.
26777 .endlist
26778
26779 Each cipher string can be optionally preceded by one of the characters &`!`&,
26780 &`-`& or &`+`&.
26781 .ilist
26782 If &`!`& is used, the ciphers are permanently deleted from the list. The
26783 ciphers deleted can never reappear in the list even if they are explicitly
26784 stated.
26785 .next
26786 If &`-`& is used, the ciphers are deleted from the list, but some or all
26787 of the ciphers can be added again by later options.
26788 .next
26789 If &`+`& is used, the ciphers are moved to the end of the list. This
26790 option does not add any new ciphers; it just moves matching existing ones.
26791 .endlist
26792
26793 If none of these characters is present, the string is interpreted as
26794 a list of ciphers to be appended to the current preference list. If the list
26795 includes any ciphers already present they will be ignored: that is, they will
26796 not be moved to the end of the list.
26797 .endlist
26798
26799 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
26800 string:
26801 .code
26802 # note single-quotes to get ! past any shell history expansion
26803 $ openssl ciphers 'HIGH:!MD5:!SHA1'
26804 .endd
26805
26806 This example will let the library defaults be permitted on the MX port, where
26807 there's probably no identity verification anyway, but ups the ante on the
26808 submission ports where the administrator might have some influence on the
26809 choice of clients used:
26810 .code
26811 # OpenSSL variant; see man ciphers(1)
26812 tls_require_ciphers = ${if =={$received_port}{25}\
26813                            {DEFAULT}\
26814                            {HIGH:!MD5:!SHA1}}
26815 .endd
26816
26817
26818
26819 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
26820          "SECTreqciphgnu"
26821 .cindex "GnuTLS" "specifying parameters for"
26822 .cindex "TLS" "specifying ciphers (GnuTLS)"
26823 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
26824 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
26825 .cindex "TLS" "specifying protocols (GnuTLS)"
26826 .cindex "TLS" "specifying priority string (GnuTLS)"
26827 .oindex "&%tls_require_ciphers%&" "GnuTLS"
26828 The GnuTLS library allows the caller to provide a "priority string", documented
26829 as part of the &[gnutls_priority_init]& function.  This is very similar to the
26830 ciphersuite specification in OpenSSL.
26831
26832 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string
26833 and controls both protocols and ciphers.
26834
26835 The &%tls_require_ciphers%& option is available both as an global option,
26836 controlling how Exim behaves as a server, and also as an option of the
26837 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
26838 the value is string expanded.  The resulting string is not an Exim list and
26839 the string is given to the GnuTLS library, so that Exim does not need to be
26840 aware of future feature enhancements of GnuTLS.
26841
26842 Documentation of the strings accepted may be found in the GnuTLS manual, under
26843 "Priority strings".  This is online as
26844 &url(http://www.gnutls.org/manual/html_node/Priority-Strings.html),
26845 but beware that this relates to GnuTLS 3, which may be newer than the version
26846 installed on your system.  If you are using GnuTLS 3,
26847 &url(http://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string, then the example code)
26848 on that site can be used to test a given string.
26849
26850 For example:
26851 .code
26852 # Disable older versions of protocols
26853 tls_require_ciphers = NORMAL:%LATEST_RECORD_VERSION:-VERS-SSL3.0
26854 .endd
26855
26856 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
26857 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
26858 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
26859
26860 This example will let the library defaults be permitted on the MX port, where
26861 there's probably no identity verification anyway, and lowers security further
26862 by increasing compatibility; but this ups the ante on the submission ports
26863 where the administrator might have some influence on the choice of clients
26864 used:
26865 .code
26866 # GnuTLS variant
26867 tls_require_ciphers = ${if =={$received_port}{25}\
26868                            {NORMAL:%COMPAT}\
26869                            {SECURE128}}
26870 .endd
26871
26872
26873 .section "Configuring an Exim server to use TLS" "SECID182"
26874 .cindex "TLS" "configuring an Exim server"
26875 When Exim has been built with TLS support, it advertises the availability of
26876 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
26877 but not to any others. The default value of this option is unset, which means
26878 that STARTTLS is not advertised at all. This default is chosen because you
26879 need to set some other options in order to make TLS available, and also it is
26880 sensible for systems that want to use TLS only as a client.
26881
26882 If a client issues a STARTTLS command and there is some configuration
26883 problem in the server, the command is rejected with a 454 error. If the client
26884 persists in trying to issue SMTP commands, all except QUIT are rejected
26885 with the error
26886 .code
26887 554 Security failure
26888 .endd
26889 If a STARTTLS command is issued within an existing TLS session, it is
26890 rejected with a 554 error code.
26891
26892 To enable TLS operations on a server, you must set &%tls_advertise_hosts%& to
26893 match some hosts. You can, of course, set it to * to match all hosts.
26894 However, this is not all you need to do. TLS sessions to a server won't work
26895 without some further configuration at the server end.
26896
26897 It is rumoured that all existing clients that support TLS/SSL use RSA
26898 encryption. To make this work you need to set, in the server,
26899 .code
26900 tls_certificate = /some/file/name
26901 tls_privatekey = /some/file/name
26902 .endd
26903 These options are, in fact, expanded strings, so you can make them depend on
26904 the identity of the client that is connected if you wish. The first file
26905 contains the server's X509 certificate, and the second contains the private key
26906 that goes with it. These files need to be
26907 PEM format and readable by the Exim user, and must
26908 always be given as full path names.
26909 The key must not be password-protected.
26910 They can be the same file if both the
26911 certificate and the key are contained within it. If &%tls_privatekey%& is not
26912 set, or if its expansion is forced to fail or results in an empty string, this
26913 is assumed to be the case. The certificate file may also contain intermediate
26914 certificates that need to be sent to the client to enable it to authenticate
26915 the server's certificate.
26916
26917 If you do not understand about certificates and keys, please try to find a
26918 source of this background information, which is not Exim-specific. (There are a
26919 few comments below in section &<<SECTcerandall>>&.)
26920
26921 &*Note*&: These options do not apply when Exim is operating as a client &--
26922 they apply only in the case of a server. If you need to use a certificate in an
26923 Exim client, you must set the options of the same names in an &(smtp)&
26924 transport.
26925
26926 With just these options, an Exim server will be able to use TLS. It does not
26927 require the client to have a certificate (but see below for how to insist on
26928 this). There is one other option that may be needed in other situations. If
26929 .code
26930 tls_dhparam = /some/file/name
26931 .endd
26932 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
26933 with the parameters contained in the file.
26934 Set this to &`none`& to disable use of DH entirely, by making no prime
26935 available:
26936 .code
26937 tls_dhparam = none
26938 .endd
26939 This may also be set to a string identifying a standard prime to be used for
26940 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
26941 used is &`ike23`&.  There are a few standard primes available, see the
26942 documentation for &%tls_dhparam%& for the complete list.
26943
26944 See the command
26945 .code
26946 openssl dhparam
26947 .endd
26948 for a way of generating file data.
26949
26950 The strings supplied for these three options are expanded every time a client
26951 host connects. It is therefore possible to use different certificates and keys
26952 for different hosts, if you so wish, by making use of the client's IP address
26953 in &$sender_host_address$& to control the expansion. If a string expansion is
26954 forced to fail, Exim behaves as if the option is not set.
26955
26956 .cindex "cipher" "logging"
26957 .cindex "log" "TLS cipher"
26958 .vindex "&$tls_in_cipher$&"
26959 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
26960 an incoming TLS connection. It is included in the &'Received:'& header of an
26961 incoming message (by default &-- you can, of course, change this), and it is
26962 also included in the log line that records a message's arrival, keyed by
26963 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
26964 condition can be used to test for specific cipher suites in ACLs.
26965
26966 Once TLS has been established, the ACLs that run for subsequent SMTP commands
26967 can check the name of the cipher suite and vary their actions accordingly. The
26968 cipher suite names vary, depending on which TLS library is being used. For
26969 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
26970 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
26971 documentation for more details.
26972
26973 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
26974 (again depending on the &%tls_cipher%& log selector).
26975
26976
26977 .section "Requesting and verifying client certificates" "SECID183"
26978 .cindex "certificate" "verification of client"
26979 .cindex "TLS" "client certificate verification"
26980 If you want an Exim server to request a certificate when negotiating a TLS
26981 session with a client, you must set either &%tls_verify_hosts%& or
26982 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
26983 apply to all TLS connections. For any host that matches one of these options,
26984 Exim requests a certificate as part of the setup of the TLS session. The
26985 contents of the certificate are verified by comparing it with a list of
26986 expected certificates.
26987 These may be the system default set (depending on library version),
26988 an explicit file or,
26989 depending on library version, a directory, identified by
26990 &%tls_verify_certificates%&.
26991
26992 A file can contain multiple certificates, concatenated end to end. If a
26993 directory is used
26994 (OpenSSL only),
26995 each certificate must be in a separate file, with a name (or a symbolic link)
26996 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
26997 certificate. You can compute the relevant hash by running the command
26998 .code
26999 openssl x509 -hash -noout -in /cert/file
27000 .endd
27001 where &_/cert/file_& contains a single certificate.
27002
27003 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
27004 what happens if the client does not supply a certificate, or if the certificate
27005 does not match any of the certificates in the collection named by
27006 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
27007 attempt to set up a TLS session is aborted, and the incoming connection is
27008 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
27009 session continues. ACLs that run for subsequent SMTP commands can detect the
27010 fact that no certificate was verified, and vary their actions accordingly. For
27011 example, you can insist on a certificate before accepting a message for
27012 relaying, but not when the message is destined for local delivery.
27013
27014 .vindex "&$tls_in_peerdn$&"
27015 When a client supplies a certificate (whether it verifies or not), the value of
27016 the Distinguished Name of the certificate is made available in the variable
27017 &$tls_in_peerdn$& during subsequent processing of the message.
27018
27019 .cindex "log" "distinguished name"
27020 Because it is often a long text string, it is not included in the log line or
27021 &'Received:'& header by default. You can arrange for it to be logged, keyed by
27022 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
27023 &%received_header_text%& to change the &'Received:'& header. When no
27024 certificate is supplied, &$tls_in_peerdn$& is empty.
27025
27026
27027 .section "Revoked certificates" "SECID184"
27028 .cindex "TLS" "revoked certificates"
27029 .cindex "revocation list"
27030 .cindex "certificate" "revocation list"
27031 .cindex "OCSP" "stapling"
27032 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
27033 certificates are revoked. If you have such a list, you can pass it to an Exim
27034 server using the global option called &%tls_crl%& and to an Exim client using
27035 an identically named option for the &(smtp)& transport. In each case, the value
27036 of the option is expanded and must then be the name of a file that contains a
27037 CRL in PEM format.
27038 The downside is that clients have to periodically re-download a potentially huge
27039 file from every certificate authority they know of.
27040
27041 The way with most moving parts at query time is Online Certificate
27042 Status Protocol (OCSP), where the client verifies the certificate
27043 against an OCSP server run by the CA.  This lets the CA track all
27044 usage of the certs.  It requires running software with access to the
27045 private key of the CA, to sign the responses to the OCSP queries.  OCSP
27046 is based on HTTP and can be proxied accordingly.
27047
27048 The only widespread OCSP server implementation (known to this writer)
27049 comes as part of OpenSSL and aborts on an invalid request, such as
27050 connecting to the port and then disconnecting.  This requires
27051 re-entering the passphrase each time some random client does this.
27052
27053 The third way is OCSP Stapling; in this, the server using a certificate
27054 issued by the CA periodically requests an OCSP proof of validity from
27055 the OCSP server, then serves it up inline as part of the TLS
27056 negotiation.   This approach adds no extra round trips, does not let the
27057 CA track users, scales well with number of certs issued by the CA and is
27058 resilient to temporary OCSP server failures, as long as the server
27059 starts retrying to fetch an OCSP proof some time before its current
27060 proof expires.  The downside is that it requires server support.
27061
27062 Unless Exim is built with the support disabled,
27063 .new
27064 or with GnuTLS earlier than version 3.3.16 / 3.4.8
27065 .wen
27066 support for OCSP stapling is included.
27067
27068 There is a global option called &%tls_ocsp_file%&.
27069 The file specified therein is expected to be in DER format, and contain
27070 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
27071 option will be re-expanded for SNI, if the &%tls_certificate%& option
27072 contains &`tls_in_sni`&, as per other TLS options.
27073
27074 Exim does not at this time implement any support for fetching a new OCSP
27075 proof.  The burden is on the administrator to handle this, outside of
27076 Exim.  The file specified should be replaced atomically, so that the
27077 contents are always valid.  Exim will expand the &%tls_ocsp_file%& option
27078 on each connection, so a new file will be handled transparently on the
27079 next connection.
27080
27081 When built with OpenSSL Exim will check for a valid next update timestamp
27082 in the OCSP proof; if not present, or if the proof has expired, it will be
27083 ignored.
27084
27085 For the client to be able to verify the stapled OCSP the server must
27086 also supply, in its stapled information, any intermediate
27087 certificates for the chain leading to the OCSP proof from the signer
27088 of the server certificate.  There may be zero or one such. These
27089 intermediate certificates should be added to the server OCSP stapling
27090 file named by &%tls_ocsp_file%&.
27091
27092 Note that the proof only covers the terminal server certificate,
27093 not any of the chain from CA to it.
27094
27095 There is no current way to staple a proof for a client certificate.
27096
27097 .code
27098   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
27099   OCSP server is supplied.  The server URL may be included in the
27100   server certificate, if the CA is helpful.
27101
27102   One failure mode seen was the OCSP Signer cert expiring before the end
27103   of validity of the OCSP proof. The checking done by Exim/OpenSSL
27104   noted this as invalid overall, but the re-fetch script did not.
27105 .endd
27106
27107
27108
27109
27110 .section "Configuring an Exim client to use TLS" "SECID185"
27111 .cindex "cipher" "logging"
27112 .cindex "log" "TLS cipher"
27113 .cindex "log" "distinguished name"
27114 .cindex "TLS" "configuring an Exim client"
27115 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
27116 deliveries as well as to incoming, the latter one causing logging of the
27117 server certificate's DN. The remaining client configuration for TLS is all
27118 within the &(smtp)& transport.
27119
27120 It is not necessary to set any options to have TLS work in the &(smtp)&
27121 transport. If Exim is built with TLS support, and TLS is advertised by a
27122 server, the &(smtp)& transport always tries to start a TLS session. However,
27123 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
27124 transport) to a list of server hosts for which TLS should not be used.
27125
27126 If you do not want Exim to attempt to send messages unencrypted when an attempt
27127 to set up an encrypted connection fails in any way, you can set
27128 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
27129 those hosts, delivery is always deferred if an encrypted connection cannot be
27130 set up. If there are any other hosts for the address, they are tried in the
27131 usual way.
27132
27133 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
27134 the message unencrypted. It always does this if the response to STARTTLS is
27135 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
27136 session after a success response code, what happens is controlled by the
27137 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
27138 delivery to this host is deferred, and other hosts (if available) are tried. If
27139 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
27140 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
27141 negotiation fails, Exim closes the current connection (because it is in an
27142 unknown state), opens a new one to the same host, and then tries the delivery
27143 unencrypted.
27144
27145 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
27146 transport provide the client with a certificate, which is passed to the server
27147 if it requests it. If the server is Exim, it will request a certificate only if
27148 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
27149
27150 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
27151 specifies a collection of expected server certificates.
27152 These may be the system default set (depending on library version),
27153 a file or,
27154 depending on library version, a directory,
27155 must name a file or,
27156 for OpenSSL only (not GnuTLS), a directory.
27157 The client verifies the server's certificate
27158 against this collection, taking into account any revoked certificates that are
27159 in the list defined by &%tls_crl%&.
27160 Failure to verify fails the TLS connection unless either of the
27161 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
27162
27163 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
27164 certificate verification to the listed servers.  Verification either must
27165 or need not succeed respectively.
27166
27167 The &(smtp)& transport has two OCSP-related options:
27168 &%hosts_require_ocsp%&; a host-list for which a Certificate Status
27169 is requested and required for the connection to proceed.  The default
27170 value is empty.
27171 &%hosts_request_ocsp%&; a host-list for which (additionally)
27172 a Certificate Status is requested (but not necessarily verified).  The default
27173 value is "*" meaning that requests are made unless configured
27174 otherwise.
27175
27176 The host(s) should also be in &%hosts_require_tls%&, and
27177 &%tls_verify_certificates%& configured for the transport,
27178 for OCSP to be relevant.
27179
27180 If
27181 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
27182 list of permitted cipher suites. If either of these checks fails, delivery to
27183 the current host is abandoned, and the &(smtp)& transport tries to deliver to
27184 alternative hosts, if any.
27185
27186  &*Note*&:
27187 These options must be set in the &(smtp)& transport for Exim to use TLS when it
27188 is operating as a client. Exim does not assume that a server certificate (set
27189 by the global options of the same name) should also be used when operating as a
27190 client.
27191
27192 .vindex "&$host$&"
27193 .vindex "&$host_address$&"
27194 All the TLS options in the &(smtp)& transport are expanded before use, with
27195 &$host$& and &$host_address$& containing the name and address of the server to
27196 which the client is connected. Forced failure of an expansion causes Exim to
27197 behave as if the relevant option were unset.
27198
27199 .vindex &$tls_out_bits$&
27200 .vindex &$tls_out_cipher$&
27201 .vindex &$tls_out_peerdn$&
27202 .vindex &$tls_out_sni$&
27203 Before an SMTP connection is established, the
27204 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
27205 variables are emptied. (Until the first connection, they contain the values
27206 that were set when the message was received.) If STARTTLS is subsequently
27207 successfully obeyed, these variables are set to the relevant values for the
27208 outgoing connection.
27209
27210
27211
27212 .section "Use of TLS Server Name Indication" "SECTtlssni"
27213 .cindex "TLS" "Server Name Indication"
27214 .vindex "&$tls_in_sni$&"
27215 .oindex "&%tls_in_sni%&"
27216 With TLS1.0 or above, there is an extension mechanism by which extra
27217 information can be included at various points in the protocol.  One of these
27218 extensions, documented in RFC 6066 (and before that RFC 4366) is
27219 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
27220 client in the initial handshake, so that the server can examine the servername
27221 within and possibly choose to use different certificates and keys (and more)
27222 for this session.
27223
27224 This is analogous to HTTP's &"Host:"& header, and is the main mechanism by
27225 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
27226 address.
27227
27228 With SMTP to MX, there are the same problems here as in choosing the identity
27229 against which to validate a certificate: you can't rely on insecure DNS to
27230 provide the identity which you then cryptographically verify.  So this will
27231 be of limited use in that environment.
27232
27233 With SMTP to Submission, there is a well-defined hostname which clients are
27234 connecting to and can validate certificates against.  Thus clients &*can*&
27235 choose to include this information in the TLS negotiation.  If this becomes
27236 wide-spread, then hosters can choose to present different certificates to
27237 different clients.  Or even negotiate different cipher suites.
27238
27239 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
27240 if not empty, will be sent on a TLS session as part of the handshake.  There's
27241 nothing more to it.  Choosing a sensible value not derived insecurely is the
27242 only point of caution.  The &$tls_out_sni$& variable will be set to this string
27243 for the lifetime of the client connection (including during authentication).
27244
27245 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
27246 received from a client.
27247 It can be logged with the &%log_selector%& item &`+tls_sni`&.
27248
27249 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
27250 option (prior to expansion) then the following options will be re-expanded
27251 during TLS session handshake, to permit alternative values to be chosen:
27252
27253 .ilist
27254 .vindex "&%tls_certificate%&"
27255 &%tls_certificate%&
27256 .next
27257 .vindex "&%tls_crl%&"
27258 &%tls_crl%&
27259 .next
27260 .vindex "&%tls_privatekey%&"
27261 &%tls_privatekey%&
27262 .next
27263 .vindex "&%tls_verify_certificates%&"
27264 &%tls_verify_certificates%&
27265 .next
27266 .vindex "&%tls_ocsp_file%&"
27267 &%tls_ocsp_file%&
27268 .endlist
27269
27270 Great care should be taken to deal with matters of case, various injection
27271 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
27272 can always be referenced; it is important to remember that &$tls_sni$& is
27273 arbitrary unverified data provided prior to authentication.
27274
27275 The Exim developers are proceeding cautiously and so far no other TLS options
27276 are re-expanded.
27277
27278 When Exim is built against OpenSSL, OpenSSL must have been built with support
27279 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
27280 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
27281 see &`-servername`& in the output, then OpenSSL has support.
27282
27283 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
27284 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
27285 built, then you have SNI support).
27286
27287
27288
27289 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
27290          "SECTmulmessam"
27291 .cindex "multiple SMTP deliveries with TLS"
27292 .cindex "TLS" "multiple message deliveries"
27293 Exim sends multiple messages down the same TCP/IP connection by starting up
27294 an entirely new delivery process for each message, passing the socket from
27295 one process to the next. This implementation does not fit well with the use
27296 of TLS, because there is quite a lot of state information associated with a TLS
27297 connection, not just a socket identification. Passing all the state information
27298 to a new process is not feasible. Consequently, Exim shuts down an existing TLS
27299 session before passing the socket to a new process. The new process may then
27300 try to start a new TLS session, and if successful, may try to re-authenticate
27301 if AUTH is in use, before sending the next message.
27302
27303 The RFC is not clear as to whether or not an SMTP session continues in clear
27304 after TLS has been shut down, or whether TLS may be restarted again later, as
27305 just described. However, if the server is Exim, this shutdown and
27306 reinitialization works. It is not known which (if any) other servers operate
27307 successfully if the client closes a TLS session and continues with unencrypted
27308 SMTP, but there are certainly some that do not work. For such servers, Exim
27309 should not pass the socket to another process, because the failure of the
27310 subsequent attempt to use it would cause Exim to record a temporary host error,
27311 and delay other deliveries to that host.
27312
27313 To test for this case, Exim sends an EHLO command to the server after
27314 closing down the TLS session. If this fails in any way, the connection is
27315 closed instead of being passed to a new delivery process, but no retry
27316 information is recorded.
27317
27318 There is also a manual override; you can set &%hosts_nopass_tls%& on the
27319 &(smtp)& transport to match those hosts for which Exim should not pass
27320 connections to new processes if TLS has been used.
27321
27322
27323
27324
27325 .section "Certificates and all that" "SECTcerandall"
27326 .cindex "certificate" "references to discussion"
27327 In order to understand fully how TLS works, you need to know about
27328 certificates, certificate signing, and certificate authorities. This is not the
27329 place to give a tutorial, especially as I do not know very much about it
27330 myself. Some helpful introduction can be found in the FAQ for the SSL addition
27331 to Apache, currently at
27332 .display
27333 &url(http://www.modssl.org/docs/2.7/ssl_faq.html#ToC24)
27334 .endd
27335 Other parts of the &'modssl'& documentation are also helpful, and have
27336 links to further files.
27337 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
27338 0-201-61598-3), contains both introductory and more in-depth descriptions.
27339 Some sample programs taken from the book are available from
27340 .display
27341 &url(http://www.rtfm.com/openssl-examples/)
27342 .endd
27343
27344
27345 .section "Certificate chains" "SECID186"
27346 The file named by &%tls_certificate%& may contain more than one
27347 certificate. This is useful in the case where the certificate that is being
27348 sent is validated by an intermediate certificate which the other end does
27349 not have. Multiple certificates must be in the correct order in the file.
27350 First the host's certificate itself, then the first intermediate
27351 certificate to validate the issuer of the host certificate, then the next
27352 intermediate certificate to validate the issuer of the first intermediate
27353 certificate, and so on, until finally (optionally) the root certificate.
27354 The root certificate must already be trusted by the recipient for
27355 validation to succeed, of course, but if it's not preinstalled, sending the
27356 root certificate along with the rest makes it available for the user to
27357 install if the receiving end is a client MUA that can interact with a user.
27358
27359 Note that certificates using MD5 are unlikely to work on today's Internet;
27360 even if your libraries allow loading them for use in Exim when acting as a
27361 server, increasingly clients will not accept such certificates.  The error
27362 diagnostics in such a case can be frustratingly vague.
27363
27364
27365
27366 .section "Self-signed certificates" "SECID187"
27367 .cindex "certificate" "self-signed"
27368 You can create a self-signed certificate using the &'req'& command provided
27369 with OpenSSL, like this:
27370 . ==== Do not shorten the duration here without reading and considering
27371 . ==== the text below.  Please leave it at 9999 days.
27372 .code
27373 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
27374             -days 9999 -nodes
27375 .endd
27376 &_file1_& and &_file2_& can be the same file; the key and the certificate are
27377 delimited and so can be identified independently. The &%-days%& option
27378 specifies a period for which the certificate is valid. The &%-nodes%& option is
27379 important: if you do not set it, the key is encrypted with a passphrase
27380 that you are prompted for, and any use that is made of the key causes more
27381 prompting for the passphrase. This is not helpful if you are going to use
27382 this certificate and key in an MTA, where prompting is not possible.
27383
27384 . ==== I expect to still be working 26 years from now.  The less technical
27385 . ==== debt I create, in terms of storing up trouble for my later years, the
27386 . ==== happier I will be then.  We really have reached the point where we
27387 . ==== should start, at the very least, provoking thought and making folks
27388 . ==== pause before proceeding, instead of leaving all the fixes until two
27389 . ==== years before 2^31 seconds after the 1970 Unix epoch.
27390 . ==== -pdp, 2012
27391 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
27392 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
27393 the above command might produce a date in the past.  Think carefully about
27394 the lifetime of the systems you're deploying, and either reduce the duration
27395 of the certificate or reconsider your platform deployment.  (At time of
27396 writing, reducing the duration is the most likely choice, but the inexorable
27397 progression of time takes us steadily towards an era where this will not
27398 be a sensible resolution).
27399
27400 A self-signed certificate made in this way is sufficient for testing, and
27401 may be adequate for all your requirements if you are mainly interested in
27402 encrypting transfers, and not in secure identification.
27403
27404 However, many clients require that the certificate presented by the server be a
27405 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
27406 certificate. In this situation, the self-signed certificate described above
27407 must be installed on the client host as a trusted root &'certification
27408 authority'& (CA), and the certificate used by Exim must be a user certificate
27409 signed with that self-signed certificate.
27410
27411 For information on creating self-signed CA certificates and using them to sign
27412 user certificates, see the &'General implementation overview'& chapter of the
27413 Open-source PKI book, available online at
27414 &url(http://ospkibook.sourceforge.net/).
27415 .ecindex IIDencsmtp1
27416 .ecindex IIDencsmtp2
27417
27418
27419
27420 . ////////////////////////////////////////////////////////////////////////////
27421 . ////////////////////////////////////////////////////////////////////////////
27422
27423 .chapter "Access control lists" "CHAPACL"
27424 .scindex IIDacl "&ACL;" "description"
27425 .cindex "control of incoming mail"
27426 .cindex "message" "controlling incoming"
27427 .cindex "policy control" "access control lists"
27428 Access Control Lists (ACLs) are defined in a separate section of the run time
27429 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
27430 name, terminated by a colon. Here is a complete ACL section that contains just
27431 one very small ACL:
27432 .code
27433 begin acl
27434 small_acl:
27435   accept   hosts = one.host.only
27436 .endd
27437 You can have as many lists as you like in the ACL section, and the order in
27438 which they appear does not matter. The lists are self-terminating.
27439
27440 The majority of ACLs are used to control Exim's behaviour when it receives
27441 certain SMTP commands. This applies both to incoming TCP/IP connections, and
27442 when a local process submits a message using SMTP by specifying the &%-bs%&
27443 option. The most common use is for controlling which recipients are accepted
27444 in incoming messages. In addition, you can define an ACL that is used to check
27445 local non-SMTP messages. The default configuration file contains an example of
27446 a realistic ACL for checking RCPT commands. This is discussed in chapter
27447 &<<CHAPdefconfil>>&.
27448
27449
27450 .section "Testing ACLs" "SECID188"
27451 The &%-bh%& command line option provides a way of testing your ACL
27452 configuration locally by running a fake SMTP session with which you interact.
27453 The host &'relay-test.mail-abuse.org'& provides a service for checking your
27454 relaying configuration (see section &<<SECTcheralcon>>& for more details).
27455
27456
27457
27458 .section "Specifying when ACLs are used" "SECID189"
27459 .cindex "&ACL;" "options for specifying"
27460 In order to cause an ACL to be used, you have to name it in one of the relevant
27461 options in the main part of the configuration. These options are:
27462 .cindex "AUTH" "ACL for"
27463 .cindex "DATA" "ACLs for"
27464 .cindex "ETRN" "ACL for"
27465 .cindex "EXPN" "ACL for"
27466 .cindex "HELO" "ACL for"
27467 .cindex "EHLO" "ACL for"
27468 .cindex "DKIM" "ACL for"
27469 .cindex "MAIL" "ACL for"
27470 .cindex "QUIT, ACL for"
27471 .cindex "RCPT" "ACL for"
27472 .cindex "STARTTLS, ACL for"
27473 .cindex "VRFY" "ACL for"
27474 .cindex "SMTP" "connection, ACL for"
27475 .cindex "non-SMTP messages" "ACLs for"
27476 .cindex "MIME content scanning" "ACL for"
27477 .cindex "PRDR" "ACL for"
27478
27479 .table2 140pt
27480 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
27481 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
27482 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
27483 .irow &%acl_smtp_auth%&        "ACL for AUTH"
27484 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
27485 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
27486 .irow &%acl_smtp_data_prdr%&   "ACL for each recipient, after DATA is complete"
27487 .irow &%acl_smtp_dkim%&        "ACL for each DKIM signer"
27488 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
27489 .irow &%acl_smtp_expn%&        "ACL for EXPN"
27490 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
27491 .irow &%acl_smtp_mail%&        "ACL for MAIL"
27492 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
27493 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
27494 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
27495 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
27496 .irow &%acl_smtp_quit%&        "ACL for QUIT"
27497 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
27498 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
27499 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
27500 .endtable
27501
27502 For example, if you set
27503 .code
27504 acl_smtp_rcpt = small_acl
27505 .endd
27506 the little ACL defined above is used whenever Exim receives a RCPT command
27507 in an SMTP dialogue. The majority of policy tests on incoming messages can be
27508 done when RCPT commands arrive. A rejection of RCPT should cause the
27509 sending MTA to give up on the recipient address contained in the RCPT
27510 command, whereas rejection at other times may cause the client MTA to keep on
27511 trying to deliver the message. It is therefore recommended that you do as much
27512 testing as possible at RCPT time.
27513
27514
27515 .section "The non-SMTP ACLs" "SECID190"
27516 .cindex "non-SMTP messages" "ACLs for"
27517 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
27518 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
27519 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
27520 the state of the SMTP connection such as encryption and authentication) are not
27521 relevant and are forbidden in these ACLs. However, the sender and recipients
27522 are known, so the &%senders%& and &%sender_domains%& conditions and the
27523 &$sender_address$& and &$recipients$& variables can be used. Variables such as
27524 &$authenticated_sender$& are also available. You can specify added header lines
27525 in any of these ACLs.
27526
27527 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
27528 non-SMTP message, before any of the message has been read. (This is the
27529 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
27530 batched SMTP input, it runs after the DATA command has been reached. The
27531 result of this ACL is ignored; it cannot be used to reject a message. If you
27532 really need to, you could set a value in an ACL variable here and reject based
27533 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
27534 controls, and in particular, it can be used to set
27535 .code
27536 control = suppress_local_fixups
27537 .endd
27538 This cannot be used in the other non-SMTP ACLs because by the time they are
27539 run, it is too late.
27540
27541 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
27542 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
27543
27544 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
27545 kind of rejection is treated as permanent, because there is no way of sending a
27546 temporary error for these kinds of message.
27547
27548
27549 .section "The SMTP connect ACL" "SECID191"
27550 .cindex "SMTP" "connection, ACL for"
27551 .oindex &%smtp_banner%&
27552 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
27553 session, after the test specified by &%host_reject_connection%& (which is now
27554 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
27555 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
27556 the message override the banner message that is otherwise specified by the
27557 &%smtp_banner%& option.
27558
27559
27560 .section "The EHLO/HELO ACL" "SECID192"
27561 .cindex "EHLO" "ACL for"
27562 .cindex "HELO" "ACL for"
27563 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
27564 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
27565 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
27566 Note that a client may issue more than one EHLO or HELO command in an SMTP
27567 session, and indeed is required to issue a new EHLO or HELO after successfully
27568 setting up encryption following a STARTTLS command.
27569
27570 .new
27571 Note also that a deny neither forces the client to go away nor means that
27572 mail will be refused on the connection.  Consider checking for
27573 &$sender_helo_name$& being defined in a MAIL or RCPT ACL to do that.
27574 .wen
27575
27576 If the command is accepted by an &%accept%& verb that has a &%message%&
27577 modifier, the message may not contain more than one line (it will be truncated
27578 at the first newline and a panic logged if it does). Such a message cannot
27579 affect the EHLO options that are listed on the second and subsequent lines of
27580 an EHLO response.
27581
27582
27583 .section "The DATA ACLs" "SECID193"
27584 .cindex "DATA" "ACLs for"
27585 Two ACLs are associated with the DATA command, because it is two-stage
27586 command, with two responses being sent to the client.
27587 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
27588 is obeyed. This gives you control after all the RCPT commands, but before
27589 the message itself is received. It offers the opportunity to give a negative
27590 response to the DATA command before the data is transmitted. Header lines
27591 added by MAIL or RCPT ACLs are not visible at this time, but any that
27592 are defined here are visible when the &%acl_smtp_data%& ACL is run.
27593
27594 You cannot test the contents of the message, for example, to verify addresses
27595 in the headers, at RCPT time or when the DATA command is received. Such
27596 tests have to appear in the ACL that is run after the message itself has been
27597 received, before the final response to the DATA command is sent. This is
27598 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
27599 associated with the DATA command.
27600
27601 For both of these ACLs, it is not possible to reject individual recipients. An
27602 error response rejects the entire message. Unfortunately, it is known that some
27603 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
27604 before or after the data) correctly &-- they keep the message on their queues
27605 and try again later, but that is their problem, though it does waste some of
27606 your resources.
27607
27608 The &%acl_smtp_data%& ACL is run after
27609 the &%acl_smtp_data_prdr%&,
27610 the &%acl_smtp_dkim%&
27611 and the &%acl_smtp_mime%& ACLs.
27612
27613 .section "The SMTP DKIM ACL" "SECTDKIMACL"
27614 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
27615 enabled (which is the default).
27616
27617 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
27618 received, and is executed for each DKIM signature found in a message.  If not
27619 otherwise specified, the default action is to accept.
27620
27621 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
27622
27623 For details on the operation of DKIM, see chapter &<<CHAPdkim>>&.
27624
27625
27626 .section "The SMTP MIME ACL" "SECID194"
27627 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
27628 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
27629
27630 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
27631
27632
27633 .section "The SMTP PRDR ACL" "SECTPRDRACL"
27634 .cindex "PRDR" "ACL for"
27635 .oindex "&%prdr_enable%&"
27636 The &%acl_smtp_data_prdr%& ACL is available only when Exim is compiled
27637 with PRDR support enabled (which is the default).
27638 It becomes active only when the PRDR feature is negotiated between
27639 client and server for a message, and more than one recipient
27640 has been accepted.
27641
27642 The ACL test specified by &%acl_smtp_data_prdr%& happens after a message
27643 has been received, and is executed once for each recipient of the message
27644 with &$local_part$& and &$domain$& valid.
27645 The test may accept, defer or deny for individual recipients.
27646 The &%acl_smtp_data%& will still be called after this ACL and
27647 can reject the message overall, even if this ACL has accepted it
27648 for some or all recipients.
27649
27650 PRDR may be used to support per-user content filtering.  Without it
27651 one must defer any recipient after the first that has a different
27652 content-filter configuration.  With PRDR, the RCPT-time check
27653 .new
27654 .cindex "PRDR" "variable for"
27655 for this can be disabled when the variable &$prdr_requested$&
27656 is &"yes"&.
27657 .wen
27658 Any required difference in behaviour of the main DATA-time
27659 ACL should however depend on the PRDR-time ACL having run, as Exim
27660 will avoid doing so in some situations (e.g.  single-recipient mails).
27661
27662 See also the &%prdr_enable%& global option
27663 and the &%hosts_try_prdr%& smtp transport option.
27664
27665 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
27666 If the ACL is not defined, processing completes as if
27667 the feature was not requested by the client.
27668
27669 .section "The QUIT ACL" "SECTQUITACL"
27670 .cindex "QUIT, ACL for"
27671 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
27672 does not affect the response code to QUIT, which is always 221. Thus, the ACL
27673 does not in fact control any access.
27674 For this reason, it may only accept
27675 or warn as its final result.
27676
27677 This ACL can be used for tasks such as custom logging at the end of an SMTP
27678 session. For example, you can use ACL variables in other ACLs to count
27679 messages, recipients, etc., and log the totals at QUIT time using one or
27680 more &%logwrite%& modifiers on a &%warn%& verb.
27681
27682 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
27683 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
27684
27685 You do not need to have a final &%accept%&, but if you do, you can use a
27686 &%message%& modifier to specify custom text that is sent as part of the 221
27687 response to QUIT.
27688
27689 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
27690 failure (for example, failure to open a log file, or when Exim is bombing out
27691 because it has detected an unrecoverable error), all SMTP commands from the
27692 client are given temporary error responses until QUIT is received or the
27693 connection is closed. In these special cases, the QUIT ACL does not run.
27694
27695
27696 .section "The not-QUIT ACL" "SECTNOTQUITACL"
27697 .vindex &$acl_smtp_notquit$&
27698 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
27699 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
27700 trouble, such as being unable to write to its log files, this ACL is not run,
27701 because it might try to do things (such as write to log files) that make the
27702 situation even worse.
27703
27704 Like the QUIT ACL, this ACL is provided to make it possible to do customized
27705 logging or to gather statistics, and its outcome is ignored. The &%delay%&
27706 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
27707 and &%warn%&.
27708
27709 .vindex &$smtp_notquit_reason$&
27710 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
27711 to a string that indicates the reason for the termination of the SMTP
27712 connection. The possible values are:
27713 .table2
27714 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
27715 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
27716 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
27717 .irow &`connection-lost`&          "The SMTP connection has been lost"
27718 .irow &`data-timeout`&             "Timeout while reading message data"
27719 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
27720 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
27721 .irow &`signal-exit`&              "SIGTERM or SIGINT"
27722 .irow &`synchronization-error`&    "SMTP synchronization error"
27723 .irow &`tls-failed`&               "TLS failed to start"
27724 .endtable
27725 In most cases when an SMTP connection is closed without having received QUIT,
27726 Exim sends an SMTP response message before actually closing the connection.
27727 With the exception of the &`acl-drop`& case, the default message can be
27728 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
27729 &%drop%& verb in another ACL, it is the message from the other ACL that is
27730 used.
27731
27732
27733 .section "Finding an ACL to use" "SECID195"
27734 .cindex "&ACL;" "finding which to use"
27735 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
27736 you can use different ACLs in different circumstances. For example,
27737 .code
27738 acl_smtp_rcpt = ${if ={25}{$interface_port} \
27739                      {acl_check_rcpt} {acl_check_rcpt_submit} }
27740 .endd
27741 In the default configuration file there are some example settings for
27742 providing an RFC 4409 message submission service on port 587 and a
27743 non-standard &"smtps"& service on port 465. You can use a string
27744 expansion like this to choose an ACL for MUAs on these ports which is
27745 more appropriate for this purpose than the default ACL on port 25.
27746
27747 The expanded string does not have to be the name of an ACL in the
27748 configuration file; there are other possibilities. Having expanded the
27749 string, Exim searches for an ACL as follows:
27750
27751 .ilist
27752 If the string begins with a slash, Exim uses it as a file name, and reads its
27753 contents as an ACL. The lines are processed in the same way as lines in the
27754 Exim configuration file. In particular, continuation lines are supported, blank
27755 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
27756 If the file does not exist or cannot be read, an error occurs (typically
27757 causing a temporary failure of whatever caused the ACL to be run). For example:
27758 .code
27759 acl_smtp_data = /etc/acls/\
27760   ${lookup{$sender_host_address}lsearch\
27761   {/etc/acllist}{$value}{default}}
27762 .endd
27763 This looks up an ACL file to use on the basis of the host's IP address, falling
27764 back to a default if the lookup fails. If an ACL is successfully read from a
27765 file, it is retained in memory for the duration of the Exim process, so that it
27766 can be re-used without having to re-read the file.
27767 .next
27768 If the string does not start with a slash, and does not contain any spaces,
27769 Exim searches the ACL section of the configuration for an ACL whose name
27770 matches the string.
27771 .next
27772 If no named ACL is found, or if the string contains spaces, Exim parses
27773 the string as an inline ACL. This can save typing in cases where you just
27774 want to have something like
27775 .code
27776 acl_smtp_vrfy = accept
27777 .endd
27778 in order to allow free use of the VRFY command. Such a string may contain
27779 newlines; it is processed in the same way as an ACL that is read from a file.
27780 .endlist
27781
27782
27783
27784
27785 .section "ACL return codes" "SECID196"
27786 .cindex "&ACL;" "return codes"
27787 Except for the QUIT ACL, which does not affect the SMTP return code (see
27788 section &<<SECTQUITACL>>& above), the result of running an ACL is either
27789 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
27790 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
27791 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
27792 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
27793 This also causes a 4&'xx'& return code.
27794
27795 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
27796 &"deny"&, because there is no mechanism for passing temporary errors to the
27797 submitters of non-SMTP messages.
27798
27799
27800 ACLs that are relevant to message reception may also return &"discard"&. This
27801 has the effect of &"accept"&, but causes either the entire message or an
27802 individual recipient address to be discarded. In other words, it is a
27803 blackholing facility. Use it with care.
27804
27805 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
27806 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
27807 RCPT ACL is to discard just the one recipient address. If there are no
27808 recipients left when the message's data is received, the DATA ACL is not
27809 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
27810 remaining recipients. The &"discard"& return is not permitted for the
27811 &%acl_smtp_predata%& ACL.
27812
27813
27814 .cindex "&[local_scan()]& function" "when all recipients discarded"
27815 The &[local_scan()]& function is always run, even if there are no remaining
27816 recipients; it may create new recipients.
27817
27818
27819
27820 .section "Unset ACL options" "SECID197"
27821 .cindex "&ACL;" "unset options"
27822 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
27823 all the same. &*Note*&: These defaults apply only when the relevant ACL is
27824 not defined at all. For any defined ACL, the default action when control
27825 reaches the end of the ACL statements is &"deny"&.
27826
27827 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
27828 these two are ACLs that are used only for their side effects. They cannot be
27829 used to accept or reject anything.
27830
27831 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
27832 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
27833 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
27834 when the ACL is not defined is &"accept"&.
27835
27836 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
27837 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
27838 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
27839 messages over an SMTP connection. For an example, see the ACL in the default
27840 configuration file.
27841
27842
27843
27844
27845 .section "Data for message ACLs" "SECID198"
27846 .cindex "&ACL;" "data for message ACL"
27847 .vindex &$domain$&
27848 .vindex &$local_part$&
27849 .vindex &$sender_address$&
27850 .vindex &$sender_host_address$&
27851 .vindex &$smtp_command$&
27852 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
27853 that contain information about the host and the message's sender (for example,
27854 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
27855 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
27856 &$local_part$& are set from the argument address. The entire SMTP command
27857 is available in &$smtp_command$&.
27858
27859 When an ACL for the AUTH parameter of MAIL is running, the variables that
27860 contain information about the host are set, but &$sender_address$& is not yet
27861 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
27862 how it is used.
27863
27864 .vindex "&$message_size$&"
27865 The &$message_size$& variable is set to the value of the SIZE parameter on
27866 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
27867 that parameter is not given. The value is updated to the true message size by
27868 the time the final DATA ACL is run (after the message data has been
27869 received).
27870
27871 .vindex "&$rcpt_count$&"
27872 .vindex "&$recipients_count$&"
27873 The &$rcpt_count$& variable increases by one for each RCPT command received.
27874 The &$recipients_count$& variable increases by one each time a RCPT command is
27875 accepted, so while an ACL for RCPT is being processed, it contains the number
27876 of previously accepted recipients. At DATA time (for both the DATA ACLs),
27877 &$rcpt_count$& contains the total number of RCPT commands, and
27878 &$recipients_count$& contains the total number of accepted recipients.
27879
27880
27881
27882
27883
27884 .section "Data for non-message ACLs" "SECTdatfornon"
27885 .cindex "&ACL;" "data for non-message ACL"
27886 .vindex &$smtp_command_argument$&
27887 .vindex &$smtp_command$&
27888 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
27889 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
27890 and the entire SMTP command is available in &$smtp_command$&.
27891 These variables can be tested using a &%condition%& condition. For example,
27892 here is an ACL for use with AUTH, which insists that either the session is
27893 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
27894 does not permit authentication methods that use cleartext passwords on
27895 unencrypted connections.
27896 .code
27897 acl_check_auth:
27898   accept encrypted = *
27899   accept condition = ${if eq{${uc:$smtp_command_argument}}\
27900                      {CRAM-MD5}}
27901   deny   message   = TLS encryption or CRAM-MD5 required
27902 .endd
27903 (Another way of applying this restriction is to arrange for the authenticators
27904 that use cleartext passwords not to be advertised when the connection is not
27905 encrypted. You can use the generic &%server_advertise_condition%& authenticator
27906 option to do this.)
27907
27908
27909
27910 .section "Format of an ACL" "SECID199"
27911 .cindex "&ACL;" "format of"
27912 .cindex "&ACL;" "verbs, definition of"
27913 An individual ACL consists of a number of statements. Each statement starts
27914 with a verb, optionally followed by a number of conditions and &"modifiers"&.
27915 Modifiers can change the way the verb operates, define error and log messages,
27916 set variables, insert delays, and vary the processing of accepted messages.
27917
27918 If all the conditions are met, the verb is obeyed. The same condition may be
27919 used (with different arguments) more than once in the same statement. This
27920 provides a means of specifying an &"and"& conjunction between conditions. For
27921 example:
27922 .code
27923 deny  dnslists = list1.example
27924 dnslists = list2.example
27925 .endd
27926 If there are no conditions, the verb is always obeyed. Exim stops evaluating
27927 the conditions and modifiers when it reaches a condition that fails. What
27928 happens then depends on the verb (and in one case, on a special modifier). Not
27929 all the conditions make sense at every testing point. For example, you cannot
27930 test a sender address in the ACL that is run for a VRFY command.
27931
27932
27933 .section "ACL verbs" "SECID200"
27934 The ACL verbs are as follows:
27935
27936 .ilist
27937 .cindex "&%accept%& ACL verb"
27938 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
27939 of the conditions are not met, what happens depends on whether &%endpass%&
27940 appears among the conditions (for syntax see below). If the failing condition
27941 is before &%endpass%&, control is passed to the next ACL statement; if it is
27942 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
27943 check a RCPT command:
27944 .code
27945 accept domains = +local_domains
27946 endpass
27947 verify = recipient
27948 .endd
27949 If the recipient domain does not match the &%domains%& condition, control
27950 passes to the next statement. If it does match, the recipient is verified, and
27951 the command is accepted if verification succeeds. However, if verification
27952 fails, the ACL yields &"deny"&, because the failing condition is after
27953 &%endpass%&.
27954
27955 The &%endpass%& feature has turned out to be confusing to many people, so its
27956 use is not recommended nowadays. It is always possible to rewrite an ACL so
27957 that &%endpass%& is not needed, and it is no longer used in the default
27958 configuration.
27959
27960 .cindex "&%message%& ACL modifier" "with &%accept%&"
27961 If a &%message%& modifier appears on an &%accept%& statement, its action
27962 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
27963 (when an &%accept%& verb either accepts or passes control to the next
27964 statement), &%message%& can be used to vary the message that is sent when an
27965 SMTP command is accepted. For example, in a RCPT ACL you could have:
27966 .display
27967 &`accept  `&<&'some conditions'&>
27968 &`        message = OK, I will allow you through today`&
27969 .endd
27970 You can specify an SMTP response code, optionally followed by an &"extended
27971 response code"& at the start of the message, but the first digit must be the
27972 same as would be sent by default, which is 2 for an &%accept%& verb.
27973
27974 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
27975 an error message that is used when access is denied. This behaviour is retained
27976 for backward compatibility, but current &"best practice"& is to avoid the use
27977 of &%endpass%&.
27978
27979
27980 .next
27981 .cindex "&%defer%& ACL verb"
27982 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
27983 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
27984 &%defer%& is the same as &%deny%&, because there is no way of sending a
27985 temporary error. For a RCPT command, &%defer%& is much the same as using a
27986 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
27987 be used in any ACL, and even for a recipient it might be a simpler approach.
27988
27989
27990 .next
27991 .cindex "&%deny%& ACL verb"
27992 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
27993 the conditions are not met, control is passed to the next ACL statement. For
27994 example,
27995 .code
27996 deny dnslists = blackholes.mail-abuse.org
27997 .endd
27998 rejects commands from hosts that are on a DNS black list.
27999
28000
28001 .next
28002 .cindex "&%discard%& ACL verb"
28003 &%discard%&: This verb behaves like &%accept%&, except that it returns
28004 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
28005 that are concerned with receiving messages. When all the conditions are true,
28006 the sending entity receives a &"success"& response. However, &%discard%& causes
28007 recipients to be discarded. If it is used in an ACL for RCPT, just the one
28008 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
28009 message's recipients are discarded. Recipients that are discarded before DATA
28010 do not appear in the log line when the &%received_recipients%& log selector is set.
28011
28012 If the &%log_message%& modifier is set when &%discard%& operates,
28013 its contents are added to the line that is automatically written to the log.
28014 The &%message%& modifier operates exactly as it does for &%accept%&.
28015
28016
28017 .next
28018 .cindex "&%drop%& ACL verb"
28019 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
28020 forcibly closed after the 5&'xx'& error message has been sent. For example:
28021 .code
28022 drop   message   = I don't take more than 20 RCPTs
28023        condition = ${if > {$rcpt_count}{20}}
28024 .endd
28025 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
28026 The connection is always dropped after sending a 550 response.
28027
28028 .next
28029 .cindex "&%require%& ACL verb"
28030 &%require%&: If all the conditions are met, control is passed to the next ACL
28031 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
28032 example, when checking a RCPT command,
28033 .code
28034 require message = Sender did not verify
28035         verify  = sender
28036 .endd
28037 passes control to subsequent statements only if the message's sender can be
28038 verified. Otherwise, it rejects the command. Note the positioning of the
28039 &%message%& modifier, before the &%verify%& condition. The reason for this is
28040 discussed in section &<<SECTcondmodproc>>&.
28041
28042 .next
28043 .cindex "&%warn%& ACL verb"
28044 &%warn%&: If all the conditions are true, a line specified by the
28045 &%log_message%& modifier is written to Exim's main log. Control always passes
28046 to the next ACL statement. If any condition is false, the log line is not
28047 written. If an identical log line is requested several times in the same
28048 message, only one copy is actually written to the log. If you want to force
28049 duplicates to be written, use the &%logwrite%& modifier instead.
28050
28051 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
28052 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
28053 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
28054 first failing condition. There is more about adding header lines in section
28055 &<<SECTaddheadacl>>&.
28056
28057 If any condition on a &%warn%& statement cannot be completed (that is, there is
28058 some sort of defer), the log line specified by &%log_message%& is not written.
28059 This does not include the case of a forced failure from a lookup, which
28060 is considered to be a successful completion. After a defer, no further
28061 conditions or modifiers in the &%warn%& statement are processed. The incident
28062 is logged, and the ACL continues to be processed, from the next statement
28063 onwards.
28064
28065
28066 .vindex "&$acl_verify_message$&"
28067 When one of the &%warn%& conditions is an address verification that fails, the
28068 text of the verification failure message is in &$acl_verify_message$&. If you
28069 want this logged, you must set it up explicitly. For example:
28070 .code
28071 warn   !verify = sender
28072        log_message = sender verify failed: $acl_verify_message
28073 .endd
28074 .endlist
28075
28076 At the end of each ACL there is an implicit unconditional &%deny%&.
28077
28078 As you can see from the examples above, the conditions and modifiers are
28079 written one to a line, with the first one on the same line as the verb, and
28080 subsequent ones on following lines. If you have a very long condition, you can
28081 continue it onto several physical lines by the usual backslash continuation
28082 mechanism. It is conventional to align the conditions vertically.
28083
28084
28085
28086 .section "ACL variables" "SECTaclvariables"
28087 .cindex "&ACL;" "variables"
28088 There are some special variables that can be set during ACL processing. They
28089 can be used to pass information between different ACLs, different invocations
28090 of the same ACL in the same SMTP connection, and between ACLs and the routers,
28091 transports, and filters that are used to deliver a message. The names of these
28092 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
28093 an underscore, but the remainder of the name can be any sequence of
28094 alphanumeric characters and underscores that you choose. There is no limit on
28095 the number of ACL variables. The two sets act as follows:
28096 .ilist
28097 The values of those variables whose names begin with &$acl_c$& persist
28098 throughout an SMTP connection. They are never reset. Thus, a value that is set
28099 while receiving one message is still available when receiving the next message
28100 on the same SMTP connection.
28101 .next
28102 The values of those variables whose names begin with &$acl_m$& persist only
28103 while a message is being received. They are reset afterwards. They are also
28104 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
28105 .endlist
28106
28107 When a message is accepted, the current values of all the ACL variables are
28108 preserved with the message and are subsequently made available at delivery
28109 time. The ACL variables are set by a modifier called &%set%&. For example:
28110 .code
28111 accept hosts = whatever
28112        set acl_m4 = some value
28113 accept authenticated = *
28114        set acl_c_auth = yes
28115 .endd
28116 &*Note*&: A leading dollar sign is not used when naming a variable that is to
28117 be set. If you want to set a variable without taking any action, you can use a
28118 &%warn%& verb without any other modifiers or conditions.
28119
28120 .oindex &%strict_acl_vars%&
28121 What happens if a syntactically valid but undefined ACL variable is
28122 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
28123 false (the default), an empty string is substituted; if it is true, an
28124 error is generated.
28125
28126 Versions of Exim before 4.64 have a limited set of numbered variables, but
28127 their names are compatible, so there is no problem with upgrading.
28128
28129
28130 .section "Condition and modifier processing" "SECTcondmodproc"
28131 .cindex "&ACL;" "conditions; processing"
28132 .cindex "&ACL;" "modifiers; processing"
28133 An exclamation mark preceding a condition negates its result. For example:
28134 .code
28135 deny   domains = *.dom.example
28136       !verify  = recipient
28137 .endd
28138 causes the ACL to return &"deny"& if the recipient domain ends in
28139 &'dom.example'& and the recipient address cannot be verified. Sometimes
28140 negation can be used on the right-hand side of a condition. For example, these
28141 two statements are equivalent:
28142 .code
28143 deny  hosts = !192.168.3.4
28144 deny !hosts =  192.168.3.4
28145 .endd
28146 However, for many conditions (&%verify%& being a good example), only left-hand
28147 side negation of the whole condition is possible.
28148
28149 The arguments of conditions and modifiers are expanded. A forced failure
28150 of an expansion causes a condition to be ignored, that is, it behaves as if the
28151 condition is true. Consider these two statements:
28152 .code
28153 accept  senders = ${lookup{$host_name}lsearch\
28154                   {/some/file}{$value}fail}
28155 accept  senders = ${lookup{$host_name}lsearch\
28156                   {/some/file}{$value}{}}
28157 .endd
28158 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
28159 the returned list is searched, but if the lookup fails the behaviour is
28160 different in the two cases. The &%fail%& in the first statement causes the
28161 condition to be ignored, leaving no further conditions. The &%accept%& verb
28162 therefore succeeds. The second statement, however, generates an empty list when
28163 the lookup fails. No sender can match an empty list, so the condition fails,
28164 and therefore the &%accept%& also fails.
28165
28166 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
28167 specify actions that are taken as the conditions for a statement are checked;
28168 others specify text for messages that are used when access is denied or a
28169 warning is generated. The &%control%& modifier affects the way an incoming
28170 message is handled.
28171
28172 The positioning of the modifiers in an ACL statement is important, because the
28173 processing of a verb ceases as soon as its outcome is known. Only those
28174 modifiers that have already been encountered will take effect. For example,
28175 consider this use of the &%message%& modifier:
28176 .code
28177 require message = Can't verify sender
28178         verify  = sender
28179         message = Can't verify recipient
28180         verify  = recipient
28181         message = This message cannot be used
28182 .endd
28183 If sender verification fails, Exim knows that the result of the statement is
28184 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
28185 so its text is used as the error message. If sender verification succeeds, but
28186 recipient verification fails, the second message is used. If recipient
28187 verification succeeds, the third message becomes &"current"&, but is never used
28188 because there are no more conditions to cause failure.
28189
28190 For the &%deny%& verb, on the other hand, it is always the last &%message%&
28191 modifier that is used, because all the conditions must be true for rejection to
28192 happen. Specifying more than one &%message%& modifier does not make sense, and
28193 the message can even be specified after all the conditions. For example:
28194 .code
28195 deny   hosts = ...
28196       !senders = *@my.domain.example
28197        message = Invalid sender from client host
28198 .endd
28199 The &"deny"& result does not happen until the end of the statement is reached,
28200 by which time Exim has set up the message.
28201
28202
28203
28204 .section "ACL modifiers" "SECTACLmodi"
28205 .cindex "&ACL;" "modifiers; list of"
28206 The ACL modifiers are as follows:
28207
28208 .vlist
28209 .vitem &*add_header*&&~=&~<&'text'&>
28210 This modifier specifies one or more header lines that are to be added to an
28211 incoming message, assuming, of course, that the message is ultimately
28212 accepted. For details, see section &<<SECTaddheadacl>>&.
28213
28214 .vitem &*continue*&&~=&~<&'text'&>
28215 .cindex "&%continue%& ACL modifier"
28216 .cindex "database" "updating in ACL"
28217 This modifier does nothing of itself, and processing of the ACL always
28218 continues with the next condition or modifier. The value of &%continue%& is in
28219 the side effects of expanding its argument. Typically this could be used to
28220 update a database. It is really just a syntactic tidiness, to avoid having to
28221 write rather ugly lines like this:
28222 .display
28223 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
28224 .endd
28225 Instead, all you need is
28226 .display
28227 &`continue = `&<&'some expansion'&>
28228 .endd
28229
28230 .vitem &*control*&&~=&~<&'text'&>
28231 .cindex "&%control%& ACL modifier"
28232 This modifier affects the subsequent processing of the SMTP connection or of an
28233 incoming message that is accepted. The effect of the first type of control
28234 lasts for the duration of the connection, whereas the effect of the second type
28235 lasts only until the current message has been received. The message-specific
28236 controls always apply to the whole message, not to individual recipients,
28237 even if the &%control%& modifier appears in a RCPT ACL.
28238
28239 As there are now quite a few controls that can be applied, they are described
28240 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
28241 in several different ways. For example:
28242
28243 . ==== As this is a nested list, any displays it contains must be indented
28244 . ==== as otherwise they are too far to the left. That comment applies only
28245 . ==== when xmlto and fop are used; formatting with sdop gets it right either
28246 . ==== way.
28247
28248 .ilist
28249 It can be at the end of an &%accept%& statement:
28250 .code
28251     accept  ...some conditions
28252             control = queue_only
28253 .endd
28254 In this case, the control is applied when this statement yields &"accept"&, in
28255 other words, when the conditions are all true.
28256
28257 .next
28258 It can be in the middle of an &%accept%& statement:
28259 .code
28260     accept  ...some conditions...
28261             control = queue_only
28262             ...some more conditions...
28263 .endd
28264 If the first set of conditions are true, the control is applied, even if the
28265 statement does not accept because one of the second set of conditions is false.
28266 In this case, some subsequent statement must yield &"accept"& for the control
28267 to be relevant.
28268
28269 .next
28270 It can be used with &%warn%& to apply the control, leaving the
28271 decision about accepting or denying to a subsequent verb. For
28272 example:
28273 .code
28274     warn    ...some conditions...
28275             control = freeze
28276     accept  ...
28277 .endd
28278 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
28279 &%logwrite%&, so it does not add anything to the message and does not write a
28280 log entry.
28281
28282 .next
28283 If you want to apply a control unconditionally, you can use it with a
28284 &%require%& verb. For example:
28285 .code
28286     require  control = no_multiline_responses
28287 .endd
28288 .endlist
28289
28290 .vitem &*delay*&&~=&~<&'time'&>
28291 .cindex "&%delay%& ACL modifier"
28292 .oindex "&%-bh%&"
28293 This modifier may appear in any ACL except notquit. It causes Exim to wait for
28294 the time interval before proceeding. However, when testing Exim using the
28295 &%-bh%& option, the delay is not actually imposed (an appropriate message is
28296 output instead). The time is given in the usual Exim notation, and the delay
28297 happens as soon as the modifier is processed. In an SMTP session, pending
28298 output is flushed before the delay is imposed.
28299
28300 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
28301 example:
28302 .code
28303 deny    ...some conditions...
28304         delay = 30s
28305 .endd
28306 The delay happens if all the conditions are true, before the statement returns
28307 &"deny"&. Compare this with:
28308 .code
28309 deny    delay = 30s
28310         ...some conditions...
28311 .endd
28312 which waits for 30s before processing the conditions. The &%delay%& modifier
28313 can also be used with &%warn%& and together with &%control%&:
28314 .code
28315 warn    ...some conditions...
28316         delay = 2m
28317         control = freeze
28318 accept  ...
28319 .endd
28320
28321 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
28322 responses to several commands are no longer buffered and sent in one packet (as
28323 they would normally be) because all output is flushed before imposing the
28324 delay. This optimization is disabled so that a number of small delays do not
28325 appear to the client as one large aggregated delay that might provoke an
28326 unwanted timeout. You can, however, disable output flushing for &%delay%& by
28327 using a &%control%& modifier to set &%no_delay_flush%&.
28328
28329
28330 .vitem &*endpass*&
28331 .cindex "&%endpass%& ACL modifier"
28332 This modifier, which has no argument, is recognized only in &%accept%& and
28333 &%discard%& statements. It marks the boundary between the conditions whose
28334 failure causes control to pass to the next statement, and the conditions whose
28335 failure causes the ACL to return &"deny"&. This concept has proved to be
28336 confusing to some people, so the use of &%endpass%& is no longer recommended as
28337 &"best practice"&. See the description of &%accept%& above for more details.
28338
28339
28340 .vitem &*log_message*&&~=&~<&'text'&>
28341 .cindex "&%log_message%& ACL modifier"
28342 This modifier sets up a message that is used as part of the log message if the
28343 ACL denies access or a &%warn%& statement's conditions are true. For example:
28344 .code
28345 require log_message = wrong cipher suite $tls_in_cipher
28346         encrypted   = DES-CBC3-SHA
28347 .endd
28348 &%log_message%& is also used when recipients are discarded by &%discard%&. For
28349 example:
28350 .display
28351 &`discard `&<&'some conditions'&>
28352 &`        log_message = Discarded $local_part@$domain because...`&
28353 .endd
28354 When access is denied, &%log_message%& adds to any underlying error message
28355 that may exist because of a condition failure. For example, while verifying a
28356 recipient address, a &':fail:'& redirection might have already set up a
28357 message.
28358
28359 The message may be defined before the conditions to which it applies, because
28360 the string expansion does not happen until Exim decides that access is to be
28361 denied. This means that any variables that are set by the condition are
28362 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
28363 variables are set after a DNS black list lookup succeeds. If the expansion of
28364 &%log_message%& fails, or if the result is an empty string, the modifier is
28365 ignored.
28366
28367 .vindex "&$acl_verify_message$&"
28368 If you want to use a &%warn%& statement to log the result of an address
28369 verification, you can use &$acl_verify_message$& to include the verification
28370 error message.
28371
28372 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
28373 the start of the logged message. If the same warning log message is requested
28374 more than once while receiving  a single email message, only one copy is
28375 actually logged. If you want to log multiple copies, use &%logwrite%& instead
28376 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
28377 is logged for a successful &%warn%& statement.
28378
28379 If &%log_message%& is not present and there is no underlying error message (for
28380 example, from the failure of address verification), but &%message%& is present,
28381 the &%message%& text is used for logging rejections. However, if any text for
28382 logging contains newlines, only the first line is logged. In the absence of
28383 both &%log_message%& and &%message%&, a default built-in message is used for
28384 logging rejections.
28385
28386
28387 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
28388 .cindex "&%log_reject_target%& ACL modifier"
28389 .cindex "logging in ACL" "specifying which log"
28390 This modifier makes it possible to specify which logs are used for messages
28391 about ACL rejections. Its argument is a colon-separated list of words that can
28392 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
28393 may be empty, in which case a rejection is not logged at all. For example, this
28394 ACL fragment writes no logging information when access is denied:
28395 .display
28396 &`deny `&<&'some conditions'&>
28397 &`     log_reject_target =`&
28398 .endd
28399 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
28400 permanent and temporary rejections. Its effect lasts for the rest of the
28401 current ACL.
28402
28403
28404 .vitem &*logwrite*&&~=&~<&'text'&>
28405 .cindex "&%logwrite%& ACL modifier"
28406 .cindex "logging in ACL" "immediate"
28407 This modifier writes a message to a log file as soon as it is encountered when
28408 processing an ACL. (Compare &%log_message%&, which, except in the case of
28409 &%warn%& and &%discard%&, is used only if the ACL statement denies
28410 access.) The &%logwrite%& modifier can be used to log special incidents in
28411 ACLs. For example:
28412 .display
28413 &`accept `&<&'some special conditions'&>
28414 &`       control  = freeze`&
28415 &`       logwrite = froze message because ...`&
28416 .endd
28417 By default, the message is written to the main log. However, it may begin
28418 with a colon, followed by a comma-separated list of log names, and then
28419 another colon, to specify exactly which logs are to be written. For
28420 example:
28421 .code
28422 logwrite = :main,reject: text for main and reject logs
28423 logwrite = :panic: text for panic log only
28424 .endd
28425
28426
28427 .vitem &*message*&&~=&~<&'text'&>
28428 .cindex "&%message%& ACL modifier"
28429 This modifier sets up a text string that is expanded and used as a response
28430 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
28431 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
28432 there is some complication if &%endpass%& is involved; see the description of
28433 &%accept%& for details.)
28434
28435 The expansion of the message happens at the time Exim decides that the ACL is
28436 to end, not at the time it processes &%message%&. If the expansion fails, or
28437 generates an empty string, the modifier is ignored. Here is an example where
28438 &%message%& must be specified first, because the ACL ends with a rejection if
28439 the &%hosts%& condition fails:
28440 .code
28441 require  message = Host not recognized
28442          hosts = 10.0.0.0/8
28443 .endd
28444 (Once a condition has failed, no further conditions or modifiers are
28445 processed.)
28446
28447 .cindex "SMTP" "error codes"
28448 .oindex "&%smtp_banner%&
28449 For ACLs that are triggered by SMTP commands, the message is returned as part
28450 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
28451 is meaningful only for SMTP, as no message is returned when a non-SMTP message
28452 is accepted. In the case of the connect ACL, accepting with a message modifier
28453 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
28454 accept message may not contain more than one line (otherwise it will be
28455 truncated at the first newline and a panic logged), and it cannot affect the
28456 EHLO options.
28457
28458 When SMTP is involved, the message may begin with an overriding response code,
28459 consisting of three digits optionally followed by an &"extended response code"&
28460 of the form &'n.n.n'&, each code being followed by a space. For example:
28461 .code
28462 deny  message = 599 1.2.3 Host not welcome
28463       hosts = 192.168.34.0/24
28464 .endd
28465 The first digit of the supplied response code must be the same as would be sent
28466 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
28467 access, but for the predata ACL, note that the default success code is 354, not
28468 2&'xx'&.
28469
28470 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
28471 the message modifier cannot override the 221 response code.
28472
28473 The text in a &%message%& modifier is literal; any quotes are taken as
28474 literals, but because the string is expanded, backslash escapes are processed
28475 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
28476 response.
28477
28478 .vindex "&$acl_verify_message$&"
28479 For ACLs that are called by an &%acl =%& ACL condition, the message is
28480 stored in &$acl_verify_message$&, from which the calling ACL may use it.
28481
28482 If &%message%& is used on a statement that verifies an address, the message
28483 specified overrides any message that is generated by the verification process.
28484 However, the original message is available in the variable
28485 &$acl_verify_message$&, so you can incorporate it into your message if you
28486 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
28487 routers to be passed back as part of the SMTP response, you should either not
28488 use a &%message%& modifier, or make use of &$acl_verify_message$&.
28489
28490 For compatibility with previous releases of Exim, a &%message%& modifier that
28491 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
28492 modifier, but this usage is now deprecated. However, &%message%& acts only when
28493 all the conditions are true, wherever it appears in an ACL command, whereas
28494 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
28495 &%warn%& in an ACL that is not concerned with receiving a message, it has no
28496 effect.
28497
28498
28499 .vitem &*remove_header*&&~=&~<&'text'&>
28500 This modifier specifies one or more header names in a colon-separated list
28501  that are to be removed from an incoming message, assuming, of course, that
28502 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
28503
28504
28505 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
28506 .cindex "&%set%& ACL modifier"
28507 This modifier puts a value into one of the ACL variables (see section
28508 &<<SECTaclvariables>>&).
28509
28510
28511 .vitem &*udpsend*&&~=&~<&'parameters'&>
28512 This modifier sends a UDP packet, for purposes such as statistics
28513 collection or behaviour monitoring. The parameters are expanded, and
28514 the result of the expansion must be a colon-separated list consisting
28515 of a destination server, port number, and the packet contents. The
28516 server can be specified as a host name or IPv4 or IPv6 address. The
28517 separator can be changed with the usual angle bracket syntax. For
28518 example, you might want to collect information on which hosts connect
28519 when:
28520 .code
28521 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
28522              $tod_zulu $sender_host_address
28523 .endd
28524 .endlist
28525
28526
28527
28528
28529 .section "Use of the control modifier" "SECTcontrols"
28530 .cindex "&%control%& ACL modifier"
28531 The &%control%& modifier supports the following settings:
28532
28533 .vlist
28534 .vitem &*control&~=&~allow_auth_unadvertised*&
28535 This modifier allows a client host to use the SMTP AUTH command even when it
28536 has not been advertised in response to EHLO. Furthermore, because there are
28537 apparently some really broken clients that do this, Exim will accept AUTH after
28538 HELO (rather than EHLO) when this control is set. It should be used only if you
28539 really need it, and you should limit its use to those broken clients that do
28540 not work without it. For example:
28541 .code
28542 warn hosts   = 192.168.34.25
28543      control = allow_auth_unadvertised
28544 .endd
28545 Normally, when an Exim server receives an AUTH command, it checks the name of
28546 the authentication mechanism that is given in the command to ensure that it
28547 matches an advertised mechanism. When this control is set, the check that a
28548 mechanism has been advertised is bypassed. Any configured mechanism can be used
28549 by the client. This control is permitted only in the connection and HELO ACLs.
28550
28551
28552 .vitem &*control&~=&~caseful_local_part*& &&&
28553        &*control&~=&~caselower_local_part*&
28554 .cindex "&ACL;" "case of local part in"
28555 .cindex "case of local parts"
28556 .vindex "&$local_part$&"
28557 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
28558 (that is, during RCPT processing). By default, the contents of &$local_part$&
28559 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
28560 any uppercase letters in the original local part are restored in &$local_part$&
28561 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
28562 is encountered.
28563
28564 These controls affect only the current recipient. Moreover, they apply only to
28565 local part handling that takes place directly in the ACL (for example, as a key
28566 in lookups). If a test to verify the recipient is obeyed, the case-related
28567 handling of the local part during the verification is controlled by the router
28568 configuration (see the &%caseful_local_part%& generic router option).
28569
28570 This facility could be used, for example, to add a spam score to local parts
28571 containing upper case letters. For example, using &$acl_m4$& to accumulate the
28572 spam score:
28573 .code
28574 warn  control = caseful_local_part
28575       set acl_m4 = ${eval:\
28576                      $acl_m4 + \
28577                      ${if match{$local_part}{[A-Z]}{1}{0}}\
28578                     }
28579       control = caselower_local_part
28580 .endd
28581 Notice that we put back the lower cased version afterwards, assuming that
28582 is what is wanted for subsequent tests.
28583
28584
28585 .vitem &*control&~=&~cutthrough_delivery*&
28586 .cindex "&ACL;" "cutthrough routing"
28587 .cindex "cutthrough" "requesting"
28588 This option requests delivery be attempted while the item is being received.
28589
28590 The option is usable in the RCPT ACL.
28591 If enabled for a message received via smtp and routed to an smtp transport,
28592 and only one transport, interface, destination host and port combination
28593 is used for all recipients of the message,
28594 then the delivery connection is made while the receiving connection is open
28595 and data is copied from one to the other.
28596
28597 An attempt to set this option for any recipient but the first
28598 for a mail will be quietly ignored.
28599 If a recipient-verify callout connection is subsequently
28600 requested in the same ACL it is held open and used for
28601 any subsequent recipients and the data,
28602 otherwise one is made after the initial RCPT ACL completes.
28603
28604 Note that routers are used in verify mode,
28605 and cannot depend on content of received headers.
28606 Note also that headers cannot be
28607 modified by any of the post-data ACLs (DATA, MIME and DKIM).
28608 Headers may be modified by routers (subject to the above) and transports.
28609
28610 Cutthrough delivery is not supported via transport-filters or when DKIM signing
28611 of outgoing messages is done, because it sends data to the ultimate destination
28612 before the entire message has been received from the source.
28613 It is not supported for messages received with the SMTP PRDR option in use.
28614
28615 Should the ultimate destination system positively accept or reject the mail,
28616 a corresponding indication is given to the source system and nothing is queued.
28617 If there is a temporary error the item is queued for later delivery in the
28618 usual fashion. If the item is successfully delivered in cutthrough mode
28619 the delivery log lines are tagged with ">>" rather than "=>" and appear
28620 before the acceptance "<=" line.
28621
28622 Delivery in this mode avoids the generation of a bounce mail to a
28623 (possibly faked)
28624 sender when the destination system is doing content-scan based rejection.
28625
28626
28627 .vitem &*control&~=&~debug/*&<&'options'&>
28628 .cindex "&ACL;" "enabling debug logging"
28629 .cindex "debugging" "enabling from an ACL"
28630 This control turns on debug logging, almost as though Exim had been invoked
28631 with &`-d`&, with the output going to a new logfile, by default called
28632 &'debuglog'&.  The filename can be adjusted with the &'tag'& option, which
28633 may access any variables already defined.  The logging may be adjusted with
28634 the &'opts'& option, which takes the same values as the &`-d`& command-line
28635 option.  Some examples (which depend on variables that don't exist in all
28636 contexts):
28637 .code
28638       control = debug
28639       control = debug/tag=.$sender_host_address
28640       control = debug/opts=+expand+acl
28641       control = debug/tag=.$message_exim_id/opts=+expand
28642 .endd
28643
28644
28645 .vitem &*control&~=&~dkim_disable_verify*&
28646 .cindex "disable DKIM verify"
28647 .cindex "DKIM" "disable verify"
28648 This control turns off DKIM verification processing entirely.  For details on
28649 the operation and configuration of DKIM, see chapter &<<CHAPdkim>>&.
28650
28651
28652 .vitem &*control&~=&~dscp/*&<&'value'&>
28653 .cindex "&ACL;" "setting DSCP value"
28654 .cindex "DSCP" "inbound"
28655 This option causes the DSCP value associated with the socket for the inbound
28656 connection to be adjusted to a given value, given as one of a number of fixed
28657 strings or to numeric value.
28658 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
28659 Common values include &`throughput`&, &`mincost`&, and on newer systems
28660 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
28661
28662 The outbound packets from Exim will be marked with this value in the header
28663 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
28664 that these values will have any effect, not be stripped by networking
28665 equipment, or do much of anything without cooperation with your Network
28666 Engineer and those of all network operators between the source and destination.
28667
28668
28669 .vitem &*control&~=&~enforce_sync*& &&&
28670        &*control&~=&~no_enforce_sync*&
28671 .cindex "SMTP" "synchronization checking"
28672 .cindex "synchronization checking in SMTP"
28673 These controls make it possible to be selective about when SMTP synchronization
28674 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
28675 state of the switch (it is true by default). See the description of this option
28676 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
28677
28678 The effect of these two controls lasts for the remainder of the SMTP
28679 connection. They can appear in any ACL except the one for the non-SMTP
28680 messages. The most straightforward place to put them is in the ACL defined by
28681 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
28682 before the first synchronization check. The expected use is to turn off the
28683 synchronization checks for badly-behaved hosts that you nevertheless need to
28684 work with.
28685
28686
28687 .vitem &*control&~=&~fakedefer/*&<&'message'&>
28688 .cindex "fake defer"
28689 .cindex "defer, fake"
28690 This control works in exactly the same way as &%fakereject%& (described below)
28691 except that it causes an SMTP 450 response after the message data instead of a
28692 550 response. You must take care when using &%fakedefer%& because it causes the
28693 messages to be duplicated when the sender retries. Therefore, you should not
28694 use &%fakedefer%& if the message is to be delivered normally.
28695
28696 .vitem &*control&~=&~fakereject/*&<&'message'&>
28697 .cindex "fake rejection"
28698 .cindex "rejection, fake"
28699 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
28700 words, only when an SMTP message is being received. If Exim accepts the
28701 message, instead the final 250 response, a 550 rejection message is sent.
28702 However, Exim proceeds to deliver the message as normal. The control applies
28703 only to the current message, not to any subsequent ones that may be received in
28704 the same SMTP connection.
28705
28706 The text for the 550 response is taken from the &%control%& modifier. If no
28707 message is supplied, the following is used:
28708 .code
28709 550-Your message has been rejected but is being
28710 550-kept for evaluation.
28711 550-If it was a legitimate message, it may still be
28712 550 delivered to the target recipient(s).
28713 .endd
28714 This facility should be used with extreme caution.
28715
28716 .vitem &*control&~=&~freeze*&
28717 .cindex "frozen messages" "forcing in ACL"
28718 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
28719 other words, only when a message is being received. If the message is accepted,
28720 it is placed on Exim's queue and frozen. The control applies only to the
28721 current message, not to any subsequent ones that may be received in the same
28722 SMTP connection.
28723
28724 This modifier can optionally be followed by &`/no_tell`&. If the global option
28725 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
28726 is told about the freezing), provided all the &*control=freeze*& modifiers that
28727 are obeyed for the current message have the &`/no_tell`& option.
28728
28729 .vitem &*control&~=&~no_delay_flush*&
28730 .cindex "SMTP" "output flushing, disabling for delay"
28731 Exim normally flushes SMTP output before implementing a delay in an ACL, to
28732 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
28733 use. This control, as long as it is encountered before the &%delay%& modifier,
28734 disables such output flushing.
28735
28736 .vitem &*control&~=&~no_callout_flush*&
28737 .cindex "SMTP" "output flushing, disabling for callout"
28738 Exim normally flushes SMTP output before performing a callout in an ACL, to
28739 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
28740 use. This control, as long as it is encountered before the &%verify%& condition
28741 that causes the callout, disables such output flushing.
28742
28743 .vitem &*control&~=&~no_mbox_unspool*&
28744 This control is available when Exim is compiled with the content scanning
28745 extension. Content scanning may require a copy of the current message, or parts
28746 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
28747 or spam scanner. Normally, such copies are deleted when they are no longer
28748 needed. If this control is set, the copies are not deleted. The control applies
28749 only to the current message, not to any subsequent ones that may be received in
28750 the same SMTP connection. It is provided for debugging purposes and is unlikely
28751 to be useful in production.
28752
28753 .vitem &*control&~=&~no_multiline_responses*&
28754 .cindex "multiline responses, suppressing"
28755 This control is permitted for any ACL except the one for non-SMTP messages.
28756 It seems that there are broken clients in use that cannot handle multiline
28757 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
28758
28759 If this control is set, multiline SMTP responses from ACL rejections are
28760 suppressed. One way of doing this would have been to put out these responses as
28761 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
28762 (&"use multiline responses for more"& it says &-- ha!), and some of the
28763 responses might get close to that. So this facility, which is after all only a
28764 sop to broken clients, is implemented by doing two very easy things:
28765
28766 .ilist
28767 Extra information that is normally output as part of a rejection caused by
28768 sender verification failure is omitted. Only the final line (typically &"sender
28769 verification failed"&) is sent.
28770 .next
28771 If a &%message%& modifier supplies a multiline response, only the first
28772 line is output.
28773 .endlist
28774
28775 The setting of the switch can, of course, be made conditional on the
28776 calling host. Its effect lasts until the end of the SMTP connection.
28777
28778 .vitem &*control&~=&~no_pipelining*&
28779 .cindex "PIPELINING" "suppressing advertising"
28780 This control turns off the advertising of the PIPELINING extension to SMTP in
28781 the current session. To be useful, it must be obeyed before Exim sends its
28782 response to an EHLO command. Therefore, it should normally appear in an ACL
28783 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
28784 &%pipelining_advertise_hosts%&.
28785
28786 .vitem &*control&~=&~queue_only*&
28787 .oindex "&%queue_only%&"
28788 .cindex "queueing incoming messages"
28789 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
28790 other words, only when a message is being received. If the message is accepted,
28791 it is placed on Exim's queue and left there for delivery by a subsequent queue
28792 runner. No immediate delivery process is started. In other words, it has the
28793 effect as the &%queue_only%& global option. However, the control applies only
28794 to the current message, not to any subsequent ones that may be received in the
28795 same SMTP connection.
28796
28797 .vitem &*control&~=&~submission/*&<&'options'&>
28798 .cindex "message" "submission"
28799 .cindex "submission mode"
28800 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
28801 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
28802 the current message is a submission from a local MUA. In this case, Exim
28803 operates in &"submission mode"&, and applies certain fixups to the message if
28804 necessary. For example, it adds a &'Date:'& header line if one is not present.
28805 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
28806 late (the message has already been created).
28807
28808 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
28809 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
28810 submission mode; the available options for this control are described there.
28811 The control applies only to the current message, not to any subsequent ones
28812 that may be received in the same SMTP connection.
28813
28814 .vitem &*control&~=&~suppress_local_fixups*&
28815 .cindex "submission fixups, suppressing"
28816 This control applies to locally submitted (non TCP/IP) messages, and is the
28817 complement of &`control = submission`&. It disables the fixups that are
28818 normally applied to locally-submitted messages. Specifically:
28819
28820 .ilist
28821 Any &'Sender:'& header line is left alone (in this respect, it is a
28822 dynamic version of &%local_sender_retain%&).
28823 .next
28824 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
28825 .next
28826 There is no check that &'From:'& corresponds to the actual sender.
28827 .endlist ilist
28828
28829 This control may be useful when a remotely-originated message is accepted,
28830 passed to some scanning program, and then re-submitted for delivery. It can be
28831 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
28832 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
28833 data is read.
28834
28835 &*Note:*& This control applies only to the current message, not to any others
28836 that are being submitted at the same time using &%-bs%& or &%-bS%&.
28837
28838 .new
28839 .vitem &*control&~=&~utf8_downconvert*&
28840 This control enables conversion of UTF-8 in message addresses
28841 to a-label form.
28842 For details see &<<SECTi18nMTA>>&.
28843 .wen
28844 .endlist vlist
28845
28846
28847 .section "Summary of message fixup control" "SECTsummesfix"
28848 All four possibilities for message fixups can be specified:
28849
28850 .ilist
28851 Locally submitted, fixups applied: the default.
28852 .next
28853 Locally submitted, no fixups applied: use
28854 &`control = suppress_local_fixups`&.
28855 .next
28856 Remotely submitted, no fixups applied: the default.
28857 .next
28858 Remotely submitted, fixups applied: use &`control = submission`&.
28859 .endlist
28860
28861
28862
28863 .section "Adding header lines in ACLs" "SECTaddheadacl"
28864 .cindex "header lines" "adding in an ACL"
28865 .cindex "header lines" "position of added lines"
28866 .cindex "&%add_header%& ACL modifier"
28867 The &%add_header%& modifier can be used to add one or more extra header lines
28868 to an incoming message, as in this example:
28869 .code
28870 warn dnslists = sbl.spamhaus.org : \
28871                 dialup.mail-abuse.org
28872      add_header = X-blacklisted-at: $dnslist_domain
28873 .endd
28874 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
28875 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
28876 receiving a message). The message must ultimately be accepted for
28877 &%add_header%& to have any significant effect. You can use &%add_header%& with
28878 any ACL verb, including &%deny%& (though this is potentially useful only in a
28879 RCPT ACL).
28880
28881 Headers will not be added to the message if the modifier is used in
28882 DATA, MIME or DKIM ACLs for messages delivered by cutthrough routing.
28883
28884 Leading and trailing newlines are removed from
28885 the data for the &%add_header%& modifier; if it then
28886 contains one or more newlines that
28887 are not followed by a space or a tab, it is assumed to contain multiple header
28888 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
28889 front of any line that is not a valid header line.
28890
28891 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
28892 They are added to the message before processing the DATA and MIME ACLs.
28893 However, if an identical header line is requested more than once, only one copy
28894 is actually added to the message. Further header lines may be accumulated
28895 during the DATA and MIME ACLs, after which they are added to the message, again
28896 with duplicates suppressed. Thus, it is possible to add two identical header
28897 lines to an SMTP message, but only if one is added before DATA and one after.
28898 In the case of non-SMTP messages, new headers are accumulated during the
28899 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
28900 message is rejected after DATA or by the non-SMTP ACL, all added header lines
28901 are included in the entry that is written to the reject log.
28902
28903 .cindex "header lines" "added; visibility of"
28904 Header lines are not visible in string expansions
28905 of message headers
28906 until they are added to the
28907 message. It follows that header lines defined in the MAIL, RCPT, and predata
28908 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
28909 header lines that are added by the DATA or MIME ACLs are not visible in those
28910 ACLs. Because of this restriction, you cannot use header lines as a way of
28911 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
28912 this, you can use ACL variables, as described in section
28913 &<<SECTaclvariables>>&.
28914
28915 The list of headers yet to be added is given by the &%$headers_added%& variable.
28916
28917 The &%add_header%& modifier acts immediately as it is encountered during the
28918 processing of an ACL. Notice the difference between these two cases:
28919 .display
28920 &`accept add_header = ADDED: some text`&
28921 &`       `&<&'some condition'&>
28922
28923 &`accept `&<&'some condition'&>
28924 &`       add_header = ADDED: some text`&
28925 .endd
28926 In the first case, the header line is always added, whether or not the
28927 condition is true. In the second case, the header line is added only if the
28928 condition is true. Multiple occurrences of &%add_header%& may occur in the same
28929 ACL statement. All those that are encountered before a condition fails are
28930 honoured.
28931
28932 .cindex "&%warn%& ACL verb"
28933 For compatibility with previous versions of Exim, a &%message%& modifier for a
28934 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
28935 effect only if all the conditions are true, even if it appears before some of
28936 them. Furthermore, only the last occurrence of &%message%& is honoured. This
28937 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
28938 are present on a &%warn%& verb, both are processed according to their
28939 specifications.
28940
28941 By default, new header lines are added to a message at the end of the existing
28942 header lines. However, you can specify that any particular header line should
28943 be added right at the start (before all the &'Received:'& lines), immediately
28944 after the first block of &'Received:'& lines, or immediately before any line
28945 that is not a &'Received:'& or &'Resent-something:'& header.
28946
28947 This is done by specifying &":at_start:"&, &":after_received:"&, or
28948 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
28949 header line, respectively. (Header text cannot start with a colon, as there has
28950 to be a header name first.) For example:
28951 .code
28952 warn add_header = \
28953        :after_received:X-My-Header: something or other...
28954 .endd
28955 If more than one header line is supplied in a single &%add_header%& modifier,
28956 each one is treated independently and can therefore be placed differently. If
28957 you add more than one line at the start, or after the Received: block, they end
28958 up in reverse order.
28959
28960 &*Warning*&: This facility currently applies only to header lines that are
28961 added in an ACL. It does NOT work for header lines that are added in a
28962 system filter or in a router or transport.
28963
28964
28965
28966 .section "Removing header lines in ACLs" "SECTremoveheadacl"
28967 .cindex "header lines" "removing in an ACL"
28968 .cindex "header lines" "position of removed lines"
28969 .cindex "&%remove_header%& ACL modifier"
28970 The &%remove_header%& modifier can be used to remove one or more header lines
28971 from an incoming message, as in this example:
28972 .code
28973 warn   message        = Remove internal headers
28974        remove_header  = x-route-mail1 : x-route-mail2
28975 .endd
28976 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
28977 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
28978 receiving a message). The message must ultimately be accepted for
28979 &%remove_header%& to have any significant effect. You can use &%remove_header%&
28980 with any ACL verb, including &%deny%&, though this is really not useful for
28981 any verb that doesn't result in a delivered message.
28982
28983 Headers will not be removed to the message if the modifier is used in
28984 DATA, MIME or DKIM ACLs for messages delivered by cutthrough routing.
28985
28986 More than one header can be removed at the same time by using a colon separated
28987 list of header names. The header matching is case insensitive. Wildcards are
28988 not permitted, nor is list expansion performed, so you cannot use hostlists to
28989 create a list of headers, however both connection and message variable expansion
28990 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
28991 .code
28992 warn   hosts           = +internal_hosts
28993        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
28994 warn   message         = Remove internal headers
28995        remove_header   = $acl_c_ihdrs
28996 .endd
28997 Removed header lines are accumulated during the MAIL, RCPT, and predata ACLs.
28998 They are removed from the message before processing the DATA and MIME ACLs.
28999 There is no harm in attempting to remove the same header twice nor is removing
29000 a non-existent header. Further header lines to be removed may be accumulated
29001 during the DATA and MIME ACLs, after which they are removed from the message,
29002 if present. In the case of non-SMTP messages, headers to be removed are
29003 accumulated during the non-SMTP ACLs, and are removed from the message after
29004 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
29005 ACL, there really is no effect because there is no logging of what headers
29006 would have been removed.
29007
29008 .cindex "header lines" "removed; visibility of"
29009 Header lines are not visible in string expansions until the DATA phase when it
29010 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
29011 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
29012 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
29013 this restriction, you cannot use header lines as a way of controlling data
29014 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
29015 you should instead use ACL variables, as described in section
29016 &<<SECTaclvariables>>&.
29017
29018 The &%remove_header%& modifier acts immediately as it is encountered during the
29019 processing of an ACL. Notice the difference between these two cases:
29020 .display
29021 &`accept remove_header = X-Internal`&
29022 &`       `&<&'some condition'&>
29023
29024 &`accept `&<&'some condition'&>
29025 &`       remove_header = X-Internal`&
29026 .endd
29027 In the first case, the header line is always removed, whether or not the
29028 condition is true. In the second case, the header line is removed only if the
29029 condition is true. Multiple occurrences of &%remove_header%& may occur in the
29030 same ACL statement. All those that are encountered before a condition fails
29031 are honoured.
29032
29033 &*Warning*&: This facility currently applies only to header lines that are
29034 present during ACL processing. It does NOT remove header lines that are added
29035 in a system filter or in a router or transport.
29036
29037
29038
29039
29040 .section "ACL conditions" "SECTaclconditions"
29041 .cindex "&ACL;" "conditions; list of"
29042 Some of the conditions listed in this section are available only when Exim is
29043 compiled with the content-scanning extension. They are included here briefly
29044 for completeness. More detailed descriptions can be found in the discussion on
29045 content scanning in chapter &<<CHAPexiscan>>&.
29046
29047 Not all conditions are relevant in all circumstances. For example, testing
29048 senders and recipients does not make sense in an ACL that is being run as the
29049 result of the arrival of an ETRN command, and checks on message headers can be
29050 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
29051 can use the same condition (with different parameters) more than once in the
29052 same ACL statement. This provides a way of specifying an &"and"& conjunction.
29053 The conditions are as follows:
29054
29055
29056 .vlist
29057 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
29058 .cindex "&ACL;" "nested"
29059 .cindex "&ACL;" "indirect"
29060 .cindex "&ACL;" "arguments"
29061 .cindex "&%acl%& ACL condition"
29062 The possible values of the argument are the same as for the
29063 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
29064 &"accept"& the condition is true; if it returns &"deny"& the condition is
29065 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
29066 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
29067 condition false. This means that further processing of the &%warn%& verb
29068 ceases, but processing of the ACL continues.
29069
29070 If the argument is a named ACL, up to nine space-separated optional values
29071 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
29072 and $acl_narg is set to the count of values.
29073 Previous values of these variables are restored after the call returns.
29074 The name and values are expanded separately.
29075 Note that spaces in complex expansions which are used as arguments
29076 will act as argument separators.
29077
29078 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
29079 the connection is dropped. If it returns &"discard"&, the verb must be
29080 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
29081 conditions are tested.
29082
29083 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
29084 loops. This condition allows you to use different ACLs in different
29085 circumstances. For example, different ACLs can be used to handle RCPT commands
29086 for different local users or different local domains.
29087
29088 .vitem &*authenticated&~=&~*&<&'string&~list'&>
29089 .cindex "&%authenticated%& ACL condition"
29090 .cindex "authentication" "ACL checking"
29091 .cindex "&ACL;" "testing for authentication"
29092 If the SMTP connection is not authenticated, the condition is false. Otherwise,
29093 the name of the authenticator is tested against the list. To test for
29094 authentication by any authenticator, you can set
29095 .code
29096 authenticated = *
29097 .endd
29098
29099 .vitem &*condition&~=&~*&<&'string'&>
29100 .cindex "&%condition%& ACL condition"
29101 .cindex "customizing" "ACL condition"
29102 .cindex "&ACL;" "customized test"
29103 .cindex "&ACL;" "testing, customized"
29104 This feature allows you to make up custom conditions. If the result of
29105 expanding the string is an empty string, the number zero, or one of the strings
29106 &"no"& or &"false"&, the condition is false. If the result is any non-zero
29107 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
29108 any other value, some error is assumed to have occurred, and the ACL returns
29109 &"defer"&. However, if the expansion is forced to fail, the condition is
29110 ignored. The effect is to treat it as true, whether it is positive or
29111 negative.
29112
29113 .vitem &*decode&~=&~*&<&'location'&>
29114 .cindex "&%decode%& ACL condition"
29115 This condition is available only when Exim is compiled with the
29116 content-scanning extension, and it is allowed only in the ACL defined by
29117 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
29118 If all goes well, the condition is true. It is false only if there are
29119 problems such as a syntax error or a memory shortage. For more details, see
29120 chapter &<<CHAPexiscan>>&.
29121
29122 .vitem &*demime&~=&~*&<&'extension&~list'&>
29123 .cindex "&%demime%& ACL condition"
29124 This condition is available only when Exim is compiled with the
29125 content-scanning extension. Its use is described in section
29126 &<<SECTdemimecond>>&.
29127
29128 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
29129 .cindex "&%dnslists%& ACL condition"
29130 .cindex "DNS list" "in ACL"
29131 .cindex "black list (DNS)"
29132 .cindex "&ACL;" "testing a DNS list"
29133 This condition checks for entries in DNS black lists. These are also known as
29134 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
29135 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
29136 different variants of this condition to describe briefly here. See sections
29137 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
29138
29139 .vitem &*domains&~=&~*&<&'domain&~list'&>
29140 .cindex "&%domains%& ACL condition"
29141 .cindex "domain" "ACL checking"
29142 .cindex "&ACL;" "testing a recipient domain"
29143 .vindex "&$domain_data$&"
29144 This condition is relevant only after a RCPT command. It checks that the domain
29145 of the recipient address is in the domain list. If percent-hack processing is
29146 enabled, it is done before this test is done. If the check succeeds with a
29147 lookup, the result of the lookup is placed in &$domain_data$& until the next
29148 &%domains%& test.
29149
29150 &*Note carefully*& (because many people seem to fall foul of this): you cannot
29151 use &%domains%& in a DATA ACL.
29152
29153
29154 .vitem &*encrypted&~=&~*&<&'string&~list'&>
29155 .cindex "&%encrypted%& ACL condition"
29156 .cindex "encryption" "checking in an ACL"
29157 .cindex "&ACL;" "testing for encryption"
29158 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
29159 name of the cipher suite in use is tested against the list. To test for
29160 encryption without testing for any specific cipher suite(s), set
29161 .code
29162 encrypted = *
29163 .endd
29164
29165
29166 .vitem &*hosts&~=&~*&<&'host&~list'&>
29167 .cindex "&%hosts%& ACL condition"
29168 .cindex "host" "ACL checking"
29169 .cindex "&ACL;" "testing the client host"
29170 This condition tests that the calling host matches the host list. If you have
29171 name lookups or wildcarded host names and IP addresses in the same host list,
29172 you should normally put the IP addresses first. For example, you could have:
29173 .code
29174 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
29175 .endd
29176 The lookup in this example uses the host name for its key. This is implied by
29177 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
29178 and it wouldn't matter which way round you had these two items.)
29179
29180 The reason for the problem with host names lies in the left-to-right way that
29181 Exim processes lists. It can test IP addresses without doing any DNS lookups,
29182 but when it reaches an item that requires a host name, it fails if it cannot
29183 find a host name to compare with the pattern. If the above list is given in the
29184 opposite order, the &%accept%& statement fails for a host whose name cannot be
29185 found, even if its IP address is 10.9.8.7.
29186
29187 If you really do want to do the name check first, and still recognize the IP
29188 address even if the name lookup fails, you can rewrite the ACL like this:
29189 .code
29190 accept hosts = dbm;/etc/friendly/hosts
29191 accept hosts = 10.9.8.7
29192 .endd
29193 The default action on failing to find the host name is to assume that the host
29194 is not in the list, so the first &%accept%& statement fails. The second
29195 statement can then check the IP address.
29196
29197 .vindex "&$host_data$&"
29198 If a &%hosts%& condition is satisfied by means of a lookup, the result
29199 of the lookup is made available in the &$host_data$& variable. This
29200 allows you, for example, to set up a statement like this:
29201 .code
29202 deny  hosts = net-lsearch;/some/file
29203 message = $host_data
29204 .endd
29205 which gives a custom error message for each denied host.
29206
29207 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
29208 .cindex "&%local_parts%& ACL condition"
29209 .cindex "local part" "ACL checking"
29210 .cindex "&ACL;" "testing a local part"
29211 .vindex "&$local_part_data$&"
29212 This condition is relevant only after a RCPT command. It checks that the local
29213 part of the recipient address is in the list. If percent-hack processing is
29214 enabled, it is done before this test. If the check succeeds with a lookup, the
29215 result of the lookup is placed in &$local_part_data$&, which remains set until
29216 the next &%local_parts%& test.
29217
29218 .vitem &*malware&~=&~*&<&'option'&>
29219 .cindex "&%malware%& ACL condition"
29220 .cindex "&ACL;" "virus scanning"
29221 .cindex "&ACL;" "scanning for viruses"
29222 This condition is available only when Exim is compiled with the
29223 content-scanning extension. It causes the incoming message to be scanned for
29224 viruses. For details, see chapter &<<CHAPexiscan>>&.
29225
29226 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
29227 .cindex "&%mime_regex%& ACL condition"
29228 .cindex "&ACL;" "testing by regex matching"
29229 This condition is available only when Exim is compiled with the
29230 content-scanning extension, and it is allowed only in the ACL defined by
29231 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
29232 with any of the regular expressions. For details, see chapter
29233 &<<CHAPexiscan>>&.
29234
29235 .vitem &*ratelimit&~=&~*&<&'parameters'&>
29236 .cindex "rate limiting"
29237 This condition can be used to limit the rate at which a user or host submits
29238 messages. Details are given in section &<<SECTratelimiting>>&.
29239
29240 .vitem &*recipients&~=&~*&<&'address&~list'&>
29241 .cindex "&%recipients%& ACL condition"
29242 .cindex "recipient" "ACL checking"
29243 .cindex "&ACL;" "testing a recipient"
29244 This condition is relevant only after a RCPT command. It checks the entire
29245 recipient address against a list of recipients.
29246
29247 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
29248 .cindex "&%regex%& ACL condition"
29249 .cindex "&ACL;" "testing by regex matching"
29250 This condition is available only when Exim is compiled with the
29251 content-scanning extension, and is available only in the DATA, MIME, and
29252 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
29253 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
29254
29255 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
29256 .cindex "&%sender_domains%& ACL condition"
29257 .cindex "sender" "ACL checking"
29258 .cindex "&ACL;" "testing a sender domain"
29259 .vindex "&$domain$&"
29260 .vindex "&$sender_address_domain$&"
29261 This condition tests the domain of the sender of the message against the given
29262 domain list. &*Note*&: The domain of the sender address is in
29263 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
29264 of this condition. This is an exception to the general rule for testing domain
29265 lists. It is done this way so that, if this condition is used in an ACL for a
29266 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
29267 influence the sender checking.
29268
29269 &*Warning*&: It is a bad idea to use this condition on its own as a control on
29270 relaying, because sender addresses are easily, and commonly, forged.
29271
29272 .vitem &*senders&~=&~*&<&'address&~list'&>
29273 .cindex "&%senders%& ACL condition"
29274 .cindex "sender" "ACL checking"
29275 .cindex "&ACL;" "testing a sender"
29276 This condition tests the sender of the message against the given list. To test
29277 for a bounce message, which has an empty sender, set
29278 .code
29279 senders = :
29280 .endd
29281 &*Warning*&: It is a bad idea to use this condition on its own as a control on
29282 relaying, because sender addresses are easily, and commonly, forged.
29283
29284 .vitem &*spam&~=&~*&<&'username'&>
29285 .cindex "&%spam%& ACL condition"
29286 .cindex "&ACL;" "scanning for spam"
29287 This condition is available only when Exim is compiled with the
29288 content-scanning extension. It causes the incoming message to be scanned by
29289 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
29290
29291 .vitem &*verify&~=&~certificate*&
29292 .cindex "&%verify%& ACL condition"
29293 .cindex "TLS" "client certificate verification"
29294 .cindex "certificate" "verification of client"
29295 .cindex "&ACL;" "certificate verification"
29296 .cindex "&ACL;" "testing a TLS certificate"
29297 This condition is true in an SMTP session if the session is encrypted, and a
29298 certificate was received from the client, and the certificate was verified. The
29299 server requests a certificate only if the client matches &%tls_verify_hosts%&
29300 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
29301
29302 .vitem &*verify&~=&~csa*&
29303 .cindex "CSA verification"
29304 This condition checks whether the sending host (the client) is authorized to
29305 send email. Details of how this works are given in section
29306 &<<SECTverifyCSA>>&.
29307
29308 .vitem &*verify&~=&~header_names_ascii*&
29309 .cindex "&%verify%& ACL condition"
29310 .cindex "&ACL;" "verifying header names only ASCII"
29311 .cindex "header lines" "verifying header names only ASCII"
29312 .cindex "verifying" "header names only ASCII"
29313 This condition is relevant only in an ACL that is run after a message has been
29314 received, that is, in an ACL specified by &%acl_smtp_data%& or
29315 &%acl_not_smtp%&.  It checks all header names (not the content) to make sure
29316 there are no non-ASCII characters, also excluding control characters.  The
29317 allowable characters are decimal ASCII values 33 through 126.
29318
29319 Exim itself will handle headers with non-ASCII characters, but it can cause
29320 problems for downstream applications, so this option will allow their
29321 detection and rejection in the DATA ACL's.
29322
29323 .vitem &*verify&~=&~header_sender/*&<&'options'&>
29324 .cindex "&%verify%& ACL condition"
29325 .cindex "&ACL;" "verifying sender in the header"
29326 .cindex "header lines" "verifying the sender in"
29327 .cindex "sender" "verifying in header"
29328 .cindex "verifying" "sender in header"
29329 This condition is relevant only in an ACL that is run after a message has been
29330 received, that is, in an ACL specified by &%acl_smtp_data%& or
29331 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
29332 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
29333 is loosely thought of as a &"sender"& address (hence the name of the test).
29334 However, an address that appears in one of these headers need not be an address
29335 that accepts bounce messages; only sender addresses in envelopes are required
29336 to accept bounces. Therefore, if you use the callout option on this check, you
29337 might want to arrange for a non-empty address in the MAIL command.
29338
29339 Details of address verification and the options are given later, starting at
29340 section &<<SECTaddressverification>>& (callouts are described in section
29341 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
29342 condition to restrict it to bounce messages only:
29343 .code
29344 deny    senders = :
29345         message = A valid sender header is required for bounces
29346        !verify  = header_sender
29347 .endd
29348
29349 .vitem &*verify&~=&~header_syntax*&
29350 .cindex "&%verify%& ACL condition"
29351 .cindex "&ACL;" "verifying header syntax"
29352 .cindex "header lines" "verifying syntax"
29353 .cindex "verifying" "header syntax"
29354 This condition is relevant only in an ACL that is run after a message has been
29355 received, that is, in an ACL specified by &%acl_smtp_data%& or
29356 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
29357 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
29358 and &'Bcc:'&), returning true if there are no problems.
29359 Unqualified addresses (local parts without domains) are
29360 permitted only in locally generated messages and from hosts that match
29361 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
29362 appropriate.
29363
29364 Note that this condition is a syntax check only. However, a common spamming
29365 ploy used to be to send syntactically invalid headers such as
29366 .code
29367 To: @
29368 .endd
29369 and this condition can be used to reject such messages, though they are not as
29370 common as they used to be.
29371
29372 .vitem &*verify&~=&~helo*&
29373 .cindex "&%verify%& ACL condition"
29374 .cindex "&ACL;" "verifying HELO/EHLO"
29375 .cindex "HELO" "verifying"
29376 .cindex "EHLO" "verifying"
29377 .cindex "verifying" "EHLO"
29378 .cindex "verifying" "HELO"
29379 This condition is true if a HELO or EHLO command has been received from the
29380 client host, and its contents have been verified. If there has been no previous
29381 attempt to verify the HELO/EHLO contents, it is carried out when this
29382 condition is encountered. See the description of the &%helo_verify_hosts%& and
29383 &%helo_try_verify_hosts%& options for details of how to request verification
29384 independently of this condition.
29385
29386 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
29387 option), this condition is always true.
29388
29389
29390 .vitem &*verify&~=&~not_blind*&
29391 .cindex "verifying" "not blind"
29392 .cindex "bcc recipients, verifying none"
29393 This condition checks that there are no blind (bcc) recipients in the message.
29394 Every envelope recipient must appear either in a &'To:'& header line or in a
29395 &'Cc:'& header line for this condition to be true. Local parts are checked
29396 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
29397 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
29398 used only in a DATA or non-SMTP ACL.
29399
29400 There are, of course, many legitimate messages that make use of blind (bcc)
29401 recipients. This check should not be used on its own for blocking messages.
29402
29403
29404 .vitem &*verify&~=&~recipient/*&<&'options'&>
29405 .cindex "&%verify%& ACL condition"
29406 .cindex "&ACL;" "verifying recipient"
29407 .cindex "recipient" "verifying"
29408 .cindex "verifying" "recipient"
29409 .vindex "&$address_data$&"
29410 This condition is relevant only after a RCPT command. It verifies the current
29411 recipient. Details of address verification are given later, starting at section
29412 &<<SECTaddressverification>>&. After a recipient has been verified, the value
29413 of &$address_data$& is the last value that was set while routing the address.
29414 This applies even if the verification fails. When an address that is being
29415 verified is redirected to a single address, verification continues with the new
29416 address, and in that case, the subsequent value of &$address_data$& is the
29417 value for the child address.
29418
29419 .vitem &*verify&~=&~reverse_host_lookup/*&<&'options'&>
29420 .cindex "&%verify%& ACL condition"
29421 .cindex "&ACL;" "verifying host reverse lookup"
29422 .cindex "host" "verifying reverse lookup"
29423 This condition ensures that a verified host name has been looked up from the IP
29424 address of the client host. (This may have happened already if the host name
29425 was needed for checking a host list, or if the host matched &%host_lookup%&.)
29426 Verification ensures that the host name obtained from a reverse DNS lookup, or
29427 one of its aliases, does, when it is itself looked up in the DNS, yield the
29428 original IP address.
29429
29430 There is one possible option, &`defer_ok`&.  If this is present and a
29431 DNS operation returns a temporary error, the verify condition succeeds.
29432
29433 If this condition is used for a locally generated message (that is, when there
29434 is no client host involved), it always succeeds.
29435
29436 .vitem &*verify&~=&~sender/*&<&'options'&>
29437 .cindex "&%verify%& ACL condition"
29438 .cindex "&ACL;" "verifying sender"
29439 .cindex "sender" "verifying"
29440 .cindex "verifying" "sender"
29441 This condition is relevant only after a MAIL or RCPT command, or after a
29442 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
29443 the message's sender is empty (that is, this is a bounce message), the
29444 condition is true. Otherwise, the sender address is verified.
29445
29446 .vindex "&$address_data$&"
29447 .vindex "&$sender_address_data$&"
29448 If there is data in the &$address_data$& variable at the end of routing, its
29449 value is placed in &$sender_address_data$& at the end of verification. This
29450 value can be used in subsequent conditions and modifiers in the same ACL
29451 statement. It does not persist after the end of the current statement. If you
29452 want to preserve the value for longer, you can save it in an ACL variable.
29453
29454 Details of verification are given later, starting at section
29455 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
29456 to avoid doing it more than once per message.
29457
29458 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
29459 .cindex "&%verify%& ACL condition"
29460 This is a variation of the previous option, in which a modified address is
29461 verified as a sender.
29462 .endlist
29463
29464
29465
29466 .section "Using DNS lists" "SECTmorednslists"
29467 .cindex "DNS list" "in ACL"
29468 .cindex "black list (DNS)"
29469 .cindex "&ACL;" "testing a DNS list"
29470 In its simplest form, the &%dnslists%& condition tests whether the calling host
29471 is on at least one of a number of DNS lists by looking up the inverted IP
29472 address in one or more DNS domains. (Note that DNS list domains are not mail
29473 domains, so the &`+`& syntax for named lists doesn't work - it is used for
29474 special options instead.) For example, if the calling host's IP
29475 address is 192.168.62.43, and the ACL statement is
29476 .code
29477 deny dnslists = blackholes.mail-abuse.org : \
29478                 dialups.mail-abuse.org
29479 .endd
29480 the following records are looked up:
29481 .code
29482 43.62.168.192.blackholes.mail-abuse.org
29483 43.62.168.192.dialups.mail-abuse.org
29484 .endd
29485 As soon as Exim finds an existing DNS record, processing of the list stops.
29486 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
29487 to test that a host is on more than one list (an &"and"& conjunction), you can
29488 use two separate conditions:
29489 .code
29490 deny dnslists = blackholes.mail-abuse.org
29491      dnslists = dialups.mail-abuse.org
29492 .endd
29493 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
29494 behaves as if the host does not match the list item, that is, as if the DNS
29495 record does not exist. If there are further items in the DNS list, they are
29496 processed.
29497
29498 This is usually the required action when &%dnslists%& is used with &%deny%&
29499 (which is the most common usage), because it prevents a DNS failure from
29500 blocking mail. However, you can change this behaviour by putting one of the
29501 following special items in the list:
29502 .display
29503 &`+include_unknown `&   behave as if the item is on the list
29504 &`+exclude_unknown `&   behave as if the item is not on the list (default)
29505 &`+defer_unknown   `&   give a temporary error
29506 .endd
29507 .cindex "&`+include_unknown`&"
29508 .cindex "&`+exclude_unknown`&"
29509 .cindex "&`+defer_unknown`&"
29510 Each of these applies to any subsequent items on the list. For example:
29511 .code
29512 deny dnslists = +defer_unknown : foo.bar.example
29513 .endd
29514 Testing the list of domains stops as soon as a match is found. If you want to
29515 warn for one list and block for another, you can use two different statements:
29516 .code
29517 deny  dnslists = blackholes.mail-abuse.org
29518 warn  message  = X-Warn: sending host is on dialups list
29519       dnslists = dialups.mail-abuse.org
29520 .endd
29521 .cindex cacheing "of dns lookup"
29522 .cindex DNS TTL
29523 DNS list lookups are cached by Exim for the duration of the SMTP session
29524 .new
29525 (but limited by the DNS return TTL value),
29526 .wen
29527 so a lookup based on the IP address is done at most once for any incoming
29528 connection (assuming long-enough TTL).
29529 Exim does not share information between multiple incoming
29530 connections (but your local name server cache should be active).
29531
29532
29533
29534 .section "Specifying the IP address for a DNS list lookup" "SECID201"
29535 .cindex "DNS list" "keyed by explicit IP address"
29536 By default, the IP address that is used in a DNS list lookup is the IP address
29537 of the calling host. However, you can specify another IP address by listing it
29538 after the domain name, introduced by a slash. For example:
29539 .code
29540 deny dnslists = black.list.tld/192.168.1.2
29541 .endd
29542 This feature is not very helpful with explicit IP addresses; it is intended for
29543 use with IP addresses that are looked up, for example, the IP addresses of the
29544 MX hosts or nameservers of an email sender address. For an example, see section
29545 &<<SECTmulkeyfor>>& below.
29546
29547
29548
29549
29550 .section "DNS lists keyed on domain names" "SECID202"
29551 .cindex "DNS list" "keyed by domain name"
29552 There are some lists that are keyed on domain names rather than inverted IP
29553 addresses (see for example the &'domain based zones'& link at
29554 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
29555 with these lists. You can change the name that is looked up in a DNS list by
29556 listing it after the domain name, introduced by a slash. For example,
29557 .code
29558 deny  message  = Sender's domain is listed at $dnslist_domain
29559       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
29560 .endd
29561 This particular example is useful only in ACLs that are obeyed after the
29562 RCPT or DATA commands, when a sender address is available. If (for
29563 example) the message's sender is &'user@tld.example'& the name that is looked
29564 up by this example is
29565 .code
29566 tld.example.dsn.rfc-ignorant.org
29567 .endd
29568 A single &%dnslists%& condition can contain entries for both names and IP
29569 addresses. For example:
29570 .code
29571 deny dnslists = sbl.spamhaus.org : \
29572                 dsn.rfc-ignorant.org/$sender_address_domain
29573 .endd
29574 The first item checks the sending host's IP address; the second checks a domain
29575 name. The whole condition is true if either of the DNS lookups succeeds.
29576
29577
29578
29579
29580 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
29581 .cindex "DNS list" "multiple keys for"
29582 The syntax described above for looking up explicitly-defined values (either
29583 names or IP addresses) in a DNS blacklist is a simplification. After the domain
29584 name for the DNS list, what follows the slash can in fact be a list of items.
29585 As with all lists in Exim, the default separator is a colon. However, because
29586 this is a sublist within the list of DNS blacklist domains, it is necessary
29587 either to double the separators like this:
29588 .code
29589 dnslists = black.list.tld/name.1::name.2
29590 .endd
29591 or to change the separator character, like this:
29592 .code
29593 dnslists = black.list.tld/<;name.1;name.2
29594 .endd
29595 If an item in the list is an IP address, it is inverted before the DNS
29596 blacklist domain is appended. If it is not an IP address, no inversion
29597 occurs. Consider this condition:
29598 .code
29599 dnslists = black.list.tld/<;192.168.1.2;a.domain
29600 .endd
29601 The DNS lookups that occur are:
29602 .code
29603 2.1.168.192.black.list.tld
29604 a.domain.black.list.tld
29605 .endd
29606 Once a DNS record has been found (that matches a specific IP return
29607 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
29608 are done. If there is a temporary DNS error, the rest of the sublist of domains
29609 or IP addresses is tried. A temporary error for the whole dnslists item occurs
29610 only if no other DNS lookup in this sublist succeeds. In other words, a
29611 successful lookup for any of the items in the sublist overrides a temporary
29612 error for a previous item.
29613
29614 The ability to supply a list of items after the slash is in some sense just a
29615 syntactic convenience. These two examples have the same effect:
29616 .code
29617 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
29618 dnslists = black.list.tld/a.domain::b.domain
29619 .endd
29620 However, when the data for the list is obtained from a lookup, the second form
29621 is usually much more convenient. Consider this example:
29622 .code
29623 deny message  = The mail servers for the domain \
29624                 $sender_address_domain \
29625                 are listed at $dnslist_domain ($dnslist_value); \
29626                 see $dnslist_text.
29627      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
29628                                    ${lookup dnsdb {>|mxh=\
29629                                    $sender_address_domain} }} }
29630 .endd
29631 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
29632 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
29633 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
29634 of expanding the condition might be something like this:
29635 .code
29636 dnslists = sbl.spahmaus.org/<|192.168.2.3|192.168.5.6|...
29637 .endd
29638 Thus, this example checks whether or not the IP addresses of the sender
29639 domain's mail servers are on the Spamhaus black list.
29640
29641 The key that was used for a successful DNS list lookup is put into the variable
29642 &$dnslist_matched$& (see section &<<SECID204>>&).
29643
29644
29645
29646
29647 .section "Data returned by DNS lists" "SECID203"
29648 .cindex "DNS list" "data returned from"
29649 DNS lists are constructed using address records in the DNS. The original RBL
29650 just used the address 127.0.0.1 on the right hand side of each record, but the
29651 RBL+ list and some other lists use a number of values with different meanings.
29652 The values used on the RBL+ list are:
29653 .display
29654 127.1.0.1  RBL
29655 127.1.0.2  DUL
29656 127.1.0.3  DUL and RBL
29657 127.1.0.4  RSS
29658 127.1.0.5  RSS and RBL
29659 127.1.0.6  RSS and DUL
29660 127.1.0.7  RSS and DUL and RBL
29661 .endd
29662 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
29663 different values. Some DNS lists may return more than one address record;
29664 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
29665
29666
29667 .section "Variables set from DNS lists" "SECID204"
29668 .cindex "expansion" "variables, set from DNS list"
29669 .cindex "DNS list" "variables set from"
29670 .vindex "&$dnslist_domain$&"
29671 .vindex "&$dnslist_matched$&"
29672 .vindex "&$dnslist_text$&"
29673 .vindex "&$dnslist_value$&"
29674 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
29675 the name of the overall domain that matched (for example,
29676 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
29677 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
29678 the DNS record. When the key is an IP address, it is not reversed in
29679 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
29680 cases, for example:
29681 .code
29682 deny dnslists = spamhaus.example
29683 .endd
29684 the key is also available in another variable (in this case,
29685 &$sender_host_address$&). In more complicated cases, however, this is not true.
29686 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
29687 might generate a dnslists lookup like this:
29688 .code
29689 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
29690 .endd
29691 If this condition succeeds, the value in &$dnslist_matched$& might be
29692 &`192.168.6.7`& (for example).
29693
29694 If more than one address record is returned by the DNS lookup, all the IP
29695 addresses are included in &$dnslist_value$&, separated by commas and spaces.
29696 The variable &$dnslist_text$& contains the contents of any associated TXT
29697 record. For lists such as RBL+ the TXT record for a merged entry is often not
29698 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
29699 information.
29700
29701 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
29702 &-- although these appear before the condition in the ACL, they are not
29703 expanded until after it has failed. For example:
29704 .code
29705 deny    hosts = !+local_networks
29706         message = $sender_host_address is listed \
29707                   at $dnslist_domain
29708         dnslists = rbl-plus.mail-abuse.example
29709 .endd
29710
29711
29712
29713 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
29714 .cindex "DNS list" "matching specific returned data"
29715 You can add an equals sign and an IP address after a &%dnslists%& domain name
29716 in order to restrict its action to DNS records with a matching right hand side.
29717 For example,
29718 .code
29719 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
29720 .endd
29721 rejects only those hosts that yield 127.0.0.2. Without this additional data,
29722 any address record is considered to be a match. For the moment, we assume
29723 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
29724 describes how multiple records are handled.
29725
29726 More than one IP address may be given for checking, using a comma as a
29727 separator. These are alternatives &-- if any one of them matches, the
29728 &%dnslists%& condition is true. For example:
29729 .code
29730 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
29731 .endd
29732 If you want to specify a constraining address list and also specify names or IP
29733 addresses to be looked up, the constraining address list must be specified
29734 first. For example:
29735 .code
29736 deny dnslists = dsn.rfc-ignorant.org\
29737                 =127.0.0.2/$sender_address_domain
29738 .endd
29739
29740 If the character &`&&`& is used instead of &`=`&, the comparison for each
29741 listed IP address is done by a bitwise &"and"& instead of by an equality test.
29742 In other words, the listed addresses are used as bit masks. The comparison is
29743 true if all the bits in the mask are present in the address that is being
29744 tested. For example:
29745 .code
29746 dnslists = a.b.c&0.0.0.3
29747 .endd
29748 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
29749 want to test whether one bit or another bit is present (as opposed to both
29750 being present), you must use multiple values. For example:
29751 .code
29752 dnslists = a.b.c&0.0.0.1,0.0.0.2
29753 .endd
29754 matches if the final component of the address is an odd number or two times
29755 an odd number.
29756
29757
29758
29759 .section "Negated DNS matching conditions" "SECID205"
29760 You can supply a negative list of IP addresses as part of a &%dnslists%&
29761 condition. Whereas
29762 .code
29763 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
29764 .endd
29765 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
29766 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
29767 .code
29768 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
29769 .endd
29770 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
29771 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
29772 words, the result of the test is inverted if an exclamation mark appears before
29773 the &`=`& (or the &`&&`&) sign.
29774
29775 &*Note*&: This kind of negation is not the same as negation in a domain,
29776 host, or address list (which is why the syntax is different).
29777
29778 If you are using just one list, the negation syntax does not gain you much. The
29779 previous example is precisely equivalent to
29780 .code
29781 deny  dnslists = a.b.c
29782      !dnslists = a.b.c=127.0.0.2,127.0.0.3
29783 .endd
29784 However, if you are using multiple lists, the negation syntax is clearer.
29785 Consider this example:
29786 .code
29787 deny  dnslists = sbl.spamhaus.org : \
29788                  list.dsbl.org : \
29789                  dnsbl.njabl.org!=127.0.0.3 : \
29790                  relays.ordb.org
29791 .endd
29792 Using only positive lists, this would have to be:
29793 .code
29794 deny  dnslists = sbl.spamhaus.org : \
29795                  list.dsbl.org
29796 deny  dnslists = dnsbl.njabl.org
29797      !dnslists = dnsbl.njabl.org=127.0.0.3
29798 deny  dnslists = relays.ordb.org
29799 .endd
29800 which is less clear, and harder to maintain.
29801
29802
29803
29804
29805 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
29806 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
29807 thereby providing more than one IP address. When an item in a &%dnslists%& list
29808 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
29809 the match to specific results from the DNS lookup, there are two ways in which
29810 the checking can be handled. For example, consider the condition:
29811 .code
29812 dnslists = a.b.c=127.0.0.1
29813 .endd
29814 What happens if the DNS lookup for the incoming IP address yields both
29815 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
29816 condition true because at least one given value was found, or is it false
29817 because at least one of the found values was not listed? And how does this
29818 affect negated conditions? Both possibilities are provided for with the help of
29819 additional separators &`==`& and &`=&&`&.
29820
29821 .ilist
29822 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
29823 IP addresses matches one of the listed addresses. For the example above, the
29824 condition is true because 127.0.0.1 matches.
29825 .next
29826 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
29827 looked up IP addresses matches one of the listed addresses. If the condition is
29828 changed to:
29829 .code
29830 dnslists = a.b.c==127.0.0.1
29831 .endd
29832 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
29833 false because 127.0.0.2 is not listed. You would need to have:
29834 .code
29835 dnslists = a.b.c==127.0.0.1,127.0.0.2
29836 .endd
29837 for the condition to be true.
29838 .endlist
29839
29840 When &`!`& is used to negate IP address matching, it inverts the result, giving
29841 the precise opposite of the behaviour above. Thus:
29842 .ilist
29843 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
29844 addresses matches one of the listed addresses. Consider:
29845 .code
29846 dnslists = a.b.c!&0.0.0.1
29847 .endd
29848 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
29849 false because 127.0.0.1 matches.
29850 .next
29851 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
29852 looked up IP address that does not match. Consider:
29853 .code
29854 dnslists = a.b.c!=&0.0.0.1
29855 .endd
29856 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
29857 true, because 127.0.0.2 does not match. You would need to have:
29858 .code
29859 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
29860 .endd
29861 for the condition to be false.
29862 .endlist
29863 When the DNS lookup yields only a single IP address, there is no difference
29864 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
29865
29866
29867
29868
29869 .section "Detailed information from merged DNS lists" "SECTmordetinf"
29870 .cindex "DNS list" "information from merged"
29871 When the facility for restricting the matching IP values in a DNS list is used,
29872 the text from the TXT record that is set in &$dnslist_text$& may not reflect
29873 the true reason for rejection. This happens when lists are merged and the IP
29874 address in the A record is used to distinguish them; unfortunately there is
29875 only one TXT record. One way round this is not to use merged lists, but that
29876 can be inefficient because it requires multiple DNS lookups where one would do
29877 in the vast majority of cases when the host of interest is not on any of the
29878 lists.
29879
29880 A less inefficient way of solving this problem is available. If
29881 two domain names, comma-separated, are given, the second is used first to
29882 do an initial check, making use of any IP value restrictions that are set.
29883 If there is a match, the first domain is used, without any IP value
29884 restrictions, to get the TXT record. As a byproduct of this, there is also
29885 a check that the IP being tested is indeed on the first list. The first
29886 domain is the one that is put in &$dnslist_domain$&. For example:
29887 .code
29888 reject message  = \
29889          rejected because $sender_host_address is blacklisted \
29890          at $dnslist_domain\n$dnslist_text
29891        dnslists = \
29892          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
29893          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
29894 .endd
29895 For the first blacklist item, this starts by doing a lookup in
29896 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
29897 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
29898 value, and as long as something is found, it looks for the corresponding TXT
29899 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
29900 The second blacklist item is processed similarly.
29901
29902 If you are interested in more than one merged list, the same list must be
29903 given several times, but because the results of the DNS lookups are cached,
29904 the DNS calls themselves are not repeated. For example:
29905 .code
29906 reject dnslists = \
29907          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
29908          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
29909          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
29910          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
29911 .endd
29912 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
29913 values matches (or if no record is found), this is the only lookup that is
29914 done. Only if there is a match is one of the more specific lists consulted.
29915
29916
29917
29918 .section "DNS lists and IPv6" "SECTmorednslistslast"
29919 .cindex "IPv6" "DNS black lists"
29920 .cindex "DNS list" "IPv6 usage"
29921 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
29922 nibble by nibble. For example, if the calling host's IP address is
29923 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
29924 .code
29925 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
29926   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
29927 .endd
29928 (split over two lines here to fit on the page). Unfortunately, some of the DNS
29929 lists contain wildcard records, intended for IPv4, that interact badly with
29930 IPv6. For example, the DNS entry
29931 .code
29932 *.3.some.list.example.    A    127.0.0.1
29933 .endd
29934 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
29935 Unfortunately, it also matches the entire 3::/4 IPv6 network.
29936
29937 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
29938 &%condition%& condition, as in this example:
29939 .code
29940 deny   condition = ${if isip4{$sender_host_address}}
29941        dnslists  = some.list.example
29942 .endd
29943
29944 If an explicit key is being used for a DNS lookup and it may be an IPv6
29945 address you should specify alternate list separators for both the outer
29946 (DNS list name) list and inner (lookup keys) list:
29947 .code
29948        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
29949 .endd
29950
29951 .section "Rate limiting incoming messages" "SECTratelimiting"
29952 .cindex "rate limiting" "client sending"
29953 .cindex "limiting client sending rates"
29954 .oindex "&%smtp_ratelimit_*%&"
29955 The &%ratelimit%& ACL condition can be used to measure and control the rate at
29956 which clients can send email. This is more powerful than the
29957 &%smtp_ratelimit_*%& options, because those options control the rate of
29958 commands in a single SMTP session only, whereas the &%ratelimit%& condition
29959 works across all connections (concurrent and sequential) from the same client
29960 host. The syntax of the &%ratelimit%& condition is:
29961 .display
29962 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
29963 .endd
29964 If the average client sending rate is less than &'m'& messages per time
29965 period &'p'& then the condition is false; otherwise it is true.
29966
29967 As a side-effect, the &%ratelimit%& condition sets the expansion variable
29968 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
29969 configured value of &'m'&, and &$sender_rate_period$& to the configured value
29970 of &'p'&.
29971
29972 The parameter &'p'& is the smoothing time constant, in the form of an Exim
29973 time interval, for example, &`8h`& for eight hours. A larger time constant
29974 means that it takes Exim longer to forget a client's past behaviour. The
29975 parameter &'m'& is the maximum number of messages that a client is permitted to
29976 send in each time interval. It also specifies the number of messages permitted
29977 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
29978 constant, you can allow a client to send more messages in a burst without
29979 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
29980 both small, messages must be sent at an even rate.
29981
29982 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
29983 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
29984 when deploying the &%ratelimit%& ACL condition. The script prints usage
29985 instructions when it is run with no arguments.
29986
29987 The key is used to look up the data for calculating the client's average
29988 sending rate. This data is stored in Exim's spool directory, alongside the
29989 retry and other hints databases. The default key is &$sender_host_address$&,
29990 which means Exim computes the sending rate of each client host IP address.
29991 By changing the key you can change how Exim identifies clients for the purpose
29992 of ratelimiting. For example, to limit the sending rate of each authenticated
29993 user, independent of the computer they are sending from, set the key to
29994 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
29995 example, &$authenticated_id$& is only meaningful if the client has
29996 authenticated (which you can check with the &%authenticated%& ACL condition).
29997
29998 The lookup key does not have to identify clients: If you want to limit the
29999 rate at which a recipient receives messages, you can use the key
30000 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
30001 ACL.
30002
30003 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
30004 specifies what Exim measures the rate of, for example messages or recipients
30005 or bytes. You can adjust the measurement using the &%unique=%& and/or
30006 &%count=%& options. You can also control when Exim updates the recorded rate
30007 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
30008 separated by a slash, like the other parameters. They may appear in any order.
30009
30010 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
30011 any options that alter the meaning of the stored data. The limit &'m'& is not
30012 stored, so you can alter the configured maximum rate and Exim will still
30013 remember clients' past behaviour. If you change the &%per_*%& mode or add or
30014 remove the &%unique=%& option, the lookup key changes so Exim will forget past
30015 behaviour. The lookup key is not affected by changes to the update mode and
30016 the &%count=%& option.
30017
30018
30019 .section "Ratelimit options for what is being measured" "ratoptmea"
30020 .cindex "rate limiting" "per_* options"
30021 The &%per_conn%& option limits the client's connection rate. It is not
30022 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
30023 &%acl_not_smtp_start%& ACLs.
30024
30025 The &%per_mail%& option limits the client's rate of sending messages. This is
30026 the default if none of the &%per_*%& options is specified. It can be used in
30027 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
30028 &%acl_smtp_data%&, or &%acl_not_smtp%&.
30029
30030 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
30031 the same ACLs as the &%per_mail%& option, though it is best to use this option
30032 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
30033 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
30034 in its MAIL command, which may be inaccurate or completely missing. You can
30035 follow the limit &'m'& in the configuration with K, M, or G to specify limits
30036 in kilobytes, megabytes, or gigabytes, respectively.
30037
30038 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
30039 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
30040 &%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In
30041 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
30042 ACLs the rate is updated with the total (accepted) recipient count in one go. Note that
30043 in either case the rate limiting engine will see a message with many
30044 recipients as a large high-speed burst.
30045
30046 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
30047 number of different recipients that the client has sent messages to in the
30048 last time period. That is, if the client repeatedly sends messages to the same
30049 recipient, its measured rate is not increased. This option can only be used in
30050 &%acl_smtp_rcpt%&.
30051
30052 The &%per_cmd%& option causes Exim to recompute the rate every time the
30053 condition is processed. This can be used to limit the rate of any SMTP
30054 command. If it is used in multiple ACLs it can limit the aggregate rate of
30055 multiple different commands.
30056
30057 The &%count=%& option can be used to alter how much Exim adds to the client's
30058 measured rate. For example, the &%per_byte%& option is equivalent to
30059 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
30060 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
30061 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
30062
30063 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
30064
30065
30066 .section "Ratelimit update modes" "ratoptupd"
30067 .cindex "rate limiting" "reading data without updating"
30068 You can specify one of three options with the &%ratelimit%& condition to
30069 control when its database is updated. This section describes the &%readonly%&
30070 mode, and the next section describes the &%strict%& and &%leaky%& modes.
30071
30072 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
30073 previously-computed rate to check against the limit.
30074
30075 For example, you can test the client's sending rate and deny it access (when
30076 it is too fast) in the connect ACL. If the client passes this check then it
30077 can go on to send a message, in which case its recorded rate will be updated
30078 in the MAIL ACL. Subsequent connections from the same client will check this
30079 new rate.
30080 .code
30081 acl_check_connect:
30082  deny ratelimit = 100 / 5m / readonly
30083     log_message = RATE CHECK: $sender_rate/$sender_rate_period \
30084                   (max $sender_rate_limit)
30085 # ...
30086 acl_check_mail:
30087  warn ratelimit = 100 / 5m / strict
30088     log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
30089                   (max $sender_rate_limit)
30090 .endd
30091
30092 If Exim encounters multiple &%ratelimit%& conditions with the same key when
30093 processing a message then it may increase the client's measured rate more than
30094 it should. For example, this will happen if you check the &%per_rcpt%& option
30095 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
30096 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
30097 multiple update problems by using the &%readonly%& option on later ratelimit
30098 checks.
30099
30100 The &%per_*%& options described above do not make sense in some ACLs. If you
30101 use a &%per_*%& option in an ACL where it is not normally permitted then the
30102 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
30103 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
30104 next section) so you must specify the &%readonly%& option explicitly.
30105
30106
30107 .section "Ratelimit options for handling fast clients" "ratoptfast"
30108 .cindex "rate limiting" "strict and leaky modes"
30109 If a client's average rate is greater than the maximum, the rate limiting
30110 engine can react in two possible ways, depending on the presence of the
30111 &%strict%& or &%leaky%& update modes. This is independent of the other
30112 counter-measures (such as rejecting the message) that may be specified by the
30113 rest of the ACL.
30114
30115 The &%leaky%& (default) option means that the client's recorded rate is not
30116 updated if it is above the limit. The effect of this is that Exim measures the
30117 client's average rate of successfully sent email, which cannot be greater than
30118 the maximum allowed. If the client is over the limit it may suffer some
30119 counter-measures (as specified in the ACL), but it will still be able to send
30120 email at the configured maximum rate, whatever the rate of its attempts. This
30121 is generally the better choice if you have clients that retry automatically.
30122 For example, it does not prevent a sender with an over-aggressive retry rate
30123 from getting any email through.
30124
30125 The &%strict%& option means that the client's recorded rate is always
30126 updated. The effect of this is that Exim measures the client's average rate
30127 of attempts to send email, which can be much higher than the maximum it is
30128 actually allowed. If the client is over the limit it may be subjected to
30129 counter-measures by the ACL. It must slow down and allow sufficient time to
30130 pass that its computed rate falls below the maximum before it can send email
30131 again. The time (the number of smoothing periods) it must wait and not
30132 attempt to send mail can be calculated with this formula:
30133 .code
30134         ln(peakrate/maxrate)
30135 .endd
30136
30137
30138 .section "Limiting the rate of different events" "ratoptuniq"
30139 .cindex "rate limiting" "counting unique events"
30140 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
30141 rate of different events. For example, the &%per_addr%& option uses this
30142 mechanism to count the number of different recipients that the client has
30143 sent messages to in the last time period; it is equivalent to
30144 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
30145 measure the rate that a client uses different sender addresses with the
30146 options &`per_mail/unique=$sender_address`&.
30147
30148 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
30149 has seen for that key. The whole set is thrown away when it is older than the
30150 rate smoothing period &'p'&, so each different event is counted at most once
30151 per period. In the &%leaky%& update mode, an event that causes the client to
30152 go over the limit is not added to the set, in the same way that the client's
30153 recorded rate is not updated in the same situation.
30154
30155 When you combine the &%unique=%& and &%readonly%& options, the specific
30156 &%unique=%& value is ignored, and Exim just retrieves the client's stored
30157 rate.
30158
30159 The &%unique=%& mechanism needs more space in the ratelimit database than the
30160 other &%ratelimit%& options in order to store the event set. The number of
30161 unique values is potentially as large as the rate limit, so the extra space
30162 required increases with larger limits.
30163
30164 The uniqueification is not perfect: there is a small probability that Exim
30165 will think a new event has happened before. If the sender's rate is less than
30166 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
30167 the measured rate can go above the limit, in which case Exim may under-count
30168 events by a significant margin. Fortunately, if the rate is high enough (2.7
30169 times the limit) that the false positive rate goes above 9%, then Exim will
30170 throw away the over-full event set before the measured rate falls below the
30171 limit. Therefore the only harm should be that exceptionally high sending rates
30172 are logged incorrectly; any countermeasures you configure will be as effective
30173 as intended.
30174
30175
30176 .section "Using rate limiting" "useratlim"
30177 Exim's other ACL facilities are used to define what counter-measures are taken
30178 when the rate limit is exceeded. This might be anything from logging a warning
30179 (for example, while measuring existing sending rates in order to define
30180 policy), through time delays to slow down fast senders, up to rejecting the
30181 message. For example:
30182 .code
30183 # Log all senders' rates
30184 warn ratelimit = 0 / 1h / strict
30185      log_message = Sender rate $sender_rate / $sender_rate_period
30186
30187 # Slow down fast senders; note the need to truncate $sender_rate
30188 # at the decimal point.
30189 warn ratelimit = 100 / 1h / per_rcpt / strict
30190      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
30191                    $sender_rate_limit }s
30192
30193 # Keep authenticated users under control
30194 deny authenticated = *
30195      ratelimit = 100 / 1d / strict / $authenticated_id
30196
30197 # System-wide rate limit
30198 defer message = Sorry, too busy. Try again later.
30199      ratelimit = 10 / 1s / $primary_hostname
30200
30201 # Restrict incoming rate from each host, with a default
30202 # set using a macro and special cases looked up in a table.
30203 defer message = Sender rate exceeds $sender_rate_limit \
30204                messages per $sender_rate_period
30205      ratelimit = ${lookup {$sender_host_address} \
30206                    cdb {DB/ratelimits.cdb} \
30207                    {$value} {RATELIMIT} }
30208 .endd
30209 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
30210 especially with the &%per_rcpt%& option, you may suffer from a performance
30211 bottleneck caused by locking on the ratelimit hints database. Apart from
30212 making your ACLs less complicated, you can reduce the problem by using a
30213 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
30214 this means that Exim will lose its hints data after a reboot (including retry
30215 hints, the callout cache, and ratelimit data).
30216
30217
30218
30219 .section "Address verification" "SECTaddressverification"
30220 .cindex "verifying address" "options for"
30221 .cindex "policy control" "address verification"
30222 Several of the &%verify%& conditions described in section
30223 &<<SECTaclconditions>>& cause addresses to be verified. Section
30224 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
30225 The verification conditions can be followed by options that modify the
30226 verification process. The options are separated from the keyword and from each
30227 other by slashes, and some of them contain parameters. For example:
30228 .code
30229 verify = sender/callout
30230 verify = recipient/defer_ok/callout=10s,defer_ok
30231 .endd
30232 The first stage of address verification, which always happens, is to run the
30233 address through the routers, in &"verify mode"&. Routers can detect the
30234 difference between verification and routing for delivery, and their actions can
30235 be varied by a number of generic options such as &%verify%& and &%verify_only%&
30236 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
30237 The available options are as follows:
30238
30239 .ilist
30240 If the &%callout%& option is specified, successful routing to one or more
30241 remote hosts is followed by a &"callout"& to those hosts as an additional
30242 check. Callouts and their sub-options are discussed in the next section.
30243 .next
30244 If there is a defer error while doing verification routing, the ACL
30245 normally returns &"defer"&. However, if you include &%defer_ok%& in the
30246 options, the condition is forced to be true instead. Note that this is a main
30247 verification option as well as a suboption for callouts.
30248 .next
30249 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
30250 discusses the reporting of sender address verification failures.
30251 .next
30252 The &%success_on_redirect%& option causes verification always to succeed
30253 immediately after a successful redirection. By default, if a redirection
30254 generates just one address, that address is also verified. See further
30255 discussion in section &<<SECTredirwhilveri>>&.
30256 .endlist
30257
30258 .cindex "verifying address" "differentiating failures"
30259 .vindex "&$recipient_verify_failure$&"
30260 .vindex "&$sender_verify_failure$&"
30261 .vindex "&$acl_verify_message$&"
30262 After an address verification failure, &$acl_verify_message$& contains the
30263 error message that is associated with the failure. It can be preserved by
30264 coding like this:
30265 .code
30266 warn  !verify = sender
30267        set acl_m0 = $acl_verify_message
30268 .endd
30269 If you are writing your own custom rejection message or log message when
30270 denying access, you can use this variable to include information about the
30271 verification failure.
30272
30273 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
30274 appropriate) contains one of the following words:
30275
30276 .ilist
30277 &%qualify%&: The address was unqualified (no domain), and the message
30278 was neither local nor came from an exempted host.
30279 .next
30280 &%route%&: Routing failed.
30281 .next
30282 &%mail%&: Routing succeeded, and a callout was attempted; rejection
30283 occurred at or before the MAIL command (that is, on initial
30284 connection, HELO, or MAIL).
30285 .next
30286 &%recipient%&: The RCPT command in a callout was rejected.
30287 .next
30288 &%postmaster%&: The postmaster check in a callout was rejected.
30289 .endlist
30290
30291 The main use of these variables is expected to be to distinguish between
30292 rejections of MAIL and rejections of RCPT in callouts.
30293
30294
30295
30296
30297 .section "Callout verification" "SECTcallver"
30298 .cindex "verifying address" "by callout"
30299 .cindex "callout" "verification"
30300 .cindex "SMTP" "callout verification"
30301 For non-local addresses, routing verifies the domain, but is unable to do any
30302 checking of the local part. There are situations where some means of verifying
30303 the local part is desirable. One way this can be done is to make an SMTP
30304 &'callback'& to a delivery host for the sender address or a &'callforward'& to
30305 a subsequent host for a recipient address, to see if the host accepts the
30306 address. We use the term &'callout'& to cover both cases. Note that for a
30307 sender address, the callback is not to the client host that is trying to
30308 deliver the message, but to one of the hosts that accepts incoming mail for the
30309 sender's domain.
30310
30311 Exim does not do callouts by default. If you want them to happen, you must
30312 request them by setting appropriate options on the &%verify%& condition, as
30313 described below. This facility should be used with care, because it can add a
30314 lot of resource usage to the cost of verifying an address. However, Exim does
30315 cache the results of callouts, which helps to reduce the cost. Details of
30316 caching are in section &<<SECTcallvercache>>&.
30317
30318 Recipient callouts are usually used only between hosts that are controlled by
30319 the same administration. For example, a corporate gateway host could use
30320 callouts to check for valid recipients on an internal mailserver. A successful
30321 callout does not guarantee that a real delivery to the address would succeed;
30322 on the other hand, a failing callout does guarantee that a delivery would fail.
30323
30324 If the &%callout%& option is present on a condition that verifies an address, a
30325 second stage of verification occurs if the address is successfully routed to
30326 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
30327 &(manualroute)& router, where the router specifies the hosts. However, if a
30328 router that does not set up hosts routes to an &(smtp)& transport with a
30329 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
30330 &%hosts_override%& set, its hosts are always used, whether or not the router
30331 supplies a host list.
30332 Callouts are only supported on &(smtp)& transports.
30333
30334 The port that is used is taken from the transport, if it is specified and is a
30335 remote transport. (For routers that do verification only, no transport need be
30336 specified.) Otherwise, the default SMTP port is used. If a remote transport
30337 specifies an outgoing interface, this is used; otherwise the interface is not
30338 specified. Likewise, the text that is used for the HELO command is taken from
30339 the transport's &%helo_data%& option; if there is no transport, the value of
30340 &$smtp_active_hostname$& is used.
30341
30342 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
30343 test whether a bounce message could be delivered to the sender address. The
30344 following SMTP commands are sent:
30345 .display
30346 &`HELO `&<&'local host name'&>
30347 &`MAIL FROM:<>`&
30348 &`RCPT TO:`&<&'the address to be tested'&>
30349 &`QUIT`&
30350 .endd
30351 LHLO is used instead of HELO if the transport's &%protocol%& option is
30352 set to &"lmtp"&.
30353
30354 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
30355 settings.
30356
30357 A recipient callout check is similar. By default, it also uses an empty address
30358 for the sender. This default is chosen because most hosts do not make use of
30359 the sender address when verifying a recipient. Using the same address means
30360 that a single cache entry can be used for each recipient. Some sites, however,
30361 do make use of the sender address when verifying. These are catered for by the
30362 &%use_sender%& and &%use_postmaster%& options, described in the next section.
30363
30364 If the response to the RCPT command is a 2&'xx'& code, the verification
30365 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
30366 Exim tries the next host, if any. If there is a problem with all the remote
30367 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
30368 &%callout%& option is given, in which case the condition is forced to succeed.
30369
30370 .cindex "SMTP" "output flushing, disabling for callout"
30371 A callout may take a little time. For this reason, Exim normally flushes SMTP
30372 output before performing a callout in an ACL, to avoid unexpected timeouts in
30373 clients when the SMTP PIPELINING extension is in use. The flushing can be
30374 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
30375
30376
30377
30378
30379 .section "Additional parameters for callouts" "CALLaddparcall"
30380 .cindex "callout" "additional parameters for"
30381 The &%callout%& option can be followed by an equals sign and a number of
30382 optional parameters, separated by commas. For example:
30383 .code
30384 verify = recipient/callout=10s,defer_ok
30385 .endd
30386 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
30387 separate verify options, is retained for backwards compatibility, but is now
30388 deprecated. The additional parameters for &%callout%& are as follows:
30389
30390
30391 .vlist
30392 .vitem <&'a&~time&~interval'&>
30393 .cindex "callout" "timeout, specifying"
30394 This specifies the timeout that applies for the callout attempt to each host.
30395 For example:
30396 .code
30397 verify = sender/callout=5s
30398 .endd
30399 The default is 30 seconds. The timeout is used for each response from the
30400 remote host. It is also used for the initial connection, unless overridden by
30401 the &%connect%& parameter.
30402
30403
30404 .vitem &*connect&~=&~*&<&'time&~interval'&>
30405 .cindex "callout" "connection timeout, specifying"
30406 This parameter makes it possible to set a different (usually smaller) timeout
30407 for making the SMTP connection. For example:
30408 .code
30409 verify = sender/callout=5s,connect=1s
30410 .endd
30411 If not specified, this timeout defaults to the general timeout value.
30412
30413 .vitem &*defer_ok*&
30414 .cindex "callout" "defer, action on"
30415 When this parameter is present, failure to contact any host, or any other kind
30416 of temporary error, is treated as success by the ACL. However, the cache is not
30417 updated in this circumstance.
30418
30419 .vitem &*fullpostmaster*&
30420 .cindex "callout" "full postmaster check"
30421 This operates like the &%postmaster%& option (see below), but if the check for
30422 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
30423 accordance with the specification in RFC 2821. The RFC states that the
30424 unqualified address &'postmaster'& should be accepted.
30425
30426
30427 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
30428 .cindex "callout" "sender when verifying header"
30429 When verifying addresses in header lines using the &%header_sender%&
30430 verification option, Exim behaves by default as if the addresses are envelope
30431 sender addresses from a message. Callout verification therefore tests to see
30432 whether a bounce message could be delivered, by using an empty address in the
30433 MAIL command. However, it is arguable that these addresses might never be used
30434 as envelope senders, and could therefore justifiably reject bounce messages
30435 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
30436 address to use in the MAIL command. For example:
30437 .code
30438 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
30439 .endd
30440 This parameter is available only for the &%header_sender%& verification option.
30441
30442
30443 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
30444 .cindex "callout" "overall timeout, specifying"
30445 This parameter sets an overall timeout for performing a callout verification.
30446 For example:
30447 .code
30448 verify = sender/callout=5s,maxwait=30s
30449 .endd
30450 This timeout defaults to four times the callout timeout for individual SMTP
30451 commands. The overall timeout applies when there is more than one host that can
30452 be tried. The timeout is checked before trying the next host. This prevents
30453 very long delays if there are a large number of hosts and all are timing out
30454 (for example, when network connections are timing out).
30455
30456
30457 .vitem &*no_cache*&
30458 .cindex "callout" "cache, suppressing"
30459 .cindex "caching callout, suppressing"
30460 When this parameter is given, the callout cache is neither read nor updated.
30461
30462 .vitem &*postmaster*&
30463 .cindex "callout" "postmaster; checking"
30464 When this parameter is set, a successful callout check is followed by a similar
30465 check for the local part &'postmaster'& at the same domain. If this address is
30466 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
30467 the postmaster check is recorded in a cache record; if it is a failure, this is
30468 used to fail subsequent callouts for the domain without a connection being
30469 made, until the cache record expires.
30470
30471 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
30472 The postmaster check uses an empty sender in the MAIL command by default.
30473 You can use this parameter to do a postmaster check using a different address.
30474 For example:
30475 .code
30476 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
30477 .endd
30478 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
30479 one overrides. The &%postmaster%& parameter is equivalent to this example:
30480 .code
30481 require  verify = sender/callout=postmaster_mailfrom=
30482 .endd
30483 &*Warning*&: The caching arrangements for postmaster checking do not take
30484 account of the sender address. It is assumed that either the empty address or
30485 a fixed non-empty address will be used. All that Exim remembers is that the
30486 postmaster check for the domain succeeded or failed.
30487
30488
30489 .vitem &*random*&
30490 .cindex "callout" "&""random""& check"
30491 When this parameter is set, before doing the normal callout check, Exim does a
30492 check for a &"random"& local part at the same domain. The local part is not
30493 really random &-- it is defined by the expansion of the option
30494 &%callout_random_local_part%&, which defaults to
30495 .code
30496 $primary_hostname-$tod_epoch-testing
30497 .endd
30498 The idea here is to try to determine whether the remote host accepts all local
30499 parts without checking. If it does, there is no point in doing callouts for
30500 specific local parts. If the &"random"& check succeeds, the result is saved in
30501 a cache record, and used to force the current and subsequent callout checks to
30502 succeed without a connection being made, until the cache record expires.
30503
30504 .vitem &*use_postmaster*&
30505 .cindex "callout" "sender for recipient check"
30506 This parameter applies to recipient callouts only. For example:
30507 .code
30508 deny  !verify = recipient/callout=use_postmaster
30509 .endd
30510 .vindex "&$qualify_domain$&"
30511 It causes a non-empty postmaster address to be used in the MAIL command when
30512 performing the callout for the recipient, and also for a &"random"& check if
30513 that is configured. The local part of the address is &`postmaster`& and the
30514 domain is the contents of &$qualify_domain$&.
30515
30516 .vitem &*use_sender*&
30517 This option applies to recipient callouts only. For example:
30518 .code
30519 require  verify = recipient/callout=use_sender
30520 .endd
30521 It causes the message's actual sender address to be used in the MAIL
30522 command when performing the callout, instead of an empty address. There is no
30523 need to use this option unless you know that the called hosts make use of the
30524 sender when checking recipients. If used indiscriminately, it reduces the
30525 usefulness of callout caching.
30526 .endlist
30527
30528 If you use any of the parameters that set a non-empty sender for the MAIL
30529 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
30530 &%use_sender%&), you should think about possible loops. Recipient checking is
30531 usually done between two hosts that are under the same management, and the host
30532 that receives the callouts is not normally configured to do callouts itself.
30533 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
30534 these circumstances.
30535
30536 However, if you use a non-empty sender address for a callout to an arbitrary
30537 host, there is the likelihood that the remote host will itself initiate a
30538 callout check back to your host. As it is checking what appears to be a message
30539 sender, it is likely to use an empty address in MAIL, thus avoiding a
30540 callout loop. However, to be on the safe side it would be best to set up your
30541 own ACLs so that they do not do sender verification checks when the recipient
30542 is the address you use for header sender or postmaster callout checking.
30543
30544 Another issue to think about when using non-empty senders for callouts is
30545 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
30546 by the sender/recipient combination; thus, for any given recipient, many more
30547 actual callouts are performed than when an empty sender or postmaster is used.
30548
30549
30550
30551
30552 .section "Callout caching" "SECTcallvercache"
30553 .cindex "hints database" "callout cache"
30554 .cindex "callout" "cache, description of"
30555 .cindex "caching" "callout"
30556 Exim caches the results of callouts in order to reduce the amount of resources
30557 used, unless you specify the &%no_cache%& parameter with the &%callout%&
30558 option. A hints database called &"callout"& is used for the cache. Two
30559 different record types are used: one records the result of a callout check for
30560 a specific address, and the other records information that applies to the
30561 entire domain (for example, that it accepts the local part &'postmaster'&).
30562
30563 When an original callout fails, a detailed SMTP error message is given about
30564 the failure. However, for subsequent failures use the cache data, this message
30565 is not available.
30566
30567 The expiry times for negative and positive address cache records are
30568 independent, and can be set by the global options &%callout_negative_expire%&
30569 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
30570
30571 If a host gives a negative response to an SMTP connection, or rejects any
30572 commands up to and including
30573 .code
30574 MAIL FROM:<>
30575 .endd
30576 (but not including the MAIL command with a non-empty address),
30577 any callout attempt is bound to fail. Exim remembers such failures in a
30578 domain cache record, which it uses to fail callouts for the domain without
30579 making new connections, until the domain record times out. There are two
30580 separate expiry times for domain cache records:
30581 &%callout_domain_negative_expire%& (default 3h) and
30582 &%callout_domain_positive_expire%& (default 7d).
30583
30584 Domain records expire when the negative expiry time is reached if callouts
30585 cannot be made for the domain, or if the postmaster check failed.
30586 Otherwise, they expire when the positive expiry time is reached. This
30587 ensures that, for example, a host that stops accepting &"random"& local parts
30588 will eventually be noticed.
30589
30590 The callout caching mechanism is based on the domain of the address that is
30591 being tested. If the domain routes to several hosts, it is assumed that their
30592 behaviour will be the same.
30593
30594
30595
30596 .section "Sender address verification reporting" "SECTsenaddver"
30597 .cindex "verifying" "suppressing error details"
30598 See section &<<SECTaddressverification>>& for a general discussion of
30599 verification. When sender verification fails in an ACL, the details of the
30600 failure are given as additional output lines before the 550 response to the
30601 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
30602 you might see:
30603 .code
30604 MAIL FROM:<xyz@abc.example>
30605 250 OK
30606 RCPT TO:<pqr@def.example>
30607 550-Verification failed for <xyz@abc.example>
30608 550-Called:   192.168.34.43
30609 550-Sent:     RCPT TO:<xyz@abc.example>
30610 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
30611 550 Sender verification failed
30612 .endd
30613 If more than one RCPT command fails in the same way, the details are given
30614 only for the first of them. However, some administrators do not want to send
30615 out this much information. You can suppress the details by adding
30616 &`/no_details`& to the ACL statement that requests sender verification. For
30617 example:
30618 .code
30619 verify = sender/no_details
30620 .endd
30621
30622 .section "Redirection while verifying" "SECTredirwhilveri"
30623 .cindex "verifying" "redirection while"
30624 .cindex "address redirection" "while verifying"
30625 A dilemma arises when a local address is redirected by aliasing or forwarding
30626 during verification: should the generated addresses themselves be verified,
30627 or should the successful expansion of the original address be enough to verify
30628 it? By default, Exim takes the following pragmatic approach:
30629
30630 .ilist
30631 When an incoming address is redirected to just one child address, verification
30632 continues with the child address, and if that fails to verify, the original
30633 verification also fails.
30634 .next
30635 When an incoming address is redirected to more than one child address,
30636 verification does not continue. A success result is returned.
30637 .endlist
30638
30639 This seems the most reasonable behaviour for the common use of aliasing as a
30640 way of redirecting different local parts to the same mailbox. It means, for
30641 example, that a pair of alias entries of the form
30642 .code
30643 A.Wol:   aw123
30644 aw123:   :fail: Gone away, no forwarding address
30645 .endd
30646 work as expected, with both local parts causing verification failure. When a
30647 redirection generates more than one address, the behaviour is more like a
30648 mailing list, where the existence of the alias itself is sufficient for
30649 verification to succeed.
30650
30651 It is possible, however, to change the default behaviour so that all successful
30652 redirections count as successful verifications, however many new addresses are
30653 generated. This is specified by the &%success_on_redirect%& verification
30654 option. For example:
30655 .code
30656 require verify = recipient/success_on_redirect/callout=10s
30657 .endd
30658 In this example, verification succeeds if a router generates a new address, and
30659 the callout does not occur, because no address was routed to a remote host.
30660
30661 When verification is being tested via the &%-bv%& option, the treatment of
30662 redirections is as just described, unless the &%-v%& or any debugging option is
30663 also specified. In that case, full verification is done for every generated
30664 address and a report is output for each of them.
30665
30666
30667
30668 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
30669 .cindex "CSA" "verifying"
30670 Client SMTP Authorization is a system that allows a site to advertise
30671 which machines are and are not permitted to send email. This is done by placing
30672 special SRV records in the DNS; these are looked up using the client's HELO
30673 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
30674 Authorization checks in Exim are performed by the ACL condition:
30675 .code
30676 verify = csa
30677 .endd
30678 This fails if the client is not authorized. If there is a DNS problem, or if no
30679 valid CSA SRV record is found, or if the client is authorized, the condition
30680 succeeds. These three cases can be distinguished using the expansion variable
30681 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
30682 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
30683 be likely to cause problems for legitimate email.
30684
30685 The error messages produced by the CSA code include slightly more
30686 detail. If &$csa_status$& is &"defer"&, this may be because of problems
30687 looking up the CSA SRV record, or problems looking up the CSA target
30688 address record. There are four reasons for &$csa_status$& being &"fail"&:
30689
30690 .ilist
30691 The client's host name is explicitly not authorized.
30692 .next
30693 The client's IP address does not match any of the CSA target IP addresses.
30694 .next
30695 The client's host name is authorized but it has no valid target IP addresses
30696 (for example, the target's addresses are IPv6 and the client is using IPv4).
30697 .next
30698 The client's host name has no CSA SRV record but a parent domain has asserted
30699 that all subdomains must be explicitly authorized.
30700 .endlist
30701
30702 The &%csa%& verification condition can take an argument which is the domain to
30703 use for the DNS query. The default is:
30704 .code
30705 verify = csa/$sender_helo_name
30706 .endd
30707 This implementation includes an extension to CSA. If the query domain
30708 is an address literal such as [192.0.2.95], or if it is a bare IP
30709 address, Exim searches for CSA SRV records in the reverse DNS as if
30710 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
30711 meaningful to say:
30712 .code
30713 verify = csa/$sender_host_address
30714 .endd
30715 In fact, this is the check that Exim performs if the client does not say HELO.
30716 This extension can be turned off by setting the main configuration option
30717 &%dns_csa_use_reverse%& to be false.
30718
30719 If a CSA SRV record is not found for the domain itself, a search
30720 is performed through its parent domains for a record which might be
30721 making assertions about subdomains. The maximum depth of this search is limited
30722 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
30723 default. Exim does not look for CSA SRV records in a top level domain, so the
30724 default settings handle HELO domains as long as seven
30725 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
30726 of legitimate HELO domains.
30727
30728 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
30729 direct SRV lookups, this is not sufficient because of the extra parent domain
30730 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
30731 addresses into lookups in the reverse DNS space. The result of a successful
30732 lookup such as:
30733 .code
30734 ${lookup dnsdb {csa=$sender_helo_name}}
30735 .endd
30736 has two space-separated fields: an authorization code and a target host name.
30737 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
30738 authorization required but absent, or &"?"& for unknown.
30739
30740
30741
30742
30743 .section "Bounce address tag validation" "SECTverifyPRVS"
30744 .cindex "BATV, verifying"
30745 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
30746 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
30747 Genuine incoming bounce messages should therefore always be addressed to
30748 recipients that have a valid tag. This scheme is a way of detecting unwanted
30749 bounce messages caused by sender address forgeries (often called &"collateral
30750 spam"&), because the recipients of such messages do not include valid tags.
30751
30752 There are two expansion items to help with the implementation of the BATV
30753 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
30754 the original envelope sender address by using a simple key to add a hash of the
30755 address and some time-based randomizing information. The &%prvs%& expansion
30756 item creates a signed address, and the &%prvscheck%& expansion item checks one.
30757 The syntax of these expansion items is described in section
30758 &<<SECTexpansionitems>>&.
30759
30760 As an example, suppose the secret per-address keys are stored in an MySQL
30761 database. A query to look up the key for an address could be defined as a macro
30762 like this:
30763 .code
30764 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
30765                 WHERE sender='${quote_mysql:$prvscheck_address}'\
30766                 }{$value}}
30767 .endd
30768 Suppose also that the senders who make use of BATV are defined by an address
30769 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
30770 use this:
30771 .code
30772 # Bounces: drop unsigned addresses for BATV senders
30773 deny message = This address does not send an unsigned reverse path
30774      senders = :
30775      recipients = +batv_senders
30776
30777 # Bounces: In case of prvs-signed address, check signature.
30778 deny message = Invalid reverse path signature.
30779      senders = :
30780      condition  = ${prvscheck {$local_part@$domain}\
30781                   {PRVSCHECK_SQL}{1}}
30782      !condition = $prvscheck_result
30783 .endd
30784 The first statement rejects recipients for bounce messages that are addressed
30785 to plain BATV sender addresses, because it is known that BATV senders do not
30786 send out messages with plain sender addresses. The second statement rejects
30787 recipients that are prvs-signed, but with invalid signatures (either because
30788 the key is wrong, or the signature has timed out).
30789
30790 A non-prvs-signed address is not rejected by the second statement, because the
30791 &%prvscheck%& expansion yields an empty string if its first argument is not a
30792 prvs-signed address, thus causing the &%condition%& condition to be false. If
30793 the first argument is a syntactically valid prvs-signed address, the yield is
30794 the third string (in this case &"1"&), whether or not the cryptographic and
30795 timeout checks succeed. The &$prvscheck_result$& variable contains the result
30796 of the checks (empty for failure, &"1"& for success).
30797
30798 There is one more issue you must consider when implementing prvs-signing:
30799 you have to ensure that the routers accept prvs-signed addresses and
30800 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
30801 router to remove the signature with a configuration along these lines:
30802 .code
30803 batv_redirect:
30804   driver = redirect
30805   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
30806 .endd
30807 This works because, if the third argument of &%prvscheck%& is empty, the result
30808 of the expansion of a prvs-signed address is the decoded value of the original
30809 address. This router should probably be the first of your routers that handles
30810 local addresses.
30811
30812 To create BATV-signed addresses in the first place, a transport of this form
30813 can be used:
30814 .code
30815 external_smtp_batv:
30816   driver = smtp
30817   return_path = ${prvs {$return_path} \
30818                        {${lookup mysql{SELECT \
30819                        secret FROM batv_prvs WHERE \
30820                        sender='${quote_mysql:$sender_address}'} \
30821                        {$value}fail}}}
30822 .endd
30823 If no key can be found for the existing return path, no signing takes place.
30824
30825
30826
30827 .section "Using an ACL to control relaying" "SECTrelaycontrol"
30828 .cindex "&ACL;" "relay control"
30829 .cindex "relaying" "control by ACL"
30830 .cindex "policy control" "relay control"
30831 An MTA is said to &'relay'& a message if it receives it from some host and
30832 delivers it directly to another host as a result of a remote address contained
30833 within it. Redirecting a local address via an alias or forward file and then
30834 passing the message on to another host is not relaying,
30835 .cindex "&""percent hack""&"
30836 but a redirection as a result of the &"percent hack"& is.
30837
30838 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
30839 A host which is acting as a gateway or an MX backup is concerned with incoming
30840 relaying from arbitrary hosts to a specific set of domains. On the other hand,
30841 a host which is acting as a smart host for a number of clients is concerned
30842 with outgoing relaying from those clients to the Internet at large. Often the
30843 same host is fulfilling both functions,
30844 . ///
30845 . as illustrated in the diagram below,
30846 . ///
30847 but in principle these two kinds of relaying are entirely independent. What is
30848 not wanted is the transmission of mail from arbitrary remote hosts through your
30849 system to arbitrary domains.
30850
30851
30852 You can implement relay control by means of suitable statements in the ACL that
30853 runs for each RCPT command. For convenience, it is often easiest to use
30854 Exim's named list facility to define the domains and hosts involved. For
30855 example, suppose you want to do the following:
30856
30857 .ilist
30858 Deliver a number of domains to mailboxes on the local host (or process them
30859 locally in some other way). Let's say these are &'my.dom1.example'& and
30860 &'my.dom2.example'&.
30861 .next
30862 Relay mail for a number of other domains for which you are the secondary MX.
30863 These might be &'friend1.example'& and &'friend2.example'&.
30864 .next
30865 Relay mail from the hosts on your local LAN, to whatever domains are involved.
30866 Suppose your LAN is 192.168.45.0/24.
30867 .endlist
30868
30869
30870 In the main part of the configuration, you put the following definitions:
30871 .code
30872 domainlist local_domains    = my.dom1.example : my.dom2.example
30873 domainlist relay_to_domains = friend1.example : friend2.example
30874 hostlist   relay_from_hosts = 192.168.45.0/24
30875 .endd
30876 Now you can use these definitions in the ACL that is run for every RCPT
30877 command:
30878 .code
30879 acl_check_rcpt:
30880   accept domains = +local_domains : +relay_to_domains
30881   accept hosts   = +relay_from_hosts
30882 .endd
30883 The first statement accepts any RCPT command that contains an address in
30884 the local or relay domains. For any other domain, control passes to the second
30885 statement, which accepts the command only if it comes from one of the relay
30886 hosts. In practice, you will probably want to make your ACL more sophisticated
30887 than this, for example, by including sender and recipient verification. The
30888 default configuration includes a more comprehensive example, which is described
30889 in chapter &<<CHAPdefconfil>>&.
30890
30891
30892
30893 .section "Checking a relay configuration" "SECTcheralcon"
30894 .cindex "relaying" "checking control of"
30895 You can check the relay characteristics of your configuration in the same way
30896 that you can test any ACL behaviour for an incoming SMTP connection, by using
30897 the &%-bh%& option to run a fake SMTP session with which you interact.
30898
30899 For specifically testing for unwanted relaying, the host
30900 &'relay-test.mail-abuse.org'& provides a useful service. If you telnet to this
30901 host from the host on which Exim is running, using the normal telnet port, you
30902 will see a normal telnet connection message and then quite a long delay. Be
30903 patient. The remote host is making an SMTP connection back to your host, and
30904 trying a number of common probes to test for open relay vulnerability. The
30905 results of the tests will eventually appear on your terminal.
30906 .ecindex IIDacl
30907
30908
30909
30910 . ////////////////////////////////////////////////////////////////////////////
30911 . ////////////////////////////////////////////////////////////////////////////
30912
30913 .chapter "Content scanning at ACL time" "CHAPexiscan"
30914 .scindex IIDcosca "content scanning" "at ACL time"
30915 The extension of Exim to include content scanning at ACL time, formerly known
30916 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
30917 was integrated into the main source for Exim release 4.50, and Tom continues to
30918 maintain it. Most of the wording of this chapter is taken from Tom's
30919 specification.
30920
30921 It is also possible to scan the content of messages at other times. The
30922 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
30923 scanning after all the ACLs have run. A transport filter can be used to scan
30924 messages at delivery time (see the &%transport_filter%& option, described in
30925 chapter &<<CHAPtransportgeneric>>&).
30926
30927 If you want to include the ACL-time content-scanning features when you compile
30928 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
30929 &_Local/Makefile_&. When you do that, the Exim binary is built with:
30930
30931 .ilist
30932 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
30933 for all MIME parts for SMTP and non-SMTP messages, respectively.
30934 .next
30935 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
30936 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
30937 run at the end of message reception (the &%acl_smtp_data%& ACL).
30938 .next
30939 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
30940 of messages, or parts of messages, for debugging purposes.
30941 .next
30942 Additional expansion variables that are set in the new ACL and by the new
30943 conditions.
30944 .next
30945 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
30946 .endlist
30947
30948 There is another content-scanning configuration option for &_Local/Makefile_&,
30949 called WITH_OLD_DEMIME. If this is set, the old, deprecated &%demime%& ACL
30950 condition is compiled, in addition to all the other content-scanning features.
30951
30952 Content-scanning is continually evolving, and new features are still being
30953 added. While such features are still unstable and liable to incompatible
30954 changes, they are made available in Exim by setting options whose names begin
30955 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
30956 this manual. You can find out about them by reading the file called
30957 &_doc/experimental.txt_&.
30958
30959 All the content-scanning facilities work on a MBOX copy of the message that is
30960 temporarily created in a file called:
30961 .display
30962 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
30963 .endd
30964 The &_.eml_& extension is a friendly hint to virus scanners that they can
30965 expect an MBOX-like structure inside that file. The file is created when the
30966 first content scanning facility is called. Subsequent calls to content
30967 scanning conditions open the same file again. The directory is recursively
30968 removed when the &%acl_smtp_data%& ACL has finished running, unless
30969 .code
30970 control = no_mbox_unspool
30971 .endd
30972 has been encountered. When the MIME ACL decodes files, they are put into the
30973 same directory by default.
30974
30975
30976
30977 .section "Scanning for viruses" "SECTscanvirus"
30978 .cindex "virus scanning"
30979 .cindex "content scanning" "for viruses"
30980 .cindex "content scanning" "the &%malware%& condition"
30981 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
30982 It supports a &"generic"& interface to scanners called via the shell, and
30983 specialized interfaces for &"daemon"& type virus scanners, which are resident
30984 in memory and thus are much faster.
30985
30986 A timeout of 2 minutes is applied to a scanner call (by default);
30987 if it expires then a defer action is taken.
30988
30989 .oindex "&%av_scanner%&"
30990 You can set the &%av_scanner%& option in the main part of the configuration
30991 to specify which scanner to use, together with any additional options that
30992 are needed. The basic syntax is as follows:
30993 .display
30994 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
30995 .endd
30996 If you do not set &%av_scanner%&, it defaults to
30997 .code
30998 av_scanner = sophie:/var/run/sophie
30999 .endd
31000 If the value of &%av_scanner%& starts with a dollar character, it is expanded
31001 before use.
31002 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
31003 The following scanner types are supported in this release:
31004
31005 .vlist
31006 .vitem &%avast%&
31007 .cindex "virus scanners" "avast"
31008 This is the scanner daemon of Avast. It has been tested with Avast Core
31009 Security (currently at version 1.1.7).
31010 You can get a trial version at &url(http://www.avast.com) or for Linux
31011 at &url(http://www.avast.com/linux-server-antivirus).
31012 This scanner type takes one option,
31013 which can be either a full path to a UNIX socket,
31014 or host and port specifiers separated by white space.
31015 The host may be a name or an IP address; the port is either a
31016 single number or a pair of numbers with a dash between.
31017 Any further options are given, on separate lines,
31018 to the daemon as options before the main scan command.
31019 For example:
31020 .code
31021 av_scanner = avast:/var/run/avast/scan.sock:FLAGS -fullfiles:SENSITIVITY -pup
31022 av_scanner = avast:192.168.2.22 5036
31023 .endd
31024 If you omit the argument, the default path
31025 &_/var/run/avast/scan.sock_&
31026 is used.
31027 If you use a remote host,
31028 you need to make Exim's spool directory available to it,
31029 as the scanner is passed a file path, not file contents.
31030 For information about available commands and their options you may use
31031 .code
31032 $ socat UNIX:/var/run/avast/scan.sock STDIO:
31033     FLAGS
31034     SENSITIVITY
31035     PACK
31036 .endd
31037
31038
31039 .vitem &%aveserver%&
31040 .cindex "virus scanners" "Kaspersky"
31041 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
31042 at &url(http://www.kaspersky.com). This scanner type takes one option,
31043 which is the path to the daemon's UNIX socket. The default is shown in this
31044 example:
31045 .code
31046 av_scanner = aveserver:/var/run/aveserver
31047 .endd
31048
31049
31050 .vitem &%clamd%&
31051 .cindex "virus scanners" "clamd"
31052 This daemon-type scanner is GPL and free. You can get it at
31053 &url(http://www.clamav.net/). Some older versions of clamd do not seem to
31054 unpack MIME containers, so it used to be recommended to unpack MIME attachments
31055 in the MIME ACL. This is no longer believed to be necessary.
31056
31057 The options are a list of server specifiers, which may be
31058 a UNIX socket specification,
31059 a TCP socket specification,
31060 or a (global) option.
31061
31062 A socket specification consists of a space-separated list.
31063 For a Unix socket the first element is a full path for the socket,
31064 for a TCP socket the first element is the IP address
31065 and the second a port number,
31066 Any further elements are per-server (non-global) options.
31067 These per-server options are supported:
31068 .code
31069 retry=<timespec>        Retry on connect fail
31070 .endd
31071
31072 The &`retry`& option specifies a time after which a single retry for
31073 a failed connect is made.  The default is to not retry.
31074
31075 If a Unix socket file is specified, only one server is supported.
31076
31077 Examples:
31078 .code
31079 av_scanner = clamd:/opt/clamd/socket
31080 av_scanner = clamd:192.0.2.3 1234
31081 av_scanner = clamd:192.0.2.3 1234:local
31082 av_scanner = clamd:192.0.2.3 1234 retry=10s
31083 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
31084 .endd
31085 If the value of av_scanner points to a UNIX socket file or contains the
31086 &`local`&
31087 option, then the ClamAV interface will pass a filename containing the data
31088 to be scanned, which will should normally result in less I/O happening and be
31089 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
31090 Exim does not assume that there is a common filesystem with the remote host.
31091 There is an option WITH_OLD_CLAMAV_STREAM in &_src/EDITME_& available, should
31092 you be running a version of ClamAV prior to 0.95.
31093
31094 The final example shows that multiple TCP targets can be specified.  Exim will
31095 randomly use one for each incoming email (i.e. it load balances them).  Note
31096 that only TCP targets may be used if specifying a list of scanners; a UNIX
31097 socket cannot be mixed in with TCP targets.  If one of the servers becomes
31098 unavailable, Exim will try the remaining one(s) until it finds one that works.
31099 When a clamd server becomes unreachable, Exim will log a message.  Exim does
31100 not keep track of scanner state between multiple messages, and the scanner
31101 selection is random, so the message will get logged in the mainlog for each
31102 email that the down scanner gets chosen first (message wrapped to be readable):
31103 .code
31104 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
31105    clamd: connection to localhost, port 3310 failed
31106    (Connection refused)
31107 .endd
31108
31109 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
31110 contributing the code for this scanner.
31111
31112 .vitem &%cmdline%&
31113 .cindex "virus scanners" "command line interface"
31114 This is the keyword for the generic command line scanner interface. It can be
31115 used to attach virus scanners that are invoked from the shell. This scanner
31116 type takes 3 mandatory options:
31117
31118 .olist
31119 The full path and name of the scanner binary, with all command line options,
31120 and a placeholder (&`%s`&) for the directory to scan.
31121
31122 .next
31123 A regular expression to match against the STDOUT and STDERR output of the
31124 virus scanner. If the expression matches, a virus was found. You must make
31125 absolutely sure that this expression matches on &"virus found"&. This is called
31126 the &"trigger"& expression.
31127
31128 .next
31129 Another regular expression, containing exactly one pair of parentheses, to
31130 match the name of the virus found in the scanners output. This is called the
31131 &"name"& expression.
31132 .endlist olist
31133
31134 For example, Sophos Sweep reports a virus on a line like this:
31135 .code
31136 Virus 'W32/Magistr-B' found in file ./those.bat
31137 .endd
31138 For the trigger expression, we can match the phrase &"found in file"&. For the
31139 name expression, we want to extract the W32/Magistr-B string, so we can match
31140 for the single quotes left and right of it. Altogether, this makes the
31141 configuration setting:
31142 .code
31143 av_scanner = cmdline:\
31144              /path/to/sweep -ss -all -rec -archive %s:\
31145              found in file:'(.+)'
31146 .endd
31147 .vitem &%drweb%&
31148 .cindex "virus scanners" "DrWeb"
31149 The DrWeb daemon scanner (&url(http://www.sald.com/)) interface
31150 takes one option,
31151 either a full path to a UNIX socket,
31152 or host and port specifiers separated by white space.
31153 The host may be a name or an IP address; the port is either a
31154 single number or a pair of numbers with a dash between.
31155 For example:
31156 .code
31157 av_scanner = drweb:/var/run/drwebd.sock
31158 av_scanner = drweb:192.168.2.20 31337
31159 .endd
31160 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
31161 is used. Thanks to Alex Miller for contributing the code for this scanner.
31162
31163 .vitem &%f-protd%&
31164 .cindex "virus scanners" "f-protd"
31165 The f-protd scanner is accessed via HTTP over TCP.
31166 One argument is taken, being a space-separated hostname and port number
31167 (or port-range).
31168 For example:
31169 .code
31170 av_scanner = f-protd:localhost 10200-10204
31171 .endd
31172 If you omit the argument, the default values show above are used.
31173
31174 .vitem &%fsecure%&
31175 .cindex "virus scanners" "F-Secure"
31176 The F-Secure daemon scanner (&url(http://www.f-secure.com)) takes one
31177 argument which is the path to a UNIX socket. For example:
31178 .code
31179 av_scanner = fsecure:/path/to/.fsav
31180 .endd
31181 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
31182 Thelmen for contributing the code for this scanner.
31183
31184 .vitem &%kavdaemon%&
31185 .cindex "virus scanners" "Kaspersky"
31186 This is the scanner daemon of Kaspersky Version 4. This version of the
31187 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
31188 scanner type takes one option, which is the path to the daemon's UNIX socket.
31189 For example:
31190 .code
31191 av_scanner = kavdaemon:/opt/AVP/AvpCtl
31192 .endd
31193 The default path is &_/var/run/AvpCtl_&.
31194
31195 .vitem &%mksd%&
31196 .cindex "virus scanners" "mksd"
31197 This is a daemon type scanner that is aimed mainly at Polish users, though some
31198 parts of documentation are now available in English. You can get it at
31199 &url(http://linux.mks.com.pl/). The only option for this scanner type is
31200 the maximum number of processes used simultaneously to scan the attachments,
31201 provided that the demime facility is employed and also provided that mksd has
31202 been run with at least the same number of child processes. For example:
31203 .code
31204 av_scanner = mksd:2
31205 .endd
31206 You can safely omit this option (the default value is 1).
31207
31208 .vitem &%sock%&
31209 .cindex "virus scanners" "simple socket-connected"
31210 This is a general-purpose way of talking to simple scanner daemons
31211 running on the local machine.
31212 There are four options:
31213 an address (which may be an IP address and port, or the path of a Unix socket),
31214 a commandline to send (may include a single %s which will be replaced with
31215 the path to the mail file to be scanned),
31216 an RE to trigger on from the returned data,
31217 an RE to extract malware_name from the returned data.
31218 For example:
31219 .code
31220 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)\$
31221 .endd
31222 Default for the socket specifier is &_/tmp/malware.sock_&.
31223 Default for the commandline is &_%s\n_&.
31224 Both regular-expressions are required.
31225
31226 .vitem &%sophie%&
31227 .cindex "virus scanners" "Sophos and Sophie"
31228 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
31229 You can get Sophie at &url(http://www.clanfield.info/sophie/). The only option
31230 for this scanner type is the path to the UNIX socket that Sophie uses for
31231 client communication. For example:
31232 .code
31233 av_scanner = sophie:/tmp/sophie
31234 .endd
31235 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
31236 the option.
31237 .endlist
31238
31239 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
31240 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
31241 ACL.
31242
31243 The &%av_scanner%& option is expanded each time &%malware%& is called. This
31244 makes it possible to use different scanners. See further below for an example.
31245 The &%malware%& condition caches its results, so when you use it multiple times
31246 for the same message, the actual scanning process is only carried out once.
31247 However, using expandable items in &%av_scanner%& disables this caching, in
31248 which case each use of the &%malware%& condition causes a new scan of the
31249 message.
31250
31251 The &%malware%& condition takes a right-hand argument that is expanded before
31252 use and taken as a list, slash-separated by default.
31253 The first element can then be one of
31254
31255 .ilist
31256 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
31257 The condition succeeds if a virus was found, and fail otherwise. This is the
31258 recommended usage.
31259 .next
31260 &"false"& or &"0"& or an empty string, in which case no scanning is done and
31261 the condition fails immediately.
31262 .next
31263 A regular expression, in which case the message is scanned for viruses. The
31264 condition succeeds if a virus is found and its name matches the regular
31265 expression. This allows you to take special actions on certain types of virus.
31266 Note that &"/"& characters in the RE must be doubled due to the list-processing,
31267 unless the separator is changed (in the usual way).
31268 .endlist
31269
31270 You can append a &`defer_ok`& element to the &%malware%& argument list to accept
31271 messages even if there is a problem with the virus scanner.
31272 Otherwise, such a problem causes the ACL to defer.
31273
31274 You can append a &`tmo=<val>`& element to the &%malware%& argument list to
31275 specify a non-default timeout.  The default is two minutes.
31276 For example:
31277 .code
31278 malware = * / defer_ok / tmo=10s
31279 .endd
31280 A timeout causes the ACL to defer.
31281
31282 .vindex "&$callout_address$&"
31283 When a connection is made to the scanner the expansion variable &$callout_address$&
31284 is set to record the actual address used.
31285
31286 .vindex "&$malware_name$&"
31287 When a virus is found, the condition sets up an expansion variable called
31288 &$malware_name$& that contains the name of the virus. You can use it in a
31289 &%message%& modifier that specifies the error returned to the sender, and/or in
31290 logging data.
31291
31292 If your virus scanner cannot unpack MIME and TNEF containers itself, you should
31293 use the &%demime%& condition (see section &<<SECTdemimecond>>&) before the
31294 &%malware%& condition.
31295
31296 Beware the interaction of Exim's &%message_size_limit%& with any size limits
31297 imposed by your anti-virus scanner.
31298
31299 Here is a very simple scanning example:
31300 .code
31301 deny message = This message contains malware ($malware_name)
31302      demime = *
31303      malware = *
31304 .endd
31305 The next example accepts messages when there is a problem with the scanner:
31306 .code
31307 deny message = This message contains malware ($malware_name)
31308      demime = *
31309      malware = */defer_ok
31310 .endd
31311 The next example shows how to use an ACL variable to scan with both sophie and
31312 aveserver. It assumes you have set:
31313 .code
31314 av_scanner = $acl_m0
31315 .endd
31316 in the main Exim configuration.
31317 .code
31318 deny message = This message contains malware ($malware_name)
31319      set acl_m0 = sophie
31320      malware = *
31321
31322 deny message = This message contains malware ($malware_name)
31323      set acl_m0 = aveserver
31324      malware = *
31325 .endd
31326
31327
31328 .section "Scanning with SpamAssassin and Rspamd" "SECTscanspamass"
31329 .cindex "content scanning" "for spam"
31330 .cindex "spam scanning"
31331 .cindex "SpamAssassin"
31332 .cindex "Rspamd"
31333 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
31334 score and a report for the message.
31335 Support is also provided for Rspamd.
31336
31337 For more information about installation and configuration of SpamAssassin or
31338 Rspamd refer to their respective websites at
31339 &url(http://spamassassin.apache.org) and &url(http://www.rspamd.com)
31340
31341 SpamAssassin can be installed with CPAN by running:
31342 .code
31343 perl -MCPAN -e 'install Mail::SpamAssassin'
31344 .endd
31345 SpamAssassin has its own set of configuration files. Please review its
31346 documentation to see how you can tweak it. The default installation should work
31347 nicely, however.
31348
31349 .oindex "&%spamd_address%&"
31350 By default, SpamAssassin listens on 127.0.0.1, TCP port 783 and if you
31351 intend to use an instance running on the local host you do not need to set
31352 &%spamd_address%&. If you intend to use another host or port for SpamAssassin,
31353 you must set the &%spamd_address%& option in the global part of the Exim
31354 configuration as follows (example):
31355 .code
31356 spamd_address = 192.168.99.45 387
31357 .endd
31358
31359 To use Rspamd (which by default listens on all local addresses
31360 on TCP port 11333)
31361 you should add &%variant=rspamd%& after the address/port pair, for example:
31362 .code
31363 spamd_address = 127.0.0.1 11333 variant=rspamd
31364 .endd
31365
31366 As of version 2.60, &%SpamAssassin%& also supports communication over UNIX
31367 sockets. If you want to us these, supply &%spamd_address%& with an absolute
31368 file name instead of an address/port pair:
31369 .code
31370 spamd_address = /var/run/spamd_socket
31371 .endd
31372 You can have multiple &%spamd%& servers to improve scalability. These can
31373 reside on other hardware reachable over the network. To specify multiple
31374 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
31375 option, separated with colons (the separator can be changed in the usual way):
31376 .code
31377 spamd_address = 192.168.2.10 783 : \
31378                 192.168.2.11 783 : \
31379                 192.168.2.12 783
31380 .endd
31381 Up to 32 &%spamd%& servers are supported.
31382 When a server fails to respond to the connection attempt, all other
31383 servers are tried until one succeeds. If no server responds, the &%spam%&
31384 condition defers.
31385
31386 Unix and TCP socket specifications may be mixed in any order.
31387 Each element of the list is a list itself, space-separated by default
31388 and changeable in the usual way.
31389
31390 For TCP socket specifications a host name or IP (v4 or v6, but
31391 subject to list-separator quoting rules) address can be used,
31392 and the port can be one or a dash-separated pair.
31393 In the latter case, the range is tried in strict order.
31394
31395 Elements after the first for Unix sockets, or second for TCP socket,
31396 are options.
31397 The supported options are:
31398 .code
31399 pri=<priority>      Selection priority
31400 weight=<value>      Selection bias
31401 time=<start>-<end>  Use only between these times of day
31402 retry=<timespec>    Retry on connect fail
31403 tmo=<timespec>      Connection time limit
31404 variant=rspamd      Use Rspamd rather than SpamAssassin protocol
31405 .endd
31406
31407 The &`pri`& option specifies a priority for the server within the list,
31408 higher values being tried first.
31409 The default priority is 1.
31410
31411 The &`weight`& option specifies a selection bias.
31412 Within a priority set
31413 servers are queried in a random fashion, weighted by this value.
31414 The default value for selection bias is 1.
31415
31416 Time specifications for the &`time`& option are <hour>.<minute>.<second>
31417 in the local time zone; each element being one or more digits.
31418 Either the seconds or both minutes and seconds, plus the leading &`.`&
31419 characters, may be omitted and will be taken as zero.
31420
31421 Timeout specifications for the &`retry`& and &`tmo`& options
31422 are the usual Exim time interval standard, e.g. &`20s`& or &`1m`&.
31423
31424 The &`tmo`& option specifies an overall timeout for communication.
31425 The default value is two minutes.
31426
31427 The &`retry`& option specifies a time after which a single retry for
31428 a failed connect is made.
31429 The default is to not retry.
31430
31431 The &%spamd_address%& variable is expanded before use if it starts with
31432 a dollar sign. In this case, the expansion may return a string that is
31433 used as the list so that multiple spamd servers can be the result of an
31434 expansion.
31435
31436 .vindex "&$callout_address$&"
31437 When a connection is made to the server the expansion variable &$callout_address$&
31438 is set to record the actual address used.
31439
31440 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
31441 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
31442 .code
31443 deny message = This message was classified as SPAM
31444      spam = joe
31445 .endd
31446 The right-hand side of the &%spam%& condition specifies a name. This is
31447 relevant if you have set up multiple SpamAssassin profiles. If you do not want
31448 to scan using a specific profile, but rather use the SpamAssassin system-wide
31449 default profile, you can scan for an unknown name, or simply use &"nobody"&.
31450 Rspamd does not use this setting. However, you must put something on the
31451 right-hand side.
31452
31453 The name allows you to use per-domain or per-user antispam profiles in
31454 principle, but this is not straightforward in practice, because a message may
31455 have multiple recipients, not necessarily all in the same domain. Because the
31456 &%spam%& condition has to be called from a DATA-time ACL in order to be able to
31457 read the contents of the message, the variables &$local_part$& and &$domain$&
31458 are not set.
31459 Careful enforcement of single-recipient messages
31460 (e.g. by responding with defer in the recipient ACL for all recipients
31461 after the first),
31462 or the use of PRDR,
31463 .cindex "PRDR" "use for per-user SpamAssassin profiles"
31464 are needed to use this feature.
31465
31466 The right-hand side of the &%spam%& condition is expanded before being used, so
31467 you can put lookups or conditions there. When the right-hand side evaluates to
31468 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
31469
31470
31471 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
31472 large ones may cause significant performance degradation. As most spam messages
31473 are quite small, it is recommended that you do not scan the big ones. For
31474 example:
31475 .code
31476 deny message = This message was classified as SPAM
31477      condition = ${if < {$message_size}{10K}}
31478      spam = nobody
31479 .endd
31480
31481 The &%spam%& condition returns true if the threshold specified in the user's
31482 SpamAssassin profile has been matched or exceeded. If you want to use the
31483 &%spam%& condition for its side effects (see the variables below), you can make
31484 it always return &"true"& by appending &`:true`& to the username.
31485
31486 .cindex "spam scanning" "returned variables"
31487 When the &%spam%& condition is run, it sets up a number of expansion
31488 variables.
31489 Except for &$spam_report$&,
31490 these variables are saved with the received message so are
31491 available for use at delivery time.
31492
31493 .vlist
31494 .vitem &$spam_score$&
31495 The spam score of the message, for example &"3.4"& or &"30.5"&. This is useful
31496 for inclusion in log or reject messages.
31497
31498 .vitem &$spam_score_int$&
31499 The spam score of the message, multiplied by ten, as an integer value. For
31500 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
31501 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
31502 The integer value is useful for numeric comparisons in conditions.
31503
31504 .vitem &$spam_bar$&
31505 A string consisting of a number of &"+"& or &"-"& characters, representing the
31506 integer part of the spam score value. A spam score of 4.4 would have a
31507 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
31508 headers, since MUAs can match on such strings. The maximum length of the
31509 spam bar is 50 characters.
31510
31511 .vitem &$spam_report$&
31512 A multiline text table, containing the full SpamAssassin report for the
31513 message. Useful for inclusion in headers or reject messages.
31514 This variable is only usable in a DATA-time ACL.
31515
31516 .vitem &$spam_action$&
31517 For SpamAssassin either 'reject' or 'no action' depending on the
31518 spam score versus threshold.
31519 For Rspamd, the recommended action.
31520
31521 .endlist
31522
31523 The &%spam%& condition caches its results unless expansion in
31524 spamd_address was used. If you call it again with the same user name, it
31525 does not scan again, but rather returns the same values as before.
31526
31527 The &%spam%& condition returns DEFER if there is any error while running
31528 the message through SpamAssassin or if the expansion of spamd_address
31529 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
31530 statement block), append &`/defer_ok`& to the right-hand side of the
31531 spam condition, like this:
31532 .code
31533 deny message = This message was classified as SPAM
31534      spam    = joe/defer_ok
31535 .endd
31536 This causes messages to be accepted even if there is a problem with &%spamd%&.
31537
31538 Here is a longer, commented example of the use of the &%spam%&
31539 condition:
31540 .code
31541 # put headers in all messages (no matter if spam or not)
31542 warn  spam = nobody:true
31543       add_header = X-Spam-Score: $spam_score ($spam_bar)
31544       add_header = X-Spam-Report: $spam_report
31545
31546 # add second subject line with *SPAM* marker when message
31547 # is over threshold
31548 warn  spam = nobody
31549       add_header = Subject: *SPAM* $h_Subject:
31550
31551 # reject spam at high scores (> 12)
31552 deny  message = This message scored $spam_score spam points.
31553       spam = nobody:true
31554       condition = ${if >{$spam_score_int}{120}{1}{0}}
31555 .endd
31556
31557
31558
31559 .section "Scanning MIME parts" "SECTscanmimepart"
31560 .cindex "content scanning" "MIME parts"
31561 .cindex "MIME content scanning"
31562 .oindex "&%acl_smtp_mime%&"
31563 .oindex "&%acl_not_smtp_mime%&"
31564 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
31565 each MIME part of an SMTP message, including multipart types, in the sequence
31566 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
31567 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
31568 options may both refer to the same ACL if you want the same processing in both
31569 cases.
31570
31571 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
31572 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
31573 the case of a non-SMTP message. However, a MIME ACL is called only if the
31574 message contains a &'Content-Type:'& header line. When a call to a MIME
31575 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
31576 result code is sent to the client. In the case of an SMTP message, the
31577 &%acl_smtp_data%& ACL is not called when this happens.
31578
31579 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
31580 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
31581 condition to match against the raw MIME part. You can also use the
31582 &%mime_regex%& condition to match against the decoded MIME part (see section
31583 &<<SECTscanregex>>&).
31584
31585 At the start of a MIME ACL, a number of variables are set from the header
31586 information for the relevant MIME part. These are described below. The contents
31587 of the MIME part are not by default decoded into a disk file except for MIME
31588 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
31589 part into a disk file, you can use the &%decode%& condition. The general
31590 syntax is:
31591 .display
31592 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
31593 .endd
31594 The right hand side is expanded before use. After expansion,
31595 the value can be:
31596
31597 .olist
31598 &"0"& or &"false"&, in which case no decoding is done.
31599 .next
31600 The string &"default"&. In that case, the file is put in the temporary
31601 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
31602 a sequential file name consisting of the message id and a sequence number. The
31603 full path and name is available in &$mime_decoded_filename$& after decoding.
31604 .next
31605 A full path name starting with a slash. If the full name is an existing
31606 directory, it is used as a replacement for the default directory. The filename
31607 is then sequentially assigned. If the path does not exist, it is used as
31608 the full path and file name.
31609 .next
31610 If the string does not start with a slash, it is used as the
31611 filename, and the default path is then used.
31612 .endlist
31613 The &%decode%& condition normally succeeds. It is only false for syntax
31614 errors or unusual circumstances such as memory shortages. You can easily decode
31615 a file with its original, proposed filename using
31616 .code
31617 decode = $mime_filename
31618 .endd
31619 However, you should keep in mind that &$mime_filename$& might contain
31620 anything. If you place files outside of the default path, they are not
31621 automatically unlinked.
31622
31623 For RFC822 attachments (these are messages attached to messages, with a
31624 content-type of &"message/rfc822"&), the ACL is called again in the same manner
31625 as for the primary message, only that the &$mime_is_rfc822$& expansion
31626 variable is set (see below). Attached messages are always decoded to disk
31627 before being checked, and the files are unlinked once the check is done.
31628
31629 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
31630 used to match regular expressions against raw and decoded MIME parts,
31631 respectively. They are described in section &<<SECTscanregex>>&.
31632
31633 .cindex "MIME content scanning" "returned variables"
31634 The following list describes all expansion variables that are
31635 available in the MIME ACL:
31636
31637 .vlist
31638 .vitem &$mime_boundary$&
31639 If the current part is a multipart (see &$mime_is_multipart$&) below, it should
31640 have a boundary string, which is stored in this variable. If the current part
31641 has no boundary parameter in the &'Content-Type:'& header, this variable
31642 contains the empty string.
31643
31644 .vitem &$mime_charset$&
31645 This variable contains the character set identifier, if one was found in the
31646 &'Content-Type:'& header. Examples for charset identifiers are:
31647 .code
31648 us-ascii
31649 gb2312 (Chinese)
31650 iso-8859-1
31651 .endd
31652 Please note that this value is not normalized, so you should do matches
31653 case-insensitively.
31654
31655 .vitem &$mime_content_description$&
31656 This variable contains the normalized content of the &'Content-Description:'&
31657 header. It can contain a human-readable description of the parts content. Some
31658 implementations repeat the filename for attachments here, but they are usually
31659 only used for display purposes.
31660
31661 .vitem &$mime_content_disposition$&
31662 This variable contains the normalized content of the &'Content-Disposition:'&
31663 header. You can expect strings like &"attachment"& or &"inline"& here.
31664
31665 .vitem &$mime_content_id$&
31666 This variable contains the normalized content of the &'Content-ID:'& header.
31667 This is a unique ID that can be used to reference a part from another part.
31668
31669 .vitem &$mime_content_size$&
31670 This variable is set only after the &%decode%& modifier (see above) has been
31671 successfully run. It contains the size of the decoded part in kilobytes. The
31672 size is always rounded up to full kilobytes, so only a completely empty part
31673 has a &$mime_content_size$& of zero.
31674
31675 .vitem &$mime_content_transfer_encoding$&
31676 This variable contains the normalized content of the
31677 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
31678 type. Typical values are &"base64"& and &"quoted-printable"&.
31679
31680 .vitem &$mime_content_type$&
31681 If the MIME part has a &'Content-Type:'& header, this variable contains its
31682 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
31683 are some examples of popular MIME types, as they may appear in this variable:
31684 .code
31685 text/plain
31686 text/html
31687 application/octet-stream
31688 image/jpeg
31689 audio/midi
31690 .endd
31691 If the MIME part has no &'Content-Type:'& header, this variable contains the
31692 empty string.
31693
31694 .vitem &$mime_decoded_filename$&
31695 This variable is set only after the &%decode%& modifier (see above) has been
31696 successfully run. It contains the full path and file name of the file
31697 containing the decoded data.
31698 .endlist
31699
31700 .cindex "RFC 2047"
31701 .vlist
31702 .vitem &$mime_filename$&
31703 This is perhaps the most important of the MIME variables. It contains a
31704 proposed filename for an attachment, if one was found in either the
31705 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
31706 RFC2047
31707 or RFC2231
31708 decoded, but no additional sanity checks are done.
31709  If no filename was
31710 found, this variable contains the empty string.
31711
31712 .vitem &$mime_is_coverletter$&
31713 This variable attempts to differentiate the &"cover letter"& of an e-mail from
31714 attached data. It can be used to clamp down on flashy or unnecessarily encoded
31715 content in the cover letter, while not restricting attachments at all.
31716
31717 The variable contains 1 (true) for a MIME part believed to be part of the
31718 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
31719 follows:
31720
31721 .olist
31722 The outermost MIME part of a message is always a cover letter.
31723
31724 .next
31725 If a multipart/alternative or multipart/related MIME part is a cover letter,
31726 so are all MIME subparts within that multipart.
31727
31728 .next
31729 If any other multipart is a cover letter, the first subpart is a cover letter,
31730 and the rest are attachments.
31731
31732 .next
31733 All parts contained within an attachment multipart are attachments.
31734 .endlist olist
31735
31736 As an example, the following will ban &"HTML mail"& (including that sent with
31737 alternative plain text), while allowing HTML files to be attached. HTML
31738 coverletter mail attached to non-HMTL coverletter mail will also be allowed:
31739 .code
31740 deny message = HTML mail is not accepted here
31741 !condition = $mime_is_rfc822
31742 condition = $mime_is_coverletter
31743 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
31744 .endd
31745 .vitem &$mime_is_multipart$&
31746 This variable has the value 1 (true) when the current part has the main type
31747 &"multipart"&, for example &"multipart/alternative"& or &"multipart/mixed"&.
31748 Since multipart entities only serve as containers for other parts, you may not
31749 want to carry out specific actions on them.
31750
31751 .vitem &$mime_is_rfc822$&
31752 This variable has the value 1 (true) if the current part is not a part of the
31753 checked message itself, but part of an attached message. Attached message
31754 decoding is fully recursive.
31755
31756 .vitem &$mime_part_count$&
31757 This variable is a counter that is raised for each processed MIME part. It
31758 starts at zero for the very first part (which is usually a multipart). The
31759 counter is per-message, so it is reset when processing RFC822 attachments (see
31760 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
31761 complete, so you can use it in the DATA ACL to determine the number of MIME
31762 parts of a message. For non-MIME messages, this variable contains the value -1.
31763 .endlist
31764
31765
31766
31767 .section "Scanning with regular expressions" "SECTscanregex"
31768 .cindex "content scanning" "with regular expressions"
31769 .cindex "regular expressions" "content scanning with"
31770 You can specify your own custom regular expression matches on the full body of
31771 the message, or on individual MIME parts.
31772
31773 The &%regex%& condition takes one or more regular expressions as arguments and
31774 matches them against the full message (when called in the DATA ACL) or a raw
31775 MIME part (when called in the MIME ACL). The &%regex%& condition matches
31776 linewise, with a maximum line length of 32K characters. That means you cannot
31777 have multiline matches with the &%regex%& condition.
31778
31779 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
31780 to 32K of decoded content (the whole content at once, not linewise). If the
31781 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
31782 is decoded automatically when &%mime_regex%& is executed (using default path
31783 and filename values). If the decoded data is larger than  32K, only the first
31784 32K characters are checked.
31785
31786 The regular expressions are passed as a colon-separated list. To include a
31787 literal colon, you must double it. Since the whole right-hand side string is
31788 expanded before being used, you must also escape dollar signs and backslashes
31789 with more backslashes, or use the &`\N`& facility to disable expansion.
31790 Here is a simple example that contains two regular expressions:
31791 .code
31792 deny message = contains blacklisted regex ($regex_match_string)
31793      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
31794 .endd
31795 The conditions returns true if any one of the regular expressions matches. The
31796 &$regex_match_string$& expansion variable is then set up and contains the
31797 matching regular expression.
31798 The expansion variables &$regex1$& &$regex2$& etc
31799 are set to any substrings captured by the regular expression.
31800
31801 &*Warning*&: With large messages, these conditions can be fairly
31802 CPU-intensive.
31803
31804
31805
31806
31807 .section "The demime condition" "SECTdemimecond"
31808 .cindex "content scanning" "MIME checking"
31809 .cindex "MIME content scanning"
31810 The &%demime%& ACL condition provides MIME unpacking, sanity checking and file
31811 extension blocking. It is usable only in the DATA and non-SMTP ACLs. The
31812 &%demime%& condition uses a simpler interface to MIME decoding than the MIME
31813 ACL functionality, but provides no additional facilities. Please note that this
31814 condition is deprecated and kept only for backward compatibility. You must set
31815 the WITH_OLD_DEMIME option in &_Local/Makefile_& at build time to be able to
31816 use the &%demime%& condition.
31817
31818 The &%demime%& condition unpacks MIME containers in the message. It detects
31819 errors in MIME containers and can match file extensions found in the message
31820 against a list. Using this facility produces files containing the unpacked MIME
31821 parts of the message in the temporary scan directory. If you do antivirus
31822 scanning, it is recommended that you use the &%demime%& condition before the
31823 antivirus (&%malware%&) condition.
31824
31825 On the right-hand side of the &%demime%& condition you can pass a
31826 colon-separated list of file extensions that it should match against. For
31827 example:
31828 .code
31829 deny message = Found blacklisted file attachment
31830      demime  = vbs:com:bat:pif:prf:lnk
31831 .endd
31832 If one of the file extensions is found, the condition is true, otherwise it is
31833 false. If there is a temporary error while demimeing (for example, &"disk
31834 full"&), the condition defers, and the message is temporarily rejected (unless
31835 the condition is on a &%warn%& verb).
31836
31837 The right-hand side is expanded before being treated as a list, so you can have
31838 conditions and lookups there. If it expands to an empty string, &"false"&, or
31839 zero (&"0"&), no demimeing is done and the condition is false.
31840
31841 The &%demime%& condition set the following variables:
31842
31843 .vlist
31844 .vitem &$demime_errorlevel$&
31845 .vindex "&$demime_errorlevel$&"
31846 When an error is detected in a MIME container, this variable contains the
31847 severity of the error, as an integer number. The higher the value, the more
31848 severe the error (the current maximum value is 3). If this variable is unset or
31849 zero, no error occurred.
31850
31851 .vitem &$demime_reason$&
31852 .vindex "&$demime_reason$&"
31853 When &$demime_errorlevel$& is greater than zero, this variable contains a
31854 human-readable text string describing the MIME error that occurred.
31855 .endlist
31856
31857 .vlist
31858 .vitem &$found_extension$&
31859 .vindex "&$found_extension$&"
31860 When the &%demime%& condition is true, this variable contains the file
31861 extension it found.
31862 .endlist
31863
31864 Both &$demime_errorlevel$& and &$demime_reason$& are set by the first call of
31865 the &%demime%& condition, and are not changed on subsequent calls.
31866
31867 If you do not want to check for file extensions, but rather use the &%demime%&
31868 condition for unpacking or error checking purposes, pass &"*"& as the
31869 right-hand side value. Here is a more elaborate example of how to use this
31870 facility:
31871 .code
31872 # Reject messages with serious MIME container errors
31873 deny  message = Found MIME error ($demime_reason).
31874       demime = *
31875       condition = ${if >{$demime_errorlevel}{2}{1}{0}}
31876
31877 # Reject known virus spreading file extensions.
31878 # Accepting these is pretty much braindead.
31879 deny  message = contains $found_extension file (blacklisted).
31880       demime  = com:vbs:bat:pif:scr
31881
31882 # Freeze .exe and .doc files. Postmaster can
31883 # examine them and eventually thaw them.
31884 deny  log_message = Another $found_extension file.
31885       demime = exe:doc
31886       control = freeze
31887 .endd
31888 .ecindex IIDcosca
31889
31890
31891
31892
31893 . ////////////////////////////////////////////////////////////////////////////
31894 . ////////////////////////////////////////////////////////////////////////////
31895
31896 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
31897          "Local scan function"
31898 .scindex IIDlosca "&[local_scan()]& function" "description of"
31899 .cindex "customizing" "input scan using C function"
31900 .cindex "policy control" "by local scan function"
31901 In these days of email worms, viruses, and ever-increasing spam, some sites
31902 want to apply a lot of checking to messages before accepting them.
31903
31904 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
31905 passing messages to external virus and spam scanning software. You can also do
31906 a certain amount in Exim itself through string expansions and the &%condition%&
31907 condition in the ACL that runs after the SMTP DATA command or the ACL for
31908 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
31909
31910 To allow for further customization to a site's own requirements, there is the
31911 possibility of linking Exim with a private message scanning function, written
31912 in C. If you want to run code that is written in something other than C, you
31913 can of course use a little C stub to call it.
31914
31915 The local scan function is run once for every incoming message, at the point
31916 when Exim is just about to accept the message.
31917 It can therefore be used to control non-SMTP messages from local processes as
31918 well as messages arriving via SMTP.
31919
31920 Exim applies a timeout to calls of the local scan function, and there is an
31921 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
31922 Zero means &"no timeout"&.
31923 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
31924 before calling the local scan function, so that the most common types of crash
31925 are caught. If the timeout is exceeded or one of those signals is caught, the
31926 incoming message is rejected with a temporary error if it is an SMTP message.
31927 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
31928 code. The incident is logged on the main and reject logs.
31929
31930
31931
31932 .section "Building Exim to use a local scan function" "SECID207"
31933 .cindex "&[local_scan()]& function" "building Exim to use"
31934 To make use of the local scan function feature, you must tell Exim where your
31935 function is before building Exim, by setting LOCAL_SCAN_SOURCE in your
31936 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
31937 directory, so you might set
31938 .code
31939 LOCAL_SCAN_SOURCE=Local/local_scan.c
31940 .endd
31941 for example. The function must be called &[local_scan()]&. It is called by
31942 Exim after it has received a message, when the success return code is about to
31943 be sent. This is after all the ACLs have been run. The return code from your
31944 function controls whether the message is actually accepted or not. There is a
31945 commented template function (that just accepts the message) in the file
31946 _src/local_scan.c_.
31947
31948 If you want to make use of Exim's run time configuration file to set options
31949 for your &[local_scan()]& function, you must also set
31950 .code
31951 LOCAL_SCAN_HAS_OPTIONS=yes
31952 .endd
31953 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
31954
31955
31956
31957
31958 .section "API for local_scan()" "SECTapiforloc"
31959 .cindex "&[local_scan()]& function" "API description"
31960 You must include this line near the start of your code:
31961 .code
31962 #include "local_scan.h"
31963 .endd
31964 This header file defines a number of variables and other values, and the
31965 prototype for the function itself. Exim is coded to use unsigned char values
31966 almost exclusively, and one of the things this header defines is a shorthand
31967 for &`unsigned char`& called &`uschar`&.
31968 It also contains the following macro definitions, to simplify casting character
31969 strings and pointers to character strings:
31970 .code
31971 #define CS   (char *)
31972 #define CCS  (const char *)
31973 #define CSS  (char **)
31974 #define US   (unsigned char *)
31975 #define CUS  (const unsigned char *)
31976 #define USS  (unsigned char **)
31977 .endd
31978 The function prototype for &[local_scan()]& is:
31979 .code
31980 extern int local_scan(int fd, uschar **return_text);
31981 .endd
31982 The arguments are as follows:
31983
31984 .ilist
31985 &%fd%& is a file descriptor for the file that contains the body of the message
31986 (the -D file). The file is open for reading and writing, but updating it is not
31987 recommended. &*Warning*&: You must &'not'& close this file descriptor.
31988
31989 The descriptor is positioned at character 19 of the file, which is the first
31990 character of the body itself, because the first 19 characters are the message
31991 id followed by &`-D`& and a newline. If you rewind the file, you should use the
31992 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
31993 case this changes in some future version.
31994 .next
31995 &%return_text%& is an address which you can use to return a pointer to a text
31996 string at the end of the function. The value it points to on entry is NULL.
31997 .endlist
31998
31999 The function must return an &%int%& value which is one of the following macros:
32000
32001 .vlist
32002 .vitem &`LOCAL_SCAN_ACCEPT`&
32003 .vindex "&$local_scan_data$&"
32004 The message is accepted. If you pass back a string of text, it is saved with
32005 the message, and made available in the variable &$local_scan_data$&. No
32006 newlines are permitted (if there are any, they are turned into spaces) and the
32007 maximum length of text is 1000 characters.
32008
32009 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
32010 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
32011 queued without immediate delivery, and is frozen.
32012
32013 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
32014 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
32015 queued without immediate delivery.
32016
32017 .vitem &`LOCAL_SCAN_REJECT`&
32018 The message is rejected; the returned text is used as an error message which is
32019 passed back to the sender and which is also logged. Newlines are permitted &--
32020 they cause a multiline response for SMTP rejections, but are converted to
32021 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
32022 used.
32023
32024 .vitem &`LOCAL_SCAN_TEMPREJECT`&
32025 The message is temporarily rejected; the returned text is used as an error
32026 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
32027 problem"& is used.
32028
32029 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
32030 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
32031 message is not written to the reject log. It has the effect of unsetting the
32032 &%rejected_header%& log selector for just this rejection. If
32033 &%rejected_header%& is already unset (see the discussion of the
32034 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
32035 same as LOCAL_SCAN_REJECT.
32036
32037 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
32038 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
32039 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
32040 .endlist
32041
32042 If the message is not being received by interactive SMTP, rejections are
32043 reported by writing to &%stderr%& or by sending an email, as configured by the
32044 &%-oe%& command line options.
32045
32046
32047
32048 .section "Configuration options for local_scan()" "SECTconoptloc"
32049 .cindex "&[local_scan()]& function" "configuration options"
32050 It is possible to have option settings in the main configuration file
32051 that set values in static variables in the &[local_scan()]& module. If you
32052 want to do this, you must have the line
32053 .code
32054 LOCAL_SCAN_HAS_OPTIONS=yes
32055 .endd
32056 in your &_Local/Makefile_& when you build Exim. (This line is in
32057 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
32058 file, you must define static variables to hold the option values, and a table
32059 to define them.
32060
32061 The table must be a vector called &%local_scan_options%&, of type
32062 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
32063 and a pointer to the variable that holds the value. The entries must appear in
32064 alphabetical order. Following &%local_scan_options%& you must also define a
32065 variable called &%local_scan_options_count%& that contains the number of
32066 entries in the table. Here is a short example, showing two kinds of option:
32067 .code
32068 static int my_integer_option = 42;
32069 static uschar *my_string_option = US"a default string";
32070
32071 optionlist local_scan_options[] = {
32072   { "my_integer", opt_int,       &my_integer_option },
32073   { "my_string",  opt_stringptr, &my_string_option }
32074 };
32075
32076 int local_scan_options_count =
32077   sizeof(local_scan_options)/sizeof(optionlist);
32078 .endd
32079 The values of the variables can now be changed from Exim's runtime
32080 configuration file by including a local scan section as in this example:
32081 .code
32082 begin local_scan
32083 my_integer = 99
32084 my_string = some string of text...
32085 .endd
32086 The available types of option data are as follows:
32087
32088 .vlist
32089 .vitem &*opt_bool*&
32090 This specifies a boolean (true/false) option. The address should point to a
32091 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
32092 that are defined as &"1"& and &"0"&, respectively. If you want to detect
32093 whether such a variable has been set at all, you can initialize it to
32094 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
32095 values.)
32096
32097 .vitem &*opt_fixed*&
32098 This specifies a fixed point number, such as is used for load averages.
32099 The address should point to a variable of type &`int`&. The value is stored
32100 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
32101
32102 .vitem &*opt_int*&
32103 This specifies an integer; the address should point to a variable of type
32104 &`int`&. The value may be specified in any of the integer formats accepted by
32105 Exim.
32106
32107 .vitem &*opt_mkint*&
32108 This is the same as &%opt_int%&, except that when such a value is output in a
32109 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
32110 printed with the suffix K or M.
32111
32112 .vitem &*opt_octint*&
32113 This also specifies an integer, but the value is always interpreted as an
32114 octal integer, whether or not it starts with the digit zero, and it is
32115 always output in octal.
32116
32117 .vitem &*opt_stringptr*&
32118 This specifies a string value; the address must be a pointer to a
32119 variable that points to a string (for example, of type &`uschar *`&).
32120
32121 .vitem &*opt_time*&
32122 This specifies a time interval value. The address must point to a variable of
32123 type &`int`&. The value that is placed there is a number of seconds.
32124 .endlist
32125
32126 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
32127 out the values of all the &[local_scan()]& options.
32128
32129
32130
32131 .section "Available Exim variables" "SECID208"
32132 .cindex "&[local_scan()]& function" "available Exim variables"
32133 The header &_local_scan.h_& gives you access to a number of C variables. These
32134 are the only ones that are guaranteed to be maintained from release to release.
32135 Note, however, that you can obtain the value of any Exim expansion variable,
32136 including &$recipients$&, by calling &'expand_string()'&. The exported
32137 C variables are as follows:
32138
32139 .vlist
32140 .vitem &*int&~body_linecount*&
32141 This variable contains the number of lines in the message's body.
32142
32143 .vitem &*int&~body_zerocount*&
32144 This variable contains the number of binary zero bytes in the message's body.
32145
32146 .vitem &*unsigned&~int&~debug_selector*&
32147 This variable is set to zero when no debugging is taking place. Otherwise, it
32148 is a bitmap of debugging selectors. Two bits are identified for use in
32149 &[local_scan()]&; they are defined as macros:
32150
32151 .ilist
32152 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
32153 testing option that is not privileged &-- any caller may set it. All the
32154 other selector bits can be set only by admin users.
32155
32156 .next
32157 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
32158 by the &`+local_scan`& debug selector. It is not included in the default set
32159 of debugging bits.
32160 .endlist ilist
32161
32162 Thus, to write to the debugging output only when &`+local_scan`& has been
32163 selected, you should use code like this:
32164 .code
32165 if ((debug_selector & D_local_scan) != 0)
32166   debug_printf("xxx", ...);
32167 .endd
32168 .vitem &*uschar&~*expand_string_message*&
32169 After a failing call to &'expand_string()'& (returned value NULL), the
32170 variable &%expand_string_message%& contains the error message, zero-terminated.
32171
32172 .vitem &*header_line&~*header_list*&
32173 A pointer to a chain of header lines. The &%header_line%& structure is
32174 discussed below.
32175
32176 .vitem &*header_line&~*header_last*&
32177 A pointer to the last of the header lines.
32178
32179 .vitem &*uschar&~*headers_charset*&
32180 The value of the &%headers_charset%& configuration option.
32181
32182 .vitem &*BOOL&~host_checking*&
32183 This variable is TRUE during a host checking session that is initiated by the
32184 &%-bh%& command line option.
32185
32186 .vitem &*uschar&~*interface_address*&
32187 The IP address of the interface that received the message, as a string. This
32188 is NULL for locally submitted messages.
32189
32190 .vitem &*int&~interface_port*&
32191 The port on which this message was received. When testing with the &%-bh%&
32192 command line option, the value of this variable is -1 unless a port has been
32193 specified via the &%-oMi%& option.
32194
32195 .vitem &*uschar&~*message_id*&
32196 This variable contains Exim's message id for the incoming message (the value of
32197 &$message_exim_id$&) as a zero-terminated string.
32198
32199 .vitem &*uschar&~*received_protocol*&
32200 The name of the protocol by which the message was received.
32201
32202 .vitem &*int&~recipients_count*&
32203 The number of accepted recipients.
32204
32205 .vitem &*recipient_item&~*recipients_list*&
32206 .cindex "recipient" "adding in local scan"
32207 .cindex "recipient" "removing in local scan"
32208 The list of accepted recipients, held in a vector of length
32209 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
32210 can add additional recipients by calling &'receive_add_recipient()'& (see
32211 below). You can delete recipients by removing them from the vector and
32212 adjusting the value in &%recipients_count%&. In particular, by setting
32213 &%recipients_count%& to zero you remove all recipients. If you then return the
32214 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
32215 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
32216 and then call &'receive_add_recipient()'& as often as needed.
32217
32218 .vitem &*uschar&~*sender_address*&
32219 The envelope sender address. For bounce messages this is the empty string.
32220
32221 .vitem &*uschar&~*sender_host_address*&
32222 The IP address of the sending host, as a string. This is NULL for
32223 locally-submitted messages.
32224
32225 .vitem &*uschar&~*sender_host_authenticated*&
32226 The name of the authentication mechanism that was used, or NULL if the message
32227 was not received over an authenticated SMTP connection.
32228
32229 .vitem &*uschar&~*sender_host_name*&
32230 The name of the sending host, if known.
32231
32232 .vitem &*int&~sender_host_port*&
32233 The port on the sending host.
32234
32235 .vitem &*BOOL&~smtp_input*&
32236 This variable is TRUE for all SMTP input, including BSMTP.
32237
32238 .vitem &*BOOL&~smtp_batched_input*&
32239 This variable is TRUE for BSMTP input.
32240
32241 .vitem &*int&~store_pool*&
32242 The contents of this variable control which pool of memory is used for new
32243 requests. See section &<<SECTmemhanloc>>& for details.
32244 .endlist
32245
32246
32247 .section "Structure of header lines" "SECID209"
32248 The &%header_line%& structure contains the members listed below.
32249 You can add additional header lines by calling the &'header_add()'& function
32250 (see below). You can cause header lines to be ignored (deleted) by setting
32251 their type to *.
32252
32253
32254 .vlist
32255 .vitem &*struct&~header_line&~*next*&
32256 A pointer to the next header line, or NULL for the last line.
32257
32258 .vitem &*int&~type*&
32259 A code identifying certain headers that Exim recognizes. The codes are printing
32260 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
32261 Notice in particular that any header line whose type is * is not transmitted
32262 with the message. This flagging is used for header lines that have been
32263 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
32264 lines.) Effectively, * means &"deleted"&.
32265
32266 .vitem &*int&~slen*&
32267 The number of characters in the header line, including the terminating and any
32268 internal newlines.
32269
32270 .vitem &*uschar&~*text*&
32271 A pointer to the text of the header. It always ends with a newline, followed by
32272 a zero byte. Internal newlines are preserved.
32273 .endlist
32274
32275
32276
32277 .section "Structure of recipient items" "SECID210"
32278 The &%recipient_item%& structure contains these members:
32279
32280 .vlist
32281 .vitem &*uschar&~*address*&
32282 This is a pointer to the recipient address as it was received.
32283
32284 .vitem &*int&~pno*&
32285 This is used in later Exim processing when top level addresses are created by
32286 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
32287 and must always contain -1 at this stage.
32288
32289 .vitem &*uschar&~*errors_to*&
32290 If this value is not NULL, bounce messages caused by failing to deliver to the
32291 recipient are sent to the address it contains. In other words, it overrides the
32292 envelope sender for this one recipient. (Compare the &%errors_to%& generic
32293 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
32294 an unqualified address, Exim qualifies it using the domain from
32295 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
32296 is NULL for all recipients.
32297 .endlist
32298
32299
32300
32301 .section "Available Exim functions" "SECID211"
32302 .cindex "&[local_scan()]& function" "available Exim functions"
32303 The header &_local_scan.h_& gives you access to a number of Exim functions.
32304 These are the only ones that are guaranteed to be maintained from release to
32305 release:
32306
32307 .vlist
32308 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
32309        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
32310
32311 This function creates a child process that runs the command specified by
32312 &%argv%&. The environment for the process is specified by &%envp%&, which can
32313 be NULL if no environment variables are to be passed. A new umask is supplied
32314 for the process in &%newumask%&.
32315
32316 Pipes to the standard input and output of the new process are set up
32317 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
32318 standard error is cloned to the standard output. If there are any file
32319 descriptors &"in the way"& in the new process, they are closed. If the final
32320 argument is TRUE, the new process is made into a process group leader.
32321
32322 The function returns the pid of the new process, or -1 if things go wrong.
32323
32324 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
32325 This function waits for a child process to terminate, or for a timeout (in
32326 seconds) to expire. A timeout value of zero means wait as long as it takes. The
32327 return value is as follows:
32328
32329 .ilist
32330 >= 0
32331
32332 The process terminated by a normal exit and the value is the process
32333 ending status.
32334
32335 .next
32336 < 0 and > &--256
32337
32338 The process was terminated by a signal and the value is the negation of the
32339 signal number.
32340
32341 .next
32342 &--256
32343
32344 The process timed out.
32345 .next
32346 &--257
32347
32348 The was some other error in wait(); &%errno%& is still set.
32349 .endlist
32350
32351 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
32352 This function provide you with a means of submitting a new message to
32353 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
32354 want, but this packages it all up for you.) The function creates a pipe,
32355 forks a subprocess that is running
32356 .code
32357 exim -t -oem -oi -f <>
32358 .endd
32359 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
32360 that is connected to the standard input. The yield of the function is the PID
32361 of the subprocess. You can then write a message to the file descriptor, with
32362 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
32363
32364 When you have finished, call &'child_close()'& to wait for the process to
32365 finish and to collect its ending status. A timeout value of zero is usually
32366 fine in this circumstance. Unless you have made a mistake with the recipient
32367 addresses, you should get a return code of zero.
32368
32369
32370 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
32371        *sender_authentication)*&
32372 This function is a more sophisticated version of &'child_open()'&. The command
32373 that it runs is:
32374 .display
32375 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
32376 .endd
32377 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
32378
32379
32380 .vitem &*void&~debug_printf(char&~*,&~...)*&
32381 This is Exim's debugging function, with arguments as for &'(printf()'&. The
32382 output is written to the standard error stream. If no debugging is selected,
32383 calls to &'debug_printf()'& have no effect. Normally, you should make calls
32384 conditional on the &`local_scan`& debug selector by coding like this:
32385 .code
32386 if ((debug_selector & D_local_scan) != 0)
32387   debug_printf("xxx", ...);
32388 .endd
32389
32390 .vitem &*uschar&~*expand_string(uschar&~*string)*&
32391 This is an interface to Exim's string expansion code. The return value is the
32392 expanded string, or NULL if there was an expansion failure.
32393 The C variable &%expand_string_message%& contains an error message after an
32394 expansion failure. If expansion does not change the string, the return value is
32395 the pointer to the input string. Otherwise, the return value points to a new
32396 block of memory that was obtained by a call to &'store_get()'&. See section
32397 &<<SECTmemhanloc>>& below for a discussion of memory handling.
32398
32399 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
32400 This function allows you to an add additional header line at the end of the
32401 existing ones. The first argument is the type, and should normally be a space
32402 character. The second argument is a format string and any number of
32403 substitution arguments as for &[sprintf()]&. You may include internal newlines
32404 if you want, and you must ensure that the string ends with a newline.
32405
32406 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
32407         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
32408 This function adds a new header line at a specified point in the header
32409 chain. The header itself is specified as for &'header_add()'&.
32410
32411 If &%name%& is NULL, the new header is added at the end of the chain if
32412 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
32413 NULL, the header lines are searched for the first non-deleted header that
32414 matches the name. If one is found, the new header is added before it if
32415 &%after%& is false. If &%after%& is true, the new header is added after the
32416 found header and any adjacent subsequent ones with the same name (even if
32417 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
32418 option controls where the header is added. If it is true, addition is at the
32419 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
32420 headers, or at the top if there are no &'Received:'& headers, you could use
32421 .code
32422 header_add_at_position(TRUE, US"Received", TRUE,
32423   ' ', "X-xxx: ...");
32424 .endd
32425 Normally, there is always at least one non-deleted &'Received:'& header, but
32426 there may not be if &%received_header_text%& expands to an empty string.
32427
32428
32429 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
32430 This function removes header lines. If &%occurrence%& is zero or negative, all
32431 occurrences of the header are removed. If occurrence is greater than zero, that
32432 particular instance of the header is removed. If no header(s) can be found that
32433 match the specification, the function does nothing.
32434
32435
32436 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
32437         int&~length,&~BOOL&~notdel)*&"
32438 This function tests whether the given header has the given name. It is not just
32439 a string comparison, because white space is permitted between the name and the
32440 colon. If the &%notdel%& argument is true, a false return is forced for all
32441 &"deleted"& headers; otherwise they are not treated specially. For example:
32442 .code
32443 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
32444 .endd
32445 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
32446 .cindex "base64 encoding" "functions for &[local_scan()]& use"
32447 This function base64-encodes a string, which is passed by address and length.
32448 The text may contain bytes of any value, including zero. The result is passed
32449 back in dynamic memory that is obtained by calling &'store_get()'&. It is
32450 zero-terminated.
32451
32452 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
32453 This function decodes a base64-encoded string. Its arguments are a
32454 zero-terminated base64-encoded string and the address of a variable that is set
32455 to point to the result, which is in dynamic memory. The length of the decoded
32456 string is the yield of the function. If the input is invalid base64 data, the
32457 yield is -1. A zero byte is added to the end of the output string to make it
32458 easy to interpret as a C string (assuming it contains no zeros of its own). The
32459 added zero byte is not included in the returned count.
32460
32461 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
32462 This function checks for a match in a domain list. Domains are always
32463 matched caselessly. The return value is one of the following:
32464 .display
32465 &`OK     `& match succeeded
32466 &`FAIL   `& match failed
32467 &`DEFER  `& match deferred
32468 .endd
32469 DEFER is usually caused by some kind of lookup defer, such as the
32470 inability to contact a database.
32471
32472 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
32473         BOOL&~caseless)*&"
32474 This function checks for a match in a local part list. The third argument
32475 controls case-sensitivity. The return values are as for
32476 &'lss_match_domain()'&.
32477
32478 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
32479         BOOL&~caseless)*&"
32480 This function checks for a match in an address list. The third argument
32481 controls the case-sensitivity of the local part match. The domain is always
32482 matched caselessly. The return values are as for &'lss_match_domain()'&.
32483
32484 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
32485         uschar&~*list)*&"
32486 This function checks for a match in a host list. The most common usage is
32487 expected to be
32488 .code
32489 lss_match_host(sender_host_name, sender_host_address, ...)
32490 .endd
32491 .vindex "&$sender_host_address$&"
32492 An empty address field matches an empty item in the host list. If the host name
32493 is NULL, the name corresponding to &$sender_host_address$& is automatically
32494 looked up if a host name is required to match an item in the list. The return
32495 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
32496 returns ERROR in the case when it had to look up a host name, but the lookup
32497 failed.
32498
32499 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
32500         *format,&~...)*&"
32501 This function writes to Exim's log files. The first argument should be zero (it
32502 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
32503 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
32504 them. It specifies to which log or logs the message is written. The remaining
32505 arguments are a format and relevant insertion arguments. The string should not
32506 contain any newlines, not even at the end.
32507
32508
32509 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
32510 This function adds an additional recipient to the message. The first argument
32511 is the recipient address. If it is unqualified (has no domain), it is qualified
32512 with the &%qualify_recipient%& domain. The second argument must always be -1.
32513
32514 This function does not allow you to specify a private &%errors_to%& address (as
32515 described with the structure of &%recipient_item%& above), because it pre-dates
32516 the addition of that field to the structure. However, it is easy to add such a
32517 value afterwards. For example:
32518 .code
32519  receive_add_recipient(US"monitor@mydom.example", -1);
32520  recipients_list[recipients_count-1].errors_to =
32521    US"postmaster@mydom.example";
32522 .endd
32523
32524 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
32525 This is a convenience function to remove a named recipient from the list of
32526 recipients. It returns true if a recipient was removed, and false if no
32527 matching recipient could be found. The argument must be a complete email
32528 address.
32529 .endlist
32530
32531
32532 .cindex "RFC 2047"
32533 .vlist
32534 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
32535   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
32536 This function decodes strings that are encoded according to RFC 2047. Typically
32537 these are the contents of header lines. First, each &"encoded word"& is decoded
32538 from the Q or B encoding into a byte-string. Then, if provided with the name of
32539 a charset encoding, and if the &[iconv()]& function is available, an attempt is
32540 made  to translate the result to the named character set. If this fails, the
32541 binary string is returned with an error message.
32542
32543 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
32544 maximum MIME word length is enforced. The third argument is the target
32545 encoding, or NULL if no translation is wanted.
32546
32547 .cindex "binary zero" "in RFC 2047 decoding"
32548 .cindex "RFC 2047" "binary zero in"
32549 If a binary zero is encountered in the decoded string, it is replaced by the
32550 contents of the &%zeroval%& argument. For use with Exim headers, the value must
32551 not be 0 because header lines are handled as zero-terminated strings.
32552
32553 The function returns the result of processing the string, zero-terminated; if
32554 &%lenptr%& is not NULL, the length of the result is set in the variable to
32555 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
32556
32557 If an error is encountered, the function returns NULL and uses the &%error%&
32558 argument to return an error message. The variable pointed to by &%error%& is
32559 set to NULL if there is no error; it may be set non-NULL even when the function
32560 returns a non-NULL value if decoding was successful, but there was a problem
32561 with translation.
32562
32563
32564 .vitem &*int&~smtp_fflush(void)*&
32565 This function is used in conjunction with &'smtp_printf()'&, as described
32566 below.
32567
32568 .vitem &*void&~smtp_printf(char&~*,&~...)*&
32569 The arguments of this function are like &[printf()]&; it writes to the SMTP
32570 output stream. You should use this function only when there is an SMTP output
32571 stream, that is, when the incoming message is being received via interactive
32572 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
32573 is FALSE. If you want to test for an incoming message from another host (as
32574 opposed to a local process that used the &%-bs%& command line option), you can
32575 test the value of &%sender_host_address%&, which is non-NULL when a remote host
32576 is involved.
32577
32578 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
32579 output function, so it can be used for all forms of SMTP connection.
32580
32581 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
32582 must start with an appropriate response code: 550 if you are going to return
32583 LOCAL_SCAN_REJECT, 451 if you are going to return
32584 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
32585 initial lines of a multi-line response, the code must be followed by a hyphen
32586 to indicate that the line is not the final response line. You must also ensure
32587 that the lines you write terminate with CRLF. For example:
32588 .code
32589 smtp_printf("550-this is some extra info\r\n");
32590 return LOCAL_SCAN_REJECT;
32591 .endd
32592 Note that you can also create multi-line responses by including newlines in
32593 the data returned via the &%return_text%& argument. The added value of using
32594 &'smtp_printf()'& is that, for instance, you could introduce delays between
32595 multiple output lines.
32596
32597 The &'smtp_printf()'& function does not return any error indication, because it
32598 does not automatically flush pending output, and therefore does not test
32599 the state of the stream. (In the main code of Exim, flushing and error
32600 detection is done when Exim is ready for the next SMTP input command.) If
32601 you want to flush the output and check for an error (for example, the
32602 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
32603 arguments. It flushes the output stream, and returns a non-zero value if there
32604 is an error.
32605
32606 .vitem &*void&~*store_get(int)*&
32607 This function accesses Exim's internal store (memory) manager. It gets a new
32608 chunk of memory whose size is given by the argument. Exim bombs out if it ever
32609 runs out of memory. See the next section for a discussion of memory handling.
32610
32611 .vitem &*void&~*store_get_perm(int)*&
32612 This function is like &'store_get()'&, but it always gets memory from the
32613 permanent pool. See the next section for a discussion of memory handling.
32614
32615 .vitem &*uschar&~*string_copy(uschar&~*string)*&
32616 See below.
32617
32618 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
32619 See below.
32620
32621 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
32622 These three functions create strings using Exim's dynamic memory facilities.
32623 The first makes a copy of an entire string. The second copies up to a maximum
32624 number of characters, indicated by the second argument. The third uses a format
32625 and insertion arguments to create a new string. In each case, the result is a
32626 pointer to a new string in the current memory pool. See the next section for
32627 more discussion.
32628 .endlist
32629
32630
32631
32632 .section "More about Exim's memory handling" "SECTmemhanloc"
32633 .cindex "&[local_scan()]& function" "memory handling"
32634 No function is provided for freeing memory, because that is never needed.
32635 The dynamic memory that Exim uses when receiving a message is automatically
32636 recycled if another message is received by the same process (this applies only
32637 to incoming SMTP connections &-- other input methods can supply only one
32638 message at a time). After receiving the last message, a reception process
32639 terminates.
32640
32641 Because it is recycled, the normal dynamic memory cannot be used for holding
32642 data that must be preserved over a number of incoming messages on the same SMTP
32643 connection. However, Exim in fact uses two pools of dynamic memory; the second
32644 one is not recycled, and can be used for this purpose.
32645
32646 If you want to allocate memory that remains available for subsequent messages
32647 in the same SMTP connection, you should set
32648 .code
32649 store_pool = POOL_PERM
32650 .endd
32651 before calling the function that does the allocation. There is no need to
32652 restore the value if you do not need to; however, if you do want to revert to
32653 the normal pool, you can either restore the previous value of &%store_pool%& or
32654 set it explicitly to POOL_MAIN.
32655
32656 The pool setting applies to all functions that get dynamic memory, including
32657 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
32658 There is also a convenience function called &'store_get_perm()'& that gets a
32659 block of memory from the permanent pool while preserving the value of
32660 &%store_pool%&.
32661 .ecindex IIDlosca
32662
32663
32664
32665
32666 . ////////////////////////////////////////////////////////////////////////////
32667 . ////////////////////////////////////////////////////////////////////////////
32668
32669 .chapter "System-wide message filtering" "CHAPsystemfilter"
32670 .scindex IIDsysfil1 "filter" "system filter"
32671 .scindex IIDsysfil2 "filtering all mail"
32672 .scindex IIDsysfil3 "system filter"
32673 The previous chapters (on ACLs and the local scan function) describe checks
32674 that can be applied to messages before they are accepted by a host. There is
32675 also a mechanism for checking messages once they have been received, but before
32676 they are delivered. This is called the &'system filter'&.
32677
32678 The system filter operates in a similar manner to users' filter files, but it
32679 is run just once per message (however many recipients the message has).
32680 It should not normally be used as a substitute for routing, because &%deliver%&
32681 commands in a system router provide new envelope recipient addresses.
32682 The system filter must be an Exim filter. It cannot be a Sieve filter.
32683
32684 The system filter is run at the start of a delivery attempt, before any routing
32685 is done. If a message fails to be completely delivered at the first attempt,
32686 the system filter is run again at the start of every retry.
32687 If you want your filter to do something only once per message, you can make use
32688 of the &%first_delivery%& condition in an &%if%& command in the filter to
32689 prevent it happening on retries.
32690
32691 .vindex "&$domain$&"
32692 .vindex "&$local_part$&"
32693 &*Warning*&: Because the system filter runs just once, variables that are
32694 specific to individual recipient addresses, such as &$local_part$& and
32695 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
32696 you want to run a centrally-specified filter for each recipient address
32697 independently, you can do so by setting up a suitable &(redirect)& router, as
32698 described in section &<<SECTperaddfil>>& below.
32699
32700
32701 .section "Specifying a system filter" "SECID212"
32702 .cindex "uid (user id)" "system filter"
32703 .cindex "gid (group id)" "system filter"
32704 The name of the file that contains the system filter must be specified by
32705 setting &%system_filter%&. If you want the filter to run under a uid and gid
32706 other than root, you must also set &%system_filter_user%& and
32707 &%system_filter_group%& as appropriate. For example:
32708 .code
32709 system_filter = /etc/mail/exim.filter
32710 system_filter_user = exim
32711 .endd
32712 If a system filter generates any deliveries directly to files or pipes (via the
32713 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
32714 specified by setting &%system_filter_file_transport%& and
32715 &%system_filter_pipe_transport%&, respectively. Similarly,
32716 &%system_filter_reply_transport%& must be set to handle any messages generated
32717 by the &%reply%& command.
32718
32719
32720 .section "Testing a system filter" "SECID213"
32721 You can run simple tests of a system filter in the same way as for a user
32722 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
32723 are permitted only in system filters are recognized.
32724
32725 If you want to test the combined effect of a system filter and a user filter,
32726 you can use both &%-bF%& and &%-bf%& on the same command line.
32727
32728
32729
32730 .section "Contents of a system filter" "SECID214"
32731 The language used to specify system filters is the same as for users' filter
32732 files. It is described in the separate end-user document &'Exim's interface to
32733 mail filtering'&. However, there are some additional features that are
32734 available only in system filters; these are described in subsequent sections.
32735 If they are encountered in a user's filter file or when testing with &%-bf%&,
32736 they cause errors.
32737
32738 .cindex "frozen messages" "manual thaw; testing in filter"
32739 There are two special conditions which, though available in users' filter
32740 files, are designed for use in system filters. The condition &%first_delivery%&
32741 is true only for the first attempt at delivering a message, and
32742 &%manually_thawed%& is true only if the message has been frozen, and
32743 subsequently thawed by an admin user. An explicit forced delivery counts as a
32744 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
32745
32746 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
32747 specify an &"unseen"& (non-significant) delivery, and that delivery does not
32748 succeed, it will not be tried again.
32749 If you want Exim to retry an unseen delivery until it succeeds, you should
32750 arrange to set it up every time the filter runs.
32751
32752 When a system filter finishes running, the values of the variables &$n0$& &--
32753 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
32754 users' filter files. Thus a system filter can, for example, set up &"scores"&
32755 to which users' filter files can refer.
32756
32757
32758
32759 .section "Additional variable for system filters" "SECID215"
32760 .vindex "&$recipients$&"
32761 The expansion variable &$recipients$&, containing a list of all the recipients
32762 of the message (separated by commas and white space), is available in system
32763 filters. It is not available in users' filters for privacy reasons.
32764
32765
32766
32767 .section "Defer, freeze, and fail commands for system filters" "SECID216"
32768 .cindex "freezing messages"
32769 .cindex "message" "freezing"
32770 .cindex "message" "forced failure"
32771 .cindex "&%fail%&" "in system filter"
32772 .cindex "&%freeze%& in system filter"
32773 .cindex "&%defer%& in system filter"
32774 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
32775 always available in system filters, but are not normally enabled in users'
32776 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
32777 for the &(redirect)& router.) These commands can optionally be followed by the
32778 word &%text%& and a string containing an error message, for example:
32779 .code
32780 fail text "this message looks like spam to me"
32781 .endd
32782 The keyword &%text%& is optional if the next character is a double quote.
32783
32784 The &%defer%& command defers delivery of the original recipients of the
32785 message. The &%fail%& command causes all the original recipients to be failed,
32786 and a bounce message to be created. The &%freeze%& command suspends all
32787 delivery attempts for the original recipients. In all cases, any new deliveries
32788 that are specified by the filter are attempted as normal after the filter has
32789 run.
32790
32791 The &%freeze%& command is ignored if the message has been manually unfrozen and
32792 not manually frozen since. This means that automatic freezing by a system
32793 filter can be used as a way of checking out suspicious messages. If a message
32794 is found to be all right, manually unfreezing it allows it to be delivered.
32795
32796 .cindex "log" "&%fail%& command log line"
32797 .cindex "&%fail%&" "log line; reducing"
32798 The text given with a fail command is used as part of the bounce message as
32799 well as being written to the log. If the message is quite long, this can fill
32800 up a lot of log space when such failures are common. To reduce the size of the
32801 log message, Exim interprets the text in a special way if it starts with the
32802 two characters &`<<`& and contains &`>>`& later. The text between these two
32803 strings is written to the log, and the rest of the text is used in the bounce
32804 message. For example:
32805 .code
32806 fail "<<filter test 1>>Your message is rejected \
32807      because it contains attachments that we are \
32808      not prepared to receive."
32809 .endd
32810
32811 .cindex "loop" "caused by &%fail%&"
32812 Take great care with the &%fail%& command when basing the decision to fail on
32813 the contents of the message, because the bounce message will of course include
32814 the contents of the original message and will therefore trigger the &%fail%&
32815 command again (causing a mail loop) unless steps are taken to prevent this.
32816 Testing the &%error_message%& condition is one way to prevent this. You could
32817 use, for example
32818 .code
32819 if $message_body contains "this is spam" and not error_message
32820 then fail text "spam is not wanted here" endif
32821 .endd
32822 though of course that might let through unwanted bounce messages. The
32823 alternative is clever checking of the body and/or headers to detect bounces
32824 generated by the filter.
32825
32826 The interpretation of a system filter file ceases after a
32827 &%defer%&,
32828 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
32829 set up earlier in the filter file are honoured, so you can use a sequence such
32830 as
32831 .code
32832 mail ...
32833 freeze
32834 .endd
32835 to send a specified message when the system filter is freezing (or deferring or
32836 failing) a message. The normal deliveries for the message do not, of course,
32837 take place.
32838
32839
32840
32841 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
32842 .cindex "header lines" "adding; in system filter"
32843 .cindex "header lines" "removing; in system filter"
32844 .cindex "filter" "header lines; adding/removing"
32845 Two filter commands that are available only in system filters are:
32846 .code
32847 headers add <string>
32848 headers remove <string>
32849 .endd
32850 The argument for the &%headers add%& is a string that is expanded and then
32851 added to the end of the message's headers. It is the responsibility of the
32852 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
32853 space is ignored, and if the string is otherwise empty, or if the expansion is
32854 forced to fail, the command has no effect.
32855
32856 You can use &"\n"& within the string, followed by white space, to specify
32857 continued header lines. More than one header may be added in one command by
32858 including &"\n"& within the string without any following white space. For
32859 example:
32860 .code
32861 headers add "X-header-1: ....\n  \
32862              continuation of X-header-1 ...\n\
32863              X-header-2: ...."
32864 .endd
32865 Note that the header line continuation white space after the first newline must
32866 be placed before the backslash that continues the input string, because white
32867 space after input continuations is ignored.
32868
32869 The argument for &%headers remove%& is a colon-separated list of header names.
32870 This command applies only to those headers that are stored with the message;
32871 those that are added at delivery time (such as &'Envelope-To:'& and
32872 &'Return-Path:'&) cannot be removed by this means. If there is more than one
32873 header with the same name, they are all removed.
32874
32875 The &%headers%& command in a system filter makes an immediate change to the set
32876 of header lines that was received with the message (with possible additions
32877 from ACL processing). Subsequent commands in the system filter operate on the
32878 modified set, which also forms the basis for subsequent message delivery.
32879 Unless further modified during routing or transporting, this set of headers is
32880 used for all recipients of the message.
32881
32882 During routing and transporting, the variables that refer to the contents of
32883 header lines refer only to those lines that are in this set. Thus, header lines
32884 that are added by a system filter are visible to users' filter files and to all
32885 routers and transports. This contrasts with the manipulation of header lines by
32886 routers and transports, which is not immediate, but which instead is saved up
32887 until the message is actually being written (see section
32888 &<<SECTheadersaddrem>>&).
32889
32890 If the message is not delivered at the first attempt, header lines that were
32891 added by the system filter are stored with the message, and so are still
32892 present at the next delivery attempt. Header lines that were removed are still
32893 present, but marked &"deleted"& so that they are not transported with the
32894 message. For this reason, it is usual to make the &%headers%& command
32895 conditional on &%first_delivery%& so that the set of header lines is not
32896 modified more than once.
32897
32898 Because header modification in a system filter acts immediately, you have to
32899 use an indirect approach if you want to modify the contents of a header line.
32900 For example:
32901 .code
32902 headers add "Old-Subject: $h_subject:"
32903 headers remove "Subject"
32904 headers add "Subject: new subject (was: $h_old-subject:)"
32905 headers remove "Old-Subject"
32906 .endd
32907
32908
32909
32910 .section "Setting an errors address in a system filter" "SECID217"
32911 .cindex "envelope sender"
32912 In a system filter, if a &%deliver%& command is followed by
32913 .code
32914 errors_to <some address>
32915 .endd
32916 in order to change the envelope sender (and hence the error reporting) for that
32917 delivery, any address may be specified. (In a user filter, only the current
32918 user's address can be set.) For example, if some mail is being monitored, you
32919 might use
32920 .code
32921 unseen deliver monitor@spying.example errors_to root@local.example
32922 .endd
32923 to take a copy which would not be sent back to the normal error reporting
32924 address if its delivery failed.
32925
32926
32927
32928 .section "Per-address filtering" "SECTperaddfil"
32929 .vindex "&$domain$&"
32930 .vindex "&$local_part$&"
32931 In contrast to the system filter, which is run just once per message for each
32932 delivery attempt, it is also possible to set up a system-wide filtering
32933 operation that runs once for each recipient address. In this case, variables
32934 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
32935 filter file could be made dependent on them. This is an example of a router
32936 which implements such a filter:
32937 .code
32938 central_filter:
32939   check_local_user
32940   driver = redirect
32941   domains = +local_domains
32942   file = /central/filters/$local_part
32943   no_verify
32944   allow_filter
32945   allow_freeze
32946 .endd
32947 The filter is run in a separate process under its own uid. Therefore, either
32948 &%check_local_user%& must be set (as above), in which case the filter is run as
32949 the local user, or the &%user%& option must be used to specify which user to
32950 use. If both are set, &%user%& overrides.
32951
32952 Care should be taken to ensure that none of the commands in the filter file
32953 specify a significant delivery if the message is to go on to be delivered to
32954 its intended recipient. The router will not then claim to have dealt with the
32955 address, so it will be passed on to subsequent routers to be delivered in the
32956 normal way.
32957 .ecindex IIDsysfil1
32958 .ecindex IIDsysfil2
32959 .ecindex IIDsysfil3
32960
32961
32962
32963
32964
32965
32966 . ////////////////////////////////////////////////////////////////////////////
32967 . ////////////////////////////////////////////////////////////////////////////
32968
32969 .chapter "Message processing" "CHAPmsgproc"
32970 .scindex IIDmesproc "message" "general processing"
32971 Exim performs various transformations on the sender and recipient addresses of
32972 all messages that it handles, and also on the messages' header lines. Some of
32973 these are optional and configurable, while others always take place. All of
32974 this processing, except rewriting as a result of routing, and the addition or
32975 removal of header lines while delivering, happens when a message is received,
32976 before it is placed on Exim's queue.
32977
32978 Some of the automatic processing takes place by default only for
32979 &"locally-originated"& messages. This adjective is used to describe messages
32980 that are not received over TCP/IP, but instead are passed to an Exim process on
32981 its standard input. This includes the interactive &"local SMTP"& case that is
32982 set up by the &%-bs%& command line option.
32983
32984 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
32985 or ::1) are not considered to be locally-originated. Exim does not treat the
32986 loopback interface specially in any way.
32987
32988 If you want the loopback interface to be treated specially, you must ensure
32989 that there are appropriate entries in your ACLs.
32990
32991
32992
32993
32994 .section "Submission mode for non-local messages" "SECTsubmodnon"
32995 .cindex "message" "submission"
32996 .cindex "submission mode"
32997 Processing that happens automatically for locally-originated messages (unless
32998 &%suppress_local_fixups%& is set) can also be requested for messages that are
32999 received over TCP/IP. The term &"submission mode"& is used to describe this
33000 state. Submission mode is set by the modifier
33001 .code
33002 control = submission
33003 .endd
33004 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
33005 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
33006 a local submission, and is normally used when the source of the message is
33007 known to be an MUA running on a client host (as opposed to an MTA). For
33008 example, to set submission mode for messages originating on the IPv4 loopback
33009 interface, you could include the following in the MAIL ACL:
33010 .code
33011 warn  hosts = 127.0.0.1
33012       control = submission
33013 .endd
33014 .cindex "&%sender_retain%& submission option"
33015 There are some options that can be used when setting submission mode. A slash
33016 is used to separate options. For example:
33017 .code
33018 control = submission/sender_retain
33019 .endd
33020 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
33021 true and &%local_from_check%& false for the current incoming message. The first
33022 of these allows an existing &'Sender:'& header in the message to remain, and
33023 the second suppresses the check to ensure that &'From:'& matches the
33024 authenticated sender. With this setting, Exim still fixes up messages by adding
33025 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
33026 attempt to check sender authenticity in header lines.
33027
33028 When &%sender_retain%& is not set, a submission mode setting may specify a
33029 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
33030 example:
33031 .code
33032 control = submission/domain=some.domain
33033 .endd
33034 The domain may be empty. How this value is used is described in sections
33035 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
33036 that allows you to specify the user's full name for inclusion in a created
33037 &'Sender:'& or &'From:'& header line. For example:
33038 .code
33039 accept authenticated = *
33040        control = submission/domain=wonderland.example/\
33041                             name=${lookup {$authenticated_id} \
33042                                    lsearch {/etc/exim/namelist}}
33043 .endd
33044 Because the name may contain any characters, including slashes, the &%name%&
33045 option must be given last. The remainder of the string is used as the name. For
33046 the example above, if &_/etc/exim/namelist_& contains:
33047 .code
33048 bigegg:  Humpty Dumpty
33049 .endd
33050 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
33051 line would be:
33052 .code
33053 Sender: Humpty Dumpty <bigegg@wonderland.example>
33054 .endd
33055 .cindex "return path" "in submission mode"
33056 By default, submission mode forces the return path to the same address as is
33057 used to create the &'Sender:'& header. However, if &%sender_retain%& is
33058 specified, the return path is also left unchanged.
33059
33060 &*Note*&: The changes caused by submission mode take effect after the predata
33061 ACL. This means that any sender checks performed before the fix-ups use the
33062 untrusted sender address specified by the user, not the trusted sender address
33063 specified by submission mode. Although this might be slightly unexpected, it
33064 does mean that you can configure ACL checks to spot that a user is trying to
33065 spoof another's address.
33066
33067 .section "Line endings" "SECTlineendings"
33068 .cindex "line endings"
33069 .cindex "carriage return"
33070 .cindex "linefeed"
33071 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
33072 linefeed) is the line ending for messages transmitted over the Internet using
33073 SMTP over TCP/IP. However, within individual operating systems, different
33074 conventions are used. For example, Unix-like systems use just LF, but others
33075 use CRLF or just CR.
33076
33077 Exim was designed for Unix-like systems, and internally, it stores messages
33078 using the system's convention of a single LF as a line terminator. When
33079 receiving a message, all line endings are translated to this standard format.
33080 Originally, it was thought that programs that passed messages directly to an
33081 MTA within an operating system would use that system's convention. Experience
33082 has shown that this is not the case; for example, there are Unix applications
33083 that use CRLF in this circumstance. For this reason, and for compatibility with
33084 other MTAs, the way Exim handles line endings for all messages is now as
33085 follows:
33086
33087 .ilist
33088 LF not preceded by CR is treated as a line ending.
33089 .next
33090 CR is treated as a line ending; if it is immediately followed by LF, the LF
33091 is ignored.
33092 .next
33093 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
33094 nor a local message in the state where a line containing only a dot is a
33095 terminator.
33096 .next
33097 If a bare CR is encountered within a header line, an extra space is added after
33098 the line terminator so as not to end the header line. The reasoning behind this
33099 is that bare CRs in header lines are most likely either to be mistakes, or
33100 people trying to play silly games.
33101 .next
33102 If the first header line received in a message ends with CRLF, a subsequent
33103 bare LF in a header line is treated in the same way as a bare CR in a header
33104 line.
33105 .endlist
33106
33107
33108
33109
33110
33111 .section "Unqualified addresses" "SECID218"
33112 .cindex "unqualified addresses"
33113 .cindex "address" "qualification"
33114 By default, Exim expects every envelope address it receives from an external
33115 host to be fully qualified. Unqualified addresses cause negative responses to
33116 SMTP commands. However, because SMTP is used as a means of transporting
33117 messages from MUAs running on personal workstations, there is sometimes a
33118 requirement to accept unqualified addresses from specific hosts or IP networks.
33119
33120 Exim has two options that separately control which hosts may send unqualified
33121 sender or recipient addresses in SMTP commands, namely
33122 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
33123 cases, if an unqualified address is accepted, it is qualified by adding the
33124 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
33125
33126 .oindex "&%qualify_domain%&"
33127 .oindex "&%qualify_recipient%&"
33128 Unqualified addresses in header lines are automatically qualified for messages
33129 that are locally originated, unless the &%-bnq%& option is given on the command
33130 line. For messages received over SMTP, unqualified addresses in header lines
33131 are qualified only if unqualified addresses are permitted in SMTP commands. In
33132 other words, such qualification is also controlled by
33133 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
33134
33135
33136
33137
33138 .section "The UUCP From line" "SECID219"
33139 .cindex "&""From""& line"
33140 .cindex "UUCP" "&""From""& line"
33141 .cindex "sender" "address"
33142 .oindex "&%uucp_from_pattern%&"
33143 .oindex "&%uucp_from_sender%&"
33144 .cindex "envelope sender"
33145 .cindex "Sendmail compatibility" "&""From""& line"
33146 Messages that have come from UUCP (and some other applications) often begin
33147 with a line containing the envelope sender and a timestamp, following the word
33148 &"From"&. Examples of two common formats are:
33149 .code
33150 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
33151 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
33152 .endd
33153 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
33154 Exim recognizes such lines at the start of messages that are submitted to it
33155 via the command line (that is, on the standard input). It does not recognize
33156 such lines in incoming SMTP messages, unless the sending host matches
33157 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
33158 and &%ignore_fromline_local%& is set. The recognition is controlled by a
33159 regular expression that is defined by the &%uucp_from_pattern%& option, whose
33160 default value matches the two common cases shown above and puts the address
33161 that follows &"From"& into &$1$&.
33162
33163 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
33164 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
33165 a trusted user, the message's sender address is constructed by expanding the
33166 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
33167 then parsed as an RFC 2822 address. If there is no domain, the local part is
33168 qualified with &%qualify_domain%& unless it is the empty string. However, if
33169 the command line &%-f%& option is used, it overrides the &"From"& line.
33170
33171 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
33172 sender address is not changed. This is also the case for incoming SMTP messages
33173 that are permitted to contain &"From"& lines.
33174
33175 Only one &"From"& line is recognized. If there is more than one, the second is
33176 treated as a data line that starts the body of the message, as it is not valid
33177 as a header line. This also happens if a &"From"& line is present in an
33178 incoming SMTP message from a source that is not permitted to send them.
33179
33180
33181
33182 .section "Resent- header lines" "SECID220"
33183 .cindex "&%Resent-%& header lines"
33184 RFC 2822 makes provision for sets of header lines starting with the string
33185 &`Resent-`& to be added to a message when it is resent by the original
33186 recipient to somebody else. These headers are &'Resent-Date:'&,
33187 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
33188 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
33189
33190 .blockquote
33191 &'Resent fields are strictly informational. They MUST NOT be used in the normal
33192 processing of replies or other such automatic actions on messages.'&
33193 .endblockquote
33194
33195 This leaves things a bit vague as far as other processing actions such as
33196 address rewriting are concerned. Exim treats &%Resent-%& header lines as
33197 follows:
33198
33199 .ilist
33200 A &'Resent-From:'& line that just contains the login id of the submitting user
33201 is automatically rewritten in the same way as &'From:'& (see below).
33202 .next
33203 If there's a rewriting rule for a particular header line, it is also applied to
33204 &%Resent-%& header lines of the same type. For example, a rule that rewrites
33205 &'From:'& also rewrites &'Resent-From:'&.
33206 .next
33207 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
33208 also removed.
33209 .next
33210 For a locally-submitted message,
33211 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
33212 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
33213 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
33214 included in log lines in this case.
33215 .next
33216 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
33217 &%Resent-%& header lines are present.
33218 .endlist
33219
33220
33221
33222
33223 .section "The Auto-Submitted: header line" "SECID221"
33224 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
33225 includes the header line:
33226 .code
33227 Auto-Submitted: auto-replied
33228 .endd
33229
33230 .section "The Bcc: header line" "SECID222"
33231 .cindex "&'Bcc:'& header line"
33232 If Exim is called with the &%-t%& option, to take recipient addresses from a
33233 message's header, it removes any &'Bcc:'& header line that may exist (after
33234 extracting its addresses). If &%-t%& is not present on the command line, any
33235 existing &'Bcc:'& is not removed.
33236
33237
33238 .section "The Date: header line" "SECID223"
33239 .cindex "&'Date:'& header line"
33240 If a locally-generated or submission-mode message has no &'Date:'& header line,
33241 Exim adds one, using the current date and time, unless the
33242 &%suppress_local_fixups%& control has been specified.
33243
33244 .section "The Delivery-date: header line" "SECID224"
33245 .cindex "&'Delivery-date:'& header line"
33246 .oindex "&%delivery_date_remove%&"
33247 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
33248 set. Exim can be configured to add them to the final delivery of messages. (See
33249 the generic &%delivery_date_add%& transport option.) They should not be present
33250 in messages in transit. If the &%delivery_date_remove%& configuration option is
33251 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
33252 messages.
33253
33254
33255 .section "The Envelope-to: header line" "SECID225"
33256 .cindex "&'Envelope-to:'& header line"
33257 .oindex "&%envelope_to_remove%&"
33258 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
33259 Exim can be configured to add them to the final delivery of messages. (See the
33260 generic &%envelope_to_add%& transport option.) They should not be present in
33261 messages in transit. If the &%envelope_to_remove%& configuration option is set
33262 (the default), Exim removes &'Envelope-to:'& header lines from incoming
33263 messages.
33264
33265
33266 .section "The From: header line" "SECTthefrohea"
33267 .cindex "&'From:'& header line"
33268 .cindex "Sendmail compatibility" "&""From""& line"
33269 .cindex "message" "submission"
33270 .cindex "submission mode"
33271 If a submission-mode message does not contain a &'From:'& header line, Exim
33272 adds one if either of the following conditions is true:
33273
33274 .ilist
33275 The envelope sender address is not empty (that is, this is not a bounce
33276 message). The added header line copies the envelope sender address.
33277 .next
33278 .vindex "&$authenticated_id$&"
33279 The SMTP session is authenticated and &$authenticated_id$& is not empty.
33280 .olist
33281 .vindex "&$qualify_domain$&"
33282 If no domain is specified by the submission control, the local part is
33283 &$authenticated_id$& and the domain is &$qualify_domain$&.
33284 .next
33285 If a non-empty domain is specified by the submission control, the local
33286 part is &$authenticated_id$&, and the domain is the specified domain.
33287 .next
33288 If an empty domain is specified by the submission control,
33289 &$authenticated_id$& is assumed to be the complete address.
33290 .endlist
33291 .endlist
33292
33293 A non-empty envelope sender takes precedence.
33294
33295 If a locally-generated incoming message does not contain a &'From:'& header
33296 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
33297 containing the sender's address. The calling user's login name and full name
33298 are used to construct the address, as described in section &<<SECTconstr>>&.
33299 They are obtained from the password data by calling &[getpwuid()]& (but see the
33300 &%unknown_login%& configuration option). The address is qualified with
33301 &%qualify_domain%&.
33302
33303 For compatibility with Sendmail, if an incoming, non-SMTP message has a
33304 &'From:'& header line containing just the unqualified login name of the calling
33305 user, this is replaced by an address containing the user's login name and full
33306 name as described in section &<<SECTconstr>>&.
33307
33308
33309 .section "The Message-ID: header line" "SECID226"
33310 .cindex "&'Message-ID:'& header line"
33311 .cindex "message" "submission"
33312 .oindex "&%message_id_header_text%&"
33313 If a locally-generated or submission-mode incoming message does not contain a
33314 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
33315 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
33316 to the message. If there are any &'Resent-:'& headers in the message, it
33317 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
33318 message id, preceded by the letter E to ensure it starts with a letter, and
33319 followed by @ and the primary host name. Additional information can be included
33320 in this header line by setting the &%message_id_header_text%& and/or
33321 &%message_id_header_domain%& options.
33322
33323
33324 .section "The Received: header line" "SECID227"
33325 .cindex "&'Received:'& header line"
33326 A &'Received:'& header line is added at the start of every message. The
33327 contents are defined by the &%received_header_text%& configuration option, and
33328 Exim automatically adds a semicolon and a timestamp to the configured string.
33329
33330 The &'Received:'& header is generated as soon as the message's header lines
33331 have been received. At this stage, the timestamp in the &'Received:'& header
33332 line is the time that the message started to be received. This is the value
33333 that is seen by the DATA ACL and by the &[local_scan()]& function.
33334
33335 Once a message is accepted, the timestamp in the &'Received:'& header line is
33336 changed to the time of acceptance, which is (apart from a small delay while the
33337 -H spool file is written) the earliest time at which delivery could start.
33338
33339
33340 .section "The References: header line" "SECID228"
33341 .cindex "&'References:'& header line"
33342 Messages created by the &(autoreply)& transport include a &'References:'&
33343 header line. This is constructed according to the rules that are described in
33344 section 3.64 of RFC 2822 (which states that replies should contain such a
33345 header line), and section 3.14 of RFC 3834 (which states that automatic
33346 responses are not different in this respect). However, because some mail
33347 processing software does not cope well with very long header lines, no more
33348 than 12 message IDs are copied from the &'References:'& header line in the
33349 incoming message. If there are more than 12, the first one and then the final
33350 11 are copied, before adding the message ID of the incoming message.
33351
33352
33353
33354 .section "The Return-path: header line" "SECID229"
33355 .cindex "&'Return-path:'& header line"
33356 .oindex "&%return_path_remove%&"
33357 &'Return-path:'& header lines are defined as something an MTA may insert when
33358 it does the final delivery of messages. (See the generic &%return_path_add%&
33359 transport option.) Therefore, they should not be present in messages in
33360 transit. If the &%return_path_remove%& configuration option is set (the
33361 default), Exim removes &'Return-path:'& header lines from incoming messages.
33362
33363
33364
33365 .section "The Sender: header line" "SECTthesenhea"
33366 .cindex "&'Sender:'& header line"
33367 .cindex "message" "submission"
33368 For a locally-originated message from an untrusted user, Exim may remove an
33369 existing &'Sender:'& header line, and it may add a new one. You can modify
33370 these actions by setting the &%local_sender_retain%& option true, the
33371 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
33372 control setting.
33373
33374 When a local message is received from an untrusted user and
33375 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
33376 control has not been set, a check is made to see if the address given in the
33377 &'From:'& header line is the correct (local) sender of the message. The address
33378 that is expected has the login name as the local part and the value of
33379 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
33380 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
33381 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
33382 line is added to the message.
33383
33384 If you set &%local_from_check%& false, this checking does not occur. However,
33385 the removal of an existing &'Sender:'& line still happens, unless you also set
33386 &%local_sender_retain%& to be true. It is not possible to set both of these
33387 options true at the same time.
33388
33389 .cindex "submission mode"
33390 By default, no processing of &'Sender:'& header lines is done for messages
33391 received over TCP/IP or for messages submitted by trusted users. However, when
33392 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
33393 not specified on the submission control, the following processing takes place:
33394
33395 .vindex "&$authenticated_id$&"
33396 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
33397 authenticated, and &$authenticated_id$& is not empty, a sender address is
33398 created as follows:
33399
33400 .ilist
33401 .vindex "&$qualify_domain$&"
33402 If no domain is specified by the submission control, the local part is
33403 &$authenticated_id$& and the domain is &$qualify_domain$&.
33404 .next
33405 If a non-empty domain is specified by the submission control, the local part
33406 is &$authenticated_id$&, and the domain is the specified domain.
33407 .next
33408 If an empty domain is specified by the submission control,
33409 &$authenticated_id$& is assumed to be the complete address.
33410 .endlist
33411
33412 This address is compared with the address in the &'From:'& header line. If they
33413 are different, a &'Sender:'& header line containing the created address is
33414 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
33415 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
33416
33417 .cindex "return path" "created from &'Sender:'&"
33418 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
33419 the message (the envelope sender address) is changed to be the same address,
33420 except in the case of submission mode when &%sender_retain%& is specified.
33421
33422
33423
33424 .section "Adding and removing header lines in routers and transports" &&&
33425          "SECTheadersaddrem"
33426 .cindex "header lines" "adding; in router or transport"
33427 .cindex "header lines" "removing; in router or transport"
33428 When a message is delivered, the addition and removal of header lines can be
33429 specified in a system filter, or on any of the routers and transports that
33430 process the message. Section &<<SECTaddremheasys>>& contains details about
33431 modifying headers in a system filter. Header lines can also be added in an ACL
33432 as a message is received (see section &<<SECTaddheadacl>>&).
33433
33434 In contrast to what happens in a system filter, header modifications that are
33435 specified on routers and transports apply only to the particular recipient
33436 addresses that are being processed by those routers and transports. These
33437 changes do not actually take place until a copy of the message is being
33438 transported. Therefore, they do not affect the basic set of header lines, and
33439 they do not affect the values of the variables that refer to header lines.
33440
33441 &*Note*&: In particular, this means that any expansions in the configuration of
33442 the transport cannot refer to the modified header lines, because such
33443 expansions all occur before the message is actually transported.
33444
33445 For both routers and transports, the argument of a &%headers_add%&
33446 option must be in the form of one or more RFC 2822 header lines, separated by
33447 newlines (coded as &"\n"&). For example:
33448 .code
33449 headers_add = X-added-header: added by $primary_hostname\n\
33450               X-added-second: another added header line
33451 .endd
33452 Exim does not check the syntax of these added header lines.
33453
33454 Multiple &%headers_add%& options for a single router or transport can be
33455 specified; the values will append to a single list of header lines.
33456 Each header-line is separately expanded.
33457
33458 The argument of a &%headers_remove%& option must consist of a colon-separated
33459 list of header names. This is confusing, because header names themselves are
33460 often terminated by colons. In this case, the colons are the list separators,
33461 not part of the names. For example:
33462 .code
33463 headers_remove = return-receipt-to:acknowledge-to
33464 .endd
33465
33466 Multiple &%headers_remove%& options for a single router or transport can be
33467 specified; the arguments will append to a single header-names list.
33468 Each item is separately expanded.
33469 Note that colons in complex expansions which are used to
33470 form all or part of a &%headers_remove%& list
33471 will act as list separators.
33472
33473 When &%headers_add%& or &%headers_remove%& is specified on a router,
33474 items are expanded at routing time,
33475 and then associated with all addresses that are
33476 accepted by that router, and also with any new addresses that it generates. If
33477 an address passes through several routers as a result of aliasing or
33478 forwarding, the changes are cumulative.
33479
33480 .oindex "&%unseen%&"
33481 However, this does not apply to multiple routers that result from the use of
33482 the &%unseen%& option. Any header modifications that were specified by the
33483 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
33484
33485 Addresses that end up with different &%headers_add%& or &%headers_remove%&
33486 settings cannot be delivered together in a batch, so a transport is always
33487 dealing with a set of addresses that have the same header-processing
33488 requirements.
33489
33490 The transport starts by writing the original set of header lines that arrived
33491 with the message, possibly modified by the system filter. As it writes out
33492 these lines, it consults the list of header names that were attached to the
33493 recipient address(es) by &%headers_remove%& options in routers, and it also
33494 consults the transport's own &%headers_remove%& option. Header lines whose
33495 names are on either of these lists are not written out. If there are multiple
33496 instances of any listed header, they are all skipped.
33497
33498 After the remaining original header lines have been written, new header
33499 lines that were specified by routers' &%headers_add%& options are written, in
33500 the order in which they were attached to the address. These are followed by any
33501 header lines specified by the transport's &%headers_add%& option.
33502
33503 This way of handling header line modifications in routers and transports has
33504 the following consequences:
33505
33506 .ilist
33507 The original set of header lines, possibly modified by the system filter,
33508 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
33509 to it, at all times.
33510 .next
33511 Header lines that are added by a router's
33512 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
33513 expansion syntax in subsequent routers or the transport.
33514 .next
33515 Conversely, header lines that are specified for removal by &%headers_remove%&
33516 in a router remain visible to subsequent routers and the transport.
33517 .next
33518 Headers added to an address by &%headers_add%& in a router cannot be removed by
33519 a later router or by a transport.
33520 .next
33521 An added header can refer to the contents of an original header that is to be
33522 removed, even it has the same name as the added header. For example:
33523 .code
33524 headers_remove = subject
33525 headers_add = Subject: new subject (was: $h_subject:)
33526 .endd
33527 .endlist
33528
33529 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
33530 for a &(redirect)& router that has the &%one_time%& option set.
33531
33532
33533
33534
33535
33536 .section "Constructed addresses" "SECTconstr"
33537 .cindex "address" "constructed"
33538 .cindex "constructed address"
33539 When Exim constructs a sender address for a locally-generated message, it uses
33540 the form
33541 .display
33542 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
33543 .endd
33544 For example:
33545 .code
33546 Zaphod Beeblebrox <zaphod@end.univ.example>
33547 .endd
33548 The user name is obtained from the &%-F%& command line option if set, or
33549 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
33550 &"gecos"& field from the password entry. If the &"gecos"& field contains an
33551 ampersand character, this is replaced by the login name with the first letter
33552 upper cased, as is conventional in a number of operating systems. See the
33553 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
33554 The &%unknown_username%& option can be used to specify user names in cases when
33555 there is no password file entry.
33556
33557 .cindex "RFC 2047"
33558 In all cases, the user name is made to conform to RFC 2822 by quoting all or
33559 parts of it if necessary. In addition, if it contains any non-printing
33560 characters, it is encoded as described in RFC 2047, which defines a way of
33561 including non-ASCII characters in header lines. The value of the
33562 &%headers_charset%& option specifies the name of the encoding that is used (the
33563 characters are assumed to be in this encoding). The setting of
33564 &%print_topbitchars%& controls whether characters with the top bit set (that
33565 is, with codes greater than 127) count as printing characters or not.
33566
33567
33568
33569 .section "Case of local parts" "SECID230"
33570 .cindex "case of local parts"
33571 .cindex "local part" "case of"
33572 RFC 2822 states that the case of letters in the local parts of addresses cannot
33573 be assumed to be non-significant. Exim preserves the case of local parts of
33574 addresses, but by default it uses a lower-cased form when it is routing,
33575 because on most Unix systems, usernames are in lower case and case-insensitive
33576 routing is required. However, any particular router can be made to use the
33577 original case for local parts by setting the &%caseful_local_part%& generic
33578 router option.
33579
33580 .cindex "mixed-case login names"
33581 If you must have mixed-case user names on your system, the best way to proceed,
33582 assuming you want case-independent handling of incoming email, is to set up
33583 your first router to convert incoming local parts in your domains to the
33584 correct case by means of a file lookup. For example:
33585 .code
33586 correct_case:
33587   driver = redirect
33588   domains = +local_domains
33589   data = ${lookup{$local_part}cdb\
33590               {/etc/usercased.cdb}{$value}fail}\
33591               @$domain
33592 .endd
33593 For this router, the local part is forced to lower case by the default action
33594 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
33595 up a new local part in the correct case. If you then set &%caseful_local_part%&
33596 on any subsequent routers which process your domains, they will operate on
33597 local parts with the correct case in a case-sensitive manner.
33598
33599
33600
33601 .section "Dots in local parts" "SECID231"
33602 .cindex "dot" "in local part"
33603 .cindex "local part" "dots in"
33604 RFC 2822 forbids empty components in local parts. That is, an unquoted local
33605 part may not begin or end with a dot, nor have two consecutive dots in the
33606 middle. However, it seems that many MTAs do not enforce this, so Exim permits
33607 empty components for compatibility.
33608
33609
33610
33611 .section "Rewriting addresses" "SECID232"
33612 .cindex "rewriting" "addresses"
33613 Rewriting of sender and recipient addresses, and addresses in headers, can
33614 happen automatically, or as the result of configuration options, as described
33615 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
33616 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
33617
33618 Automatic rewriting includes qualification, as mentioned above. The other case
33619 in which it can happen is when an incomplete non-local domain is given. The
33620 routing process may cause this to be expanded into the full domain name. For
33621 example, a header such as
33622 .code
33623 To: hare@teaparty
33624 .endd
33625 might get rewritten as
33626 .code
33627 To: hare@teaparty.wonderland.fict.example
33628 .endd
33629 Rewriting as a result of routing is the one kind of message processing that
33630 does not happen at input time, as it cannot be done until the address has
33631 been routed.
33632
33633 Strictly, one should not do &'any'& deliveries of a message until all its
33634 addresses have been routed, in case any of the headers get changed as a
33635 result of routing. However, doing this in practice would hold up many
33636 deliveries for unreasonable amounts of time, just because one address could not
33637 immediately be routed. Exim therefore does not delay other deliveries when
33638 routing of one or more addresses is deferred.
33639 .ecindex IIDmesproc
33640
33641
33642
33643 . ////////////////////////////////////////////////////////////////////////////
33644 . ////////////////////////////////////////////////////////////////////////////
33645
33646 .chapter "SMTP processing" "CHAPSMTP"
33647 .scindex IIDsmtpproc1 "SMTP" "processing details"
33648 .scindex IIDsmtpproc2 "LMTP" "processing details"
33649 Exim supports a number of different ways of using the SMTP protocol, and its
33650 LMTP variant, which is an interactive protocol for transferring messages into a
33651 closed mail store application. This chapter contains details of how SMTP is
33652 processed. For incoming mail, the following are available:
33653
33654 .ilist
33655 SMTP over TCP/IP (Exim daemon or &'inetd'&);
33656 .next
33657 SMTP over the standard input and output (the &%-bs%& option);
33658 .next
33659 Batched SMTP on the standard input (the &%-bS%& option).
33660 .endlist
33661
33662 For mail delivery, the following are available:
33663
33664 .ilist
33665 SMTP over TCP/IP (the &(smtp)& transport);
33666 .next
33667 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
33668 &"lmtp"&);
33669 .next
33670 LMTP over a pipe to a process running in the local host (the &(lmtp)&
33671 transport);
33672 .next
33673 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
33674 the &%use_bsmtp%& option set).
33675 .endlist
33676
33677 &'Batched SMTP'& is the name for a process in which batches of messages are
33678 stored in or read from files (or pipes), in a format in which SMTP commands are
33679 used to contain the envelope information.
33680
33681
33682
33683 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
33684 .cindex "SMTP" "outgoing over TCP/IP"
33685 .cindex "outgoing SMTP over TCP/IP"
33686 .cindex "LMTP" "over TCP/IP"
33687 .cindex "outgoing LMTP over TCP/IP"
33688 .cindex "EHLO"
33689 .cindex "HELO"
33690 .cindex "SIZE option on MAIL command"
33691 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
33692 The &%protocol%& option selects which protocol is to be used, but the actual
33693 processing is the same in both cases.
33694
33695 If, in response to its EHLO command, Exim is told that the SIZE
33696 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
33697 command. The value of <&'n'&> is the message size plus the value of the
33698 &%size_addition%& option (default 1024) to allow for additions to the message
33699 such as per-transport header lines, or changes made in a
33700 .cindex "transport" "filter"
33701 .cindex "filter" "transport filter"
33702 transport filter. If &%size_addition%& is set negative, the use of SIZE is
33703 suppressed.
33704
33705 If the remote server advertises support for PIPELINING, Exim uses the
33706 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
33707 required for the transaction.
33708
33709 If the remote server advertises support for the STARTTLS command, and Exim
33710 was built to support TLS encryption, it tries to start a TLS session unless the
33711 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
33712 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
33713 is called for verification.
33714
33715 If the remote server advertises support for the AUTH command, Exim scans
33716 the authenticators configuration for any suitable client settings, as described
33717 in chapter &<<CHAPSMTPAUTH>>&.
33718
33719 .cindex "carriage return"
33720 .cindex "linefeed"
33721 Responses from the remote host are supposed to be terminated by CR followed by
33722 LF. However, there are known to be hosts that do not send CR characters, so in
33723 order to be able to interwork with such hosts, Exim treats LF on its own as a
33724 line terminator.
33725
33726 If a message contains a number of different addresses, all those with the same
33727 characteristics (for example, the same envelope sender) that resolve to the
33728 same set of hosts, in the same order, are sent in a single SMTP transaction,
33729 even if they are for different domains, unless there are more than the setting
33730 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
33731 they are split into groups containing no more than &%max_rcpt%&s addresses
33732 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
33733 in parallel sessions. The order of hosts with identical MX values is not
33734 significant when checking whether addresses can be batched in this way.
33735
33736 When the &(smtp)& transport suffers a temporary failure that is not
33737 message-related, Exim updates its transport-specific database, which contains
33738 records indexed by host name that remember which messages are waiting for each
33739 particular host. It also updates the retry database with new retry times.
33740
33741 .cindex "hints database" "retry keys"
33742 Exim's retry hints are based on host name plus IP address, so if one address of
33743 a multi-homed host is broken, it will soon be skipped most of the time.
33744 See the next section for more detail about error handling.
33745
33746 .cindex "SMTP" "passed connection"
33747 .cindex "SMTP" "batching over TCP/IP"
33748 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
33749 looks in the hints database for the transport to see if there are any queued
33750 messages waiting for the host to which it is connected. If it finds one, it
33751 creates a new Exim process using the &%-MC%& option (which can only be used by
33752 a process running as root or the Exim user) and passes the TCP/IP socket to it
33753 so that it can deliver another message using the same socket. The new process
33754 does only those deliveries that are routed to the connected host, and may in
33755 turn pass the socket on to a third process, and so on.
33756
33757 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
33758 limit the number of messages sent down a single TCP/IP connection.
33759
33760 .cindex "asterisk" "after IP address"
33761 The second and subsequent messages delivered down an existing connection are
33762 identified in the main log by the addition of an asterisk after the closing
33763 square bracket of the IP address.
33764
33765
33766
33767
33768 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
33769 .cindex "error" "in outgoing SMTP"
33770 .cindex "SMTP" "errors in outgoing"
33771 .cindex "host" "error"
33772 Three different kinds of error are recognized for outgoing SMTP: host errors,
33773 message errors, and recipient errors.
33774
33775 .vlist
33776 .vitem "&*Host errors*&"
33777 A host error is not associated with a particular message or with a
33778 particular recipient of a message. The host errors are:
33779
33780 .ilist
33781 Connection refused or timed out,
33782 .next
33783 Any error response code on connection,
33784 .next
33785 Any error response code to EHLO or HELO,
33786 .next
33787 Loss of connection at any time, except after &"."&,
33788 .next
33789 I/O errors at any time,
33790 .next
33791 Timeouts during the session, other than in response to MAIL, RCPT or
33792 the &"."& at the end of the data.
33793 .endlist ilist
33794
33795 For a host error, a permanent error response on connection, or in response to
33796 EHLO, causes all addresses routed to the host to be failed. Any other host
33797 error causes all addresses to be deferred, and retry data to be created for the
33798 host. It is not tried again, for any message, until its retry time arrives. If
33799 the current set of addresses are not all delivered in this run (to some
33800 alternative host), the message is added to the list of those waiting for this
33801 host, so if it is still undelivered when a subsequent successful delivery is
33802 made to the host, it will be sent down the same SMTP connection.
33803
33804 .vitem "&*Message errors*&"
33805 .cindex "message" "error"
33806 A message error is associated with a particular message when sent to a
33807 particular host, but not with a particular recipient of the message. The
33808 message errors are:
33809
33810 .ilist
33811 Any error response code to MAIL, DATA, or the &"."& that terminates
33812 the data,
33813 .next
33814 Timeout after MAIL,
33815 .next
33816 Timeout or loss of connection after the &"."& that terminates the data. A
33817 timeout after the DATA command itself is treated as a host error, as is loss of
33818 connection at any other time.
33819 .endlist ilist
33820
33821 For a message error, a permanent error response (5&'xx'&) causes all addresses
33822 to be failed, and a delivery error report to be returned to the sender. A
33823 temporary error response (4&'xx'&), or one of the timeouts, causes all
33824 addresses to be deferred. Retry data is not created for the host, but instead,
33825 a retry record for the combination of host plus message id is created. The
33826 message is not added to the list of those waiting for this host. This ensures
33827 that the failing message will not be sent to this host again until the retry
33828 time arrives. However, other messages that are routed to the host are not
33829 affected, so if it is some property of the message that is causing the error,
33830 it will not stop the delivery of other mail.
33831
33832 If the remote host specified support for the SIZE parameter in its response
33833 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
33834 over-large message will cause a message error because the error arrives as a
33835 response to MAIL.
33836
33837 .vitem "&*Recipient errors*&"
33838 .cindex "recipient" "error"
33839 A recipient error is associated with a particular recipient of a message. The
33840 recipient errors are:
33841
33842 .ilist
33843 Any error response to RCPT,
33844 .next
33845 Timeout after RCPT.
33846 .endlist
33847
33848 For a recipient error, a permanent error response (5&'xx'&) causes the
33849 recipient address to be failed, and a bounce message to be returned to the
33850 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
33851 address to be deferred, and routing retry data to be created for it. This is
33852 used to delay processing of the address in subsequent queue runs, until its
33853 routing retry time arrives. This applies to all messages, but because it
33854 operates only in queue runs, one attempt will be made to deliver a new message
33855 to the failing address before the delay starts to operate. This ensures that,
33856 if the failure is really related to the message rather than the recipient
33857 (&"message too big for this recipient"& is a possible example), other messages
33858 have a chance of getting delivered. If a delivery to the address does succeed,
33859 the retry information gets cleared, so all stuck messages get tried again, and
33860 the retry clock is reset.
33861
33862 The message is not added to the list of those waiting for this host. Use of the
33863 host for other messages is unaffected, and except in the case of a timeout,
33864 other recipients are processed independently, and may be successfully delivered
33865 in the current SMTP session. After a timeout it is of course impossible to
33866 proceed with the session, so all addresses get deferred. However, those other
33867 than the one that failed do not suffer any subsequent retry delays. Therefore,
33868 if one recipient is causing trouble, the others have a chance of getting
33869 through when a subsequent delivery attempt occurs before the failing
33870 recipient's retry time.
33871 .endlist
33872
33873 In all cases, if there are other hosts (or IP addresses) available for the
33874 current set of addresses (for example, from multiple MX records), they are
33875 tried in this run for any undelivered addresses, subject of course to their
33876 own retry data. In other words, recipient error retry data does not take effect
33877 until the next delivery attempt.
33878
33879 Some hosts have been observed to give temporary error responses to every
33880 MAIL command at certain times (&"insufficient space"& has been seen). It
33881 would be nice if such circumstances could be recognized, and defer data for the
33882 host itself created, but this is not possible within the current Exim design.
33883 What actually happens is that retry data for every (host, message) combination
33884 is created.
33885
33886 The reason that timeouts after MAIL and RCPT are treated specially is that
33887 these can sometimes arise as a result of the remote host's verification
33888 procedures. Exim makes this assumption, and treats them as if a temporary error
33889 response had been received. A timeout after &"."& is treated specially because
33890 it is known that some broken implementations fail to recognize the end of the
33891 message if the last character of the last line is a binary zero. Thus, it is
33892 helpful to treat this case as a message error.
33893
33894 Timeouts at other times are treated as host errors, assuming a problem with the
33895 host, or the connection to it. If a timeout after MAIL, RCPT,
33896 or &"."& is really a connection problem, the assumption is that at the next try
33897 the timeout is likely to occur at some other point in the dialogue, causing it
33898 then to be treated as a host error.
33899
33900 There is experimental evidence that some MTAs drop the connection after the
33901 terminating &"."& if they do not like the contents of the message for some
33902 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
33903 should be given. That is why Exim treats this case as a message rather than a
33904 host error, in order not to delay other messages to the same host.
33905
33906
33907
33908
33909 .section "Incoming SMTP messages over TCP/IP" "SECID233"
33910 .cindex "SMTP" "incoming over TCP/IP"
33911 .cindex "incoming SMTP over TCP/IP"
33912 .cindex "inetd"
33913 .cindex "daemon"
33914 Incoming SMTP messages can be accepted in one of two ways: by running a
33915 listening daemon, or by using &'inetd'&. In the latter case, the entry in
33916 &_/etc/inetd.conf_& should be like this:
33917 .code
33918 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
33919 .endd
33920 Exim distinguishes between this case and the case of a locally running user
33921 agent using the &%-bs%& option by checking whether or not the standard input is
33922 a socket. When it is, either the port must be privileged (less than 1024), or
33923 the caller must be root or the Exim user. If any other user passes a socket
33924 with an unprivileged port number, Exim prints a message on the standard error
33925 stream and exits with an error code.
33926
33927 By default, Exim does not make a log entry when a remote host connects or
33928 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
33929 unexpected. It can be made to write such log entries by setting the
33930 &%smtp_connection%& log selector.
33931
33932 .cindex "carriage return"
33933 .cindex "linefeed"
33934 Commands from the remote host are supposed to be terminated by CR followed by
33935 LF. However, there are known to be hosts that do not send CR characters. In
33936 order to be able to interwork with such hosts, Exim treats LF on its own as a
33937 line terminator.
33938 Furthermore, because common code is used for receiving messages from all
33939 sources, a CR on its own is also interpreted as a line terminator. However, the
33940 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
33941
33942 .cindex "EHLO" "invalid data"
33943 .cindex "HELO" "invalid data"
33944 One area that sometimes gives rise to problems concerns the EHLO or
33945 HELO commands. Some clients send syntactically invalid versions of these
33946 commands, which Exim rejects by default. (This is nothing to do with verifying
33947 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
33948 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
33949 match the broken hosts that send invalid commands.
33950
33951 .cindex "SIZE option on MAIL command"
33952 .cindex "MAIL" "SIZE option"
33953 The amount of disk space available is checked whenever SIZE is received on
33954 a MAIL command, independently of whether &%message_size_limit%& or
33955 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
33956 false. A temporary error is given if there is not enough space. If
33957 &%check_spool_space%& is set, the check is for that amount of space plus the
33958 value given with SIZE, that is, it checks that the addition of the incoming
33959 message will not reduce the space below the threshold.
33960
33961 When a message is successfully received, Exim includes the local message id in
33962 its response to the final &"."& that terminates the data. If the remote host
33963 logs this text it can help with tracing what has happened to a message.
33964
33965 The Exim daemon can limit the number of simultaneous incoming connections it is
33966 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
33967 number of simultaneous incoming connections from a single remote host (see the
33968 &%smtp_accept_max_per_host%& option). Additional connection attempts are
33969 rejected using the SMTP temporary error code 421.
33970
33971 The Exim daemon does not rely on the SIGCHLD signal to detect when a
33972 subprocess has finished, as this can get lost at busy times. Instead, it looks
33973 for completed subprocesses every time it wakes up. Provided there are other
33974 things happening (new incoming calls, starts of queue runs), completed
33975 processes will be noticed and tidied away. On very quiet systems you may
33976 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
33977 it will be noticed when the daemon next wakes up.
33978
33979 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
33980 and can also be set up to reject SMTP calls from non-reserved hosts at times of
33981 high system load &-- for details see the &%smtp_accept_reserve%&,
33982 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
33983 applies in both the daemon and &'inetd'& cases.
33984
33985 Exim normally starts a delivery process for each message received, though this
33986 can be varied by means of the &%-odq%& command line option and the
33987 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
33988 number of simultaneously running delivery processes started in this way from
33989 SMTP input can be limited by the &%smtp_accept_queue%& and
33990 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
33991 subsequently received messages are just put on the input queue without starting
33992 a delivery process.
33993
33994 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
33995 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
33996 started up from the &'inetd'& daemon, because in that case each connection is
33997 handled by an entirely independent Exim process. Control by load average is,
33998 however, available with &'inetd'&.
33999
34000 Exim can be configured to verify addresses in incoming SMTP commands as they
34001 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
34002 to rewrite addresses at this time &-- before any syntax checking is done. See
34003 section &<<SECTrewriteS>>&.
34004
34005 Exim can also be configured to limit the rate at which a client host submits
34006 MAIL and RCPT commands in a single SMTP session. See the
34007 &%smtp_ratelimit_hosts%& option.
34008
34009
34010
34011 .section "Unrecognized SMTP commands" "SECID234"
34012 .cindex "SMTP" "unrecognized commands"
34013 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
34014 commands during a single SMTP connection, it drops the connection after sending
34015 the error response to the last command. The default value for
34016 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
34017 abuse that subvert web servers into making connections to SMTP ports; in these
34018 circumstances, a number of non-SMTP lines are sent first.
34019
34020
34021 .section "Syntax and protocol errors in SMTP commands" "SECID235"
34022 .cindex "SMTP" "syntax errors"
34023 .cindex "SMTP" "protocol errors"
34024 A syntax error is detected if an SMTP command is recognized, but there is
34025 something syntactically wrong with its data, for example, a malformed email
34026 address in a RCPT command. Protocol errors include invalid command
34027 sequencing such as RCPT before MAIL. If Exim receives more than
34028 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
34029 drops the connection after sending the error response to the last command. The
34030 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
34031 broken clients that loop sending bad commands (yes, it has been seen).
34032
34033
34034
34035 .section "Use of non-mail SMTP commands" "SECID236"
34036 .cindex "SMTP" "non-mail commands"
34037 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
34038 DATA. Exim counts such commands, and drops the connection if there are too
34039 many of them in a single SMTP session. This action catches some
34040 denial-of-service attempts and things like repeated failing AUTHs, or a mad
34041 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
34042 defines what &"too many"& means. Its default value is 10.
34043
34044 When a new message is expected, one occurrence of RSET is not counted. This
34045 allows a client to send one RSET between messages (this is not necessary,
34046 but some clients do it). Exim also allows one uncounted occurrence of HELO
34047 or EHLO, and one occurrence of STARTTLS between messages. After
34048 starting up a TLS session, another EHLO is expected, and so it too is not
34049 counted.
34050
34051 The first occurrence of AUTH in a connection, or immediately following
34052 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
34053 RCPT, DATA, and QUIT are counted.
34054
34055 You can control which hosts are subject to the limit set by
34056 &%smtp_accept_max_nonmail%& by setting
34057 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
34058 the limit apply to all hosts. This option means that you can exclude any
34059 specific badly-behaved hosts that you have to live with.
34060
34061
34062
34063
34064 .section "The VRFY and EXPN commands" "SECID237"
34065 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
34066 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
34067 appropriate) in order to decide whether the command should be accepted or not.
34068
34069 .new
34070 .cindex "VRFY" "processing"
34071 When no ACL is defined for VRFY, or if it rejects without
34072 setting an explicit response code, the command is accepted
34073 (with a 252 SMTP response code)
34074 in order to support awkward clients that do a VRFY before every RCPT.
34075 .wen
34076 When VRFY is accepted, it runs exactly the same code as when Exim is
34077 called with the &%-bv%& option, and returns 250/451/550
34078 SMTP response codes.
34079
34080 .cindex "EXPN" "processing"
34081 If no ACL for EXPN is defined, the command is rejected.
34082 When EXPN is accepted, a single-level expansion of the address is done.
34083 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
34084 than a verification (the &%-bv%& option). If an unqualified local part is given
34085 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
34086 of VRFY and EXPN commands are logged on the main and reject logs, and
34087 VRFY verification failures are logged on the main log for consistency with
34088 RCPT failures.
34089
34090
34091
34092 .section "The ETRN command" "SECTETRN"
34093 .cindex "ETRN" "processing"
34094 RFC 1985 describes an SMTP command called ETRN that is designed to
34095 overcome the security problems of the TURN command (which has fallen into
34096 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
34097 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
34098 should be accepted or not. If no ACL is defined, the command is rejected.
34099
34100 The ETRN command is concerned with &"releasing"& messages that are awaiting
34101 delivery to certain hosts. As Exim does not organize its message queue by host,
34102 the only form of ETRN that is supported by default is the one where the
34103 text starts with the &"#"& prefix, in which case the remainder of the text is
34104 specific to the SMTP server. A valid ETRN command causes a run of Exim with
34105 the &%-R%& option to happen, with the remainder of the ETRN text as its
34106 argument. For example,
34107 .code
34108 ETRN #brigadoon
34109 .endd
34110 runs the command
34111 .code
34112 exim -R brigadoon
34113 .endd
34114 which causes a delivery attempt on all messages with undelivered addresses
34115 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
34116 default), Exim prevents the simultaneous execution of more than one queue run
34117 for the same argument string as a result of an ETRN command. This stops
34118 a misbehaving client from starting more than one queue runner at once.
34119
34120 .cindex "hints database" "ETRN serialization"
34121 Exim implements the serialization by means of a hints database in which a
34122 record is written whenever a process is started by ETRN, and deleted when
34123 the process completes. However, Exim does not keep the SMTP session waiting for
34124 the ETRN process to complete. Once ETRN is accepted, the client is sent
34125 a &"success"& return code. Obviously there is scope for hints records to get
34126 left lying around if there is a system or program crash. To guard against this,
34127 Exim ignores any records that are more than six hours old.
34128
34129 .oindex "&%smtp_etrn_command%&"
34130 For more control over what ETRN does, the &%smtp_etrn_command%& option can
34131 used. This specifies a command that is run whenever ETRN is received,
34132 whatever the form of its argument. For
34133 example:
34134 .code
34135 smtp_etrn_command = /etc/etrn_command $domain \
34136                     $sender_host_address
34137 .endd
34138 .vindex "&$domain$&"
34139 The string is split up into arguments which are independently expanded. The
34140 expansion variable &$domain$& is set to the argument of the ETRN command,
34141 and no syntax checking is done on the contents of this argument. Exim does not
34142 wait for the command to complete, so its status code is not checked. Exim runs
34143 under its own uid and gid when receiving incoming SMTP, so it is not possible
34144 for it to change them before running the command.
34145
34146
34147
34148 .section "Incoming local SMTP" "SECID238"
34149 .cindex "SMTP" "local incoming"
34150 Some user agents use SMTP to pass messages to their local MTA using the
34151 standard input and output, as opposed to passing the envelope on the command
34152 line and writing the message to the standard input. This is supported by the
34153 &%-bs%& option. This form of SMTP is handled in the same way as incoming
34154 messages over TCP/IP (including the use of ACLs), except that the envelope
34155 sender given in a MAIL command is ignored unless the caller is trusted. In
34156 an ACL you can detect this form of SMTP input by testing for an empty host
34157 identification. It is common to have this as the first line in the ACL that
34158 runs for RCPT commands:
34159 .code
34160 accept hosts = :
34161 .endd
34162 This accepts SMTP messages from local processes without doing any other tests.
34163
34164
34165
34166 .section "Outgoing batched SMTP" "SECTbatchSMTP"
34167 .cindex "SMTP" "batched outgoing"
34168 .cindex "batched SMTP output"
34169 Both the &(appendfile)& and &(pipe)& transports can be used for handling
34170 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
34171 be output in BSMTP format. No SMTP responses are possible for this form of
34172 delivery. All it is doing is using SMTP commands as a way of transmitting the
34173 envelope along with the message.
34174
34175 The message is written to the file or pipe preceded by the SMTP commands
34176 MAIL and RCPT, and followed by a line containing a single dot. Lines in
34177 the message that start with a dot have an extra dot added. The SMTP command
34178 HELO is not normally used. If it is required, the &%message_prefix%& option
34179 can be used to specify it.
34180
34181 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
34182 one recipient address at a time by default. However, you can arrange for them
34183 to handle several addresses at once by setting the &%batch_max%& option. When
34184 this is done for BSMTP, messages may contain multiple RCPT commands. See
34185 chapter &<<CHAPbatching>>& for more details.
34186
34187 .vindex "&$host$&"
34188 When one or more addresses are routed to a BSMTP transport by a router that
34189 sets up a host list, the name of the first host on the list is available to the
34190 transport in the variable &$host$&. Here is an example of such a transport and
34191 router:
34192 .code
34193 begin routers
34194 route_append:
34195   driver = manualroute
34196   transport = smtp_appendfile
34197   route_list = domain.example  batch.host.example
34198
34199 begin transports
34200 smtp_appendfile:
34201   driver = appendfile
34202   directory = /var/bsmtp/$host
34203   batch_max = 1000
34204   use_bsmtp
34205   user = exim
34206 .endd
34207 This causes messages addressed to &'domain.example'& to be written in BSMTP
34208 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
34209 message (unless there are more than 1000 recipients).
34210
34211
34212
34213 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
34214 .cindex "SMTP" "batched incoming"
34215 .cindex "batched SMTP input"
34216 The &%-bS%& command line option causes Exim to accept one or more messages by
34217 reading SMTP on the standard input, but to generate no responses. If the caller
34218 is trusted, the senders in the MAIL commands are believed; otherwise the
34219 sender is always the caller of Exim. Unqualified senders and receivers are not
34220 rejected (there seems little point) but instead just get qualified. HELO
34221 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
34222 as NOOP; QUIT quits.
34223
34224 Minimal policy checking is done for BSMTP input. Only the non-SMTP
34225 ACL is run in the same way as for non-SMTP local input.
34226
34227 If an error is detected while reading a message, including a missing &"."& at
34228 the end, Exim gives up immediately. It writes details of the error to the
34229 standard output in a stylized way that the calling program should be able to
34230 make some use of automatically, for example:
34231 .code
34232 554 Unexpected end of file
34233 Transaction started in line 10
34234 Error detected in line 14
34235 .endd
34236 It writes a more verbose version, for human consumption, to the standard error
34237 file, for example:
34238 .code
34239 An error was detected while processing a file of BSMTP input.
34240 The error message was:
34241
34242 501 '>' missing at end of address
34243
34244 The SMTP transaction started in line 10.
34245 The error was detected in line 12.
34246 The SMTP command at fault was:
34247
34248 rcpt to:<malformed@in.com.plete
34249
34250 1 previous message was successfully processed.
34251 The rest of the batch was abandoned.
34252 .endd
34253 The return code from Exim is zero only if there were no errors. It is 1 if some
34254 messages were accepted before an error was detected, and 2 if no messages were
34255 accepted.
34256 .ecindex IIDsmtpproc1
34257 .ecindex IIDsmtpproc2
34258
34259
34260
34261 . ////////////////////////////////////////////////////////////////////////////
34262 . ////////////////////////////////////////////////////////////////////////////
34263
34264 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
34265          "Customizing messages"
34266 When a message fails to be delivered, or remains on the queue for more than a
34267 configured amount of time, Exim sends a message to the original sender, or
34268 to an alternative configured address. The text of these messages is built into
34269 the code of Exim, but it is possible to change it, either by adding a single
34270 string, or by replacing each of the paragraphs by text supplied in a file.
34271
34272 The &'From:'& and &'To:'& header lines are automatically generated; you can
34273 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
34274 option. Exim also adds the line
34275 .code
34276 Auto-Submitted: auto-generated
34277 .endd
34278 to all warning and bounce messages,
34279
34280
34281 .section "Customizing bounce messages" "SECID239"
34282 .cindex "customizing" "bounce message"
34283 .cindex "bounce message" "customizing"
34284 If &%bounce_message_text%& is set, its contents are included in the default
34285 message immediately after &"This message was created automatically by mail
34286 delivery software."& The string is not expanded. It is not used if
34287 &%bounce_message_file%& is set.
34288
34289 When &%bounce_message_file%& is set, it must point to a template file for
34290 constructing error messages. The file consists of a series of text items,
34291 separated by lines consisting of exactly four asterisks. If the file cannot be
34292 opened, default text is used and a message is written to the main and panic
34293 logs. If any text item in the file is empty, default text is used for that
34294 item.
34295
34296 .vindex "&$bounce_recipient$&"
34297 .vindex "&$bounce_return_size_limit$&"
34298 Each item of text that is read from the file is expanded, and there are two
34299 expansion variables which can be of use here: &$bounce_recipient$& is set to
34300 the recipient of an error message while it is being created, and
34301 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
34302 option, rounded to a whole number.
34303
34304 The items must appear in the file in the following order:
34305
34306 .ilist
34307 The first item is included in the headers, and should include at least a
34308 &'Subject:'& header. Exim does not check the syntax of these headers.
34309 .next
34310 The second item forms the start of the error message. After it, Exim lists the
34311 failing addresses with their error messages.
34312 .next
34313 The third item is used to introduce any text from pipe transports that is to be
34314 returned to the sender. It is omitted if there is no such text.
34315 .next
34316 The fourth, fifth and sixth items will be ignored and may be empty.
34317 The fields exist for back-compatibility
34318 .endlist
34319
34320 The default state (&%bounce_message_file%& unset) is equivalent to the
34321 following file, in which the sixth item is empty. The &'Subject:'& and some
34322 other lines have been split in order to fit them on the page:
34323 .code
34324 Subject: Mail delivery failed
34325   ${if eq{$sender_address}{$bounce_recipient}
34326   {: returning message to sender}}
34327 ****
34328 This message was created automatically by mail delivery software.
34329
34330 A message ${if eq{$sender_address}{$bounce_recipient}
34331   {that you sent }{sent by
34332
34333 <$sender_address>
34334
34335 }}could not be delivered to all of its recipients.
34336 This is a permanent error. The following address(es) failed:
34337 ****
34338 The following text was generated during the delivery attempt(s):
34339 ****
34340 ------ This is a copy of the message, including all the headers.
34341   ------
34342 ****
34343 ------ The body of the message is $message_size characters long;
34344   only the first
34345 ------ $bounce_return_size_limit or so are included here.
34346 ****
34347 .endd
34348 .section "Customizing warning messages" "SECTcustwarn"
34349 .cindex "customizing" "warning message"
34350 .cindex "warning of delay" "customizing the message"
34351 The option &%warn_message_file%& can be pointed at a template file for use when
34352 warnings about message delays are created. In this case there are only three
34353 text sections:
34354
34355 .ilist
34356 The first item is included in the headers, and should include at least a
34357 &'Subject:'& header. Exim does not check the syntax of these headers.
34358 .next
34359 The second item forms the start of the warning message. After it, Exim lists
34360 the delayed addresses.
34361 .next
34362 The third item then ends the message.
34363 .endlist
34364
34365 The default state is equivalent to the following file, except that some lines
34366 have been split here, in order to fit them on the page:
34367 .code
34368 Subject: Warning: message $message_exim_id delayed
34369   $warn_message_delay
34370 ****
34371 This message was created automatically by mail delivery software.
34372
34373 A message ${if eq{$sender_address}{$warn_message_recipients}
34374 {that you sent }{sent by
34375
34376 <$sender_address>
34377
34378 }}has not been delivered to all of its recipients after
34379 more than $warn_message_delay on the queue on $primary_hostname.
34380
34381 The message identifier is:     $message_exim_id
34382 The subject of the message is: $h_subject
34383 The date of the message is:    $h_date
34384
34385 The following address(es) have not yet been delivered:
34386 ****
34387 No action is required on your part. Delivery attempts will
34388 continue for some time, and this warning may be repeated at
34389 intervals if the message remains undelivered. Eventually the
34390 mail delivery software will give up, and when that happens,
34391 the message will be returned to you.
34392 .endd
34393 .vindex "&$warn_message_delay$&"
34394 .vindex "&$warn_message_recipients$&"
34395 However, in the default state the subject and date lines are omitted if no
34396 appropriate headers exist. During the expansion of this file,
34397 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
34398 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
34399 of recipients for the warning message. There may be more than one if there are
34400 multiple addresses with different &%errors_to%& settings on the routers that
34401 handled them.
34402
34403
34404
34405
34406 . ////////////////////////////////////////////////////////////////////////////
34407 . ////////////////////////////////////////////////////////////////////////////
34408
34409 .chapter "Some common configuration settings" "CHAPcomconreq"
34410 This chapter discusses some configuration settings that seem to be fairly
34411 common. More examples and discussion can be found in the Exim book.
34412
34413
34414
34415 .section "Sending mail to a smart host" "SECID240"
34416 .cindex "smart host" "example router"
34417 If you want to send all mail for non-local domains to a &"smart host"&, you
34418 should replace the default &(dnslookup)& router with a router which does the
34419 routing explicitly:
34420 .code
34421 send_to_smart_host:
34422   driver = manualroute
34423   route_list = !+local_domains smart.host.name
34424   transport = remote_smtp
34425 .endd
34426 You can use the smart host's IP address instead of the name if you wish.
34427 If you are using Exim only to submit messages to a smart host, and not for
34428 receiving incoming messages, you can arrange for it to do the submission
34429 synchronously by setting the &%mua_wrapper%& option (see chapter
34430 &<<CHAPnonqueueing>>&).
34431
34432
34433
34434
34435 .section "Using Exim to handle mailing lists" "SECTmailinglists"
34436 .cindex "mailing lists"
34437 Exim can be used to run simple mailing lists, but for large and/or complicated
34438 requirements, the use of additional specialized mailing list software such as
34439 Majordomo or Mailman is recommended.
34440
34441 The &(redirect)& router can be used to handle mailing lists where each list
34442 is maintained in a separate file, which can therefore be managed by an
34443 independent manager. The &%domains%& router option can be used to run these
34444 lists in a separate domain from normal mail. For example:
34445 .code
34446 lists:
34447   driver = redirect
34448   domains = lists.example
34449   file = /usr/lists/$local_part
34450   forbid_pipe
34451   forbid_file
34452   errors_to = $local_part-request@lists.example
34453   no_more
34454 .endd
34455 This router is skipped for domains other than &'lists.example'&. For addresses
34456 in that domain, it looks for a file that matches the local part. If there is no
34457 such file, the router declines, but because &%no_more%& is set, no subsequent
34458 routers are tried, and so the whole delivery fails.
34459
34460 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
34461 expanded into a file name or a pipe delivery, which is usually inappropriate in
34462 a mailing list.
34463
34464 .oindex "&%errors_to%&"
34465 The &%errors_to%& option specifies that any delivery errors caused by addresses
34466 taken from a mailing list are to be sent to the given address rather than the
34467 original sender of the message. However, before acting on this, Exim verifies
34468 the error address, and ignores it if verification fails.
34469
34470 For example, using the configuration above, mail sent to
34471 &'dicts@lists.example'& is passed on to those addresses contained in
34472 &_/usr/lists/dicts_&, with error reports directed to
34473 &'dicts-request@lists.example'&, provided that this address can be verified.
34474 There could be a file called &_/usr/lists/dicts-request_& containing
34475 the address(es) of this particular list's manager(s), but other approaches,
34476 such as setting up an earlier router (possibly using the &%local_part_prefix%&
34477 or &%local_part_suffix%& options) to handle addresses of the form
34478 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
34479
34480
34481
34482 .section "Syntax errors in mailing lists" "SECID241"
34483 .cindex "mailing lists" "syntax errors in"
34484 If an entry in redirection data contains a syntax error, Exim normally defers
34485 delivery of the original address. That means that a syntax error in a mailing
34486 list holds up all deliveries to the list. This may not be appropriate when a
34487 list is being maintained automatically from data supplied by users, and the
34488 addresses are not rigorously checked.
34489
34490 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
34491 entries that fail to parse, noting the incident in the log. If in addition
34492 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
34493 whenever a broken address is skipped. It is usually appropriate to set
34494 &%syntax_errors_to%& to the same address as &%errors_to%&.
34495
34496
34497
34498 .section "Re-expansion of mailing lists" "SECID242"
34499 .cindex "mailing lists" "re-expansion of"
34500 Exim remembers every individual address to which a message has been delivered,
34501 in order to avoid duplication, but it normally stores only the original
34502 recipient addresses with a message. If all the deliveries to a mailing list
34503 cannot be done at the first attempt, the mailing list is re-expanded when the
34504 delivery is next tried. This means that alterations to the list are taken into
34505 account at each delivery attempt, so addresses that have been added to
34506 the list since the message arrived will therefore receive a copy of the
34507 message, even though it pre-dates their subscription.
34508
34509 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
34510 on the &(redirect)& router. If this is done, any addresses generated by the
34511 router that fail to deliver at the first attempt are added to the message as
34512 &"top level"& addresses, and the parent address that generated them is marked
34513 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
34514 subsequent delivery attempts. The disadvantage of this is that if any of the
34515 failing addresses are incorrect, correcting them in the file has no effect on
34516 pre-existing messages.
34517
34518 The original top-level address is remembered with each of the generated
34519 addresses, and is output in any log messages. However, any intermediate parent
34520 addresses are not recorded. This makes a difference to the log only if the
34521 &%all_parents%& selector is set, but for mailing lists there is normally only
34522 one level of expansion anyway.
34523
34524
34525
34526 .section "Closed mailing lists" "SECID243"
34527 .cindex "mailing lists" "closed"
34528 The examples so far have assumed open mailing lists, to which anybody may
34529 send mail. It is also possible to set up closed lists, where mail is accepted
34530 from specified senders only. This is done by making use of the generic
34531 &%senders%& option to restrict the router that handles the list.
34532
34533 The following example uses the same file as a list of recipients and as a list
34534 of permitted senders. It requires three routers:
34535 .code
34536 lists_request:
34537   driver = redirect
34538   domains = lists.example
34539   local_part_suffix = -request
34540   file = /usr/lists/$local_part$local_part_suffix
34541   no_more
34542
34543 lists_post:
34544   driver = redirect
34545   domains = lists.example
34546   senders = ${if exists {/usr/lists/$local_part}\
34547              {lsearch;/usr/lists/$local_part}{*}}
34548   file = /usr/lists/$local_part
34549   forbid_pipe
34550   forbid_file
34551   errors_to = $local_part-request@lists.example
34552   no_more
34553
34554 lists_closed:
34555   driver = redirect
34556   domains = lists.example
34557   allow_fail
34558   data = :fail: $local_part@lists.example is a closed mailing list
34559 .endd
34560 All three routers have the same &%domains%& setting, so for any other domains,
34561 they are all skipped. The first router runs only if the local part ends in
34562 &%-request%&. It handles messages to the list manager(s) by means of an open
34563 mailing list.
34564
34565 The second router runs only if the &%senders%& precondition is satisfied. It
34566 checks for the existence of a list that corresponds to the local part, and then
34567 checks that the sender is on the list by means of a linear search. It is
34568 necessary to check for the existence of the file before trying to search it,
34569 because otherwise Exim thinks there is a configuration error. If the file does
34570 not exist, the expansion of &%senders%& is *, which matches all senders. This
34571 means that the router runs, but because there is no list, declines, and
34572 &%no_more%& ensures that no further routers are run. The address fails with an
34573 &"unrouteable address"& error.
34574
34575 The third router runs only if the second router is skipped, which happens when
34576 a mailing list exists, but the sender is not on it. This router forcibly fails
34577 the address, giving a suitable error message.
34578
34579
34580
34581
34582 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
34583 .cindex "VERP"
34584 .cindex "Variable Envelope Return Paths"
34585 .cindex "envelope sender"
34586 Variable Envelope Return Paths &-- see &url(http://cr.yp.to/proto/verp.txt) &--
34587 are a way of helping mailing list administrators discover which subscription
34588 address is the cause of a particular delivery failure. The idea is to encode
34589 the original recipient address in the outgoing envelope sender address, so that
34590 if the message is forwarded by another host and then subsequently bounces, the
34591 original recipient can be extracted from the recipient address of the bounce.
34592
34593 .oindex &%errors_to%&
34594 .oindex &%return_path%&
34595 Envelope sender addresses can be modified by Exim using two different
34596 facilities: the &%errors_to%& option on a router (as shown in previous mailing
34597 list examples), or the &%return_path%& option on a transport. The second of
34598 these is effective only if the message is successfully delivered to another
34599 host; it is not used for errors detected on the local host (see the description
34600 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
34601 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
34602 .code
34603 verp_smtp:
34604   driver = smtp
34605   max_rcpt = 1
34606   return_path = \
34607     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
34608       {$1-request+$local_part=$domain@your.dom.example}fail}
34609 .endd
34610 This has the effect of rewriting the return path (envelope sender) on outgoing
34611 SMTP messages, if the local part of the original return path ends in
34612 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
34613 local part and domain of the recipient into the return path. Suppose, for
34614 example, that a message whose return path has been set to
34615 &'somelist-request@your.dom.example'& is sent to
34616 &'subscriber@other.dom.example'&. In the transport, the return path is
34617 rewritten as
34618 .code
34619 somelist-request+subscriber=other.dom.example@your.dom.example
34620 .endd
34621 .vindex "&$local_part$&"
34622 For this to work, you must tell Exim to send multiple copies of messages that
34623 have more than one recipient, so that each copy has just one recipient. This is
34624 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
34625 might be sent to several different recipients in the same domain, in which case
34626 &$local_part$& is not available in the transport, because it is not unique.
34627
34628 Unless your host is doing nothing but mailing list deliveries, you should
34629 probably use a separate transport for the VERP deliveries, so as not to use
34630 extra resources in making one-per-recipient copies for other deliveries. This
34631 can easily be done by expanding the &%transport%& option in the router:
34632 .code
34633 dnslookup:
34634   driver = dnslookup
34635   domains = ! +local_domains
34636   transport = \
34637     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
34638       {verp_smtp}{remote_smtp}}
34639   no_more
34640 .endd
34641 If you want to change the return path using &%errors_to%& in a router instead
34642 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
34643 routers that handle mailing list addresses. This will ensure that all delivery
34644 errors, including those detected on the local host, are sent to the VERP
34645 address.
34646
34647 On a host that does no local deliveries and has no manual routing, only the
34648 &(dnslookup)& router needs to be changed. A special transport is not needed for
34649 SMTP deliveries. Every mailing list recipient has its own return path value,
34650 and so Exim must hand them to the transport one at a time. Here is an example
34651 of a &(dnslookup)& router that implements VERP:
34652 .code
34653 verp_dnslookup:
34654   driver = dnslookup
34655   domains = ! +local_domains
34656   transport = remote_smtp
34657   errors_to = \
34658     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
34659      {$1-request+$local_part=$domain@your.dom.example}fail}
34660   no_more
34661 .endd
34662 Before you start sending out messages with VERPed return paths, you must also
34663 configure Exim to accept the bounce messages that come back to those paths.
34664 Typically this is done by setting a &%local_part_suffix%& option for a
34665 router, and using this to route the messages to wherever you want to handle
34666 them.
34667
34668 The overhead incurred in using VERP depends very much on the size of the
34669 message, the number of recipient addresses that resolve to the same remote
34670 host, and the speed of the connection over which the message is being sent. If
34671 a lot of addresses resolve to the same host and the connection is slow, sending
34672 a separate copy of the message for each address may take substantially longer
34673 than sending a single copy with many recipients (for which VERP cannot be
34674 used).
34675
34676
34677
34678
34679
34680
34681 .section "Virtual domains" "SECTvirtualdomains"
34682 .cindex "virtual domains"
34683 .cindex "domain" "virtual"
34684 The phrase &'virtual domain'& is unfortunately used with two rather different
34685 meanings:
34686
34687 .ilist
34688 A domain for which there are no real mailboxes; all valid local parts are
34689 aliases for other email addresses. Common examples are organizational
34690 top-level domains and &"vanity"& domains.
34691 .next
34692 One of a number of independent domains that are all handled by the same host,
34693 with mailboxes on that host, but where the mailbox owners do not necessarily
34694 have login accounts on that host.
34695 .endlist
34696
34697 The first usage is probably more common, and does seem more &"virtual"& than
34698 the second. This kind of domain can be handled in Exim with a straightforward
34699 aliasing router. One approach is to create a separate alias file for each
34700 virtual domain. Exim can test for the existence of the alias file to determine
34701 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
34702 to a router of this form:
34703 .code
34704 virtual:
34705   driver = redirect
34706   domains = dsearch;/etc/mail/virtual
34707   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
34708   no_more
34709 .endd
34710 The &%domains%& option specifies that the router is to be skipped, unless there
34711 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
34712 domain that is being processed. When the router runs, it looks up the local
34713 part in the file to find a new address (or list of addresses). The &%no_more%&
34714 setting ensures that if the lookup fails (leading to &%data%& being an empty
34715 string), Exim gives up on the address without trying any subsequent routers.
34716
34717 This one router can handle all the virtual domains because the alias file names
34718 follow a fixed pattern. Permissions can be arranged so that appropriate people
34719 can edit the different alias files. A successful aliasing operation results in
34720 a new envelope recipient address, which is then routed from scratch.
34721
34722 The other kind of &"virtual"& domain can also be handled in a straightforward
34723 way. One approach is to create a file for each domain containing a list of
34724 valid local parts, and use it in a router like this:
34725 .code
34726 my_domains:
34727   driver = accept
34728   domains = dsearch;/etc/mail/domains
34729   local_parts = lsearch;/etc/mail/domains/$domain
34730   transport = my_mailboxes
34731 .endd
34732 The address is accepted if there is a file for the domain, and the local part
34733 can be found in the file. The &%domains%& option is used to check for the
34734 file's existence because &%domains%& is tested before the &%local_parts%&
34735 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
34736 because that option is tested after &%local_parts%&. The transport is as
34737 follows:
34738 .code
34739 my_mailboxes:
34740   driver = appendfile
34741   file = /var/mail/$domain/$local_part
34742   user = mail
34743 .endd
34744 This uses a directory of mailboxes for each domain. The &%user%& setting is
34745 required, to specify which uid is to be used for writing to the mailboxes.
34746
34747 The configuration shown here is just one example of how you might support this
34748 requirement. There are many other ways this kind of configuration can be set
34749 up, for example, by using a database instead of separate files to hold all the
34750 information about the domains.
34751
34752
34753
34754 .section "Multiple user mailboxes" "SECTmulbox"
34755 .cindex "multiple mailboxes"
34756 .cindex "mailbox" "multiple"
34757 .cindex "local part" "prefix"
34758 .cindex "local part" "suffix"
34759 Heavy email users often want to operate with multiple mailboxes, into which
34760 incoming mail is automatically sorted. A popular way of handling this is to
34761 allow users to use multiple sender addresses, so that replies can easily be
34762 identified. Users are permitted to add prefixes or suffixes to their local
34763 parts for this purpose. The wildcard facility of the generic router options
34764 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
34765 example, consider this router:
34766 .code
34767 userforward:
34768   driver = redirect
34769   check_local_user
34770   file = $home/.forward
34771   local_part_suffix = -*
34772   local_part_suffix_optional
34773   allow_filter
34774 .endd
34775 .vindex "&$local_part_suffix$&"
34776 It runs a user's &_.forward_& file for all local parts of the form
34777 &'username-*'&. Within the filter file the user can distinguish different
34778 cases by testing the variable &$local_part_suffix$&. For example:
34779 .code
34780 if $local_part_suffix contains -special then
34781 save /home/$local_part/Mail/special
34782 endif
34783 .endd
34784 If the filter file does not exist, or does not deal with such addresses, they
34785 fall through to subsequent routers, and, assuming no subsequent use of the
34786 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
34787 control over which suffixes are valid.
34788
34789 Alternatively, a suffix can be used to trigger the use of a different
34790 &_.forward_& file &-- which is the way a similar facility is implemented in
34791 another MTA:
34792 .code
34793 userforward:
34794   driver = redirect
34795   check_local_user
34796   file = $home/.forward$local_part_suffix
34797   local_part_suffix = -*
34798   local_part_suffix_optional
34799   allow_filter
34800 .endd
34801 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
34802 example, &_.forward-special_& is used. Once again, if the appropriate file
34803 does not exist, or does not deal with the address, it is passed on to
34804 subsequent routers, which could, if required, look for an unqualified
34805 &_.forward_& file to use as a default.
34806
34807
34808
34809 .section "Simplified vacation processing" "SECID244"
34810 .cindex "vacation processing"
34811 The traditional way of running the &'vacation'& program is for a user to set up
34812 a pipe command in a &_.forward_& file
34813 (see section &<<SECTspecitredli>>& for syntax details).
34814 This is prone to error by inexperienced users. There are two features of Exim
34815 that can be used to make this process simpler for users:
34816
34817 .ilist
34818 A local part prefix such as &"vacation-"& can be specified on a router which
34819 can cause the message to be delivered directly to the &'vacation'& program, or
34820 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
34821 &_.forward_& file are then much simpler. For example:
34822 .code
34823 spqr, vacation-spqr
34824 .endd
34825 .next
34826 The &%require_files%& generic router option can be used to trigger a
34827 vacation delivery by checking for the existence of a certain file in the
34828 user's home directory. The &%unseen%& generic option should also be used, to
34829 ensure that the original delivery also proceeds. In this case, all the user has
34830 to do is to create a file called, say, &_.vacation_&, containing a vacation
34831 message.
34832 .endlist
34833
34834 Another advantage of both these methods is that they both work even when the
34835 use of arbitrary pipes by users is locked out.
34836
34837
34838
34839 .section "Taking copies of mail" "SECID245"
34840 .cindex "message" "copying every"
34841 Some installations have policies that require archive copies of all messages to
34842 be made. A single copy of each message can easily be taken by an appropriate
34843 command in a system filter, which could, for example, use a different file for
34844 each day's messages.
34845
34846 There is also a shadow transport mechanism that can be used to take copies of
34847 messages that are successfully delivered by local transports, one copy per
34848 delivery. This could be used, &'inter alia'&, to implement automatic
34849 notification of delivery by sites that insist on doing such things.
34850
34851
34852
34853 .section "Intermittently connected hosts" "SECID246"
34854 .cindex "intermittently connected hosts"
34855 It has become quite common (because it is cheaper) for hosts to connect to the
34856 Internet periodically rather than remain connected all the time. The normal
34857 arrangement is that mail for such hosts accumulates on a system that is
34858 permanently connected.
34859
34860 Exim was designed for use on permanently connected hosts, and so it is not
34861 particularly well-suited to use in an intermittently connected environment.
34862 Nevertheless there are some features that can be used.
34863
34864
34865 .section "Exim on the upstream server host" "SECID247"
34866 It is tempting to arrange for incoming mail for the intermittently connected
34867 host to remain on Exim's queue until the client connects. However, this
34868 approach does not scale very well. Two different kinds of waiting message are
34869 being mixed up in the same queue &-- those that cannot be delivered because of
34870 some temporary problem, and those that are waiting for their destination host
34871 to connect. This makes it hard to manage the queue, as well as wasting
34872 resources, because each queue runner scans the entire queue.
34873
34874 A better approach is to separate off those messages that are waiting for an
34875 intermittently connected host. This can be done by delivering these messages
34876 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
34877 format, from where they are transmitted by other software when their
34878 destination connects. This makes it easy to collect all the mail for one host
34879 in a single directory, and to apply local timeout rules on a per-message basis
34880 if required.
34881
34882 On a very small scale, leaving the mail on Exim's queue can be made to work. If
34883 you are doing this, you should configure Exim with a long retry period for the
34884 intermittent host. For example:
34885 .code
34886 cheshire.wonderland.fict.example    *   F,5d,24h
34887 .endd
34888 This stops a lot of failed delivery attempts from occurring, but Exim remembers
34889 which messages it has queued up for that host. Once the intermittent host comes
34890 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
34891 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
34892 causes all the queued up messages to be delivered, often down a single SMTP
34893 connection. While the host remains connected, any new messages get delivered
34894 immediately.
34895
34896 If the connecting hosts do not have fixed IP addresses, that is, if a host is
34897 issued with a different IP address each time it connects, Exim's retry
34898 mechanisms on the holding host get confused, because the IP address is normally
34899 used as part of the key string for holding retry information. This can be
34900 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
34901 Since this has disadvantages for permanently connected hosts, it is best to
34902 arrange a separate transport for the intermittently connected ones.
34903
34904
34905
34906 .section "Exim on the intermittently connected client host" "SECID248"
34907 The value of &%smtp_accept_queue_per_connection%& should probably be
34908 increased, or even set to zero (that is, disabled) on the intermittently
34909 connected host, so that all incoming messages down a single connection get
34910 delivered immediately.
34911
34912 .cindex "SMTP" "passed connection"
34913 .cindex "SMTP" "multiple deliveries"
34914 .cindex "multiple SMTP deliveries"
34915 Mail waiting to be sent from an intermittently connected host will probably
34916 not have been routed, because without a connection DNS lookups are not
34917 possible. This means that if a normal queue run is done at connection time,
34918 each message is likely to be sent in a separate SMTP session. This can be
34919 avoided by starting the queue run with a command line option beginning with
34920 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
34921 first pass, routing is done but no deliveries take place. The second pass is a
34922 normal queue run; since all the messages have been previously routed, those
34923 destined for the same host are likely to get sent as multiple deliveries in a
34924 single SMTP connection.
34925
34926
34927
34928 . ////////////////////////////////////////////////////////////////////////////
34929 . ////////////////////////////////////////////////////////////////////////////
34930
34931 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
34932          "Exim as a non-queueing client"
34933 .cindex "client, non-queueing"
34934 .cindex "smart host" "suppressing queueing"
34935 On a personal computer, it is a common requirement for all
34936 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
34937 configured to operate that way, for all the popular operating systems.
34938 However, there are some MUAs for Unix-like systems that cannot be so
34939 configured: they submit messages using the command line interface of
34940 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
34941 messages this way.
34942
34943 If the personal computer runs continuously, there is no problem, because it can
34944 run a conventional MTA that handles delivery to the smart host, and deal with
34945 any delays via its queueing mechanism. However, if the computer does not run
34946 continuously or runs different operating systems at different times, queueing
34947 email is not desirable.
34948
34949 There is therefore a requirement for something that can provide the
34950 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
34951 any queueing or retrying facilities. Furthermore, the delivery to the smart
34952 host should be synchronous, so that if it fails, the sending MUA is immediately
34953 informed. In other words, we want something that extends an MUA that submits
34954 to a local MTA via the command line so that it behaves like one that submits
34955 to a remote smart host using TCP/SMTP.
34956
34957 There are a number of applications (for example, there is one called &'ssmtp'&)
34958 that do this job. However, people have found them to be lacking in various
34959 ways. For instance, you might want to allow aliasing and forwarding to be done
34960 before sending a message to the smart host.
34961
34962 Exim already had the necessary infrastructure for doing this job. Just a few
34963 tweaks were needed to make it behave as required, though it is somewhat of an
34964 overkill to use a fully-featured MTA for this purpose.
34965
34966 .oindex "&%mua_wrapper%&"
34967 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
34968 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
34969 assumes that it is being used to &"wrap"& a command-line MUA in the manner
34970 just described. As well as setting &%mua_wrapper%&, you also need to provide a
34971 compatible router and transport configuration. Typically there will be just one
34972 router and one transport, sending everything to a smart host.
34973
34974 When run in MUA wrapping mode, the behaviour of Exim changes in the
34975 following ways:
34976
34977 .ilist
34978 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
34979 In other words, the only way to submit messages is via the command line.
34980 .next
34981 Each message is synchronously delivered as soon as it is received (&%-odi%& is
34982 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
34983 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
34984 does not finish until the delivery attempt is complete. If the delivery is
34985 successful, a zero return code is given.
34986 .next
34987 Address redirection is permitted, but the final routing for all addresses must
34988 be to the same remote transport, and to the same list of hosts. Furthermore,
34989 the return address (envelope sender) must be the same for all recipients, as
34990 must any added or deleted header lines. In other words, it must be possible to
34991 deliver the message in a single SMTP transaction, however many recipients there
34992 are.
34993 .next
34994 If these conditions are not met, or if routing any address results in a
34995 failure or defer status, or if Exim is unable to deliver all the recipients
34996 successfully to one of the smart hosts, delivery of the entire message fails.
34997 .next
34998 Because no queueing is allowed, all failures are treated as permanent; there
34999 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
35000 smart host. Furthermore, because only a single yes/no response can be given to
35001 the caller, it is not possible to deliver to some recipients and not others. If
35002 there is an error (temporary or permanent) for any recipient, all are failed.
35003 .next
35004 If more than one smart host is listed, Exim will try another host after a
35005 connection failure or a timeout, in the normal way. However, if this kind of
35006 failure happens for all the hosts, the delivery fails.
35007 .next
35008 When delivery fails, an error message is written to the standard error stream
35009 (as well as to Exim's log), and Exim exits to the caller with a return code
35010 value 1. The message is expunged from Exim's spool files. No bounce messages
35011 are ever generated.
35012 .next
35013 No retry data is maintained, and any retry rules are ignored.
35014 .next
35015 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
35016 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
35017 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
35018 .endlist
35019
35020 The overall effect is that Exim makes a single synchronous attempt to deliver
35021 the message, failing if there is any kind of problem. Because no local
35022 deliveries are done and no daemon can be run, Exim does not need root
35023 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
35024 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
35025 the advantages and disadvantages of running without root privilege.
35026
35027
35028
35029
35030 . ////////////////////////////////////////////////////////////////////////////
35031 . ////////////////////////////////////////////////////////////////////////////
35032
35033 .chapter "Log files" "CHAPlog"
35034 .scindex IIDloggen "log" "general description"
35035 .cindex "log" "types of"
35036 Exim writes three different logs, referred to as the main log, the reject log,
35037 and the panic log:
35038
35039 .ilist
35040 .cindex "main log"
35041 The main log records the arrival of each message and each delivery in a single
35042 line in each case. The format is as compact as possible, in an attempt to keep
35043 down the size of log files. Two-character flag sequences make it easy to pick
35044 out these lines. A number of other events are recorded in the main log. Some of
35045 them are optional, in which case the &%log_selector%& option controls whether
35046 they are included or not. A Perl script called &'eximstats'&, which does simple
35047 analysis of main log files, is provided in the Exim distribution (see section
35048 &<<SECTmailstat>>&).
35049 .next
35050 .cindex "reject log"
35051 The reject log records information from messages that are rejected as a result
35052 of a configuration option (that is, for policy reasons).
35053 The first line of each rejection is a copy of the line that is also written to
35054 the main log. Then, if the message's header has been read at the time the log
35055 is written, its contents are written to this log. Only the original header
35056 lines are available; header lines added by ACLs are not logged. You can use the
35057 reject log to check that your policy controls are working correctly; on a busy
35058 host this may be easier than scanning the main log for rejection messages. You
35059 can suppress the writing of the reject log by setting &%write_rejectlog%&
35060 false.
35061 .next
35062 .cindex "panic log"
35063 .cindex "system log"
35064 When certain serious errors occur, Exim writes entries to its panic log. If the
35065 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
35066 are usually written to the main log as well, but can get lost amid the mass of
35067 other entries. The panic log should be empty under normal circumstances. It is
35068 therefore a good idea to check it (or to have a &'cron'& script check it)
35069 regularly, in order to become aware of any problems. When Exim cannot open its
35070 panic log, it tries as a last resort to write to the system log (syslog). This
35071 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
35072 message itself is written at priority LOG_CRIT.
35073 .endlist
35074
35075 Every log line starts with a timestamp, in the format shown in the following
35076 example. Note that many of the examples shown in this chapter are line-wrapped.
35077 In the log file, this would be all on one line:
35078 .code
35079 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
35080   by QUIT
35081 .endd
35082 By default, the timestamps are in the local timezone. There are two
35083 ways of changing this:
35084
35085 .ilist
35086 You can set the &%timezone%& option to a different time zone; in particular, if
35087 you set
35088 .code
35089 timezone = UTC
35090 .endd
35091 the timestamps will be in UTC (aka GMT).
35092 .next
35093 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
35094 example:
35095 .code
35096 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
35097 .endd
35098 .endlist
35099
35100 .cindex "log" "process ids in"
35101 .cindex "pid (process id)" "in log lines"
35102 Exim does not include its process id in log lines by default, but you can
35103 request that it does so by specifying the &`pid`& log selector (see section
35104 &<<SECTlogselector>>&). When this is set, the process id is output, in square
35105 brackets, immediately after the time and date.
35106
35107
35108
35109
35110 .section "Where the logs are written" "SECTwhelogwri"
35111 .cindex "log" "destination"
35112 .cindex "log" "to file"
35113 .cindex "log" "to syslog"
35114 .cindex "syslog"
35115 The logs may be written to local files, or to syslog, or both. However, it
35116 should be noted that many syslog implementations use UDP as a transport, and
35117 are therefore unreliable in the sense that messages are not guaranteed to
35118 arrive at the loghost, nor is the ordering of messages necessarily maintained.
35119 It has also been reported that on large log files (tens of megabytes) you may
35120 need to tweak syslog to prevent it syncing the file with each write &-- on
35121 Linux this has been seen to make syslog take 90% plus of CPU time.
35122
35123 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
35124 &_Local/Makefile_& or by setting &%log_file_path%& in the run time
35125 configuration. This latter string is expanded, so it can contain, for example,
35126 references to the host name:
35127 .code
35128 log_file_path = /var/log/$primary_hostname/exim_%slog
35129 .endd
35130 It is generally advisable, however, to set the string in &_Local/Makefile_&
35131 rather than at run time, because then the setting is available right from the
35132 start of Exim's execution. Otherwise, if there's something it wants to log
35133 before it has read the configuration file (for example, an error in the
35134 configuration file) it will not use the path you want, and may not be able to
35135 log at all.
35136
35137 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
35138 list, currently limited to at most two items. This is one option where the
35139 facility for changing a list separator may not be used. The list must always be
35140 colon-separated. If an item in the list is &"syslog"& then syslog is used;
35141 otherwise the item must either be an absolute path, containing &`%s`& at the
35142 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
35143 implying the use of a default path.
35144
35145 When Exim encounters an empty item in the list, it searches the list defined by
35146 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
35147 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
35148 mean &"use the path specified at build time"&. It no such item exists, log
35149 files are written in the &_log_& subdirectory of the spool directory. This is
35150 equivalent to the setting:
35151 .code
35152 log_file_path = $spool_directory/log/%slog
35153 .endd
35154 If you do not specify anything at build time or run time,
35155 or if you unset the option at run time (i.e. &`log_file_path = `&),
35156 that is where the logs are written.
35157
35158 A log file path may also contain &`%D`& or &`%M`& if datestamped log file names
35159 are in use &-- see section &<<SECTdatlogfil>>& below.
35160
35161 Here are some examples of possible settings:
35162 .display
35163 &`LOG_FILE_PATH=syslog                    `& syslog only
35164 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
35165 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
35166 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
35167 .endd
35168 If there are more than two paths in the list, the first is used and a panic
35169 error is logged.
35170
35171
35172
35173 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
35174 .cindex "log" "cycling local files"
35175 .cindex "cycling logs"
35176 .cindex "&'exicyclog'&"
35177 .cindex "log" "local files; writing to"
35178 Some operating systems provide centralized and standardized methods for cycling
35179 log files. For those that do not, a utility script called &'exicyclog'& is
35180 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
35181 main and reject logs each time it is called. The maximum number of old logs to
35182 keep can be set. It is suggested this script is run as a daily &'cron'& job.
35183
35184 An Exim delivery process opens the main log when it first needs to write to it,
35185 and it keeps the file open in case subsequent entries are required &-- for
35186 example, if a number of different deliveries are being done for the same
35187 message. However, remote SMTP deliveries can take a long time, and this means
35188 that the file may be kept open long after it is renamed if &'exicyclog'& or
35189 something similar is being used to rename log files on a regular basis. To
35190 ensure that a switch of log files is noticed as soon as possible, Exim calls
35191 &[stat()]& on the main log's name before reusing an open file, and if the file
35192 does not exist, or its inode has changed, the old file is closed and Exim
35193 tries to open the main log from scratch. Thus, an old log file may remain open
35194 for quite some time, but no Exim processes should write to it once it has been
35195 renamed.
35196
35197
35198
35199 .section "Datestamped log files" "SECTdatlogfil"
35200 .cindex "log" "datestamped files"
35201 Instead of cycling the main and reject log files by renaming them
35202 periodically, some sites like to use files whose names contain a datestamp,
35203 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
35204 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
35205 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
35206 point where the datestamp is required. For example:
35207 .code
35208 log_file_path = /var/spool/exim/log/%slog-%D
35209 log_file_path = /var/log/exim-%s-%D.log
35210 log_file_path = /var/spool/exim/log/%D-%slog
35211 log_file_path = /var/log/exim/%s.%M
35212 .endd
35213 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
35214 examples of names generated by the above examples:
35215 .code
35216 /var/spool/exim/log/mainlog-20021225
35217 /var/log/exim-reject-20021225.log
35218 /var/spool/exim/log/20021225-mainlog
35219 /var/log/exim/main.200212
35220 .endd
35221 When this form of log file is specified, Exim automatically switches to new
35222 files at midnight. It does not make any attempt to compress old logs; you
35223 will need to write your own script if you require this. You should not
35224 run &'exicyclog'& with this form of logging.
35225
35226 The location of the panic log is also determined by &%log_file_path%&, but it
35227 is not datestamped, because rotation of the panic log does not make sense.
35228 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
35229 the string. In addition, if it immediately follows a slash, a following
35230 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
35231 character is removed. Thus, the four examples above would give these panic
35232 log names:
35233 .code
35234 /var/spool/exim/log/paniclog
35235 /var/log/exim-panic.log
35236 /var/spool/exim/log/paniclog
35237 /var/log/exim/panic
35238 .endd
35239
35240
35241 .section "Logging to syslog" "SECID249"
35242 .cindex "log" "syslog; writing to"
35243 The use of syslog does not change what Exim logs or the format of its messages,
35244 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
35245 Exim's log lines are omitted when these lines are sent to syslog. Apart from
35246 that, the same strings are written to syslog as to log files. The syslog
35247 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
35248 by default, but you can change these by setting the &%syslog_facility%& and
35249 &%syslog_processname%& options, respectively. If Exim was compiled with
35250 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
35251 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
35252 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
35253 the time and host name to each line.
35254 The three log streams are mapped onto syslog priorities as follows:
35255
35256 .ilist
35257 &'mainlog'& is mapped to LOG_INFO
35258 .next
35259 &'rejectlog'& is mapped to LOG_NOTICE
35260 .next
35261 &'paniclog'& is mapped to LOG_ALERT
35262 .endlist
35263
35264 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
35265 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
35266 these are routed by syslog to the same place. You can suppress this duplication
35267 by setting &%syslog_duplication%& false.
35268
35269 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
35270 entries contain multiple lines when headers are included. To cope with both
35271 these cases, entries written to syslog are split into separate &[syslog()]&
35272 calls at each internal newline, and also after a maximum of
35273 870 data characters. (This allows for a total syslog line length of 1024, when
35274 additions such as timestamps are added.) If you are running a syslog
35275 replacement that can handle lines longer than the 1024 characters allowed by
35276 RFC 3164, you should set
35277 .code
35278 SYSLOG_LONG_LINES=yes
35279 .endd
35280 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
35281 lines, but it still splits at internal newlines in &'reject'& log entries.
35282
35283 To make it easy to re-assemble split lines later, each component of a split
35284 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
35285 where <&'n'&> is the component number and <&'m'&> is the total number of
35286 components in the entry. The / delimiter is used when the line was split
35287 because it was too long; if it was split because of an internal newline, the \
35288 delimiter is used. For example, supposing the length limit to be 50 instead of
35289 870, the following would be the result of a typical rejection message to
35290 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
35291 name, and pid as added by syslog:
35292 .code
35293 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
35294 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
35295 [3/5]  when scanning for sender: missing or malformed lo
35296 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
35297 [5/5] mple>)
35298 .endd
35299 The same error might cause the following lines to be written to &"rejectlog"&
35300 (LOG_NOTICE):
35301 .code
35302 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
35303 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
35304 [3/18] er when scanning for sender: missing or malformed
35305 [4/18]  local part in "<>" (envelope sender is <ph10@cam
35306 [5\18] .example>)
35307 [6\18] Recipients: ph10@some.domain.cam.example
35308 [7\18] P Received: from [127.0.0.1] (ident=ph10)
35309 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
35310 [9\18]        id 16RdAL-0006pc-00
35311 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
35312 [11\18] 09:43 +0100
35313 [12\18] F From: <>
35314 [13\18]   Subject: this is a test header
35315 [18\18]   X-something: this is another header
35316 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
35317 [16\18] le>
35318 [17\18] B Bcc:
35319 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
35320 .endd
35321 Log lines that are neither too long nor contain newlines are written to syslog
35322 without modification.
35323
35324 If only syslog is being used, the Exim monitor is unable to provide a log tail
35325 display, unless syslog is routing &'mainlog'& to a file on the local host and
35326 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
35327 where it is.
35328
35329
35330
35331 .section "Log line flags" "SECID250"
35332 One line is written to the main log for each message received, and for each
35333 successful, unsuccessful, and delayed delivery. These lines can readily be
35334 picked out by the distinctive two-character flags that immediately follow the
35335 timestamp. The flags are:
35336 .display
35337 &`<=`&     message arrival
35338 &`=>`&     normal message delivery
35339 &`->`&     additional address in same delivery
35340 &`>>`&     cutthrough message delivery
35341 &`*>`&     delivery suppressed by &%-N%&
35342 &`**`&     delivery failed; address bounced
35343 &`==`&     delivery deferred; temporary problem
35344 .endd
35345
35346
35347 .section "Logging message reception" "SECID251"
35348 .cindex "log" "reception line"
35349 The format of the single-line entry in the main log that is written for every
35350 message received is shown in the basic example below, which is split over
35351 several lines in order to fit it on the page:
35352 .code
35353 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
35354   H=mailer.fict.example [192.168.123.123] U=exim
35355   P=smtp S=5678 id=<incoming message id>
35356 .endd
35357 The address immediately following &"<="& is the envelope sender address. A
35358 bounce message is shown with the sender address &"<>"&, and if it is locally
35359 generated, this is followed by an item of the form
35360 .code
35361 R=<message id>
35362 .endd
35363 which is a reference to the message that caused the bounce to be sent.
35364
35365 .cindex "HELO"
35366 .cindex "EHLO"
35367 For messages from other hosts, the H and U fields identify the remote host and
35368 record the RFC 1413 identity of the user that sent the message, if one was
35369 received. The number given in square brackets is the IP address of the sending
35370 host. If there is a single, unparenthesized  host name in the H field, as
35371 above, it has been verified to correspond to the IP address (see the
35372 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
35373 by the remote host in the SMTP HELO or EHLO command, and has not been
35374 verified. If verification yields a different name to that given for HELO or
35375 EHLO, the verified name appears first, followed by the HELO or EHLO
35376 name in parentheses.
35377
35378 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
35379 without brackets, in the HELO or EHLO command, leading to entries in
35380 the log containing text like these examples:
35381 .code
35382 H=(10.21.32.43) [192.168.8.34]
35383 H=([10.21.32.43]) [192.168.8.34]
35384 .endd
35385 This can be confusing. Only the final address in square brackets can be relied
35386 on.
35387
35388 For locally generated messages (that is, messages not received over TCP/IP),
35389 the H field is omitted, and the U field contains the login name of the caller
35390 of Exim.
35391
35392 .cindex "authentication" "logging"
35393 .cindex "AUTH" "logging"
35394 For all messages, the P field specifies the protocol used to receive the
35395 message. This is the value that is stored in &$received_protocol$&. In the case
35396 of incoming SMTP messages, the value indicates whether or not any SMTP
35397 extensions (ESMTP), encryption, or authentication were used. If the SMTP
35398 session was encrypted, there is an additional X field that records the cipher
35399 suite that was used.
35400
35401 .cindex log protocol
35402 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
35403 hosts that have authenticated themselves using the SMTP AUTH command. The first
35404 value is used when the SMTP connection was encrypted (&"secure"&). In this case
35405 there is an additional item A= followed by the name of the authenticator that
35406 was used. If an authenticated identification was set up by the authenticator's
35407 &%server_set_id%& option, this is logged too, separated by a colon from the
35408 authenticator name.
35409
35410 .cindex "size" "of message"
35411 The id field records the existing message id, if present. The size of the
35412 received message is given by the S field. When the message is delivered,
35413 headers may be removed or added, so that the size of delivered copies of the
35414 message may not correspond with this value (and indeed may be different to each
35415 other).
35416
35417 The &%log_selector%& option can be used to request the logging of additional
35418 data when a message is received. See section &<<SECTlogselector>>& below.
35419
35420
35421
35422 .section "Logging deliveries" "SECID252"
35423 .cindex "log" "delivery line"
35424 The format of the single-line entry in the main log that is written for every
35425 delivery is shown in one of the examples below, for local and remote
35426 deliveries, respectively. Each example has been split into multiple lines in order
35427 to fit it on the page:
35428 .code
35429 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
35430   <marv@hitch.fict.example> R=localuser T=local_delivery
35431 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
35432   monk@holistic.fict.example R=dnslookup T=remote_smtp
35433   H=holistic.fict.example [192.168.234.234]
35434 .endd
35435 For ordinary local deliveries, the original address is given in angle brackets
35436 after the final delivery address, which might be a pipe or a file. If
35437 intermediate address(es) exist between the original and the final address, the
35438 last of these is given in parentheses after the final address. The R and T
35439 fields record the router and transport that were used to process the address.
35440
35441 If SMTP AUTH was used for the delivery there is an additional item A=
35442 followed by the name of the authenticator that was used.
35443 If an authenticated identification was set up by the authenticator's &%client_set_id%&
35444 option, this is logged too, separated by a colon from the authenticator name.
35445
35446 If a shadow transport was run after a successful local delivery, the log line
35447 for the successful delivery has an item added on the end, of the form
35448 .display
35449 &`ST=<`&&'shadow transport name'&&`>`&
35450 .endd
35451 If the shadow transport did not succeed, the error message is put in
35452 parentheses afterwards.
35453
35454 .cindex "asterisk" "after IP address"
35455 When more than one address is included in a single delivery (for example, two
35456 SMTP RCPT commands in one transaction) the second and subsequent addresses are
35457 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
35458 down a single SMTP connection, an asterisk follows the IP address in the log
35459 lines for the second and subsequent messages.
35460
35461 .cindex "delivery" "cutthrough; logging"
35462 .cindex "cutthrough" "logging"
35463 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
35464 line precedes the reception line, since cutthrough waits for a possible
35465 rejection from the destination in case it can reject the sourced item.
35466
35467 The generation of a reply message by a filter file gets logged as a
35468 &"delivery"& to the addressee, preceded by &">"&.
35469
35470 The &%log_selector%& option can be used to request the logging of additional
35471 data when a message is delivered. See section &<<SECTlogselector>>& below.
35472
35473
35474 .section "Discarded deliveries" "SECID253"
35475 .cindex "discarded messages"
35476 .cindex "message" "discarded"
35477 .cindex "delivery" "discarded; logging"
35478 When a message is discarded as a result of the command &"seen finish"& being
35479 obeyed in a filter file which generates no deliveries, a log entry of the form
35480 .code
35481 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
35482   <low.club@bridge.example> R=userforward
35483 .endd
35484 is written, to record why no deliveries are logged. When a message is discarded
35485 because it is aliased to &":blackhole:"& the log line is like this:
35486 .code
35487 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
35488   <hole@nowhere.example> R=blackhole_router
35489 .endd
35490
35491
35492 .section "Deferred deliveries" "SECID254"
35493 When a delivery is deferred, a line of the following form is logged:
35494 .code
35495 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
35496   R=dnslookup T=smtp defer (146): Connection refused
35497 .endd
35498 In the case of remote deliveries, the error is the one that was given for the
35499 last IP address that was tried. Details of individual SMTP failures are also
35500 written to the log, so the above line would be preceded by something like
35501 .code
35502 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
35503   mail1.endrest.example [192.168.239.239]: Connection refused
35504 .endd
35505 When a deferred address is skipped because its retry time has not been reached,
35506 a message is written to the log, but this can be suppressed by setting an
35507 appropriate value in &%log_selector%&.
35508
35509
35510
35511 .section "Delivery failures" "SECID255"
35512 .cindex "delivery" "failure; logging"
35513 If a delivery fails because an address cannot be routed, a line of the
35514 following form is logged:
35515 .code
35516 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
35517   <jim@trek99.example>: unknown mail domain
35518 .endd
35519 If a delivery fails at transport time, the router and transport are shown, and
35520 the response from the remote host is included, as in this example:
35521 .code
35522 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
35523   R=dnslookup T=remote_smtp: SMTP error from remote mailer
35524   after pipelined RCPT TO:<ace400@pb.example>: host
35525   pbmail3.py.example [192.168.63.111]: 553 5.3.0
35526   <ace400@pb.example>...Addressee unknown
35527 .endd
35528 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
35529 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
35530 disabling PIPELINING. The log lines for all forms of delivery failure are
35531 flagged with &`**`&.
35532
35533
35534
35535 .section "Fake deliveries" "SECID256"
35536 .cindex "delivery" "fake; logging"
35537 If a delivery does not actually take place because the &%-N%& option has been
35538 used to suppress it, a normal delivery line is written to the log, except that
35539 &"=>"& is replaced by &"*>"&.
35540
35541
35542
35543 .section "Completion" "SECID257"
35544 A line of the form
35545 .code
35546 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
35547 .endd
35548 is written to the main log when a message is about to be removed from the spool
35549 at the end of its processing.
35550
35551
35552
35553
35554 .section "Summary of Fields in Log Lines" "SECID258"
35555 .cindex "log" "summary of fields"
35556 A summary of the field identifiers that are used in log lines is shown in
35557 the following table:
35558 .display
35559 &`A   `&        authenticator name (and optional id and sender)
35560 &`C   `&        SMTP confirmation on delivery
35561 &`    `&        command list for &"no mail in SMTP session"&
35562 &`CV  `&        certificate verification status
35563 &`D   `&        duration of &"no mail in SMTP session"&
35564 &`DN  `&        distinguished name from peer certificate
35565 &`DT  `&        on &`=>`& lines: time taken for a delivery
35566 &`F   `&        sender address (on delivery lines)
35567 &`H   `&        host name and IP address
35568 &`I   `&        local interface used
35569 &`id  `&        message id for incoming message
35570 &`P   `&        on &`<=`& lines: protocol used
35571 &`    `&        on &`=>`& and &`**`& lines: return path
35572 &`PRX `&        on &'<='& and&`=>`& lines: proxy address
35573 &`QT  `&        on &`=>`& lines: time spent on queue so far
35574 &`    `&        on &"Completed"& lines: time spent on queue
35575 &`R   `&        on &`<=`& lines: reference for local bounce
35576 &`    `&        on &`=>`&  &`**`& and &`==`& lines: router name
35577 &`S   `&        size of message
35578 &`SNI `&        server name indication from TLS client hello
35579 &`ST  `&        shadow transport name
35580 &`T   `&        on &`<=`& lines: message subject (topic)
35581 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
35582 &`U   `&        local user or RFC 1413 identity
35583 &`X   `&        TLS cipher suite
35584 .endd
35585
35586
35587 .section "Other log entries" "SECID259"
35588 Various other types of log entry are written from time to time. Most should be
35589 self-explanatory. Among the more common are:
35590
35591 .ilist
35592 .cindex "retry" "time not reached"
35593 &'retry time not reached'&&~&~An address previously suffered a temporary error
35594 during routing or local delivery, and the time to retry has not yet arrived.
35595 This message is not written to an individual message log file unless it happens
35596 during the first delivery attempt.
35597 .next
35598 &'retry time not reached for any host'&&~&~An address previously suffered
35599 temporary errors during remote delivery, and the retry time has not yet arrived
35600 for any of the hosts to which it is routed.
35601 .next
35602 .cindex "spool directory" "file locked"
35603 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
35604 some other Exim process is already working on the message. This can be quite
35605 common if queue running processes are started at frequent intervals. The
35606 &'exiwhat'& utility script can be used to find out what Exim processes are
35607 doing.
35608 .next
35609 .cindex "error" "ignored"
35610 &'error ignored'&&~&~There are several circumstances that give rise to this
35611 message:
35612 .olist
35613 Exim failed to deliver a bounce message whose age was greater than
35614 &%ignore_bounce_errors_after%&. The bounce was discarded.
35615 .next
35616 A filter file set up a delivery using the &"noerror"& option, and the delivery
35617 failed. The delivery was discarded.
35618 .next
35619 A delivery set up by a router configured with
35620 . ==== As this is a nested list, any displays it contains must be indented
35621 . ==== as otherwise they are too far to the left.
35622 .code
35623     errors_to = <>
35624 .endd
35625 failed. The delivery was discarded.
35626 .endlist olist
35627 .endlist ilist
35628
35629
35630
35631
35632
35633 .section "Reducing or increasing what is logged" "SECTlogselector"
35634 .cindex "log" "selectors"
35635 By setting the &%log_selector%& global option, you can disable some of Exim's
35636 default logging, or you can request additional logging. The value of
35637 &%log_selector%& is made up of names preceded by plus or minus characters. For
35638 example:
35639 .code
35640 log_selector = +arguments -retry_defer
35641 .endd
35642 The list of optional log items is in the following table, with the default
35643 selection marked by asterisks:
35644 .display
35645 &` 8bitmime                   `&  received 8BITMIME status
35646 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
35647 &` address_rewrite            `&  address rewriting
35648 &` all_parents                `&  all parents in => lines
35649 &` arguments                  `&  command line arguments
35650 &`*connection_reject          `&  connection rejections
35651 &`*delay_delivery             `&  immediate delivery delayed
35652 &` deliver_time               `&  time taken to perform delivery
35653 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
35654 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
35655 &`*etrn                       `&  ETRN commands
35656 &`*host_lookup_failed         `&  as it says
35657 &` ident_timeout              `&  timeout for ident connection
35658 &` incoming_interface         `&  local interface on <= and => lines
35659 &` incoming_port              `&  remote port on <= lines
35660 &`*lost_incoming_connection   `&  as it says (includes timeouts)
35661 .new
35662 &` outgoing_interface         `&  local interface on => lines
35663 .wen
35664 &` outgoing_port              `&  add remote port to => lines
35665 &`*queue_run                  `&  start and end queue runs
35666 &` queue_time                 `&  time on queue for one recipient
35667 &` queue_time_overall         `&  time on queue for whole message
35668 &` pid                        `&  Exim process id
35669 .new
35670 &` proxy                      `&  proxy address on <= and => lines
35671 .wen
35672 &` received_recipients        `&  recipients on <= lines
35673 &` received_sender            `&  sender on <= lines
35674 &`*rejected_header            `&  header contents on reject log
35675 &`*retry_defer                `&  &"retry time not reached"&
35676 &` return_path_on_delivery    `&  put return path on => and ** lines
35677 &` sender_on_delivery         `&  add sender to => lines
35678 &`*sender_verify_fail         `&  sender verification failures
35679 &`*size_reject                `&  rejection because too big
35680 &`*skip_delivery              `&  delivery skipped in a queue run
35681 &`*smtp_confirmation          `&  SMTP confirmation on => lines
35682 &` smtp_connection            `&  incoming SMTP connections
35683 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
35684 &` smtp_mailauth              `&  AUTH argument to MAIL commands
35685 &` smtp_no_mail               `&  session with no MAIL commands
35686 &` smtp_protocol_error        `&  SMTP protocol errors
35687 &` smtp_syntax_error          `&  SMTP syntax errors
35688 &` subject                    `&  contents of &'Subject:'& on <= lines
35689 &`*tls_certificate_verified   `&  certificate verification status
35690 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
35691 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
35692 &` tls_sni                    `&  TLS SNI on <= lines
35693 &` unknown_in_list            `&  DNS lookup failed in list match
35694
35695 &` all                        `&  all of the above
35696 .endd
35697 See also the &%slow_lookup_log%& main configuration option,
35698 section &<<SECID99>>&
35699
35700 More details on each of these items follows:
35701
35702 .ilist
35703 .cindex "8BITMIME"
35704 .cindex "log" "8BITMIME"
35705 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
35706 which may help in tracking down interoperability issues with ancient MTAs
35707 that are not 8bit clean.  This is added to the &"<="& line, tagged with
35708 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
35709 &`7BIT`& and &`8BITMIME`& respectively.
35710 .next
35711 .cindex "&%warn%& ACL verb" "log when skipping"
35712 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
35713 its conditions cannot be evaluated, a log line to this effect is written if
35714 this log selector is set.
35715 .next
35716 .cindex "log" "rewriting"
35717 .cindex "rewriting" "logging"
35718 &%address_rewrite%&: This applies both to global rewrites and per-transport
35719 rewrites, but not to rewrites in filters run as an unprivileged user (because
35720 such users cannot access the log).
35721 .next
35722 .cindex "log" "full parentage"
35723 &%all_parents%&: Normally only the original and final addresses are logged on
35724 delivery lines; with this selector, intermediate parents are given in
35725 parentheses between them.
35726 .next
35727 .cindex "log" "Exim arguments"
35728 .cindex "Exim arguments, logging"
35729 &%arguments%&: This causes Exim to write the arguments with which it was called
35730 to the main log, preceded by the current working directory. This is a debugging
35731 feature, added to make it easier to find out how certain MUAs call
35732 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
35733 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
35734 that are empty or that contain white space are quoted. Non-printing characters
35735 are shown as escape sequences. This facility cannot log unrecognized arguments,
35736 because the arguments are checked before the configuration file is read. The
35737 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
35738 between the caller and Exim.
35739 .next
35740 .cindex "log" "connection rejections"
35741 &%connection_reject%&: A log entry is written whenever an incoming SMTP
35742 connection is rejected, for whatever reason.
35743 .next
35744 .cindex "log" "delayed delivery"
35745 .cindex "delayed delivery, logging"
35746 &%delay_delivery%&: A log entry is written whenever a delivery process is not
35747 started for an incoming message because the load is too high or too many
35748 messages were received on one connection. Logging does not occur if no delivery
35749 process is started because &%queue_only%& is set or &%-odq%& was used.
35750 .next
35751 .cindex "log" "delivery duration"
35752 &%deliver_time%&: For each delivery, the amount of real time it has taken to
35753 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
35754 .next
35755 .cindex "log" "message size on delivery"
35756 .cindex "size" "of message"
35757 &%delivery_size%&: For each delivery, the size of message delivered is added to
35758 the &"=>"& line, tagged with S=.
35759 .next
35760 .cindex "log" "dnslist defer"
35761 .cindex "DNS list" "logging defer"
35762 .cindex "black list (DNS)"
35763 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
35764 DNS black list suffers a temporary error.
35765 .next
35766 .cindex "log" "ETRN commands"
35767 .cindex "ETRN" "logging"
35768 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
35769 is run to determine whether or not it is actually accepted. An invalid ETRN
35770 command, or one received within a message transaction is not logged by this
35771 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
35772 .next
35773 .cindex "log" "host lookup failure"
35774 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
35775 any addresses, or when a lookup of an IP address fails to find a host name, a
35776 log line is written. This logging does not apply to direct DNS lookups when
35777 routing email addresses, but it does apply to &"byname"& lookups.
35778 .next
35779 .cindex "log" "ident timeout"
35780 .cindex "RFC 1413" "logging timeout"
35781 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
35782 client's ident port times out.
35783 .next
35784 .cindex "log" "incoming interface"
35785 .cindex "log" "local interface"
35786 .cindex "log" "local address and port"
35787 .cindex "TCP/IP" "logging local address and port"
35788 .cindex "interface" "logging"
35789 &%incoming_interface%&: The interface on which a message was received is added
35790 to the &"<="& line as an IP address in square brackets, tagged by I= and
35791 followed by a colon and the port number. The local interface and port are also
35792 added to other SMTP log lines, for example &"SMTP connection from"&, to
35793 rejection lines, and (despite the name) to outgoing &"=>"& and &"->"& lines.
35794 .new
35795 The latter can be disabled by turning off the &%outgoing_interface%& option.
35796 .wen
35797 .next
35798 .new
35799 .cindex log "incoming proxy address"
35800 .cindex proxy "logging proxy address"
35801 .cindex "TCP/IP" "logging proxy address"
35802 &%proxy%&: The internal (closest to the system running Exim) IP address
35803 of the proxy, tagged by PRX=, on the &"<="& line for a message accepted
35804 on a proxied connection
35805 or the &"=>"& line for a message delivered on a proxied connection..
35806 See &<<SECTproxyInbound>>& for more information.
35807 .wen
35808 .next
35809 .cindex "log" "incoming remote port"
35810 .cindex "port" "logging remote"
35811 .cindex "TCP/IP" "logging incoming remote port"
35812 .vindex "&$sender_fullhost$&"
35813 .vindex "&$sender_rcvhost$&"
35814 &%incoming_port%&: The remote port number from which a message was received is
35815 added to log entries and &'Received:'& header lines, following the IP address
35816 in square brackets, and separated from it by a colon. This is implemented by
35817 changing the value that is put in the &$sender_fullhost$& and
35818 &$sender_rcvhost$& variables. Recording the remote port number has become more
35819 important with the widening use of NAT (see RFC 2505).
35820 .next
35821 .cindex "log" "dropped connection"
35822 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
35823 connection is unexpectedly dropped.
35824 .next
35825 .cindex "log" "outgoing interface"
35826 .cindex "log" "local interface"
35827 .cindex "log" "local address and port"
35828 .cindex "TCP/IP" "logging local address and port"
35829 .cindex "interface" "logging"
35830 .new
35831 &%outgoing_interface%&: If &%incoming_interface%& is turned on, then the
35832 interface on which a message was sent is added to delivery lines as an I= tag
35833 followed by IP address in square brackets. You can disable this by turning
35834 off the &%outgoing_interface%& option.
35835 .wen
35836 .next
35837 .cindex "log" "outgoing remote port"
35838 .cindex "port" "logging outgoint remote"
35839 .cindex "TCP/IP" "logging ougtoing remote port"
35840 &%outgoing_port%&: The remote port number is added to delivery log lines (those
35841 containing => tags) following the IP address.
35842 .new
35843 The local port is also added if &%incoming_interface%& and
35844 &%outgoing_interface%& are both enabled.
35845 .wen
35846 This option is not included in the default setting, because for most ordinary
35847 configurations, the remote port number is always 25 (the SMTP port), and the
35848 local port is a random ephemeral port.
35849 .next
35850 .cindex "log" "process ids in"
35851 .cindex "pid (process id)" "in log lines"
35852 &%pid%&: The current process id is added to every log line, in square brackets,
35853 immediately after the time and date.
35854 .next
35855 .cindex "log" "queue run"
35856 .cindex "queue runner" "logging"
35857 &%queue_run%&: The start and end of every queue run are logged.
35858 .next
35859 .cindex "log" "queue time"
35860 &%queue_time%&: The amount of time the message has been in the queue on the
35861 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
35862 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
35863 includes reception time as well as the delivery time for the current address.
35864 This means that it may be longer than the difference between the arrival and
35865 delivery log line times, because the arrival log line is not written until the
35866 message has been successfully received.
35867 .next
35868 &%queue_time_overall%&: The amount of time the message has been in the queue on
35869 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
35870 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
35871 message, so it includes reception time as well as the total delivery time.
35872 .next
35873 .cindex "log" "recipients"
35874 &%received_recipients%&: The recipients of a message are listed in the main log
35875 as soon as the message is received. The list appears at the end of the log line
35876 that is written when a message is received, preceded by the word &"for"&. The
35877 addresses are listed after they have been qualified, but before any rewriting
35878 has taken place.
35879 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
35880 in the list.
35881 .next
35882 .cindex "log" "sender reception"
35883 &%received_sender%&: The unrewritten original sender of a message is added to
35884 the end of the log line that records the message's arrival, after the word
35885 &"from"& (before the recipients if &%received_recipients%& is also set).
35886 .next
35887 .cindex "log" "header lines for rejection"
35888 &%rejected_header%&: If a message's header has been received at the time a
35889 rejection is written to the reject log, the complete header is added to the
35890 log. Header logging can be turned off individually for messages that are
35891 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
35892 .next
35893 .cindex "log" "retry defer"
35894 &%retry_defer%&: A log line is written if a delivery is deferred because a
35895 retry time has not yet been reached. However, this &"retry time not reached"&
35896 message is always omitted from individual message logs after the first delivery
35897 attempt.
35898 .next
35899 .cindex "log" "return path"
35900 &%return_path_on_delivery%&: The return path that is being transmitted with
35901 the message is included in delivery and bounce lines, using the tag P=.
35902 This is omitted if no delivery actually happens, for example, if routing fails,
35903 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
35904 .next
35905 .cindex "log" "sender on delivery"
35906 &%sender_on_delivery%&: The message's sender address is added to every delivery
35907 and bounce line, tagged by F= (for &"from"&).
35908 This is the original sender that was received with the message; it is not
35909 necessarily the same as the outgoing return path.
35910 .next
35911 .cindex "log" "sender verify failure"
35912 &%sender_verify_fail%&: If this selector is unset, the separate log line that
35913 gives details of a sender verification failure is not written. Log lines for
35914 the rejection of SMTP commands contain just &"sender verify failed"&, so some
35915 detail is lost.
35916 .next
35917 .cindex "log" "size rejection"
35918 &%size_reject%&: A log line is written whenever a message is rejected because
35919 it is too big.
35920 .next
35921 .cindex "log" "frozen messages; skipped"
35922 .cindex "frozen messages" "logging skipping"
35923 &%skip_delivery%&: A log line is written whenever a message is skipped during a
35924 queue run because it is frozen or because another process is already delivering
35925 it.
35926 .cindex "&""spool file is locked""&"
35927 The message that is written is &"spool file is locked"&.
35928 .next
35929 .cindex "log" "smtp confirmation"
35930 .cindex "SMTP" "logging confirmation"
35931 .cindex "LMTP" "logging confirmation"
35932 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
35933 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
35934 A number of MTAs (including Exim) return an identifying string in this
35935 response.
35936 .next
35937 .cindex "log" "SMTP connections"
35938 .cindex "SMTP" "logging connections"
35939 &%smtp_connection%&: A log line is written whenever an incoming SMTP connection is
35940 established or closed, unless the connection is from a host that matches
35941 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
35942 only when the closure is unexpected.) This applies to connections from local
35943 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
35944 dropped in the middle of a message, a log line is always written, whether or
35945 not this selector is set, but otherwise nothing is written at the start and end
35946 of connections unless this selector is enabled.
35947
35948 For TCP/IP connections to an Exim daemon, the current number of connections is
35949 included in the log message for each new connection, but note that the count is
35950 reset if the daemon is restarted.
35951 Also, because connections are closed (and the closure is logged) in
35952 subprocesses, the count may not include connections that have been closed but
35953 whose termination the daemon has not yet noticed. Thus, while it is possible to
35954 match up the opening and closing of connections in the log, the value of the
35955 logged counts may not be entirely accurate.
35956 .next
35957 .cindex "log" "SMTP transaction; incomplete"
35958 .cindex "SMTP" "logging incomplete transactions"
35959 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
35960 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
35961 and the message sender plus any accepted recipients are included in the log
35962 line. This can provide evidence of dictionary attacks.
35963 .next
35964 .cindex "log" "non-MAIL SMTP sessions"
35965 .cindex "MAIL" "logging session without"
35966 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
35967 connection terminates without having issued a MAIL command. This includes both
35968 the case when the connection is dropped, and the case when QUIT is used. It
35969 does not include cases where the connection is rejected right at the start (by
35970 an ACL, or because there are too many connections, or whatever). These cases
35971 already have their own log lines.
35972
35973 The log line that is written contains the identity of the client in the usual
35974 way, followed by D= and a time, which records the duration of the connection.
35975 If the connection was authenticated, this fact is logged exactly as it is for
35976 an incoming message, with an A= item. If the connection was encrypted, CV=,
35977 DN=, and X= items may appear as they do for an incoming message, controlled by
35978 the same logging options.
35979
35980 Finally, if any SMTP commands were issued during the connection, a C= item
35981 is added to the line, listing the commands that were used. For example,
35982 .code
35983 C=EHLO,QUIT
35984 .endd
35985 shows that the client issued QUIT straight after EHLO. If there were fewer
35986 than 20 commands, they are all listed. If there were more than 20 commands,
35987 the last 20 are listed, preceded by &"..."&. However, with the default
35988 setting of 10 for &%smtp_accept_max_nonmail%&, the connection will in any case
35989 have been aborted before 20 non-mail commands are processed.
35990 .next
35991 &%smtp_mailauth%&: A third subfield with the authenticated sender,
35992 colon-separated, is appended to the A= item for a message arrival or delivery
35993 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
35994 was accepted or used.
35995 .next
35996 .cindex "log" "SMTP protocol error"
35997 .cindex "SMTP" "logging protocol error"
35998 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
35999 encountered. Exim does not have perfect detection of all protocol errors
36000 because of transmission delays and the use of pipelining. If PIPELINING has
36001 been advertised to a client, an Exim server assumes that the client will use
36002 it, and therefore it does not count &"expected"& errors (for example, RCPT
36003 received after rejecting MAIL) as protocol errors.
36004 .next
36005 .cindex "SMTP" "logging syntax errors"
36006 .cindex "SMTP" "syntax errors; logging"
36007 .cindex "SMTP" "unknown command; logging"
36008 .cindex "log" "unknown SMTP command"
36009 .cindex "log" "SMTP syntax error"
36010 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
36011 encountered. An unrecognized command is treated as a syntax error. For an
36012 external connection, the host identity is given; for an internal connection
36013 using &%-bs%& the sender identification (normally the calling user) is given.
36014 .next
36015 .cindex "log" "subject"
36016 .cindex "subject, logging"
36017 &%subject%&: The subject of the message is added to the arrival log line,
36018 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
36019 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
36020 specifies whether characters with values greater than 127 should be logged
36021 unchanged, or whether they should be rendered as escape sequences.
36022 .next
36023 .cindex "log" "certificate verification"
36024 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
36025 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
36026 verified, and &`CV=no`& if not.
36027 .next
36028 .cindex "log" "TLS cipher"
36029 .cindex "TLS" "logging cipher"
36030 &%tls_cipher%&: When a message is sent or received over an encrypted
36031 connection, the cipher suite used is added to the log line, preceded by X=.
36032 .next
36033 .cindex "log" "TLS peer DN"
36034 .cindex "TLS" "logging peer DN"
36035 &%tls_peerdn%&: When a message is sent or received over an encrypted
36036 connection, and a certificate is supplied by the remote host, the peer DN is
36037 added to the log line, preceded by DN=.
36038 .next
36039 .cindex "log" "TLS SNI"
36040 .cindex "TLS" "logging SNI"
36041 &%tls_sni%&: When a message is received over an encrypted connection, and
36042 the remote host provided the Server Name Indication extension, the SNI is
36043 added to the log line, preceded by SNI=.
36044 .next
36045 .cindex "log" "DNS failure in list"
36046 &%unknown_in_list%&: This setting causes a log entry to be written when the
36047 result of a list match is failure because a DNS lookup failed.
36048 .endlist
36049
36050
36051 .section "Message log" "SECID260"
36052 .cindex "message" "log file for"
36053 .cindex "log" "message log; description of"
36054 .cindex "&_msglog_& directory"
36055 .oindex "&%preserve_message_logs%&"
36056 In addition to the general log files, Exim writes a log file for each message
36057 that it handles. The names of these per-message logs are the message ids, and
36058 they are kept in the &_msglog_& sub-directory of the spool directory. Each
36059 message log contains copies of the log lines that apply to the message. This
36060 makes it easier to inspect the status of an individual message without having
36061 to search the main log. A message log is deleted when processing of the message
36062 is complete, unless &%preserve_message_logs%& is set, but this should be used
36063 only with great care because they can fill up your disk very quickly.
36064
36065 On a heavily loaded system, it may be desirable to disable the use of
36066 per-message logs, in order to reduce disk I/O. This can be done by setting the
36067 &%message_logs%& option false.
36068 .ecindex IIDloggen
36069
36070
36071
36072
36073 . ////////////////////////////////////////////////////////////////////////////
36074 . ////////////////////////////////////////////////////////////////////////////
36075
36076 .chapter "Exim utilities" "CHAPutils"
36077 .scindex IIDutils "utilities"
36078 A number of utility scripts and programs are supplied with Exim and are
36079 described in this chapter. There is also the Exim Monitor, which is covered in
36080 the next chapter. The utilities described here are:
36081
36082 .itable none 0 0 3  7* left  15* left  40* left
36083 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
36084   "list what Exim processes are doing"
36085 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
36086 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
36087 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
36088 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
36089                                                 various criteria"
36090 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
36091 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
36092   "extract statistics from the log"
36093 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
36094   "check address acceptance from given IP"
36095 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
36096 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
36097 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
36098 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
36099 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
36100 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
36101 .endtable
36102
36103 Another utility that might be of use to sites with many MTAs is Tom Kistner's
36104 &'exilog'&. It provides log visualizations across multiple Exim servers. See
36105 &url(http://duncanthrax.net/exilog/) for details.
36106
36107
36108
36109
36110 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
36111 .cindex "&'exiwhat'&"
36112 .cindex "process, querying"
36113 .cindex "SIGUSR1"
36114 On operating systems that can restart a system call after receiving a signal
36115 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
36116 a line describing what it is doing to the file &_exim-process.info_& in the
36117 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
36118 processes it can find, having first emptied the file. It then waits for one
36119 second to allow the Exim processes to react before displaying the results. In
36120 order to run &'exiwhat'& successfully you have to have sufficient privilege to
36121 send the signal to the Exim processes, so it is normally run as root.
36122
36123 &*Warning*&: This is not an efficient process. It is intended for occasional
36124 use by system administrators. It is not sensible, for example, to set up a
36125 script that sends SIGUSR1 signals to Exim processes at short intervals.
36126
36127
36128 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
36129 varies in different operating systems. Not only are different options used,
36130 but the format of the output is different. For this reason, there are some
36131 system configuration options that configure exactly how &'exiwhat'& works. If
36132 it doesn't seem to be working for you, check the following compile-time
36133 options:
36134 .display
36135 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
36136 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
36137 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
36138 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
36139 .endd
36140 An example of typical output from &'exiwhat'& is
36141 .code
36142 164 daemon: -q1h, listening on port 25
36143 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
36144 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
36145   [10.19.42.42] (editor@ref.example)
36146 10592 handling incoming call from [192.168.243.242]
36147 10628 accepting a local non-SMTP message
36148 .endd
36149 The first number in the output line is the process number. The third line has
36150 been split here, in order to fit it on the page.
36151
36152
36153
36154 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
36155 .cindex "&'exiqgrep'&"
36156 .cindex "queue" "grepping"
36157 This utility is a Perl script contributed by Matt Hubbard. It runs
36158 .code
36159 exim -bpu
36160 .endd
36161 or (in case &*-a*& switch is specified)
36162 .code
36163 exim -bp
36164 .endd
36165 The &*-C*& option is used to specify an alternate &_exim.conf_& which might
36166 contain alternate exim configuration the queue management might be using.
36167
36168 to obtain a queue listing, and then greps the output to select messages
36169 that match given criteria. The following selection options are available:
36170
36171 .vlist
36172 .vitem &*-f*&&~<&'regex'&>
36173 Match the sender address using a case-insensitive search. The field that is
36174 tested is enclosed in angle brackets, so you can test for bounce messages with
36175 .code
36176 exiqgrep -f '^<>$'
36177 .endd
36178 .vitem &*-r*&&~<&'regex'&>
36179 Match a recipient address using a case-insensitive search. The field that is
36180 tested is not enclosed in angle brackets.
36181
36182 .vitem &*-s*&&~<&'regex'&>
36183 Match against the size field.
36184
36185 .vitem &*-y*&&~<&'seconds'&>
36186 Match messages that are younger than the given time.
36187
36188 .vitem &*-o*&&~<&'seconds'&>
36189 Match messages that are older than the given time.
36190
36191 .vitem &*-z*&
36192 Match only frozen messages.
36193
36194 .vitem &*-x*&
36195 Match only non-frozen messages.
36196 .endlist
36197
36198 The following options control the format of the output:
36199
36200 .vlist
36201 .vitem &*-c*&
36202 Display only the count of matching messages.
36203
36204 .vitem &*-l*&
36205 Long format &-- display the full message information as output by Exim. This is
36206 the default.
36207
36208 .vitem &*-i*&
36209 Display message ids only.
36210
36211 .vitem &*-b*&
36212 Brief format &-- one line per message.
36213
36214 .vitem &*-R*&
36215 Display messages in reverse order.
36216
36217 .vitem &*-a*&
36218 Include delivered recipients in queue listing.
36219 .endlist
36220
36221 There is one more option, &%-h%&, which outputs a list of options.
36222
36223
36224
36225 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
36226 .cindex "&'exiqsumm'&"
36227 .cindex "queue" "summary"
36228 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
36229 -bp`& and produces a summary of the messages on the queue. Thus, you use it by
36230 running a command such as
36231 .code
36232 exim -bp | exiqsumm
36233 .endd
36234 The output consists of one line for each domain that has messages waiting for
36235 it, as in the following example:
36236 .code
36237 3   2322   74m   66m  msn.com.example
36238 .endd
36239 Each line lists the number of pending deliveries for a domain, their total
36240 volume, and the length of time that the oldest and the newest messages have
36241 been waiting. Note that the number of pending deliveries is greater than the
36242 number of messages when messages have more than one recipient.
36243
36244 A summary line is output at the end. By default the output is sorted on the
36245 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
36246 the output to be sorted by oldest message and by count of messages,
36247 respectively. There are also three options that split the messages for each
36248 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
36249 separates frozen messages, and &%-s%& separates messages according to their
36250 sender.
36251
36252 The output of &'exim -bp'& contains the original addresses in the message, so
36253 this also applies to the output from &'exiqsumm'&. No domains from addresses
36254 generated by aliasing or forwarding are included (unless the &%one_time%&
36255 option of the &(redirect)& router has been used to convert them into &"top
36256 level"& addresses).
36257
36258
36259
36260
36261 .section "Extracting specific information from the log (exigrep)" &&&
36262          "SECTextspeinf"
36263 .cindex "&'exigrep'&"
36264 .cindex "log" "extracts; grepping for"
36265 The &'exigrep'& utility is a Perl script that searches one or more main log
36266 files for entries that match a given pattern. When it finds a match, it
36267 extracts all the log entries for the relevant message, not just those that
36268 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
36269 given message, or all mail for a given user, or for a given host, for example.
36270 The input files can be in Exim log format or syslog format.
36271 If a matching log line is not associated with a specific message, it is
36272 included in &'exigrep'&'s output without any additional lines. The usage is:
36273 .display
36274 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-M] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
36275 .endd
36276 If no log file names are given on the command line, the standard input is read.
36277
36278 The &%-t%& argument specifies a number of seconds. It adds an additional
36279 condition for message selection. Messages that are complete are shown only if
36280 they spent more than <&'n'&> seconds on the queue.
36281
36282 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
36283 makes it case-sensitive. This may give a performance improvement when searching
36284 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
36285 option; with &%-I%& they do not. In both cases it is possible to change the
36286 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
36287
36288 The &%-l%& option means &"literal"&, that is, treat all characters in the
36289 pattern as standing for themselves. Otherwise the pattern must be a Perl
36290 regular expression.
36291
36292 The &%-v%& option inverts the matching condition. That is, a line is selected
36293 if it does &'not'& match the pattern.
36294
36295 The &%-M%& options means &"related messages"&. &'exigrep'& will show messages
36296 that are generated as a result/response to a message that &'exigrep'& matched
36297 normally.
36298
36299 Example of &%-M%&:
36300 user_a sends a message to user_b, which generates a bounce back to user_b. If
36301 &'exigrep'& is used to search for &"user_a"&, only the first message will be
36302 displayed.  But if &'exigrep'& is used to search for &"user_b"&, the first and
36303 the second (bounce) message will be displayed. Using &%-M%& with &'exigrep'&
36304 when searching for &"user_a"& will show both messages since the bounce is
36305 &"related"& to or a &"result"& of the first message that was found by the
36306 search term.
36307
36308 If the location of a &'zcat'& command is known from the definition of
36309 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
36310 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
36311 If the ZCAT_COMMAND is not executable, &'exigrep'& tries to use
36312 autodetection of some well known compression extensions.
36313
36314
36315 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
36316 .cindex "&'exipick'&"
36317 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
36318 lists messages from the queue according to a variety of criteria. For details
36319 of &'exipick'&'s facilities, visit the web page at
36320 &url(http://www.exim.org/eximwiki/ToolExipickManPage) or run &'exipick'& with
36321 the &%--help%& option.
36322
36323
36324 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
36325 .cindex "log" "cycling local files"
36326 .cindex "cycling logs"
36327 .cindex "&'exicyclog'&"
36328 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
36329 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
36330 you are using log files with datestamps in their names (see section
36331 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
36332 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
36333 There are two command line options for &'exicyclog'&:
36334 .ilist
36335 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
36336 default that is set when Exim is built. The default default is 10.
36337 .next
36338 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
36339 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
36340 overriding the script's default, which is to find the setting from Exim's
36341 configuration.
36342 .endlist
36343
36344 Each time &'exicyclog'& is run the file names get &"shuffled down"& by one. If
36345 the main log file name is &_mainlog_& (the default) then when &'exicyclog'& is
36346 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
36347 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
36348 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
36349 logs are handled similarly.
36350
36351 If the limit is greater than 99, the script uses 3-digit numbers such as
36352 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
36353 to one that is greater, or &'vice versa'&, you will have to fix the names of
36354 any existing log files.
36355
36356 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
36357 the end are deleted. All files with numbers greater than 01 are compressed,
36358 using a compression command which is configured by the COMPRESS_COMMAND
36359 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
36360 root &%crontab%& entry of the form
36361 .code
36362 1 0 * * * su exim -c /usr/exim/bin/exicyclog
36363 .endd
36364 assuming you have used the name &"exim"& for the Exim user. You can run
36365 &'exicyclog'& as root if you wish, but there is no need.
36366
36367
36368
36369 .section "Mail statistics (eximstats)" "SECTmailstat"
36370 .cindex "statistics"
36371 .cindex "&'eximstats'&"
36372 A Perl script called &'eximstats'& is provided for extracting statistical
36373 information from log files. The output is either plain text, or HTML.
36374 Exim log files are also supported by the &'Lire'& system produced by the
36375 LogReport Foundation &url(http://www.logreport.org).
36376
36377 The &'eximstats'& script has been hacked about quite a bit over time. The
36378 latest version is the result of some extensive revision by Steve Campbell. A
36379 lot of information is given by default, but there are options for suppressing
36380 various parts of it. Following any options, the arguments to the script are a
36381 list of files, which should be main log files. For example:
36382 .code
36383 eximstats -nr /var/spool/exim/log/mainlog.01
36384 .endd
36385 By default, &'eximstats'& extracts information about the number and volume of
36386 messages received from or delivered to various hosts. The information is sorted
36387 both by message count and by volume, and the top fifty hosts in each category
36388 are listed on the standard output. Similar information, based on email
36389 addresses or domains instead of hosts can be requested by means of various
36390 options. For messages delivered and received locally, similar statistics are
36391 also produced per user.
36392
36393 The output also includes total counts and statistics about delivery errors, and
36394 histograms showing the number of messages received and deliveries made in each
36395 hour of the day. A delivery with more than one address in its envelope (for
36396 example, an SMTP transaction with more than one RCPT command) is counted
36397 as a single delivery by &'eximstats'&.
36398
36399 Though normally more deliveries than receipts are reported (as messages may
36400 have multiple recipients), it is possible for &'eximstats'& to report more
36401 messages received than delivered, even though the queue is empty at the start
36402 and end of the period in question. If an incoming message contains no valid
36403 recipients, no deliveries are recorded for it. A bounce message is handled as
36404 an entirely separate message.
36405
36406 &'eximstats'& always outputs a grand total summary giving the volume and number
36407 of messages received and deliveries made, and the number of hosts involved in
36408 each case. It also outputs the number of messages that were delayed (that is,
36409 not completely delivered at the first attempt), and the number that had at
36410 least one address that failed.
36411
36412 The remainder of the output is in sections that can be independently disabled
36413 or modified by various options. It consists of a summary of deliveries by
36414 transport, histograms of messages received and delivered per time interval
36415 (default per hour), information about the time messages spent on the queue,
36416 a list of relayed messages, lists of the top fifty sending hosts, local
36417 senders, destination hosts, and destination local users by count and by volume,
36418 and a list of delivery errors that occurred.
36419
36420 The relay information lists messages that were actually relayed, that is, they
36421 came from a remote host and were directly delivered to some other remote host,
36422 without being processed (for example, for aliasing or forwarding) locally.
36423
36424 There are quite a few options for &'eximstats'& to control exactly what it
36425 outputs. These are documented in the Perl script itself, and can be extracted
36426 by running the command &(perldoc)& on the script. For example:
36427 .code
36428 perldoc /usr/exim/bin/eximstats
36429 .endd
36430
36431 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
36432 .cindex "&'exim_checkaccess'&"
36433 .cindex "policy control" "checking access"
36434 .cindex "checking access"
36435 The &%-bh%& command line argument allows you to run a fake SMTP session with
36436 debugging output, in order to check what Exim is doing when it is applying
36437 policy controls to incoming SMTP mail. However, not everybody is sufficiently
36438 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
36439 sometimes you just want to answer the question &"Does this address have
36440 access?"& without bothering with any further details.
36441
36442 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
36443 two arguments, an IP address and an email address:
36444 .code
36445 exim_checkaccess 10.9.8.7 A.User@a.domain.example
36446 .endd
36447 The utility runs a call to Exim with the &%-bh%& option, to test whether the
36448 given email address would be accepted in a RCPT command in a TCP/IP
36449 connection from the host with the given IP address. The output of the utility
36450 is either the word &"accepted"&, or the SMTP error response, for example:
36451 .code
36452 Rejected:
36453 550 Relay not permitted
36454 .endd
36455 When running this test, the utility uses &`<>`& as the envelope sender address
36456 for the MAIL command, but you can change this by providing additional
36457 options. These are passed directly to the Exim command. For example, to specify
36458 that the test is to be run with the sender address &'himself@there.example'&
36459 you can use:
36460 .code
36461 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
36462                  -f himself@there.example
36463 .endd
36464 Note that these additional Exim command line items must be given after the two
36465 mandatory arguments.
36466
36467 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
36468 while running its checks. You can run checks that include callouts by using
36469 &%-bhc%&, but this is not yet available in a &"packaged"& form.
36470
36471
36472
36473 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
36474 .cindex "DBM" "building dbm files"
36475 .cindex "building DBM files"
36476 .cindex "&'exim_dbmbuild'&"
36477 .cindex "lower casing"
36478 .cindex "binary zero" "in lookup key"
36479 The &'exim_dbmbuild'& program reads an input file containing keys and data in
36480 the format used by the &(lsearch)& lookup (see section
36481 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
36482 names as keys and the remainder of the information as data. The lower-casing
36483 can be prevented by calling the program with the &%-nolc%& option.
36484
36485 A terminating zero is included as part of the key string. This is expected by
36486 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
36487 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
36488 strings or the data strings. The &(dbmnz)& lookup type can be used with such
36489 files.
36490
36491 The program requires two arguments: the name of the input file (which can be a
36492 single hyphen to indicate the standard input), and the name of the output file.
36493 It creates the output under a temporary name, and then renames it if all went
36494 well.
36495
36496 .cindex "USE_DB"
36497 If the native DB interface is in use (USE_DB is set in a compile-time
36498 configuration file &-- this is common in free versions of Unix) the two file
36499 names must be different, because in this mode the Berkeley DB functions create
36500 a single output file using exactly the name given. For example,
36501 .code
36502 exim_dbmbuild /etc/aliases /etc/aliases.db
36503 .endd
36504 reads the system alias file and creates a DBM version of it in
36505 &_/etc/aliases.db_&.
36506
36507 In systems that use the &'ndbm'& routines (mostly proprietary versions of
36508 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
36509 environment, the suffixes are added to the second argument of
36510 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
36511 when the Berkeley functions are used in compatibility mode (though this is not
36512 recommended), because in that case it adds a &_.db_& suffix to the file name.
36513
36514 If a duplicate key is encountered, the program outputs a warning, and when it
36515 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
36516 option is used. By default, only the first of a set of duplicates is used &--
36517 this makes it compatible with &(lsearch)& lookups. There is an option
36518 &%-lastdup%& which causes it to use the data for the last duplicate instead.
36519 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
36520 &%stderr%&. For other errors, where it doesn't actually make a new file, the
36521 return code is 2.
36522
36523
36524
36525
36526 .section "Finding individual retry times (exinext)" "SECTfinindret"
36527 .cindex "retry" "times"
36528 .cindex "&'exinext'&"
36529 A utility called &'exinext'& (mostly a Perl script) provides the ability to
36530 fish specific information out of the retry database. Given a mail domain (or a
36531 complete address), it looks up the hosts for that domain, and outputs any retry
36532 information for the hosts or for the domain. At present, the retry information
36533 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
36534 output. For example:
36535 .code
36536 $ exinext piglet@milne.fict.example
36537 kanga.milne.example:192.168.8.1 error 146: Connection refused
36538   first failed: 21-Feb-1996 14:57:34
36539   last tried:   21-Feb-1996 14:57:34
36540   next try at:  21-Feb-1996 15:02:34
36541 roo.milne.example:192.168.8.3 error 146: Connection refused
36542   first failed: 20-Jan-1996 13:12:08
36543   last tried:   21-Feb-1996 11:42:03
36544   next try at:  21-Feb-1996 19:42:03
36545   past final cutoff time
36546 .endd
36547 You can also give &'exinext'& a local part, without a domain, and it
36548 will give any retry information for that local part in your default domain.
36549 A message id can be used to obtain retry information pertaining to a specific
36550 message. This exists only when an attempt to deliver a message to a remote host
36551 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
36552 &'exinext'& is not particularly efficient, but then it is not expected to be
36553 run very often.
36554
36555 The &'exinext'& utility calls Exim to find out information such as the location
36556 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
36557 passed on to the &'exim'& commands. The first specifies an alternate Exim
36558 configuration file, and the second sets macros for use within the configuration
36559 file. These features are mainly to help in testing, but might also be useful in
36560 environments where more than one configuration file is in use.
36561
36562
36563
36564 .section "Hints database maintenance" "SECThindatmai"
36565 .cindex "hints database" "maintenance"
36566 .cindex "maintaining Exim's hints database"
36567 Three utility programs are provided for maintaining the DBM files that Exim
36568 uses to contain its delivery hint information. Each program requires two
36569 arguments. The first specifies the name of Exim's spool directory, and the
36570 second is the name of the database it is to operate on. These are as follows:
36571
36572 .ilist
36573 &'retry'&: the database of retry information
36574 .next
36575 &'wait-'&<&'transport name'&>: databases of information about messages waiting
36576 for remote hosts
36577 .next
36578 &'callout'&: the callout cache
36579 .next
36580 &'ratelimit'&: the data for implementing the ratelimit ACL condition
36581 .next
36582 &'misc'&: other hints data
36583 .endlist
36584
36585 The &'misc'& database is used for
36586
36587 .ilist
36588 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
36589 .next
36590 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
36591 &(smtp)& transport)
36592 .next
36593 Limiting the concurrency of specific transports (when &%max_parallel%& is set
36594 in a transport)
36595 .endlist
36596
36597
36598
36599 .section "exim_dumpdb" "SECID261"
36600 .cindex "&'exim_dumpdb'&"
36601 The entire contents of a database are written to the standard output by the
36602 &'exim_dumpdb'& program, which has no options or arguments other than the
36603 spool and database names. For example, to dump the retry database:
36604 .code
36605 exim_dumpdb /var/spool/exim retry
36606 .endd
36607 Two lines of output are produced for each entry:
36608 .code
36609 T:mail.ref.example:192.168.242.242 146 77 Connection refused
36610 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
36611 .endd
36612 The first item on the first line is the key of the record. It starts with one
36613 of the letters R, or T, depending on whether it refers to a routing or
36614 transport retry. For a local delivery, the next part is the local address; for
36615 a remote delivery it is the name of the remote host, followed by its failing IP
36616 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
36617 transport). If the remote port is not the standard one (port 25), it is added
36618 to the IP address. Then there follows an error code, an additional error code,
36619 and a textual description of the error.
36620
36621 The three times on the second line are the time of first failure, the time of
36622 the last delivery attempt, and the computed time for the next attempt. The line
36623 ends with an asterisk if the cutoff time for the last retry rule has been
36624 exceeded.
36625
36626 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
36627 consists of a host name followed by a list of ids for messages that are or were
36628 waiting to be delivered to that host. If there are a very large number for any
36629 one host, continuation records, with a sequence number added to the host name,
36630 may be seen. The data in these records is often out of date, because a message
36631 may be routed to several alternative hosts, and Exim makes no effort to keep
36632 cross-references.
36633
36634
36635
36636 .section "exim_tidydb" "SECID262"
36637 .cindex "&'exim_tidydb'&"
36638 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
36639 database. If run with no options, it removes all records that are more than 30
36640 days old. The age is calculated from the date and time that the record was last
36641 updated. Note that, in the case of the retry database, it is &'not'& the time
36642 since the first delivery failure. Information about a host that has been down
36643 for more than 30 days will remain in the database, provided that the record is
36644 updated sufficiently often.
36645
36646 The cutoff date can be altered by means of the &%-t%& option, which must be
36647 followed by a time. For example, to remove all records older than a week from
36648 the retry database:
36649 .code
36650 exim_tidydb -t 7d /var/spool/exim retry
36651 .endd
36652 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
36653 message ids. In the former these appear as data in records keyed by host &--
36654 they were messages that were waiting for that host &-- and in the latter they
36655 are the keys for retry information for messages that have suffered certain
36656 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
36657 message ids in database records are those of messages that are still on the
36658 queue. Message ids for messages that no longer exist are removed from
36659 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
36660 For the &'retry'& database, records whose keys are non-existent message ids are
36661 removed. The &'exim_tidydb'& utility outputs comments on the standard output
36662 whenever it removes information from the database.
36663
36664 Certain records are automatically removed by Exim when they are no longer
36665 needed, but others are not. For example, if all the MX hosts for a domain are
36666 down, a retry record is created for each one. If the primary MX host comes back
36667 first, its record is removed when Exim successfully delivers to it, but the
36668 records for the others remain because Exim has not tried to use those hosts.
36669
36670 It is important, therefore, to run &'exim_tidydb'& periodically on all the
36671 hints databases. You should do this at a quiet time of day, because it requires
36672 a database to be locked (and therefore inaccessible to Exim) while it does its
36673 work. Removing records from a DBM file does not normally make the file smaller,
36674 but all the common DBM libraries are able to re-use the space that is released.
36675 After an initial phase of increasing in size, the databases normally reach a
36676 point at which they no longer get any bigger, as long as they are regularly
36677 tidied.
36678
36679 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
36680 databases is likely to keep on increasing.
36681
36682
36683
36684
36685 .section "exim_fixdb" "SECID263"
36686 .cindex "&'exim_fixdb'&"
36687 The &'exim_fixdb'& program is a utility for interactively modifying databases.
36688 Its main use is for testing Exim, but it might also be occasionally useful for
36689 getting round problems in a live system. It has no options, and its interface
36690 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
36691 key of a database record can then be entered, and the data for that record is
36692 displayed.
36693
36694 If &"d"& is typed at the next prompt, the entire record is deleted. For all
36695 except the &'retry'& database, that is the only operation that can be carried
36696 out. For the &'retry'& database, each field is output preceded by a number, and
36697 data for individual fields can be changed by typing the field number followed
36698 by new data, for example:
36699 .code
36700 > 4 951102:1000
36701 .endd
36702 resets the time of the next delivery attempt. Time values are given as a
36703 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
36704 used as optional separators.
36705
36706
36707
36708
36709 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
36710 .cindex "mailbox" "maintenance"
36711 .cindex "&'exim_lock'&"
36712 .cindex "locking mailboxes"
36713 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
36714 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
36715 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
36716 a user agent while investigating a problem. The utility requires the name of
36717 the file as its first argument. If the locking is successful, the second
36718 argument is run as a command (using C's &[system()]& function); if there is no
36719 second argument, the value of the SHELL environment variable is used; if this
36720 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
36721 is unlocked and the utility ends. The following options are available:
36722
36723 .vlist
36724 .vitem &%-fcntl%&
36725 Use &[fcntl()]& locking on the open mailbox.
36726
36727 .vitem &%-flock%&
36728 Use &[flock()]& locking on the open mailbox, provided the operating system
36729 supports it.
36730
36731 .vitem &%-interval%&
36732 This must be followed by a number, which is a number of seconds; it sets the
36733 interval to sleep between retries (default 3).
36734
36735 .vitem &%-lockfile%&
36736 Create a lock file before opening the mailbox.
36737
36738 .vitem &%-mbx%&
36739 Lock the mailbox using MBX rules.
36740
36741 .vitem &%-q%&
36742 Suppress verification output.
36743
36744 .vitem &%-retries%&
36745 This must be followed by a number; it sets the number of times to try to get
36746 the lock (default 10).
36747
36748 .vitem &%-restore_time%&
36749 This option causes &%exim_lock%& to restore the modified and read times to the
36750 locked file before exiting. This allows you to access a locked mailbox (for
36751 example, to take a backup copy) without disturbing the times that the user
36752 subsequently sees.
36753
36754 .vitem &%-timeout%&
36755 This must be followed by a number, which is a number of seconds; it sets a
36756 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
36757 default), a non-blocking call is used.
36758
36759 .vitem &%-v%&
36760 Generate verbose output.
36761 .endlist
36762
36763 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
36764 default is to create a lock file and also to use &[fcntl()]& locking on the
36765 mailbox, which is the same as Exim's default. The use of &%-flock%& or
36766 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
36767 requires that the directory containing the file be writeable. Locking by lock
36768 file does not last for ever; Exim assumes that a lock file is expired if it is
36769 more than 30 minutes old.
36770
36771 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
36772 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
36773 to be taken out on the open mailbox, and an exclusive lock on the file
36774 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
36775 number of the mailbox file. When the locking is released, if an exclusive lock
36776 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
36777
36778 The default output contains verification of the locking that takes place. The
36779 &%-v%& option causes some additional information to be given. The &%-q%& option
36780 suppresses all output except error messages.
36781
36782 A command such as
36783 .code
36784 exim_lock /var/spool/mail/spqr
36785 .endd
36786 runs an interactive shell while the file is locked, whereas
36787 .display
36788 &`exim_lock -q /var/spool/mail/spqr <<End`&
36789 <&'some commands'&>
36790 &`End`&
36791 .endd
36792 runs a specific non-interactive sequence of commands while the file is locked,
36793 suppressing all verification output. A single command can be run by a command
36794 such as
36795 .code
36796 exim_lock -q /var/spool/mail/spqr \
36797   "cp /var/spool/mail/spqr /some/where"
36798 .endd
36799 Note that if a command is supplied, it must be entirely contained within the
36800 second argument &-- hence the quotes.
36801 .ecindex IIDutils
36802
36803
36804 . ////////////////////////////////////////////////////////////////////////////
36805 . ////////////////////////////////////////////////////////////////////////////
36806
36807 .chapter "The Exim monitor" "CHAPeximon"
36808 .scindex IIDeximon "Exim monitor" "description"
36809 .cindex "X-windows"
36810 .cindex "&'eximon'&"
36811 .cindex "Local/eximon.conf"
36812 .cindex "&_exim_monitor/EDITME_&"
36813 The Exim monitor is an application which displays in an X window information
36814 about the state of Exim's queue and what Exim is doing. An admin user can
36815 perform certain operations on messages from this GUI interface; however all
36816 such facilities are also available from the command line, and indeed, the
36817 monitor itself makes use of the command line to perform any actions requested.
36818
36819
36820
36821 .section "Running the monitor" "SECID264"
36822 The monitor is started by running the script called &'eximon'&. This is a shell
36823 script that sets up a number of environment variables, and then runs the
36824 binary called &_eximon.bin_&. The default appearance of the monitor window can
36825 be changed by editing the &_Local/eximon.conf_& file created by editing
36826 &_exim_monitor/EDITME_&. Comments in that file describe what the various
36827 parameters are for.
36828
36829 The parameters that get built into the &'eximon'& script can be overridden for
36830 a particular invocation by setting up environment variables of the same names,
36831 preceded by &`EXIMON_`&. For example, a shell command such as
36832 .code
36833 EXIMON_LOG_DEPTH=400 eximon
36834 .endd
36835 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
36836 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
36837 overrides the Exim log file configuration. This makes it possible to have
36838 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
36839 syslog messages are routed to a file on the local host.
36840
36841 X resources can be used to change the appearance of the window in the normal
36842 way. For example, a resource setting of the form
36843 .code
36844 Eximon*background: gray94
36845 .endd
36846 changes the colour of the background to light grey rather than white. The
36847 stripcharts are drawn with both the data lines and the reference lines in
36848 black. This means that the reference lines are not visible when on top of the
36849 data. However, their colour can be changed by setting a resource called
36850 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
36851 For example, if your X server is running Unix, you could set up lighter
36852 reference lines in the stripcharts by obeying
36853 .code
36854 xrdb -merge <<End
36855 Eximon*highlight: gray
36856 End
36857 .endd
36858 .cindex "admin user"
36859 In order to see the contents of messages on the queue, and to operate on them,
36860 &'eximon'& must either be run as root or by an admin user.
36861
36862 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
36863 contain X11 resource parameters interpreted by the X11 library.  In addition,
36864 if the first parameter starts with the string "gdb" then it is removed and the
36865 binary is invoked under gdb (the parameter is used as the gdb command-name, so
36866 versioned variants of gdb can be invoked).
36867
36868 The monitor's window is divided into three parts. The first contains one or
36869 more stripcharts and two action buttons, the second contains a &"tail"& of the
36870 main log file, and the third is a display of the queue of messages awaiting
36871 delivery, with two more action buttons. The following sections describe these
36872 different parts of the display.
36873
36874
36875
36876
36877 .section "The stripcharts" "SECID265"
36878 .cindex "stripchart"
36879 The first stripchart is always a count of messages on the queue. Its name can
36880 be configured by setting QUEUE_STRIPCHART_NAME in the
36881 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
36882 configuration script by regular expression matches on log file entries, making
36883 it possible to display, for example, counts of messages delivered to certain
36884 hosts or using certain transports. The supplied defaults display counts of
36885 received and delivered messages, and of local and SMTP deliveries. The default
36886 period between stripchart updates is one minute; this can be adjusted by a
36887 parameter in the &_Local/eximon.conf_& file.
36888
36889 The stripchart displays rescale themselves automatically as the value they are
36890 displaying changes. There are always 10 horizontal lines in each chart; the
36891 title string indicates the value of each division when it is greater than one.
36892 For example, &"x2"& means that each division represents a value of 2.
36893
36894 It is also possible to have a stripchart which shows the percentage fullness of
36895 a particular disk partition, which is useful when local deliveries are confined
36896 to a single partition.
36897
36898 .cindex "&%statvfs%& function"
36899 This relies on the availability of the &[statvfs()]& function or equivalent in
36900 the operating system. Most, but not all versions of Unix that support Exim have
36901 this. For this particular stripchart, the top of the chart always represents
36902 100%, and the scale is given as &"x10%"&. This chart is configured by setting
36903 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
36904 &_Local/eximon.conf_& file.
36905
36906
36907
36908
36909 .section "Main action buttons" "SECID266"
36910 .cindex "size" "of monitor window"
36911 .cindex "Exim monitor" "window size"
36912 .cindex "window size"
36913 Below the stripcharts there is an action button for quitting the monitor. Next
36914 to this is another button marked &"Size"&. They are placed here so that
36915 shrinking the window to its default minimum size leaves just the queue count
36916 stripchart and these two buttons visible. Pressing the &"Size"& button causes
36917 the window to expand to its maximum size, unless it is already at the maximum,
36918 in which case it is reduced to its minimum.
36919
36920 When expanding to the maximum, if the window cannot be fully seen where it
36921 currently is, it is moved back to where it was the last time it was at full
36922 size. When it is expanding from its minimum size, the old position is
36923 remembered, and next time it is reduced to the minimum it is moved back there.
36924
36925 The idea is that you can keep a reduced window just showing one or two
36926 stripcharts at a convenient place on your screen, easily expand it to show
36927 the full window when required, and just as easily put it back to what it was.
36928 The idea is copied from what the &'twm'& window manager does for its
36929 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
36930 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
36931
36932 Normally, the monitor starts up with the window at its full size, but it can be
36933 built so that it starts up with the window at its smallest size, by setting
36934 START_SMALL=yes in &_Local/eximon.conf_&.
36935
36936
36937
36938 .section "The log display" "SECID267"
36939 .cindex "log" "tail of; in monitor"
36940 The second section of the window is an area in which a display of the tail of
36941 the main log is maintained.
36942 To save space on the screen, the timestamp on each log line is shortened by
36943 removing the date and, if &%log_timezone%& is set, the timezone.
36944 The log tail is not available when the only destination for logging data is
36945 syslog, unless the syslog lines are routed to a local file whose name is passed
36946 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
36947
36948 The log sub-window has a scroll bar at its lefthand side which can be used to
36949 move back to look at earlier text, and the up and down arrow keys also have a
36950 scrolling effect. The amount of log that is kept depends on the setting of
36951 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
36952 to use. When this is full, the earlier 50% of data is discarded &-- this is
36953 much more efficient than throwing it away line by line. The sub-window also has
36954 a horizontal scroll bar for accessing the ends of long log lines. This is the
36955 only means of horizontal scrolling; the right and left arrow keys are not
36956 available. Text can be cut from this part of the window using the mouse in the
36957 normal way. The size of this subwindow is controlled by parameters in the
36958 configuration file &_Local/eximon.conf_&.
36959
36960 Searches of the text in the log window can be carried out by means of the ^R
36961 and ^S keystrokes, which default to a reverse and a forward search,
36962 respectively. The search covers only the text that is displayed in the window.
36963 It cannot go further back up the log.
36964
36965 The point from which the search starts is indicated by a caret marker. This is
36966 normally at the end of the text in the window, but can be positioned explicitly
36967 by pointing and clicking with the left mouse button, and is moved automatically
36968 by a successful search. If new text arrives in the window when it is scrolled
36969 back, the caret remains where it is, but if the window is not scrolled back,
36970 the caret is moved to the end of the new text.
36971
36972 Pressing ^R or ^S pops up a window into which the search text can be typed.
36973 There are buttons for selecting forward or reverse searching, for carrying out
36974 the search, and for cancelling. If the &"Search"& button is pressed, the search
36975 happens and the window remains so that further searches can be done. If the
36976 &"Return"& key is pressed, a single search is done and the window is closed. If
36977 ^C is typed the search is cancelled.
36978
36979 The searching facility is implemented using the facilities of the Athena text
36980 widget. By default this pops up a window containing both &"search"& and
36981 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
36982 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
36983 However, the linkers in BSDI and HP-UX seem unable to handle an externally
36984 provided version of &%TextPop%& when the remaining parts of the text widget
36985 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
36986 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
36987 on these systems, at the expense of having unwanted items in the search popup
36988 window.
36989
36990
36991
36992 .section "The queue display" "SECID268"
36993 .cindex "queue" "display in monitor"
36994 The bottom section of the monitor window contains a list of all messages that
36995 are on the queue, which includes those currently being received or delivered,
36996 as well as those awaiting delivery. The size of this subwindow is controlled by
36997 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
36998 at which it is updated is controlled by another parameter in the same file &--
36999 the default is 5 minutes, since queue scans can be quite expensive. However,
37000 there is an &"Update"& action button just above the display which can be used
37001 to force an update of the queue display at any time.
37002
37003 When a host is down for some time, a lot of pending mail can build up for it,
37004 and this can make it hard to deal with other messages on the queue. To help
37005 with this situation there is a button next to &"Update"& called &"Hide"&. If
37006 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
37007 type anything in here and press &"Return"&, the text is added to a chain of
37008 such texts, and if every undelivered address in a message matches at least one
37009 of the texts, the message is not displayed.
37010
37011 If there is an address that does not match any of the texts, all the addresses
37012 are displayed as normal. The matching happens on the ends of addresses so, for
37013 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
37014 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
37015 has been set up, a button called &"Unhide"& is displayed. If pressed, it
37016 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
37017 a hide request is automatically cancelled after one hour.
37018
37019 While the dialogue box is displayed, you can't press any buttons or do anything
37020 else to the monitor window. For this reason, if you want to cut text from the
37021 queue display to use in the dialogue box, you have to do the cutting before
37022 pressing the &"Hide"& button.
37023
37024 The queue display contains, for each unhidden queued message, the length of
37025 time it has been on the queue, the size of the message, the message id, the
37026 message sender, and the first undelivered recipient, all on one line. If it is
37027 a bounce message, the sender is shown as &"<>"&. If there is more than one
37028 recipient to which the message has not yet been delivered, subsequent ones are
37029 listed on additional lines, up to a maximum configured number, following which
37030 an ellipsis is displayed. Recipients that have already received the message are
37031 not shown.
37032
37033 .cindex "frozen messages" "display"
37034 If a message is frozen, an asterisk is displayed at the left-hand side.
37035
37036 The queue display has a vertical scroll bar, and can also be scrolled by means
37037 of the arrow keys. Text can be cut from it using the mouse in the normal way.
37038 The text searching facilities, as described above for the log window, are also
37039 available, but the caret is always moved to the end of the text when the queue
37040 display is updated.
37041
37042
37043
37044 .section "The queue menu" "SECID269"
37045 .cindex "queue" "menu in monitor"
37046 If the &%shift%& key is held down and the left button is clicked when the mouse
37047 pointer is over the text for any message, an action menu pops up, and the first
37048 line of the queue display for the message is highlighted. This does not affect
37049 any selected text.
37050
37051 If you want to use some other event for popping up the menu, you can set the
37052 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
37053 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
37054 value set in this parameter is a standard X event description. For example, to
37055 run eximon using &%ctrl%& rather than &%shift%& you could use
37056 .code
37057 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
37058 .endd
37059 The title of the menu is the message id, and it contains entries which act as
37060 follows:
37061
37062 .ilist
37063 &'message log'&: The contents of the message log for the message are displayed
37064 in a new text window.
37065 .next
37066 &'headers'&: Information from the spool file that contains the envelope
37067 information and headers is displayed in a new text window. See chapter
37068 &<<CHAPspool>>& for a description of the format of spool files.
37069 .next
37070 &'body'&: The contents of the spool file containing the body of the message are
37071 displayed in a new text window. There is a default limit of 20,000 bytes to the
37072 amount of data displayed. This can be changed by setting the BODY_MAX
37073 option at compile time, or the EXIMON_BODY_MAX option at run time.
37074 .next
37075 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
37076 delivery of the message. This causes an automatic thaw if the message is
37077 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
37078 a new text window. The delivery is run in a separate process, to avoid holding
37079 up the monitor while the delivery proceeds.
37080 .next
37081 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
37082 that the message be frozen.
37083 .next
37084 .cindex "thawing messages"
37085 .cindex "unfreezing messages"
37086 .cindex "frozen messages" "thawing"
37087 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
37088 that the message be thawed.
37089 .next
37090 .cindex "delivery" "forcing failure"
37091 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
37092 that Exim gives up trying to deliver the message. A bounce message is generated
37093 for any remaining undelivered addresses.
37094 .next
37095 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
37096 that the message be deleted from the system without generating a bounce
37097 message.
37098 .next
37099 &'add recipient'&: A dialog box is displayed into which a recipient address can
37100 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
37101 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
37102 Otherwise it must be entered as a fully qualified address. Pressing RETURN
37103 causes a call to Exim to be made using the &%-Mar%& option to request that an
37104 additional recipient be added to the message, unless the entry box is empty, in
37105 which case no action is taken.
37106 .next
37107 &'mark delivered'&: A dialog box is displayed into which a recipient address
37108 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
37109 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
37110 Otherwise it must be entered as a fully qualified address. Pressing RETURN
37111 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
37112 recipient address as already delivered, unless the entry box is empty, in which
37113 case no action is taken.
37114 .next
37115 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
37116 mark all recipient addresses as already delivered.
37117 .next
37118 &'edit sender'&: A dialog box is displayed initialized with the current
37119 sender's address. Pressing RETURN causes a call to Exim to be made using the
37120 &%-Mes%& option to replace the sender address, unless the entry box is empty,
37121 in which case no action is taken. If you want to set an empty sender (as in
37122 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
37123 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
37124 the address is qualified with that domain.
37125 .endlist
37126
37127 When a delivery is forced, a window showing the &%-v%& output is displayed. In
37128 other cases when a call to Exim is made, if there is any output from Exim (in
37129 particular, if the command fails) a window containing the command and the
37130 output is displayed. Otherwise, the results of the action are normally apparent
37131 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
37132 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
37133 if no output is generated.
37134
37135 The queue display is automatically updated for actions such as freezing and
37136 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
37137 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
37138 force an update of the display after one of these actions.
37139
37140 In any text window that is displayed as result of a menu action, the normal
37141 cut-and-paste facility is available, and searching can be carried out using ^R
37142 and ^S, as described above for the log tail window.
37143 .ecindex IIDeximon
37144
37145
37146
37147
37148
37149 . ////////////////////////////////////////////////////////////////////////////
37150 . ////////////////////////////////////////////////////////////////////////////
37151
37152 .chapter "Security considerations" "CHAPsecurity"
37153 .scindex IIDsecurcon "security" "discussion of"
37154 This chapter discusses a number of issues concerned with security, some of
37155 which are also covered in other parts of this manual.
37156
37157 For reasons that this author does not understand, some people have promoted
37158 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
37159 existence of this chapter in the documentation. However, the intent of the
37160 chapter is simply to describe the way Exim works in relation to certain
37161 security concerns, not to make any specific claims about the effectiveness of
37162 its security as compared with other MTAs.
37163
37164 What follows is a description of the way Exim is supposed to be. Best efforts
37165 have been made to try to ensure that the code agrees with the theory, but an
37166 absence of bugs can never be guaranteed. Any that are reported will get fixed
37167 as soon as possible.
37168
37169
37170 .section "Building a more &""hardened""& Exim" "SECID286"
37171 .cindex "security" "build-time features"
37172 There are a number of build-time options that can be set in &_Local/Makefile_&
37173 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
37174 Exim administrator who does not have the root password, or by someone who has
37175 penetrated the Exim (but not the root) account. These options are as follows:
37176
37177 .ilist
37178 ALT_CONFIG_PREFIX can be set to a string that is required to match the
37179 start of any file names used with the &%-C%& option. When it is set, these file
37180 names are also not allowed to contain the sequence &"/../"&. (However, if the
37181 value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
37182 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
37183 default setting for &%ALT_CONFIG_PREFIX%&.
37184
37185 If the permitted configuration files are confined to a directory to
37186 which only root has access, this guards against someone who has broken
37187 into the Exim account from running a privileged Exim with an arbitrary
37188 configuration file, and using it to break into other accounts.
37189 .next
37190
37191 If a non-trusted configuration file (i.e. not the default configuration file
37192 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
37193 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
37194 the next item), then root privilege is retained only if the caller of Exim is
37195 root. This locks out the possibility of testing a configuration using &%-C%&
37196 right through message reception and delivery, even if the caller is root. The
37197 reception works, but by that time, Exim is running as the Exim user, so when
37198 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
37199 privilege to be lost. However, root can test reception and delivery using two
37200 separate commands.
37201
37202 .next
37203 The WHITELIST_D_MACROS build option declares some macros to be safe to override
37204 with &%-D%& if the real uid is one of root, the Exim run-time user or the
37205 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
37206 requiring the run-time value supplied to &%-D%& to match a regex that errs on
37207 the restrictive side.  Requiring build-time selection of safe macros is onerous
37208 but this option is intended solely as a transition mechanism to permit
37209 previously-working configurations to continue to work after release 4.73.
37210 .next
37211 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
37212 is disabled.
37213 .next
37214 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
37215 never to be used for any deliveries. This is like the &%never_users%& runtime
37216 option, but it cannot be overridden; the runtime option adds additional users
37217 to the list. The default setting is &"root"&; this prevents a non-root user who
37218 is permitted to modify the runtime file from using Exim as a way to get root.
37219 .endlist
37220
37221
37222
37223 .section "Root privilege" "SECID270"
37224 .cindex "setuid"
37225 .cindex "root privilege"
37226 The Exim binary is normally setuid to root, which means that it gains root
37227 privilege (runs as root) when it starts execution. In some special cases (for
37228 example, when the daemon is not in use and there are no local deliveries), it
37229 may be possible to run Exim setuid to some user other than root. This is
37230 discussed in the next section. However, in most installations, root privilege
37231 is required for two things:
37232
37233 .ilist
37234 To set up a socket connected to the standard SMTP port (25) when initialising
37235 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
37236 not required.
37237 .next
37238 To be able to change uid and gid in order to read users' &_.forward_& files and
37239 perform local deliveries as the receiving user or as specified in the
37240 configuration.
37241 .endlist
37242
37243 It is not necessary to be root to do any of the other things Exim does, such as
37244 receiving messages and delivering them externally over SMTP, and it is
37245 obviously more secure if Exim does not run as root except when necessary.
37246 For this reason, a user and group for Exim to use must be defined in
37247 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
37248 group"&. Their values can be changed by the run time configuration, though this
37249 is not recommended. Often a user called &'exim'& is used, but some sites use
37250 &'mail'& or another user name altogether.
37251
37252 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
37253 abdication; the process cannot regain root afterwards. Prior to release 4.00,
37254 &[seteuid()]& was used in some circumstances, but this is no longer the case.
37255
37256 After a new Exim process has interpreted its command line options, it changes
37257 uid and gid in the following cases:
37258
37259 .ilist
37260 .oindex "&%-C%&"
37261 .oindex "&%-D%&"
37262 If the &%-C%& option is used to specify an alternate configuration file, or if
37263 the &%-D%& option is used to define macro values for the configuration, and the
37264 calling process is not running as root, the uid and gid are changed to those of
37265 the calling process.
37266 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
37267 option may not be used at all.
37268 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
37269 can be supplied if the calling process is running as root, the Exim run-time
37270 user or CONFIGURE_OWNER, if defined.
37271 .next
37272 .oindex "&%-be%&"
37273 .oindex "&%-bf%&"
37274 .oindex "&%-bF%&"
37275 If the expansion test option (&%-be%&) or one of the filter testing options
37276 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
37277 calling process.
37278 .next
37279 If the process is not a daemon process or a queue runner process or a delivery
37280 process or a process for testing address routing (started with &%-bt%&), the
37281 uid and gid are changed to the Exim user and group. This means that Exim always
37282 runs under its own uid and gid when receiving messages. This also applies when
37283 testing address verification
37284 .oindex "&%-bv%&"
37285 .oindex "&%-bh%&"
37286 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
37287 option).
37288 .next
37289 For a daemon, queue runner, delivery, or address testing process, the uid
37290 remains as root at this stage, but the gid is changed to the Exim group.
37291 .endlist
37292
37293 The processes that initially retain root privilege behave as follows:
37294
37295 .ilist
37296 A daemon process changes the gid to the Exim group and the uid to the Exim
37297 user after setting up one or more listening sockets. The &[initgroups()]&
37298 function is called, so that if the Exim user is in any additional groups, they
37299 will be used during message reception.
37300 .next
37301 A queue runner process retains root privilege throughout its execution. Its
37302 job is to fork a controlled sequence of delivery processes.
37303 .next
37304 A delivery process retains root privilege throughout most of its execution,
37305 but any actual deliveries (that is, the transports themselves) are run in
37306 subprocesses which always change to a non-root uid and gid. For local
37307 deliveries this is typically the uid and gid of the owner of the mailbox; for
37308 remote deliveries, the Exim uid and gid are used. Once all the delivery
37309 subprocesses have been run, a delivery process changes to the Exim uid and gid
37310 while doing post-delivery tidying up such as updating the retry database and
37311 generating bounce and warning messages.
37312
37313 While the recipient addresses in a message are being routed, the delivery
37314 process runs as root. However, if a user's filter file has to be processed,
37315 this is done in a subprocess that runs under the individual user's uid and
37316 gid. A system filter is run as root unless &%system_filter_user%& is set.
37317 .next
37318 A process that is testing addresses (the &%-bt%& option) runs as root so that
37319 the routing is done in the same environment as a message delivery.
37320 .endlist
37321
37322
37323
37324
37325 .section "Running Exim without privilege" "SECTrunexiwitpri"
37326 .cindex "privilege, running without"
37327 .cindex "unprivileged running"
37328 .cindex "root privilege" "running without"
37329 Some installations like to run Exim in an unprivileged state for more of its
37330 operation, for added security. Support for this mode of operation is provided
37331 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
37332 gid are changed to the Exim user and group at the start of a delivery process
37333 (and also queue runner and address testing processes). This means that address
37334 routing is no longer run as root, and the deliveries themselves cannot change
37335 to any other uid.
37336
37337 .cindex SIGHUP
37338 .cindex "daemon" "restarting"
37339 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
37340 that the daemon can still be started in the usual way, and it can respond
37341 correctly to SIGHUP because the re-invocation regains root privilege.
37342
37343 An alternative approach is to make Exim setuid to the Exim user and also setgid
37344 to the Exim group. If you do this, the daemon must be started from a root
37345 process. (Calling Exim from a root process makes it behave in the way it does
37346 when it is setuid root.) However, the daemon cannot restart itself after a
37347 SIGHUP signal because it cannot regain privilege.
37348
37349 It is still useful to set &%deliver_drop_privilege%& in this case, because it
37350 stops Exim from trying to re-invoke itself to do a delivery after a message has
37351 been received. Such a re-invocation is a waste of resources because it has no
37352 effect.
37353
37354 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
37355 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
37356 to the Exim user seems a clean approach, but there is one complication:
37357
37358 In this style of operation, Exim is running with the real uid and gid set to
37359 those of the calling process, and the effective uid/gid set to Exim's values.
37360 Ideally, any association with the calling process' uid/gid should be dropped,
37361 that is, the real uid/gid should be reset to the effective values so as to
37362 discard any privileges that the caller may have. While some operating systems
37363 have a function that permits this action for a non-root effective uid, quite a
37364 number of them do not. Because of this lack of standardization, Exim does not
37365 address this problem at this time.
37366
37367 For this reason, the recommended approach for &"mostly unprivileged"& running
37368 is to keep the Exim binary setuid to root, and to set
37369 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
37370 be used in the most straightforward way.
37371
37372 If you configure Exim not to run delivery processes as root, there are a
37373 number of restrictions on what you can do:
37374
37375 .ilist
37376 You can deliver only as the Exim user/group. You should  explicitly use the
37377 &%user%& and &%group%& options to override routers or local transports that
37378 normally deliver as the recipient. This makes sure that configurations that
37379 work in this mode function the same way in normal mode. Any implicit or
37380 explicit specification of another user causes an error.
37381 .next
37382 Use of &_.forward_& files is severely restricted, such that it is usually
37383 not worthwhile to include them in the configuration.
37384 .next
37385 Users who wish to use &_.forward_& would have to make their home directory and
37386 the file itself accessible to the Exim user. Pipe and append-to-file entries,
37387 and their equivalents in Exim filters, cannot be used. While they could be
37388 enabled in the Exim user's name, that would be insecure and not very useful.
37389 .next
37390 Unless the local user mailboxes are all owned by the Exim user (possible in
37391 some POP3 or IMAP-only environments):
37392
37393 .olist
37394 They must be owned by the Exim group and be writeable by that group. This
37395 implies you must set &%mode%& in the appendfile configuration, as well as the
37396 mode of the mailbox files themselves.
37397 .next
37398 You must set &%no_check_owner%&, since most or all of the files will not be
37399 owned by the Exim user.
37400 .next
37401 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
37402 on a newly created mailbox when unprivileged. This also implies that new
37403 mailboxes need to be created manually.
37404 .endlist olist
37405 .endlist ilist
37406
37407
37408 These restrictions severely restrict what can be done in local deliveries.
37409 However, there are no restrictions on remote deliveries. If you are running a
37410 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
37411 gives more security at essentially no cost.
37412
37413 If you are using the &%mua_wrapper%& facility (see chapter
37414 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
37415
37416
37417
37418
37419 .section "Delivering to local files" "SECID271"
37420 Full details of the checks applied by &(appendfile)& before it writes to a file
37421 are given in chapter &<<CHAPappendfile>>&.
37422
37423
37424
37425 .section "Running local commands" "SECTsecconslocalcmds"
37426 .cindex "security" "local commands"
37427 .cindex "security" "command injection attacks"
37428 There are a number of ways in which an administrator can configure Exim to run
37429 commands based upon received, untrustworthy, data. Further, in some
37430 configurations a user who can control a &_.forward_& file can also arrange to
37431 run commands. Configuration to check includes, but is not limited to:
37432
37433 .ilist
37434 Use of &%use_shell%& in the pipe transport: various forms of shell command
37435 injection may be possible with this option present. It is dangerous and should
37436 be used only with considerable caution. Consider constraints which whitelist
37437 allowed characters in a variable which is to be used in a pipe transport that
37438 has &%use_shell%& enabled.
37439 .next
37440 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
37441 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
37442 &_.forward_& files in a redirect router. If Exim is running on a central mail
37443 hub to which ordinary users do not have shell access, but home directories are
37444 NFS mounted (for instance) then administrators should review the list of these
37445 forbid options available, and should bear in mind that the options that may
37446 need forbidding can change as new features are added between releases.
37447 .next
37448 The &%${run...}%& expansion item does not use a shell by default, but
37449 administrators can configure use of &_/bin/sh_& as part of the command.
37450 Such invocations should be viewed with prejudicial suspicion.
37451 .next
37452 Administrators who use embedded Perl are advised to explore how Perl's
37453 taint checking might apply to their usage.
37454 .next
37455 Use of &%${expand...}%& is somewhat analogous to shell's eval builtin and
37456 administrators are well advised to view its use with suspicion, in case (for
37457 instance) it allows a local-part to contain embedded Exim directives.
37458 .next
37459 Use of &%${match_local_part...}%& and friends becomes more dangerous if
37460 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
37461 each can reference arbitrary lists and files, rather than just being a list
37462 of opaque strings.
37463 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
37464 real-world security vulnerabilities caused by its use with untrustworthy data
37465 injected in, for SQL injection attacks.
37466 Consider the use of the &%inlisti%& expansion condition instead.
37467 .endlist
37468
37469
37470
37471
37472 .section "Trust in configuration data" "SECTsecconfdata"
37473 .cindex "security" "data sources"
37474 .cindex "security" "regular expressions"
37475 .cindex "regular expressions" "security"
37476 .cindex "PCRE" "security"
37477 If configuration data for Exim can come from untrustworthy sources, there
37478 are some issues to be aware of:
37479
37480 .ilist
37481 Use of &%${expand...}%& may provide a path for shell injection attacks.
37482 .next
37483 Letting untrusted data provide a regular expression is unwise.
37484 .next
37485 Using &%${match...}%& to apply a fixed regular expression against untrusted
37486 data may result in pathological behaviour within PCRE.  Be aware of what
37487 "backtracking" means and consider options for being more strict with a regular
37488 expression. Avenues to explore include limiting what can match (avoiding &`.`&
37489 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
37490 possessive quantifiers or just not using regular expressions against untrusted
37491 data.
37492 .next
37493 It can be important to correctly use &%${quote:...}%&,
37494 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
37495 items to ensure that data is correctly constructed.
37496 .next
37497 Some lookups might return multiple results, even though normal usage is only
37498 expected to yield one result.
37499 .endlist
37500
37501
37502
37503
37504 .section "IPv4 source routing" "SECID272"
37505 .cindex "source routing" "in IP packets"
37506 .cindex "IP source routing"
37507 Many operating systems suppress IP source-routed packets in the kernel, but
37508 some cannot be made to do this, so Exim does its own check. It logs incoming
37509 IPv4 source-routed TCP calls, and then drops them. Things are all different in
37510 IPv6. No special checking is currently done.
37511
37512
37513
37514 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
37515 Support for these SMTP commands is disabled by default. If required, they can
37516 be enabled by defining suitable ACLs.
37517
37518
37519
37520
37521 .section "Privileged users" "SECID274"
37522 .cindex "trusted users"
37523 .cindex "admin user"
37524 .cindex "privileged user"
37525 .cindex "user" "trusted"
37526 .cindex "user" "admin"
37527 Exim recognizes two sets of users with special privileges. Trusted users are
37528 able to submit new messages to Exim locally, but supply their own sender
37529 addresses and information about a sending host. For other users submitting
37530 local messages, Exim sets up the sender address from the uid, and doesn't
37531 permit a remote host to be specified.
37532
37533 .oindex "&%-f%&"
37534 However, an untrusted user is permitted to use the &%-f%& command line option
37535 in the special form &%-f <>%& to indicate that a delivery failure for the
37536 message should not cause an error report. This affects the message's envelope,
37537 but it does not affect the &'Sender:'& header. Untrusted users may also be
37538 permitted to use specific forms of address with the &%-f%& option by setting
37539 the &%untrusted_set_sender%& option.
37540
37541 Trusted users are used to run processes that receive mail messages from some
37542 other mail domain and pass them on to Exim for delivery either locally, or over
37543 the Internet. Exim trusts a caller that is running as root, as the Exim user,
37544 as any user listed in the &%trusted_users%& configuration option, or under any
37545 group listed in the &%trusted_groups%& option.
37546
37547 Admin users are permitted to do things to the messages on Exim's queue. They
37548 can freeze or thaw messages, cause them to be returned to their senders, remove
37549 them entirely, or modify them in various ways. In addition, admin users can run
37550 the Exim monitor and see all the information it is capable of providing, which
37551 includes the contents of files on the spool.
37552
37553 .oindex "&%-M%&"
37554 .oindex "&%-q%&"
37555 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
37556 delivery of messages on its queue is restricted to admin users. This
37557 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
37558 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
37559 queue is also restricted to admin users. This restriction can be relaxed by
37560 setting &%no_queue_list_requires_admin%&.
37561
37562 Exim recognizes an admin user if the calling process is running as root or as
37563 the Exim user or if any of the groups associated with the calling process is
37564 the Exim group. It is not necessary actually to be running under the Exim
37565 group. However, if admin users who are not root or the Exim user are to access
37566 the contents of files on the spool via the Exim monitor (which runs
37567 unprivileged), Exim must be built to allow group read access to its spool
37568 files.
37569
37570
37571
37572 .section "Spool files" "SECID275"
37573 .cindex "spool directory" "files"
37574 Exim's spool directory and everything it contains is owned by the Exim user and
37575 set to the Exim group. The mode for spool files is defined in the
37576 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
37577 any user who is a member of the Exim group can access these files.
37578
37579
37580
37581 .section "Use of argv[0]" "SECID276"
37582 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
37583 of specific strings, Exim assumes certain options. For example, calling Exim
37584 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
37585 to calling it with the option &%-bS%&. There are no security implications in
37586 this.
37587
37588
37589
37590 .section "Use of %f formatting" "SECID277"
37591 The only use made of &"%f"& by Exim is in formatting load average values. These
37592 are actually stored in integer variables as 1000 times the load average.
37593 Consequently, their range is limited and so therefore is the length of the
37594 converted output.
37595
37596
37597
37598 .section "Embedded Exim path" "SECID278"
37599 Exim uses its own path name, which is embedded in the code, only when it needs
37600 to re-exec in order to regain root privilege. Therefore, it is not root when it
37601 does so. If some bug allowed the path to get overwritten, it would lead to an
37602 arbitrary program's being run as exim, not as root.
37603
37604
37605
37606 .section "Dynamic module directory" "SECTdynmoddir"
37607 Any dynamically loadable modules must be installed into the directory
37608 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
37609 loading it.
37610
37611
37612 .section "Use of sprintf()" "SECID279"
37613 .cindex "&[sprintf()]&"
37614 A large number of occurrences of &"sprintf"& in the code are actually calls to
37615 &'string_sprintf()'&, a function that returns the result in malloc'd store.
37616 The intermediate formatting is done into a large fixed buffer by a function
37617 that runs through the format string itself, and checks the length of each
37618 conversion before performing it, thus preventing buffer overruns.
37619
37620 The remaining uses of &[sprintf()]& happen in controlled circumstances where
37621 the output buffer is known to be sufficiently long to contain the converted
37622 string.
37623
37624
37625
37626 .section "Use of debug_printf() and log_write()" "SECID280"
37627 Arbitrary strings are passed to both these functions, but they do their
37628 formatting by calling the function &'string_vformat()'&, which runs through
37629 the format string itself, and checks the length of each conversion.
37630
37631
37632
37633 .section "Use of strcat() and strcpy()" "SECID281"
37634 These are used only in cases where the output buffer is known to be large
37635 enough to hold the result.
37636 .ecindex IIDsecurcon
37637
37638
37639
37640
37641 . ////////////////////////////////////////////////////////////////////////////
37642 . ////////////////////////////////////////////////////////////////////////////
37643
37644 .chapter "Format of spool files" "CHAPspool"
37645 .scindex IIDforspo1 "format" "spool files"
37646 .scindex IIDforspo2 "spool directory" "format of files"
37647 .scindex IIDforspo3 "spool files" "format of"
37648 .cindex "spool files" "editing"
37649 A message on Exim's queue consists of two files, whose names are the message id
37650 followed by -D and -H, respectively. The data portion of the message is kept in
37651 the -D file on its own. The message's envelope, status, and headers are all
37652 kept in the -H file, whose format is described in this chapter. Each of these
37653 two files contains the final component of its own name as its first line. This
37654 is insurance against disk crashes where the directory is lost but the files
37655 themselves are recoverable.
37656
37657 Some people are tempted into editing -D files in order to modify messages. You
37658 need to be extremely careful if you do this; it is not recommended and you are
37659 on your own if you do it. Here are some of the pitfalls:
37660
37661 .ilist
37662 You must ensure that Exim does not try to deliver the message while you are
37663 fiddling with it. The safest way is to take out a write lock on the -D file,
37664 which is what Exim itself does, using &[fcntl()]&. If you update the file in
37665 place, the lock will be retained. If you write a new file and rename it, the
37666 lock will be lost at the instant of rename.
37667 .next
37668 .vindex "&$body_linecount$&"
37669 If you change the number of lines in the file, the value of
37670 &$body_linecount$&, which is stored in the -H file, will be incorrect. At
37671 present, this value is not used by Exim, but there is no guarantee that this
37672 will always be the case.
37673 .next
37674 If the message is in MIME format, you must take care not to break it.
37675 .next
37676 If the message is cryptographically signed, any change will invalidate the
37677 signature.
37678 .endlist
37679 All in all, modifying -D files is fraught with danger.
37680
37681 Files whose names end with -J may also be seen in the &_input_& directory (or
37682 its subdirectories when &%split_spool_directory%& is set). These are journal
37683 files, used to record addresses to which the message has been delivered during
37684 the course of a delivery attempt. If there are still undelivered recipients at
37685 the end, the -H file is updated, and the -J file is deleted. If, however, there
37686 is some kind of crash (for example, a power outage) before this happens, the -J
37687 file remains in existence. When Exim next processes the message, it notices the
37688 -J file and uses it to update the -H file before starting the next delivery
37689 attempt.
37690
37691 .section "Format of the -H file" "SECID282"
37692 .cindex "uid (user id)" "in spool file"
37693 .cindex "gid (group id)" "in spool file"
37694 The second line of the -H file contains the login name for the uid of the
37695 process that called Exim to read the message, followed by the numerical uid and
37696 gid. For a locally generated message, this is normally the user who sent the
37697 message. For a message received over TCP/IP via the daemon, it is
37698 normally the Exim user.
37699
37700 The third line of the file contains the address of the message's sender as
37701 transmitted in the envelope, contained in angle brackets. The sender address is
37702 empty for bounce messages. For incoming SMTP mail, the sender address is given
37703 in the MAIL command. For locally generated mail, the sender address is
37704 created by Exim from the login name of the current user and the configured
37705 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
37706 leading &"From&~"& line if the caller is trusted, or if the supplied address is
37707 &"<>"& or an address that matches &%untrusted_set_senders%&.
37708
37709 The fourth line contains two numbers. The first is the time that the message
37710 was received, in the conventional Unix form &-- the number of seconds since the
37711 start of the epoch. The second number is a count of the number of messages
37712 warning of delayed delivery that have been sent to the sender.
37713
37714 There follow a number of lines starting with a hyphen. These can appear in any
37715 order, and are omitted when not relevant:
37716
37717 .vlist
37718 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
37719 This item is obsolete, and is not generated from Exim release 4.61 onwards;
37720 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
37721 recognized, to provide backward compatibility. In the old format, a line of
37722 this form is present for every ACL variable that is not empty. The number
37723 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
37724 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
37725 the data string for the variable. The string itself starts at the beginning of
37726 the next line, and is followed by a newline character. It may contain internal
37727 newlines.
37728
37729 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
37730 A line of this form is present for every ACL connection variable that is
37731 defined. Note that there is a space between &%-aclc%& and the rest of the name.
37732 The length is the length of the data string for the variable. The string itself
37733 starts at the beginning of the next line, and is followed by a newline
37734 character. It may contain internal newlines.
37735
37736 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
37737 A line of this form is present for every ACL message variable that is defined.
37738 Note that there is a space between &%-aclm%& and the rest of the name. The
37739 length is the length of the data string for the variable. The string itself
37740 starts at the beginning of the next line, and is followed by a newline
37741 character. It may contain internal newlines.
37742
37743 .vitem "&%-active_hostname%&&~<&'hostname'&>"
37744 This is present if, when the message was received over SMTP, the value of
37745 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
37746
37747 .vitem &%-allow_unqualified_recipient%&
37748 This is present if unqualified recipient addresses are permitted in header
37749 lines (to stop such addresses from being qualified if rewriting occurs at
37750 transport time). Local messages that were input using &%-bnq%& and remote
37751 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
37752
37753 .vitem &%-allow_unqualified_sender%&
37754 This is present if unqualified sender addresses are permitted in header lines
37755 (to stop such addresses from being qualified if rewriting occurs at transport
37756 time). Local messages that were input using &%-bnq%& and remote messages from
37757 hosts that match &%sender_unqualified_hosts%& set this flag.
37758
37759 .vitem "&%-auth_id%&&~<&'text'&>"
37760 The id information for a message received on an authenticated SMTP connection
37761 &-- the value of the &$authenticated_id$& variable.
37762
37763 .vitem "&%-auth_sender%&&~<&'address'&>"
37764 The address of an authenticated sender &-- the value of the
37765 &$authenticated_sender$& variable.
37766
37767 .vitem "&%-body_linecount%&&~<&'number'&>"
37768 This records the number of lines in the body of the message, and is always
37769 present.
37770
37771 .vitem "&%-body_zerocount%&&~<&'number'&>"
37772 This records the number of binary zero bytes in the body of the message, and is
37773 present if the number is greater than zero.
37774
37775 .vitem &%-deliver_firsttime%&
37776 This is written when a new message is first added to the spool. When the spool
37777 file is updated after a deferral, it is omitted.
37778
37779 .vitem "&%-frozen%&&~<&'time'&>"
37780 .cindex "frozen messages" "spool data"
37781 The message is frozen, and the freezing happened at <&'time'&>.
37782
37783 .vitem "&%-helo_name%&&~<&'text'&>"
37784 This records the host name as specified by a remote host in a HELO or EHLO
37785 command.
37786
37787 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
37788 This records the IP address of the host from which the message was received and
37789 the remote port number that was used. It is omitted for locally generated
37790 messages.
37791
37792 .vitem "&%-host_auth%&&~<&'text'&>"
37793 If the message was received on an authenticated SMTP connection, this records
37794 the name of the authenticator &-- the value of the
37795 &$sender_host_authenticated$& variable.
37796
37797 .vitem &%-host_lookup_failed%&
37798 This is present if an attempt to look up the sending host's name from its IP
37799 address failed. It corresponds to the &$host_lookup_failed$& variable.
37800
37801 .vitem "&%-host_name%&&~<&'text'&>"
37802 .cindex "reverse DNS lookup"
37803 .cindex "DNS" "reverse lookup"
37804 This records the name of the remote host from which the message was received,
37805 if the host name was looked up from the IP address when the message was being
37806 received. It is not present if no reverse lookup was done.
37807
37808 .vitem "&%-ident%&&~<&'text'&>"
37809 For locally submitted messages, this records the login of the originating user,
37810 unless it was a trusted user and the &%-oMt%& option was used to specify an
37811 ident value. For messages received over TCP/IP, this records the ident string
37812 supplied by the remote host, if any.
37813
37814 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
37815 This records the IP address of the local interface and the port number through
37816 which a message was received from a remote host. It is omitted for locally
37817 generated messages.
37818
37819 .vitem &%-local%&
37820 The message is from a local sender.
37821
37822 .vitem &%-localerror%&
37823 The message is a locally-generated bounce message.
37824
37825 .vitem "&%-local_scan%&&~<&'string'&>"
37826 This records the data string that was returned by the &[local_scan()]& function
37827 when the message was received &-- the value of the &$local_scan_data$&
37828 variable. It is omitted if no data was returned.
37829
37830 .vitem &%-manual_thaw%&
37831 The message was frozen but has been thawed manually, that is, by an explicit
37832 Exim command rather than via the auto-thaw process.
37833
37834 .vitem &%-N%&
37835 A testing delivery process was started using the &%-N%& option to suppress any
37836 actual deliveries, but delivery was deferred. At any further delivery attempts,
37837 &%-N%& is assumed.
37838
37839 .vitem &%-received_protocol%&
37840 This records the value of the &$received_protocol$& variable, which contains
37841 the name of the protocol by which the message was received.
37842
37843 .vitem &%-sender_set_untrusted%&
37844 The envelope sender of this message was set by an untrusted local caller (used
37845 to ensure that the caller is displayed in queue listings).
37846
37847 .vitem "&%-spam_score_int%&&~<&'number'&>"
37848 If a message was scanned by SpamAssassin, this is present. It records the value
37849 of &$spam_score_int$&.
37850
37851 .vitem &%-tls_certificate_verified%&
37852 A TLS certificate was received from the client that sent this message, and the
37853 certificate was verified by the server.
37854
37855 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
37856 When the message was received over an encrypted connection, this records the
37857 name of the cipher suite that was used.
37858
37859 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
37860 When the message was received over an encrypted connection, and a certificate
37861 was received from the client, this records the Distinguished Name from that
37862 certificate.
37863 .endlist
37864
37865 Following the options there is a list of those addresses to which the message
37866 is not to be delivered. This set of addresses is initialized from the command
37867 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
37868 is set; otherwise it starts out empty. Whenever a successful delivery is made,
37869 the address is added to this set. The addresses are kept internally as a
37870 balanced binary tree, and it is a representation of that tree which is written
37871 to the spool file. If an address is expanded via an alias or forward file, the
37872 original address is added to the tree when deliveries to all its child
37873 addresses are complete.
37874
37875 If the tree is empty, there is a single line in the spool file containing just
37876 the text &"XX"&. Otherwise, each line consists of two letters, which are either
37877 Y or N, followed by an address. The address is the value for the node of the
37878 tree, and the letters indicate whether the node has a left branch and/or a
37879 right branch attached to it, respectively. If branches exist, they immediately
37880 follow. Here is an example of a three-node tree:
37881 .code
37882 YY darcy@austen.fict.example
37883 NN alice@wonderland.fict.example
37884 NN editor@thesaurus.ref.example
37885 .endd
37886 After the non-recipients tree, there is a list of the message's recipients.
37887 This is a simple list, preceded by a count. It includes all the original
37888 recipients of the message, including those to whom the message has already been
37889 delivered. In the simplest case, the list contains one address per line. For
37890 example:
37891 .code
37892 4
37893 editor@thesaurus.ref.example
37894 darcy@austen.fict.example
37895 rdo@foundation
37896 alice@wonderland.fict.example
37897 .endd
37898 However, when a child address has been added to the top-level addresses as a
37899 result of the use of the &%one_time%& option on a &(redirect)& router, each
37900 line is of the following form:
37901 .display
37902 <&'top-level address'&> <&'errors_to address'&> &&&
37903   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
37904 .endd
37905 The 01 flag bit indicates the presence of the three other fields that follow
37906 the top-level address. Other bits may be used in future to support additional
37907 fields. The <&'parent number'&> is the offset in the recipients list of the
37908 original parent of the &"one time"& address. The first two fields are the
37909 envelope sender that is associated with this address and its length. If the
37910 length is zero, there is no special envelope sender (there are then two space
37911 characters in the line). A non-empty field can arise from a &(redirect)& router
37912 that has an &%errors_to%& setting.
37913
37914
37915 A blank line separates the envelope and status information from the headers
37916 which follow. A header may occupy several lines of the file, and to save effort
37917 when reading it in, each header is preceded by a number and an identifying
37918 character. The number is the number of characters in the header, including any
37919 embedded newlines and the terminating newline. The character is one of the
37920 following:
37921
37922 .table2 50pt
37923 .row <&'blank'&>         "header in which Exim has no special interest"
37924 .row &`B`&               "&'Bcc:'& header"
37925 .row &`C`&               "&'Cc:'& header"
37926 .row &`F`&               "&'From:'& header"
37927 .row &`I`&               "&'Message-id:'& header"
37928 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
37929 .row &`R`&               "&'Reply-To:'& header"
37930 .row &`S`&               "&'Sender:'& header"
37931 .row &`T`&               "&'To:'& header"
37932 .row &`*`&               "replaced or deleted header"
37933 .endtable
37934
37935 Deleted or replaced (rewritten) headers remain in the spool file for debugging
37936 purposes. They are not transmitted when the message is delivered. Here is a
37937 typical set of headers:
37938 .code
37939 111P Received: by hobbit.fict.example with local (Exim 4.00)
37940 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
37941 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
37942 038* X-rewrote-sender: bb@hobbit.fict.example
37943 042* From: Bilbo Baggins <bb@hobbit.fict.example>
37944 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
37945 099* To: alice@wonderland.fict.example, rdo@foundation,
37946 darcy@austen.fict.example, editor@thesaurus.ref.example
37947 104T To: alice@wonderland.fict.example, rdo@foundation.example,
37948 darcy@austen.fict.example, editor@thesaurus.ref.example
37949 038  Date: Fri, 11 May 2001 10:28:59 +0100
37950 .endd
37951 The asterisked headers indicate that the envelope sender, &'From:'& header, and
37952 &'To:'& header have been rewritten, the last one because routing expanded the
37953 unqualified domain &'foundation'&.
37954 .ecindex IIDforspo1
37955 .ecindex IIDforspo2
37956 .ecindex IIDforspo3
37957
37958 . ////////////////////////////////////////////////////////////////////////////
37959 . ////////////////////////////////////////////////////////////////////////////
37960
37961 .chapter "Support for DKIM (DomainKeys Identified Mail)" "CHAPdkim" &&&
37962          "DKIM Support"
37963 .cindex "DKIM"
37964
37965 DKIM is a mechanism by which messages sent by some entity can be provably
37966 linked to a domain which that entity controls.  It permits reputation to
37967 be tracked on a per-domain basis, rather than merely upon source IP address.
37968 DKIM is documented in RFC 4871.
37969
37970 .new
37971 DKIM support is compiled into Exim by default if TLS support is present.
37972 .wen
37973 It can be disabled by setting DISABLE_DKIM=yes in &_Local/Makefile_&.
37974
37975 Exim's DKIM implementation allows to
37976 .olist
37977 Sign outgoing messages: This function is implemented in the SMTP transport.
37978 It can co-exist with all other Exim features
37979 (including transport filters)
37980 except cutthrough delivery.
37981 .next
37982 Verify signatures in incoming messages: This is implemented by an additional
37983 ACL (acl_smtp_dkim), which can be called several times per message, with
37984 different signature contexts.
37985 .endlist
37986
37987 In typical Exim style, the verification implementation does not include any
37988 default "policy". Instead it enables you to build your own policy using
37989 Exim's standard controls.
37990
37991 Please note that verification of DKIM signatures in incoming mail is turned
37992 on by default for logging purposes. For each signature in incoming email,
37993 exim will log a line displaying the most important signature details, and the
37994 signature status. Here is an example (with line-breaks added for clarity):
37995 .code
37996 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
37997     d=facebookmail.com s=q1-2009b
37998     c=relaxed/relaxed a=rsa-sha1
37999     i=@facebookmail.com t=1252484542 [verification succeeded]
38000 .endd
38001 You might want to turn off DKIM verification processing entirely for internal
38002 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
38003 control modifier. This should typically be done in the RCPT ACL, at points
38004 where you accept mail from relay sources (internal hosts or authenticated
38005 senders).
38006
38007
38008 .section "Signing outgoing messages" "SECID513"
38009 .cindex "DKIM" "signing"
38010
38011 Signing is implemented by setting private options on the SMTP transport.
38012 These options take (expandable) strings as arguments.
38013
38014 .option dkim_domain smtp string&!! unset
38015 MANDATORY:
38016 The domain you want to sign with. The result of this expanded
38017 option is put into the &%$dkim_domain%& expansion variable.
38018
38019 .option dkim_selector smtp string&!! unset
38020 MANDATORY:
38021 This sets the key selector string. You can use the &%$dkim_domain%& expansion
38022 variable to look up a matching selector. The result is put in the expansion
38023 variable &%$dkim_selector%& which should be used in the &%dkim_private_key%&
38024 option along with &%$dkim_domain%&.
38025
38026 .option dkim_private_key smtp string&!! unset
38027 MANDATORY:
38028 This sets the private key to use. You can use the &%$dkim_domain%& and
38029 &%$dkim_selector%& expansion variables to determine the private key to use.
38030 The result can either
38031 .ilist
38032 be a valid RSA private key in ASCII armor, including line breaks.
38033 .next
38034 start with a slash, in which case it is treated as a file that contains
38035 the private key.
38036 .next
38037 be "0", "false" or the empty string, in which case the message will not
38038 be signed. This case will not result in an error, even if &%dkim_strict%&
38039 is set.
38040 .endlist
38041
38042 .option dkim_canon smtp string&!! unset
38043 OPTIONAL:
38044 This option sets the canonicalization method used when signing a message.
38045 The DKIM RFC currently supports two methods: "simple" and "relaxed".
38046 The option defaults to "relaxed" when unset. Note: the current implementation
38047 only supports using the same canonicalization method for both headers and body.
38048
38049 .option dkim_strict smtp string&!! unset
38050 OPTIONAL:
38051 This  option  defines  how  Exim  behaves  when  signing a message that
38052 should be signed fails for some reason.  When the expansion evaluates to
38053 either "1" or "true", Exim will defer. Otherwise Exim will send the message
38054 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
38055 variables here.
38056
38057 .option dkim_sign_headers smtp string&!! unset
38058 OPTIONAL:
38059 When set, this option must expand to (or be specified as) a colon-separated
38060 list of header names. Headers with these names will be included in the message
38061 signature. When unspecified, the header names recommended in RFC4871 will be
38062 used.
38063
38064
38065 .section "Verifying DKIM signatures in incoming mail" "SECID514"
38066 .cindex "DKIM" "verification"
38067
38068 Verification of DKIM signatures in incoming email is implemented via the
38069 &%acl_smtp_dkim%& ACL. By default, this ACL is called once for each
38070 syntactically(!) correct signature in the incoming message.
38071 A missing ACL definition defaults to accept.
38072 If any ACL call does not accept, the message is not accepted.
38073 If a cutthrough delivery was in progress for the message it is
38074 summarily dropped (having wasted the transmission effort).
38075
38076 To evaluate the signature in the ACL a large number of expansion variables
38077 containing the signature status and its details are set up during the
38078 runtime of the ACL.
38079
38080 Calling the ACL only for existing signatures is not sufficient to build
38081 more advanced policies. For that reason, the global option
38082 &%dkim_verify_signers%&, and a global expansion variable
38083 &%$dkim_signers%& exist.
38084
38085 The global option &%dkim_verify_signers%& can be set to a colon-separated
38086 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
38087 called. It is expanded when the message has been received. At this point,
38088 the expansion variable &%$dkim_signers%& already contains a colon-separated
38089 list of signer domains and identities for the message. When
38090 &%dkim_verify_signers%& is not specified in the main configuration,
38091 it defaults as:
38092 .code
38093 dkim_verify_signers = $dkim_signers
38094 .endd
38095 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
38096 DKIM signature in the message. Current DKIM verifiers may want to explicitly
38097 call the ACL for known domains or identities. This would be achieved as follows:
38098 .code
38099 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
38100 .endd
38101 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
38102 and "ebay.com", plus all domains and identities that have signatures in the message.
38103 You can also be more creative in constructing your policy. For example:
38104 .code
38105 dkim_verify_signers = $sender_address_domain:$dkim_signers
38106 .endd
38107
38108 If a domain or identity is listed several times in the (expanded) value of
38109 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
38110
38111
38112 Inside the &%acl_smtp_dkim%&, the following expansion variables are
38113 available (from most to least important):
38114
38115
38116 .vlist
38117 .vitem &%$dkim_cur_signer%&
38118 The signer that is being evaluated in this ACL run. This can be a domain or
38119 an identity. This is one of the list items from the expanded main option
38120 &%dkim_verify_signers%& (see above).
38121 .vitem &%$dkim_verify_status%&
38122 A string describing the general status of the signature. One of
38123 .ilist
38124 &%none%&: There is no signature in the message for the current domain or
38125 identity (as reflected by &%$dkim_cur_signer%&).
38126 .next
38127 &%invalid%&: The signature could not be verified due to a processing error.
38128 More detail is available in &%$dkim_verify_reason%&.
38129 .next
38130 &%fail%&: Verification of the signature failed.  More detail is
38131 available in &%$dkim_verify_reason%&.
38132 .next
38133 &%pass%&: The signature passed verification. It is valid.
38134 .endlist
38135 .vitem &%$dkim_verify_reason%&
38136 A string giving a little bit more detail when &%$dkim_verify_status%& is either
38137 "fail" or "invalid". One of
38138 .ilist
38139 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
38140 key for the domain could not be retrieved. This may be a temporary problem.
38141 .next
38142 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
38143 record for the domain is syntactically invalid.
38144 .next
38145 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
38146 body hash does not match the one specified in the signature header. This
38147 means that the message body was modified in transit.
38148 .next
38149 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
38150 could not be verified. This may mean that headers were modified,
38151 re-written or otherwise changed in a way which is incompatible with
38152 DKIM verification. It may of course also mean that the signature is forged.
38153 .endlist
38154 .vitem &%$dkim_domain%&
38155 The signing domain. IMPORTANT: This variable is only populated if there is
38156 an actual signature in the message for the current domain or identity (as
38157 reflected by &%$dkim_cur_signer%&).
38158 .vitem &%$dkim_identity%&
38159 The signing identity, if present. IMPORTANT: This variable is only populated
38160 if there is an actual signature in the message for the current domain or
38161 identity (as reflected by &%$dkim_cur_signer%&).
38162 .vitem &%$dkim_selector%&
38163 The key record selector string.
38164 .vitem &%$dkim_algo%&
38165 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
38166 .vitem &%$dkim_canon_body%&
38167 The body canonicalization method. One of 'relaxed' or 'simple'.
38168 .vitem &%dkim_canon_headers%&
38169 The header canonicalization method. One of 'relaxed' or 'simple'.
38170 .vitem &%$dkim_copiedheaders%&
38171 A transcript of headers and their values which are included in the signature
38172 (copied from the 'z=' tag of the signature).
38173 .vitem &%$dkim_bodylength%&
38174 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
38175 limit was set by the signer, "9999999999999" is returned. This makes sure
38176 that this variable always expands to an integer value.
38177 .vitem &%$dkim_created%&
38178 UNIX timestamp reflecting the date and time when the signature was created.
38179 When this was not specified by the signer, "0" is returned.
38180 .vitem &%$dkim_expires%&
38181 UNIX timestamp reflecting the date and time when the signer wants the
38182 signature to be treated as "expired". When this was not specified by the
38183 signer, "9999999999999" is returned. This makes it possible to do useful
38184 integer size comparisons against this value.
38185 .vitem &%$dkim_headernames%&
38186 A colon-separated list of names of headers included in the signature.
38187 .vitem &%$dkim_key_testing%&
38188 "1" if the key record has the "testing" flag set, "0" if not.
38189 .vitem &%$dkim_key_nosubdomains%&
38190 "1" if the key record forbids subdomaining, "0" otherwise.
38191 .vitem &%$dkim_key_srvtype%&
38192 Service type (tag s=) from the key record. Defaults to "*" if not specified
38193 in the key record.
38194 .vitem &%$dkim_key_granularity%&
38195 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
38196 in the key record.
38197 .vitem &%$dkim_key_notes%&
38198 Notes from the key record (tag n=).
38199 .vitem &%$dkim_key_length%&
38200 Number of bits in the key.
38201 .endlist
38202
38203 In addition, two ACL conditions are provided:
38204
38205 .vlist
38206 .vitem &%dkim_signers%&
38207 ACL condition that checks a colon-separated list of domains or identities
38208 for a match against the domain or identity that the ACL is currently verifying
38209 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
38210 verb to a group of domains or identities. For example:
38211
38212 .code
38213 # Warn when Mail purportedly from GMail has no signature at all
38214 warn log_message = GMail sender without DKIM signature
38215      sender_domains = gmail.com
38216      dkim_signers = gmail.com
38217      dkim_status = none
38218 .endd
38219
38220 .vitem &%dkim_status%&
38221 ACL condition that checks a colon-separated list of possible DKIM verification
38222 results against the actual result of verification. This is typically used
38223 to restrict an ACL verb to a list of verification outcomes, for example:
38224
38225 .code
38226 deny message = Mail from Paypal with invalid/missing signature
38227      sender_domains = paypal.com:paypal.de
38228      dkim_signers = paypal.com:paypal.de
38229      dkim_status = none:invalid:fail
38230 .endd
38231
38232 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
38233 see the documentation of the &%$dkim_verify_status%& expansion variable above
38234 for more information of what they mean.
38235 .endlist
38236
38237 . ////////////////////////////////////////////////////////////////////////////
38238 . ////////////////////////////////////////////////////////////////////////////
38239
38240 .chapter "Proxies" "CHAPproxies" &&&
38241          "Proxy support"
38242 .cindex "proxy support"
38243 .cindex "proxy" "access via"
38244
38245 .new
38246 A proxy is an intermediate system through which communication is passed.
38247 Proxies may provide a security, availability or load-distribution function.
38248
38249
38250 .section "Inbound proxies" SECTproxyInbound
38251 .cindex proxy inbound
38252 .cindex proxy "server side"
38253 .cindex proxy "Proxy protocol"
38254 .cindex "Proxy protocol" proxy
38255
38256 Exim has support for receiving inbound SMTP connections via a proxy
38257 that uses &"Proxy Protocol"& to speak to it.
38258 To include this support, include &"SUPPORT_PROXY=yes"&
38259 in Local/Makefile.
38260
38261 It was built on specifications from:
38262 http://haproxy.1wt.eu/download/1.5/doc/proxy-protocol.txt
38263 That URL was revised in May 2014 to version 2 spec:
38264 http://git.1wt.eu/web?p=haproxy.git;a=commitdiff;h=afb768340c9d7e50d8e
38265
38266 The purpose of this facility is so that an application load balancer,
38267 such as HAProxy, can sit in front of several Exim servers
38268 to distribute load.
38269 Exim uses the local protocol communication with the proxy to obtain
38270 the remote SMTP system IP address and port information.
38271 There is no logging if a host passes or
38272 fails Proxy Protocol negotiation, but it can easily be determined and
38273 recorded in an ACL (example is below).
38274
38275 Use of a proxy is enabled by setting the &%hosts_proxy%&
38276 main configuration option to a hostlist; connections from these
38277 hosts will use Proxy Protocol.
38278
38279 The following expansion variables are usable
38280 (&"internal"& and &"external"& here refer to the interfaces
38281 of the proxy):
38282 .display
38283 &'proxy_host_address   '& internal IP address of the proxy
38284 &'proxy_host_port      '& internal TCP port of the proxy
38285 &'proxy_target_address '& external IP address of the proxy
38286 &'proxy_target_port    '& external TCP port of the proxy
38287 &'proxy_session        '& boolean: SMTP connection via proxy
38288 .endd
38289 If &$proxy_session$& is set but &$proxy_host_address$& is empty
38290 there was a protocol error.
38291
38292 Since the real connections are all coming from the proxy, and the
38293 per host connection tracking is done before Proxy Protocol is
38294 evaluated, &%smtp_accept_max_per_host%& must be set high enough to
38295 handle all of the parallel volume you expect per inbound proxy.
38296 With the option set so high, you lose the ability
38297 to protect your server from many connections from one IP.
38298 In order to prevent your server from overload, you
38299 need to add a per connection ratelimit to your connect ACL.
38300 A possible solution is:
38301 .display
38302   # Set max number of connections per host
38303   LIMIT   = 5
38304   # Or do some kind of IP lookup in a flat file or database
38305   # LIMIT = ${lookup{$sender_host_address}iplsearch{/etc/exim/proxy_limits}}
38306
38307   defer   message        = Too many connections from this IP right now
38308           ratelimit      = LIMIT / 5s / per_conn / strict
38309 .endd
38310
38311
38312
38313 .section "Outbound proxies" SECTproxySOCKS
38314 .cindex proxy outbound
38315 .cindex proxy "client side"
38316 .cindex proxy SOCKS
38317 .cindex SOCKS proxy
38318 Exim has support for sending outbound SMTP via a proxy
38319 using a protocol called SOCKS5 (defined by RFC1928).
38320 The support can be optionally included by defining SUPPORT_SOCKS=yes in
38321 Local/Makefile.
38322
38323 Use of a proxy is enabled by setting the &%socks_proxy%& option
38324 on an smtp transport.
38325 The option value is expanded and should then be a list
38326 (colon-separated by default) of proxy specifiers.
38327 Each proxy specifier is a list
38328 (space-separated by default) where the initial element
38329 is an IP address and any subsequent elements are options.
38330
38331 Options are a string <name>=<value>. 
38332 The list of options is in the following table:
38333 .display
38334 &'auth   '& authentication method
38335 &'name   '& authentication username
38336 &'pass   '& authentication password
38337 &'port   '& tcp port
38338 &'tmo    '& connection timeout
38339 &'pri    '& priority
38340 &'weight '& selection bias
38341 .endd
38342
38343 More details on each of these options follows:
38344
38345 .ilist
38346 .cindex authentication "to proxy"
38347 .cindex proxy authentication
38348 &%auth%&: Either &"none"& (default) or &"name"&.
38349 Using &"name"& selects username/password authentication per RFC 1929
38350 for access to the proxy.
38351 Default is &"none"&.
38352 .next
38353 &%name%&: sets the username for the &"name"& authentication method.
38354 Default is empty.
38355 .next
38356 &%pass%&: sets the password for the &"name"& authentication method.
38357 Default is empty.
38358 .next
38359 &%port%&: the TCP port number to use for the connection to the proxy.
38360 Default is 1080.
38361 .next
38362 &%tmo%&: sets a connection timeout in seconds for this proxy.
38363 Default is 5.
38364 .next
38365 &%pri%&: specifies a priority for the proxy within the list,
38366 higher values being tried first.
38367 The default priority is 1.
38368 .next
38369 &%weight%&: specifies a selection bias.
38370 Within a priority set servers are queried in a random fashion,
38371 weighted by this value.
38372 The default value for selection bias is 1.
38373 .endlist
38374
38375 Proxies from the list are tried according to their priority
38376 and weight settings until one responds.  The timeout for the
38377 overall connection applies to the set of proxied attempts.
38378
38379 .section Logging SECTproxyLog
38380 To log the (local) IP of a proxy in the incoming or delivery logline,
38381 add &"+proxy"& to the &%log_selector%& option.
38382 This will add a component tagged with &"PRX="& to the line.
38383 .wen
38384
38385 . ////////////////////////////////////////////////////////////////////////////
38386 . ////////////////////////////////////////////////////////////////////////////
38387
38388 .chapter "Internationalisation" "CHAPi18n" &&&
38389          "Internationalisation""
38390 .cindex internationalisation "email address"
38391 .cindex EAI
38392 .cindex i18n
38393 .cindex UTF-8 "mail name handling"
38394
38395 .new
38396 Exim has support for Internationalised mail names.
38397 To include this it must be built with SUPPORT_I18N and the libidn library.
38398 Standards supported are RFCs 2060, 5890, 6530 and 6533.
38399
38400 .section "MTA operations" SECTi18nMTA
38401 .cindex SMTPUTF8 "ESMTP option"
38402 The main configuration option &%smtputf8_advertise_hosts%& specifies
38403 a host list.  If this matches the sending host and
38404 accept_8bitmime is true (the default) then the ESMTP option
38405 SMTPUTF8 will be advertised.
38406
38407 If the sender specifies the SMTPUTF8 option on a MAIL command
38408 international handling for the message is enabled and
38409 the expansion variable &$message_smtputf8$& will have value TRUE.
38410
38411 The option &%allow_utf8_domains%& is set to true for this
38412 message. All DNS lookups are converted to a-label form
38413 whatever the setting of &%allow_utf8_domains%&
38414 when Exim is built with SUPPORT_I18N.
38415
38416 Both localparts and domain are maintained as the original
38417 UTF-8 form internally; any comparison or regular-expression use will
38418 require appropriate care.  Filenames created, eg. by
38419 the appendfile transport, will have UTF-8 names.
38420
38421 HELO names sent by the smtp transport will have any UTF-8
38422 components expanded to a-label form,
38423 and any certificate name checks will be done using the a-label
38424 form of the name.
38425
38426 .cindex log protocol
38427 .cindex SMTPUTF8 logging
38428 Log lines and Received-by: header lines will acquire a "utf8"
38429 prefix on the protocol element, eg. utf8esmtp.
38430
38431 The following expansion operator can be used:
38432 .code
38433 ${utf8_domain_to_alabel:str}
38434 ${utf8_domain_from_alabel:str}
38435 ${utf8_localpart_to_alabel:str}
38436 ${utf8_localpart_from_alabel:str}
38437 .endd
38438
38439 ACLs may use the following modifier:
38440 .display
38441 control = utf8_downconvert
38442 control = utf8_downconvert/<value>
38443 .endd
38444 This sets a flag requiring that addresses are converted to
38445 a-label form before smtp delivery, for use in a
38446 Message Submission Agent context.
38447 If a value is appended it may be:
38448 .display
38449 &`1  `& (default) mandatory downconversion
38450 &`0  `& no downconversion
38451 &`-1 `& if SMTPUTF8 not supported by destination host
38452 .endd
38453
38454 If mua_wrapper is set, the utf8_downconvert control
38455 is initially set to -1.
38456
38457
38458 There is no explicit support for VRFY and EXPN.
38459 Configurations supporting these should inspect
38460 &$smtp_command_argument$& for an SMTPUTF8 argument.
38461
38462 There is no support for LMTP on Unix sockets.
38463 Using the "lmtp" protocol option on an smtp transport,
38464 for LMTP over TCP, should work as expected.
38465
38466 There is no support for DSN unitext handling,
38467 and no provision for converting logging from or to UTF-8.
38468
38469
38470
38471 .section "MDA operations" SECTi18nMDA
38472 To aid in constructing names suitable for IMAP folders
38473 the following expansion operator can be used:
38474 .code
38475 ${imapfolder {<string>} {<sep>} {<specials>}}
38476 .endd
38477
38478 The string is converted from the charset specified by
38479 the "headers charset" command (in a filter file)
38480 or &%headers_charset%& main configuration option (otherwise),
38481 to the
38482 modified UTF-7 encoding specified by RFC 2060,
38483 with the following exception: All occurences of <sep>
38484 (which has to be a single character)
38485 are replaced with periods ("."), and all periods and slashes that are not
38486 <sep> and are not in the <specials> string are BASE64 encoded.
38487
38488 The third argument can be omitted, defaulting to an empty string.
38489 The second argument can be omitted, defaulting to "/".
38490
38491 This is the encoding used by Courier for Maildir names on disk, and followed
38492 by many other IMAP servers.
38493
38494 Examples:
38495 .display
38496 &`${imapfolder {Foo/Bar}}       `& yields &`Foo.Bar`&
38497 &`${imapfolder {Foo/Bar}{.}{/}} `& yields &`Foo&&AC8-Bar`&
38498 &`${imapfolder {Räksmörgås}}    `& yields &`R&&AOQ-ksm&&APY-rg&&AOU-s`&
38499 .endd
38500
38501 Note that the source charset setting is vital, and also that characters
38502 must be representable in UTF-16.
38503
38504 .wen
38505
38506 . ////////////////////////////////////////////////////////////////////////////
38507 . ////////////////////////////////////////////////////////////////////////////
38508
38509 .chapter "Events" "CHAPevents" &&&
38510          "Events"
38511 .cindex events
38512
38513 .new
38514 The events mechanism in Exim can be used to intercept processing at a number
38515 of points.  It was originally invented to giave a way to do customised logging
38516 actions (for example, to a database) but can also be used to modify some
38517 processing actions.
38518
38519 Most installations will never need to use Events.
38520 The support can be left out of a build by defining DISABLE_EVENT=yes
38521 in &_Local/Makefile_&.
38522
38523 There are two major classes of events: main and transport.
38524 The main configuration option &%event_action%& controls reception events;
38525 a transport option &%event_action%& controls delivery events.
38526
38527 Both options are a string which is expanded when the event fires.
38528 An example might look like:
38529 .cindex logging custom
38530 .code
38531 event_action = ${if eq {msg:delivery}{$event_name} \
38532 {${lookup pgsql {SELECT * FROM record_Delivery( \
38533     '${quote_pgsql:$sender_address_domain}',\
38534     '${quote_pgsql:${lc:$sender_address_local_part}}', \
38535     '${quote_pgsql:$domain}', \
38536     '${quote_pgsql:${lc:$local_part}}', \
38537     '${quote_pgsql:$host_address}', \
38538     '${quote_pgsql:${lc:$host}}', \
38539     '${quote_pgsql:$message_exim_id}')}} \
38540 } {}}
38541 .endd
38542
38543 Events have names which correspond to the point in process at which they fire.
38544 The name is placed in the variable &$event_name$& and the event action
38545 expansion must check this, as it will be called for every possible event type.
38546
38547 The current list of events is:
38548 .display
38549 &`msg:complete           after    main       `& per message
38550 &`msg:delivery           after    transport  `& per recipient
38551 &`msg:rcpt:host:defer    after    transport  `& per recipient per host
38552 &`msg:rcpt:defer         after    transport  `& per recipient
38553 &`msg:host:defer         after    transport  `& per attempt
38554 &`msg:fail:delivery      after    main       `& per recipient
38555 &`msg:fail:internal      after    main       `& per recipient
38556 &`tcp:connect            before   transport  `& per connection
38557 &`tcp:close              after    transport  `& per connection
38558 &`tls:cert               before   both       `& per certificate in verification chain
38559 &`smtp:connect           after    transport  `& per connection
38560 .endd
38561 New event types may be added in future.
38562
38563 The event name is a colon-separated list, defining the type of
38564 event in a tree of possibilities.  It may be used as a list
38565 or just matched on as a whole.  There will be no spaces in the name.
38566
38567 The second column in the table above describes whether the event fires
38568 before or after the action is associates with.  Those which fire before
38569 can be used to affect that action (more on this below).
38570
38571 An additional variable, &$event_data$&, is filled with information varying
38572 with the event type:
38573 .display
38574 &`msg:delivery         `& smtp confirmation mssage
38575 &`msg:rcpt:host:defer  `& error string
38576 &`msg:rcpt:defer       `& error string
38577 &`msg:host:defer       `& error string
38578 &`tls:cert             `& verification chain depth
38579 &`smtp:connect         `& smtp banner
38580 .endd
38581
38582 The :defer events populate one extra variable: &$event_defer_errno$&.
38583
38584 For complex operations an ACL expansion can be used in &%event_action%&
38585 however due to the multiple contextx that Exim operates in during
38586 the course of its processing:
38587 .ilist
38588 variables set in transport events will not be visible outside that
38589 transport call
38590 .next
38591 acl_m variables in a server context are lost on a new connection,
38592 and after smtp helo/ehlo/mail/starttls/rset commands
38593 .endlist
38594 Using an ACL expansion with the logwrite modifier can be
38595 a useful way of writing to the main log.
38596
38597 The expansion of the event_action option should normally
38598 return an empty string.  Should it return anything else the
38599 following will be forced:
38600 .display
38601 &`msg:delivery     `&  (ignored)
38602 &`msg:host:defer   `&  (ignored)
38603 &`msg:fail:delivery`&  (ignored)
38604 &`tcp:connect      `&  do not connect
38605 &`tcp:close        `&  (ignored)
38606 &`tls:cert         `&  refuse verification
38607 &`smtp:connect     `&  close connection
38608 .endd
38609 No other use is made of the result string.
38610
38611 For a tcp:connect event, if the connection is being made to a proxy
38612 then the address and port variables will be that of the proxy and not
38613 the target system.
38614
38615 For tls:cert events, if GnuTLS is in use this will trigger only per
38616 chain element received on the connection.
38617 For OpenSSL it will trigger for every chain element including those
38618 loaded locally.
38619 .wen
38620
38621 . ////////////////////////////////////////////////////////////////////////////
38622 . ////////////////////////////////////////////////////////////////////////////
38623
38624 .chapter "Adding new drivers or lookup types" "CHID13" &&&
38625          "Adding drivers or lookups"
38626 .cindex "adding drivers"
38627 .cindex "new drivers, adding"
38628 .cindex "drivers" "adding new"
38629 The following actions have to be taken in order to add a new router, transport,
38630 authenticator, or lookup type to Exim:
38631
38632 .olist
38633 Choose a name for the driver or lookup type that does not conflict with any
38634 existing name; I will use &"newdriver"& in what follows.
38635 .next
38636 Add to &_src/EDITME_& the line:
38637 .display
38638 <&'type'&>&`_NEWDRIVER=yes`&
38639 .endd
38640 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
38641 code is not to be included in the binary by default, comment this line out. You
38642 should also add any relevant comments about the driver or lookup type.
38643 .next
38644 Add to &_src/config.h.defaults_& the line:
38645 .code
38646 #define <type>_NEWDRIVER
38647 .endd
38648 .next
38649 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
38650 and create a table entry as is done for all the other drivers and lookup types.
38651 .next
38652 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
38653 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
38654 Add your &`NEWDRIVER`& to that list.
38655 As long as the dynamic module would be named &_newdriver.so_&, you can use the
38656 simple form that most lookups have.
38657 .next
38658 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
38659 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
38660 driver or lookup type and add it to the definition of OBJ.
38661 .next
38662 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
38663 &_src_&.
38664 .next
38665 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
38666 as for other drivers and lookups.
38667 .endlist
38668
38669 Then all you need to do is write the code! A good way to start is to make a
38670 proforma by copying an existing module of the same type, globally changing all
38671 occurrences of the name, and cutting out most of the code. Note that any
38672 options you create must be listed in alphabetical order, because the tables are
38673 searched using a binary chop procedure.
38674
38675 There is a &_README_& file in each of the sub-directories of &_src_& describing
38676 the interface that is expected.
38677
38678
38679
38680
38681 . ////////////////////////////////////////////////////////////////////////////
38682 . ////////////////////////////////////////////////////////////////////////////
38683
38684 . /////////////////////////////////////////////////////////////////////////////
38685 . These lines are processing instructions for the Simple DocBook Processor that
38686 . Philip Hazel has developed as a less cumbersome way of making PostScript and
38687 . PDFs than using xmlto and fop. They will be ignored by all other XML
38688 . processors.
38689 . /////////////////////////////////////////////////////////////////////////////
38690
38691 .literal xml
38692 <?sdop
38693   format="newpage"
38694   foot_right_recto="&chaptertitle;"
38695   foot_right_verso="&chaptertitle;"
38696 ?>
38697 .literal off
38698
38699 .makeindex "Options index"   "option"
38700 .makeindex "Variables index" "variable"
38701 .makeindex "Concept index"   "concept"
38702
38703
38704 . /////////////////////////////////////////////////////////////////////////////
38705 . /////////////////////////////////////////////////////////////////////////////