Log certificate verification status by default
[users/jgh/exim.git] / doc / doc-docbook / spec.xfpt
1 . /////////////////////////////////////////////////////////////////////////////
2 . This is the primary source of the Exim Manual. It is an xfpt document that is
3 . converted into DocBook XML for subsequent conversion into 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.84"
49 .include ./local_params
50
51 .set ACL "access control lists (ACLs)"
52 .set I   "&nbsp;&nbsp;&nbsp;&nbsp;"
53
54 .macro copyyear
55 2014
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"
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 ISO-8859-1). 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"&. It is not known
1989 if anyone is actually using A6 records. Exim has support for A6 records, but
1990 this is included only if you set &`SUPPORT_A6=YES`& in &_Local/Makefile_&. The
1991 support has not been tested for some time.
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 &*Warning*&: The &%-j%& (parallel) flag must not be used with &'make'&; the
2036 building process fails if it is set.
2037
2038 If this is the first time &'make'& has been run, it calls a script that builds
2039 a make file inside the build directory, using the configuration files from the
2040 &_Local_& directory. The new make file is then passed to another instance of
2041 &'make'&. This does the real work, building a number of utility scripts, and
2042 then compiling and linking the binaries for the Exim monitor (if configured), a
2043 number of utility programs, and finally Exim itself. The command &`make
2044 makefile`& can be used to force a rebuild of the make file in the build
2045 directory, should this ever be necessary.
2046
2047 If you have problems building Exim, check for any comments there may be in the
2048 &_README_& file concerning your operating system, and also take a look at the
2049 FAQ, where some common problems are covered.
2050
2051
2052
2053 .section 'Output from &"make"&' "SECID283"
2054 The output produced by the &'make'& process for compile lines is often very
2055 unreadable, because these lines can be very long. For this reason, the normal
2056 output is suppressed by default, and instead output similar to that which
2057 appears when compiling the 2.6 Linux kernel is generated: just a short line for
2058 each module that is being compiled or linked. However, it is still possible to
2059 get the full output, by calling &'make'& like this:
2060 .code
2061 FULLECHO='' make -e
2062 .endd
2063 The value of FULLECHO defaults to &"@"&, the flag character that suppresses
2064 command reflection in &'make'&. When you ask for the full output, it is
2065 given in addition to the short output.
2066
2067
2068
2069 .section "Overriding build-time options for Exim" "SECToverride"
2070 .cindex "build-time options, overriding"
2071 The main make file that is created at the beginning of the building process
2072 consists of the concatenation of a number of files which set configuration
2073 values, followed by a fixed set of &'make'& instructions. If a value is set
2074 more than once, the last setting overrides any previous ones. This provides a
2075 convenient way of overriding defaults. The files that are concatenated are, in
2076 order:
2077 .display
2078 &_OS/Makefile-Default_&
2079 &_OS/Makefile-_&<&'ostype'&>
2080 &_Local/Makefile_&
2081 &_Local/Makefile-_&<&'ostype'&>
2082 &_Local/Makefile-_&<&'archtype'&>
2083 &_Local/Makefile-_&<&'ostype'&>-<&'archtype'&>
2084 &_OS/Makefile-Base_&
2085 .endd
2086 .cindex "&_Local/Makefile_&"
2087 .cindex "building Exim" "operating system type"
2088 .cindex "building Exim" "architecture type"
2089 where <&'ostype'&> is the operating system type and <&'archtype'&> is the
2090 architecture type. &_Local/Makefile_& is required to exist, and the building
2091 process fails if it is absent. The other three &_Local_& files are optional,
2092 and are often not needed.
2093
2094 The values used for <&'ostype'&> and <&'archtype'&> are obtained from scripts
2095 called &_scripts/os-type_& and &_scripts/arch-type_& respectively. If either of
2096 the environment variables EXIM_OSTYPE or EXIM_ARCHTYPE is set, their
2097 values are used, thereby providing a means of forcing particular settings.
2098 Otherwise, the scripts try to get values from the &%uname%& command. If this
2099 fails, the shell variables OSTYPE and ARCHTYPE are inspected. A number
2100 of &'ad hoc'& transformations are then applied, to produce the standard names
2101 that Exim expects. You can run these scripts directly from the shell in order
2102 to find out what values are being used on your system.
2103
2104
2105 &_OS/Makefile-Default_& contains comments about the variables that are set
2106 therein. Some (but not all) are mentioned below. If there is something that
2107 needs changing, review the contents of this file and the contents of the make
2108 file for your operating system (&_OS/Makefile-<ostype>_&) to see what the
2109 default values are.
2110
2111
2112 .cindex "building Exim" "overriding default settings"
2113 If you need to change any of the values that are set in &_OS/Makefile-Default_&
2114 or in &_OS/Makefile-<ostype>_&, or to add any new definitions, you do not
2115 need to change the original files. Instead, you should make the changes by
2116 putting the new values in an appropriate &_Local_& file. For example,
2117 .cindex "Tru64-Unix build-time settings"
2118 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2119 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2120 compiler is called &'cc'& rather than &'gcc'&. Also, the compiler must be
2121 called with the option &%-std1%&, to make it recognize some of the features of
2122 Standard C that Exim uses. (Most other compilers recognize Standard C by
2123 default.) To do this, you should create a file called &_Local/Makefile-OSF1_&
2124 containing the lines
2125 .code
2126 CC=cc
2127 CFLAGS=-std1
2128 .endd
2129 If you are compiling for just one operating system, it may be easier to put
2130 these lines directly into &_Local/Makefile_&.
2131
2132 Keeping all your local configuration settings separate from the distributed
2133 files makes it easy to transfer them to new versions of Exim simply by copying
2134 the contents of the &_Local_& directory.
2135
2136
2137 .cindex "NIS lookup type" "including support for"
2138 .cindex "NIS+ lookup type" "including support for"
2139 .cindex "LDAP" "including support for"
2140 .cindex "lookup" "inclusion in binary"
2141 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2142 lookup, but not all systems have these components installed, so the default is
2143 not to include the relevant code in the binary. All the different kinds of file
2144 and database lookup that Exim supports are implemented as separate code modules
2145 which are included only if the relevant compile-time options are set. In the
2146 case of LDAP, NIS, and NIS+, the settings for &_Local/Makefile_& are:
2147 .code
2148 LOOKUP_LDAP=yes
2149 LOOKUP_NIS=yes
2150 LOOKUP_NISPLUS=yes
2151 .endd
2152 and similar settings apply to the other lookup types. They are all listed in
2153 &_src/EDITME_&. In many cases the relevant include files and interface
2154 libraries need to be installed before compiling Exim.
2155 .cindex "cdb" "including support for"
2156 However, there are some optional lookup types (such as cdb) for which
2157 the code is entirely contained within Exim, and no external include
2158 files or libraries are required. When a lookup type is not included in the
2159 binary, attempts to configure Exim to use it cause run time configuration
2160 errors.
2161
2162 .cindex "pkg-config" "lookups"
2163 .cindex "pkg-config" "authenticators"
2164 Many systems now use a tool called &'pkg-config'& to encapsulate information
2165 about how to compile against a library; Exim has some initial support for
2166 being able to use pkg-config for lookups and authenticators.  For any given
2167 makefile variable which starts &`LOOKUP_`& or &`AUTH_`&, you can add a new
2168 variable with the &`_PC`& suffix in the name and assign as the value the
2169 name of the package to be queried.  The results of querying via the
2170 &'pkg-config'& command will be added to the appropriate Makefile variables
2171 with &`+=`& directives, so your version of &'make'& will need to support that
2172 syntax.  For instance:
2173 .code
2174 LOOKUP_SQLITE=yes
2175 LOOKUP_SQLITE_PC=sqlite3
2176 AUTH_GSASL=yes
2177 AUTH_GSASL_PC=libgsasl
2178 AUTH_HEIMDAL_GSSAPI=yes
2179 AUTH_HEIMDAL_GSSAPI_PC=heimdal-gssapi
2180 .endd
2181
2182 .cindex "Perl" "including support for"
2183 Exim can be linked with an embedded Perl interpreter, allowing Perl
2184 subroutines to be called during string expansion. To enable this facility,
2185 .code
2186 EXIM_PERL=perl.o
2187 .endd
2188 must be defined in &_Local/Makefile_&. Details of this facility are given in
2189 chapter &<<CHAPperl>>&.
2190
2191 .cindex "X11 libraries, location of"
2192 The location of the X11 libraries is something that varies a lot between
2193 operating systems, and there may be different versions of X11 to cope
2194 with. Exim itself makes no use of X11, but if you are compiling the Exim
2195 monitor, the X11 libraries must be available.
2196 The following three variables are set in &_OS/Makefile-Default_&:
2197 .code
2198 X11=/usr/X11R6
2199 XINCLUDE=-I$(X11)/include
2200 XLFLAGS=-L$(X11)/lib
2201 .endd
2202 These are overridden in some of the operating-system configuration files. For
2203 example, in &_OS/Makefile-SunOS5_& there is
2204 .code
2205 X11=/usr/openwin
2206 XINCLUDE=-I$(X11)/include
2207 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2208 .endd
2209 If you need to override the default setting for your operating system, place a
2210 definition of all three of these variables into your
2211 &_Local/Makefile-<ostype>_& file.
2212
2213 .cindex "EXTRALIBS"
2214 If you need to add any extra libraries to the link steps, these can be put in a
2215 variable called EXTRALIBS, which appears in all the link commands, but by
2216 default is not defined. In contrast, EXTRALIBS_EXIM is used only on the
2217 command for linking the main Exim binary, and not for any associated utilities.
2218
2219 .cindex "DBM libraries" "configuration for building"
2220 There is also DBMLIB, which appears in the link commands for binaries that
2221 use DBM functions (see also section &<<SECTdb>>&). Finally, there is
2222 EXTRALIBS_EXIMON, which appears only in the link step for the Exim monitor
2223 binary, and which can be used, for example, to include additional X11
2224 libraries.
2225
2226 .cindex "configuration file" "editing"
2227 The make file copes with rebuilding Exim correctly if any of the configuration
2228 files are edited. However, if an optional configuration file is deleted, it is
2229 necessary to touch the associated non-optional file (that is,
2230 &_Local/Makefile_& or &_Local/eximon.conf_&) before rebuilding.
2231
2232
2233 .section "OS-specific header files" "SECID30"
2234 .cindex "&_os.h_&"
2235 .cindex "building Exim" "OS-specific C header files"
2236 The &_OS_& directory contains a number of files with names of the form
2237 &_os.h-<ostype>_&. These are system-specific C header files that should not
2238 normally need to be changed. There is a list of macro settings that are
2239 recognized in the file &_OS/os.configuring_&, which should be consulted if you
2240 are porting Exim to a new operating system.
2241
2242
2243
2244 .section "Overriding build-time options for the monitor" "SECID31"
2245 .cindex "building Eximon"
2246 A similar process is used for overriding things when building the Exim monitor,
2247 where the files that are involved are
2248 .display
2249 &_OS/eximon.conf-Default_&
2250 &_OS/eximon.conf-_&<&'ostype'&>
2251 &_Local/eximon.conf_&
2252 &_Local/eximon.conf-_&<&'ostype'&>
2253 &_Local/eximon.conf-_&<&'archtype'&>
2254 &_Local/eximon.conf-_&<&'ostype'&>-<&'archtype'&>
2255 .endd
2256 .cindex "&_Local/eximon.conf_&"
2257 As with Exim itself, the final three files need not exist, and in this case the
2258 &_OS/eximon.conf-<ostype>_& file is also optional. The default values in
2259 &_OS/eximon.conf-Default_& can be overridden dynamically by setting environment
2260 variables of the same name, preceded by EXIMON_. For example, setting
2261 EXIMON_LOG_DEPTH in the environment overrides the value of
2262 LOG_DEPTH at run time.
2263 .ecindex IIDbuex
2264
2265
2266 .section "Installing Exim binaries and scripts" "SECID32"
2267 .cindex "installing Exim"
2268 .cindex "BIN_DIRECTORY"
2269 The command &`make install`& runs the &(exim_install)& script with no
2270 arguments. The script copies binaries and utility scripts into the directory
2271 whose name is specified by the BIN_DIRECTORY setting in &_Local/Makefile_&.
2272 .cindex "setuid" "installing Exim with"
2273 The install script copies files only if they are newer than the files they are
2274 going to replace. The Exim binary is required to be owned by root and have the
2275 &'setuid'& bit set, for normal configurations. Therefore, you must run &`make
2276 install`& as root so that it can set up the Exim binary in this way. However, in
2277 some special situations (for example, if a host is doing no local deliveries)
2278 it may be possible to run Exim without making the binary setuid root (see
2279 chapter &<<CHAPsecurity>>& for details).
2280
2281 .cindex "CONFIGURE_FILE"
2282 Exim's run time configuration file is named by the CONFIGURE_FILE setting
2283 in &_Local/Makefile_&. If this names a single file, and the file does not
2284 exist, the default configuration file &_src/configure.default_& is copied there
2285 by the installation script. If a run time configuration file already exists, it
2286 is left alone. If CONFIGURE_FILE is a colon-separated list, naming several
2287 alternative files, no default is installed.
2288
2289 .cindex "system aliases file"
2290 .cindex "&_/etc/aliases_&"
2291 One change is made to the default configuration file when it is installed: the
2292 default configuration contains a router that references a system aliases file.
2293 The path to this file is set to the value specified by
2294 SYSTEM_ALIASES_FILE in &_Local/Makefile_& (&_/etc/aliases_& by default).
2295 If the system aliases file does not exist, the installation script creates it,
2296 and outputs a comment to the user.
2297
2298 The created file contains no aliases, but it does contain comments about the
2299 aliases a site should normally have. Mail aliases have traditionally been
2300 kept in &_/etc/aliases_&. However, some operating systems are now using
2301 &_/etc/mail/aliases_&. You should check if yours is one of these, and change
2302 Exim's configuration if necessary.
2303
2304 The default configuration uses the local host's name as the only local domain,
2305 and is set up to do local deliveries into the shared directory &_/var/mail_&,
2306 running as the local user. System aliases and &_.forward_& files in users' home
2307 directories are supported, but no NIS or NIS+ support is configured. Domains
2308 other than the name of the local host are routed using the DNS, with delivery
2309 over SMTP.
2310
2311 It is possible to install Exim for special purposes (such as building a binary
2312 distribution) in a private part of the file system. You can do this by a
2313 command such as
2314 .code
2315 make DESTDIR=/some/directory/ install
2316 .endd
2317 This has the effect of pre-pending the specified directory to all the file
2318 paths, except the name of the system aliases file that appears in the default
2319 configuration. (If a default alias file is created, its name &'is'& modified.)
2320 For backwards compatibility, ROOT is used if DESTDIR is not set,
2321 but this usage is deprecated.
2322
2323 .cindex "installing Exim" "what is not installed"
2324 Running &'make install'& does not copy the Exim 4 conversion script
2325 &'convert4r4'&. You will probably run this only once if you are
2326 upgrading from Exim 3. None of the documentation files in the &_doc_&
2327 directory are copied, except for the info files when you have set
2328 INFO_DIRECTORY, as described in section &<<SECTinsinfdoc>>& below.
2329
2330 For the utility programs, old versions are renamed by adding the suffix &_.O_&
2331 to their names. The Exim binary itself, however, is handled differently. It is
2332 installed under a name that includes the version number and the compile number,
2333 for example &_exim-&version()-1_&. The script then arranges for a symbolic link
2334 called &_exim_& to point to the binary. If you are updating a previous version
2335 of Exim, the script takes care to ensure that the name &_exim_& is never absent
2336 from the directory (as seen by other processes).
2337
2338 .cindex "installing Exim" "testing the script"
2339 If you want to see what the &'make install'& will do before running it for
2340 real, you can pass the &%-n%& option to the installation script by this
2341 command:
2342 .code
2343 make INSTALL_ARG=-n install
2344 .endd
2345 The contents of the variable INSTALL_ARG are passed to the installation
2346 script. You do not need to be root to run this test. Alternatively, you can run
2347 the installation script directly, but this must be from within the build
2348 directory. For example, from the top-level Exim directory you could use this
2349 command:
2350 .code
2351 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
2352 .endd
2353 .cindex "installing Exim" "install script options"
2354 There are two other options that can be supplied to the installation script.
2355
2356 .ilist
2357 &%-no_chown%& bypasses the call to change the owner of the installed binary
2358 to root, and the call to make it a setuid binary.
2359 .next
2360 &%-no_symlink%& bypasses the setting up of the symbolic link &_exim_& to the
2361 installed binary.
2362 .endlist
2363
2364 INSTALL_ARG can be used to pass these options to the script. For example:
2365 .code
2366 make INSTALL_ARG=-no_symlink install
2367 .endd
2368 The installation script can also be given arguments specifying which files are
2369 to be copied. For example, to install just the Exim binary, and nothing else,
2370 without creating the symbolic link, you could use:
2371 .code
2372 make INSTALL_ARG='-no_symlink exim' install
2373 .endd
2374
2375
2376
2377 .section "Installing info documentation" "SECTinsinfdoc"
2378 .cindex "installing Exim" "&'info'& documentation"
2379 Not all systems use the GNU &'info'& system for documentation, and for this
2380 reason, the Texinfo source of Exim's documentation is not included in the main
2381 distribution. Instead it is available separately from the ftp site (see section
2382 &<<SECTavail>>&).
2383
2384 If you have defined INFO_DIRECTORY in &_Local/Makefile_& and the Texinfo
2385 source of the documentation is found in the source tree, running &`make
2386 install`& automatically builds the info files and installs them.
2387
2388
2389
2390 .section "Setting up the spool directory" "SECID33"
2391 .cindex "spool directory" "creating"
2392 When it starts up, Exim tries to create its spool directory if it does not
2393 exist. The Exim uid and gid are used for the owner and group of the spool
2394 directory. Sub-directories are automatically created in the spool directory as
2395 necessary.
2396
2397
2398
2399
2400 .section "Testing" "SECID34"
2401 .cindex "testing" "installation"
2402 Having installed Exim, you can check that the run time configuration file is
2403 syntactically valid by running the following command, which assumes that the
2404 Exim binary directory is within your PATH environment variable:
2405 .code
2406 exim -bV
2407 .endd
2408 If there are any errors in the configuration file, Exim outputs error messages.
2409 Otherwise it outputs the version number and build date,
2410 the DBM library that is being used, and information about which drivers and
2411 other optional code modules are included in the binary.
2412 Some simple routing tests can be done by using the address testing option. For
2413 example,
2414 .display
2415 &`exim -bt`& <&'local username'&>
2416 .endd
2417 should verify that it recognizes a local mailbox, and
2418 .display
2419 &`exim -bt`& <&'remote address'&>
2420 .endd
2421 a remote one. Then try getting it to deliver mail, both locally and remotely.
2422 This can be done by passing messages directly to Exim, without going through a
2423 user agent. For example:
2424 .code
2425 exim -v postmaster@your.domain.example
2426 From: user@your.domain.example
2427 To: postmaster@your.domain.example
2428 Subject: Testing Exim
2429
2430 This is a test message.
2431 ^D
2432 .endd
2433 The &%-v%& option causes Exim to output some verification of what it is doing.
2434 In this case you should see copies of three log lines, one for the message's
2435 arrival, one for its delivery, and one containing &"Completed"&.
2436
2437 .cindex "delivery" "problems with"
2438 If you encounter problems, look at Exim's log files (&'mainlog'& and
2439 &'paniclog'&) to see if there is any relevant information there. Another source
2440 of information is running Exim with debugging turned on, by specifying the
2441 &%-d%& option. If a message is stuck on Exim's spool, you can force a delivery
2442 with debugging turned on by a command of the form
2443 .display
2444 &`exim -d -M`& <&'exim-message-id'&>
2445 .endd
2446 You must be root or an &"admin user"& in order to do this. The &%-d%& option
2447 produces rather a lot of output, but you can cut this down to specific areas.
2448 For example, if you use &%-d-all+route%& only the debugging information
2449 relevant to routing is included. (See the &%-d%& option in chapter
2450 &<<CHAPcommandline>>& for more details.)
2451
2452 .cindex '&"sticky"& bit'
2453 .cindex "lock files"
2454 One specific problem that has shown up on some sites is the inability to do
2455 local deliveries into a shared mailbox directory, because it does not have the
2456 &"sticky bit"& set on it. By default, Exim tries to create a lock file before
2457 writing to a mailbox file, and if it cannot create the lock file, the delivery
2458 is deferred. You can get round this either by setting the &"sticky bit"& on the
2459 directory, or by setting a specific group for local deliveries and allowing
2460 that group to create files in the directory (see the comments above the
2461 &(local_delivery)& transport in the default configuration file). Another
2462 approach is to configure Exim not to use lock files, but just to rely on
2463 &[fcntl()]& locking instead. However, you should do this only if all user
2464 agents also use &[fcntl()]& locking. For further discussion of locking issues,
2465 see chapter &<<CHAPappendfile>>&.
2466
2467 One thing that cannot be tested on a system that is already running an MTA is
2468 the receipt of incoming SMTP mail on the standard SMTP port. However, the
2469 &%-oX%& option can be used to run an Exim daemon that listens on some other
2470 port, or &'inetd'& can be used to do this. The &%-bh%& option and the
2471 &'exim_checkaccess'& utility can be used to check out policy controls on
2472 incoming SMTP mail.
2473
2474 Testing a new version on a system that is already running Exim can most easily
2475 be done by building a binary with a different CONFIGURE_FILE setting. From
2476 within the run time configuration, all other file and directory names
2477 that Exim uses can be altered, in order to keep it entirely clear of the
2478 production version.
2479
2480
2481 .section "Replacing another MTA with Exim" "SECID35"
2482 .cindex "replacing another MTA"
2483 Building and installing Exim for the first time does not of itself put it in
2484 general use. The name by which the system's MTA is called by mail user agents
2485 is either &_/usr/sbin/sendmail_&, or &_/usr/lib/sendmail_& (depending on the
2486 operating system), and it is necessary to make this name point to the &'exim'&
2487 binary in order to get the user agents to pass messages to Exim. This is
2488 normally done by renaming any existing file and making &_/usr/sbin/sendmail_&
2489 or &_/usr/lib/sendmail_&
2490 .cindex "symbolic link" "to &'exim'& binary"
2491 a symbolic link to the &'exim'& binary. It is a good idea to remove any setuid
2492 privilege and executable status from the old MTA. It is then necessary to stop
2493 and restart the mailer daemon, if one is running.
2494
2495 .cindex "FreeBSD, MTA indirection"
2496 .cindex "&_/etc/mail/mailer.conf_&"
2497 Some operating systems have introduced alternative ways of switching MTAs. For
2498 example, if you are running FreeBSD, you need to edit the file
2499 &_/etc/mail/mailer.conf_& instead of setting up a symbolic link as just
2500 described. A typical example of the contents of this file for running Exim is
2501 as follows:
2502 .code
2503 sendmail            /usr/exim/bin/exim
2504 send-mail           /usr/exim/bin/exim
2505 mailq               /usr/exim/bin/exim -bp
2506 newaliases          /usr/bin/true
2507 .endd
2508 Once you have set up the symbolic link, or edited &_/etc/mail/mailer.conf_&,
2509 your Exim installation is &"live"&. Check it by sending a message from your
2510 favourite user agent.
2511
2512 You should consider what to tell your users about the change of MTA. Exim may
2513 have different capabilities to what was previously running, and there are
2514 various operational differences such as the text of messages produced by
2515 command line options and in bounce messages. If you allow your users to make
2516 use of Exim's filtering capabilities, you should make the document entitled
2517 &'Exim's interface to mail filtering'& available to them.
2518
2519
2520
2521 .section "Upgrading Exim" "SECID36"
2522 .cindex "upgrading Exim"
2523 If you are already running Exim on your host, building and installing a new
2524 version automatically makes it available to MUAs, or any other programs that
2525 call the MTA directly. However, if you are running an Exim daemon, you do need
2526 to send it a HUP signal, to make it re-execute itself, and thereby pick up the
2527 new binary. You do not need to stop processing mail in order to install a new
2528 version of Exim. The install script does not modify an existing runtime
2529 configuration file.
2530
2531
2532
2533
2534 .section "Stopping the Exim daemon on Solaris" "SECID37"
2535 .cindex "Solaris" "stopping Exim on"
2536 The standard command for stopping the mailer daemon on Solaris is
2537 .code
2538 /etc/init.d/sendmail stop
2539 .endd
2540 If &_/usr/lib/sendmail_& has been turned into a symbolic link, this script
2541 fails to stop Exim because it uses the command &'ps -e'& and greps the output
2542 for the text &"sendmail"&; this is not present because the actual program name
2543 (that is, &"exim"&) is given by the &'ps'& command with these options. A
2544 solution is to replace the line that finds the process id with something like
2545 .code
2546 pid=`cat /var/spool/exim/exim-daemon.pid`
2547 .endd
2548 to obtain the daemon's pid directly from the file that Exim saves it in.
2549
2550 Note, however, that stopping the daemon does not &"stop Exim"&. Messages can
2551 still be received from local processes, and if automatic delivery is configured
2552 (the normal case), deliveries will still occur.
2553
2554
2555
2556
2557 . ////////////////////////////////////////////////////////////////////////////
2558 . ////////////////////////////////////////////////////////////////////////////
2559
2560 .chapter "The Exim command line" "CHAPcommandline"
2561 .scindex IIDclo1 "command line" "options"
2562 .scindex IIDclo2 "options" "command line"
2563 Exim's command line takes the standard Unix form of a sequence of options,
2564 each starting with a hyphen character, followed by a number of arguments. The
2565 options are compatible with the main options of Sendmail, and there are also
2566 some additional options, some of which are compatible with Smail 3. Certain
2567 combinations of options do not make sense, and provoke an error if used.
2568 The form of the arguments depends on which options are set.
2569
2570
2571 .section "Setting options by program name" "SECID38"
2572 .cindex "&'mailq'&"
2573 If Exim is called under the name &'mailq'&, it behaves as if the option &%-bp%&
2574 were present before any other options.
2575 The &%-bp%& option requests a listing of the contents of the mail queue on the
2576 standard output.
2577 This feature is for compatibility with some systems that contain a command of
2578 that name in one of the standard libraries, symbolically linked to
2579 &_/usr/sbin/sendmail_& or &_/usr/lib/sendmail_&.
2580
2581 .cindex "&'rsmtp'&"
2582 If Exim is called under the name &'rsmtp'& it behaves as if the option &%-bS%&
2583 were present before any other options, for compatibility with Smail. The
2584 &%-bS%& option is used for reading in a number of messages in batched SMTP
2585 format.
2586
2587 .cindex "&'rmail'&"
2588 If Exim is called under the name &'rmail'& it behaves as if the &%-i%& and
2589 &%-oee%& options were present before any other options, for compatibility with
2590 Smail. The name &'rmail'& is used as an interface by some UUCP systems.
2591
2592 .cindex "&'runq'&"
2593 .cindex "queue runner"
2594 If Exim is called under the name &'runq'& it behaves as if the option &%-q%&
2595 were present before any other options, for compatibility with Smail. The &%-q%&
2596 option causes a single queue runner process to be started.
2597
2598 .cindex "&'newaliases'&"
2599 .cindex "alias file" "building"
2600 .cindex "Sendmail compatibility" "calling Exim as &'newaliases'&"
2601 If Exim is called under the name &'newaliases'& it behaves as if the option
2602 &%-bi%& were present before any other options, for compatibility with Sendmail.
2603 This option is used for rebuilding Sendmail's alias file. Exim does not have
2604 the concept of a single alias file, but can be configured to run a given
2605 command if called with the &%-bi%& option.
2606
2607
2608 .section "Trusted and admin users" "SECTtrustedadmin"
2609 Some Exim options are available only to &'trusted users'& and others are
2610 available only to &'admin users'&. In the description below, the phrases &"Exim
2611 user"& and &"Exim group"& mean the user and group defined by EXIM_USER and
2612 EXIM_GROUP in &_Local/Makefile_& or set by the &%exim_user%& and
2613 &%exim_group%& options. These do not necessarily have to use the name &"exim"&.
2614
2615 .ilist
2616 .cindex "trusted users" "definition of"
2617 .cindex "user" "trusted definition of"
2618 The trusted users are root, the Exim user, any user listed in the
2619 &%trusted_users%& configuration option, and any user whose current group or any
2620 supplementary group is one of those listed in the &%trusted_groups%&
2621 configuration option. Note that the Exim group is not automatically trusted.
2622
2623 .cindex '&"From"& line'
2624 .cindex "envelope sender"
2625 Trusted users are always permitted to use the &%-f%& option or a leading
2626 &"From&~"& line to specify the envelope sender of a message that is passed to
2627 Exim through the local interface (see the &%-bm%& and &%-f%& options below).
2628 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
2629 users to set envelope senders.
2630
2631 .cindex "&'From:'& header line"
2632 .cindex "&'Sender:'& header line"
2633 For a trusted user, there is never any check on the contents of the &'From:'&
2634 header line, and a &'Sender:'& line is never added. Furthermore, any existing
2635 &'Sender:'& line in incoming local (non-TCP/IP) messages is not removed.
2636
2637 Trusted users may also specify a host name, host address, interface address,
2638 protocol name, ident value, and authentication data when submitting a message
2639 locally. Thus, they are able to insert messages into Exim's queue locally that
2640 have the characteristics of messages received from a remote host. Untrusted
2641 users may in some circumstances use &%-f%&, but can never set the other values
2642 that are available to trusted users.
2643 .next
2644 .cindex "user" "admin definition of"
2645 .cindex "admin user" "definition of"
2646 The admin users are root, the Exim user, and any user that is a member of the
2647 Exim group or of any group listed in the &%admin_groups%& configuration option.
2648 The current group does not have to be one of these groups.
2649
2650 Admin users are permitted to list the queue, and to carry out certain
2651 operations on messages, for example, to force delivery failures. It is also
2652 necessary to be an admin user in order to see the full information provided by
2653 the Exim monitor, and full debugging output.
2654
2655 By default, the use of the &%-M%&, &%-q%&, &%-R%&, and &%-S%& options to cause
2656 Exim to attempt delivery of messages on its queue is restricted to admin users.
2657 However, this restriction can be relaxed by setting the &%prod_requires_admin%&
2658 option false (that is, specifying &%no_prod_requires_admin%&).
2659
2660 Similarly, the use of the &%-bp%& option to list all the messages in the queue
2661 is restricted to admin users unless &%queue_list_requires_admin%& is set
2662 false.
2663 .endlist
2664
2665
2666 &*Warning*&: If you configure your system so that admin users are able to
2667 edit Exim's configuration file, you are giving those users an easy way of
2668 getting root. There is further discussion of this issue at the start of chapter
2669 &<<CHAPconf>>&.
2670
2671
2672
2673
2674 .section "Command line options" "SECID39"
2675 Exim's command line options are described in alphabetical order below. If none
2676 of the options that specifies a specific action (such as starting the daemon or
2677 a queue runner, or testing an address, or receiving a message in a specific
2678 format, or listing the queue) are present, and there is at least one argument
2679 on the command line, &%-bm%& (accept a local message on the standard input,
2680 with the arguments specifying the recipients) is assumed. Otherwise, Exim
2681 outputs a brief message about itself and exits.
2682
2683 . ////////////////////////////////////////////////////////////////////////////
2684 . Insert a stylized XML comment here, to identify the start of the command line
2685 . options. This is for the benefit of the Perl script that automatically
2686 . creates a man page for the options.
2687 . ////////////////////////////////////////////////////////////////////////////
2688
2689 .literal xml
2690 <!-- === Start of command line options === -->
2691 .literal off
2692
2693
2694 .vlist
2695 .vitem &%--%&
2696 .oindex "--"
2697 .cindex "options" "command line; terminating"
2698 This is a pseudo-option whose only purpose is to terminate the options and
2699 therefore to cause subsequent command line items to be treated as arguments
2700 rather than options, even if they begin with hyphens.
2701
2702 .vitem &%--help%&
2703 .oindex "&%--help%&"
2704 This option causes Exim to output a few sentences stating what it is.
2705 The same output is generated if the Exim binary is called with no options and
2706 no arguments.
2707
2708 .vitem &%--version%&
2709 .oindex "&%--version%&"
2710 This option is an alias for &%-bV%& and causes version information to be
2711 displayed.
2712
2713 .vitem &%-Ac%& &&&
2714        &%-Am%&
2715 .oindex "&%-Ac%&"
2716 .oindex "&%-Am%&"
2717 These options are used by Sendmail for selecting configuration files and are
2718 ignored by Exim.
2719
2720 .vitem &%-B%&<&'type'&>
2721 .oindex "&%-B%&"
2722 .cindex "8-bit characters"
2723 .cindex "Sendmail compatibility" "8-bit characters"
2724 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2725 clean; it ignores this option.
2726
2727 .vitem &%-bd%&
2728 .oindex "&%-bd%&"
2729 .cindex "daemon"
2730 .cindex "SMTP" "listener"
2731 .cindex "queue runner"
2732 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2733 the &%-bd%& option is combined with the &%-q%&<&'time'&> option, to specify
2734 that the daemon should also initiate periodic queue runs.
2735
2736 The &%-bd%& option can be used only by an admin user. If either of the &%-d%&
2737 (debugging) or &%-v%& (verifying) options are set, the daemon does not
2738 disconnect from the controlling terminal. When running this way, it can be
2739 stopped by pressing ctrl-C.
2740
2741 By default, Exim listens for incoming connections to the standard SMTP port on
2742 all the host's running interfaces. However, it is possible to listen on other
2743 ports, on multiple ports, and only on specific interfaces. Chapter
2744 &<<CHAPinterfaces>>& contains a description of the options that control this.
2745
2746 When a listening daemon
2747 .cindex "daemon" "process id (pid)"
2748 .cindex "pid (process id)" "of daemon"
2749 is started without the use of &%-oX%& (that is, without overriding the normal
2750 configuration), it writes its process id to a file called &_exim-daemon.pid_&
2751 in Exim's spool directory. This location can be overridden by setting
2752 PID_FILE_PATH in &_Local/Makefile_&. The file is written while Exim is still
2753 running as root.
2754
2755 When &%-oX%& is used on the command line to start a listening daemon, the
2756 process id is not written to the normal pid file path. However, &%-oP%& can be
2757 used to specify a path on the command line if a pid file is required.
2758
2759 The SIGHUP signal
2760 .cindex "SIGHUP"
2761 .cindex "daemon" "restarting"
2762 can be used to cause the daemon to re-execute itself. This should be done
2763 whenever Exim's configuration file, or any file that is incorporated into it by
2764 means of the &%.include%& facility, is changed, and also whenever a new version
2765 of Exim is installed. It is not necessary to do this when other files that are
2766 referenced from the configuration (for example, alias files) are changed,
2767 because these are reread each time they are used.
2768
2769 .vitem &%-bdf%&
2770 .oindex "&%-bdf%&"
2771 This option has the same effect as &%-bd%& except that it never disconnects
2772 from the controlling terminal, even when no debugging is specified.
2773
2774 .vitem &%-be%&
2775 .oindex "&%-be%&"
2776 .cindex "testing" "string expansion"
2777 .cindex "expansion" "testing"
2778 Run Exim in expansion testing mode. Exim discards its root privilege, to
2779 prevent ordinary users from using this mode to read otherwise inaccessible
2780 files. If no arguments are given, Exim runs interactively, prompting for lines
2781 of data. Otherwise, it processes each argument in turn.
2782
2783 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2784 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2785 used without command line arguments. If successful, it uses the &[readline()]&
2786 function, which provides extensive line-editing facilities, for reading the
2787 test data. A line history is supported.
2788
2789 Long expansion expressions can be split over several lines by using backslash
2790 continuations. As in Exim's run time configuration, white space at the start of
2791 continuation lines is ignored. Each argument or data line is passed through the
2792 string expansion mechanism, and the result is output. Variable values from the
2793 configuration file (for example, &$qualify_domain$&) are available, but no
2794 message-specific values (such as &$sender_domain$&) are set, because no message
2795 is being processed (but see &%-bem%& and &%-Mset%&).
2796
2797 &*Note*&: If you use this mechanism to test lookups, and you change the data
2798 files or databases you are using, you must exit and restart Exim before trying
2799 the same lookup again. Otherwise, because each Exim process caches the results
2800 of lookups, you will just get the same result as before.
2801
2802 .vitem &%-bem%&&~<&'filename'&>
2803 .oindex "&%-bem%&"
2804 .cindex "testing" "string expansion"
2805 .cindex "expansion" "testing"
2806 This option operates like &%-be%& except that it must be followed by the name
2807 of a file. For example:
2808 .code
2809 exim -bem /tmp/testmessage
2810 .endd
2811 The file is read as a message (as if receiving a locally-submitted non-SMTP
2812 message) before any of the test expansions are done. Thus, message-specific
2813 variables such as &$message_size$& and &$header_from:$& are available. However,
2814 no &'Received:'& header is added to the message. If the &%-t%& option is set,
2815 recipients are read from the headers in the normal way, and are shown in the
2816 &$recipients$& variable. Note that recipients cannot be given on the command
2817 line, because further arguments are taken as strings to expand (just like
2818 &%-be%&).
2819
2820 .vitem &%-bF%&&~<&'filename'&>
2821 .oindex "&%-bF%&"
2822 .cindex "system filter" "testing"
2823 .cindex "testing" "system filter"
2824 This option is the same as &%-bf%& except that it assumes that the filter being
2825 tested is a system filter. The additional commands that are available only in
2826 system filters are recognized.
2827
2828 .vitem &%-bf%&&~<&'filename'&>
2829 .oindex "&%-bf%&"
2830 .cindex "filter" "testing"
2831 .cindex "testing" "filter file"
2832 .cindex "forward file" "testing"
2833 .cindex "testing" "forward file"
2834 .cindex "Sieve filter" "testing"
2835 This option runs Exim in user filter testing mode; the file is the filter file
2836 to be tested, and a test message must be supplied on the standard input. If
2837 there are no message-dependent tests in the filter, an empty file can be
2838 supplied.
2839
2840 If you want to test a system filter file, use &%-bF%& instead of &%-bf%&. You
2841 can use both &%-bF%& and &%-bf%& on the same command, in order to test a system
2842 filter and a user filter in the same run. For example:
2843 .code
2844 exim -bF /system/filter -bf /user/filter </test/message
2845 .endd
2846 This is helpful when the system filter adds header lines or sets filter
2847 variables that are used by the user filter.
2848
2849 If the test filter file does not begin with one of the special lines
2850 .code
2851 # Exim filter
2852 # Sieve filter
2853 .endd
2854 it is taken to be a normal &_.forward_& file, and is tested for validity under
2855 that interpretation. See sections &<<SECTitenonfilred>>& to
2856 &<<SECTspecitredli>>& for a description of the possible contents of non-filter
2857 redirection lists.
2858
2859 The result of an Exim command that uses &%-bf%&, provided no errors are
2860 detected, is a list of the actions that Exim would try to take if presented
2861 with the message for real. More details of filter testing are given in the
2862 separate document entitled &'Exim's interfaces to mail filtering'&.
2863
2864 When testing a filter file,
2865 .cindex "&""From""& line"
2866 .cindex "envelope sender"
2867 .oindex "&%-f%&" "for filter testing"
2868 the envelope sender can be set by the &%-f%& option,
2869 or by a &"From&~"& line at the start of the test message. Various parameters
2870 that would normally be taken from the envelope recipient address of the message
2871 can be set by means of additional command line options (see the next four
2872 options).
2873
2874 .vitem &%-bfd%&&~<&'domain'&>
2875 .oindex "&%-bfd%&"
2876 .vindex "&$qualify_domain$&"
2877 This sets the domain of the recipient address when a filter file is being
2878 tested by means of the &%-bf%& option. The default is the value of
2879 &$qualify_domain$&.
2880
2881 .vitem &%-bfl%&&~<&'local&~part'&>
2882 .oindex "&%-bfl%&"
2883 This sets the local part of the recipient address when a filter file is being
2884 tested by means of the &%-bf%& option. The default is the username of the
2885 process that calls Exim. A local part should be specified with any prefix or
2886 suffix stripped, because that is how it appears to the filter when a message is
2887 actually being delivered.
2888
2889 .vitem &%-bfp%&&~<&'prefix'&>
2890 .oindex "&%-bfp%&"
2891 This sets the prefix of the local part of the recipient address when a filter
2892 file is being tested by means of the &%-bf%& option. The default is an empty
2893 prefix.
2894
2895 .vitem &%-bfs%&&~<&'suffix'&>
2896 .oindex "&%-bfs%&"
2897 This sets the suffix of the local part of the recipient address when a filter
2898 file is being tested by means of the &%-bf%& option. The default is an empty
2899 suffix.
2900
2901 .vitem &%-bh%&&~<&'IP&~address'&>
2902 .oindex "&%-bh%&"
2903 .cindex "testing" "incoming SMTP"
2904 .cindex "SMTP" "testing incoming"
2905 .cindex "testing" "relay control"
2906 .cindex "relaying" "testing configuration"
2907 .cindex "policy control" "testing"
2908 .cindex "debugging" "&%-bh%& option"
2909 This option runs a fake SMTP session as if from the given IP address, using the
2910 standard input and output. The IP address may include a port number at the end,
2911 after a full stop. For example:
2912 .code
2913 exim -bh 10.9.8.7.1234
2914 exim -bh fe80::a00:20ff:fe86:a061.5678
2915 .endd
2916 When an IPv6 address is given, it is converted into canonical form. In the case
2917 of the second example above, the value of &$sender_host_address$& after
2918 conversion to the canonical form is
2919 &`fe80:0000:0000:0a00:20ff:fe86:a061.5678`&.
2920
2921 Comments as to what is going on are written to the standard error file. These
2922 include lines beginning with &"LOG"& for anything that would have been logged.
2923 This facility is provided for testing configuration options for incoming
2924 messages, to make sure they implement the required policy. For example, you can
2925 test your relay controls using &%-bh%&.
2926
2927 &*Warning 1*&:
2928 .cindex "RFC 1413"
2929 You can test features of the configuration that rely on ident (RFC 1413)
2930 information by using the &%-oMt%& option. However, Exim cannot actually perform
2931 an ident callout when testing using &%-bh%& because there is no incoming SMTP
2932 connection.
2933
2934 &*Warning 2*&: Address verification callouts (see section &<<SECTcallver>>&)
2935 are also skipped when testing using &%-bh%&. If you want these callouts to
2936 occur, use &%-bhc%& instead.
2937
2938 Messages supplied during the testing session are discarded, and nothing is
2939 written to any of the real log files. There may be pauses when DNS (and other)
2940 lookups are taking place, and of course these may time out. The &%-oMi%& option
2941 can be used to specify a specific IP interface and port if this is important,
2942 and &%-oMaa%& and &%-oMai%& can be used to set parameters as if the SMTP
2943 session were authenticated.
2944
2945 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%& whose
2946 output just states whether a given recipient address from a given host is
2947 acceptable or not. See section &<<SECTcheckaccess>>&.
2948
2949 Features such as authentication and encryption, where the client input is not
2950 plain text, cannot easily be tested with &%-bh%&. Instead, you should use a
2951 specialized SMTP test program such as
2952 &url(http://jetmore.org/john/code/#swaks,swaks).
2953
2954 .vitem &%-bhc%&&~<&'IP&~address'&>
2955 .oindex "&%-bhc%&"
2956 This option operates in the same way as &%-bh%&, except that address
2957 verification callouts are performed if required. This includes consulting and
2958 updating the callout cache database.
2959
2960 .vitem &%-bi%&
2961 .oindex "&%-bi%&"
2962 .cindex "alias file" "building"
2963 .cindex "building alias file"
2964 .cindex "Sendmail compatibility" "&%-bi%& option"
2965 Sendmail interprets the &%-bi%& option as a request to rebuild its alias file.
2966 Exim does not have the concept of a single alias file, and so it cannot mimic
2967 this behaviour. However, calls to &_/usr/lib/sendmail_& with the &%-bi%& option
2968 tend to appear in various scripts such as NIS make files, so the option must be
2969 recognized.
2970
2971 If &%-bi%& is encountered, the command specified by the &%bi_command%&
2972 configuration option is run, under the uid and gid of the caller of Exim. If
2973 the &%-oA%& option is used, its value is passed to the command as an argument.
2974 The command set by &%bi_command%& may not contain arguments. The command can
2975 use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files
2976 if this is required. If the &%bi_command%& option is not set, calling Exim with
2977 &%-bi%& is a no-op.
2978
2979 . // Keep :help first, then the rest in alphabetical order
2980 .vitem &%-bI:help%&
2981 .oindex "&%-bI:help%&"
2982 .cindex "querying exim information"
2983 We shall provide various options starting &`-bI:`& for querying Exim for
2984 information.  The output of many of these will be intended for machine
2985 consumption.  This one is not.  The &%-bI:help%& option asks Exim for a
2986 synopsis of supported options beginning &`-bI:`&.  Use of any of these
2987 options shall cause Exim to exit after producing the requested output.
2988
2989 .vitem &%-bI:dscp%&
2990 .oindex "&%-bI:dscp%&"
2991 .cindex "DSCP" "values"
2992 This option causes Exim to emit an alphabetically sorted list of all
2993 recognised DSCP names.
2994
2995 .vitem &%-bI:sieve%&
2996 .oindex "&%-bI:sieve%&"
2997 .cindex "Sieve filter" "capabilities"
2998 This option causes Exim to emit an alphabetically sorted list of all supported
2999 Sieve protocol extensions on stdout, one per line.  This is anticipated to be
3000 useful for ManageSieve (RFC 5804) implementations, in providing that protocol's
3001 &`SIEVE`& capability response line.  As the precise list may depend upon
3002 compile-time build options, which this option will adapt to, this is the only
3003 way to guarantee a correct response.
3004
3005 .vitem &%-bm%&
3006 .oindex "&%-bm%&"
3007 .cindex "local message reception"
3008 This option runs an Exim receiving process that accepts an incoming,
3009 locally-generated message on the standard input. The recipients are given as the
3010 command arguments (except when &%-t%& is also present &-- see below). Each
3011 argument can be a comma-separated list of RFC 2822 addresses. This is the
3012 default option for selecting the overall action of an Exim call; it is assumed
3013 if no other conflicting option is present.
3014
3015 If any addresses in the message are unqualified (have no domain), they are
3016 qualified by the values of the &%qualify_domain%& or &%qualify_recipient%&
3017 options, as appropriate. The &%-bnq%& option (see below) provides a way of
3018 suppressing this for special cases.
3019
3020 Policy checks on the contents of local messages can be enforced by means of
3021 the non-SMTP ACL. See chapter &<<CHAPACL>>& for details.
3022
3023 .cindex "return code" "for &%-bm%&"
3024 The return code is zero if the message is successfully accepted. Otherwise, the
3025 action is controlled by the &%-oe%&&'x'& option setting &-- see below.
3026
3027 The format
3028 .cindex "message" "format"
3029 .cindex "format" "message"
3030 .cindex "&""From""& line"
3031 .cindex "UUCP" "&""From""& line"
3032 .cindex "Sendmail compatibility" "&""From""& line"
3033 of the message must be as defined in RFC 2822, except that, for
3034 compatibility with Sendmail and Smail, a line in one of the forms
3035 .code
3036 From sender Fri Jan  5 12:55 GMT 1997
3037 From sender Fri, 5 Jan 97 12:55:01
3038 .endd
3039 (with the weekday optional, and possibly with additional text after the date)
3040 is permitted to appear at the start of the message. There appears to be no
3041 authoritative specification of the format of this line. Exim recognizes it by
3042 matching against the regular expression defined by the &%uucp_from_pattern%&
3043 option, which can be changed if necessary.
3044
3045 .oindex "&%-f%&" "overriding &""From""& line"
3046 The specified sender is treated as if it were given as the argument to the
3047 &%-f%& option, but if a &%-f%& option is also present, its argument is used in
3048 preference to the address taken from the message. The caller of Exim must be a
3049 trusted user for the sender of a message to be set in this way.
3050
3051 .vitem &%-bmalware%&&~<&'filename'&>
3052 .oindex "&%-bmalware%&"
3053 .cindex "testing", "malware"
3054 .cindex "malware scan test"
3055 This debugging option causes Exim to scan the given file,
3056 using the malware scanning framework.  The option of &%av_scanner%& influences
3057 this option, so if &%av_scanner%&'s value is dependent upon an expansion then
3058 the expansion should have defaults which apply to this invocation.  ACLs are
3059 not invoked, so if &%av_scanner%& references an ACL variable then that variable
3060 will never be populated and &%-bmalware%& will fail.
3061
3062 Exim will have changed working directory before resolving the filename, so
3063 using fully qualified pathnames is advisable.  Exim will be running as the Exim
3064 user when it tries to open the file, rather than as the invoking user.
3065 This option requires admin privileges.
3066
3067 The &%-bmalware%& option will not be extended to be more generally useful,
3068 there are better tools for file-scanning.  This option exists to help
3069 administrators verify their Exim and AV scanner configuration.
3070
3071 .vitem &%-bnq%&
3072 .oindex "&%-bnq%&"
3073 .cindex "address qualification, suppressing"
3074 By default, Exim automatically qualifies unqualified addresses (those
3075 without domains) that appear in messages that are submitted locally (that
3076 is, not over TCP/IP). This qualification applies both to addresses in
3077 envelopes, and addresses in header lines. Sender addresses are qualified using
3078 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
3079 defaults to the value of &%qualify_domain%&).
3080
3081 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
3082 being used to re-submit messages that originally came from remote hosts after
3083 content scanning, you probably do not want to qualify unqualified addresses in
3084 header lines. (Such lines will be present only if you have not enabled a header
3085 syntax check in the appropriate ACL.)
3086
3087 The &%-bnq%& option suppresses all qualification of unqualified addresses in
3088 messages that originate on the local host. When this is used, unqualified
3089 addresses in the envelope provoke errors (causing message rejection) and
3090 unqualified addresses in header lines are left alone.
3091
3092
3093 .vitem &%-bP%&
3094 .oindex "&%-bP%&"
3095 .cindex "configuration options" "extracting"
3096 .cindex "options" "configuration &-- extracting"
3097 If this option is given with no arguments, it causes the values of all Exim's
3098 main configuration options to be written to the standard output. The values
3099 of one or more specific options can be requested by giving their names as
3100 arguments, for example:
3101 .code
3102 exim -bP qualify_domain hold_domains
3103 .endd
3104 .cindex "hiding configuration option values"
3105 .cindex "configuration options" "hiding value of"
3106 .cindex "options" "hiding value of"
3107 However, any option setting that is preceded by the word &"hide"& in the
3108 configuration file is not shown in full, except to an admin user. For other
3109 users, the output is as in this example:
3110 .code
3111 mysql_servers = <value not displayable>
3112 .endd
3113 If &%configure_file%& is given as an argument, the name of the run time
3114 configuration file is output.
3115 If a list of configuration files was supplied, the value that is output here
3116 is the name of the file that was actually used.
3117
3118 .cindex "options" "hiding name of"
3119 If the &%-n%& flag is given, then for most modes of &%-bP%& operation the
3120 name will not be output.
3121
3122 .cindex "daemon" "process id (pid)"
3123 .cindex "pid (process id)" "of daemon"
3124 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
3125 directories where log files and daemon pid files are written are output,
3126 respectively. If these values are unset, log files are written in a
3127 sub-directory of the spool directory called &%log%&, and the pid file is
3128 written directly into the spool directory.
3129
3130 If &%-bP%& is followed by a name preceded by &`+`&, for example,
3131 .code
3132 exim -bP +local_domains
3133 .endd
3134 it searches for a matching named list of any type (domain, host, address, or
3135 local part) and outputs what it finds.
3136
3137 .cindex "options" "router &-- extracting"
3138 .cindex "options" "transport &-- extracting"
3139 .cindex "options" "authenticator &-- extracting"
3140 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
3141 followed by the name of an appropriate driver instance, the option settings for
3142 that driver are output. For example:
3143 .code
3144 exim -bP transport local_delivery
3145 .endd
3146 The generic driver options are output first, followed by the driver's private
3147 options. A list of the names of drivers of a particular type can be obtained by
3148 using one of the words &%router_list%&, &%transport_list%&, or
3149 &%authenticator_list%&, and a complete list of all drivers with their option
3150 settings can be obtained by using &%routers%&, &%transports%&, or
3151 &%authenticators%&.
3152
3153 .cindex "options" "macro &-- extracting"
3154 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3155 are available, similarly to the drivers.  Because macros are sometimes used
3156 for storing passwords, this option is restricted.
3157 The output format is one item per line.
3158
3159 .vitem &%-bp%&
3160 .oindex "&%-bp%&"
3161 .cindex "queue" "listing messages on"
3162 .cindex "listing" "messages on the queue"
3163 This option requests a listing of the contents of the mail queue on the
3164 standard output. If the &%-bp%& option is followed by a list of message ids,
3165 just those messages are listed. By default, this option can be used only by an
3166 admin user. However, the &%queue_list_requires_admin%& option can be set false
3167 to allow any user to see the queue.
3168
3169 Each message on the queue is displayed as in the following example:
3170 .code
3171 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3172           red.king@looking-glass.fict.example
3173           <other addresses>
3174 .endd
3175 .cindex "message" "size in queue listing"
3176 .cindex "size" "of message"
3177 The first line contains the length of time the message has been on the queue
3178 (in this case 25 minutes), the size of the message (2.9K), the unique local
3179 identifier for the message, and the message sender, as contained in the
3180 envelope. For bounce messages, the sender address is empty, and appears as
3181 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3182 the default sender address, the user's login name is shown in parentheses
3183 before the sender address.
3184
3185 .cindex "frozen messages" "in queue listing"
3186 If the message is frozen (attempts to deliver it are suspended) then the text
3187 &"*** frozen ***"& is displayed at the end of this line.
3188
3189 The recipients of the message (taken from the envelope, not the headers) are
3190 displayed on subsequent lines. Those addresses to which the message has already
3191 been delivered are marked with the letter D. If an original address gets
3192 expanded into several addresses via an alias or forward file, the original is
3193 displayed with a D only when deliveries for all of its child addresses are
3194 complete.
3195
3196
3197 .vitem &%-bpa%&
3198 .oindex "&%-bpa%&"
3199 This option operates like &%-bp%&, but in addition it shows delivered addresses
3200 that were generated from the original top level address(es) in each message by
3201 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3202 of just &"D"&.
3203
3204
3205 .vitem &%-bpc%&
3206 .oindex "&%-bpc%&"
3207 .cindex "queue" "count of messages on"
3208 This option counts the number of messages on the queue, and writes the total
3209 to the standard output. It is restricted to admin users, unless
3210 &%queue_list_requires_admin%& is set false.
3211
3212
3213 .vitem &%-bpr%&
3214 .oindex "&%-bpr%&"
3215 This option operates like &%-bp%&, but the output is not sorted into
3216 chronological order of message arrival. This can speed it up when there are
3217 lots of messages on the queue, and is particularly useful if the output is
3218 going to be post-processed in a way that doesn't need the sorting.
3219
3220 .vitem &%-bpra%&
3221 .oindex "&%-bpra%&"
3222 This option is a combination of &%-bpr%& and &%-bpa%&.
3223
3224 .vitem &%-bpru%&
3225 .oindex "&%-bpru%&"
3226 This option is a combination of &%-bpr%& and &%-bpu%&.
3227
3228
3229 .vitem &%-bpu%&
3230 .oindex "&%-bpu%&"
3231 This option operates like &%-bp%& but shows only undelivered top-level
3232 addresses for each message displayed. Addresses generated by aliasing or
3233 forwarding are not shown, unless the message was deferred after processing by a
3234 router with the &%one_time%& option set.
3235
3236
3237 .vitem &%-brt%&
3238 .oindex "&%-brt%&"
3239 .cindex "testing" "retry configuration"
3240 .cindex "retry" "configuration testing"
3241 This option is for testing retry rules, and it must be followed by up to three
3242 arguments. It causes Exim to look for a retry rule that matches the values
3243 and to write it to the standard output. For example:
3244 .code
3245 exim -brt bach.comp.mus.example
3246 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3247 .endd
3248 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3249 argument, which is required, can be a complete address in the form
3250 &'local_part@domain'&, or it can be just a domain name. If the second argument
3251 contains a dot, it is interpreted as an optional second domain name; if no
3252 retry rule is found for the first argument, the second is tried. This ties in
3253 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3254 rule is found that matches the host, one that matches the mail domain is
3255 sought. Finally, an argument that is the name of a specific delivery error, as
3256 used in setting up retry rules, can be given. For example:
3257 .code
3258 exim -brt haydn.comp.mus.example quota_3d
3259 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3260 .endd
3261
3262 .vitem &%-brw%&
3263 .oindex "&%-brw%&"
3264 .cindex "testing" "rewriting"
3265 .cindex "rewriting" "testing"
3266 This option is for testing address rewriting rules, and it must be followed by
3267 a single argument, consisting of either a local part without a domain, or a
3268 complete address with a fully qualified domain. Exim outputs how this address
3269 would be rewritten for each possible place it might appear. See chapter
3270 &<<CHAPrewrite>>& for further details.
3271
3272 .vitem &%-bS%&
3273 .oindex "&%-bS%&"
3274 .cindex "SMTP" "batched incoming"
3275 .cindex "batched SMTP input"
3276 This option is used for batched SMTP input, which is an alternative interface
3277 for non-interactive local message submission. A number of messages can be
3278 submitted in a single run. However, despite its name, this is not really SMTP
3279 input. Exim reads each message's envelope from SMTP commands on the standard
3280 input, but generates no responses. If the caller is trusted, or
3281 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3282 believed; otherwise the sender is always the caller of Exim.
3283
3284 The message itself is read from the standard input, in SMTP format (leading
3285 dots doubled), terminated by a line containing just a single dot. An error is
3286 provoked if the terminating dot is missing. A further message may then follow.
3287
3288 As for other local message submissions, the contents of incoming batch SMTP
3289 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3290 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3291 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3292
3293 Some other SMTP commands are recognized in the input. HELO and EHLO act
3294 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3295 QUIT quits, ignoring the rest of the standard input.
3296
3297 .cindex "return code" "for &%-bS%&"
3298 If any error is encountered, reports are written to the standard output and
3299 error streams, and Exim gives up immediately. The return code is 0 if no error
3300 was detected; it is 1 if one or more messages were accepted before the error
3301 was detected; otherwise it is 2.
3302
3303 More details of input using batched SMTP are given in section
3304 &<<SECTincomingbatchedSMTP>>&.
3305
3306 .vitem &%-bs%&
3307 .oindex "&%-bs%&"
3308 .cindex "SMTP" "local input"
3309 .cindex "local SMTP input"
3310 This option causes Exim to accept one or more messages by reading SMTP commands
3311 on the standard input, and producing SMTP replies on the standard output. SMTP
3312 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3313 Some user agents use this interface as a way of passing locally-generated
3314 messages to the MTA.
3315
3316 In
3317 .cindex "sender" "source of"
3318 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3319 set, the senders of messages are taken from the SMTP MAIL commands.
3320 Otherwise the content of these commands is ignored and the sender is set up as
3321 the calling user. Unqualified addresses are automatically qualified using
3322 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3323 &%-bnq%& option is used.
3324
3325 .cindex "inetd"
3326 The
3327 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3328 using a listening daemon. Exim can distinguish the two cases by checking
3329 whether the standard input is a TCP/IP socket. When Exim is called from
3330 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3331 above concerning senders and qualification do not apply. In this situation,
3332 Exim behaves in exactly the same way as it does when receiving a message via
3333 the listening daemon.
3334
3335 .vitem &%-bt%&
3336 .oindex "&%-bt%&"
3337 .cindex "testing" "addresses"
3338 .cindex "address" "testing"
3339 This option runs Exim in address testing mode, in which each argument is taken
3340 as a recipient address to be tested for deliverability. The results are
3341 written to the standard output. If a test fails, and the caller is not an admin
3342 user, no details of the failure are output, because these might contain
3343 sensitive information such as usernames and passwords for database lookups.
3344
3345 If no arguments are given, Exim runs in an interactive manner, prompting with a
3346 right angle bracket for addresses to be tested.
3347
3348 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3349 &[readline()]& function, because it is running as &'root'& and there are
3350 security issues.
3351
3352 Each address is handled as if it were the recipient address of a message
3353 (compare the &%-bv%& option). It is passed to the routers and the result is
3354 written to the standard output. However, any router that has
3355 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3356 genuine routing tests if your first router passes everything to a scanner
3357 program.
3358
3359 .cindex "return code" "for &%-bt%&"
3360 The return code is 2 if any address failed outright; it is 1 if no address
3361 failed outright but at least one could not be resolved for some reason. Return
3362 code 0 is given only when all addresses succeed.
3363
3364 .cindex "duplicate addresses"
3365 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3366 addresses after routing is complete, so that only one delivery takes place.
3367 This does not happen when testing with &%-bt%&; the full results of routing are
3368 always shown.
3369
3370 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3371 routers in the configuration makes any tests on the sender address of a
3372 message,
3373 .oindex "&%-f%&" "for address testing"
3374 you can use the &%-f%& option to set an appropriate sender when running
3375 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3376 default qualifying domain. However, if you have set up (for example) routers
3377 whose behaviour depends on the contents of an incoming message, you cannot test
3378 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3379 doing such tests.
3380
3381 .vitem &%-bV%&
3382 .oindex "&%-bV%&"
3383 .cindex "version number of Exim"
3384 This option causes Exim to write the current version number, compilation
3385 number, and compilation date of the &'exim'& binary to the standard output.
3386 It also lists the DBM library that is being used, the optional modules (such as
3387 specific lookup types), the drivers that are included in the binary, and the
3388 name of the run time configuration file that is in use.
3389
3390 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3391 configuration file. However, this is a static check only. It cannot check
3392 values that are to be expanded. For example, although a misspelt ACL verb is
3393 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3394 alone to discover (for example) all the typos in the configuration; some
3395 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3396 dynamic testing facilities.
3397
3398 .vitem &%-bv%&
3399 .oindex "&%-bv%&"
3400 .cindex "verifying address" "using &%-bv%&"
3401 .cindex "address" "verification"
3402 This option runs Exim in address verification mode, in which each argument is
3403 taken as a recipient address to be verified by the routers. (This does
3404 not involve any verification callouts). During normal operation, verification
3405 happens mostly as a consequence processing a &%verify%& condition in an ACL
3406 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3407 including callouts, see the &%-bh%& and &%-bhc%& options.
3408
3409 If verification fails, and the caller is not an admin user, no details of the
3410 failure are output, because these might contain sensitive information such as
3411 usernames and passwords for database lookups.
3412
3413 If no arguments are given, Exim runs in an interactive manner, prompting with a
3414 right angle bracket for addresses to be verified.
3415
3416 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3417 &[readline()]& function, because it is running as &'exim'& and there are
3418 security issues.
3419
3420 Verification differs from address testing (the &%-bt%& option) in that routers
3421 that have &%no_verify%& set are skipped, and if the address is accepted by a
3422 router that has &%fail_verify%& set, verification fails. The address is
3423 verified as a recipient if &%-bv%& is used; to test verification for a sender
3424 address, &%-bvs%& should be used.
3425
3426 If the &%-v%& option is not set, the output consists of a single line for each
3427 address, stating whether it was verified or not, and giving a reason in the
3428 latter case. Without &%-v%&, generating more than one address by redirection
3429 causes verification to end successfully, without considering the generated
3430 addresses. However, if just one address is generated, processing continues,
3431 and the generated address must verify successfully for the overall verification
3432 to succeed.
3433
3434 When &%-v%& is set, more details are given of how the address has been handled,
3435 and in the case of address redirection, all the generated addresses are also
3436 considered. Verification may succeed for some and fail for others.
3437
3438 The
3439 .cindex "return code" "for &%-bv%&"
3440 return code is 2 if any address failed outright; it is 1 if no address
3441 failed outright but at least one could not be resolved for some reason. Return
3442 code 0 is given only when all addresses succeed.
3443
3444 If any of the routers in the configuration makes any tests on the sender
3445 address of a message, you should use the &%-f%& option to set an appropriate
3446 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3447 calling user at the default qualifying domain.
3448
3449 .vitem &%-bvs%&
3450 .oindex "&%-bvs%&"
3451 This option acts like &%-bv%&, but verifies the address as a sender rather
3452 than a recipient address. This affects any rewriting and qualification that
3453 might happen.
3454
3455 .vitem &%-bw%&
3456 .oindex "&%-bw%&"
3457 .cindex "daemon"
3458 .cindex "inetd"
3459 .cindex "inetd" "wait mode"
3460 This option runs Exim as a daemon, awaiting incoming SMTP connections,
3461 similarly to the &%-bd%& option.  All port specifications on the command-line
3462 and in the configuration file are ignored.  Queue-running may not be specified.
3463
3464 In this mode, Exim expects to be passed a socket as fd 0 (stdin) which is
3465 listening for connections.  This permits the system to start up and have
3466 inetd (or equivalent) listen on the SMTP ports, starting an Exim daemon for
3467 each port only when the first connection is received.
3468
3469 If the option is given as &%-bw%&<&'time'&> then the time is a timeout, after
3470 which the daemon will exit, which should cause inetd to listen once more.
3471
3472 .vitem &%-C%&&~<&'filelist'&>
3473 .oindex "&%-C%&"
3474 .cindex "configuration file" "alternate"
3475 .cindex "CONFIGURE_FILE"
3476 .cindex "alternate configuration file"
3477 This option causes Exim to find the run time configuration file from the given
3478 list instead of from the list specified by the CONFIGURE_FILE
3479 compile-time setting. Usually, the list will consist of just a single file
3480 name, but it can be a colon-separated list of names. In this case, the first
3481 file that exists is used. Failure to open an existing file stops Exim from
3482 proceeding any further along the list, and an error is generated.
3483
3484 When this option is used by a caller other than root, and the list is different
3485 from the compiled-in list, Exim gives up its root privilege immediately, and
3486 runs with the real and effective uid and gid set to those of the caller.
3487 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3488 file contains a list of full pathnames, one per line, for configuration files
3489 which are trusted. Root privilege is retained for any configuration file so
3490 listed, as long as the caller is the Exim user (or the user specified in the
3491 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3492 not writeable by inappropriate users or groups.
3493
3494 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3495 configuration using &%-C%& right through message reception and delivery,
3496 even if the caller is root. The reception works, but by that time, Exim is
3497 running as the Exim user, so when it re-executes to regain privilege for the
3498 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3499 test reception and delivery using two separate commands (one to put a message
3500 on the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3501
3502 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3503 prefix string with which any file named in a &%-C%& command line option
3504 must start. In addition, the file name must not contain the sequence &`/../`&.
3505 However, if the value of the &%-C%& option is identical to the value of
3506 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3507 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3508 unset, any file name can be used with &%-C%&.
3509
3510 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3511 to a directory to which only root has access. This prevents someone who has
3512 broken into the Exim account from running a privileged Exim with an arbitrary
3513 configuration file.
3514
3515 The &%-C%& facility is useful for ensuring that configuration files are
3516 syntactically correct, but cannot be used for test deliveries, unless the
3517 caller is privileged, or unless it is an exotic configuration that does not
3518 require privilege. No check is made on the owner or group of the files
3519 specified by this option.
3520
3521
3522 .vitem &%-D%&<&'macro'&>=<&'value'&>
3523 .oindex "&%-D%&"
3524 .cindex "macro" "setting on command line"
3525 This option can be used to override macro definitions in the configuration file
3526 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3527 unprivileged caller, it causes Exim to give up its root privilege.
3528 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3529 completely disabled, and its use causes an immediate error exit.
3530
3531 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3532 colon-separated list of macros which are considered safe and, if &%-D%& only
3533 supplies macros from this list, and the values are acceptable, then Exim will
3534 not give up root privilege if the caller is root, the Exim run-time user, or
3535 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3536 to be removed in the future.  Acceptable values for the macros satisfy the
3537 regexp: &`^[A-Za-z0-9_/.-]*$`&
3538
3539 The entire option (including equals sign if present) must all be within one
3540 command line item. &%-D%& can be used to set the value of a macro to the empty
3541 string, in which case the equals sign is optional. These two commands are
3542 synonymous:
3543 .code
3544 exim -DABC  ...
3545 exim -DABC= ...
3546 .endd
3547 To include spaces in a macro definition item, quotes must be used. If you use
3548 quotes, spaces are permitted around the macro name and the equals sign. For
3549 example:
3550 .code
3551 exim '-D ABC = something' ...
3552 .endd
3553 &%-D%& may be repeated up to 10 times on a command line.
3554
3555
3556 .vitem &%-d%&<&'debug&~options'&>
3557 .oindex "&%-d%&"
3558 .cindex "debugging" "list of selectors"
3559 .cindex "debugging" "&%-d%& option"
3560 This option causes debugging information to be written to the standard
3561 error stream. It is restricted to admin users because debugging output may show
3562 database queries that contain password information. Also, the details of users'
3563 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3564 writes an error message to the standard error stream and exits with a non-zero
3565 return code.
3566
3567 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3568 standard debugging data is output. This can be reduced, or increased to include
3569 some more rarely needed information, by directly following &%-d%& with a string
3570 made up of names preceded by plus or minus characters. These add or remove sets
3571 of debugging data, respectively. For example, &%-d+filter%& adds filter
3572 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3573 no spaces are allowed in the debug setting. The available debugging categories
3574 are:
3575 .display
3576 &`acl            `& ACL interpretation
3577 &`auth           `& authenticators
3578 &`deliver        `& general delivery logic
3579 &`dns            `& DNS lookups (see also resolver)
3580 &`dnsbl          `& DNS black list (aka RBL) code
3581 &`exec           `& arguments for &[execv()]& calls
3582 &`expand         `& detailed debugging for string expansions
3583 &`filter         `& filter handling
3584 &`hints_lookup   `& hints data lookups
3585 &`host_lookup    `& all types of name-to-IP address handling
3586 &`ident          `& ident lookup
3587 &`interface      `& lists of local interfaces
3588 &`lists          `& matching things in lists
3589 &`load           `& system load checks
3590 &`local_scan     `& can be used by &[local_scan()]& (see chapter &&&
3591                     &<<CHAPlocalscan>>&)
3592 &`lookup         `& general lookup code and all lookups
3593 &`memory         `& memory handling
3594 &`pid            `& add pid to debug output lines
3595 &`process_info   `& setting info for the process log
3596 &`queue_run      `& queue runs
3597 &`receive        `& general message reception logic
3598 &`resolver       `& turn on the DNS resolver's debugging output
3599 &`retry          `& retry handling
3600 &`rewrite        `& address rewriting
3601 &`route          `& address routing
3602 &`timestamp      `& add timestamp to debug output lines
3603 &`tls            `& TLS logic
3604 &`transport      `& transports
3605 &`uid            `& changes of uid/gid and looking up uid/gid
3606 &`verify         `& address verification logic
3607 &`all            `& almost all of the above (see below), and also &%-v%&
3608 .endd
3609 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3610 for &`-all`&. The reason for this is that &`+all`& is something that people
3611 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3612 is included, an awful lot of output that is very rarely of interest is
3613 generated, so it now has to be explicitly requested. However, &`-all`& does
3614 turn everything off.
3615
3616 .cindex "resolver, debugging output"
3617 .cindex "DNS resolver, debugging output"
3618 The &`resolver`& option produces output only if the DNS resolver was compiled
3619 with DEBUG enabled. This is not the case in some operating systems. Also,
3620 unfortunately, debugging output from the DNS resolver is written to stdout
3621 rather than stderr.
3622
3623 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3624 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3625 However, the &`pid`& selector is forced when debugging is turned on for a
3626 daemon, which then passes it on to any re-executed Exims. Exim also
3627 automatically adds the pid to debug lines when several remote deliveries are
3628 run in parallel.
3629
3630 The &`timestamp`& selector causes the current time to be inserted at the start
3631 of all debug output lines. This can be useful when trying to track down delays
3632 in processing.
3633
3634 If the &%debug_print%& option is set in any driver, it produces output whenever
3635 any debugging is selected, or if &%-v%& is used.
3636
3637 .vitem &%-dd%&<&'debug&~options'&>
3638 .oindex "&%-dd%&"
3639 This option behaves exactly like &%-d%& except when used on a command that
3640 starts a daemon process. In that case, debugging is turned off for the
3641 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3642 behaviour of the daemon without creating as much output as full debugging does.
3643
3644 .vitem &%-dropcr%&
3645 .oindex "&%-dropcr%&"
3646 This is an obsolete option that is now a no-op. It used to affect the way Exim
3647 handled CR and LF characters in incoming messages. What happens now is
3648 described in section &<<SECTlineendings>>&.
3649
3650 .vitem &%-E%&
3651 .oindex "&%-E%&"
3652 .cindex "bounce message" "generating"
3653 This option specifies that an incoming message is a locally-generated delivery
3654 failure report. It is used internally by Exim when handling delivery failures
3655 and is not intended for external use. Its only effect is to stop Exim
3656 generating certain messages to the postmaster, as otherwise message cascades
3657 could occur in some situations. As part of the same option, a message id may
3658 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3659 new message contains the id, following &"R="&, as a cross-reference.
3660
3661 .vitem &%-e%&&'x'&
3662 .oindex "&%-e%&&'x'&"
3663 There are a number of Sendmail options starting with &%-oe%& which seem to be
3664 called by various programs without the leading &%o%& in the option. For
3665 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3666 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3667
3668 .vitem &%-F%&&~<&'string'&>
3669 .oindex "&%-F%&"
3670 .cindex "sender" "name"
3671 .cindex "name" "of sender"
3672 This option sets the sender's full name for use when a locally-generated
3673 message is being accepted. In the absence of this option, the user's &'gecos'&
3674 entry from the password data is used. As users are generally permitted to alter
3675 their &'gecos'& entries, no security considerations are involved. White space
3676 between &%-F%& and the <&'string'&> is optional.
3677
3678 .vitem &%-f%&&~<&'address'&>
3679 .oindex "&%-f%&"
3680 .cindex "sender" "address"
3681 .cindex "address" "sender"
3682 .cindex "trusted users"
3683 .cindex "envelope sender"
3684 .cindex "user" "trusted"
3685 This option sets the address of the envelope sender of a locally-generated
3686 message (also known as the return path). The option can normally be used only
3687 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3688 users to use it.
3689
3690 Processes running as root or the Exim user are always trusted. Other
3691 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3692 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3693 of a local message is set to the caller's login name at the default qualify
3694 domain.
3695
3696 There is one exception to the restriction on the use of &%-f%&: an empty sender
3697 can be specified by any user, trusted or not, to create a message that can
3698 never provoke a bounce. An empty sender can be specified either as an empty
3699 string, or as a pair of angle brackets with nothing between them, as in these
3700 examples of shell commands:
3701 .code
3702 exim -f '<>' user@domain
3703 exim -f "" user@domain
3704 .endd
3705 In addition, the use of &%-f%& is not restricted when testing a filter file
3706 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3707 &%-bv%& options.
3708
3709 Allowing untrusted users to change the sender address does not of itself make
3710 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3711 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3712 though this can be overridden by setting &%no_local_from_check%&.
3713
3714 White
3715 .cindex "&""From""& line"
3716 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3717 given as two arguments or one combined argument). The sender of a
3718 locally-generated message can also be set (when permitted) by an initial
3719 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3720 if &%-f%& is also present, it overrides &"From&~"&.
3721
3722 .vitem &%-G%&
3723 .oindex "&%-G%&"
3724 .cindex "submission fixups, suppressing (command-line)"
3725 This option is equivalent to an ACL applying:
3726 .code
3727 control = suppress_local_fixups
3728 .endd
3729 for every message received.  Note that Sendmail will complain about such
3730 bad formatting, where Exim silently just does not fix it up.  This may change
3731 in future.
3732
3733 As this affects audit information, the caller must be a trusted user to use
3734 this option.
3735
3736 .vitem &%-h%&&~<&'number'&>
3737 .oindex "&%-h%&"
3738 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3739 This option is accepted for compatibility with Sendmail, but has no effect. (In
3740 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3741 headers.)
3742
3743 .vitem &%-i%&
3744 .oindex "&%-i%&"
3745 .cindex "Solaris" "&'mail'& command"
3746 .cindex "dot" "in incoming non-SMTP message"
3747 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3748 line by itself should not terminate an incoming, non-SMTP message. I can find
3749 no documentation for this option in Solaris 2.4 Sendmail, but the &'mailx'&
3750 command in Solaris 2.4 uses it. See also &%-ti%&.
3751
3752 .vitem &%-L%&&~<&'tag'&>
3753 .oindex "&%-L%&"
3754 .cindex "syslog" "process name; set with flag"
3755 This option is equivalent to setting &%syslog_processname%& in the config
3756 file and setting &%log_file_path%& to &`syslog`&.
3757 Its use is restricted to administrators.  The configuration file has to be
3758 read and parsed, to determine access rights, before this is set and takes
3759 effect, so early configuration file errors will not honour this flag.
3760
3761 The tag should not be longer than 32 characters.
3762
3763 .vitem &%-M%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3764 .oindex "&%-M%&"
3765 .cindex "forcing delivery"
3766 .cindex "delivery" "forcing attempt"
3767 .cindex "frozen messages" "forcing delivery"
3768 This option requests Exim to run a delivery attempt on each message in turn. If
3769 any of the messages are frozen, they are automatically thawed before the
3770 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3771 and &%hold_domains%& are ignored.
3772
3773 Retry
3774 .cindex "hints database" "overriding retry hints"
3775 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3776 the normal retry time has not yet been reached. This option requires the caller
3777 to be an admin user. However, there is an option called &%prod_requires_admin%&
3778 which can be set false to relax this restriction (and also the same requirement
3779 for the &%-q%&, &%-R%&, and &%-S%& options).
3780
3781 The deliveries happen synchronously, that is, the original Exim process does
3782 not terminate until all the delivery attempts have finished. No output is
3783 produced unless there is a serious error. If you want to see what is happening,
3784 use the &%-v%& option as well, or inspect Exim's main log.
3785
3786 .vitem &%-Mar%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3787 .oindex "&%-Mar%&"
3788 .cindex "message" "adding recipients"
3789 .cindex "recipient" "adding"
3790 This option requests Exim to add the addresses to the list of recipients of the
3791 message (&"ar"& for &"add recipients"&). The first argument must be a message
3792 id, and the remaining ones must be email addresses. However, if the message is
3793 active (in the middle of a delivery attempt), it is not altered. This option
3794 can be used only by an admin user.
3795
3796 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&~<&'sequence&~number'&>&&&
3797         &~<&'message&~id'&>"
3798 .oindex "&%-MC%&"
3799 .cindex "SMTP" "passed connection"
3800 .cindex "SMTP" "multiple deliveries"
3801 .cindex "multiple SMTP deliveries"
3802 This option is not intended for use by external callers. It is used internally
3803 by Exim to invoke another instance of itself to deliver a waiting message using
3804 an existing SMTP connection, which is passed as the standard input. Details are
3805 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3806 must be root or the Exim user in order to use it.
3807
3808 .vitem &%-MCA%&
3809 .oindex "&%-MCA%&"
3810 This option is not intended for use by external callers. It is used internally
3811 by Exim in conjunction with the &%-MC%& option. It signifies that the
3812 connection to the remote host has been authenticated.
3813
3814 .vitem &%-MCP%&
3815 .oindex "&%-MCP%&"
3816 This option is not intended for use by external callers. It is used internally
3817 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3818 which Exim is connected supports pipelining.
3819
3820 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3821 .oindex "&%-MCQ%&"
3822 This option is not intended for use by external callers. It is used internally
3823 by Exim in conjunction with the &%-MC%& option when the original delivery was
3824 started by a queue runner. It passes on the process id of the queue runner,
3825 together with the file descriptor number of an open pipe. Closure of the pipe
3826 signals the final completion of the sequence of processes that are passing
3827 messages through the same SMTP connection.
3828
3829 .vitem &%-MCS%&
3830 .oindex "&%-MCS%&"
3831 This option is not intended for use by external callers. It is used internally
3832 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3833 SMTP SIZE option should be used on messages delivered down the existing
3834 connection.
3835
3836 .vitem &%-MCT%&
3837 .oindex "&%-MCT%&"
3838 This option is not intended for use by external callers. It is used internally
3839 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3840 host to which Exim is connected supports TLS encryption.
3841
3842 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3843 .oindex "&%-Mc%&"
3844 .cindex "hints database" "not overridden by &%-Mc%&"
3845 .cindex "delivery" "manually started &-- not forced"
3846 This option requests Exim to run a delivery attempt on each message in turn,
3847 but unlike the &%-M%& option, it does check for retry hints, and respects any
3848 that are found. This option is not very useful to external callers. It is
3849 provided mainly for internal use by Exim when it needs to re-invoke itself in
3850 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3851 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3852 respects retry times and other options such as &%hold_domains%& that are
3853 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3854 If you want to run a specific delivery as if in a queue run, you should use
3855 &%-q%& with a message id argument. A distinction between queue run deliveries
3856 and other deliveries is made in one or two places.
3857
3858 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
3859 .oindex "&%-Mes%&"
3860 .cindex "message" "changing sender"
3861 .cindex "sender" "changing"
3862 This option requests Exim to change the sender address in the message to the
3863 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3864 &"edit sender"&). There must be exactly two arguments. The first argument must
3865 be a message id, and the second one an email address. However, if the message
3866 is active (in the middle of a delivery attempt), its status is not altered.
3867 This option can be used only by an admin user.
3868
3869 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3870 .oindex "&%-Mf%&"
3871 .cindex "freezing messages"
3872 .cindex "message" "manually freezing"
3873 This option requests Exim to mark each listed message as &"frozen"&. This
3874 prevents any delivery attempts taking place until the message is &"thawed"&,
3875 either manually or as a result of the &%auto_thaw%& configuration option.
3876 However, if any of the messages are active (in the middle of a delivery
3877 attempt), their status is not altered. This option can be used only by an admin
3878 user.
3879
3880 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3881 .oindex "&%-Mg%&"
3882 .cindex "giving up on messages"
3883 .cindex "message" "abandoning delivery attempts"
3884 .cindex "delivery" "abandoning further attempts"
3885 This option requests Exim to give up trying to deliver the listed messages,
3886 including any that are frozen. However, if any of the messages are active,
3887 their status is not altered. For non-bounce messages, a delivery error message
3888 is sent to the sender, containing the text &"cancelled by administrator"&.
3889 Bounce messages are just discarded. This option can be used only by an admin
3890 user.
3891
3892 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3893 .oindex "&%-Mmad%&"
3894 .cindex "delivery" "cancelling all"
3895 This option requests Exim to mark all the recipient addresses in the messages
3896 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
3897 message is active (in the middle of a delivery attempt), its status is not
3898 altered. This option can be used only by an admin user.
3899
3900 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3901 .oindex "&%-Mmd%&"
3902 .cindex "delivery" "cancelling by address"
3903 .cindex "recipient" "removing"
3904 .cindex "removing recipients"
3905 This option requests Exim to mark the given addresses as already delivered
3906 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
3907 the remaining ones must be email addresses. These are matched to recipient
3908 addresses in the message in a case-sensitive manner. If the message is active
3909 (in the middle of a delivery attempt), its status is not altered. This option
3910 can be used only by an admin user.
3911
3912 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3913 .oindex "&%-Mrm%&"
3914 .cindex "removing messages"
3915 .cindex "abandoning mail"
3916 .cindex "message" "manually discarding"
3917 This option requests Exim to remove the given messages from the queue. No
3918 bounce messages are sent; each message is simply forgotten. However, if any of
3919 the messages are active, their status is not altered. This option can be used
3920 only by an admin user or by the user who originally caused the message to be
3921 placed on the queue.
3922
3923 .vitem &%-Mset%&&~<&'message&~id'&>
3924 .oindex "&%-Mset%&
3925 .cindex "testing" "string expansion"
3926 .cindex "expansion" "testing"
3927 This option is useful only in conjunction with &%-be%& (that is, when testing
3928 string expansions). Exim loads the given message from its spool before doing
3929 the test expansions, thus setting message-specific variables such as
3930 &$message_size$& and the header variables. The &$recipients$& variable is made
3931 available. This feature is provided to make it easier to test expansions that
3932 make use of these variables. However, this option can be used only by an admin
3933 user. See also &%-bem%&.
3934
3935 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3936 .oindex "&%-Mt%&"
3937 .cindex "thawing messages"
3938 .cindex "unfreezing messages"
3939 .cindex "frozen messages" "thawing"
3940 .cindex "message" "thawing frozen"
3941 This option requests Exim to &"thaw"& any of the listed messages that are
3942 &"frozen"&, so that delivery attempts can resume. However, if any of the
3943 messages are active, their status is not altered. This option can be used only
3944 by an admin user.
3945
3946 .vitem &%-Mvb%&&~<&'message&~id'&>
3947 .oindex "&%-Mvb%&"
3948 .cindex "listing" "message body"
3949 .cindex "message" "listing body of"
3950 This option causes the contents of the message body (-D) spool file to be
3951 written to the standard output. This option can be used only by an admin user.
3952
3953 .vitem &%-Mvc%&&~<&'message&~id'&>
3954 .oindex "&%-Mvc%&"
3955 .cindex "message" "listing in RFC 2822 format"
3956 .cindex "listing" "message in RFC 2822 format"
3957 This option causes a copy of the complete message (header lines plus body) to
3958 be written to the standard output in RFC 2822 format. This option can be used
3959 only by an admin user.
3960
3961 .vitem &%-Mvh%&&~<&'message&~id'&>
3962 .oindex "&%-Mvh%&"
3963 .cindex "listing" "message headers"
3964 .cindex "header lines" "listing"
3965 .cindex "message" "listing header lines"
3966 This option causes the contents of the message headers (-H) spool file to be
3967 written to the standard output. This option can be used only by an admin user.
3968
3969 .vitem &%-Mvl%&&~<&'message&~id'&>
3970 .oindex "&%-Mvl%&"
3971 .cindex "listing" "message log"
3972 .cindex "message" "listing message log"
3973 This option causes the contents of the message log spool file to be written to
3974 the standard output. This option can be used only by an admin user.
3975
3976 .vitem &%-m%&
3977 .oindex "&%-m%&"
3978 This is apparently a synonym for &%-om%& that is accepted by Sendmail, so Exim
3979 treats it that way too.
3980
3981 .vitem &%-N%&
3982 .oindex "&%-N%&"
3983 .cindex "debugging" "&%-N%& option"
3984 .cindex "debugging" "suppressing delivery"
3985 This is a debugging option that inhibits delivery of a message at the transport
3986 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
3987 it just doesn't actually transport the message, but instead behaves as if it
3988 had successfully done so. However, it does not make any updates to the retry
3989 database, and the log entries for deliveries are flagged with &"*>"& rather
3990 than &"=>"&.
3991
3992 Because &%-N%& discards any message to which it applies, only root or the Exim
3993 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
3994 words, an ordinary user can use it only when supplying an incoming message to
3995 which it will apply. Although transportation never fails when &%-N%& is set, an
3996 address may be deferred because of a configuration problem on a transport, or a
3997 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
3998 the message, and applies to any subsequent delivery attempts that may happen
3999 for that message.
4000
4001 .vitem &%-n%&
4002 .oindex "&%-n%&"
4003 This option is interpreted by Sendmail to mean &"no aliasing"&.
4004 For normal modes of operation, it is ignored by Exim.
4005 When combined with &%-bP%& it suppresses the name of an option from being output.
4006
4007 .vitem &%-O%&&~<&'data'&>
4008 .oindex "&%-O%&"
4009 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
4010 Exim.
4011
4012 .vitem &%-oA%&&~<&'file&~name'&>
4013 .oindex "&%-oA%&"
4014 .cindex "Sendmail compatibility" "&%-oA%& option"
4015 This option is used by Sendmail in conjunction with &%-bi%& to specify an
4016 alternative alias file name. Exim handles &%-bi%& differently; see the
4017 description above.
4018
4019 .vitem &%-oB%&&~<&'n'&>
4020 .oindex "&%-oB%&"
4021 .cindex "SMTP" "passed connection"
4022 .cindex "SMTP" "multiple deliveries"
4023 .cindex "multiple SMTP deliveries"
4024 This is a debugging option which limits the maximum number of messages that can
4025 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
4026 transport. If <&'n'&> is omitted, the limit is set to 1.
4027
4028 .vitem &%-odb%&
4029 .oindex "&%-odb%&"
4030 .cindex "background delivery"
4031 .cindex "delivery" "in the background"
4032 This option applies to all modes in which Exim accepts incoming messages,
4033 including the listening daemon. It requests &"background"& delivery of such
4034 messages, which means that the accepting process automatically starts a
4035 delivery process for each message received, but does not wait for the delivery
4036 processes to finish.
4037
4038 When all the messages have been received, the reception process exits,
4039 leaving the delivery processes to finish in their own time. The standard output
4040 and error streams are closed at the start of each delivery process.
4041 This is the default action if none of the &%-od%& options are present.
4042
4043 If one of the queueing options in the configuration file
4044 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
4045 overrides it if &%queue_only_override%& is set true, which is the default
4046 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
4047
4048 .vitem &%-odf%&
4049 .oindex "&%-odf%&"
4050 .cindex "foreground delivery"
4051 .cindex "delivery" "in the foreground"
4052 This option requests &"foreground"& (synchronous) delivery when Exim has
4053 accepted a locally-generated message. (For the daemon it is exactly the same as
4054 &%-odb%&.) A delivery process is automatically started to deliver the message,
4055 and Exim waits for it to complete before proceeding.
4056
4057 The original Exim reception process does not finish until the delivery
4058 process for the final message has ended. The standard error stream is left open
4059 during deliveries.
4060
4061 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
4062 false and one of the queueing options in the configuration file is in effect.
4063
4064 If there is a temporary delivery error during foreground delivery, the
4065 message is left on the queue for later delivery, and the original reception
4066 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
4067 restricted configuration that never queues messages.
4068
4069
4070 .vitem &%-odi%&
4071 .oindex "&%-odi%&"
4072 This option is synonymous with &%-odf%&. It is provided for compatibility with
4073 Sendmail.
4074
4075 .vitem &%-odq%&
4076 .oindex "&%-odq%&"
4077 .cindex "non-immediate delivery"
4078 .cindex "delivery" "suppressing immediate"
4079 .cindex "queueing incoming messages"
4080 This option applies to all modes in which Exim accepts incoming messages,
4081 including the listening daemon. It specifies that the accepting process should
4082 not automatically start a delivery process for each message received. Messages
4083 are placed on the queue, and remain there until a subsequent queue runner
4084 process encounters them. There are several configuration options (such as
4085 &%queue_only%&) that can be used to queue incoming messages under certain
4086 conditions. This option overrides all of them and also &%-odqs%&. It always
4087 forces queueing.
4088
4089 .vitem &%-odqs%&
4090 .oindex "&%-odqs%&"
4091 .cindex "SMTP" "delaying delivery"
4092 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4093 However, like &%-odb%& and &%-odi%&, this option has no effect if
4094 &%queue_only_override%& is false and one of the queueing options in the
4095 configuration file is in effect.
4096
4097 When &%-odqs%& does operate, a delivery process is started for each incoming
4098 message, in the background by default, but in the foreground if &%-odi%& is
4099 also present. The recipient addresses are routed, and local deliveries are done
4100 in the normal way. However, if any SMTP deliveries are required, they are not
4101 done at this time, so the message remains on the queue until a subsequent queue
4102 runner process encounters it. Because routing was done, Exim knows which
4103 messages are waiting for which hosts, and so a number of messages for the same
4104 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4105 configuration option has the same effect for specific domains. See also the
4106 &%-qq%& option.
4107
4108 .vitem &%-oee%&
4109 .oindex "&%-oee%&"
4110 .cindex "error" "reporting"
4111 If an error is detected while a non-SMTP message is being received (for
4112 example, a malformed address), the error is reported to the sender in a mail
4113 message.
4114
4115 .cindex "return code" "for &%-oee%&"
4116 Provided
4117 this error message is successfully sent, the Exim receiving process
4118 exits with a return code of zero. If not, the return code is 2 if the problem
4119 is that the original message has no recipients, or 1 for any other error.
4120 This is the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4121
4122 .vitem &%-oem%&
4123 .oindex "&%-oem%&"
4124 .cindex "error" "reporting"
4125 .cindex "return code" "for &%-oem%&"
4126 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4127 return code, whether or not the error message was successfully sent.
4128 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4129
4130 .vitem &%-oep%&
4131 .oindex "&%-oep%&"
4132 .cindex "error" "reporting"
4133 If an error is detected while a non-SMTP message is being received, the
4134 error is reported by writing a message to the standard error file (stderr).
4135 .cindex "return code" "for &%-oep%&"
4136 The return code is 1 for all errors.
4137
4138 .vitem &%-oeq%&
4139 .oindex "&%-oeq%&"
4140 .cindex "error" "reporting"
4141 This option is supported for compatibility with Sendmail, but has the same
4142 effect as &%-oep%&.
4143
4144 .vitem &%-oew%&
4145 .oindex "&%-oew%&"
4146 .cindex "error" "reporting"
4147 This option is supported for compatibility with Sendmail, but has the same
4148 effect as &%-oem%&.
4149
4150 .vitem &%-oi%&
4151 .oindex "&%-oi%&"
4152 .cindex "dot" "in incoming non-SMTP message"
4153 This option, which has the same effect as &%-i%&, specifies that a dot on a
4154 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4155 single dot does terminate, though Exim does no special processing for other
4156 lines that start with a dot. This option is set by default if Exim is called as
4157 &'rmail'&. See also &%-ti%&.
4158
4159 .vitem &%-oitrue%&
4160 .oindex "&%-oitrue%&"
4161 This option is treated as synonymous with &%-oi%&.
4162
4163 .vitem &%-oMa%&&~<&'host&~address'&>
4164 .oindex "&%-oMa%&"
4165 .cindex "sender" "host address, specifying for local message"
4166 A number of options starting with &%-oM%& can be used to set values associated
4167 with remote hosts on locally-submitted messages (that is, messages not received
4168 over TCP/IP). These options can be used by any caller in conjunction with the
4169 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4170 other circumstances, they are ignored unless the caller is trusted.
4171
4172 The &%-oMa%& option sets the sender host address. This may include a port
4173 number at the end, after a full stop (period). For example:
4174 .code
4175 exim -bs -oMa 10.9.8.7.1234
4176 .endd
4177 An alternative syntax is to enclose the IP address in square brackets,
4178 followed by a colon and the port number:
4179 .code
4180 exim -bs -oMa [10.9.8.7]:1234
4181 .endd
4182 The IP address is placed in the &$sender_host_address$& variable, and the
4183 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4184 are present on the command line, the sender host IP address is taken from
4185 whichever one is last.
4186
4187 .vitem &%-oMaa%&&~<&'name'&>
4188 .oindex "&%-oMaa%&"
4189 .cindex "authentication" "name, specifying for local message"
4190 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4191 option sets the value of &$sender_host_authenticated$& (the authenticator
4192 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4193 This option can be used with &%-bh%& and &%-bs%& to set up an
4194 authenticated SMTP session without actually using the SMTP AUTH command.
4195
4196 .vitem &%-oMai%&&~<&'string'&>
4197 .oindex "&%-oMai%&"
4198 .cindex "authentication" "id, specifying for local message"
4199 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4200 option sets the value of &$authenticated_id$& (the id that was authenticated).
4201 This overrides the default value (the caller's login id, except with &%-bh%&,
4202 where there is no default) for messages from local sources. See chapter
4203 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4204
4205 .vitem &%-oMas%&&~<&'address'&>
4206 .oindex "&%-oMas%&"
4207 .cindex "authentication" "sender, specifying for local message"
4208 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4209 option sets the authenticated sender value in &$authenticated_sender$&. It
4210 overrides the sender address that is created from the caller's login id for
4211 messages from local sources, except when &%-bh%& is used, when there is no
4212 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4213 specified on a MAIL command overrides this value. See chapter
4214 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4215
4216 .vitem &%-oMi%&&~<&'interface&~address'&>
4217 .oindex "&%-oMi%&"
4218 .cindex "interface" "address, specifying for local message"
4219 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4220 option sets the IP interface address value. A port number may be included,
4221 using the same syntax as for &%-oMa%&. The interface address is placed in
4222 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4223
4224 .vitem &%-oMm%&&~<&'message&~reference'&>
4225 .oindex "&%-oMm%&"
4226 .cindex "message reference" "message reference, specifying for local message"
4227 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMm%&
4228 option sets the message reference, e.g. message-id, and is logged during
4229 delivery. This is useful when some kind of audit trail is required to tie
4230 messages together. The format of the message reference is checked and will
4231 abort if the format is invalid. The option will only be accepted if exim is
4232 running in trusted mode, not as any regular user.
4233
4234 The best example of a message reference is when Exim sends a bounce message.
4235 The message reference is the message-id of the original message for which Exim
4236 is sending the bounce.
4237
4238 .vitem &%-oMr%&&~<&'protocol&~name'&>
4239 .oindex "&%-oMr%&"
4240 .cindex "protocol, specifying for local message"
4241 .vindex "&$received_protocol$&"
4242 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4243 option sets the received protocol value that is stored in
4244 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4245 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4246 SMTP protocol names (see the description of &$received_protocol$& in section
4247 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4248 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4249 be set by &%-oMr%&.
4250
4251 .vitem &%-oMs%&&~<&'host&~name'&>
4252 .oindex "&%-oMs%&"
4253 .cindex "sender" "host name, specifying for local message"
4254 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4255 option sets the sender host name in &$sender_host_name$&. When this option is
4256 present, Exim does not attempt to look up a host name from an IP address; it
4257 uses the name it is given.
4258
4259 .vitem &%-oMt%&&~<&'ident&~string'&>
4260 .oindex "&%-oMt%&"
4261 .cindex "sender" "ident string, specifying for local message"
4262 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4263 option sets the sender ident value in &$sender_ident$&. The default setting for
4264 local callers is the login id of the calling process, except when &%-bh%& is
4265 used, when there is no default.
4266
4267 .vitem &%-om%&
4268 .oindex "&%-om%&"
4269 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4270 In Sendmail, this option means &"me too"&, indicating that the sender of a
4271 message should receive a copy of the message if the sender appears in an alias
4272 expansion. Exim always does this, so the option does nothing.
4273
4274 .vitem &%-oo%&
4275 .oindex "&%-oo%&"
4276 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4277 This option is ignored. In Sendmail it specifies &"old style headers"&,
4278 whatever that means.
4279
4280 .vitem &%-oP%&&~<&'path'&>
4281 .oindex "&%-oP%&"
4282 .cindex "pid (process id)" "of daemon"
4283 .cindex "daemon" "process id (pid)"
4284 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4285 value. The option specifies the file to which the process id of the daemon is
4286 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4287 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4288 because in those cases, the normal pid file is not used.
4289
4290 .vitem &%-or%&&~<&'time'&>
4291 .oindex "&%-or%&"
4292 .cindex "timeout" "for non-SMTP input"
4293 This option sets a timeout value for incoming non-SMTP messages. If it is not
4294 set, Exim will wait forever for the standard input. The value can also be set
4295 by the &%receive_timeout%& option. The format used for specifying times is
4296 described in section &<<SECTtimeformat>>&.
4297
4298 .vitem &%-os%&&~<&'time'&>
4299 .oindex "&%-os%&"
4300 .cindex "timeout" "for SMTP input"
4301 .cindex "SMTP" "input timeout"
4302 This option sets a timeout value for incoming SMTP messages. The timeout
4303 applies to each SMTP command and block of data. The value can also be set by
4304 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4305 for specifying times is described in section &<<SECTtimeformat>>&.
4306
4307 .vitem &%-ov%&
4308 .oindex "&%-ov%&"
4309 This option has exactly the same effect as &%-v%&.
4310
4311 .vitem &%-oX%&&~<&'number&~or&~string'&>
4312 .oindex "&%-oX%&"
4313 .cindex "TCP/IP" "setting listening ports"
4314 .cindex "TCP/IP" "setting listening interfaces"
4315 .cindex "port" "receiving TCP/IP"
4316 This option is relevant only when the &%-bd%& (start listening daemon) option
4317 is also given. It controls which ports and interfaces the daemon uses. Details
4318 of the syntax, and how it interacts with configuration file options, are given
4319 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4320 file is written unless &%-oP%& is also present to specify a pid file name.
4321
4322 .vitem &%-pd%&
4323 .oindex "&%-pd%&"
4324 .cindex "Perl" "starting the interpreter"
4325 This option applies when an embedded Perl interpreter is linked with Exim (see
4326 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4327 option, forcing the starting of the interpreter to be delayed until it is
4328 needed.
4329
4330 .vitem &%-ps%&
4331 .oindex "&%-ps%&"
4332 .cindex "Perl" "starting the interpreter"
4333 This option applies when an embedded Perl interpreter is linked with Exim (see
4334 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4335 option, forcing the starting of the interpreter to occur as soon as Exim is
4336 started.
4337
4338 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4339 .oindex "&%-p%&"
4340 For compatibility with Sendmail, this option is equivalent to
4341 .display
4342 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4343 .endd
4344 It sets the incoming protocol and host name (for trusted callers). The
4345 host name and its colon can be omitted when only the protocol is to be set.
4346 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4347 to embedded Perl. It is therefore impossible to set a protocol value of &`d`&
4348 or &`s`& using this option (but that does not seem a real limitation).
4349
4350 .vitem &%-q%&
4351 .oindex "&%-q%&"
4352 .cindex "queue runner" "starting manually"
4353 This option is normally restricted to admin users. However, there is a
4354 configuration option called &%prod_requires_admin%& which can be set false to
4355 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4356 and &%-S%& options).
4357
4358 .cindex "queue runner" "description of operation"
4359 The &%-q%& option starts one queue runner process. This scans the queue of
4360 waiting messages, and runs a delivery process for each one in turn. It waits
4361 for each delivery process to finish before starting the next one. A delivery
4362 process may not actually do any deliveries if the retry times for the addresses
4363 have not been reached. Use &%-qf%& (see below) if you want to override this.
4364
4365 If
4366 .cindex "SMTP" "passed connection"
4367 .cindex "SMTP" "multiple deliveries"
4368 .cindex "multiple SMTP deliveries"
4369 the delivery process spawns other processes to deliver other messages down
4370 passed SMTP connections, the queue runner waits for these to finish before
4371 proceeding.
4372
4373 When all the queued messages have been considered, the original queue runner
4374 process terminates. In other words, a single pass is made over the waiting
4375 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4376 this to be repeated periodically.
4377
4378 Exim processes the waiting messages in an unpredictable order. It isn't very
4379 random, but it is likely to be different each time, which is all that matters.
4380 If one particular message screws up a remote MTA, other messages to the same
4381 MTA have a chance of getting through if they get tried first.
4382
4383 It is possible to cause the messages to be processed in lexical message id
4384 order, which is essentially the order in which they arrived, by setting the
4385 &%queue_run_in_order%& option, but this is not recommended for normal use.
4386
4387 .vitem &%-q%&<&'qflags'&>
4388 The &%-q%& option may be followed by one or more flag letters that change its
4389 behaviour. They are all optional, but if more than one is present, they must
4390 appear in the correct order. Each flag is described in a separate item below.
4391
4392 .vitem &%-qq...%&
4393 .oindex "&%-qq%&"
4394 .cindex "queue" "double scanning"
4395 .cindex "queue" "routing"
4396 .cindex "routing" "whole queue before delivery"
4397 An option starting with &%-qq%& requests a two-stage queue run. In the first
4398 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4399 every domain. Addresses are routed, local deliveries happen, but no remote
4400 transports are run.
4401
4402 .cindex "hints database" "remembering routing"
4403 The hints database that remembers which messages are waiting for specific hosts
4404 is updated, as if delivery to those hosts had been deferred. After this is
4405 complete, a second, normal queue scan happens, with routing and delivery taking
4406 place as normal. Messages that are routed to the same host should mostly be
4407 delivered down a single SMTP
4408 .cindex "SMTP" "passed connection"
4409 .cindex "SMTP" "multiple deliveries"
4410 .cindex "multiple SMTP deliveries"
4411 connection because of the hints that were set up during the first queue scan.
4412 This option may be useful for hosts that are connected to the Internet
4413 intermittently.
4414
4415 .vitem &%-q[q]i...%&
4416 .oindex "&%-qi%&"
4417 .cindex "queue" "initial delivery"
4418 If the &'i'& flag is present, the queue runner runs delivery processes only for
4419 those messages that haven't previously been tried. (&'i'& stands for &"initial
4420 delivery"&.) This can be helpful if you are putting messages on the queue using
4421 &%-odq%& and want a queue runner just to process the new messages.
4422
4423 .vitem &%-q[q][i]f...%&
4424 .oindex "&%-qf%&"
4425 .cindex "queue" "forcing delivery"
4426 .cindex "delivery" "forcing in queue run"
4427 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4428 message, whereas without &'f'& only those non-frozen addresses that have passed
4429 their retry times are tried.
4430
4431 .vitem &%-q[q][i]ff...%&
4432 .oindex "&%-qff%&"
4433 .cindex "frozen messages" "forcing delivery"
4434 If &'ff'& is present, a delivery attempt is forced for every message, whether
4435 frozen or not.
4436
4437 .vitem &%-q[q][i][f[f]]l%&
4438 .oindex "&%-ql%&"
4439 .cindex "queue" "local deliveries only"
4440 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4441 be done. If a message requires any remote deliveries, it remains on the queue
4442 for later delivery.
4443
4444 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4445 .cindex "queue" "delivering specific messages"
4446 When scanning the queue, Exim can be made to skip over messages whose ids are
4447 lexically less than a given value by following the &%-q%& option with a
4448 starting message id. For example:
4449 .code
4450 exim -q 0t5C6f-0000c8-00
4451 .endd
4452 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4453 second message id is given, messages whose ids are lexically greater than it
4454 are also skipped. If the same id is given twice, for example,
4455 .code
4456 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4457 .endd
4458 just one delivery process is started, for that message. This differs from
4459 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4460 that it counts as a delivery from a queue run. Note that the selection
4461 mechanism does not affect the order in which the messages are scanned. There
4462 are also other ways of selecting specific sets of messages for delivery in a
4463 queue run &-- see &%-R%& and &%-S%&.
4464
4465 .vitem &%-q%&<&'qflags'&><&'time'&>
4466 .cindex "queue runner" "starting periodically"
4467 .cindex "periodic queue running"
4468 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4469 starting a queue runner process at intervals specified by the given time value
4470 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4471 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4472 single daemon process handles both functions. A common way of starting up a
4473 combined daemon at system boot time is to use a command such as
4474 .code
4475 /usr/exim/bin/exim -bd -q30m
4476 .endd
4477 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4478 process every 30 minutes.
4479
4480 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4481 pid file is written unless one is explicitly requested by the &%-oP%& option.
4482
4483 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4484 .oindex "&%-qR%&"
4485 This option is synonymous with &%-R%&. It is provided for Sendmail
4486 compatibility.
4487
4488 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4489 .oindex "&%-qS%&"
4490 This option is synonymous with &%-S%&.
4491
4492 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4493 .oindex "&%-R%&"
4494 .cindex "queue runner" "for specific recipients"
4495 .cindex "delivery" "to given domain"
4496 .cindex "domain" "delivery to"
4497 The <&'rsflags'&> may be empty, in which case the white space before the string
4498 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4499 which are the possible values for <&'rsflags'&>. White space is required if
4500 <&'rsflags'&> is not empty.
4501
4502 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4503 perform a single queue run, except that, when scanning the messages on the
4504 queue, Exim processes only those that have at least one undelivered recipient
4505 address containing the given string, which is checked in a case-independent
4506 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4507 regular expression; otherwise it is a literal string.
4508
4509 If you want to do periodic queue runs for messages with specific recipients,
4510 you can combine &%-R%& with &%-q%& and a time value. For example:
4511 .code
4512 exim -q25m -R @special.domain.example
4513 .endd
4514 This example does a queue run for messages with recipients in the given domain
4515 every 25 minutes. Any additional flags that are specified with &%-q%& are
4516 applied to each queue run.
4517
4518 Once a message is selected for delivery by this mechanism, all its addresses
4519 are processed. For the first selected message, Exim overrides any retry
4520 information and forces a delivery attempt for each undelivered address. This
4521 means that if delivery of any address in the first message is successful, any
4522 existing retry information is deleted, and so delivery attempts for that
4523 address in subsequently selected messages (which are processed without forcing)
4524 will run. However, if delivery of any address does not succeed, the retry
4525 information is updated, and in subsequently selected messages, the failing
4526 address will be skipped.
4527
4528 .cindex "frozen messages" "forcing delivery"
4529 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4530 all selected messages, not just the first; frozen messages are included when
4531 &'ff'& is present.
4532
4533 The &%-R%& option makes it straightforward to initiate delivery of all messages
4534 to a given domain after a host has been down for some time. When the SMTP
4535 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4536 effect is to run Exim with the &%-R%& option, but it can be configured to run
4537 an arbitrary command instead.
4538
4539 .vitem &%-r%&
4540 .oindex "&%-r%&"
4541 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4542
4543 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4544 .oindex "&%-S%&"
4545 .cindex "delivery" "from given sender"
4546 .cindex "queue runner" "for specific senders"
4547 This option acts like &%-R%& except that it checks the string against each
4548 message's sender instead of against the recipients. If &%-R%& is also set, both
4549 conditions must be met for a message to be selected. If either of the options
4550 has &'f'& or &'ff'& in its flags, the associated action is taken.
4551
4552 .vitem &%-Tqt%&&~<&'times'&>
4553 .oindex "&%-Tqt%&"
4554 This is an option that is exclusively for use by the Exim testing suite. It is not
4555 recognized when Exim is run normally. It allows for the setting up of explicit
4556 &"queue times"& so that various warning/retry features can be tested.
4557
4558 .vitem &%-t%&
4559 .oindex "&%-t%&"
4560 .cindex "recipient" "extracting from header lines"
4561 .cindex "&'Bcc:'& header line"
4562 .cindex "&'Cc:'& header line"
4563 .cindex "&'To:'& header line"
4564 When Exim is receiving a locally-generated, non-SMTP message on its standard
4565 input, the &%-t%& option causes the recipients of the message to be obtained
4566 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4567 from the command arguments. The addresses are extracted before any rewriting
4568 takes place and the &'Bcc:'& header line, if present, is then removed.
4569
4570 .cindex "Sendmail compatibility" "&%-t%& option"
4571 If the command has any arguments, they specify addresses to which the message
4572 is &'not'& to be delivered. That is, the argument addresses are removed from
4573 the recipients list obtained from the headers. This is compatible with Smail 3
4574 and in accordance with the documented behaviour of several versions of
4575 Sendmail, as described in man pages on a number of operating systems (e.g.
4576 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4577 argument addresses to those obtained from the headers, and the O'Reilly
4578 Sendmail book documents it that way. Exim can be made to add argument addresses
4579 instead of subtracting them by setting the option
4580 &%extract_addresses_remove_arguments%& false.
4581
4582 .cindex "&%Resent-%& header lines" "with &%-t%&"
4583 If there are any &%Resent-%& header lines in the message, Exim extracts
4584 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4585 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4586 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4587 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4588
4589 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4590 message is resent several times). The RFC also specifies that they should be
4591 added at the front of the message, and separated by &'Received:'& lines. It is
4592 not at all clear how &%-t%& should operate in the present of multiple sets,
4593 nor indeed exactly what constitutes a &"set"&.
4594 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4595 are often added at the end of the header, and if a message is resent more than
4596 once, it is common for the original set of &%Resent-%& headers to be renamed as
4597 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4598
4599 .vitem &%-ti%&
4600 .oindex "&%-ti%&"
4601 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4602 compatibility with Sendmail.
4603
4604 .vitem &%-tls-on-connect%&
4605 .oindex "&%-tls-on-connect%&"
4606 .cindex "TLS" "use without STARTTLS"
4607 .cindex "TLS" "automatic start"
4608 This option is available when Exim is compiled with TLS support. It forces all
4609 incoming SMTP connections to behave as if the incoming port is listed in the
4610 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4611 &<<CHAPTLS>>& for further details.
4612
4613
4614 .vitem &%-U%&
4615 .oindex "&%-U%&"
4616 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4617 Sendmail uses this option for &"initial message submission"&, and its
4618 documentation states that in future releases, it may complain about
4619 syntactically invalid messages rather than fixing them when this flag is not
4620 set. Exim ignores this option.
4621
4622 .vitem &%-v%&
4623 .oindex "&%-v%&"
4624 This option causes Exim to write information to the standard error stream,
4625 describing what it is doing. In particular, it shows the log lines for
4626 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4627 dialogue is shown. Some of the log lines shown may not actually be written to
4628 the log if the setting of &%log_selector%& discards them. Any relevant
4629 selectors are shown with each log line. If none are shown, the logging is
4630 unconditional.
4631
4632 .vitem &%-x%&
4633 .oindex "&%-x%&"
4634 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4635 National Language Support extended characters in the body of the mail item"&).
4636 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4637 this option.
4638
4639 .vitem &%-X%&&~<&'logfile'&>
4640 .oindex "&%-X%&"
4641 This option is interpreted by Sendmail to cause debug information to be sent
4642 to the named file.  It is ignored by Exim.
4643 .endlist
4644
4645 .ecindex IIDclo1
4646 .ecindex IIDclo2
4647
4648
4649 . ////////////////////////////////////////////////////////////////////////////
4650 . Insert a stylized DocBook comment here, to identify the end of the command
4651 . line options. This is for the benefit of the Perl script that automatically
4652 . creates a man page for the options.
4653 . ////////////////////////////////////////////////////////////////////////////
4654
4655 .literal xml
4656 <!-- === End of command line options === -->
4657 .literal off
4658
4659
4660
4661
4662
4663 . ////////////////////////////////////////////////////////////////////////////
4664 . ////////////////////////////////////////////////////////////////////////////
4665
4666
4667 .chapter "The Exim run time configuration file" "CHAPconf" &&&
4668          "The runtime configuration file"
4669
4670 .cindex "run time configuration"
4671 .cindex "configuration file" "general description"
4672 .cindex "CONFIGURE_FILE"
4673 .cindex "configuration file" "errors in"
4674 .cindex "error" "in configuration file"
4675 .cindex "return code" "for bad configuration"
4676 Exim uses a single run time configuration file that is read whenever an Exim
4677 binary is executed. Note that in normal operation, this happens frequently,
4678 because Exim is designed to operate in a distributed manner, without central
4679 control.
4680
4681 If a syntax error is detected while reading the configuration file, Exim
4682 writes a message on the standard error, and exits with a non-zero return code.
4683 The message is also written to the panic log. &*Note*&: Only simple syntax
4684 errors can be detected at this time. The values of any expanded options are
4685 not checked until the expansion happens, even when the expansion does not
4686 actually alter the string.
4687
4688 The name of the configuration file is compiled into the binary for security
4689 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4690 most configurations, this specifies a single file. However, it is permitted to
4691 give a colon-separated list of file names, in which case Exim uses the first
4692 existing file in the list.
4693
4694 .cindex "EXIM_USER"
4695 .cindex "EXIM_GROUP"
4696 .cindex "CONFIGURE_OWNER"
4697 .cindex "CONFIGURE_GROUP"
4698 .cindex "configuration file" "ownership"
4699 .cindex "ownership" "configuration file"
4700 The run time configuration file must be owned by root or by the user that is
4701 specified at compile time by the CONFIGURE_OWNER option (if set). The
4702 configuration file must not be world-writeable, or group-writeable unless its
4703 group is the root group or the one specified at compile time by the
4704 CONFIGURE_GROUP option.
4705
4706 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4707 to root, anybody who is able to edit the run time configuration file has an
4708 easy way to run commands as root. If you specify a user or group in the
4709 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4710 who are members of that group will trivially be able to obtain root privileges.
4711
4712 Up to Exim version 4.72, the run time configuration file was also permitted to
4713 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4714 since it offered a simple privilege escalation for any attacker who managed to
4715 compromise the Exim user account.
4716
4717 A default configuration file, which will work correctly in simple situations,
4718 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4719 defines just one file name, the installation process copies the default
4720 configuration to a new file of that name if it did not previously exist. If
4721 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4722 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4723 configuration.
4724
4725
4726
4727 .section "Using a different configuration file" "SECID40"
4728 .cindex "configuration file" "alternate"
4729 A one-off alternate configuration can be specified by the &%-C%& command line
4730 option, which may specify a single file or a list of files. However, when
4731 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4732 unless the argument for &%-C%& is identical to the built-in value from
4733 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4734 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4735 is useful mainly for checking the syntax of configuration files before
4736 installing them. No owner or group checks are done on a configuration file
4737 specified by &%-C%&, if root privilege has been dropped.
4738
4739 Even the Exim user is not trusted to specify an arbitrary configuration file
4740 with the &%-C%& option to be used with root privileges, unless that file is
4741 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4742 testing a configuration using &%-C%& right through message reception and
4743 delivery, even if the caller is root. The reception works, but by that time,
4744 Exim is running as the Exim user, so when it re-execs to regain privilege for
4745 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4746 can test reception and delivery using two separate commands (one to put a
4747 message on the queue, using &%-odq%&, and another to do the delivery, using
4748 &%-M%&).
4749
4750 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4751 prefix string with which any file named in a &%-C%& command line option must
4752 start. In addition, the file name must not contain the sequence &"&`/../`&"&.
4753 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any file
4754 name can be used with &%-C%&.
4755
4756 One-off changes to a configuration can be specified by the &%-D%& command line
4757 option, which defines and overrides values for macros used inside the
4758 configuration file. However, like &%-C%&, the use of this option by a
4759 non-privileged user causes Exim to discard its root privilege.
4760 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4761 completely disabled, and its use causes an immediate error exit.
4762
4763 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4764 to declare certain macro names trusted, such that root privilege will not
4765 necessarily be discarded.
4766 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4767 considered safe and, if &%-D%& only supplies macros from this list, and the
4768 values are acceptable, then Exim will not give up root privilege if the caller
4769 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4770 transition mechanism and is expected to be removed in the future.  Acceptable
4771 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4772
4773 Some sites may wish to use the same Exim binary on different machines that
4774 share a file system, but to use different configuration files on each machine.
4775 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4776 looks for a file whose name is the configuration file name followed by a dot
4777 and the machine's node name, as obtained from the &[uname()]& function. If this
4778 file does not exist, the standard name is tried. This processing occurs for
4779 each file name in the list given by CONFIGURE_FILE or &%-C%&.
4780
4781 In some esoteric situations different versions of Exim may be run under
4782 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4783 help with this. See the comments in &_src/EDITME_& for details.
4784
4785
4786
4787 .section "Configuration file format" "SECTconffilfor"
4788 .cindex "configuration file" "format of"
4789 .cindex "format" "configuration file"
4790 Exim's configuration file is divided into a number of different parts. General
4791 option settings must always appear at the start of the file. The other parts
4792 are all optional, and may appear in any order. Each part other than the first
4793 is introduced by the word &"begin"& followed by the name of the part. The
4794 optional parts are:
4795
4796 .ilist
4797 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4798 &<<CHAPACL>>&).
4799 .next
4800 .cindex "AUTH" "configuration"
4801 &'authenticators'&: Configuration settings for the authenticator drivers. These
4802 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4803 .next
4804 &'routers'&: Configuration settings for the router drivers. Routers process
4805 addresses and determine how the message is to be delivered (see chapters
4806 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4807 .next
4808 &'transports'&: Configuration settings for the transport drivers. Transports
4809 define mechanisms for copying messages to destinations (see chapters
4810 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4811 .next
4812 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4813 If there is no retry section, or if it is empty (that is, no retry rules are
4814 defined), Exim will not retry deliveries. In this situation, temporary errors
4815 are treated the same as permanent errors. Retry rules are discussed in chapter
4816 &<<CHAPretry>>&.
4817 .next
4818 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4819 when new addresses are generated during delivery. Rewriting is discussed in
4820 chapter &<<CHAPrewrite>>&.
4821 .next
4822 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4823 want to use this feature, you must set
4824 .code
4825 LOCAL_SCAN_HAS_OPTIONS=yes
4826 .endd
4827 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4828 facility are given in chapter &<<CHAPlocalscan>>&.
4829 .endlist
4830
4831 .cindex "configuration file" "leading white space in"
4832 .cindex "configuration file" "trailing white space in"
4833 .cindex "white space" "in configuration file"
4834 Leading and trailing white space in configuration lines is always ignored.
4835
4836 Blank lines in the file, and lines starting with a # character (ignoring
4837 leading white space) are treated as comments and are ignored. &*Note*&: A
4838 # character other than at the beginning of a line is not treated specially,
4839 and does not introduce a comment.
4840
4841 Any non-comment line can be continued by ending it with a backslash. Note that
4842 the general rule for white space means that trailing white space after the
4843 backslash and leading white space at the start of continuation
4844 lines is ignored. Comment lines beginning with # (but not empty lines) may
4845 appear in the middle of a sequence of continuation lines.
4846
4847 A convenient way to create a configuration file is to start from the
4848 default, which is supplied in &_src/configure.default_&, and add, delete, or
4849 change settings as required.
4850
4851 The ACLs, retry rules, and rewriting rules have their own syntax which is
4852 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
4853 respectively. The other parts of the configuration file have some syntactic
4854 items in common, and these are described below, from section &<<SECTcos>>&
4855 onwards. Before that, the inclusion, macro, and conditional facilities are
4856 described.
4857
4858
4859
4860 .section "File inclusions in the configuration file" "SECID41"
4861 .cindex "inclusions in configuration file"
4862 .cindex "configuration file" "including other files"
4863 .cindex "&`.include`& in configuration file"
4864 .cindex "&`.include_if_exists`& in configuration file"
4865 You can include other files inside Exim's run time configuration file by
4866 using this syntax:
4867 .display
4868 &`.include`& <&'file name'&>
4869 &`.include_if_exists`& <&'file name'&>
4870 .endd
4871 on a line by itself. Double quotes round the file name are optional. If you use
4872 the first form, a configuration error occurs if the file does not exist; the
4873 second form does nothing for non-existent files. In all cases, an absolute file
4874 name is required.
4875
4876 Includes may be nested to any depth, but remember that Exim reads its
4877 configuration file often, so it is a good idea to keep them to a minimum.
4878 If you change the contents of an included file, you must HUP the daemon,
4879 because an included file is read only when the configuration itself is read.
4880
4881 The processing of inclusions happens early, at a physical line level, so, like
4882 comment lines, an inclusion can be used in the middle of an option setting,
4883 for example:
4884 .code
4885 hosts_lookup = a.b.c \
4886                .include /some/file
4887 .endd
4888 Include processing happens after macro processing (see below). Its effect is to
4889 process the lines of the included file as if they occurred inline where the
4890 inclusion appears.
4891
4892
4893
4894 .section "Macros in the configuration file" "SECTmacrodefs"
4895 .cindex "macro" "description of"
4896 .cindex "configuration file" "macros"
4897 If a line in the main part of the configuration (that is, before the first
4898 &"begin"& line) begins with an upper case letter, it is taken as a macro
4899 definition, and must be of the form
4900 .display
4901 <&'name'&> = <&'rest of line'&>
4902 .endd
4903 The name must consist of letters, digits, and underscores, and need not all be
4904 in upper case, though that is recommended. The rest of the line, including any
4905 continuations, is the replacement text, and has leading and trailing white
4906 space removed. Quotes are not removed. The replacement text can never end with
4907 a backslash character, but this doesn't seem to be a serious limitation.
4908
4909 Macros may also be defined between router, transport, authenticator, or ACL
4910 definitions. They may not, however, be defined within an individual driver or
4911 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
4912
4913 .section "Macro substitution" "SECID42"
4914 Once a macro is defined, all subsequent lines in the file (and any included
4915 files) are scanned for the macro name; if there are several macros, the line is
4916 scanned for each in turn, in the order in which the macros are defined. The
4917 replacement text is not re-scanned for the current macro, though it is scanned
4918 for subsequently defined macros. For this reason, a macro name may not contain
4919 the name of a previously defined macro as a substring. You could, for example,
4920 define
4921 .display
4922 &`ABCD_XYZ = `&<&'something'&>
4923 &`ABCD = `&<&'something else'&>
4924 .endd
4925 but putting the definitions in the opposite order would provoke a configuration
4926 error. Macro expansion is applied to individual physical lines from the file,
4927 before checking for line continuation or file inclusion (see above). If a line
4928 consists solely of a macro name, and the expansion of the macro is empty, the
4929 line is ignored. A macro at the start of a line may turn the line into a
4930 comment line or a &`.include`& line.
4931
4932
4933 .section "Redefining macros" "SECID43"
4934 Once defined, the value of a macro can be redefined later in the configuration
4935 (or in an included file). Redefinition is specified by using &'=='& instead of
4936 &'='&. For example:
4937 .code
4938 MAC =  initial value
4939 ...
4940 MAC == updated value
4941 .endd
4942 Redefinition does not alter the order in which the macros are applied to the
4943 subsequent lines of the configuration file. It is still the same order in which
4944 the macros were originally defined. All that changes is the macro's value.
4945 Redefinition makes it possible to accumulate values. For example:
4946 .code
4947 MAC =  initial value
4948 ...
4949 MAC == MAC and something added
4950 .endd
4951 This can be helpful in situations where the configuration file is built
4952 from a number of other files.
4953
4954 .section "Overriding macro values" "SECID44"
4955 The values set for macros in the configuration file can be overridden by the
4956 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
4957 used, unless called by root or the Exim user. A definition on the command line
4958 using the &%-D%& option causes all definitions and redefinitions within the
4959 file to be ignored.
4960
4961
4962
4963 .section "Example of macro usage" "SECID45"
4964 As an example of macro usage, consider a configuration where aliases are looked
4965 up in a MySQL database. It helps to keep the file less cluttered if long
4966 strings such as SQL statements are defined separately as macros, for example:
4967 .code
4968 ALIAS_QUERY = select mailbox from user where \
4969               login='${quote_mysql:$local_part}';
4970 .endd
4971 This can then be used in a &(redirect)& router setting like this:
4972 .code
4973 data = ${lookup mysql{ALIAS_QUERY}}
4974 .endd
4975 In earlier versions of Exim macros were sometimes used for domain, host, or
4976 address lists. In Exim 4 these are handled better by named lists &-- see
4977 section &<<SECTnamedlists>>&.
4978
4979
4980 .section "Conditional skips in the configuration file" "SECID46"
4981 .cindex "configuration file" "conditional skips"
4982 .cindex "&`.ifdef`&"
4983 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
4984 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
4985 portions of the configuration file. The processing happens whenever the file is
4986 read (that is, when an Exim binary starts to run).
4987
4988 The implementation is very simple. Instances of the first four directives must
4989 be followed by text that includes the names of one or macros. The condition
4990 that is tested is whether or not any macro substitution has taken place in the
4991 line. Thus:
4992 .code
4993 .ifdef AAA
4994 message_size_limit = 50M
4995 .else
4996 message_size_limit = 100M
4997 .endif
4998 .endd
4999 sets a message size limit of 50M if the macro &`AAA`& is defined, and 100M
5000 otherwise. If there is more than one macro named on the line, the condition
5001 is true if any of them are defined. That is, it is an &"or"& condition. To
5002 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
5003
5004 Although you can use a macro expansion to generate one of these directives,
5005 it is not very useful, because the condition &"there was a macro substitution
5006 in this line"& will always be true.
5007
5008 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
5009 to clarify complicated nestings.
5010
5011
5012
5013 .section "Common option syntax" "SECTcos"
5014 .cindex "common option syntax"
5015 .cindex "syntax of common options"
5016 .cindex "configuration file" "common option syntax"
5017 For the main set of options, driver options, and &[local_scan()]& options,
5018 each setting is on a line by itself, and starts with a name consisting of
5019 lower-case letters and underscores. Many options require a data value, and in
5020 these cases the name must be followed by an equals sign (with optional white
5021 space) and then the value. For example:
5022 .code
5023 qualify_domain = mydomain.example.com
5024 .endd
5025 .cindex "hiding configuration option values"
5026 .cindex "configuration options" "hiding value of"
5027 .cindex "options" "hiding value of"
5028 Some option settings may contain sensitive data, for example, passwords for
5029 accessing databases. To stop non-admin users from using the &%-bP%& command
5030 line option to read these values, you can precede the option settings with the
5031 word &"hide"&. For example:
5032 .code
5033 hide mysql_servers = localhost/users/admin/secret-password
5034 .endd
5035 For non-admin users, such options are displayed like this:
5036 .code
5037 mysql_servers = <value not displayable>
5038 .endd
5039 If &"hide"& is used on a driver option, it hides the value of that option on
5040 all instances of the same driver.
5041
5042 The following sections describe the syntax used for the different data types
5043 that are found in option settings.
5044
5045
5046 .section "Boolean options" "SECID47"
5047 .cindex "format" "boolean"
5048 .cindex "boolean configuration values"
5049 .oindex "&%no_%&&'xxx'&"
5050 .oindex "&%not_%&&'xxx'&"
5051 Options whose type is given as boolean are on/off switches. There are two
5052 different ways of specifying such options: with and without a data value. If
5053 the option name is specified on its own without data, the switch is turned on;
5054 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5055 boolean options may be followed by an equals sign and one of the words
5056 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5057 the following two settings have exactly the same effect:
5058 .code
5059 queue_only
5060 queue_only = true
5061 .endd
5062 The following two lines also have the same (opposite) effect:
5063 .code
5064 no_queue_only
5065 queue_only = false
5066 .endd
5067 You can use whichever syntax you prefer.
5068
5069
5070
5071
5072 .section "Integer values" "SECID48"
5073 .cindex "integer configuration values"
5074 .cindex "format" "integer"
5075 If an option's type is given as &"integer"&, the value can be given in decimal,
5076 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5077 number is assumed. Otherwise, it is treated as an octal number unless it starts
5078 with the characters &"0x"&, in which case the remainder is interpreted as a
5079 hexadecimal number.
5080
5081 If an integer value is followed by the letter K, it is multiplied by 1024; if
5082 it is followed by the letter M, it is multiplied by 1024x1024. When the values
5083 of integer option settings are output, values which are an exact multiple of
5084 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5085 and M. The printing style is independent of the actual input format that was
5086 used.
5087
5088
5089 .section "Octal integer values" "SECID49"
5090 .cindex "integer format"
5091 .cindex "format" "octal integer"
5092 If an option's type is given as &"octal integer"&, its value is always
5093 interpreted as an octal number, whether or not it starts with the digit zero.
5094 Such options are always output in octal.
5095
5096
5097 .section "Fixed point numbers" "SECID50"
5098 .cindex "fixed point configuration values"
5099 .cindex "format" "fixed point"
5100 If an option's type is given as &"fixed-point"&, its value must be a decimal
5101 integer, optionally followed by a decimal point and up to three further digits.
5102
5103
5104
5105 .section "Time intervals" "SECTtimeformat"
5106 .cindex "time interval" "specifying in configuration"
5107 .cindex "format" "time interval"
5108 A time interval is specified as a sequence of numbers, each followed by one of
5109 the following letters, with no intervening white space:
5110
5111 .table2 30pt
5112 .irow &%s%& seconds
5113 .irow &%m%& minutes
5114 .irow &%h%& hours
5115 .irow &%d%& days
5116 .irow &%w%& weeks
5117 .endtable
5118
5119 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5120 intervals are output in the same format. Exim does not restrict the values; it
5121 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5122
5123
5124
5125 .section "String values" "SECTstrings"
5126 .cindex "string" "format of configuration values"
5127 .cindex "format" "string"
5128 If an option's type is specified as &"string"&, the value can be specified with
5129 or without double-quotes. If it does not start with a double-quote, the value
5130 consists of the remainder of the line plus any continuation lines, starting at
5131 the first character after any leading white space, with trailing white space
5132 removed, and with no interpretation of the characters in the string. Because
5133 Exim removes comment lines (those beginning with #) at an early stage, they can
5134 appear in the middle of a multi-line string. The following two settings are
5135 therefore equivalent:
5136 .code
5137 trusted_users = uucp:mail
5138 trusted_users = uucp:\
5139                 # This comment line is ignored
5140                 mail
5141 .endd
5142 .cindex "string" "quoted"
5143 .cindex "escape characters in quoted strings"
5144 If a string does start with a double-quote, it must end with a closing
5145 double-quote, and any backslash characters other than those used for line
5146 continuation are interpreted as escape characters, as follows:
5147
5148 .table2 100pt
5149 .irow &`\\`&                     "single backslash"
5150 .irow &`\n`&                     "newline"
5151 .irow &`\r`&                     "carriage return"
5152 .irow &`\t`&                     "tab"
5153 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5154 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5155                                    character"
5156 .endtable
5157
5158 If a backslash is followed by some other character, including a double-quote
5159 character, that character replaces the pair.
5160
5161 Quoting is necessary only if you want to make use of the backslash escapes to
5162 insert special characters, or if you need to specify a value with leading or
5163 trailing spaces. These cases are rare, so quoting is almost never needed in
5164 current versions of Exim. In versions of Exim before 3.14, quoting was required
5165 in order to continue lines, so you may come across older configuration files
5166 and examples that apparently quote unnecessarily.
5167
5168
5169 .section "Expanded strings" "SECID51"
5170 .cindex "expansion" "definition of"
5171 Some strings in the configuration file are subjected to &'string expansion'&,
5172 by which means various parts of the string may be changed according to the
5173 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5174 is as just described; in particular, the handling of backslashes in quoted
5175 strings is done as part of the input process, before expansion takes place.
5176 However, backslash is also an escape character for the expander, so any
5177 backslashes that are required for that reason must be doubled if they are
5178 within a quoted configuration string.
5179
5180
5181 .section "User and group names" "SECID52"
5182 .cindex "user name" "format of"
5183 .cindex "format" "user name"
5184 .cindex "groups" "name format"
5185 .cindex "format" "group name"
5186 User and group names are specified as strings, using the syntax described
5187 above, but the strings are interpreted specially. A user or group name must
5188 either consist entirely of digits, or be a name that can be looked up using the
5189 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5190
5191
5192 .section "List construction" "SECTlistconstruct"
5193 .cindex "list" "syntax of in configuration"
5194 .cindex "format" "list item in configuration"
5195 .cindex "string" "list, definition of"
5196 The data for some configuration options is a list of items, with colon as the
5197 default separator. Many of these options are shown with type &"string list"& in
5198 the descriptions later in this document. Others are listed as &"domain list"&,
5199 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5200 are all the same; however, those other than &"string list"& are subject to
5201 particular kinds of interpretation, as described in chapter
5202 &<<CHAPdomhosaddlists>>&.
5203
5204 In all these cases, the entire list is treated as a single string as far as the
5205 input syntax is concerned. The &%trusted_users%& setting in section
5206 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5207 in a list, it must be entered as two colons. Leading and trailing white space
5208 on each item in a list is ignored. This makes it possible to include items that
5209 start with a colon, and in particular, certain forms of IPv6 address. For
5210 example, the list
5211 .code
5212 local_interfaces = 127.0.0.1 : ::::1
5213 .endd
5214 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5215
5216 &*Note*&: Although leading and trailing white space is ignored in individual
5217 list items, it is not ignored when parsing the list. The space after the first
5218 colon in the example above is necessary. If it were not there, the list would
5219 be interpreted as the two items 127.0.0.1:: and 1.
5220
5221 .section "Changing list separators" "SECID53"
5222 .cindex "list separator" "changing"
5223 .cindex "IPv6" "addresses in lists"
5224 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5225 introduced to allow the separator character to be changed. If a list begins
5226 with a left angle bracket, followed by any punctuation character, that
5227 character is used instead of colon as the list separator. For example, the list
5228 above can be rewritten to use a semicolon separator like this:
5229 .code
5230 local_interfaces = <; 127.0.0.1 ; ::1
5231 .endd
5232 This facility applies to all lists, with the exception of the list in
5233 &%log_file_path%&. It is recommended that the use of non-colon separators be
5234 confined to circumstances where they really are needed.
5235
5236 .cindex "list separator" "newline as"
5237 .cindex "newline" "as list separator"
5238 It is also possible to use newline and other control characters (those with
5239 code values less than 32, plus DEL) as separators in lists. Such separators
5240 must be provided literally at the time the list is processed. For options that
5241 are string-expanded, you can write the separator using a normal escape
5242 sequence. This will be processed by the expander before the string is
5243 interpreted as a list. For example, if a newline-separated list of domains is
5244 generated by a lookup, you can process it directly by a line such as this:
5245 .code
5246 domains = <\n ${lookup mysql{.....}}
5247 .endd
5248 This avoids having to change the list separator in such data. You are unlikely
5249 to want to use a control character as a separator in an option that is not
5250 expanded, because the value is literal text. However, it can be done by giving
5251 the value in quotes. For example:
5252 .code
5253 local_interfaces = "<\n 127.0.0.1 \n ::1"
5254 .endd
5255 Unlike printing character separators, which can be included in list items by
5256 doubling, it is not possible to include a control character as data when it is
5257 set as the separator. Two such characters in succession are interpreted as
5258 enclosing an empty list item.
5259
5260
5261
5262 .section "Empty items in lists" "SECTempitelis"
5263 .cindex "list" "empty item in"
5264 An empty item at the end of a list is always ignored. In other words, trailing
5265 separator characters are ignored. Thus, the list in
5266 .code
5267 senders = user@domain :
5268 .endd
5269 contains only a single item. If you want to include an empty string as one item
5270 in a list, it must not be the last item. For example, this list contains three
5271 items, the second of which is empty:
5272 .code
5273 senders = user1@domain : : user2@domain
5274 .endd
5275 &*Note*&: There must be white space between the two colons, as otherwise they
5276 are interpreted as representing a single colon data character (and the list
5277 would then contain just one item). If you want to specify a list that contains
5278 just one, empty item, you can do it as in this example:
5279 .code
5280 senders = :
5281 .endd
5282 In this case, the first item is empty, and the second is discarded because it
5283 is at the end of the list.
5284
5285
5286
5287
5288 .section "Format of driver configurations" "SECTfordricon"
5289 .cindex "drivers" "configuration format"
5290 There are separate parts in the configuration for defining routers, transports,
5291 and authenticators. In each part, you are defining a number of driver
5292 instances, each with its own set of options. Each driver instance is defined by
5293 a sequence of lines like this:
5294 .display
5295 <&'instance name'&>:
5296   <&'option'&>
5297   ...
5298   <&'option'&>
5299 .endd
5300 In the following example, the instance name is &(localuser)&, and it is
5301 followed by three options settings:
5302 .code
5303 localuser:
5304   driver = accept
5305   check_local_user
5306   transport = local_delivery
5307 .endd
5308 For each driver instance, you specify which Exim code module it uses &-- by the
5309 setting of the &%driver%& option &-- and (optionally) some configuration
5310 settings. For example, in the case of transports, if you want a transport to
5311 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5312 a local file you would use the &(appendfile)& driver. Each of the drivers is
5313 described in detail in its own separate chapter later in this manual.
5314
5315 You can have several routers, transports, or authenticators that are based on
5316 the same underlying driver (each must have a different instance name).
5317
5318 The order in which routers are defined is important, because addresses are
5319 passed to individual routers one by one, in order. The order in which
5320 transports are defined does not matter at all. The order in which
5321 authenticators are defined is used only when Exim, as a client, is searching
5322 them to find one that matches an authentication mechanism offered by the
5323 server.
5324
5325 .cindex "generic options"
5326 .cindex "options" "generic &-- definition of"
5327 Within a driver instance definition, there are two kinds of option: &'generic'&
5328 and &'private'&. The generic options are those that apply to all drivers of the
5329 same type (that is, all routers, all transports or all authenticators). The
5330 &%driver%& option is a generic option that must appear in every definition.
5331 .cindex "private options"
5332 The private options are special for each driver, and none need appear, because
5333 they all have default values.
5334
5335 The options may appear in any order, except that the &%driver%& option must
5336 precede any private options, since these depend on the particular driver. For
5337 this reason, it is recommended that &%driver%& always be the first option.
5338
5339 Driver instance names, which are used for reference in log entries and
5340 elsewhere, can be any sequence of letters, digits, and underscores (starting
5341 with a letter) and must be unique among drivers of the same type. A router and
5342 a transport (for example) can each have the same name, but no two router
5343 instances can have the same name. The name of a driver instance should not be
5344 confused with the name of the underlying driver module. For example, the
5345 configuration lines:
5346 .code
5347 remote_smtp:
5348   driver = smtp
5349 .endd
5350 create an instance of the &(smtp)& transport driver whose name is
5351 &(remote_smtp)&. The same driver code can be used more than once, with
5352 different instance names and different option settings each time. A second
5353 instance of the &(smtp)& transport, with different options, might be defined
5354 thus:
5355 .code
5356 special_smtp:
5357   driver = smtp
5358   port = 1234
5359   command_timeout = 10s
5360 .endd
5361 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5362 these transport instances from routers, and these names would appear in log
5363 lines.
5364
5365 Comment lines may be present in the middle of driver specifications. The full
5366 list of option settings for any particular driver instance, including all the
5367 defaulted values, can be extracted by making use of the &%-bP%& command line
5368 option.
5369
5370
5371
5372
5373
5374
5375 . ////////////////////////////////////////////////////////////////////////////
5376 . ////////////////////////////////////////////////////////////////////////////
5377
5378 .chapter "The default configuration file" "CHAPdefconfil"
5379 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5380 .cindex "default" "configuration file &""walk through""&"
5381 The default configuration file supplied with Exim as &_src/configure.default_&
5382 is sufficient for a host with simple mail requirements. As an introduction to
5383 the way Exim is configured, this chapter &"walks through"& the default
5384 configuration, giving brief explanations of the settings. Detailed descriptions
5385 of the options are given in subsequent chapters. The default configuration file
5386 itself contains extensive comments about ways you might want to modify the
5387 initial settings. However, note that there are many options that are not
5388 mentioned at all in the default configuration.
5389
5390
5391
5392 .section "Main configuration settings" "SECTdefconfmain"
5393 The main (global) configuration option settings must always come first in the
5394 file. The first thing you'll see in the file, after some initial comments, is
5395 the line
5396 .code
5397 # primary_hostname =
5398 .endd
5399 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5400 to know the official, fully qualified name of your host, and this is where you
5401 can specify it. However, in most cases you do not need to set this option. When
5402 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5403
5404 The first three non-comment configuration lines are as follows:
5405 .code
5406 domainlist local_domains    = @
5407 domainlist relay_to_domains =
5408 hostlist   relay_from_hosts = 127.0.0.1
5409 .endd
5410 These are not, in fact, option settings. They are definitions of two named
5411 domain lists and one named host list. Exim allows you to give names to lists of
5412 domains, hosts, and email addresses, in order to make it easier to manage the
5413 configuration file (see section &<<SECTnamedlists>>&).
5414
5415 The first line defines a domain list called &'local_domains'&; this is used
5416 later in the configuration to identify domains that are to be delivered
5417 on the local host.
5418
5419 .cindex "@ in a domain list"
5420 There is just one item in this list, the string &"@"&. This is a special form
5421 of entry which means &"the name of the local host"&. Thus, if the local host is
5422 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5423 be delivered locally. Because the local host's name is referenced indirectly,
5424 the same configuration file can be used on different hosts.
5425
5426 The second line defines a domain list called &'relay_to_domains'&, but the
5427 list itself is empty. Later in the configuration we will come to the part that
5428 controls mail relaying through the local host; it allows relaying to any
5429 domains in this list. By default, therefore, no relaying on the basis of a mail
5430 domain is permitted.
5431
5432 The third line defines a host list called &'relay_from_hosts'&. This list is
5433 used later in the configuration to permit relaying from any host or IP address
5434 that matches the list. The default contains just the IP address of the IPv4
5435 loopback interface, which means that processes on the local host are able to
5436 submit mail for relaying by sending it over TCP/IP to that interface. No other
5437 hosts are permitted to submit messages for relaying.
5438
5439 Just to be sure there's no misunderstanding: at this point in the configuration
5440 we aren't actually setting up any controls. We are just defining some domains
5441 and hosts that will be used in the controls that are specified later.
5442
5443 The next two configuration lines are genuine option settings:
5444 .code
5445 acl_smtp_rcpt = acl_check_rcpt
5446 acl_smtp_data = acl_check_data
5447 .endd
5448 These options specify &'Access Control Lists'& (ACLs) that are to be used
5449 during an incoming SMTP session for every recipient of a message (every RCPT
5450 command), and after the contents of the message have been received,
5451 respectively. The names of the lists are &'acl_check_rcpt'& and
5452 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5453 section of the configuration. The RCPT ACL controls which recipients are
5454 accepted for an incoming message &-- if a configuration does not provide an ACL
5455 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5456 contents of a message to be checked.
5457
5458 Two commented-out option settings are next:
5459 .code
5460 # av_scanner = clamd:/tmp/clamd
5461 # spamd_address = 127.0.0.1 783
5462 .endd
5463 These are example settings that can be used when Exim is compiled with the
5464 content-scanning extension. The first specifies the interface to the virus
5465 scanner, and the second specifies the interface to SpamAssassin. Further
5466 details are given in chapter &<<CHAPexiscan>>&.
5467
5468 Three more commented-out option settings follow:
5469 .code
5470 # tls_advertise_hosts = *
5471 # tls_certificate = /etc/ssl/exim.crt
5472 # tls_privatekey = /etc/ssl/exim.pem
5473 .endd
5474 These are example settings that can be used when Exim is compiled with
5475 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5476 first one specifies the list of clients that are allowed to use TLS when
5477 connecting to this server; in this case the wildcard means all clients. The
5478 other options specify where Exim should find its TLS certificate and private
5479 key, which together prove the server's identity to any clients that connect.
5480 More details are given in chapter &<<CHAPTLS>>&.
5481
5482 Another two commented-out option settings follow:
5483 .code
5484 # daemon_smtp_ports = 25 : 465 : 587
5485 # tls_on_connect_ports = 465
5486 .endd
5487 .cindex "port" "465 and 587"
5488 .cindex "port" "for message submission"
5489 .cindex "message" "submission, ports for"
5490 .cindex "ssmtp protocol"
5491 .cindex "smtps protocol"
5492 .cindex "SMTP" "ssmtp protocol"
5493 .cindex "SMTP" "smtps protocol"
5494 These options provide better support for roaming users who wish to use this
5495 server for message submission. They are not much use unless you have turned on
5496 TLS (as described in the previous paragraph) and authentication (about which
5497 more in section &<<SECTdefconfauth>>&). The usual SMTP port 25 is often blocked
5498 on end-user networks, so RFC 4409 specifies that message submission should use
5499 port 587 instead. However some software (notably Microsoft Outlook) cannot be
5500 configured to use port 587 correctly, so these settings also enable the
5501 non-standard &"smtps"& (aka &"ssmtp"&) port 465 (see section
5502 &<<SECTsupobssmt>>&).
5503
5504 Two more commented-out options settings follow:
5505 .code
5506 # qualify_domain =
5507 # qualify_recipient =
5508 .endd
5509 The first of these specifies a domain that Exim uses when it constructs a
5510 complete email address from a local login name. This is often needed when Exim
5511 receives a message from a local process. If you do not set &%qualify_domain%&,
5512 the value of &%primary_hostname%& is used. If you set both of these options,
5513 you can have different qualification domains for sender and recipient
5514 addresses. If you set only the first one, its value is used in both cases.
5515
5516 .cindex "domain literal" "recognizing format"
5517 The following line must be uncommented if you want Exim to recognize
5518 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5519 (an IP address within square brackets) instead of a named domain.
5520 .code
5521 # allow_domain_literals
5522 .endd
5523 The RFCs still require this form, but many people think that in the modern
5524 Internet it makes little sense to permit mail to be sent to specific hosts by
5525 quoting their IP addresses. This ancient format has been used by people who
5526 try to abuse hosts by using them for unwanted relaying. However, some
5527 people believe there are circumstances (for example, messages addressed to
5528 &'postmaster'&) where domain literals are still useful.
5529
5530 The next configuration line is a kind of trigger guard:
5531 .code
5532 never_users = root
5533 .endd
5534 It specifies that no delivery must ever be run as the root user. The normal
5535 convention is to set up &'root'& as an alias for the system administrator. This
5536 setting is a guard against slips in the configuration.
5537 The list of users specified by &%never_users%& is not, however, the complete
5538 list; the build-time configuration in &_Local/Makefile_& has an option called
5539 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5540 contents of &%never_users%& are added to this list. By default
5541 FIXED_NEVER_USERS also specifies root.
5542
5543 When a remote host connects to Exim in order to send mail, the only information
5544 Exim has about the host's identity is its IP address. The next configuration
5545 line,
5546 .code
5547 host_lookup = *
5548 .endd
5549 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5550 in order to get a host name. This improves the quality of the logging
5551 information, but if you feel it is too expensive, you can remove it entirely,
5552 or restrict the lookup to hosts on &"nearby"& networks.
5553 Note that it is not always possible to find a host name from an IP address,
5554 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5555 unreachable.
5556
5557 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5558 1413 (hence their names):
5559 .code
5560 rfc1413_hosts = *
5561 rfc1413_query_timeout = 0s
5562 .endd
5563 These settings cause Exim to avoid ident callbacks for all incoming SMTP calls.
5564 Few hosts offer RFC1413 service these days; calls have to be
5565 terminated by a timeout and this needlessly delays the startup
5566 of an incoming SMTP connection.
5567 If you have hosts for which you trust RFC1413 and need this
5568 information, you can change this.
5569
5570 This line enables an efficiency SMTP option.  It is negotiated by clients
5571 and not expected to cause problems but can be disabled if needed.
5572 .code
5573 prdr_enable = true
5574 .endd
5575
5576 When Exim receives messages over SMTP connections, it expects all addresses to
5577 be fully qualified with a domain, as required by the SMTP definition. However,
5578 if you are running a server to which simple clients submit messages, you may
5579 find that they send unqualified addresses. The two commented-out options:
5580 .code
5581 # sender_unqualified_hosts =
5582 # recipient_unqualified_hosts =
5583 .endd
5584 show how you can specify hosts that are permitted to send unqualified sender
5585 and recipient addresses, respectively.
5586
5587 The &%percent_hack_domains%& option is also commented out:
5588 .code
5589 # percent_hack_domains =
5590 .endd
5591 It provides a list of domains for which the &"percent hack"& is to operate.
5592 This is an almost obsolete form of explicit email routing. If you do not know
5593 anything about it, you can safely ignore this topic.
5594
5595 The last two settings in the main part of the default configuration are
5596 concerned with messages that have been &"frozen"& on Exim's queue. When a
5597 message is frozen, Exim no longer continues to try to deliver it. Freezing
5598 occurs when a bounce message encounters a permanent failure because the sender
5599 address of the original message that caused the bounce is invalid, so the
5600 bounce cannot be delivered. This is probably the most common case, but there
5601 are also other conditions that cause freezing, and frozen messages are not
5602 always bounce messages.
5603 .code
5604 ignore_bounce_errors_after = 2d
5605 timeout_frozen_after = 7d
5606 .endd
5607 The first of these options specifies that failing bounce messages are to be
5608 discarded after 2 days on the queue. The second specifies that any frozen
5609 message (whether a bounce message or not) is to be timed out (and discarded)
5610 after a week. In this configuration, the first setting ensures that no failing
5611 bounce message ever lasts a week.
5612
5613
5614
5615 .section "ACL configuration" "SECID54"
5616 .cindex "default" "ACLs"
5617 .cindex "&ACL;" "default configuration"
5618 In the default configuration, the ACL section follows the main configuration.
5619 It starts with the line
5620 .code
5621 begin acl
5622 .endd
5623 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5624 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5625 and &%acl_smtp_data%& above.
5626
5627 .cindex "RCPT" "ACL for"
5628 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5629 RCPT command specifies one of the message's recipients. The ACL statements
5630 are considered in order, until the recipient address is either accepted or
5631 rejected. The RCPT command is then accepted or rejected, according to the
5632 result of the ACL processing.
5633 .code
5634 acl_check_rcpt:
5635 .endd
5636 This line, consisting of a name terminated by a colon, marks the start of the
5637 ACL, and names it.
5638 .code
5639 accept  hosts = :
5640 .endd
5641 This ACL statement accepts the recipient if the sending host matches the list.
5642 But what does that strange list mean? It doesn't actually contain any host
5643 names or IP addresses. The presence of the colon puts an empty item in the
5644 list; Exim matches this only if the incoming message did not come from a remote
5645 host, because in that case, the remote hostname is empty. The colon is
5646 important. Without it, the list itself is empty, and can never match anything.
5647
5648 What this statement is doing is to accept unconditionally all recipients in
5649 messages that are submitted by SMTP from local processes using the standard
5650 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5651 manner.
5652 .code
5653 deny    message       = Restricted characters in address
5654         domains       = +local_domains
5655         local_parts   = ^[.] : ^.*[@%!/|]
5656
5657 deny    message       = Restricted characters in address
5658         domains       = !+local_domains
5659         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5660 .endd
5661 These statements are concerned with local parts that contain any of the
5662 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5663 Although these characters are entirely legal in local parts (in the case of
5664 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5665 in Internet mail addresses.
5666
5667 The first three have in the past been associated with explicitly routed
5668 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5669 option). Addresses containing these characters are regularly tried by spammers
5670 in an attempt to bypass relaying restrictions, and also by open relay testing
5671 programs. Unless you really need them it is safest to reject these characters
5672 at this early stage. This configuration is heavy-handed in rejecting these
5673 characters for all messages it accepts from remote hosts. This is a deliberate
5674 policy of being as safe as possible.
5675
5676 The first rule above is stricter, and is applied to messages that are addressed
5677 to one of the local domains handled by this host. This is implemented by the
5678 first condition, which restricts it to domains that are listed in the
5679 &'local_domains'& domain list. The &"+"& character is used to indicate a
5680 reference to a named list. In this configuration, there is just one domain in
5681 &'local_domains'&, but in general there may be many.
5682
5683 The second condition on the first statement uses two regular expressions to
5684 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5685 or &"|"&. If you have local accounts that include these characters, you will
5686 have to modify this rule.
5687
5688 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5689 allows them because they have been encountered in practice. (Consider the
5690 common convention of local parts constructed as
5691 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5692 the author of Exim, who has no second initial.) However, a local part starting
5693 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5694 file name (for example, for a mailing list). This is also true for local parts
5695 that contain slashes. A pipe symbol can also be troublesome if the local part
5696 is incorporated unthinkingly into a shell command line.
5697
5698 The second rule above applies to all other domains, and is less strict. This
5699 allows your own users to send outgoing messages to sites that use slashes
5700 and vertical bars in their local parts. It blocks local parts that begin
5701 with a dot, slash, or vertical bar, but allows these characters within the
5702 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5703 and &"!"& is blocked, as before. The motivation here is to prevent your users
5704 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5705 .code
5706 accept  local_parts   = postmaster
5707         domains       = +local_domains
5708 .endd
5709 This statement, which has two conditions, accepts an incoming address if the
5710 local part is &'postmaster'& and the domain is one of those listed in the
5711 &'local_domains'& domain list. The &"+"& character is used to indicate a
5712 reference to a named list. In this configuration, there is just one domain in
5713 &'local_domains'&, but in general there may be many.
5714
5715 The presence of this statement means that mail to postmaster is never blocked
5716 by any of the subsequent tests. This can be helpful while sorting out problems
5717 in cases where the subsequent tests are incorrectly denying access.
5718 .code
5719 require verify        = sender
5720 .endd
5721 This statement requires the sender address to be verified before any subsequent
5722 ACL statement can be used. If verification fails, the incoming recipient
5723 address is refused. Verification consists of trying to route the address, to
5724 see if a bounce message could be delivered to it. In the case of remote
5725 addresses, basic verification checks only the domain, but &'callouts'& can be
5726 used for more verification if required. Section &<<SECTaddressverification>>&
5727 discusses the details of address verification.
5728 .code
5729 accept  hosts         = +relay_from_hosts
5730         control       = submission
5731 .endd
5732 This statement accepts the address if the message is coming from one of the
5733 hosts that are defined as being allowed to relay through this host. Recipient
5734 verification is omitted here, because in many cases the clients are dumb MUAs
5735 that do not cope well with SMTP error responses. For the same reason, the
5736 second line specifies &"submission mode"& for messages that are accepted. This
5737 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5738 messages that are deficient in some way, for example, because they lack a
5739 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5740 probably add recipient verification here, and disable submission mode.
5741 .code
5742 accept  authenticated = *
5743         control       = submission
5744 .endd
5745 This statement accepts the address if the client host has authenticated itself.
5746 Submission mode is again specified, on the grounds that such messages are most
5747 likely to come from MUAs. The default configuration does not define any
5748 authenticators, though it does include some nearly complete commented-out
5749 examples described in &<<SECTdefconfauth>>&. This means that no client can in
5750 fact authenticate until you complete the authenticator definitions.
5751 .code
5752 require message = relay not permitted
5753         domains = +local_domains : +relay_to_domains
5754 .endd
5755 This statement rejects the address if its domain is neither a local domain nor
5756 one of the domains for which this host is a relay.
5757 .code
5758 require verify = recipient
5759 .endd
5760 This statement requires the recipient address to be verified; if verification
5761 fails, the address is rejected.
5762 .code
5763 # deny    message     = rejected because $sender_host_address \
5764 #                       is in a black list at $dnslist_domain\n\
5765 #                       $dnslist_text
5766 #         dnslists    = black.list.example
5767 #
5768 # warn    dnslists    = black.list.example
5769 #         add_header  = X-Warning: $sender_host_address is in \
5770 #                       a black list at $dnslist_domain
5771 #         log_message = found in $dnslist_domain
5772 .endd
5773 These commented-out lines are examples of how you could configure Exim to check
5774 sending hosts against a DNS black list. The first statement rejects messages
5775 from blacklisted hosts, whereas the second just inserts a warning header
5776 line.
5777 .code
5778 # require verify = csa
5779 .endd
5780 This commented-out line is an example of how you could turn on client SMTP
5781 authorization (CSA) checking. Such checks do DNS lookups for special SRV
5782 records.
5783 .code
5784 accept
5785 .endd
5786 The final statement in the first ACL unconditionally accepts any recipient
5787 address that has successfully passed all the previous tests.
5788 .code
5789 acl_check_data:
5790 .endd
5791 This line marks the start of the second ACL, and names it. Most of the contents
5792 of this ACL are commented out:
5793 .code
5794 # deny    malware   = *
5795 #         message   = This message contains a virus \
5796 #                     ($malware_name).
5797 .endd
5798 These lines are examples of how to arrange for messages to be scanned for
5799 viruses when Exim has been compiled with the content-scanning extension, and a
5800 suitable virus scanner is installed. If the message is found to contain a
5801 virus, it is rejected with the given custom error message.
5802 .code
5803 # warn    spam      = nobody
5804 #         message   = X-Spam_score: $spam_score\n\
5805 #                     X-Spam_score_int: $spam_score_int\n\
5806 #                     X-Spam_bar: $spam_bar\n\
5807 #                     X-Spam_report: $spam_report
5808 .endd
5809 These lines are an example of how to arrange for messages to be scanned by
5810 SpamAssassin when Exim has been compiled with the content-scanning extension,
5811 and SpamAssassin has been installed. The SpamAssassin check is run with
5812 &`nobody`& as its user parameter, and the results are added to the message as a
5813 series of extra header line. In this case, the message is not rejected,
5814 whatever the spam score.
5815 .code
5816 accept
5817 .endd
5818 This final line in the DATA ACL accepts the message unconditionally.
5819
5820
5821 .section "Router configuration" "SECID55"
5822 .cindex "default" "routers"
5823 .cindex "routers" "default"
5824 The router configuration comes next in the default configuration, introduced
5825 by the line
5826 .code
5827 begin routers
5828 .endd
5829 Routers are the modules in Exim that make decisions about where to send
5830 messages. An address is passed to each router in turn, until it is either
5831 accepted, or failed. This means that the order in which you define the routers
5832 matters. Each router is fully described in its own chapter later in this
5833 manual. Here we give only brief overviews.
5834 .code
5835 # domain_literal:
5836 #   driver = ipliteral
5837 #   domains = !+local_domains
5838 #   transport = remote_smtp
5839 .endd
5840 .cindex "domain literal" "default router"
5841 This router is commented out because the majority of sites do not want to
5842 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
5843 you uncomment this router, you also need to uncomment the setting of
5844 &%allow_domain_literals%& in the main part of the configuration.
5845 .code
5846 dnslookup:
5847   driver = dnslookup
5848   domains = ! +local_domains
5849   transport = remote_smtp
5850   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
5851   no_more
5852 .endd
5853 The first uncommented router handles addresses that do not involve any local
5854 domains. This is specified by the line
5855 .code
5856 domains = ! +local_domains
5857 .endd
5858 The &%domains%& option lists the domains to which this router applies, but the
5859 exclamation mark is a negation sign, so the router is used only for domains
5860 that are not in the domain list called &'local_domains'& (which was defined at
5861 the start of the configuration). The plus sign before &'local_domains'&
5862 indicates that it is referring to a named list. Addresses in other domains are
5863 passed on to the following routers.
5864
5865 The name of the router driver is &(dnslookup)&,
5866 and is specified by the &%driver%& option. Do not be confused by the fact that
5867 the name of this router instance is the same as the name of the driver. The
5868 instance name is arbitrary, but the name set in the &%driver%& option must be
5869 one of the driver modules that is in the Exim binary.
5870
5871 The &(dnslookup)& router routes addresses by looking up their domains in the
5872 DNS in order to obtain a list of hosts to which the address is routed. If the
5873 router succeeds, the address is queued for the &(remote_smtp)& transport, as
5874 specified by the &%transport%& option. If the router does not find the domain
5875 in the DNS, no further routers are tried because of the &%no_more%& setting, so
5876 the address fails and is bounced.
5877
5878 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
5879 be entirely ignored. This option is present because a number of cases have been
5880 encountered where MX records in the DNS point to host names
5881 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
5882 Completely ignoring these IP addresses causes Exim to fail to route the
5883 email address, so it bounces. Otherwise, Exim would log a routing problem, and
5884 continue to try to deliver the message periodically until the address timed
5885 out.
5886 .code
5887 system_aliases:
5888   driver = redirect
5889   allow_fail
5890   allow_defer
5891   data = ${lookup{$local_part}lsearch{/etc/aliases}}
5892 # user = exim
5893   file_transport = address_file
5894   pipe_transport = address_pipe
5895 .endd
5896 Control reaches this and subsequent routers only for addresses in the local
5897 domains. This router checks to see whether the local part is defined as an
5898 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
5899 data that it looks up from that file. If no data is found for the local part,
5900 the value of the &%data%& option is empty, causing the address to be passed to
5901 the next router.
5902
5903 &_/etc/aliases_& is a conventional name for the system aliases file that is
5904 often used. That is why it is referenced by from the default configuration
5905 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
5906 &_Local/Makefile_& before building Exim.
5907 .code
5908 userforward:
5909   driver = redirect
5910   check_local_user
5911 # local_part_suffix = +* : -*
5912 # local_part_suffix_optional
5913   file = $home/.forward
5914 # allow_filter
5915   no_verify
5916   no_expn
5917   check_ancestor
5918   file_transport = address_file
5919   pipe_transport = address_pipe
5920   reply_transport = address_reply
5921 .endd
5922 This is the most complicated router in the default configuration. It is another
5923 redirection router, but this time it is looking for forwarding data set up by
5924 individual users. The &%check_local_user%& setting specifies a check that the
5925 local part of the address is the login name of a local user. If it is not, the
5926 router is skipped. The two commented options that follow &%check_local_user%&,
5927 namely:
5928 .code
5929 # local_part_suffix = +* : -*
5930 # local_part_suffix_optional
5931 .endd
5932 .vindex "&$local_part_suffix$&"
5933 show how you can specify the recognition of local part suffixes. If the first
5934 is uncommented, a suffix beginning with either a plus or a minus sign, followed
5935 by any sequence of characters, is removed from the local part and placed in the
5936 variable &$local_part_suffix$&. The second suffix option specifies that the
5937 presence of a suffix in the local part is optional. When a suffix is present,
5938 the check for a local login uses the local part with the suffix removed.
5939
5940 When a local user account is found, the file called &_.forward_& in the user's
5941 home directory is consulted. If it does not exist, or is empty, the router
5942 declines. Otherwise, the contents of &_.forward_& are interpreted as
5943 redirection data (see chapter &<<CHAPredirect>>& for more details).
5944
5945 .cindex "Sieve filter" "enabling in default router"
5946 Traditional &_.forward_& files contain just a list of addresses, pipes, or
5947 files. Exim supports this by default. However, if &%allow_filter%& is set (it
5948 is commented out by default), the contents of the file are interpreted as a set
5949 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
5950 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
5951 separate document entitled &'Exim's interfaces to mail filtering'&.
5952
5953 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
5954 verifying addresses, or when running as a consequence of an SMTP EXPN command.
5955 There are two reasons for doing this:
5956
5957 .olist
5958 Whether or not a local user has a &_.forward_& file is not really relevant when
5959 checking an address for validity; it makes sense not to waste resources doing
5960 unnecessary work.
5961 .next
5962 More importantly, when Exim is verifying addresses or handling an EXPN
5963 command during an SMTP session, it is running as the Exim user, not as root.
5964 The group is the Exim group, and no additional groups are set up.
5965 It may therefore not be possible for Exim to read users' &_.forward_& files at
5966 this time.
5967 .endlist
5968
5969 The setting of &%check_ancestor%& prevents the router from generating a new
5970 address that is the same as any previous address that was redirected. (This
5971 works round a problem concerning a bad interaction between aliasing and
5972 forwarding &-- see section &<<SECTredlocmai>>&).
5973
5974 The final three option settings specify the transports that are to be used when
5975 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
5976 auto-reply, respectively. For example, if a &_.forward_& file contains
5977 .code
5978 a.nother@elsewhere.example, /home/spqr/archive
5979 .endd
5980 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
5981 transport.
5982 .code
5983 localuser:
5984   driver = accept
5985   check_local_user
5986 # local_part_suffix = +* : -*
5987 # local_part_suffix_optional
5988   transport = local_delivery
5989 .endd
5990 The final router sets up delivery into local mailboxes, provided that the local
5991 part is the name of a local login, by accepting the address and assigning it to
5992 the &(local_delivery)& transport. Otherwise, we have reached the end of the
5993 routers, so the address is bounced. The commented suffix settings fulfil the
5994 same purpose as they do for the &(userforward)& router.
5995
5996
5997 .section "Transport configuration" "SECID56"
5998 .cindex "default" "transports"
5999 .cindex "transports" "default"
6000 Transports define mechanisms for actually delivering messages. They operate
6001 only when referenced from routers, so the order in which they are defined does
6002 not matter. The transports section of the configuration starts with
6003 .code
6004 begin transports
6005 .endd
6006 One remote transport and four local transports are defined.
6007 .code
6008 remote_smtp:
6009   driver = smtp
6010   hosts_try_prdr = *
6011 .endd
6012 This transport is used for delivering messages over SMTP connections.
6013 The list of remote hosts comes from the router.
6014 The &%hosts_try_prdr%& option enables an efficiency SMTP option.
6015 It is negotiated between client and server
6016 and not expected to cause problems but can be disabled if needed.
6017 All other options are defaulted.
6018 .code
6019 local_delivery:
6020   driver = appendfile
6021   file = /var/mail/$local_part
6022   delivery_date_add
6023   envelope_to_add
6024   return_path_add
6025 # group = mail
6026 # mode = 0660
6027 .endd
6028 This &(appendfile)& transport is used for local delivery to user mailboxes in
6029 traditional BSD mailbox format. By default it runs under the uid and gid of the
6030 local user, which requires the sticky bit to be set on the &_/var/mail_&
6031 directory. Some systems use the alternative approach of running mail deliveries
6032 under a particular group instead of using the sticky bit. The commented options
6033 show how this can be done.
6034
6035 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
6036 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
6037 similarly-named options above.
6038 .code
6039 address_pipe:
6040   driver = pipe
6041   return_output
6042 .endd
6043 This transport is used for handling deliveries to pipes that are generated by
6044 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6045 option specifies that any output generated by the pipe is to be returned to the
6046 sender.
6047 .code
6048 address_file:
6049   driver = appendfile
6050   delivery_date_add
6051   envelope_to_add
6052   return_path_add
6053 .endd
6054 This transport is used for handling deliveries to files that are generated by
6055 redirection. The name of the file is not specified in this instance of
6056 &(appendfile)&, because it comes from the &(redirect)& router.
6057 .code
6058 address_reply:
6059   driver = autoreply
6060 .endd
6061 This transport is used for handling automatic replies generated by users'
6062 filter files.
6063
6064
6065
6066 .section "Default retry rule" "SECID57"
6067 .cindex "retry" "default rule"
6068 .cindex "default" "retry rule"
6069 The retry section of the configuration file contains rules which affect the way
6070 Exim retries deliveries that cannot be completed at the first attempt. It is
6071 introduced by the line
6072 .code
6073 begin retry
6074 .endd
6075 In the default configuration, there is just one rule, which applies to all
6076 errors:
6077 .code
6078 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6079 .endd
6080 This causes any temporarily failing address to be retried every 15 minutes for
6081 2 hours, then at intervals starting at one hour and increasing by a factor of
6082 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6083 is not delivered after 4 days of temporary failure, it is bounced.
6084
6085 If the retry section is removed from the configuration, or is empty (that is,
6086 if no retry rules are defined), Exim will not retry deliveries. This turns
6087 temporary errors into permanent errors.
6088
6089
6090 .section "Rewriting configuration" "SECID58"
6091 The rewriting section of the configuration, introduced by
6092 .code
6093 begin rewrite
6094 .endd
6095 contains rules for rewriting addresses in messages as they arrive. There are no
6096 rewriting rules in the default configuration file.
6097
6098
6099
6100 .section "Authenticators configuration" "SECTdefconfauth"
6101 .cindex "AUTH" "configuration"
6102 The authenticators section of the configuration, introduced by
6103 .code
6104 begin authenticators
6105 .endd
6106 defines mechanisms for the use of the SMTP AUTH command. The default
6107 configuration file contains two commented-out example authenticators
6108 which support plaintext username/password authentication using the
6109 standard PLAIN mechanism and the traditional but non-standard LOGIN
6110 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6111 to support most MUA software.
6112
6113 The example PLAIN authenticator looks like this:
6114 .code
6115 #PLAIN:
6116 #  driver                  = plaintext
6117 #  server_set_id           = $auth2
6118 #  server_prompts          = :
6119 #  server_condition        = Authentication is not yet configured
6120 #  server_advertise_condition = ${if def:tls_in_cipher }
6121 .endd
6122 And the example LOGIN authenticator looks like this:
6123 .code
6124 #LOGIN:
6125 #  driver                  = plaintext
6126 #  server_set_id           = $auth1
6127 #  server_prompts          = <| Username: | Password:
6128 #  server_condition        = Authentication is not yet configured
6129 #  server_advertise_condition = ${if def:tls_in_cipher }
6130 .endd
6131
6132 The &%server_set_id%& option makes Exim remember the authenticated username
6133 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6134 &%server_prompts%& option configures the &(plaintext)& authenticator so
6135 that it implements the details of the specific authentication mechanism,
6136 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6137 when Exim offers authentication to clients; in the examples, this is only
6138 when TLS or SSL has been started, so to enable the authenticators you also
6139 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6140
6141 The &%server_condition%& setting defines how to verify that the username and
6142 password are correct. In the examples it just produces an error message.
6143 To make the authenticators work, you can use a string expansion
6144 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6145
6146 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6147 usercode and password are in different positions.
6148 Chapter &<<CHAPplaintext>>& covers both.
6149
6150 .ecindex IIDconfiwal
6151
6152
6153
6154 . ////////////////////////////////////////////////////////////////////////////
6155 . ////////////////////////////////////////////////////////////////////////////
6156
6157 .chapter "Regular expressions" "CHAPregexp"
6158
6159 .cindex "regular expressions" "library"
6160 .cindex "PCRE"
6161 Exim supports the use of regular expressions in many of its options. It
6162 uses the PCRE regular expression library; this provides regular expression
6163 matching that is compatible with Perl 5. The syntax and semantics of
6164 regular expressions is discussed in many Perl reference books, and also in
6165 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6166 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6167
6168 The documentation for the syntax and semantics of the regular expressions that
6169 are supported by PCRE is included in the PCRE distribution, and no further
6170 description is included here. The PCRE functions are called from Exim using
6171 the default option settings (that is, with no PCRE options set), except that
6172 the PCRE_CASELESS option is set when the matching is required to be
6173 case-insensitive.
6174
6175 In most cases, when a regular expression is required in an Exim configuration,
6176 it has to start with a circumflex, in order to distinguish it from plain text
6177 or an &"ends with"& wildcard. In this example of a configuration setting, the
6178 second item in the colon-separated list is a regular expression.
6179 .code
6180 domains = a.b.c : ^\\d{3} : *.y.z : ...
6181 .endd
6182 The doubling of the backslash is required because of string expansion that
6183 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6184 of this issue, and a way of avoiding the need for doubling backslashes. The
6185 regular expression that is eventually used in this example contains just one
6186 backslash. The circumflex is included in the regular expression, and has the
6187 normal effect of &"anchoring"& it to the start of the string that is being
6188 matched.
6189
6190 There are, however, two cases where a circumflex is not required for the
6191 recognition of a regular expression: these are the &%match%& condition in a
6192 string expansion, and the &%matches%& condition in an Exim filter file. In
6193 these cases, the relevant string is always treated as a regular expression; if
6194 it does not start with a circumflex, the expression is not anchored, and can
6195 match anywhere in the subject string.
6196
6197 In all cases, if you want a regular expression to match at the end of a string,
6198 you must code the $ metacharacter to indicate this. For example:
6199 .code
6200 domains = ^\\d{3}\\.example
6201 .endd
6202 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6203 You need to use:
6204 .code
6205 domains = ^\\d{3}\\.example\$
6206 .endd
6207 if you want &'example'& to be the top-level domain. The backslash before the
6208 $ is needed because string expansion also interprets dollar characters.
6209
6210
6211
6212 . ////////////////////////////////////////////////////////////////////////////
6213 . ////////////////////////////////////////////////////////////////////////////
6214
6215 .chapter "File and database lookups" "CHAPfdlookup"
6216 .scindex IIDfidalo1 "file" "lookups"
6217 .scindex IIDfidalo2 "database" "lookups"
6218 .cindex "lookup" "description of"
6219 Exim can be configured to look up data in files or databases as it processes
6220 messages. Two different kinds of syntax are used:
6221
6222 .olist
6223 A string that is to be expanded may contain explicit lookup requests. These
6224 cause parts of the string to be replaced by data that is obtained from the
6225 lookup. Lookups of this type are conditional expansion items. Different results
6226 can be defined for the cases of lookup success and failure. See chapter
6227 &<<CHAPexpand>>&, where string expansions are described in detail.
6228 .next
6229 Lists of domains, hosts, and email addresses can contain lookup requests as a
6230 way of avoiding excessively long linear lists. In this case, the data that is
6231 returned by the lookup is often (but not always) discarded; whether the lookup
6232 succeeds or fails is what really counts. These kinds of list are described in
6233 chapter &<<CHAPdomhosaddlists>>&.
6234 .endlist
6235
6236 String expansions, lists, and lookups interact with each other in such a way
6237 that there is no order in which to describe any one of them that does not
6238 involve references to the others. Each of these three chapters makes more sense
6239 if you have read the other two first. If you are reading this for the first
6240 time, be aware that some of it will make a lot more sense after you have read
6241 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6242
6243 .section "Examples of different lookup syntax" "SECID60"
6244 It is easy to confuse the two different kinds of lookup, especially as the
6245 lists that may contain the second kind are always expanded before being
6246 processed as lists. Therefore, they may also contain lookups of the first kind.
6247 Be careful to distinguish between the following two examples:
6248 .code
6249 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6250 domains = lsearch;/some/file
6251 .endd
6252 The first uses a string expansion, the result of which must be a domain list.
6253 No strings have been specified for a successful or a failing lookup; the
6254 defaults in this case are the looked-up data and an empty string, respectively.
6255 The expansion takes place before the string is processed as a list, and the
6256 file that is searched could contain lines like this:
6257 .code
6258 192.168.3.4: domain1:domain2:...
6259 192.168.1.9: domain3:domain4:...
6260 .endd
6261 When the lookup succeeds, the result of the expansion is a list of domains (and
6262 possibly other types of item that are allowed in domain lists).
6263
6264 In the second example, the lookup is a single item in a domain list. It causes
6265 Exim to use a lookup to see if the domain that is being processed can be found
6266 in the file. The file could contains lines like this:
6267 .code
6268 domain1:
6269 domain2:
6270 .endd
6271 Any data that follows the keys is not relevant when checking that the domain
6272 matches the list item.
6273
6274 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6275 Consider a file containing lines like this:
6276 .code
6277 192.168.5.6: lsearch;/another/file
6278 .endd
6279 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6280 first &%domains%& setting above generates the second setting, which therefore
6281 causes a second lookup to occur.
6282
6283 The rest of this chapter describes the different lookup types that are
6284 available. Any of them can be used in any part of the configuration where a
6285 lookup is permitted.
6286
6287
6288 .section "Lookup types" "SECID61"
6289 .cindex "lookup" "types of"
6290 .cindex "single-key lookup" "definition of"
6291 Two different types of data lookup are implemented:
6292
6293 .ilist
6294 The &'single-key'& type requires the specification of a file in which to look,
6295 and a single key to search for. The key must be a non-empty string for the
6296 lookup to succeed. The lookup type determines how the file is searched.
6297 .next
6298 .cindex "query-style lookup" "definition of"
6299 The &'query-style'& type accepts a generalized database query. No particular
6300 key value is assumed by Exim for query-style lookups. You can use whichever
6301 Exim variables you need to construct the database query.
6302 .endlist
6303
6304 The code for each lookup type is in a separate source file that is included in
6305 the binary of Exim only if the corresponding compile-time option is set. The
6306 default settings in &_src/EDITME_& are:
6307 .code
6308 LOOKUP_DBM=yes
6309 LOOKUP_LSEARCH=yes
6310 .endd
6311 which means that only linear searching and DBM lookups are included by default.
6312 For some types of lookup (e.g. SQL databases), you need to install appropriate
6313 libraries and header files before building Exim.
6314
6315
6316
6317
6318 .section "Single-key lookup types" "SECTsinglekeylookups"
6319 .cindex "lookup" "single-key types"
6320 .cindex "single-key lookup" "list of types"
6321 The following single-key lookup types are implemented:
6322
6323 .ilist
6324 .cindex "cdb" "description of"
6325 .cindex "lookup" "cdb"
6326 .cindex "binary zero" "in lookup key"
6327 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6328 string without a terminating binary zero. The cdb format is designed for
6329 indexed files that are read frequently and never updated, except by total
6330 re-creation. As such, it is particularly suitable for large files containing
6331 aliases or other indexed data referenced by an MTA. Information about cdb can
6332 be found in several places:
6333 .display
6334 &url(http://www.pobox.com/~djb/cdb.html)
6335 &url(ftp://ftp.corpit.ru/pub/tinycdb/)
6336 &url(http://packages.debian.org/stable/utils/freecdb.html)
6337 .endd
6338 A cdb distribution is not needed in order to build Exim with cdb support,
6339 because the code for reading cdb files is included directly in Exim itself.
6340 However, no means of building or testing cdb files is provided with Exim, so
6341 you need to obtain a cdb distribution in order to do this.
6342 .next
6343 .cindex "DBM" "lookup type"
6344 .cindex "lookup" "dbm"
6345 .cindex "binary zero" "in lookup key"
6346 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6347 DBM file by looking up the record with the given key. A terminating binary
6348 zero is included in the key that is passed to the DBM library. See section
6349 &<<SECTdb>>& for a discussion of DBM libraries.
6350
6351 .cindex "Berkeley DB library" "file format"
6352 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6353 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6354 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6355 the DB_UNKNOWN option. This enables it to handle any of the types of database
6356 that the library supports, and can be useful for accessing DBM files created by
6357 other applications. (For earlier DB versions, DB_HASH is always used.)
6358 .next
6359 .cindex "lookup" "dbmjz"
6360 .cindex "lookup" "dbm &-- embedded NULs"
6361 .cindex "sasldb2"
6362 .cindex "dbmjz lookup type"
6363 &(dbmjz)&: This is the same as &(dbm)&, except that the lookup key is
6364 interpreted as an Exim list; the elements of the list are joined together with
6365 ASCII NUL characters to form the lookup key.  An example usage would be to
6366 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6367 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6368 &(cram_md5)& authenticator.
6369 .next
6370 .cindex "lookup" "dbmnz"
6371 .cindex "lookup" "dbm &-- terminating zero"
6372 .cindex "binary zero" "in lookup key"
6373 .cindex "Courier"
6374 .cindex "&_/etc/userdbshadow.dat_&"
6375 .cindex "dbmnz lookup type"
6376 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6377 is not included in the key that is passed to the DBM library. You may need this
6378 if you want to look up data in files that are created by or shared with some
6379 other application that does not use terminating zeros. For example, you need to
6380 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6381 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6382 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6383 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6384 .next
6385 .cindex "lookup" "dsearch"
6386 .cindex "dsearch lookup type"
6387 &(dsearch)&: The given file must be a directory; this is searched for an entry
6388 whose name is the key by calling the &[lstat()]& function. The key may not
6389 contain any forward slash characters. If &[lstat()]& succeeds, the result of
6390 the lookup is the name of the entry, which may be a file, directory,
6391 symbolic link, or any other kind of directory entry. An example of how this
6392 lookup can be used to support virtual domains is given in section
6393 &<<SECTvirtualdomains>>&.
6394 .next
6395 .cindex "lookup" "iplsearch"
6396 .cindex "iplsearch lookup type"
6397 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6398 terminated by a colon or white space or the end of the line. The keys in the
6399 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6400 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6401 being interpreted as a key terminator. For example:
6402 .code
6403 1.2.3.4:           data for 1.2.3.4
6404 192.168.0.0/16:    data for 192.168.0.0/16
6405 "abcd::cdab":      data for abcd::cdab
6406 "abcd:abcd::/32"   data for abcd:abcd::/32
6407 .endd
6408 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6409 file is searched linearly, using the CIDR masks where present, until a matching
6410 key is found. The first key that matches is used; there is no attempt to find a
6411 &"best"& match. Apart from the way the keys are matched, the processing for
6412 &(iplsearch)& is the same as for &(lsearch)&.
6413
6414 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6415 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6416 lookup types support only literal keys.
6417
6418 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6419 the implicit key is the host's IP address rather than its name (see section
6420 &<<SECThoslispatsikey>>&).
6421 .next
6422 .cindex "linear search"
6423 .cindex "lookup" "lsearch"
6424 .cindex "lsearch lookup type"
6425 .cindex "case sensitivity" "in lsearch lookup"
6426 &(lsearch)&: The given file is a text file that is searched linearly for a
6427 line beginning with the search key, terminated by a colon or white space or the
6428 end of the line. The search is case-insensitive; that is, upper and lower case
6429 letters are treated as the same. The first occurrence of the key that is found
6430 in the file is used.
6431
6432 White space between the key and the colon is permitted. The remainder of the
6433 line, with leading and trailing white space removed, is the data. This can be
6434 continued onto subsequent lines by starting them with any amount of white
6435 space, but only a single space character is included in the data at such a
6436 junction. If the data begins with a colon, the key must be terminated by a
6437 colon, for example:
6438 .code
6439 baduser:  :fail:
6440 .endd
6441 Empty lines and lines beginning with # are ignored, even if they occur in the
6442 middle of an item. This is the traditional textual format of alias files. Note
6443 that the keys in an &(lsearch)& file are literal strings. There is no
6444 wildcarding of any kind.
6445
6446 .cindex "lookup" "lsearch &-- colons in keys"
6447 .cindex "white space" "in lsearch key"
6448 In most &(lsearch)& files, keys are not required to contain colons or #
6449 characters, or white space. However, if you need this feature, it is available.
6450 If a key begins with a doublequote character, it is terminated only by a
6451 matching quote (or end of line), and the normal escaping rules apply to its
6452 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6453 quoted keys (exactly as for unquoted keys). There is no special handling of
6454 quotes for the data part of an &(lsearch)& line.
6455
6456 .next
6457 .cindex "NIS lookup type"
6458 .cindex "lookup" "NIS"
6459 .cindex "binary zero" "in lookup key"
6460 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6461 the given key, without a terminating binary zero. There is a variant called
6462 &(nis0)& which does include the terminating binary zero in the key. This is
6463 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6464 aliases; the full map names must be used.
6465
6466 .next
6467 .cindex "wildlsearch lookup type"
6468 .cindex "lookup" "wildlsearch"
6469 .cindex "nwildlsearch lookup type"
6470 .cindex "lookup" "nwildlsearch"
6471 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6472 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6473 the file may be wildcarded. The difference between these two lookup types is
6474 that for &(wildlsearch)&, each key in the file is string-expanded before being
6475 used, whereas for &(nwildlsearch)&, no expansion takes place.
6476
6477 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6478 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6479 file that are regular expressions can be made case-sensitive by the use of
6480 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6481
6482 . ==== As this is a nested list, any displays it contains must be indented
6483 . ==== as otherwise they are too far to the left.
6484
6485 .olist
6486 The string may begin with an asterisk to mean &"ends with"&. For example:
6487 .code
6488     *.a.b.c       data for anything.a.b.c
6489     *fish         data for anythingfish
6490 .endd
6491 .next
6492 The string may begin with a circumflex to indicate a regular expression. For
6493 example, for &(wildlsearch)&:
6494 .code
6495     ^\N\d+\.a\.b\N    data for <digits>.a.b
6496 .endd
6497 Note the use of &`\N`& to disable expansion of the contents of the regular
6498 expression. If you are using &(nwildlsearch)&, where the keys are not
6499 string-expanded, the equivalent entry is:
6500 .code
6501     ^\d+\.a\.b        data for <digits>.a.b
6502 .endd
6503 The case-insensitive flag is set at the start of compiling the regular
6504 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6505 For example, to make the entire pattern case-sensitive:
6506 .code
6507     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6508 .endd
6509
6510 If the regular expression contains white space or colon characters, you must
6511 either quote it (see &(lsearch)& above), or represent these characters in other
6512 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6513 colon. This may be easier than quoting, because if you quote, you have to
6514 escape all the backslashes inside the quotes.
6515
6516 &*Note*&: It is not possible to capture substrings in a regular expression
6517 match for later use, because the results of all lookups are cached. If a lookup
6518 is repeated, the result is taken from the cache, and no actual pattern matching
6519 takes place. The values of all the numeric variables are unset after a
6520 &((n)wildlsearch)& match.
6521
6522 .next
6523 Although I cannot see it being of much use, the general matching function that
6524 is used to implement &((n)wildlsearch)& means that the string may begin with a
6525 lookup name terminated by a semicolon, and followed by lookup data. For
6526 example:
6527 .code
6528     cdb;/some/file  data for keys that match the file
6529 .endd
6530 The data that is obtained from the nested lookup is discarded.
6531 .endlist olist
6532
6533 Keys that do not match any of these patterns are interpreted literally. The
6534 continuation rules for the data are the same as for &(lsearch)&, and keys may
6535 be followed by optional colons.
6536
6537 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6538 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6539 lookup types support only literal keys.
6540 .endlist ilist
6541
6542
6543 .section "Query-style lookup types" "SECID62"
6544 .cindex "lookup" "query-style types"
6545 .cindex "query-style lookup" "list of types"
6546 The supported query-style lookup types are listed below. Further details about
6547 many of them are given in later sections.
6548
6549 .ilist
6550 .cindex "DNS" "as a lookup type"
6551 .cindex "lookup" "DNS"
6552 &(dnsdb)&: This does a DNS search for one or more records whose domain names
6553 are given in the supplied query. The resulting data is the contents of the
6554 records. See section &<<SECTdnsdb>>&.
6555 .next
6556 .cindex "InterBase lookup type"
6557 .cindex "lookup" "InterBase"
6558 &(ibase)&: This does a lookup in an InterBase database.
6559 .next
6560 .cindex "LDAP" "lookup type"
6561 .cindex "lookup" "LDAP"
6562 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
6563 returns attributes from a single entry. There is a variant called &(ldapm)&
6564 that permits values from multiple entries to be returned. A third variant
6565 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
6566 any attribute values. See section &<<SECTldap>>&.
6567 .next
6568 .cindex "MySQL" "lookup type"
6569 .cindex "lookup" "MySQL"
6570 &(mysql)&: The format of the query is an SQL statement that is passed to a
6571 MySQL database. See section &<<SECTsql>>&.
6572 .next
6573 .cindex "NIS+ lookup type"
6574 .cindex "lookup" "NIS+"
6575 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
6576 the field to be returned. See section &<<SECTnisplus>>&.
6577 .next
6578 .cindex "Oracle" "lookup type"
6579 .cindex "lookup" "Oracle"
6580 &(oracle)&: The format of the query is an SQL statement that is passed to an
6581 Oracle database. See section &<<SECTsql>>&.
6582 .next
6583 .cindex "lookup" "passwd"
6584 .cindex "passwd lookup type"
6585 .cindex "&_/etc/passwd_&"
6586 &(passwd)& is a query-style lookup with queries that are just user names. The
6587 lookup calls &[getpwnam()]& to interrogate the system password data, and on
6588 success, the result string is the same as you would get from an &(lsearch)&
6589 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
6590 password value. For example:
6591 .code
6592 *:42:42:King Rat:/home/kr:/bin/bash
6593 .endd
6594 .next
6595 .cindex "PostgreSQL lookup type"
6596 .cindex "lookup" "PostgreSQL"
6597 &(pgsql)&: The format of the query is an SQL statement that is passed to a
6598 PostgreSQL database. See section &<<SECTsql>>&.
6599
6600 .next
6601 .cindex "sqlite lookup type"
6602 .cindex "lookup" "sqlite"
6603 &(sqlite)&: The format of the query is a file name followed by an SQL statement
6604 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
6605
6606 .next
6607 &(testdb)&: This is a lookup type that is used for testing Exim. It is
6608 not likely to be useful in normal operation.
6609 .next
6610 .cindex "whoson lookup type"
6611 .cindex "lookup" "whoson"
6612 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
6613 allows a server to check whether a particular (dynamically allocated) IP
6614 address is currently allocated to a known (trusted) user and, optionally, to
6615 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
6616 at one time for &"POP before SMTP"& authentication, but that approach has been
6617 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
6618 &"POP before SMTP"& checking using ACL statements such as
6619 .code
6620 require condition = \
6621   ${lookup whoson {$sender_host_address}{yes}{no}}
6622 .endd
6623 The query consists of a single IP address. The value returned is the name of
6624 the authenticated user, which is stored in the variable &$value$&. However, in
6625 this example, the data in &$value$& is not used; the result of the lookup is
6626 one of the fixed strings &"yes"& or &"no"&.
6627 .endlist
6628
6629
6630
6631 .section "Temporary errors in lookups" "SECID63"
6632 .cindex "lookup" "temporary error in"
6633 Lookup functions can return temporary error codes if the lookup cannot be
6634 completed. For example, an SQL or LDAP database might be unavailable. For this
6635 reason, it is not advisable to use a lookup that might do this for critical
6636 options such as a list of local domains.
6637
6638 When a lookup cannot be completed in a router or transport, delivery
6639 of the message (to the relevant address) is deferred, as for any other
6640 temporary error. In other circumstances Exim may assume the lookup has failed,
6641 or may give up altogether.
6642
6643
6644
6645 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
6646 .cindex "wildcard lookups"
6647 .cindex "lookup" "default values"
6648 .cindex "lookup" "wildcard"
6649 .cindex "lookup" "* added to type"
6650 .cindex "default" "in single-key lookups"
6651 In this context, a &"default value"& is a value specified by the administrator
6652 that is to be used if a lookup fails.
6653
6654 &*Note:*& This section applies only to single-key lookups. For query-style
6655 lookups, the facilities of the query language must be used. An attempt to
6656 specify a default for a query-style lookup provokes an error.
6657
6658 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
6659 and the initial lookup fails, the key &"*"& is looked up in the file to
6660 provide a default value. See also the section on partial matching below.
6661
6662 .cindex "*@ with single-key lookup"
6663 .cindex "lookup" "*@ added to type"
6664 .cindex "alias file" "per-domain default"
6665 Alternatively, if &"*@"& is added to a single-key lookup type (for example
6666 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
6667 character, a second lookup is done with everything before the last @ replaced
6668 by *. This makes it possible to provide per-domain defaults in alias files
6669 that include the domains in the keys. If the second lookup fails (or doesn't
6670 take place because there is no @ in the key), &"*"& is looked up.
6671 For example, a &(redirect)& router might contain:
6672 .code
6673 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
6674 .endd
6675 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
6676 looks up these keys, in this order:
6677 .code
6678 jane@eyre.example
6679 *@eyre.example
6680 *
6681 .endd
6682 The data is taken from whichever key it finds first. &*Note*&: In an
6683 &(lsearch)& file, this does not mean the first of these keys in the file. A
6684 complete scan is done for each key, and only if it is not found at all does
6685 Exim move on to try the next key.
6686
6687
6688
6689 .section "Partial matching in single-key lookups" "SECTpartiallookup"
6690 .cindex "partial matching"
6691 .cindex "wildcard lookups"
6692 .cindex "lookup" "partial matching"
6693 .cindex "lookup" "wildcard"
6694 .cindex "asterisk" "in search type"
6695 The normal operation of a single-key lookup is to search the file for an exact
6696 match with the given key. However, in a number of situations where domains are
6697 being looked up, it is useful to be able to do partial matching. In this case,
6698 information in the file that has a key starting with &"*."& is matched by any
6699 domain that ends with the components that follow the full stop. For example, if
6700 a key in a DBM file is
6701 .code
6702 *.dates.fict.example
6703 .endd
6704 then when partial matching is enabled this is matched by (amongst others)
6705 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
6706 by &'dates.fict.example'&, if that does not appear as a separate key in the
6707 file.
6708
6709 &*Note*&: Partial matching is not available for query-style lookups. It is
6710 also not available for any lookup items in address lists (see section
6711 &<<SECTaddresslist>>&).
6712
6713 Partial matching is implemented by doing a series of separate lookups using
6714 keys constructed by modifying the original subject key. This means that it can
6715 be used with any of the single-key lookup types, provided that
6716 partial matching keys
6717 beginning with a special prefix (default &"*."&) are included in the data file.
6718 Keys in the file that do not begin with the prefix are matched only by
6719 unmodified subject keys when partial matching is in use.
6720
6721 Partial matching is requested by adding the string &"partial-"& to the front of
6722 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
6723 is done, the subject key is first looked up unmodified; if that fails, &"*."&
6724 is added at the start of the subject key, and it is looked up again. If that
6725 fails, further lookups are tried with dot-separated components removed from the
6726 start of the subject key, one-by-one, and &"*."& added on the front of what
6727 remains.
6728
6729 A minimum number of two non-* components are required. This can be adjusted
6730 by including a number before the hyphen in the search type. For example,
6731 &%partial3-lsearch%& specifies a minimum of three non-* components in the
6732 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
6733 subject key is &'2250.dates.fict.example'& then the following keys are looked
6734 up when the minimum number of non-* components is two:
6735 .code
6736 2250.dates.fict.example
6737 *.2250.dates.fict.example
6738 *.dates.fict.example
6739 *.fict.example
6740 .endd
6741 As soon as one key in the sequence is successfully looked up, the lookup
6742 finishes.
6743
6744 .cindex "lookup" "partial matching &-- changing prefix"
6745 .cindex "prefix" "for partial matching"
6746 The use of &"*."& as the partial matching prefix is a default that can be
6747 changed. The motivation for this feature is to allow Exim to operate with file
6748 formats that are used by other MTAs. A different prefix can be supplied in
6749 parentheses instead of the hyphen after &"partial"&. For example:
6750 .code
6751 domains = partial(.)lsearch;/some/file
6752 .endd
6753 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
6754 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
6755 components is unchanged). The prefix may consist of any punctuation characters
6756 other than a closing parenthesis. It may be empty, for example:
6757 .code
6758 domains = partial1()cdb;/some/file
6759 .endd
6760 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
6761 &`a.b.c`&, &`b.c`&, and &`c`&.
6762
6763 If &"partial0"& is specified, what happens at the end (when the lookup with
6764 just one non-wild component has failed, and the original key is shortened right
6765 down to the null string) depends on the prefix:
6766
6767 .ilist
6768 If the prefix has zero length, the whole lookup fails.
6769 .next
6770 If the prefix has length 1, a lookup for just the prefix is done. For
6771 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
6772 .next
6773 Otherwise, if the prefix ends in a dot, the dot is removed, and the
6774 remainder is looked up. With the default prefix, therefore, the final lookup is
6775 for &"*"& on its own.
6776 .next
6777 Otherwise, the whole prefix is looked up.
6778 .endlist
6779
6780
6781 If the search type ends in &"*"& or &"*@"& (see section
6782 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
6783 this implies happens after all partial lookups have failed. If &"partial0"& is
6784 specified, adding &"*"& to the search type has no effect with the default
6785 prefix, because the &"*"& key is already included in the sequence of partial
6786 lookups. However, there might be a use for lookup types such as
6787 &"partial0(.)lsearch*"&.
6788
6789 The use of &"*"& in lookup partial matching differs from its use as a wildcard
6790 in domain lists and the like. Partial matching works only in terms of
6791 dot-separated components; a key such as &`*fict.example`&
6792 in a database file is useless, because the asterisk in a partial matching
6793 subject key is always followed by a dot.
6794
6795
6796
6797
6798 .section "Lookup caching" "SECID64"
6799 .cindex "lookup" "caching"
6800 .cindex "caching" "lookup data"
6801 Exim caches all lookup results in order to avoid needless repetition of
6802 lookups. However, because (apart from the daemon) Exim operates as a collection
6803 of independent, short-lived processes, this caching applies only within a
6804 single Exim process. There is no inter-process lookup caching facility.
6805
6806 For single-key lookups, Exim keeps the relevant files open in case there is
6807 another lookup that needs them. In some types of configuration this can lead to
6808 many files being kept open for messages with many recipients. To avoid hitting
6809 the operating system limit on the number of simultaneously open files, Exim
6810 closes the least recently used file when it needs to open more files than its
6811 own internal limit, which can be changed via the &%lookup_open_max%& option.
6812
6813 The single-key lookup files are closed and the lookup caches are flushed at
6814 strategic points during delivery &-- for example, after all routing is
6815 complete.
6816
6817
6818
6819
6820 .section "Quoting lookup data" "SECID65"
6821 .cindex "lookup" "quoting"
6822 .cindex "quoting" "in lookups"
6823 When data from an incoming message is included in a query-style lookup, there
6824 is the possibility of special characters in the data messing up the syntax of
6825 the query. For example, a NIS+ query that contains
6826 .code
6827 [name=$local_part]
6828 .endd
6829 will be broken if the local part happens to contain a closing square bracket.
6830 For NIS+, data can be enclosed in double quotes like this:
6831 .code
6832 [name="$local_part"]
6833 .endd
6834 but this still leaves the problem of a double quote in the data. The rule for
6835 NIS+ is that double quotes must be doubled. Other lookup types have different
6836 rules, and to cope with the differing requirements, an expansion operator
6837 of the following form is provided:
6838 .code
6839 ${quote_<lookup-type>:<string>}
6840 .endd
6841 For example, the safest way to write the NIS+ query is
6842 .code
6843 [name="${quote_nisplus:$local_part}"]
6844 .endd
6845 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
6846 operator can be used for all lookup types, but has no effect for single-key
6847 lookups, since no quoting is ever needed in their key strings.
6848
6849
6850
6851
6852 .section "More about dnsdb" "SECTdnsdb"
6853 .cindex "dnsdb lookup"
6854 .cindex "lookup" "dnsdb"
6855 .cindex "DNS" "as a lookup type"
6856 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
6857 of a record type and a domain name, separated by an equals sign. For example,
6858 an expansion string could contain:
6859 .code
6860 ${lookup dnsdb{mx=a.b.example}{$value}fail}
6861 .endd
6862 If the lookup succeeds, the result is placed in &$value$&, which in this case
6863 is used on its own as the result. If the lookup does not succeed, the
6864 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
6865 &<<SECTforexpfai>>& for an explanation of what this means.
6866
6867 The supported DNS record types are A, CNAME, MX, NS, PTR, SPF, SRV, TLSA and TXT,
6868 and, when Exim is compiled with IPv6 support, AAAA (and A6 if that is also
6869 configured). If no type is given, TXT is assumed. When the type is PTR,
6870 the data can be an IP address, written as normal; inversion and the addition of
6871 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
6872 .code
6873 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
6874 .endd
6875 If the data for a PTR record is not a syntactically valid IP address, it is not
6876 altered and nothing is added.
6877
6878 For any record type, if multiple records are found (or, for A6 lookups, if a
6879 single record leads to multiple addresses), the data is returned as a
6880 concatenation, with newline as the default separator. The order, of course,
6881 depends on the DNS resolver. You can specify a different separator character
6882 between multiple records by putting a right angle-bracket followed immediately
6883 by the new separator at the start of the query. For example:
6884 .code
6885 ${lookup dnsdb{>: a=host1.example}}
6886 .endd
6887 It is permitted to specify a space as the separator character. Further
6888 white space is ignored.
6889
6890 .cindex "MX record" "in &(dnsdb)& lookup"
6891 .cindex "SRV record" "in &(dnsdb)& lookup"
6892 For an MX lookup, both the preference value and the host name are returned for
6893 each record, separated by a space. For an SRV lookup, the priority, weight,
6894 port, and host name are returned for each record, separated by spaces.
6895 An alternate field separator can be specified using a comma after the main
6896 separator character, followed immediately by the field separator.
6897
6898 .cindex "TXT record" "in &(dnsdb)& lookup"
6899 .cindex "SPF record" "in &(dnsdb)& lookup"
6900 For TXT records with multiple items of data, only the first item is returned,
6901 unless a separator for them is specified using a comma after the separator
6902 character followed immediately by the TXT record item separator. To concatenate
6903 items without a separator, use a semicolon instead. For SPF records the
6904 default behaviour is to concatenate multiple items without using a separator.
6905 .code
6906 ${lookup dnsdb{>\n,: txt=a.b.example}}
6907 ${lookup dnsdb{>\n; txt=a.b.example}}
6908 ${lookup dnsdb{spf=example.org}}
6909 .endd
6910 It is permitted to specify a space as the separator character. Further
6911 white space is ignored.
6912
6913 .section "Dnsdb lookup modifiers" "SECTdnsdb_mod"
6914 .cindex "dnsdb modifiers"
6915 .cindex "modifiers" "dnsdb"
6916 .cindex "options" "dnsdb"
6917 Modifiers for &(dnsdb)& lookups are givien by optional keywords,
6918 each followed by a comma,
6919 that may appear before the record type.
6920
6921 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
6922 temporary DNS error for any of them, the behaviour is controlled by
6923 a defer-option modifier.
6924 The possible keywords are
6925 &"defer_strict"&, &"defer_never"&, and &"defer_lax"&.
6926 With &"strict"& behaviour, any temporary DNS error causes the
6927 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
6928 ignored, and the behaviour is as if the DNS lookup failed to find anything.
6929 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
6930 error causes the whole lookup to defer only if none of the other lookups
6931 succeed. The default is &"lax"&, so the following lookups are equivalent:
6932 .code
6933 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
6934 ${lookup dnsdb{a=one.host.com:two.host.com}}
6935 .endd
6936 Thus, in the default case, as long as at least one of the DNS lookups
6937 yields some data, the lookup succeeds.
6938
6939 .cindex "DNSSEC" "dns lookup"
6940 Use of &(DNSSEC)& is controlled by a dnssec modifier.
6941 The possible keywords are
6942 &"dnssec_strict"&, &"dnssec_lax"&, and &"dnssec_never"&.
6943 With &"strict"& or &"lax"& DNSSEC information is requested
6944 with the lookup.
6945 With &"strict"& a response from the DNS resolver that
6946 is not labelled as authenticated data
6947 is treated as equivalent to a temporary DNS error.
6948 The default is &"never"&.
6949
6950 See also the &$lookup_dnssec_authenticated$& variable.
6951
6952
6953 .section "Pseudo dnsdb record types" "SECID66"
6954 .cindex "MX record" "in &(dnsdb)& lookup"
6955 By default, both the preference value and the host name are returned for
6956 each MX record, separated by a space. If you want only host names, you can use
6957 the pseudo-type MXH:
6958 .code
6959 ${lookup dnsdb{mxh=a.b.example}}
6960 .endd
6961 In this case, the preference values are omitted, and just the host names are
6962 returned.
6963
6964 .cindex "name server for enclosing domain"
6965 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
6966 records on the given domain, but if none are found, it removes the first
6967 component of the domain name, and tries again. This process continues until NS
6968 records are found or there are no more components left (or there is a DNS
6969 error). In other words, it may return the name servers for a top-level domain,
6970 but it never returns the root name servers. If there are no NS records for the
6971 top-level domain, the lookup fails. Consider these examples:
6972 .code
6973 ${lookup dnsdb{zns=xxx.quercite.com}}
6974 ${lookup dnsdb{zns=xxx.edu}}
6975 .endd
6976 Assuming that in each case there are no NS records for the full domain name,
6977 the first returns the name servers for &%quercite.com%&, and the second returns
6978 the name servers for &%edu%&.
6979
6980 You should be careful about how you use this lookup because, unless the
6981 top-level domain does not exist, the lookup always returns some host names. The
6982 sort of use to which this might be put is for seeing if the name servers for a
6983 given domain are on a blacklist. You can probably assume that the name servers
6984 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
6985 such a list.
6986
6987 .cindex "CSA" "in &(dnsdb)& lookup"
6988 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
6989 records according to the CSA rules, which are described in section
6990 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
6991 not sufficient because of the extra parent domain search behaviour of CSA. The
6992 result of a successful lookup such as:
6993 .code
6994 ${lookup dnsdb {csa=$sender_helo_name}}
6995 .endd
6996 has two space-separated fields: an authorization code and a target host name.
6997 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
6998 authorization required but absent, or &"?"& for unknown.
6999
7000 .cindex "A+" "in &(dnsdb)& lookup"
7001 The pseudo-type A+ performs an A6 lookup (if configured) followed by an AAAA
7002 and then an A lookup.  All results are returned; defer processing
7003 (see below) is handled separately for each lookup.  Example:
7004 .code
7005 ${lookup dnsdb {>; a+=$sender_helo_name}}
7006 .endd
7007
7008
7009 .section "Multiple dnsdb lookups" "SECID67"
7010 In the previous sections, &(dnsdb)& lookups for a single domain are described.
7011 However, you can specify a list of domains or IP addresses in a single
7012 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
7013 the default separator, but with the ability to change this. For example:
7014 .code
7015 ${lookup dnsdb{one.domain.com:two.domain.com}}
7016 ${lookup dnsdb{a=one.host.com:two.host.com}}
7017 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
7018 .endd
7019 In order to retain backwards compatibility, there is one special case: if
7020 the lookup type is PTR and no change of separator is specified, Exim looks
7021 to see if the rest of the string is precisely one IPv6 address. In this
7022 case, it does not treat it as a list.
7023
7024 The data from each lookup is concatenated, with newline separators by default,
7025 in the same way that multiple DNS records for a single item are handled. A
7026 different separator can be specified, as described above.
7027
7028
7029
7030
7031 .section "More about LDAP" "SECTldap"
7032 .cindex "LDAP" "lookup, more about"
7033 .cindex "lookup" "LDAP"
7034 .cindex "Solaris" "LDAP"
7035 The original LDAP implementation came from the University of Michigan; this has
7036 become &"Open LDAP"&, and there are now two different releases. Another
7037 implementation comes from Netscape, and Solaris 7 and subsequent releases
7038 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7039 the lookup function level, their error handling is different. For this reason
7040 it is necessary to set a compile-time variable when building Exim with LDAP, to
7041 indicate which LDAP library is in use. One of the following should appear in
7042 your &_Local/Makefile_&:
7043 .code
7044 LDAP_LIB_TYPE=UMICHIGAN
7045 LDAP_LIB_TYPE=OPENLDAP1
7046 LDAP_LIB_TYPE=OPENLDAP2
7047 LDAP_LIB_TYPE=NETSCAPE
7048 LDAP_LIB_TYPE=SOLARIS
7049 .endd
7050 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7051 same interface as the University of Michigan version.
7052
7053 There are three LDAP lookup types in Exim. These behave slightly differently in
7054 the way they handle the results of a query:
7055
7056 .ilist
7057 &(ldap)& requires the result to contain just one entry; if there are more, it
7058 gives an error.
7059 .next
7060 &(ldapdn)& also requires the result to contain just one entry, but it is the
7061 Distinguished Name that is returned rather than any attribute values.
7062 .next
7063 &(ldapm)& permits the result to contain more than one entry; the attributes
7064 from all of them are returned.
7065 .endlist
7066
7067
7068 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7069 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7070 the data returned by a successful lookup is described in the next section.
7071 First we explain how LDAP queries are coded.
7072
7073
7074 .section "Format of LDAP queries" "SECTforldaque"
7075 .cindex "LDAP" "query format"
7076 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7077 the configuration of a &(redirect)& router one might have this setting:
7078 .code
7079 data = ${lookup ldap \
7080   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7081   c=UK?mailbox?base?}}
7082 .endd
7083 .cindex "LDAP" "with TLS"
7084 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7085 secure (encrypted) LDAP connections. The second of these ensures that an
7086 encrypted TLS connection is used.
7087
7088 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7089 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7090 See the &%ldap_start_tls%& option.
7091
7092 Starting with Exim 4.83, the initialization of LDAP with TLS is more tightly
7093 controlled. Every part of the TLS configuration can be configured by settings in
7094 &_exim.conf_&. Depending on the version of the client libraries installed on
7095 your system, some of the initialization may have required setting options in
7096 &_/etc/ldap.conf_& or &_~/.ldaprc_& to get TLS working with self-signed
7097 certificates. This revealed a nuance where the current UID that exim was
7098 running as could affect which config files it read. With Exim 4.83, these
7099 methods become optional, only taking effect if not specifically set in
7100 &_exim.conf_&.
7101
7102
7103 .section "LDAP quoting" "SECID68"
7104 .cindex "LDAP" "quoting"
7105 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7106 and the second because the LDAP query is represented as a URL. Furthermore,
7107 within an LDAP query, two different kinds of quoting are required. For this
7108 reason, there are two different LDAP-specific quoting operators.
7109
7110 The &%quote_ldap%& operator is designed for use on strings that are part of
7111 filter specifications. Conceptually, it first does the following conversions on
7112 the string:
7113 .code
7114 *   =>   \2A
7115 (   =>   \28
7116 )   =>   \29
7117 \   =>   \5C
7118 .endd
7119 in accordance with RFC 2254. The resulting string is then quoted according
7120 to the rules for URLs, that is, all non-alphanumeric characters except
7121 .code
7122 ! $ ' - . _ ( ) * +
7123 .endd
7124 are converted to their hex values, preceded by a percent sign. For example:
7125 .code
7126 ${quote_ldap: a(bc)*, a<yz>; }
7127 .endd
7128 yields
7129 .code
7130 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7131 .endd
7132 Removing the URL quoting, this is (with a leading and a trailing space):
7133 .code
7134 a\28bc\29\2A, a<yz>;
7135 .endd
7136 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7137 base DN specifications in queries. Conceptually, it first converts the string
7138 by inserting a backslash in front of any of the following characters:
7139 .code
7140 , + " \ < > ;
7141 .endd
7142 It also inserts a backslash before any leading spaces or # characters, and
7143 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7144 is then quoted according to the rules for URLs. For example:
7145 .code
7146 ${quote_ldap_dn: a(bc)*, a<yz>; }
7147 .endd
7148 yields
7149 .code
7150 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7151 .endd
7152 Removing the URL quoting, this is (with a trailing space):
7153 .code
7154 \ a(bc)*\, a\<yz\>\;\
7155 .endd
7156 There are some further comments about quoting in the section on LDAP
7157 authentication below.
7158
7159
7160 .section "LDAP connections" "SECID69"
7161 .cindex "LDAP" "connections"
7162 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7163 is in use, via a Unix domain socket. The example given above does not specify
7164 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7165 by starting it with
7166 .code
7167 ldap://<hostname>:<port>/...
7168 .endd
7169 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7170 used. When no server is specified in a query, a list of default servers is
7171 taken from the &%ldap_default_servers%& configuration option. This supplies a
7172 colon-separated list of servers which are tried in turn until one successfully
7173 handles a query, or there is a serious error. Successful handling either
7174 returns the requested data, or indicates that it does not exist. Serious errors
7175 are syntactical, or multiple values when only a single value is expected.
7176 Errors which cause the next server to be tried are connection failures, bind
7177 failures, and timeouts.
7178
7179 For each server name in the list, a port number can be given. The standard way
7180 of specifying a host and port is to use a colon separator (RFC 1738). Because
7181 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7182 doubled. For example
7183 .code
7184 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7185 .endd
7186 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7187 to the LDAP library with no server name, and the library's default (normally
7188 the local host) is used.
7189
7190 If you are using the OpenLDAP library, you can connect to an LDAP server using
7191 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7192 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7193 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7194 not available.
7195
7196 For this type of connection, instead of a host name for the server, a pathname
7197 for the socket is required, and the port number is not relevant. The pathname
7198 can be specified either as an item in &%ldap_default_servers%&, or inline in
7199 the query. In the former case, you can have settings such as
7200 .code
7201 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7202 .endd
7203 When the pathname is given in the query, you have to escape the slashes as
7204 &`%2F`& to fit in with the LDAP URL syntax. For example:
7205 .code
7206 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7207 .endd
7208 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7209 a pathname, it uses the Unix domain socket code, even if the query actually
7210 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7211 socket connection. This behaviour means that you can use a setting of
7212 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7213 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7214 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7215 backup host.
7216
7217 If an explicit &`ldapi`& type is given in a query when a host name is
7218 specified, an error is diagnosed. However, if there are more items in
7219 &%ldap_default_servers%&, they are tried. In other words:
7220
7221 .ilist
7222 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7223 interface.
7224 .next
7225 Using &`ldapi`& with a host name causes an error.
7226 .endlist
7227
7228
7229 Using &`ldapi`& with no host or path in the query, and no setting of
7230 &%ldap_default_servers%&, does whatever the library does by default.
7231
7232
7233
7234 .section "LDAP authentication and control information" "SECID70"
7235 .cindex "LDAP" "authentication"
7236 The LDAP URL syntax provides no way of passing authentication and other control
7237 information to the server. To make this possible, the URL in an LDAP query may
7238 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7239 spaces. If a value contains spaces it must be enclosed in double quotes, and
7240 when double quotes are used, backslash is interpreted in the usual way inside
7241 them. The following names are recognized:
7242 .display
7243 &`DEREFERENCE`&  set the dereferencing parameter
7244 &`NETTIME    `&  set a timeout for a network operation
7245 &`USER       `&  set the DN, for authenticating the LDAP bind
7246 &`PASS       `&  set the password, likewise
7247 &`REFERRALS  `&  set the referrals parameter
7248 &`SERVERS    `&  set alternate server list for this query only
7249 &`SIZE       `&  set the limit for the number of entries returned
7250 &`TIME       `&  set the maximum waiting time for a query
7251 .endd
7252 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7253 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7254 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7255 library from trying to follow referrals issued by the LDAP server.
7256
7257 The name CONNECT is an obsolete name for NETTIME, retained for
7258 backwards compatibility. This timeout (specified as a number of seconds) is
7259 enforced from the client end for operations that can be carried out over a
7260 network. Specifically, it applies to network connections and calls to the
7261 &'ldap_result()'& function. If the value is greater than zero, it is used if
7262 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7263 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7264 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7265 Netscape SDK; for OpenLDAP no action is taken.
7266
7267 The TIME parameter (also a number of seconds) is passed to the server to
7268 set a server-side limit on the time taken to complete a search.
7269
7270 The SERVERS parameter allows you to specify an alternate list of ldap servers
7271 to use for an individual lookup.  The global ldap_servers option provides a
7272 default list of ldap servers, and a single lookup can specify a single ldap
7273 server to use.  But when you need to do a lookup with a list of servers that is
7274 different than the default list (maybe different order, maybe a completely
7275 different set of servers), the SERVERS parameter allows you to specify this
7276 alternate list (colon-separated).
7277
7278 Here is an example of an LDAP query in an Exim lookup that uses some of these
7279 values. This is a single line, folded to fit on the page:
7280 .code
7281 ${lookup ldap
7282   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7283   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7284   {$value}fail}
7285 .endd
7286 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7287 any of the auxiliary data. Exim configuration settings that include lookups
7288 which contain password information should be preceded by &"hide"& to prevent
7289 non-admin users from using the &%-bP%& option to see their values.
7290
7291 The auxiliary data items may be given in any order. The default is no
7292 connection timeout (the system timeout is used), no user or password, no limit
7293 on the number of entries returned, and no time limit on queries.
7294
7295 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7296 removes any URL quoting that it may contain before passing it LDAP. Apparently
7297 some libraries do this for themselves, but some do not. Removing the URL
7298 quoting has two advantages:
7299
7300 .ilist
7301 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7302 DNs as with DNs inside actual queries.
7303 .next
7304 It permits spaces inside USER= DNs.
7305 .endlist
7306
7307 For example, a setting such as
7308 .code
7309 USER=cn=${quote_ldap_dn:$1}
7310 .endd
7311 should work even if &$1$& contains spaces.
7312
7313 Expanded data for the PASS= value should be quoted using the &%quote%&
7314 expansion operator, rather than the LDAP quote operators. The only reason this
7315 field needs quoting is to ensure that it conforms to the Exim syntax, which
7316 does not allow unquoted spaces. For example:
7317 .code
7318 PASS=${quote:$3}
7319 .endd
7320 The LDAP authentication mechanism can be used to check passwords as part of
7321 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7322 &<<CHAPexpand>>&.
7323
7324
7325
7326 .section "Format of data returned by LDAP" "SECID71"
7327 .cindex "LDAP" "returned data formats"
7328 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7329 as a sequence of values, for example
7330 .code
7331 cn=manager, o=University of Cambridge, c=UK
7332 .endd
7333 The &(ldap)& lookup type generates an error if more than one entry matches the
7334 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7335 the result between the data from different entries. It is possible for multiple
7336 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7337 you know that whatever values are returned all came from a single entry in the
7338 directory.
7339
7340 In the common case where you specify a single attribute in your LDAP query, the
7341 result is not quoted, and does not contain the attribute name. If the attribute
7342 has multiple values, they are separated by commas.
7343
7344 If you specify multiple attributes, the result contains space-separated, quoted
7345 strings, each preceded by the attribute name and an equals sign. Within the
7346 quotes, the quote character, backslash, and newline are escaped with
7347 backslashes, and commas are used to separate multiple values for the attribute.
7348 Any commas in attribute values are doubled
7349 (permitting treatment of the values as a comma-separated list).
7350 Apart from the escaping, the string within quotes takes the same form as the
7351 output when a single attribute is requested. Specifying no attributes is the
7352 same as specifying all of an entry's attributes.
7353
7354 Here are some examples of the output format. The first line of each pair is an
7355 LDAP query, and the second is the data that is returned. The attribute called
7356 &%attr1%& has two values, one of them with an embedded comma, whereas
7357 &%attr2%& has only one value:
7358 .code
7359 ldap:///o=base?attr1?sub?(uid=fred)
7360 value1.1,value1,,2
7361
7362 ldap:///o=base?attr2?sub?(uid=fred)
7363 value two
7364
7365 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7366 attr1="value1.1,value1,,2" attr2="value two"
7367
7368 ldap:///o=base??sub?(uid=fred)
7369 objectClass="top" attr1="value1.1,value1,,2" attr2="value two"
7370 .endd
7371 You can
7372 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7373 results of LDAP lookups.
7374 The &%extract%& operator in string expansions can be used to pick out
7375 individual fields from data that consists of &'key'&=&'value'& pairs.
7376 The &%listextract%& operator should be used to pick out individual values
7377 of attributes, even when only a single value is expected.
7378 The doubling of embedded commas allows you to use the returned data as a
7379 comma separated list (using the "<," syntax for changing the input list separator).
7380
7381
7382
7383
7384 .section "More about NIS+" "SECTnisplus"
7385 .cindex "NIS+ lookup type"
7386 .cindex "lookup" "NIS+"
7387 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7388 and field name. If this is given, the result of a successful query is the
7389 contents of the named field; otherwise the result consists of a concatenation
7390 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7391 values containing spaces are quoted. For example, the query
7392 .code
7393 [name=mg1456],passwd.org_dir
7394 .endd
7395 might return the string
7396 .code
7397 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7398 home=/home/mg1456 shell=/bin/bash shadow=""
7399 .endd
7400 (split over two lines here to fit on the page), whereas
7401 .code
7402 [name=mg1456],passwd.org_dir:gcos
7403 .endd
7404 would just return
7405 .code
7406 Martin Guerre
7407 .endd
7408 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7409 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7410 operator is to double any quote characters within the text.
7411
7412
7413
7414 .section "SQL lookups" "SECTsql"
7415 .cindex "SQL lookup types"
7416 .cindex "MySQL" "lookup type"
7417 .cindex "PostgreSQL lookup type"
7418 .cindex "lookup" "MySQL"
7419 .cindex "lookup" "PostgreSQL"
7420 .cindex "Oracle" "lookup type"
7421 .cindex "lookup" "Oracle"
7422 .cindex "InterBase lookup type"
7423 .cindex "lookup" "InterBase"
7424 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, and SQLite
7425 databases. Queries for these databases contain SQL statements, so an example
7426 might be
7427 .code
7428 ${lookup mysql{select mailbox from users where id='userx'}\
7429   {$value}fail}
7430 .endd
7431 If the result of the query contains more than one field, the data for each
7432 field in the row is returned, preceded by its name, so the result of
7433 .code
7434 ${lookup pgsql{select home,name from users where id='userx'}\
7435   {$value}}
7436 .endd
7437 might be
7438 .code
7439 home=/home/userx name="Mister X"
7440 .endd
7441 Empty values and values containing spaces are double quoted, with embedded
7442 quotes escaped by a backslash. If the result of the query contains just one
7443 field, the value is passed back verbatim, without a field name, for example:
7444 .code
7445 Mister X
7446 .endd
7447 If the result of the query yields more than one row, it is all concatenated,
7448 with a newline between the data for each row.
7449
7450
7451 .section "More about MySQL, PostgreSQL, Oracle, and InterBase" "SECID72"
7452 .cindex "MySQL" "lookup type"
7453 .cindex "PostgreSQL lookup type"
7454 .cindex "lookup" "MySQL"
7455 .cindex "lookup" "PostgreSQL"
7456 .cindex "Oracle" "lookup type"
7457 .cindex "lookup" "Oracle"
7458 .cindex "InterBase lookup type"
7459 .cindex "lookup" "InterBase"
7460 If any MySQL, PostgreSQL, Oracle, or InterBase lookups are used, the
7461 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, or &%ibase_servers%&
7462 option (as appropriate) must be set to a colon-separated list of server
7463 information.
7464 (For MySQL and PostgreSQL only, the global option need not be set if all
7465 queries contain their own server information &-- see section
7466 &<<SECTspeserque>>&.) Each item in the list is a slash-separated list of four
7467 items: host name, database name, user name, and password. In the case of
7468 Oracle, the host name field is used for the &"service name"&, and the database
7469 name field is not used and should be empty. For example:
7470 .code
7471 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7472 .endd
7473 Because password data is sensitive, you should always precede the setting with
7474 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7475 option. Here is an example where two MySQL servers are listed:
7476 .code
7477 hide mysql_servers = localhost/users/root/secret:\
7478                      otherhost/users/root/othersecret
7479 .endd
7480 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7481 because this is a colon-separated list, the colon has to be doubled. For each
7482 query, these parameter groups are tried in order until a connection is made and
7483 a query is successfully processed. The result of a query may be that no data is
7484 found, but that is still a successful query. In other words, the list of
7485 servers provides a backup facility, not a list of different places to look.
7486
7487 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
7488 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
7489 respectively, and the characters single-quote, double-quote, and backslash
7490 itself are escaped with backslashes. The &%quote_pgsql%& expansion operator, in
7491 addition, escapes the percent and underscore characters. This cannot be done
7492 for MySQL because these escapes are not recognized in contexts where these
7493 characters are not special.
7494
7495 .section "Specifying the server in the query" "SECTspeserque"
7496 For MySQL and PostgreSQL lookups (but not currently for Oracle and InterBase),
7497 it is possible to specify a list of servers with an individual query. This is
7498 done by starting the query with
7499 .display
7500 &`servers=`&&'server1:server2:server3:...'&&`;`&
7501 .endd
7502 Each item in the list may take one of two forms:
7503 .olist
7504 If it contains no slashes it is assumed to be just a host name. The appropriate
7505 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
7506 of the same name, and the remaining parameters (database, user, password) are
7507 taken from there.
7508 .next
7509 If it contains any slashes, it is taken as a complete parameter set.
7510 .endlist
7511 The list of servers is used in exactly the same way as the global list.
7512 Once a connection to a server has happened and a query has been
7513 successfully executed, processing of the lookup ceases.
7514
7515 This feature is intended for use in master/slave situations where updates
7516 are occurring and you want to update the master rather than a slave. If the
7517 master is in the list as a backup for reading, you might have a global setting
7518 like this:
7519 .code
7520 mysql_servers = slave1/db/name/pw:\
7521                 slave2/db/name/pw:\
7522                 master/db/name/pw
7523 .endd
7524 In an updating lookup, you could then write:
7525 .code
7526 ${lookup mysql{servers=master; UPDATE ...} }
7527 .endd
7528 That query would then be sent only to the master server. If, on the other hand,
7529 the master is not to be used for reading, and so is not present in the global
7530 option, you can still update it by a query of this form:
7531 .code
7532 ${lookup pgsql{servers=master/db/name/pw; UPDATE ...} }
7533 .endd
7534
7535
7536 .section "Special MySQL features" "SECID73"
7537 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
7538 causes a connection to the server on the local host by means of a Unix domain
7539 socket. An alternate socket can be specified in parentheses. The full syntax of
7540 each item in &%mysql_servers%& is:
7541 .display
7542 <&'hostname'&>::<&'port'&>(<&'socket name'&>)/<&'database'&>/&&&
7543   <&'user'&>/<&'password'&>
7544 .endd
7545 Any of the three sub-parts of the first field can be omitted. For normal use on
7546 the local host it can be left blank or set to just &"localhost"&.
7547
7548 No database need be supplied &-- but if it is absent here, it must be given in
7549 the queries.
7550
7551 If a MySQL query is issued that does not request any data (an insert, update,
7552 or delete command), the result of the lookup is the number of rows affected.
7553
7554 &*Warning*&: This can be misleading. If an update does not actually change
7555 anything (for example, setting a field to the value it already has), the result
7556 is zero because no rows are affected.
7557
7558
7559 .section "Special PostgreSQL features" "SECID74"
7560 PostgreSQL lookups can also use Unix domain socket connections to the database.
7561 This is usually faster and costs less CPU time than a TCP/IP connection.
7562 However it can be used only if the mail server runs on the same machine as the
7563 database server. A configuration line for PostgreSQL via Unix domain sockets
7564 looks like this:
7565 .code
7566 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
7567 .endd
7568 In other words, instead of supplying a host name, a path to the socket is
7569 given. The path name is enclosed in parentheses so that its slashes aren't
7570 visually confused with the delimiters for the other server parameters.
7571
7572 If a PostgreSQL query is issued that does not request any data (an insert,
7573 update, or delete command), the result of the lookup is the number of rows
7574 affected.
7575
7576 .section "More about SQLite" "SECTsqlite"
7577 .cindex "lookup" "SQLite"
7578 .cindex "sqlite lookup type"
7579 SQLite is different to the other SQL lookups because a file name is required in
7580 addition to the SQL query. An SQLite database is a single file, and there is no
7581 daemon as in the other SQL databases. The interface to Exim requires the name
7582 of the file, as an absolute path, to be given at the start of the query. It is
7583 separated from the query by white space. This means that the path name cannot
7584 contain white space. Here is a lookup expansion example:
7585 .code
7586 ${lookup sqlite {/some/thing/sqlitedb \
7587   select name from aliases where id='userx';}}
7588 .endd
7589 In a list, the syntax is similar. For example:
7590 .code
7591 domainlist relay_to_domains = sqlite;/some/thing/sqlitedb \
7592    select * from relays where ip='$sender_host_address';
7593 .endd
7594 The only character affected by the &%quote_sqlite%& operator is a single
7595 quote, which it doubles.
7596
7597 The SQLite library handles multiple simultaneous accesses to the database
7598 internally. Multiple readers are permitted, but only one process can
7599 update at once. Attempts to access the database while it is being updated
7600 are rejected after a timeout period, during which the SQLite library
7601 waits for the lock to be released. In Exim, the default timeout is set
7602 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
7603 option.
7604 .ecindex IIDfidalo1
7605 .ecindex IIDfidalo2
7606
7607
7608 . ////////////////////////////////////////////////////////////////////////////
7609 . ////////////////////////////////////////////////////////////////////////////
7610
7611 .chapter "Domain, host, address, and local part lists" &&&
7612          "CHAPdomhosaddlists" &&&
7613          "Domain, host, and address lists"
7614 .scindex IIDdohoadli "lists of domains; hosts; etc."
7615 A number of Exim configuration options contain lists of domains, hosts,
7616 email addresses, or local parts. For example, the &%hold_domains%& option
7617 contains a list of domains whose delivery is currently suspended. These lists
7618 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
7619 arguments to expansion conditions such as &%match_domain%&.
7620
7621 Each item in one of these lists is a pattern to be matched against a domain,
7622 host, email address, or local part, respectively. In the sections below, the
7623 different types of pattern for each case are described, but first we cover some
7624 general facilities that apply to all four kinds of list.
7625
7626
7627
7628 .section "Expansion of lists" "SECID75"
7629 .cindex "expansion" "of lists"
7630 Each list is expanded as a single string before it is used. The result of
7631 expansion must be a list, possibly containing empty items, which is split up
7632 into separate items for matching. By default, colon is the separator character,
7633 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
7634 &<<SECTempitelis>>& for details of the list syntax; the second of these
7635 discusses the way to specify empty list items.
7636
7637
7638 If the string expansion is forced to fail, Exim behaves as if the item it is
7639 testing (domain, host, address, or local part) is not in the list. Other
7640 expansion failures cause temporary errors.
7641
7642 If an item in a list is a regular expression, backslashes, dollars and possibly
7643 other special characters in the expression must be protected against
7644 misinterpretation by the string expander. The easiest way to do this is to use
7645 the &`\N`& expansion feature to indicate that the contents of the regular
7646 expression should not be expanded. For example, in an ACL you might have:
7647 .code
7648 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
7649                ${lookup{$domain}lsearch{/badsenders/bydomain}}
7650 .endd
7651 The first item is a regular expression that is protected from expansion by
7652 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
7653 senders based on the receiving domain.
7654
7655
7656
7657
7658 .section "Negated items in lists" "SECID76"
7659 .cindex "list" "negation"
7660 .cindex "negation" "in lists"
7661 Items in a list may be positive or negative. Negative items are indicated by a
7662 leading exclamation mark, which may be followed by optional white space. A list
7663 defines a set of items (domains, etc). When Exim processes one of these lists,
7664 it is trying to find out whether a domain, host, address, or local part
7665 (respectively) is in the set that is defined by the list. It works like this:
7666
7667 The list is scanned from left to right. If a positive item is matched, the
7668 subject that is being checked is in the set; if a negative item is matched, the
7669 subject is not in the set. If the end of the list is reached without the
7670 subject having matched any of the patterns, it is in the set if the last item
7671 was a negative one, but not if it was a positive one. For example, the list in
7672 .code
7673 domainlist relay_to_domains = !a.b.c : *.b.c
7674 .endd
7675 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
7676 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
7677 list is positive. However, if the setting were
7678 .code
7679 domainlist relay_to_domains = !a.b.c
7680 .endd
7681 then all domains other than &'a.b.c'& would match because the last item in the
7682 list is negative. In other words, a list that ends with a negative item behaves
7683 as if it had an extra item &`:*`& on the end.
7684
7685 Another way of thinking about positive and negative items in lists is to read
7686 the connector as &"or"& after a positive item and as &"and"& after a negative
7687 item.
7688
7689
7690
7691 .section "File names in lists" "SECTfilnamlis"
7692 .cindex "list" "file name in"
7693 If an item in a domain, host, address, or local part list is an absolute file
7694 name (beginning with a slash character), each line of the file is read and
7695 processed as if it were an independent item in the list, except that further
7696 file names are not allowed,
7697 and no expansion of the data from the file takes place.
7698 Empty lines in the file are ignored, and the file may also contain comment
7699 lines:
7700
7701 .ilist
7702 For domain and host lists, if a # character appears anywhere in a line of the
7703 file, it and all following characters are ignored.
7704 .next
7705 Because local parts may legitimately contain # characters, a comment in an
7706 address list or local part list file is recognized only if # is preceded by
7707 white space or the start of the line. For example:
7708 .code
7709 not#comment@x.y.z   # but this is a comment
7710 .endd
7711 .endlist
7712
7713 Putting a file name in a list has the same effect as inserting each line of the
7714 file as an item in the list (blank lines and comments excepted). However, there
7715 is one important difference: the file is read each time the list is processed,
7716 so if its contents vary over time, Exim's behaviour changes.
7717
7718 If a file name is preceded by an exclamation mark, the sense of any match
7719 within the file is inverted. For example, if
7720 .code
7721 hold_domains = !/etc/nohold-domains
7722 .endd
7723 and the file contains the lines
7724 .code
7725 !a.b.c
7726 *.b.c
7727 .endd
7728 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
7729 any domain matching &`*.b.c`& is not.
7730
7731
7732
7733 .section "An lsearch file is not an out-of-line list" "SECID77"
7734 As will be described in the sections that follow, lookups can be used in lists
7735 to provide indexed methods of checking list membership. There has been some
7736 confusion about the way &(lsearch)& lookups work in lists. Because
7737 an &(lsearch)& file contains plain text and is scanned sequentially, it is
7738 sometimes thought that it is allowed to contain wild cards and other kinds of
7739 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
7740 always fixed strings, just as for any other single-key lookup type.
7741
7742 If you want to use a file to contain wild-card patterns that form part of a
7743 list, just give the file name on its own, without a search type, as described
7744 in the previous section. You could also use the &(wildlsearch)& or
7745 &(nwildlsearch)&, but there is no advantage in doing this.
7746
7747
7748
7749
7750 .section "Named lists" "SECTnamedlists"
7751 .cindex "named lists"
7752 .cindex "list" "named"
7753 A list of domains, hosts, email addresses, or local parts can be given a name
7754 which is then used to refer to the list elsewhere in the configuration. This is
7755 particularly convenient if the same list is required in several different
7756 places. It also allows lists to be given meaningful names, which can improve
7757 the readability of the configuration. For example, it is conventional to define
7758 a domain list called &'local_domains'& for all the domains that are handled
7759 locally on a host, using a configuration line such as
7760 .code
7761 domainlist local_domains = localhost:my.dom.example
7762 .endd
7763 Named lists are referenced by giving their name preceded by a plus sign, so,
7764 for example, a router that is intended to handle local domains would be
7765 configured with the line
7766 .code
7767 domains = +local_domains
7768 .endd
7769 The first router in a configuration is often one that handles all domains
7770 except the local ones, using a configuration with a negated item like this:
7771 .code
7772 dnslookup:
7773   driver = dnslookup
7774   domains = ! +local_domains
7775   transport = remote_smtp
7776   no_more
7777 .endd
7778 The four kinds of named list are created by configuration lines starting with
7779 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
7780 respectively. Then there follows the name that you are defining, followed by an
7781 equals sign and the list itself. For example:
7782 .code
7783 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
7784 addresslist bad_senders = cdb;/etc/badsenders
7785 .endd
7786 A named list may refer to other named lists:
7787 .code
7788 domainlist  dom1 = first.example : second.example
7789 domainlist  dom2 = +dom1 : third.example
7790 domainlist  dom3 = fourth.example : +dom2 : fifth.example
7791 .endd
7792 &*Warning*&: If the last item in a referenced list is a negative one, the
7793 effect may not be what you intended, because the negation does not propagate
7794 out to the higher level. For example, consider:
7795 .code
7796 domainlist  dom1 = !a.b
7797 domainlist  dom2 = +dom1 : *.b
7798 .endd
7799 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
7800 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
7801 means it matches the second list as well. The effect is not the same as
7802 .code
7803 domainlist  dom2 = !a.b : *.b
7804 .endd
7805 where &'x.y'& does not match. It's best to avoid negation altogether in
7806 referenced lists if you can.
7807
7808 Named lists may have a performance advantage. When Exim is routing an
7809 address or checking an incoming message, it caches the result of tests on named
7810 lists. So, if you have a setting such as
7811 .code
7812 domains = +local_domains
7813 .endd
7814 on several of your routers
7815 or in several ACL statements,
7816 the actual test is done only for the first one. However, the caching works only
7817 if there are no expansions within the list itself or any sublists that it
7818 references. In other words, caching happens only for lists that are known to be
7819 the same each time they are referenced.
7820
7821 By default, there may be up to 16 named lists of each type. This limit can be
7822 extended by changing a compile-time variable. The use of domain and host lists
7823 is recommended for concepts such as local domains, relay domains, and relay
7824 hosts. The default configuration is set up like this.
7825
7826
7827
7828 .section "Named lists compared with macros" "SECID78"
7829 .cindex "list" "named compared with macro"
7830 .cindex "macro" "compared with named list"
7831 At first sight, named lists might seem to be no different from macros in the
7832 configuration file. However, macros are just textual substitutions. If you
7833 write
7834 .code
7835 ALIST = host1 : host2
7836 auth_advertise_hosts = !ALIST
7837 .endd
7838 it probably won't do what you want, because that is exactly the same as
7839 .code
7840 auth_advertise_hosts = !host1 : host2
7841 .endd
7842 Notice that the second host name is not negated. However, if you use a host
7843 list, and write
7844 .code
7845 hostlist alist = host1 : host2
7846 auth_advertise_hosts = ! +alist
7847 .endd
7848 the negation applies to the whole list, and so that is equivalent to
7849 .code
7850 auth_advertise_hosts = !host1 : !host2
7851 .endd
7852
7853
7854 .section "Named list caching" "SECID79"
7855 .cindex "list" "caching of named"
7856 .cindex "caching" "named lists"
7857 While processing a message, Exim caches the result of checking a named list if
7858 it is sure that the list is the same each time. In practice, this means that
7859 the cache operates only if the list contains no $ characters, which guarantees
7860 that it will not change when it is expanded. Sometimes, however, you may have
7861 an expanded list that you know will be the same each time within a given
7862 message. For example:
7863 .code
7864 domainlist special_domains = \
7865            ${lookup{$sender_host_address}cdb{/some/file}}
7866 .endd
7867 This provides a list of domains that depends only on the sending host's IP
7868 address. If this domain list is referenced a number of times (for example,
7869 in several ACL lines, or in several routers) the result of the check is not
7870 cached by default, because Exim does not know that it is going to be the
7871 same list each time.
7872
7873 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
7874 cache the result anyway. For example:
7875 .code
7876 domainlist_cache special_domains = ${lookup{...
7877 .endd
7878 If you do this, you should be absolutely sure that caching is going to do
7879 the right thing in all cases. When in doubt, leave it out.
7880
7881
7882
7883 .section "Domain lists" "SECTdomainlist"
7884 .cindex "domain list" "patterns for"
7885 .cindex "list" "domain list"
7886 Domain lists contain patterns that are to be matched against a mail domain.
7887 The following types of item may appear in domain lists:
7888
7889 .ilist
7890 .cindex "primary host name"
7891 .cindex "host name" "matched in domain list"
7892 .oindex "&%primary_hostname%&"
7893 .cindex "domain list" "matching primary host name"
7894 .cindex "@ in a domain list"
7895 If a pattern consists of a single @ character, it matches the local host name,
7896 as set by the &%primary_hostname%& option (or defaulted). This makes it
7897 possible to use the same configuration file on several different hosts that
7898 differ only in their names.
7899 .next
7900 .cindex "@[] in a domain list"
7901 .cindex "domain list" "matching local IP interfaces"
7902 .cindex "domain literal"
7903 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
7904 in square brackets (as in an email address that contains a domain literal), but
7905 only if that IP address is recognized as local for email routing purposes. The
7906 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
7907 control which of a host's several IP addresses are treated as local.
7908 In today's Internet, the use of domain literals is controversial.
7909 .next
7910 .cindex "@mx_any"
7911 .cindex "@mx_primary"
7912 .cindex "@mx_secondary"
7913 .cindex "domain list" "matching MX pointers to local host"
7914 If a pattern consists of the string &`@mx_any`& it matches any domain that
7915 has an MX record pointing to the local host or to any host that is listed in
7916 .oindex "&%hosts_treat_as_local%&"
7917 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
7918 are similar, except that the first matches only when a primary MX target is the
7919 local host, and the second only when no primary MX target is the local host,
7920 but a secondary MX target is. &"Primary"& means an MX record with the lowest
7921 preference value &-- there may of course be more than one of them.
7922
7923 The MX lookup that takes place when matching a pattern of this type is
7924 performed with the resolver options for widening names turned off. Thus, for
7925 example, a single-component domain will &'not'& be expanded by adding the
7926 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
7927 options of the &(dnslookup)& router for a discussion of domain widening.
7928
7929 Sometimes you may want to ignore certain IP addresses when using one of these
7930 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
7931 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
7932 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
7933 on a router). For example:
7934 .code
7935 domains = @mx_any/ignore=127.0.0.1
7936 .endd
7937 This example matches any domain that has an MX record pointing to one of
7938 the local host's IP addresses other than 127.0.0.1.
7939
7940 The list of IP addresses is in fact processed by the same code that processes
7941 host lists, so it may contain CIDR-coded network specifications and it may also
7942 contain negative items.
7943
7944 Because the list of IP addresses is a sublist within a domain list, you have to
7945 be careful about delimiters if there is more than one address. Like any other
7946 list, the default delimiter can be changed. Thus, you might have:
7947 .code
7948 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
7949           an.other.domain : ...
7950 .endd
7951 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
7952 involved, it is easiest to change the delimiter for the main list as well:
7953 .code
7954 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
7955           an.other.domain ? ...
7956 .endd
7957 .next
7958 .cindex "asterisk" "in domain list"
7959 .cindex "domain list" "asterisk in"
7960 .cindex "domain list" "matching &""ends with""&"
7961 If a pattern starts with an asterisk, the remaining characters of the pattern
7962 are compared with the terminating characters of the domain. The use of &"*"& in
7963 domain lists differs from its use in partial matching lookups. In a domain
7964 list, the character following the asterisk need not be a dot, whereas partial
7965 matching works only in terms of dot-separated components. For example, a domain
7966 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
7967 &'cipher.key.ex'&.
7968
7969 .next
7970 .cindex "regular expressions" "in domain list"
7971 .cindex "domain list" "matching regular expression"
7972 If a pattern starts with a circumflex character, it is treated as a regular
7973 expression, and matched against the domain using a regular expression matching
7974 function. The circumflex is treated as part of the regular expression.
7975 Email domains are case-independent, so this regular expression match is by
7976 default case-independent, but you can make it case-dependent by starting it
7977 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
7978 are given in chapter &<<CHAPregexp>>&.
7979
7980 &*Warning*&: Because domain lists are expanded before being processed, you
7981 must escape any backslash and dollar characters in the regular expression, or
7982 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
7983 it is not to be expanded (unless you really do want to build a regular
7984 expression by expansion, of course).
7985 .next
7986 .cindex "lookup" "in domain list"
7987 .cindex "domain list" "matching by lookup"
7988 If a pattern starts with the name of a single-key lookup type followed by a
7989 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
7990 must be a file name in a suitable format for the lookup type. For example, for
7991 &"cdb;"& it must be an absolute path:
7992 .code
7993 domains = cdb;/etc/mail/local_domains.cdb
7994 .endd
7995 The appropriate type of lookup is done on the file using the domain name as the
7996 key. In most cases, the data that is looked up is not used; Exim is interested
7997 only in whether or not the key is present in the file. However, when a lookup
7998 is used for the &%domains%& option on a router
7999 or a &%domains%& condition in an ACL statement, the data is preserved in the
8000 &$domain_data$& variable and can be referred to in other router options or
8001 other statements in the same ACL.
8002
8003 .next
8004 Any of the single-key lookup type names may be preceded by
8005 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
8006 .code
8007 domains = partial-dbm;/partial/domains
8008 .endd
8009 This causes partial matching logic to be invoked; a description of how this
8010 works is given in section &<<SECTpartiallookup>>&.
8011
8012 .next
8013 .cindex "asterisk" "in lookup type"
8014 Any of the single-key lookup types may be followed by an asterisk. This causes
8015 a default lookup for a key consisting of a single asterisk to be done if the
8016 original lookup fails. This is not a useful feature when using a domain list to
8017 select particular domains (because any domain would match), but it might have
8018 value if the result of the lookup is being used via the &$domain_data$&
8019 expansion variable.
8020 .next
8021 If the pattern starts with the name of a query-style lookup type followed by a
8022 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
8023 pattern must be an appropriate query for the lookup type, as described in
8024 chapter &<<CHAPfdlookup>>&. For example:
8025 .code
8026 hold_domains = mysql;select domain from holdlist \
8027   where domain = '${quote_mysql:$domain}';
8028 .endd
8029 In most cases, the data that is looked up is not used (so for an SQL query, for
8030 example, it doesn't matter what field you select). Exim is interested only in
8031 whether or not the query succeeds. However, when a lookup is used for the
8032 &%domains%& option on a router, the data is preserved in the &$domain_data$&
8033 variable and can be referred to in other options.
8034 .next
8035 .cindex "domain list" "matching literal domain name"
8036 If none of the above cases apply, a caseless textual comparison is made
8037 between the pattern and the domain.
8038 .endlist
8039
8040 Here is an example that uses several different kinds of pattern:
8041 .code
8042 domainlist funny_domains = \
8043   @ : \
8044   lib.unseen.edu : \
8045   *.foundation.fict.example : \
8046   \N^[1-2]\d{3}\.fict\.example$\N : \
8047   partial-dbm;/opt/data/penguin/book : \
8048   nis;domains.byname : \
8049   nisplus;[name=$domain,status=local],domains.org_dir
8050 .endd
8051 There are obvious processing trade-offs among the various matching modes. Using
8052 an asterisk is faster than a regular expression, and listing a few names
8053 explicitly probably is too. The use of a file or database lookup is expensive,
8054 but may be the only option if hundreds of names are required. Because the
8055 patterns are tested in order, it makes sense to put the most commonly matched
8056 patterns earlier.
8057
8058
8059
8060 .section "Host lists" "SECThostlist"
8061 .cindex "host list" "patterns in"
8062 .cindex "list" "host list"
8063 Host lists are used to control what remote hosts are allowed to do. For
8064 example, some hosts may be allowed to use the local host as a relay, and some
8065 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8066 two different ways, by name or by IP address. In a host list, some types of
8067 pattern are matched to a host name, and some are matched to an IP address.
8068 You need to be particularly careful with this when single-key lookups are
8069 involved, to ensure that the right value is being used as the key.
8070
8071
8072 .section "Special host list patterns" "SECID80"
8073 .cindex "empty item in hosts list"
8074 .cindex "host list" "empty string in"
8075 If a host list item is the empty string, it matches only when no remote host is
8076 involved. This is the case when a message is being received from a local
8077 process using SMTP on the standard input, that is, when a TCP/IP connection is
8078 not used.
8079
8080 .cindex "asterisk" "in host list"
8081 The special pattern &"*"& in a host list matches any host or no host. Neither
8082 the IP address nor the name is actually inspected.
8083
8084
8085
8086 .section "Host list patterns that match by IP address" "SECThoslispatip"
8087 .cindex "host list" "matching IP addresses"
8088 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8089 the incoming address actually appears in the IPv6 host as
8090 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8091 list, it is converted into a traditional IPv4 address first. (Not all operating
8092 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8093 concerns.)
8094
8095 The following types of pattern in a host list check the remote host by
8096 inspecting its IP address:
8097
8098 .ilist
8099 If the pattern is a plain domain name (not a regular expression, not starting
8100 with *, not a lookup of any kind), Exim calls the operating system function
8101 to find the associated IP address(es). Exim uses the newer
8102 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8103 This typically causes a forward DNS lookup of the name. The result is compared
8104 with the IP address of the subject host.
8105
8106 If there is a temporary problem (such as a DNS timeout) with the host name
8107 lookup, a temporary error occurs. For example, if the list is being used in an
8108 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8109 temporary SMTP error code. If no IP address can be found for the host name,
8110 what happens is described in section &<<SECTbehipnot>>& below.
8111
8112 .next
8113 .cindex "@ in a host list"
8114 If the pattern is &"@"&, the primary host name is substituted and used as a
8115 domain name, as just described.
8116
8117 .next
8118 If the pattern is an IP address, it is matched against the IP address of the
8119 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8120 IPv6 addresses can be given in colon-separated format, but the colons have to
8121 be doubled so as not to be taken as item separators when the default list
8122 separator is used. IPv6 addresses are recognized even when Exim is compiled
8123 without IPv6 support. This means that if they appear in a host list on an
8124 IPv4-only host, Exim will not treat them as host names. They are just addresses
8125 that can never match a client host.
8126
8127 .next
8128 .cindex "@[] in a host list"
8129 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8130 the local host. For example, if the local host is an IPv4 host with one
8131 interface address 10.45.23.56, these two ACL statements have the same effect:
8132 .code
8133 accept hosts = 127.0.0.1 : 10.45.23.56
8134 accept hosts = @[]
8135 .endd
8136 .next
8137 .cindex "CIDR notation"
8138 If the pattern is an IP address followed by a slash and a mask length (for
8139 example 10.11.42.0/24), it is matched against the IP address of the subject
8140 host under the given mask. This allows, an entire network of hosts to be
8141 included (or excluded) by a single item. The mask uses CIDR notation; it
8142 specifies the number of address bits that must match, starting from the most
8143 significant end of the address.
8144
8145 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8146 of a range of addresses. It is the number of bits in the network portion of the
8147 address. The above example specifies a 24-bit netmask, so it matches all 256
8148 addresses in the 10.11.42.0 network. An item such as
8149 .code
8150 192.168.23.236/31
8151 .endd
8152 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8153 32 for an IPv4 address is the same as no mask at all; just a single address
8154 matches.
8155
8156 Here is another example which shows an IPv4 and an IPv6 network:
8157 .code
8158 recipient_unqualified_hosts = 192.168.0.0/16: \
8159                               3ffe::ffff::836f::::/48
8160 .endd
8161 The doubling of list separator characters applies only when these items
8162 appear inline in a host list. It is not required when indirecting via a file.
8163 For example:
8164 .code
8165 recipient_unqualified_hosts = /opt/exim/unqualnets
8166 .endd
8167 could make use of a file containing
8168 .code
8169 172.16.0.0/12
8170 3ffe:ffff:836f::/48
8171 .endd
8172 to have exactly the same effect as the previous example. When listing IPv6
8173 addresses inline, it is usually more convenient to use the facility for
8174 changing separator characters. This list contains the same two networks:
8175 .code
8176 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8177                                  3ffe:ffff:836f::/48
8178 .endd
8179 The separator is changed to semicolon by the leading &"<;"& at the start of the
8180 list.
8181 .endlist
8182
8183
8184
8185 .section "Host list patterns for single-key lookups by host address" &&&
8186          "SECThoslispatsikey"
8187 .cindex "host list" "lookup of IP address"
8188 When a host is to be identified by a single-key lookup of its complete IP
8189 address, the pattern takes this form:
8190 .display
8191 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8192 .endd
8193 For example:
8194 .code
8195 hosts_lookup = net-cdb;/hosts-by-ip.db
8196 .endd
8197 The text form of the IP address of the subject host is used as the lookup key.
8198 IPv6 addresses are converted to an unabbreviated form, using lower case
8199 letters, with dots as separators because colon is the key terminator in
8200 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8201 quoting the keys, but this is a facility that was added later.] The data
8202 returned by the lookup is not used.
8203
8204 .cindex "IP address" "masking"
8205 .cindex "host list" "masked IP address"
8206 Single-key lookups can also be performed using masked IP addresses, using
8207 patterns of this form:
8208 .display
8209 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8210 .endd
8211 For example:
8212 .code
8213 net24-dbm;/networks.db
8214 .endd
8215 The IP address of the subject host is masked using <&'number'&> as the mask
8216 length. A textual string is constructed from the masked value, followed by the
8217 mask, and this is used as the lookup key. For example, if the host's IP address
8218 is 192.168.34.6, the key that is looked up for the above example is
8219 &"192.168.34.0/24"&.
8220
8221 When an IPv6 address is converted to a string, dots are normally used instead
8222 of colons, so that keys in &(lsearch)& files need not contain colons (which
8223 terminate &(lsearch)& keys). This was implemented some time before the ability
8224 to quote keys was made available in &(lsearch)& files. However, the more
8225 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8226 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8227 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8228 converted using colons and not dots. In all cases, full, unabbreviated IPv6
8229 addresses are always used.
8230
8231 Ideally, it would be nice to tidy up this anomalous situation by changing to
8232 colons in all cases, given that quoting is now available for &(lsearch)&.
8233 However, this would be an incompatible change that might break some existing
8234 configurations.
8235
8236 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8237 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8238 the former case the key strings include the mask value, whereas in the latter
8239 case the IP address is used on its own.
8240
8241
8242
8243 .section "Host list patterns that match by host name" "SECThoslispatnam"
8244 .cindex "host" "lookup failures"
8245 .cindex "unknown host name"
8246 .cindex "host list" "matching host name"
8247 There are several types of pattern that require Exim to know the name of the
8248 remote host. These are either wildcard patterns or lookups by name. (If a
8249 complete hostname is given without any wildcarding, it is used to find an IP
8250 address to match against, as described in section &<<SECThoslispatip>>&
8251 above.)
8252
8253 If the remote host name is not already known when Exim encounters one of these
8254 patterns, it has to be found from the IP address.
8255 Although many sites on the Internet are conscientious about maintaining reverse
8256 DNS data for their hosts, there are also many that do not do this.
8257 Consequently, a name cannot always be found, and this may lead to unwanted
8258 effects. Take care when configuring host lists with wildcarded name patterns.
8259 Consider what will happen if a name cannot be found.
8260
8261 Because of the problems of determining host names from IP addresses, matching
8262 against host names is not as common as matching against IP addresses.
8263
8264 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8265 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8266 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8267 are done can be changed by setting the &%host_lookup_order%& option. For
8268 security, once Exim has found one or more names, it looks up the IP addresses
8269 for these names and compares them with the IP address that it started with.
8270 Only those names whose IP addresses match are accepted. Any other names are
8271 discarded. If no names are left, Exim behaves as if the host name cannot be
8272 found. In the most common case there is only one name and one IP address.
8273
8274 There are some options that control what happens if a host name cannot be
8275 found. These are described in section &<<SECTbehipnot>>& below.
8276
8277 .cindex "host" "alias for"
8278 .cindex "alias for host"
8279 As a result of aliasing, hosts may have more than one name. When processing any
8280 of the following types of pattern, all the host's names are checked:
8281
8282 .ilist
8283 .cindex "asterisk" "in host list"
8284 If a pattern starts with &"*"& the remainder of the item must match the end of
8285 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8286 &'.b.c'&. This special simple form is provided because this is a very common
8287 requirement. Other kinds of wildcarding require the use of a regular
8288 expression.
8289 .next
8290 .cindex "regular expressions" "in host list"
8291 .cindex "host list" "regular expression in"
8292 If the item starts with &"^"& it is taken to be a regular expression which is
8293 matched against the host name. Host names are case-independent, so this regular
8294 expression match is by default case-independent, but you can make it
8295 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
8296 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
8297 example,
8298 .code
8299 ^(a|b)\.c\.d$
8300 .endd
8301 is a regular expression that matches either of the two hosts &'a.c.d'& or
8302 &'b.c.d'&. When a regular expression is used in a host list, you must take care
8303 that backslash and dollar characters are not misinterpreted as part of the
8304 string expansion. The simplest way to do this is to use &`\N`& to mark that
8305 part of the string as non-expandable. For example:
8306 .code
8307 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
8308 .endd
8309 &*Warning*&: If you want to match a complete host name, you must include the
8310 &`$`& terminating metacharacter in the regular expression, as in the above
8311 example. Without it, a match at the start of the host name is all that is
8312 required.
8313 .endlist
8314
8315
8316
8317
8318 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
8319 .cindex "host" "lookup failures, permanent"
8320 While processing a host list, Exim may need to look up an IP address from a
8321 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
8322 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
8323 behaviour when it fails to find the information it is seeking is the same.
8324
8325 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
8326 apply to temporary DNS errors, whose handling is described in the next section.
8327
8328 .cindex "&`+include_unknown`&"
8329 .cindex "&`+ignore_unknown`&"
8330 Exim parses a host list from left to right. If it encounters a permanent
8331 lookup failure in any item in the host list before it has found a match,
8332 Exim treats it as a failure and the default behavior is as if the host
8333 does not match the list. This may not always be what you want to happen.
8334 To change Exim's behaviour, the special items &`+include_unknown`& or
8335 &`+ignore_unknown`& may appear in the list (at top level &-- they are
8336 not recognized in an indirected file).
8337
8338 .ilist
8339 If any item that follows &`+include_unknown`& requires information that
8340 cannot found, Exim behaves as if the host does match the list. For example,
8341 .code
8342 host_reject_connection = +include_unknown:*.enemy.ex
8343 .endd
8344 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
8345 any hosts whose name it cannot find.
8346
8347 .next
8348 If any item that follows &`+ignore_unknown`& requires information that cannot
8349 be found, Exim ignores that item and proceeds to the rest of the list. For
8350 example:
8351 .code
8352 accept hosts = +ignore_unknown : friend.example : \
8353                192.168.4.5
8354 .endd
8355 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
8356 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
8357 name can be found for 192.168.4.5, it is rejected.
8358 .endlist
8359
8360 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
8361 list. The effect of each one lasts until the next, or until the end of the
8362 list.
8363
8364 .section "Mixing wildcarded host names and addresses in host lists" &&&
8365          "SECTmixwilhos"
8366 .cindex "host list" "mixing names and addresses in"
8367
8368 This section explains the host/ip processing logic with the same concepts
8369 as the previous section, but specifically addresses what happens when a
8370 wildcarded hostname is one of the items in the hostlist.
8371
8372 .ilist
8373 If you have name lookups or wildcarded host names and
8374 IP addresses in the same host list, you should normally put the IP
8375 addresses first. For example, in an ACL you could have:
8376 .code
8377 accept hosts = 10.9.8.7 : *.friend.example
8378 .endd
8379 The reason you normally would order it this way lies in the
8380 left-to-right way that Exim processes lists.  It can test IP addresses
8381 without doing any DNS lookups, but when it reaches an item that requires
8382 a host name, it fails if it cannot find a host name to compare with the
8383 pattern. If the above list is given in the opposite order, the
8384 &%accept%& statement fails for a host whose name cannot be found, even
8385 if its IP address is 10.9.8.7.
8386
8387 .next
8388 If you really do want to do the name check first, and still recognize the IP
8389 address, you can rewrite the ACL like this:
8390 .code
8391 accept hosts = *.friend.example
8392 accept hosts = 10.9.8.7
8393 .endd
8394 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
8395 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
8396 &`+ignore_unknown`&, which was discussed in depth in the first example in
8397 this section.
8398 .endlist
8399
8400
8401 .section "Temporary DNS errors when looking up host information" &&&
8402          "SECTtemdnserr"
8403 .cindex "host" "lookup failures, temporary"
8404 .cindex "&`+include_defer`&"
8405 .cindex "&`+ignore_defer`&"
8406 A temporary DNS lookup failure normally causes a defer action (except when
8407 &%dns_again_means_nonexist%& converts it into a permanent error). However,
8408 host lists can include &`+ignore_defer`& and &`+include_defer`&, analagous to
8409 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
8410 section. These options should be used with care, probably only in non-critical
8411 host lists such as whitelists.
8412
8413
8414
8415 .section "Host list patterns for single-key lookups by host name" &&&
8416          "SECThoslispatnamsk"
8417 .cindex "unknown host name"
8418 .cindex "host list" "matching host name"
8419 If a pattern is of the form
8420 .display
8421 <&'single-key-search-type'&>;<&'search-data'&>
8422 .endd
8423 for example
8424 .code
8425 dbm;/host/accept/list
8426 .endd
8427 a single-key lookup is performed, using the host name as its key. If the
8428 lookup succeeds, the host matches the item. The actual data that is looked up
8429 is not used.
8430
8431 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
8432 keys in the file, not IP addresses. If you want to do lookups based on IP
8433 addresses, you must precede the search type with &"net-"& (see section
8434 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
8435 two items in the same list, one doing an address lookup and one doing a name
8436 lookup, both using the same file.
8437
8438
8439
8440 .section "Host list patterns for query-style lookups" "SECID81"
8441 If a pattern is of the form
8442 .display
8443 <&'query-style-search-type'&>;<&'query'&>
8444 .endd
8445 the query is obeyed, and if it succeeds, the host matches the item. The actual
8446 data that is looked up is not used. The variables &$sender_host_address$& and
8447 &$sender_host_name$& can be used in the query. For example:
8448 .code
8449 hosts_lookup = pgsql;\
8450   select ip from hostlist where ip='$sender_host_address'
8451 .endd
8452 The value of &$sender_host_address$& for an IPv6 address contains colons. You
8453 can use the &%sg%& expansion item to change this if you need to. If you want to
8454 use masked IP addresses in database queries, you can use the &%mask%& expansion
8455 operator.
8456
8457 If the query contains a reference to &$sender_host_name$&, Exim automatically
8458 looks up the host name if it has not already done so. (See section
8459 &<<SECThoslispatnam>>& for comments on finding host names.)
8460
8461 Historical note: prior to release 4.30, Exim would always attempt to find a
8462 host name before running the query, unless the search type was preceded by
8463 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
8464 still recognized for query-style lookups, but its presence or absence has no
8465 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
8466 See section &<<SECThoslispatsikey>>&.)
8467
8468
8469
8470
8471
8472 .section "Address lists" "SECTaddresslist"
8473 .cindex "list" "address list"
8474 .cindex "address list" "empty item"
8475 .cindex "address list" "patterns"
8476 Address lists contain patterns that are matched against mail addresses. There
8477 is one special case to be considered: the sender address of a bounce message is
8478 always empty. You can test for this by providing an empty item in an address
8479 list. For example, you can set up a router to process bounce messages by
8480 using this option setting:
8481 .code
8482 senders = :
8483 .endd
8484 The presence of the colon creates an empty item. If you do not provide any
8485 data, the list is empty and matches nothing. The empty sender can also be
8486 detected by a regular expression that matches an empty string,
8487 and by a query-style lookup that succeeds when &$sender_address$& is empty.
8488
8489 Non-empty items in an address list can be straightforward email addresses. For
8490 example:
8491 .code
8492 senders = jbc@askone.example : hs@anacreon.example
8493 .endd
8494 A certain amount of wildcarding is permitted. If a pattern contains an @
8495 character, but is not a regular expression and does not begin with a
8496 semicolon-terminated lookup type (described below), the local part of the
8497 subject address is compared with the local part of the pattern, which may start
8498 with an asterisk. If the local parts match, the domain is checked in exactly
8499 the same way as for a pattern in a domain list. For example, the domain can be
8500 wildcarded, refer to a named list, or be a lookup:
8501 .code
8502 deny senders = *@*.spamming.site:\
8503                *@+hostile_domains:\
8504                bozo@partial-lsearch;/list/of/dodgy/sites:\
8505                *@dbm;/bad/domains.db
8506 .endd
8507 .cindex "local part" "starting with !"
8508 .cindex "address list" "local part starting with !"
8509 If a local part that begins with an exclamation mark is required, it has to be
8510 specified using a regular expression, because otherwise the exclamation mark is
8511 treated as a sign of negation, as is standard in lists.
8512
8513 If a non-empty pattern that is not a regular expression or a lookup does not
8514 contain an @ character, it is matched against the domain part of the subject
8515 address. The only two formats that are recognized this way are a literal
8516 domain, or a domain pattern that starts with *. In both these cases, the effect
8517 is the same as if &`*@`& preceded the pattern. For example:
8518 .code
8519 deny senders = enemy.domain : *.enemy.domain
8520 .endd
8521
8522 The following kinds of more complicated address list pattern can match any
8523 address, including the empty address that is characteristic of bounce message
8524 senders:
8525
8526 .ilist
8527 .cindex "regular expressions" "in address list"
8528 .cindex "address list" "regular expression in"
8529 If (after expansion) a pattern starts with &"^"&, a regular expression match is
8530 done against the complete address, with the pattern as the regular expression.
8531 You must take care that backslash and dollar characters are not misinterpreted
8532 as part of the string expansion. The simplest way to do this is to use &`\N`&
8533 to mark that part of the string as non-expandable. For example:
8534 .code
8535 deny senders = \N^.*this.*@example\.com$\N : \
8536                \N^\d{8}.+@spamhaus.example$\N : ...
8537 .endd
8538 The &`\N`& sequences are removed by the expansion, so these items do indeed
8539 start with &"^"& by the time they are being interpreted as address patterns.
8540
8541 .next
8542 .cindex "address list" "lookup for complete address"
8543 Complete addresses can be looked up by using a pattern that starts with a
8544 lookup type terminated by a semicolon, followed by the data for the lookup. For
8545 example:
8546 .code
8547 deny senders = cdb;/etc/blocked.senders : \
8548   mysql;select address from blocked where \
8549   address='${quote_mysql:$sender_address}'
8550 .endd
8551 Both query-style and single-key lookup types can be used. For a single-key
8552 lookup type, Exim uses the complete address as the key. However, empty keys are
8553 not supported for single-key lookups, so a match against the empty address
8554 always fails. This restriction does not apply to query-style lookups.
8555
8556 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
8557 cannot be used, and is ignored if specified, with an entry being written to the
8558 panic log.
8559 .cindex "*@ with single-key lookup"
8560 However, you can configure lookup defaults, as described in section
8561 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
8562 default. For example, with this lookup:
8563 .code
8564 accept senders = lsearch*@;/some/file
8565 .endd
8566 the file could contains lines like this:
8567 .code
8568 user1@domain1.example
8569 *@domain2.example
8570 .endd
8571 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
8572 that are tried is:
8573 .code
8574 nimrod@jaeger.example
8575 *@jaeger.example
8576 *
8577 .endd
8578 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
8579 would mean that every address matches, thus rendering the test useless.
8580
8581 &*Warning 2*&: Do not confuse these two kinds of item:
8582 .code
8583 deny recipients = dbm*@;/some/file
8584 deny recipients = *@dbm;/some/file
8585 .endd
8586 The first does a whole address lookup, with defaulting, as just described,
8587 because it starts with a lookup type. The second matches the local part and
8588 domain independently, as described in a bullet point below.
8589 .endlist
8590
8591
8592 The following kinds of address list pattern can match only non-empty addresses.
8593 If the subject address is empty, a match against any of these pattern types
8594 always fails.
8595
8596
8597 .ilist
8598 .cindex "@@ with single-key lookup"
8599 .cindex "address list" "@@ lookup type"
8600 .cindex "address list" "split local part and domain"
8601 If a pattern starts with &"@@"& followed by a single-key lookup item
8602 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
8603 split into a local part and a domain. The domain is looked up in the file. If
8604 it is not found, there is no match. If it is found, the data that is looked up
8605 from the file is treated as a colon-separated list of local part patterns, each
8606 of which is matched against the subject local part in turn.
8607
8608 .cindex "asterisk" "in address list"
8609 The lookup may be a partial one, and/or one involving a search for a default
8610 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
8611 patterns that are looked up can be regular expressions or begin with &"*"&, or
8612 even be further lookups. They may also be independently negated. For example,
8613 with
8614 .code
8615 deny senders = @@dbm;/etc/reject-by-domain
8616 .endd
8617 the data from which the DBM file is built could contain lines like
8618 .code
8619 baddomain.com:  !postmaster : *
8620 .endd
8621 to reject all senders except &%postmaster%& from that domain.
8622
8623 .cindex "local part" "starting with !"
8624 If a local part that actually begins with an exclamation mark is required, it
8625 has to be specified using a regular expression. In &(lsearch)& files, an entry
8626 may be split over several lines by indenting the second and subsequent lines,
8627 but the separating colon must still be included at line breaks. White space
8628 surrounding the colons is ignored. For example:
8629 .code
8630 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
8631   spammer3 : spammer4
8632 .endd
8633 As in all colon-separated lists in Exim, a colon can be included in an item by
8634 doubling.
8635
8636 If the last item in the list starts with a right angle-bracket, the remainder
8637 of the item is taken as a new key to look up in order to obtain a continuation
8638 list of local parts. The new key can be any sequence of characters. Thus one
8639 might have entries like
8640 .code
8641 aol.com: spammer1 : spammer 2 : >*
8642 xyz.com: spammer3 : >*
8643 *:       ^\d{8}$
8644 .endd
8645 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
8646 local parts for all domains, in addition to the specific local parts listed for
8647 each domain. Of course, using this feature costs another lookup each time a
8648 chain is followed, but the effort needed to maintain the data is reduced.
8649
8650 .cindex "loop" "in lookups"
8651 It is possible to construct loops using this facility, and in order to catch
8652 them, the chains may be no more than fifty items long.
8653
8654 .next
8655 The @@<&'lookup'&> style of item can also be used with a query-style
8656 lookup, but in this case, the chaining facility is not available. The lookup
8657 can only return a single list of local parts.
8658 .endlist
8659
8660 &*Warning*&: There is an important difference between the address list items
8661 in these two examples:
8662 .code
8663 senders = +my_list
8664 senders = *@+my_list
8665 .endd
8666 In the first one, &`my_list`& is a named address list, whereas in the second
8667 example it is a named domain list.
8668
8669
8670
8671
8672 .section "Case of letters in address lists" "SECTcasletadd"
8673 .cindex "case of local parts"
8674 .cindex "address list" "case forcing"
8675 .cindex "case forcing in address lists"
8676 Domains in email addresses are always handled caselessly, but for local parts
8677 case may be significant on some systems (see &%caseful_local_part%& for how
8678 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
8679 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
8680 blocking lists should be done in a case-independent manner. Since most address
8681 lists in Exim are used for this kind of control, Exim attempts to do this by
8682 default.
8683
8684 The domain portion of an address is always lowercased before matching it to an
8685 address list. The local part is lowercased by default, and any string
8686 comparisons that take place are done caselessly. This means that the data in
8687 the address list itself, in files included as plain file names, and in any file
8688 that is looked up using the &"@@"& mechanism, can be in any case. However, the
8689 keys in files that are looked up by a search type other than &(lsearch)& (which
8690 works caselessly) must be in lower case, because these lookups are not
8691 case-independent.
8692
8693 .cindex "&`+caseful`&"
8694 To allow for the possibility of caseful address list matching, if an item in
8695 an address list is the string &"+caseful"&, the original case of the local
8696 part is restored for any comparisons that follow, and string comparisons are no
8697 longer case-independent. This does not affect the domain, which remains in
8698 lower case. However, although independent matches on the domain alone are still
8699 performed caselessly, regular expressions that match against an entire address
8700 become case-sensitive after &"+caseful"& has been seen.
8701
8702
8703
8704 .section "Local part lists" "SECTlocparlis"
8705 .cindex "list" "local part list"
8706 .cindex "local part" "list"
8707 Case-sensitivity in local part lists is handled in the same way as for address
8708 lists, as just described. The &"+caseful"& item can be used if required. In a
8709 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
8710 set false, the subject is lowercased and the matching is initially
8711 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
8712 matching in the local part list, but not elsewhere in the router. If
8713 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
8714 option is case-sensitive from the start.
8715
8716 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
8717 comments are handled in the same way as address lists &-- they are recognized
8718 only if the # is preceded by white space or the start of the line.
8719 Otherwise, local part lists are matched in the same way as domain lists, except
8720 that the special items that refer to the local host (&`@`&, &`@[]`&,
8721 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
8722 Refer to section &<<SECTdomainlist>>& for details of the other available item
8723 types.
8724 .ecindex IIDdohoadli
8725
8726
8727
8728
8729 . ////////////////////////////////////////////////////////////////////////////
8730 . ////////////////////////////////////////////////////////////////////////////
8731
8732 .chapter "String expansions" "CHAPexpand"
8733 .scindex IIDstrexp "expansion" "of strings"
8734 Many strings in Exim's run time configuration are expanded before use. Some of
8735 them are expanded every time they are used; others are expanded only once.
8736
8737 When a string is being expanded it is copied verbatim from left to right except
8738 when a dollar or backslash character is encountered. A dollar specifies the
8739 start of a portion of the string that is interpreted and replaced as described
8740 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
8741 escape character, as described in the following section.
8742
8743 Whether a string is expanded depends upon the context.  Usually this is solely
8744 dependent upon the option for which a value is sought; in this documentation,
8745 options for which string expansion is performed are marked with &dagger; after
8746 the data type.  ACL rules always expand strings.  A couple of expansion
8747 conditions do not expand some of the brace-delimited branches, for security
8748 reasons.
8749
8750
8751
8752 .section "Literal text in expanded strings" "SECTlittext"
8753 .cindex "expansion" "including literal text"
8754 An uninterpreted dollar can be included in an expanded string by putting a
8755 backslash in front of it. A backslash can be used to prevent any special
8756 character being treated specially in an expansion, including backslash itself.
8757 If the string appears in quotes in the configuration file, two backslashes are
8758 required because the quotes themselves cause interpretation of backslashes when
8759 the string is read in (see section &<<SECTstrings>>&).
8760
8761 .cindex "expansion" "non-expandable substrings"
8762 A portion of the string can specified as non-expandable by placing it between
8763 two occurrences of &`\N`&. This is particularly useful for protecting regular
8764 expressions, which often contain backslashes and dollar signs. For example:
8765 .code
8766 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
8767 .endd
8768 On encountering the first &`\N`&, the expander copies subsequent characters
8769 without interpretation until it reaches the next &`\N`& or the end of the
8770 string.
8771
8772
8773
8774 .section "Character escape sequences in expanded strings" "SECID82"
8775 .cindex "expansion" "escape sequences"
8776 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
8777 expanded string is recognized as an escape sequence for the character newline,
8778 carriage return, or tab, respectively. A backslash followed by up to three
8779 octal digits is recognized as an octal encoding for a single character, and a
8780 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
8781 encoding.
8782
8783 These escape sequences are also recognized in quoted strings when they are read
8784 in. Their interpretation in expansions as well is useful for unquoted strings,
8785 and for other cases such as looked-up strings that are then expanded.
8786
8787
8788 .section "Testing string expansions" "SECID83"
8789 .cindex "expansion" "testing"
8790 .cindex "testing" "string expansion"
8791 .oindex "&%-be%&"
8792 Many expansions can be tested by calling Exim with the &%-be%& option. This
8793 takes the command arguments, or lines from the standard input if there are no
8794 arguments, runs them through the string expansion code, and writes the results
8795 to the standard output. Variables based on configuration values are set up, but
8796 since no message is being processed, variables such as &$local_part$& have no
8797 value. Nevertheless the &%-be%& option can be useful for checking out file and
8798 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
8799 and &%nhash%&.
8800
8801 Exim gives up its root privilege when it is called with the &%-be%& option, and
8802 instead runs under the uid and gid it was called with, to prevent users from
8803 using &%-be%& for reading files to which they do not have access.
8804
8805 .oindex "&%-bem%&"
8806 If you want to test expansions that include variables whose values are taken
8807 from a message, there are two other options that can be used. The &%-bem%&
8808 option is like &%-be%& except that it is followed by a file name. The file is
8809 read as a message before doing the test expansions. For example:
8810 .code
8811 exim -bem /tmp/test.message '$h_subject:'
8812 .endd
8813 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
8814 Exim message identifier. For example:
8815 .code
8816 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
8817 .endd
8818 This loads the message from Exim's spool before doing the test expansions, and
8819 is therefore restricted to admin users.
8820
8821
8822 .section "Forced expansion failure" "SECTforexpfai"
8823 .cindex "expansion" "forced failure"
8824 A number of expansions that are described in the following section have
8825 alternative &"true"& and &"false"& substrings, enclosed in brace characters
8826 (which are sometimes called &"curly brackets"&). Which of the two strings is
8827 used depends on some condition that is evaluated as part of the expansion. If,
8828 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
8829 the entire string expansion fails in a way that can be detected by the code
8830 that requested the expansion. This is called &"forced expansion failure"&, and
8831 its consequences depend on the circumstances. In some cases it is no different
8832 from any other expansion failure, but in others a different action may be
8833 taken. Such variations are mentioned in the documentation of the option that is
8834 being expanded.
8835
8836
8837
8838
8839 .section "Expansion items" "SECTexpansionitems"
8840 The following items are recognized in expanded strings. White space may be used
8841 between sub-items that are keywords or substrings enclosed in braces inside an
8842 outer set of braces, to improve readability. &*Warning*&: Within braces,
8843 white space is significant.
8844
8845 .vlist
8846 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
8847 .cindex "expansion" "variables"
8848 Substitute the contents of the named variable, for example:
8849 .code
8850 $local_part
8851 ${domain}
8852 .endd
8853 The second form can be used to separate the name from subsequent alphanumeric
8854 characters. This form (using braces) is available only for variables; it does
8855 &'not'& apply to message headers. The names of the variables are given in
8856 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
8857 given, the expansion fails.
8858
8859 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
8860 .cindex "expansion" "operators"
8861 The string is first itself expanded, and then the operation specified by
8862 <&'op'&> is applied to it. For example:
8863 .code
8864 ${lc:$local_part}
8865 .endd
8866 The string starts with the first character after the colon, which may be
8867 leading white space. A list of operators is given in section &<<SECTexpop>>&
8868 below. The operator notation is used for simple expansion items that have just
8869 one argument, because it reduces the number of braces and therefore makes the
8870 string easier to understand.
8871
8872 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
8873 This item inserts &"basic"& header lines. It is described with the &%header%&
8874 expansion item below.
8875
8876
8877 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
8878 .cindex "expansion" "calling an acl"
8879 .cindex "&%acl%&" "call from expansion"
8880 The name and zero to nine argument strings are first expanded separately.  The expanded
8881 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
8882 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
8883 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
8884 and may use the variables; if another acl expansion is used the values
8885 are restored after it returns.  If the ACL sets
8886 a value using a "message =" modifier and returns accept or deny, the value becomes
8887 the result of the expansion.
8888 If no message is set and the ACL returns accept or deny
8889 the expansion result is an empty string.
8890 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
8891
8892
8893 .vitem "&*${certextract{*&<&'field'&>&*}{*&<&'certificate'&>&*}&&&
8894        {*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
8895 .cindex "expansion" "extracting cerificate fields"
8896 .cindex "&%certextract%&" "certificate fields"
8897 .cindex "certificate" "extracting fields"
8898 The <&'certificate'&> must be a variable of type certificate.
8899 The field name is expanded and used to retrive the relevant field from
8900 the certificate.  Supported fields are:
8901 .display
8902 &`version        `&
8903 &`serial_number  `&
8904 &`subject        `& RFC4514 DN
8905 &`issuer         `& RFC4514 DN
8906 &`notbefore      `& time
8907 &`notafter       `& time
8908 &`sig_algorithm  `&
8909 &`signature      `&
8910 &`subj_altname   `& tagged list
8911 &`ocsp_uri       `& list
8912 &`crl_uri        `& list
8913 .endd
8914 If the field is found,
8915 <&'string2'&> is expanded, and replaces the whole item;
8916 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
8917 variable &$value$& contains the value that has been extracted. Afterwards, it
8918 is restored to any previous value it might have had.
8919
8920 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
8921 key is not found. If {<&'string2'&>} is also omitted, the value that was
8922 extracted is used.
8923
8924 Some field names take optional modifiers, appended and separated by commas.
8925
8926 The field selectors marked as "RFC4514" above
8927 output a Distinguished Name string which is
8928 not quite
8929 parseable by Exim as a comma-separated tagged list
8930 (the exceptions being elements containin commas).
8931 RDN elements of a single type may be selected by
8932 a modifier of the type label; if so the expansion
8933 result is a list (newline-separated by default).
8934 The separator may be changed by another modifer of
8935 a right angle-bracket followed immediately by the new separator.
8936 Recognised RDN type labels include "CN", "O", "OU" and "DC".
8937
8938 The field selectors marked as "time" above
8939 take an optional modifier of "int"
8940 for which the result is the number of seconds since epoch.
8941 Otherwise the result is a human-readable string
8942 in the timezone selected by the main "timezone" option.
8943
8944 The field selectors marked as "list" above return a list,
8945 newline-separated by default,
8946 (embedded separator characters in elements are doubled).
8947 The separator may be changed by a modifier of
8948 a right angle-bracket followed immediately by the new separator.
8949
8950 The field selectors marked as "tagged" above
8951 prefix each list element with a type string and an equals sign.
8952 Elements of only one type may be selected by a modifier
8953 which is one of "dns", "uri" or "mail";
8954 if so the elenment tags are omitted.
8955
8956 If not otherwise noted field values are presented in human-readable form.
8957
8958 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
8959        {*&<&'arg'&>&*}...}*&"
8960 .cindex &%dlfunc%&
8961 This expansion dynamically loads and then calls a locally-written C function.
8962 This functionality is available only if Exim is compiled with
8963 .code
8964 EXPAND_DLFUNC=yes
8965 .endd
8966 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
8967 object so that it doesn't reload the same object file in the same Exim process
8968 (but of course Exim does start new processes frequently).
8969
8970 There may be from zero to eight arguments to the function. When compiling
8971 a local function that is to be called in this way, &_local_scan.h_& should be
8972 included. The Exim variables and functions that are defined by that API
8973 are also available for dynamically loaded functions. The function itself
8974 must have the following type:
8975 .code
8976 int dlfunction(uschar **yield, int argc, uschar *argv[])
8977 .endd
8978 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
8979 function should return one of the following values:
8980
8981 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
8982 into the expanded string that is being built.
8983
8984 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
8985 from &'yield'&, if it is set.
8986
8987 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
8988 taken from &'yield'& if it is set.
8989
8990 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
8991
8992 When compiling a function that is to be used in this way with gcc,
8993 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
8994 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
8995
8996 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
8997        {*&<&'string3'&>&*}}*&"
8998 .cindex "expansion" "extracting substrings by key"
8999 .cindex "&%extract%&" "substrings by key"
9000 The key and <&'string1'&> are first expanded separately. Leading and trailing
9001 white space is removed from the key (but not from any of the strings). The key
9002 must not consist entirely of digits. The expanded <&'string1'&> must be of the
9003 form:
9004 .display
9005 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
9006 .endd
9007 .vindex "&$value$&"
9008 where the equals signs and spaces (but not both) are optional. If any of the
9009 values contain white space, they must be enclosed in double quotes, and any
9010 values that are enclosed in double quotes are subject to escape processing as
9011 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
9012 for the value that corresponds to the key. The search is case-insensitive. If
9013 the key is found, <&'string2'&> is expanded, and replaces the whole item;
9014 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9015 variable &$value$& contains the value that has been extracted. Afterwards, it
9016 is restored to any previous value it might have had.
9017
9018 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9019 key is not found. If {<&'string2'&>} is also omitted, the value that was
9020 extracted is used. Thus, for example, these two expansions are identical, and
9021 yield &"2001"&:
9022 .code
9023 ${extract{gid}{uid=1984 gid=2001}}
9024 ${extract{gid}{uid=1984 gid=2001}{$value}}
9025 .endd
9026 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
9027 appear, for example:
9028 .code
9029 ${extract{Z}{A=... B=...}{$value} fail }
9030 .endd
9031 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9032 {<&'string2'&>} must be present for &"fail"& to be recognized.
9033
9034
9035 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
9036         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9037 .cindex "expansion" "extracting substrings by number"
9038 .cindex "&%extract%&" "substrings by number"
9039 The <&'number'&> argument must consist entirely of decimal digits,
9040 apart from leading and trailing white space, which is ignored.
9041 This is what distinguishes this form of &%extract%& from the previous kind. It
9042 behaves in the same way, except that, instead of extracting a named field, it
9043 extracts from <&'string1'&> the field whose number is given as the first
9044 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
9045 <&'string3'&> as before.
9046
9047 The fields in the string are separated by any one of the characters in the
9048 separator string. These may include space or tab characters.
9049 The first field is numbered one. If the number is negative, the fields are
9050 counted from the end of the string, with the rightmost one numbered -1. If the
9051 number given is zero, the entire string is returned. If the modulus of the
9052 number is greater than the number of fields in the string, the result is the
9053 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
9054 provided. For example:
9055 .code
9056 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
9057 .endd
9058 yields &"42"&, and
9059 .code
9060 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
9061 .endd
9062 yields &"99"&. Two successive separators mean that the field between them is
9063 empty (for example, the fifth field above).
9064
9065
9066 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
9067 .cindex "list" "selecting by condition"
9068 .cindex "expansion" "selecting from list by condition"
9069 .vindex "&$item$&"
9070 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9071 default, but the separator can be changed in the usual way. For each item
9072 in this list, its value is place in &$item$&, and then the condition is
9073 evaluated. If the condition is true, &$item$& is added to the output as an
9074 item in a new list; if the condition is false, the item is discarded. The
9075 separator used for the output list is the same as the one used for the
9076 input, but a separator setting is not included in the output. For example:
9077 .code
9078 ${filter{a:b:c}{!eq{$item}{b}}
9079 .endd
9080 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
9081 to what it was before. See also the &*map*& and &*reduce*& expansion items.
9082
9083
9084 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9085 .cindex "hash function" "textual"
9086 .cindex "expansion" "textual hash"
9087 This is a textual hashing function, and was the first to be implemented in
9088 early versions of Exim. In current releases, there are other hashing functions
9089 (numeric, MD5, and SHA-1), which are described below.
9090
9091 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
9092 <&'n'&>. If you are using fixed values for these numbers, that is, if
9093 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
9094 use the simpler operator notation that avoids some of the braces:
9095 .code
9096 ${hash_<n>_<m>:<string>}
9097 .endd
9098 The second number is optional (in both notations). If <&'n'&> is greater than
9099 or equal to the length of the string, the expansion item returns the string.
9100 Otherwise it computes a new string of length <&'n'&> by applying a hashing
9101 function to the string. The new string consists of characters taken from the
9102 first <&'m'&> characters of the string
9103 .code
9104 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
9105 .endd
9106 If <&'m'&> is not present the value 26 is used, so that only lower case
9107 letters appear. For example:
9108 .display
9109 &`$hash{3}{monty}}           `&   yields  &`jmg`&
9110 &`$hash{5}{monty}}           `&   yields  &`monty`&
9111 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
9112 .endd
9113
9114 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
9115         &*$h_*&<&'header&~name'&>&*:*&" &&&
9116        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9117         &*$bh_*&<&'header&~name'&>&*:*&" &&&
9118        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9119         &*$rh_*&<&'header&~name'&>&*:*&"
9120 .cindex "expansion" "header insertion"
9121 .vindex "&$header_$&"
9122 .vindex "&$bheader_$&"
9123 .vindex "&$rheader_$&"
9124 .cindex "header lines" "in expansion strings"
9125 .cindex "header lines" "character sets"
9126 .cindex "header lines" "decoding"
9127 Substitute the contents of the named message header line, for example
9128 .code
9129 $header_reply-to:
9130 .endd
9131 The newline that terminates a header line is not included in the expansion, but
9132 internal newlines (caused by splitting the header line over several physical
9133 lines) may be present.
9134
9135 The difference between &%rheader%&, &%bheader%&, and &%header%& is in the way
9136 the data in the header line is interpreted.
9137
9138 .ilist
9139 .cindex "white space" "in header lines"
9140 &%rheader%& gives the original &"raw"& content of the header line, with no
9141 processing at all, and without the removal of leading and trailing white space.
9142
9143 .next
9144 .cindex "base64 encoding" "in header lines"
9145 &%bheader%& removes leading and trailing white space, and then decodes base64
9146 or quoted-printable MIME &"words"& within the header text, but does no
9147 character set translation. If decoding of what looks superficially like a MIME
9148 &"word"& fails, the raw string is returned. If decoding
9149 .cindex "binary zero" "in header line"
9150 produces a binary zero character, it is replaced by a question mark &-- this is
9151 what Exim does for binary zeros that are actually received in header lines.
9152
9153 .next
9154 &%header%& tries to translate the string as decoded by &%bheader%& to a
9155 standard character set. This is an attempt to produce the same string as would
9156 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
9157 returned. Translation is attempted only on operating systems that support the
9158 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
9159 a system Makefile or in &_Local/Makefile_&.
9160 .endlist ilist
9161
9162 In a filter file, the target character set for &%header%& can be specified by a
9163 command of the following form:
9164 .code
9165 headers charset "UTF-8"
9166 .endd
9167 This command affects all references to &$h_$& (or &$header_$&) expansions in
9168 subsequently obeyed filter commands. In the absence of this command, the target
9169 character set in a filter is taken from the setting of the &%headers_charset%&
9170 option in the runtime configuration. The value of this option defaults to the
9171 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
9172 ISO-8859-1.
9173
9174 Header names follow the syntax of RFC 2822, which states that they may contain
9175 any printing characters except space and colon. Consequently, curly brackets
9176 &'do not'& terminate header names, and should not be used to enclose them as
9177 if they were variables. Attempting to do so causes a syntax error.
9178
9179 Only header lines that are common to all copies of a message are visible to
9180 this mechanism. These are the original header lines that are received with the
9181 message, and any that are added by an ACL statement or by a system
9182 filter. Header lines that are added to a particular copy of a message by a
9183 router or transport are not accessible.
9184
9185 For incoming SMTP messages, no header lines are visible in ACLs that are obeyed
9186 before the DATA ACL, because the header structure is not set up until the
9187 message is received. Header lines that are added in a RCPT ACL (for example)
9188 are saved until the message's incoming header lines are available, at which
9189 point they are added. When a DATA ACL is running, however, header lines added
9190 by earlier ACLs are visible.
9191
9192 Upper case and lower case letters are synonymous in header names. If the
9193 following character is white space, the terminating colon may be omitted, but
9194 this is not recommended, because you may then forget it when it is needed. When
9195 white space terminates the header name, it is included in the expanded string.
9196 If the message does not contain the given header, the expansion item is
9197 replaced by an empty string. (See the &%def%& condition in section
9198 &<<SECTexpcond>>& for a means of testing for the existence of a header.)
9199
9200 If there is more than one header with the same name, they are all concatenated
9201 to form the substitution string, up to a maximum length of 64K. Unless
9202 &%rheader%& is being used, leading and trailing white space is removed from
9203 each header before concatenation, and a completely empty header is ignored. A
9204 newline character is then inserted between non-empty headers, but there is no
9205 newline at the very end. For the &%header%& and &%bheader%& expansion, for
9206 those headers that contain lists of addresses, a comma is also inserted at the
9207 junctions between headers. This does not happen for the &%rheader%& expansion.
9208
9209
9210 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
9211 .cindex "expansion" "hmac hashing"
9212 .cindex &%hmac%&
9213 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
9214 shared secret and some text into a message authentication code, as specified in
9215 RFC 2104. This differs from &`${md5:secret_text...}`& or
9216 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
9217 cryptographic hash, allowing for authentication that is not possible with MD5
9218 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
9219 present. For example:
9220 .code
9221 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
9222 .endd
9223 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
9224 produces:
9225 .code
9226 dd97e3ba5d1a61b5006108f8c8252953
9227 .endd
9228 As an example of how this might be used, you might put in the main part of
9229 an Exim configuration:
9230 .code
9231 SPAMSCAN_SECRET=cohgheeLei2thahw
9232 .endd
9233 In a router or a transport you could then have:
9234 .code
9235 headers_add = \
9236   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
9237   ${hmac{md5}{SPAMSCAN_SECRET}\
9238   {${primary_hostname},${message_exim_id},$h_message-id:}}
9239 .endd
9240 Then given a message, you can check where it was scanned by looking at the
9241 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
9242 this header line is authentic by recomputing the authentication code from the
9243 host name, message ID and the &'Message-id:'& header line. This can be done
9244 using Exim's &%-be%& option, or by other means, for example by using the
9245 &'hmac_md5_hex()'& function in Perl.
9246
9247
9248 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9249 .cindex "expansion" "conditional"
9250 .cindex "&%if%&, expansion item"
9251 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
9252 item; otherwise <&'string2'&> is used. The available conditions are described
9253 in section &<<SECTexpcond>>& below. For example:
9254 .code
9255 ${if eq {$local_part}{postmaster} {yes}{no} }
9256 .endd
9257 The second string need not be present; if it is not and the condition is not
9258 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
9259 be present instead of the second string (without any curly brackets). In this
9260 case, the expansion is forced to fail if the condition is not true (see section
9261 &<<SECTforexpfai>>&).
9262
9263 If both strings are omitted, the result is the string &`true`& if the condition
9264 is true, and the empty string if the condition is false. This makes it less
9265 cumbersome to write custom ACL and router conditions. For example, instead of
9266 .code
9267 condition = ${if >{$acl_m4}{3}{true}{false}}
9268 .endd
9269 you can use
9270 .code
9271 condition = ${if >{$acl_m4}{3}}
9272 .endd
9273
9274 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9275 .cindex "expansion" "string truncation"
9276 .cindex "&%length%& expansion item"
9277 The &%length%& item is used to extract the initial portion of a string. Both
9278 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
9279 you are using a fixed value for the number, that is, if <&'string1'&> does not
9280 change when expanded, you can use the simpler operator notation that avoids
9281 some of the braces:
9282 .code
9283 ${length_<n>:<string>}
9284 .endd
9285 The result of this item is either the first <&'n'&> characters or the whole
9286 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
9287 &%strlen%&, which gives the length of a string.
9288
9289
9290 .vitem "&*${listextract{*&<&'number'&>&*}&&&
9291         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9292 .cindex "expansion" "extracting list elements by number"
9293 .cindex "&%listextract%&" "extract list elements by number"
9294 .cindex "list" "extracting elements by number"
9295 The <&'number'&> argument must consist entirely of decimal digits,
9296 apart from an optional leading minus,
9297 and leading and trailing white space (which is ignored).
9298
9299 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9300 default, but the separator can be changed in the usual way.
9301
9302 The first field of the list is numbered one.
9303 If the number is negative, the fields are
9304 counted from the end of the list, with the rightmost one numbered -1.
9305 The numbered element of the list is extracted and placed in &$value$&,
9306 then <&'string2'&> is expanded as the result.
9307
9308 If the modulus of the
9309 number is zero or greater than the number of fields in the string,
9310 the result is the expansion of <&'string3'&>.
9311
9312 For example:
9313 .code
9314 ${listextract{2}{x:42:99}}
9315 .endd
9316 yields &"42"&, and
9317 .code
9318 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
9319 .endd
9320 yields &"result: 99"&.
9321
9322 If {<&'string3'&>} is omitted, an empty string is used for string3.
9323 If {<&'string2'&>} is also omitted, the value that was
9324 extracted is used.
9325 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
9326
9327
9328 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
9329         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9330 This is the first of one of two different types of lookup item, which are both
9331 described in the next item.
9332
9333 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
9334         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9335 .cindex "expansion" "lookup in"
9336 .cindex "file" "lookups"
9337 .cindex "lookup" "in expanded string"
9338 The two forms of lookup item specify data lookups in files and databases, as
9339 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
9340 lookups, and the second is used for query-style lookups. The <&'key'&>,
9341 <&'file'&>, and <&'query'&> strings are expanded before use.
9342
9343 If there is any white space in a lookup item which is part of a filter command,
9344 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
9345 other place where white space is significant, the lookup item must be enclosed
9346 in double quotes. The use of data lookups in users' filter files may be locked
9347 out by the system administrator.
9348
9349 .vindex "&$value$&"
9350 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
9351 During its expansion, the variable &$value$& contains the data returned by the
9352 lookup. Afterwards it reverts to the value it had previously (at the outer
9353 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
9354 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
9355 string on failure. If <&'string2'&> is provided, it can itself be a nested
9356 lookup, thus providing a mechanism for looking up a default value when the
9357 original lookup fails.
9358
9359 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
9360 data for the outer lookup while the parameters of the second lookup are
9361 expanded, and also while <&'string2'&> of the second lookup is expanded, should
9362 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
9363 appear, and in this case, if the lookup fails, the entire expansion is forced
9364 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
9365 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
9366 successful lookup, and nothing in the case of failure.
9367
9368 For single-key lookups, the string &"partial"& is permitted to precede the
9369 search type in order to do partial matching, and * or *@ may follow a search
9370 type to request default lookups if the key does not match (see sections
9371 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
9372
9373 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
9374 If a partial search is used, the variables &$1$& and &$2$& contain the wild
9375 and non-wild parts of the key during the expansion of the replacement text.
9376 They return to their previous values at the end of the lookup item.
9377
9378 This example looks up the postmaster alias in the conventional alias file:
9379 .code
9380 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
9381 .endd
9382 This example uses NIS+ to look up the full name of the user corresponding to
9383 the local part of an address, forcing the expansion to fail if it is not found:
9384 .code
9385 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
9386   {$value}fail}
9387 .endd
9388
9389
9390 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9391 .cindex "expansion" "list creation"
9392 .vindex "&$item$&"
9393 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9394 default, but the separator can be changed in the usual way. For each item
9395 in this list, its value is place in &$item$&, and then <&'string2'&> is
9396 expanded and added to the output as an item in a new list. The separator used
9397 for the output list is the same as the one used for the input, but a separator
9398 setting is not included in the output. For example:
9399 .code
9400 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
9401 .endd
9402 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
9403 value of &$item$& is restored to what it was before. See also the &*filter*&
9404 and &*reduce*& expansion items.
9405
9406 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9407 .cindex "expansion" "numeric hash"
9408 .cindex "hash function" "numeric"
9409 The three strings are expanded; the first two must yield numbers. Call them
9410 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9411 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9412 can use the simpler operator notation that avoids some of the braces:
9413 .code
9414 ${nhash_<n>_<m>:<string>}
9415 .endd
9416 The second number is optional (in both notations). If there is only one number,
9417 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
9418 processed by a div/mod hash function that returns two numbers, separated by a
9419 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
9420 example,
9421 .code
9422 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
9423 .endd
9424 returns the string &"6/33"&.
9425
9426
9427
9428 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
9429 .cindex "Perl" "use in expanded string"
9430 .cindex "expansion" "calling Perl from"
9431 This item is available only if Exim has been built to include an embedded Perl
9432 interpreter. The subroutine name and the arguments are first separately
9433 expanded, and then the Perl subroutine is called with those arguments. No
9434 additional arguments need be given; the maximum number permitted, including the
9435 name of the subroutine, is nine.
9436
9437 The return value of the subroutine is inserted into the expanded string, unless
9438 the return value is &%undef%&. In that case, the expansion fails in the same
9439 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
9440 Whatever you return is evaluated in a scalar context. For example, if you
9441 return the name of a Perl vector, the return value is the size of the vector,
9442 not its contents.
9443
9444 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
9445 with the error message that was passed to &%die%&. More details of the embedded
9446 Perl facility are given in chapter &<<CHAPperl>>&.
9447
9448 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
9449 out the use of this expansion item in filter files.
9450
9451
9452 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
9453 .cindex "&%prvs%& expansion item"
9454 The first argument is a complete email address and the second is secret
9455 keystring. The third argument, specifying a key number, is optional. If absent,
9456 it defaults to 0. The result of the expansion is a prvs-signed email address,
9457 to be typically used with the &%return_path%& option on an &(smtp)& transport
9458 as part of a bounce address tag validation (BATV) scheme. For more discussion
9459 and an example, see section &<<SECTverifyPRVS>>&.
9460
9461 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
9462         {*&<&'string'&>&*}}*&"
9463 .cindex "&%prvscheck%& expansion item"
9464 This expansion item is the complement of the &%prvs%& item. It is used for
9465 checking prvs-signed addresses. If the expansion of the first argument does not
9466 yield a syntactically valid prvs-signed address, the whole item expands to the
9467 empty string. When the first argument does expand to a syntactically valid
9468 prvs-signed address, the second argument is expanded, with the prvs-decoded
9469 version of the address and the key number extracted from the address in the
9470 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
9471
9472 These two variables can be used in the expansion of the second argument to
9473 retrieve the secret. The validity of the prvs-signed address is then checked
9474 against the secret. The result is stored in the variable &$prvscheck_result$&,
9475 which is empty for failure or &"1"& for success.
9476
9477 The third argument is optional; if it is missing, it defaults to an empty
9478 string. This argument is now expanded. If the result is an empty string, the
9479 result of the expansion is the decoded version of the address. This is the case
9480 whether or not the signature was valid. Otherwise, the result of the expansion
9481 is the expansion of the third argument.
9482
9483 All three variables can be used in the expansion of the third argument.
9484 However, once the expansion is complete, only &$prvscheck_result$& remains set.
9485 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
9486
9487 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
9488 .cindex "expansion" "inserting an entire file"
9489 .cindex "file" "inserting into expansion"
9490 .cindex "&%readfile%& expansion item"
9491 The file name and end-of-line string are first expanded separately. The file is
9492 then read, and its contents replace the entire item. All newline characters in
9493 the file are replaced by the end-of-line string if it is present. Otherwise,
9494 newlines are left in the string.
9495 String expansion is not applied to the contents of the file. If you want this,
9496 you must wrap the item in an &%expand%& operator. If the file cannot be read,
9497 the string expansion fails.
9498
9499 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
9500 locks out the use of this expansion item in filter files.
9501
9502
9503
9504 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
9505         {*&<&'timeout'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
9506 .cindex "expansion" "inserting from a socket"
9507 .cindex "socket, use of in expansion"
9508 .cindex "&%readsocket%& expansion item"
9509 This item inserts data from a Unix domain or TCP socket into the expanded
9510 string. The minimal way of using it uses just two arguments, as in these
9511 examples:
9512 .code
9513 ${readsocket{/socket/name}{request string}}
9514 ${readsocket{inet:some.host:1234}{request string}}
9515 .endd
9516 For a Unix domain socket, the first substring must be the path to the socket.
9517 For an Internet socket, the first substring must contain &`inet:`& followed by
9518 a host name or IP address, followed by a colon and a port, which can be a
9519 number or the name of a TCP port in &_/etc/services_&. An IP address may
9520 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
9521 example:
9522 .code
9523 ${readsocket{inet:[::1]:1234}{request string}}
9524 .endd
9525 Only a single host name may be given, but if looking it up yields more than
9526 one IP address, they are each tried in turn until a connection is made. For
9527 both kinds of socket, Exim makes a connection, writes the request string
9528 (unless it is an empty string) and reads from the socket until an end-of-file
9529 is read. A timeout of 5 seconds is applied. Additional, optional arguments
9530 extend what can be done. Firstly, you can vary the timeout. For example:
9531 .code
9532 ${readsocket{/socket/name}{request string}{3s}}
9533 .endd
9534 A fourth argument allows you to change any newlines that are in the data
9535 that is read, in the same way as for &%readfile%& (see above). This example
9536 turns them into spaces:
9537 .code
9538 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
9539 .endd
9540 As with all expansions, the substrings are expanded before the processing
9541 happens. Errors in these sub-expansions cause the expansion to fail. In
9542 addition, the following errors can occur:
9543
9544 .ilist
9545 Failure to create a socket file descriptor;
9546 .next
9547 Failure to connect the socket;
9548 .next
9549 Failure to write the request string;
9550 .next
9551 Timeout on reading from the socket.
9552 .endlist
9553
9554 By default, any of these errors causes the expansion to fail. However, if
9555 you supply a fifth substring, it is expanded and used when any of the above
9556 errors occurs. For example:
9557 .code
9558 ${readsocket{/socket/name}{request string}{3s}{\n}\
9559   {socket failure}}
9560 .endd
9561 You can test for the existence of a Unix domain socket by wrapping this
9562 expansion in &`${if exists`&, but there is a race condition between that test
9563 and the actual opening of the socket, so it is safer to use the fifth argument
9564 if you want to be absolutely sure of avoiding an expansion error for a
9565 non-existent Unix domain socket, or a failure to connect to an Internet socket.
9566
9567 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
9568 locks out the use of this expansion item in filter files.
9569
9570
9571 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9572 .cindex "expansion" "reducing a list to a scalar"
9573 .cindex "list" "reducing to a scalar"
9574 .vindex "&$value$&"
9575 .vindex "&$item$&"
9576 This operation reduces a list to a single, scalar string. After expansion,
9577 <&'string1'&> is interpreted as a list, colon-separated by default, but the
9578 separator can be changed in the usual way. Then <&'string2'&> is expanded and
9579 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
9580 list is assigned to &$item$& in turn, and <&'string3'&> is expanded for each of
9581 them. The result of that expansion is assigned to &$value$& before the next
9582 iteration. When the end of the list is reached, the final value of &$value$& is
9583 added to the expansion output. The &*reduce*& expansion item can be used in a
9584 number of ways. For example, to add up a list of numbers:
9585 .code
9586 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
9587 .endd
9588 The result of that expansion would be &`6`&. The maximum of a list of numbers
9589 can be found:
9590 .code
9591 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
9592 .endd
9593 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
9594 restored to what they were before. See also the &*filter*& and &*map*&
9595 expansion items.
9596
9597 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
9598 This item inserts &"raw"& header lines. It is described with the &%header%&
9599 expansion item above.
9600
9601 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
9602         {*&<&'string2'&>&*}}*&"
9603 .cindex "expansion" "running a command"
9604 .cindex "&%run%& expansion item"
9605 The command and its arguments are first expanded as one string. The string is
9606 split apart into individual arguments by spaces, and then the command is run
9607 in a separate process, but under the same uid and gid.  As in other command
9608 executions from Exim, a shell is not used by default. If the command requires
9609 a shell, you must explicitly code it.
9610
9611 Since the arguments are split by spaces, when there is a variable expansion
9612 which has an empty result, it will cause the situation that the argument will
9613 simply be omitted when the program is actually executed by Exim. If the
9614 script/program requires a specific number of arguments and the expanded
9615 variable could possibly result in this empty expansion, the variable must be
9616 quoted. This is more difficult if the expanded variable itself could result
9617 in a string containing quotes, because it would interfere with the quotes
9618 around the command arguments. A possible guard against this is to wrap the
9619 variable in the &%sg%& operator to change any quote marks to some other
9620 character.
9621
9622 The standard input for the command exists, but is empty. The standard output
9623 and standard error are set to the same file descriptor.
9624 .cindex "return code" "from &%run%& expansion"
9625 .vindex "&$value$&"
9626 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
9627 and replaces the entire item; during this expansion, the standard output/error
9628 from the command is in the variable &$value$&. If the command fails,
9629 <&'string2'&>, if present, is expanded and used. Once again, during the
9630 expansion, the standard output/error from the command is in the variable
9631 &$value$&.
9632
9633 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
9634 can be the word &"fail"& (not in braces) to force expansion failure if the
9635 command does not succeed. If both strings are omitted, the result is contents
9636 of the standard output/error on success, and nothing on failure.
9637
9638 .vindex "&$run_in_acl$&"
9639 The standard output/error of the command is put in the variable &$value$&.
9640 In this ACL example, the output of a command is logged for the admin to
9641 troubleshoot:
9642 .code
9643 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
9644       log_message  = Output of id: $value
9645 .endd
9646 If the command requires shell idioms, such as the > redirect operator, the
9647 shell must be invoked directly, such as with:
9648 .code
9649 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
9650 .endd
9651
9652 .vindex "&$runrc$&"
9653 The return code from the command is put in the variable &$runrc$&, and this
9654 remains set afterwards, so in a filter file you can do things like this:
9655 .code
9656 if "${run{x y z}{}}$runrc" is 1 then ...
9657   elif $runrc is 2 then ...
9658   ...
9659 endif
9660 .endd
9661 If execution of the command fails (for example, the command does not exist),
9662 the return code is 127 &-- the same code that shells use for non-existent
9663 commands.
9664
9665 &*Warning*&: In a router or transport, you cannot assume the order in which
9666 option values are expanded, except for those preconditions whose order of
9667 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
9668 by the expansion of one option, and use it in another.
9669
9670 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
9671 out the use of this expansion item in filter files.
9672
9673
9674 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
9675 .cindex "expansion" "string substitution"
9676 .cindex "&%sg%& expansion item"
9677 This item works like Perl's substitution operator (s) with the global (/g)
9678 option; hence its name. However, unlike the Perl equivalent, Exim does not
9679 modify the subject string; instead it returns the modified string for insertion
9680 into the overall expansion. The item takes three arguments: the subject string,
9681 a regular expression, and a substitution string. For example:
9682 .code
9683 ${sg{abcdefabcdef}{abc}{xyz}}
9684 .endd
9685 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
9686 if any $ or \ characters are required in the regular expression or in the
9687 substitution string, they have to be escaped. For example:
9688 .code
9689 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
9690 .endd
9691 yields &"defabc"&, and
9692 .code
9693 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
9694 .endd
9695 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
9696 the regular expression from string expansion.
9697
9698
9699
9700 .vitem &*${sort{*&<&'string'&>&*}{*&<&'comparator'&>&*}{*&<&'extractor'&>&*}}*&
9701 .cindex sorting a list
9702 .cindex list sorting
9703 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9704 default, but the separator can be changed in the usual way.
9705 The <&'comparator'&> argument is interpreted as the operator
9706 of a two-argument expansion condition.
9707 The numeric operators plus ge, gt, le, lt (and ~i variants) are supported.
9708 The comparison should return true when applied to two values
9709 if the first value should sort before the second value.
9710 The <&'extractor'&> expansion is applied repeatedly to elements of the list,
9711 the element being placed in &$item$&,
9712 to give values for comparison.
9713
9714 The item result is a sorted list,
9715 with the original list separator,
9716 of the list elements (in full) of the original.
9717
9718 Examples:
9719 .code
9720 ${sort{3:2:1:4}{<}{$item}}
9721 .endd
9722 sorts a list of numbers, and
9723 .code
9724 ${sort {$lookup dnsdb{>:,,mx=example.com}} {<} {${listextract{1}{<,$item}}}}
9725 .endd
9726 will sort an MX lookup into priority order.
9727
9728
9729 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9730 .cindex "&%substr%& expansion item"
9731 .cindex "substring extraction"
9732 .cindex "expansion" "substring extraction"
9733 The three strings are expanded; the first two must yield numbers. Call them
9734 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9735 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9736 can use the simpler operator notation that avoids some of the braces:
9737 .code
9738 ${substr_<n>_<m>:<string>}
9739 .endd
9740 The second number is optional (in both notations).
9741 If it is absent in the simpler format, the preceding underscore must also be
9742 omitted.
9743
9744 The &%substr%& item can be used to extract more general substrings than
9745 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
9746 length required. For example
9747 .code
9748 ${substr{3}{2}{$local_part}}
9749 .endd
9750 If the starting offset is greater than the string length the result is the
9751 null string; if the length plus starting offset is greater than the string
9752 length, the result is the right-hand part of the string, starting from the
9753 given offset. The first character in the string has offset zero.
9754
9755 The &%substr%& expansion item can take negative offset values to count
9756 from the right-hand end of its operand. The last character is offset -1, the
9757 second-last is offset -2, and so on. Thus, for example,
9758 .code
9759 ${substr{-5}{2}{1234567}}
9760 .endd
9761 yields &"34"&. If the absolute value of a negative offset is greater than the
9762 length of the string, the substring starts at the beginning of the string, and
9763 the length is reduced by the amount of overshoot. Thus, for example,
9764 .code
9765 ${substr{-5}{2}{12}}
9766 .endd
9767 yields an empty string, but
9768 .code
9769 ${substr{-3}{2}{12}}
9770 .endd
9771 yields &"1"&.
9772
9773 When the second number is omitted from &%substr%&, the remainder of the string
9774 is taken if the offset is positive. If it is negative, all characters in the
9775 string preceding the offset point are taken. For example, an offset of -1 and
9776 no length, as in these semantically identical examples:
9777 .code
9778 ${substr_-1:abcde}
9779 ${substr{-1}{abcde}}
9780 .endd
9781 yields all but the last character of the string, that is, &"abcd"&.
9782
9783
9784
9785 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
9786         {*&<&'replacements'&>&*}}*&"
9787 .cindex "expansion" "character translation"
9788 .cindex "&%tr%& expansion item"
9789 This item does single-character translation on its subject string. The second
9790 argument is a list of characters to be translated in the subject string. Each
9791 matching character is replaced by the corresponding character from the
9792 replacement list. For example
9793 .code
9794 ${tr{abcdea}{ac}{13}}
9795 .endd
9796 yields &`1b3de1`&. If there are duplicates in the second character string, the
9797 last occurrence is used. If the third string is shorter than the second, its
9798 last character is replicated. However, if it is empty, no translation takes
9799 place.
9800 .endlist
9801
9802
9803
9804 .section "Expansion operators" "SECTexpop"
9805 .cindex "expansion" "operators"
9806 For expansion items that perform transformations on a single argument string,
9807 the &"operator"& notation is used because it is simpler and uses fewer braces.
9808 The substring is first expanded before the operation is applied to it. The
9809 following operations can be performed:
9810
9811 .vlist
9812 .vitem &*${address:*&<&'string'&>&*}*&
9813 .cindex "expansion" "RFC 2822 address handling"
9814 .cindex "&%address%& expansion item"
9815 The string is interpreted as an RFC 2822 address, as it might appear in a
9816 header line, and the effective address is extracted from it. If the string does
9817 not parse successfully, the result is empty.
9818
9819
9820 .vitem &*${addresses:*&<&'string'&>&*}*&
9821 .cindex "expansion" "RFC 2822 address handling"
9822 .cindex "&%addresses%& expansion item"
9823 The string (after expansion) is interpreted as a list of addresses in RFC
9824 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
9825 operative address (&'local-part@domain'&) is extracted from each item, and the
9826 result of the expansion is a colon-separated list, with appropriate
9827 doubling of colons should any happen to be present in the email addresses.
9828 Syntactically invalid RFC2822 address items are omitted from the output.
9829
9830 It is possible to specify a character other than colon for the output
9831 separator by starting the string with > followed by the new separator
9832 character. For example:
9833 .code
9834 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
9835 .endd
9836 expands to &`ceo@up.stairs&&sec@base.ment`&. Compare the &*address*& (singular)
9837 expansion item, which extracts the working address from a single RFC2822
9838 address. See the &*filter*&, &*map*&, and &*reduce*& items for ways of
9839 processing lists.
9840
9841 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
9842 a strict interpretation of header line formatting.  Exim parses the bare,
9843 unquoted portion of an email address and if it finds a comma, treats it as an
9844 email address seperator. For the example header line:
9845 .code
9846 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
9847 .endd
9848 The first example below demonstrates that Q-encoded email addresses are parsed
9849 properly if it is given the raw header (in this example, &`$rheader_from:`&).
9850 It does not see the comma because it's still encoded as "=2C".  The second
9851 example below is passed the contents of &`$header_from:`&, meaning it gets
9852 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
9853 The third example shows that the presence of a comma is skipped when it is
9854 quoted.
9855 .code
9856 # exim -be '${addresses:From: \
9857 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
9858 user@example.com
9859 # exim -be '${addresses:From: Last, First <user@example.com>}'
9860 Last:user@example.com
9861 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
9862 user@example.com
9863 .endd
9864
9865 .vitem &*${base62:*&<&'digits'&>&*}*&
9866 .cindex "&%base62%& expansion item"
9867 .cindex "expansion" "conversion to base 62"
9868 The string must consist entirely of decimal digits. The number is converted to
9869 base 62 and output as a string of six characters, including leading zeros. In
9870 the few operating environments where Exim uses base 36 instead of base 62 for
9871 its message identifiers (because those systems do not have case-sensitive file
9872 names), base 36 is used by this operator, despite its name. &*Note*&: Just to
9873 be absolutely clear: this is &'not'& base64 encoding.
9874
9875 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
9876 .cindex "&%base62d%& expansion item"
9877 .cindex "expansion" "conversion to base 62"
9878 The string must consist entirely of base-62 digits, or, in operating
9879 environments where Exim uses base 36 instead of base 62 for its message
9880 identifiers, base-36 digits. The number is converted to decimal and output as a
9881 string.
9882
9883
9884 .vitem &*${domain:*&<&'string'&>&*}*&
9885 .cindex "domain" "extraction"
9886 .cindex "expansion" "domain extraction"
9887 The string is interpreted as an RFC 2822 address and the domain is extracted
9888 from it. If the string does not parse successfully, the result is empty.
9889
9890
9891 .vitem &*${escape:*&<&'string'&>&*}*&
9892 .cindex "expansion" "escaping non-printing characters"
9893 .cindex "&%escape%& expansion item"
9894 If the string contains any non-printing characters, they are converted to
9895 escape sequences starting with a backslash. Whether characters with the most
9896 significant bit set (so-called &"8-bit characters"&) count as printing or not
9897 is controlled by the &%print_topbitchars%& option.
9898
9899
9900 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
9901 .cindex "expansion" "expression evaluation"
9902 .cindex "expansion" "arithmetic expression"
9903 .cindex "&%eval%& expansion item"
9904 These items supports simple arithmetic and bitwise logical operations in
9905 expansion strings. The string (after expansion) must be a conventional
9906 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
9907 logical operators, and parentheses. All operations are carried out using
9908 integer arithmetic. The operator priorities are as follows (the same as in the
9909 C programming language):
9910 .table2 70pt 300pt
9911 .irow &'highest:'& "not (~), negate (-)"
9912 .irow ""   "multiply (*), divide (/), remainder (%)"
9913 .irow ""   "plus (+), minus (-)"
9914 .irow ""   "shift-left (<<), shift-right (>>)"
9915 .irow ""   "and (&&)"
9916 .irow ""   "xor (^)"
9917 .irow &'lowest:'&  "or (|)"
9918 .endtable
9919 Binary operators with the same priority are evaluated from left to right. White
9920 space is permitted before or after operators.
9921
9922 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
9923 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
9924 decimal, even if they start with a leading zero; hexadecimal numbers are not
9925 permitted. This can be useful when processing numbers extracted from dates or
9926 times, which often do have leading zeros.
9927
9928 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
9929 or 1024*1024*1024,
9930 respectively. Negative numbers are supported. The result of the computation is
9931 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
9932
9933 .display
9934 &`${eval:1+1}            `&  yields 2
9935 &`${eval:1+2*3}          `&  yields 7
9936 &`${eval:(1+2)*3}        `&  yields 9
9937 &`${eval:2+42%5}         `&  yields 4
9938 &`${eval:0xc&amp;5}          `&  yields 4
9939 &`${eval:0xc|5}          `&  yields 13
9940 &`${eval:0xc^5}          `&  yields 9
9941 &`${eval:0xc>>1}         `&  yields 6
9942 &`${eval:0xc<<1}         `&  yields 24
9943 &`${eval:~255&amp;0x1234}    `&  yields 4608
9944 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
9945 .endd
9946
9947 As a more realistic example, in an ACL you might have
9948 .code
9949 deny   message = Too many bad recipients
9950        condition =                    \
9951          ${if and {                   \
9952            {>{$rcpt_count}{10}}       \
9953            {                          \
9954            <                          \
9955              {$recipients_count}      \
9956              {${eval:$rcpt_count/2}}  \
9957            }                          \
9958          }{yes}{no}}
9959 .endd
9960 The condition is true if there have been more than 10 RCPT commands and
9961 fewer than half of them have resulted in a valid recipient.
9962
9963
9964 .vitem &*${expand:*&<&'string'&>&*}*&
9965 .cindex "expansion" "re-expansion of substring"
9966 The &%expand%& operator causes a string to be expanded for a second time. For
9967 example,
9968 .code
9969 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
9970 .endd
9971 first looks up a string in a file while expanding the operand for &%expand%&,
9972 and then re-expands what it has found.
9973
9974
9975 .vitem &*${from_utf8:*&<&'string'&>&*}*&
9976 .cindex "Unicode"
9977 .cindex "UTF-8" "conversion from"
9978 .cindex "expansion" "UTF-8 conversion"
9979 .cindex "&%from_utf8%& expansion item"
9980 The world is slowly moving towards Unicode, although there are no standards for
9981 email yet. However, other applications (including some databases) are starting
9982 to store data in Unicode, using UTF-8 encoding. This operator converts from a
9983 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
9984 converted to underscores. The input must be a valid UTF-8 string. If it is not,
9985 the result is an undefined sequence of bytes.
9986
9987 Unicode code points with values less than 256 are compatible with ASCII and
9988 ISO-8859-1 (also known as Latin-1).
9989 For example, character 169 is the copyright symbol in both cases, though the
9990 way it is encoded is different. In UTF-8, more than one byte is needed for
9991 characters with code values greater than 127, whereas ISO-8859-1 is a
9992 single-byte encoding (but thereby limited to 256 characters). This makes
9993 translation from UTF-8 to ISO-8859-1 straightforward.
9994
9995
9996 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
9997 .cindex "hash function" "textual"
9998 .cindex "expansion" "textual hash"
9999 The &%hash%& operator is a simpler interface to the hashing function that can
10000 be used when the two parameters are fixed numbers (as opposed to strings that
10001 change when expanded). The effect is the same as
10002 .code
10003 ${hash{<n>}{<m>}{<string>}}
10004 .endd
10005 See the description of the general &%hash%& item above for details. The
10006 abbreviation &%h%& can be used when &%hash%& is used as an operator.
10007
10008
10009
10010 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
10011 .cindex "base64 encoding" "conversion from hex"
10012 .cindex "expansion" "hex to base64"
10013 .cindex "&%hex2b64%& expansion item"
10014 This operator converts a hex string into one that is base64 encoded. This can
10015 be useful for processing the output of the MD5 and SHA-1 hashing functions.
10016
10017
10018
10019 .vitem &*${hexquote:*&<&'string'&>&*}*&
10020 .cindex "quoting" "hex-encoded unprintable characters"
10021 .cindex "&%hexquote%& expansion item"
10022 This operator converts non-printable characters in a string into a hex
10023 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
10024 as is, and other byte values are converted to &`\xNN`&, for example a
10025 byte value 127 is converted to &`\x7f`&.
10026
10027
10028 .vitem &*${lc:*&<&'string'&>&*}*&
10029 .cindex "case forcing in strings"
10030 .cindex "string" "case forcing"
10031 .cindex "lower casing"
10032 .cindex "expansion" "case forcing"
10033 .cindex "&%lc%& expansion item"
10034 This forces the letters in the string into lower-case, for example:
10035 .code
10036 ${lc:$local_part}
10037 .endd
10038
10039 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
10040 .cindex "expansion" "string truncation"
10041 .cindex "&%length%& expansion item"
10042 The &%length%& operator is a simpler interface to the &%length%& function that
10043 can be used when the parameter is a fixed number (as opposed to a string that
10044 changes when expanded). The effect is the same as
10045 .code
10046 ${length{<number>}{<string>}}
10047 .endd
10048 See the description of the general &%length%& item above for details. Note that
10049 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
10050 when &%length%& is used as an operator.
10051
10052
10053 .vitem &*${listcount:*&<&'string'&>&*}*&
10054 .cindex "expansion" "list item count"
10055 .cindex "list" "item count"
10056 .cindex "list" "count of items"
10057 .cindex "&%listcount%& expansion item"
10058 The string is interpreted as a list and the number of items is returned.
10059
10060
10061 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
10062 .cindex "expansion" "named list"
10063 .cindex "&%listnamed%& expansion item"
10064 The name is interpreted as a named list and the content of the list is returned,
10065 expanding any referenced lists, re-quoting as needed for colon-separation.
10066 If the optional type is given it must be one of "a", "d", "h" or "l"
10067 and selects address-, domain-, host- or localpart- lists to search among respectively.
10068 Otherwise all types are searched in an undefined order and the first
10069 matching list is returned.
10070
10071
10072 .vitem &*${local_part:*&<&'string'&>&*}*&
10073 .cindex "expansion" "local part extraction"
10074 .cindex "&%local_part%& expansion item"
10075 The string is interpreted as an RFC 2822 address and the local part is
10076 extracted from it. If the string does not parse successfully, the result is
10077 empty.
10078
10079
10080 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
10081 .cindex "masked IP address"
10082 .cindex "IP address" "masking"
10083 .cindex "CIDR notation"
10084 .cindex "expansion" "IP address masking"
10085 .cindex "&%mask%& expansion item"
10086 If the form of the string to be operated on is not an IP address followed by a
10087 slash and an integer (that is, a network address in CIDR notation), the
10088 expansion fails. Otherwise, this operator converts the IP address to binary,
10089 masks off the least significant bits according to the bit count, and converts
10090 the result back to text, with mask appended. For example,
10091 .code
10092 ${mask:10.111.131.206/28}
10093 .endd
10094 returns the string &"10.111.131.192/28"&. Since this operation is expected to
10095 be mostly used for looking up masked addresses in files, the result for an IPv6
10096 address uses dots to separate components instead of colons, because colon
10097 terminates a key string in lsearch files. So, for example,
10098 .code
10099 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
10100 .endd
10101 returns the string
10102 .code
10103 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
10104 .endd
10105 Letters in IPv6 addresses are always output in lower case.
10106
10107
10108 .vitem &*${md5:*&<&'string'&>&*}*&
10109 .cindex "MD5 hash"
10110 .cindex "expansion" "MD5 hash"
10111 .cindex "certificate fingerprint"
10112 .cindex "&%md5%& expansion item"
10113 The &%md5%& operator computes the MD5 hash value of the string, and returns it
10114 as a 32-digit hexadecimal number, in which any letters are in lower case.
10115
10116
10117 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10118 .cindex "expansion" "numeric hash"
10119 .cindex "hash function" "numeric"
10120 The &%nhash%& operator is a simpler interface to the numeric hashing function
10121 that can be used when the two parameters are fixed numbers (as opposed to
10122 strings that change when expanded). The effect is the same as
10123 .code
10124 ${nhash{<n>}{<m>}{<string>}}
10125 .endd
10126 See the description of the general &%nhash%& item above for details.
10127
10128
10129 .vitem &*${quote:*&<&'string'&>&*}*&
10130 .cindex "quoting" "in string expansions"
10131 .cindex "expansion" "quoting"
10132 .cindex "&%quote%& expansion item"
10133 The &%quote%& operator puts its argument into double quotes if it
10134 is an empty string or
10135 contains anything other than letters, digits, underscores, dots, and hyphens.
10136 Any occurrences of double quotes and backslashes are escaped with a backslash.
10137 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
10138 respectively For example,
10139 .code
10140 ${quote:ab"*"cd}
10141 .endd
10142 becomes
10143 .code
10144 "ab\"*\"cd"
10145 .endd
10146 The place where this is useful is when the argument is a substitution from a
10147 variable or a message header.
10148
10149 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
10150 .cindex "&%quote_local_part%& expansion item"
10151 This operator is like &%quote%&, except that it quotes the string only if
10152 required to do so by the rules of RFC 2822 for quoting local parts. For
10153 example, a plus sign would not cause quoting (but it would for &%quote%&).
10154 If you are creating a new email address from the contents of &$local_part$&
10155 (or any other unknown data), you should always use this operator.
10156
10157
10158 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
10159 .cindex "quoting" "lookup-specific"
10160 This operator applies lookup-specific quoting rules to the string. Each
10161 query-style lookup type has its own quoting rules which are described with
10162 the lookups in chapter &<<CHAPfdlookup>>&. For example,
10163 .code
10164 ${quote_ldap:two * two}
10165 .endd
10166 returns
10167 .code
10168 two%20%5C2A%20two
10169 .endd
10170 For single-key lookup types, no quoting is ever necessary and this operator
10171 yields an unchanged string.
10172
10173
10174 .vitem &*${randint:*&<&'n'&>&*}*&
10175 .cindex "random number"
10176 This operator returns a somewhat random number which is less than the
10177 supplied number and is at least 0.  The quality of this randomness depends
10178 on how Exim was built; the values are not suitable for keying material.
10179 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
10180 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
10181 for versions of GnuTLS with that function.
10182 Otherwise, the implementation may be arc4random(), random() seeded by
10183 srandomdev() or srandom(), or a custom implementation even weaker than
10184 random().
10185
10186
10187 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
10188 .cindex "expansion" "IP address"
10189 This operator reverses an IP address; for IPv4 addresses, the result is in
10190 dotted-quad decimal form, while for IPv6 addreses the result is in
10191 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
10192 for DNS.  For example,
10193 .code
10194 ${reverse_ip:192.0.2.4}
10195 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
10196 .endd
10197 returns
10198 .code
10199 4.2.0.192
10200 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
10201 .endd
10202
10203
10204 .vitem &*${rfc2047:*&<&'string'&>&*}*&
10205 .cindex "expansion" "RFC 2047"
10206 .cindex "RFC 2047" "expansion operator"
10207 .cindex "&%rfc2047%& expansion item"
10208 This operator encodes text according to the rules of RFC 2047. This is an
10209 encoding that is used in header lines to encode non-ASCII characters. It is
10210 assumed that the input string is in the encoding specified by the
10211 &%headers_charset%& option, which defaults to ISO-8859-1. If the string
10212 contains only characters in the range 33&--126, and no instances of the
10213 characters
10214 .code
10215 ? = ( ) < > @ , ; : \ " . [ ] _
10216 .endd
10217 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
10218 string, using as many &"encoded words"& as necessary to encode all the
10219 characters.
10220
10221
10222 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
10223 .cindex "expansion" "RFC 2047"
10224 .cindex "RFC 2047" "decoding"
10225 .cindex "&%rfc2047d%& expansion item"
10226 This operator decodes strings that are encoded as per RFC 2047. Binary zero
10227 bytes are replaced by question marks. Characters are converted into the
10228 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
10229 not recognized unless &%check_rfc2047_length%& is set false.
10230
10231 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
10232 access a header line, RFC 2047 decoding is done automatically. You do not need
10233 to use this operator as well.
10234
10235
10236
10237 .vitem &*${rxquote:*&<&'string'&>&*}*&
10238 .cindex "quoting" "in regular expressions"
10239 .cindex "regular expressions" "quoting"
10240 .cindex "&%rxquote%& expansion item"
10241 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
10242 characters in its argument. This is useful when substituting the values of
10243 variables or headers inside regular expressions.
10244
10245
10246 .vitem &*${sha1:*&<&'string'&>&*}*&
10247 .cindex "SHA-1 hash"
10248 .cindex "expansion" "SHA-1 hashing"
10249 .cindex "certificate fingerprint"
10250 .cindex "&%sha2%& expansion item"
10251 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
10252 it as a 40-digit hexadecimal number, in which any letters are in upper case.
10253
10254
10255 .vitem &*${sha256:*&<&'certificate'&>&*}*&
10256 .cindex "SHA-256 hash"
10257 .cindex "certificate fingerprint"
10258 .cindex "expansion" "SHA-256 hashing"
10259 .cindex "&%sha256%& expansion item"
10260 The &%sha256%& operator computes the SHA-256 hash fingerprint of the
10261 certificate,
10262 and returns
10263 it as a 64-digit hexadecimal number, in which any letters are in upper case.
10264 Only arguments which are a single variable of certificate type are supported.
10265
10266
10267 .vitem &*${stat:*&<&'string'&>&*}*&
10268 .cindex "expansion" "statting a file"
10269 .cindex "file" "extracting characteristics"
10270 .cindex "&%stat%& expansion item"
10271 The string, after expansion, must be a file path. A call to the &[stat()]&
10272 function is made for this path. If &[stat()]& fails, an error occurs and the
10273 expansion fails. If it succeeds, the data from the stat replaces the item, as a
10274 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
10275 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
10276 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
10277 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
10278 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
10279 can extract individual fields using the &%extract%& expansion item.
10280
10281 The use of the &%stat%& expansion in users' filter files can be locked out by
10282 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
10283 systems for files larger than 2GB.
10284
10285 .vitem &*${str2b64:*&<&'string'&>&*}*&
10286 .cindex "expansion" "base64 encoding"
10287 .cindex "base64 encoding" "in string expansion"
10288 .cindex "&%str2b64%& expansion item"
10289 This operator converts a string into one that is base64 encoded.
10290
10291
10292
10293 .vitem &*${strlen:*&<&'string'&>&*}*&
10294 .cindex "expansion" "string length"
10295 .cindex "string" "length in expansion"
10296 .cindex "&%strlen%& expansion item"
10297 The item is replace by the length of the expanded string, expressed as a
10298 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
10299
10300
10301 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
10302 .cindex "&%substr%& expansion item"
10303 .cindex "substring extraction"
10304 .cindex "expansion" "substring expansion"
10305 The &%substr%& operator is a simpler interface to the &%substr%& function that
10306 can be used when the two parameters are fixed numbers (as opposed to strings
10307 that change when expanded). The effect is the same as
10308 .code
10309 ${substr{<start>}{<length>}{<string>}}
10310 .endd
10311 See the description of the general &%substr%& item above for details. The
10312 abbreviation &%s%& can be used when &%substr%& is used as an operator.
10313
10314 .vitem &*${time_eval:*&<&'string'&>&*}*&
10315 .cindex "&%time_eval%& expansion item"
10316 .cindex "time interval" "decoding"
10317 This item converts an Exim time interval such as &`2d4h5m`& into a number of
10318 seconds.
10319
10320 .vitem &*${time_interval:*&<&'string'&>&*}*&
10321 .cindex "&%time_interval%& expansion item"
10322 .cindex "time interval" "formatting"
10323 The argument (after sub-expansion) must be a sequence of decimal digits that
10324 represents an interval of time as a number of seconds. It is converted into a
10325 number of larger units and output in Exim's normal time format, for example,
10326 &`1w3d4h2m6s`&.
10327
10328 .vitem &*${uc:*&<&'string'&>&*}*&
10329 .cindex "case forcing in strings"
10330 .cindex "string" "case forcing"
10331 .cindex "upper casing"
10332 .cindex "expansion" "case forcing"
10333 .cindex "&%uc%& expansion item"
10334 This forces the letters in the string into upper-case.
10335
10336 .vitem &*${utf8clean:*&<&'string'&>&*}*&
10337 .cindex "correction of invalid utf-8 sequences in strings"
10338 .cindex "utf-8" "utf-8 sequences"
10339 .cindex "incorrect utf-8"
10340 .cindex "expansion" "utf-8 forcing"
10341 .cindex "&%utf8clean%& expansion item"
10342 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
10343 .endlist
10344
10345
10346
10347
10348
10349
10350 .section "Expansion conditions" "SECTexpcond"
10351 .scindex IIDexpcond "expansion" "conditions"
10352 The following conditions are available for testing by the &%${if%& construct
10353 while expanding strings:
10354
10355 .vlist
10356 .vitem &*!*&<&'condition'&>
10357 .cindex "expansion" "negating a condition"
10358 .cindex "negation" "in expansion condition"
10359 Preceding any condition with an exclamation mark negates the result of the
10360 condition.
10361
10362 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10363 .cindex "numeric comparison"
10364 .cindex "expansion" "numeric comparison"
10365 There are a number of symbolic operators for doing numeric comparisons. They
10366 are:
10367 .display
10368 &`=   `&   equal
10369 &`==  `&   equal
10370 &`>   `&   greater
10371 &`>=  `&   greater or equal
10372 &`<   `&   less
10373 &`<=  `&   less or equal
10374 .endd
10375 For example:
10376 .code
10377 ${if >{$message_size}{10M} ...
10378 .endd
10379 Note that the general negation operator provides for inequality testing. The
10380 two strings must take the form of optionally signed decimal integers,
10381 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
10382 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
10383 As a special case, the numerical value of an empty string is taken as
10384 zero.
10385
10386 In all cases, a relative comparator OP is testing if <&'string1'&> OP
10387 <&'string2'&>; the above example is checking if &$message_size$& is larger than
10388 10M, not if 10M is larger than &$message_size$&.
10389
10390
10391 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
10392         {*&<&'arg2'&>&*}...}*&
10393 .cindex "expansion" "calling an acl"
10394 .cindex "&%acl%&" "expansion condition"
10395 The name and zero to nine argument strings are first expanded separately.  The expanded
10396 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
10397 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
10398 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
10399 and may use the variables; if another acl expansion is used the values
10400 are restored after it returns.  If the ACL sets
10401 a value using a "message =" modifier the variable $value becomes
10402 the result of the expansion, otherwise it is empty.
10403 If the ACL returns accept the condition is true; if deny, false.
10404 If the ACL returns defer the result is a forced-fail.
10405
10406 .vitem &*bool&~{*&<&'string'&>&*}*&
10407 .cindex "expansion" "boolean parsing"
10408 .cindex "&%bool%& expansion condition"
10409 This condition turns a string holding a true or false representation into
10410 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
10411 (case-insensitively); also integer numbers map to true if non-zero,
10412 false if zero.
10413 An empty string is treated as false.
10414 Leading and trailing whitespace is ignored;
10415 thus a string consisting only of whitespace is false.
10416 All other string values will result in expansion failure.
10417
10418 When combined with ACL variables, this expansion condition will let you
10419 make decisions in one place and act on those decisions in another place.
10420 For example:
10421 .code
10422 ${if bool{$acl_m_privileged_sender} ...
10423 .endd
10424
10425
10426 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
10427 .cindex "expansion" "boolean parsing"
10428 .cindex "&%bool_lax%& expansion condition"
10429 Like &%bool%&, this condition turns a string into a boolean state.  But
10430 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
10431 loose definition that the Router &%condition%& option uses.  The empty string
10432 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
10433 true.  Leading and trailing whitespace is ignored.
10434
10435 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
10436
10437 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10438 .cindex "expansion" "encrypted comparison"
10439 .cindex "encrypted strings, comparing"
10440 .cindex "&%crypteq%& expansion condition"
10441 This condition is included in the Exim binary if it is built to support any
10442 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
10443 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
10444 included in the binary.
10445
10446 The &%crypteq%& condition has two arguments. The first is encrypted and
10447 compared against the second, which is already encrypted. The second string may
10448 be in the LDAP form for storing encrypted strings, which starts with the
10449 encryption type in curly brackets, followed by the data. If the second string
10450 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
10451 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
10452 Typically this will be a field from a password file. An example of an encrypted
10453 string in LDAP form is:
10454 .code
10455 {md5}CY9rzUYh03PK3k6DJie09g==
10456 .endd
10457 If such a string appears directly in an expansion, the curly brackets have to
10458 be quoted, because they are part of the expansion syntax. For example:
10459 .code
10460 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
10461 .endd
10462 The following encryption types (whose names are matched case-independently) are
10463 supported:
10464
10465 .ilist
10466 .cindex "MD5 hash"
10467 .cindex "base64 encoding" "in encrypted password"
10468 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
10469 printable characters to compare with the remainder of the second string. If the
10470 length of the comparison string is 24, Exim assumes that it is base64 encoded
10471 (as in the above example). If the length is 32, Exim assumes that it is a
10472 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
10473 comparison fails.
10474
10475 .next
10476 .cindex "SHA-1 hash"
10477 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
10478 printable characters to compare with the remainder of the second string. If the
10479 length of the comparison string is 28, Exim assumes that it is base64 encoded.
10480 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
10481 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
10482
10483 .next
10484 .cindex "&[crypt()]&"
10485 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
10486 only the first eight characters of the password. However, in modern operating
10487 systems this is no longer true, and in many cases the entire password is used,
10488 whatever its length.
10489
10490 .next
10491 .cindex "&[crypt16()]&"
10492 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
10493 use up to 16 characters of the password in some operating systems. Again, in
10494 modern operating systems, more characters may be used.
10495 .endlist
10496 Exim has its own version of &[crypt16()]&, which is just a double call to
10497 &[crypt()]&. For operating systems that have their own version, setting
10498 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
10499 operating system version instead of its own. This option is set by default in
10500 the OS-dependent &_Makefile_& for those operating systems that are known to
10501 support &[crypt16()]&.
10502
10503 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
10504 it was not using the same algorithm as some operating systems' versions. It
10505 turns out that as well as &[crypt16()]& there is a function called
10506 &[bigcrypt()]& in some operating systems. This may or may not use the same
10507 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
10508
10509 However, since there is now a move away from the traditional &[crypt()]&
10510 functions towards using SHA1 and other algorithms, tidying up this area of
10511 Exim is seen as very low priority.
10512
10513 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
10514 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
10515 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
10516 default is &`{crypt}`&. Whatever the default, you can always use either
10517 function by specifying it explicitly in curly brackets.
10518
10519 .vitem &*def:*&<&'variable&~name'&>
10520 .cindex "expansion" "checking for empty variable"
10521 .cindex "&%def%& expansion condition"
10522 The &%def%& condition must be followed by the name of one of the expansion
10523 variables defined in section &<<SECTexpvar>>&. The condition is true if the
10524 variable does not contain the empty string. For example:
10525 .code
10526 ${if def:sender_ident {from $sender_ident}}
10527 .endd
10528 Note that the variable name is given without a leading &%$%& character. If the
10529 variable does not exist, the expansion fails.
10530
10531 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
10532         &~&*def:h_*&<&'header&~name'&>&*:*&"
10533 .cindex "expansion" "checking header line existence"
10534 This condition is true if a message is being processed and the named header
10535 exists in the message. For example,
10536 .code
10537 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
10538 .endd
10539 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
10540 the header name must be terminated by a colon if white space does not follow.
10541
10542 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10543        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10544 .cindex "string" "comparison"
10545 .cindex "expansion" "string comparison"
10546 .cindex "&%eq%& expansion condition"
10547 .cindex "&%eqi%& expansion condition"
10548 The two substrings are first expanded. The condition is true if the two
10549 resulting strings are identical. For &%eq%& the comparison includes the case of
10550 letters, whereas for &%eqi%& the comparison is case-independent.
10551
10552 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
10553 .cindex "expansion" "file existence test"
10554 .cindex "file" "existence test"
10555 .cindex "&%exists%&, expansion condition"
10556 The substring is first expanded and then interpreted as an absolute path. The
10557 condition is true if the named file (or directory) exists. The existence test
10558 is done by calling the &[stat()]& function. The use of the &%exists%& test in
10559 users' filter files may be locked out by the system administrator.
10560
10561 .vitem &*first_delivery*&
10562 .cindex "delivery" "first"
10563 .cindex "first delivery"
10564 .cindex "expansion" "first delivery test"
10565 .cindex "&%first_delivery%& expansion condition"
10566 This condition, which has no data, is true during a message's first delivery
10567 attempt. It is false during any subsequent delivery attempts.
10568
10569
10570 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
10571        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
10572 .cindex "list" "iterative conditions"
10573 .cindex "expansion" "&*forall*& condition"
10574 .cindex "expansion" "&*forany*& condition"
10575 .vindex "&$item$&"
10576 These conditions iterate over a list. The first argument is expanded to form
10577 the list. By default, the list separator is a colon, but it can be changed by
10578 the normal method. The second argument is interpreted as a condition that is to
10579 be applied to each item in the list in turn. During the interpretation of the
10580 condition, the current list item is placed in a variable called &$item$&.
10581 .ilist
10582 For &*forany*&, interpretation stops if the condition is true for any item, and
10583 the result of the whole condition is true. If the condition is false for all
10584 items in the list, the overall condition is false.
10585 .next
10586 For &*forall*&, interpretation stops if the condition is false for any item,
10587 and the result of the whole condition is false. If the condition is true for
10588 all items in the list, the overall condition is true.
10589 .endlist
10590 Note that negation of &*forany*& means that the condition must be false for all
10591 items for the overall condition to succeed, and negation of &*forall*& means
10592 that the condition must be false for at least one item. In this example, the
10593 list separator is changed to a comma:
10594 .code
10595 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
10596 .endd
10597 The value of &$item$& is saved and restored while &*forany*& or &*forall*& is
10598 being processed, to enable these expansion items to be nested.
10599
10600 To scan a named list, expand it with the &*listnamed*& operator.
10601
10602
10603 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10604        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10605 .cindex "string" "comparison"
10606 .cindex "expansion" "string comparison"
10607 .cindex "&%ge%& expansion condition"
10608 .cindex "&%gei%& expansion condition"
10609 The two substrings are first expanded. The condition is true if the first
10610 string is lexically greater than or equal to the second string. For &%ge%& the
10611 comparison includes the case of letters, whereas for &%gei%& the comparison is
10612 case-independent.
10613
10614 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10615        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10616 .cindex "string" "comparison"
10617 .cindex "expansion" "string comparison"
10618 .cindex "&%gt%& expansion condition"
10619 .cindex "&%gti%& expansion condition"
10620 The two substrings are first expanded. The condition is true if the first
10621 string is lexically greater than the second string. For &%gt%& the comparison
10622 includes the case of letters, whereas for &%gti%& the comparison is
10623 case-independent.
10624
10625 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10626        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10627 .cindex "string" "comparison"
10628 .cindex "list" "iterative conditions"
10629 Both strings are expanded; the second string is treated as a list of simple
10630 strings; if the first string is a member of the second, then the condition
10631 is true.
10632
10633 These are simpler to use versions of the more powerful &*forany*& condition.
10634 Examples, and the &*forany*& equivalents:
10635 .code
10636 ${if inlist{needle}{foo:needle:bar}}
10637   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
10638 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
10639   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
10640 .endd
10641
10642 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
10643        &*isip4&~{*&<&'string'&>&*}*& &&&
10644        &*isip6&~{*&<&'string'&>&*}*&
10645 .cindex "IP address" "testing string format"
10646 .cindex "string" "testing for IP address"
10647 .cindex "&%isip%& expansion condition"
10648 .cindex "&%isip4%& expansion condition"
10649 .cindex "&%isip6%& expansion condition"
10650 The substring is first expanded, and then tested to see if it has the form of
10651 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
10652 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
10653
10654 For an IPv4 address, the test is for four dot-separated components, each of
10655 which consists of from one to three digits. For an IPv6 address, up to eight
10656 colon-separated components are permitted, each containing from one to four
10657 hexadecimal digits. There may be fewer than eight components if an empty
10658 component (adjacent colons) is present. Only one empty component is permitted.
10659
10660 &*Note*&: The checks are just on the form of the address; actual numerical
10661 values are not considered. Thus, for example, 999.999.999.999 passes the IPv4
10662 check. The main use of these tests is to distinguish between IP addresses and
10663 host names, or between IPv4 and IPv6 addresses. For example, you could use
10664 .code
10665 ${if isip4{$sender_host_address}...
10666 .endd
10667 to test which IP version an incoming SMTP connection is using.
10668
10669 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
10670 .cindex "LDAP" "use for authentication"
10671 .cindex "expansion" "LDAP authentication test"
10672 .cindex "&%ldapauth%& expansion condition"
10673 This condition supports user authentication using LDAP. See section
10674 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
10675 queries. For this use, the query must contain a user name and password. The
10676 query itself is not used, and can be empty. The condition is true if the
10677 password is not empty, and the user name and password are accepted by the LDAP
10678 server. An empty password is rejected without calling LDAP because LDAP binds
10679 with an empty password are considered anonymous regardless of the username, and
10680 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
10681 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
10682 this can be used.
10683
10684
10685 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10686        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10687 .cindex "string" "comparison"
10688 .cindex "expansion" "string comparison"
10689 .cindex "&%le%& expansion condition"
10690 .cindex "&%lei%& expansion condition"
10691 The two substrings are first expanded. The condition is true if the first
10692 string is lexically less than or equal to the second string. For &%le%& the
10693 comparison includes the case of letters, whereas for &%lei%& the comparison is
10694 case-independent.
10695
10696 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10697        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10698 .cindex "string" "comparison"
10699 .cindex "expansion" "string comparison"
10700 .cindex "&%lt%& expansion condition"
10701 .cindex "&%lti%& expansion condition"
10702 The two substrings are first expanded. The condition is true if the first
10703 string is lexically less than the second string. For &%lt%& the comparison
10704 includes the case of letters, whereas for &%lti%& the comparison is
10705 case-independent.
10706
10707
10708 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10709 .cindex "expansion" "regular expression comparison"
10710 .cindex "regular expressions" "match in expanded string"
10711 .cindex "&%match%& expansion condition"
10712 The two substrings are first expanded. The second is then treated as a regular
10713 expression and applied to the first. Because of the pre-expansion, if the
10714 regular expression contains dollar, or backslash characters, they must be
10715 escaped. Care must also be taken if the regular expression contains braces
10716 (curly brackets). A closing brace must be escaped so that it is not taken as a
10717 premature termination of <&'string2'&>. The easiest approach is to use the
10718 &`\N`& feature to disable expansion of the regular expression.
10719 For example,
10720 .code
10721 ${if match {$local_part}{\N^\d{3}\N} ...
10722 .endd
10723 If the whole expansion string is in double quotes, further escaping of
10724 backslashes is also required.
10725
10726 The condition is true if the regular expression match succeeds.
10727 The regular expression is not required to begin with a circumflex
10728 metacharacter, but if there is no circumflex, the expression is not anchored,
10729 and it may match anywhere in the subject, not just at the start. If you want
10730 the pattern to match at the end of the subject, you must include the &`$`&
10731 metacharacter at an appropriate point.
10732
10733 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
10734 At the start of an &%if%& expansion the values of the numeric variable
10735 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
10736 succeeds causes them to be reset to the substrings of that condition and they
10737 will have these values during the expansion of the success string. At the end
10738 of the &%if%& expansion, the previous values are restored. After testing a
10739 combination of conditions using &%or%&, the subsequent values of the numeric
10740 variables are those of the condition that succeeded.
10741
10742 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10743 .cindex "&%match_address%& expansion condition"
10744 See &*match_local_part*&.
10745
10746 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10747 .cindex "&%match_domain%& expansion condition"
10748 See &*match_local_part*&.
10749
10750 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10751 .cindex "&%match_ip%& expansion condition"
10752 This condition matches an IP address to a list of IP address patterns. It must
10753 be followed by two argument strings. The first (after expansion) must be an IP
10754 address or an empty string. The second (not expanded) is a restricted host
10755 list that can match only an IP address, not a host name. For example:
10756 .code
10757 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
10758 .endd
10759 The specific types of host list item that are permitted in the list are:
10760
10761 .ilist
10762 An IP address, optionally with a CIDR mask.
10763 .next
10764 A single asterisk, which matches any IP address.
10765 .next
10766 An empty item, which matches only if the IP address is empty. This could be
10767 useful for testing for a locally submitted message or one from specific hosts
10768 in a single test such as
10769 . ==== As this is a nested list, any displays it contains must be indented
10770 . ==== as otherwise they are too far to the left. This comment applies to
10771 . ==== the use of xmlto plus fop. There's no problem when formatting with
10772 . ==== sdop, with or without the extra indent.
10773 .code
10774   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
10775 .endd
10776 where the first item in the list is the empty string.
10777 .next
10778 The item @[] matches any of the local host's interface addresses.
10779 .next
10780 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
10781 even if &`net-`& is not specified. There is never any attempt to turn the IP
10782 address into a host name. The most common type of linear search for
10783 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
10784 masks. For example:
10785 .code
10786   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
10787 .endd
10788 It is of course possible to use other kinds of lookup, and in such a case, you
10789 do need to specify the &`net-`& prefix if you want to specify a specific
10790 address mask, for example:
10791 .code
10792   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
10793 .endd
10794 However, unless you are combining a &%match_ip%& condition with others, it is
10795 just as easy to use the fact that a lookup is itself a condition, and write:
10796 .code
10797   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
10798 .endd
10799 .endlist ilist
10800
10801 Note that <&'string2'&> is not itself subject to string expansion, unless
10802 Exim was built with the EXPAND_LISTMATCH_RHS option.
10803
10804 Consult section &<<SECThoslispatip>>& for further details of these patterns.
10805
10806 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10807 .cindex "domain list" "in expansion condition"
10808 .cindex "address list" "in expansion condition"
10809 .cindex "local part" "list, in expansion condition"
10810 .cindex "&%match_local_part%& expansion condition"
10811 This condition, together with &%match_address%& and &%match_domain%&, make it
10812 possible to test domain, address, and local part lists within expansions. Each
10813 condition requires two arguments: an item and a list to match. A trivial
10814 example is:
10815 .code
10816 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
10817 .endd
10818 In each case, the second argument may contain any of the allowable items for a
10819 list of the appropriate type. Also, because the second argument (after
10820 expansion) is a standard form of list, it is possible to refer to a named list.
10821 Thus, you can use conditions like this:
10822 .code
10823 ${if match_domain{$domain}{+local_domains}{...
10824 .endd
10825 .cindex "&`+caseful`&"
10826 For address lists, the matching starts off caselessly, but the &`+caseful`&
10827 item can be used, as in all address lists, to cause subsequent items to
10828 have their local parts matched casefully. Domains are always matched
10829 caselessly.
10830
10831 Note that <&'string2'&> is not itself subject to string expansion, unless
10832 Exim was built with the EXPAND_LISTMATCH_RHS option.
10833
10834 &*Note*&: Host lists are &'not'& supported in this way. This is because
10835 hosts have two identities: a name and an IP address, and it is not clear
10836 how to specify cleanly how such a test would work. However, IP addresses can be
10837 matched using &%match_ip%&.
10838
10839 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
10840 .cindex "PAM authentication"
10841 .cindex "AUTH" "with PAM"
10842 .cindex "Solaris" "PAM support"
10843 .cindex "expansion" "PAM authentication test"
10844 .cindex "&%pam%& expansion condition"
10845 &'Pluggable Authentication Modules'&
10846 (&url(http://www.kernel.org/pub/linux/libs/pam/)) are a facility that is
10847 available in the latest releases of Solaris and in some GNU/Linux
10848 distributions. The Exim support, which is intended for use in conjunction with
10849 the SMTP AUTH command, is available only if Exim is compiled with
10850 .code
10851 SUPPORT_PAM=yes
10852 .endd
10853 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
10854 in some releases of GNU/Linux &%-ldl%& is also needed.
10855
10856 The argument string is first expanded, and the result must be a
10857 colon-separated list of strings. Leading and trailing white space is ignored.
10858 The PAM module is initialized with the service name &"exim"& and the user name
10859 taken from the first item in the colon-separated data string (<&'string1'&>).
10860 The remaining items in the data string are passed over in response to requests
10861 from the authentication function. In the simple case there will only be one
10862 request, for a password, so the data consists of just two strings.
10863
10864 There can be problems if any of the strings are permitted to contain colon
10865 characters. In the usual way, these have to be doubled to avoid being taken as
10866 separators. If the data is being inserted from a variable, the &%sg%& expansion
10867 item can be used to double any existing colons. For example, the configuration
10868 of a LOGIN authenticator might contain this setting:
10869 .code
10870 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
10871 .endd
10872 For a PLAIN authenticator you could use:
10873 .code
10874 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
10875 .endd
10876 In some operating systems, PAM authentication can be done only from a process
10877 running as root. Since Exim is running as the Exim user when receiving
10878 messages, this means that PAM cannot be used directly in those systems.
10879 A patched version of the &'pam_unix'& module that comes with the
10880 Linux PAM package is available from &url(http://www.e-admin.de/pam_exim/).
10881 The patched module allows one special uid/gid combination, in addition to root,
10882 to authenticate. If you build the patched module to allow the Exim user and
10883 group, PAM can then be used from an Exim authenticator.
10884
10885
10886 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
10887 .cindex "&'pwcheck'& daemon"
10888 .cindex "Cyrus"
10889 .cindex "expansion" "&'pwcheck'& authentication test"
10890 .cindex "&%pwcheck%& expansion condition"
10891 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
10892 This is one way of making it possible for passwords to be checked by a process
10893 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
10894 deprecated. Its replacement is &'saslauthd'& (see below).
10895
10896 The pwcheck support is not included in Exim by default. You need to specify
10897 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
10898 building Exim. For example:
10899 .code
10900 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
10901 .endd
10902 You do not need to install the full Cyrus software suite in order to use
10903 the pwcheck daemon. You can compile and install just the daemon alone
10904 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
10905 access to the &_/var/pwcheck_& directory.
10906
10907 The &%pwcheck%& condition takes one argument, which must be the user name and
10908 password, separated by a colon. For example, in a LOGIN authenticator
10909 configuration, you might have this:
10910 .code
10911 server_condition = ${if pwcheck{$auth1:$auth2}}
10912 .endd
10913 Again, for a PLAIN authenticator configuration, this would be:
10914 .code
10915 server_condition = ${if pwcheck{$auth2:$auth3}}
10916 .endd
10917 .vitem &*queue_running*&
10918 .cindex "queue runner" "detecting when delivering from"
10919 .cindex "expansion" "queue runner test"
10920 .cindex "&%queue_running%& expansion condition"
10921 This condition, which has no data, is true during delivery attempts that are
10922 initiated by queue runner processes, and false otherwise.
10923
10924
10925 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
10926 .cindex "Radius"
10927 .cindex "expansion" "Radius authentication"
10928 .cindex "&%radius%& expansion condition"
10929 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
10930 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
10931 the Radius client configuration file in order to build Exim with Radius
10932 support.
10933
10934 With just that one setting, Exim expects to be linked with the &%radiusclient%&
10935 library, using the original API. If you are using release 0.4.0 or later of
10936 this library, you need to set
10937 .code
10938 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
10939 .endd
10940 in &_Local/Makefile_& when building Exim. You can also link Exim with the
10941 &%libradius%& library that comes with FreeBSD. To do this, set
10942 .code
10943 RADIUS_LIB_TYPE=RADLIB
10944 .endd
10945 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
10946 You may also have to supply a suitable setting in EXTRALIBS so that the
10947 Radius library can be found when Exim is linked.
10948
10949 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
10950 Radius client library, which calls the Radius server. The condition is true if
10951 the authentication is successful. For example:
10952 .code
10953 server_condition = ${if radius{<arguments>}}
10954 .endd
10955
10956
10957 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
10958         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
10959 .cindex "&'saslauthd'& daemon"
10960 .cindex "Cyrus"
10961 .cindex "expansion" "&'saslauthd'& authentication test"
10962 .cindex "&%saslauthd%& expansion condition"
10963 This condition supports user authentication using the Cyrus &'saslauthd'&
10964 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
10965 Using this daemon is one way of making it possible for passwords to be checked
10966 by a process that is not running as root.
10967
10968 The saslauthd support is not included in Exim by default. You need to specify
10969 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
10970 building Exim. For example:
10971 .code
10972 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
10973 .endd
10974 You do not need to install the full Cyrus software suite in order to use
10975 the saslauthd daemon. You can compile and install just the daemon alone
10976 from the Cyrus SASL library.
10977
10978 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
10979 two are mandatory. For example:
10980 .code
10981 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
10982 .endd
10983 The service and the realm are optional (which is why the arguments are enclosed
10984 in their own set of braces). For details of the meaning of the service and
10985 realm, and how to run the daemon, consult the Cyrus documentation.
10986 .endlist vlist
10987
10988
10989
10990 .section "Combining expansion conditions" "SECID84"
10991 .cindex "expansion" "combining conditions"
10992 Several conditions can be tested at once by combining them using the &%and%&
10993 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
10994 conditions on their own, and precede their lists of sub-conditions. Each
10995 sub-condition must be enclosed in braces within the overall braces that contain
10996 the list. No repetition of &%if%& is used.
10997
10998
10999 .vlist
11000 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11001 .cindex "&""or""& expansion condition"
11002 .cindex "expansion" "&""or""& of conditions"
11003 The sub-conditions are evaluated from left to right. The condition is true if
11004 any one of the sub-conditions is true.
11005 For example,
11006 .code
11007 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
11008 .endd
11009 When a true sub-condition is found, the following ones are parsed but not
11010 evaluated. If there are several &"match"& sub-conditions the values of the
11011 numeric variables afterwards are taken from the first one that succeeds.
11012
11013 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11014 .cindex "&""and""& expansion condition"
11015 .cindex "expansion" "&""and""& of conditions"
11016 The sub-conditions are evaluated from left to right. The condition is true if
11017 all of the sub-conditions are true. If there are several &"match"&
11018 sub-conditions, the values of the numeric variables afterwards are taken from
11019 the last one. When a false sub-condition is found, the following ones are
11020 parsed but not evaluated.
11021 .endlist
11022 .ecindex IIDexpcond
11023
11024
11025
11026
11027 .section "Expansion variables" "SECTexpvar"
11028 .cindex "expansion" "variables, list of"
11029 This section contains an alphabetical list of all the expansion variables. Some
11030 of them are available only when Exim is compiled with specific options such as
11031 support for TLS or the content scanning extension.
11032
11033 .vlist
11034 .vitem "&$0$&, &$1$&, etc"
11035 .cindex "numerical variables (&$1$& &$2$& etc)"
11036 When a &%match%& expansion condition succeeds, these variables contain the
11037 captured substrings identified by the regular expression during subsequent
11038 processing of the success string of the containing &%if%& expansion item.
11039 However, they do not retain their values afterwards; in fact, their previous
11040 values are restored at the end of processing an &%if%& item. The numerical
11041 variables may also be set externally by some other matching process which
11042 precedes the expansion of the string. For example, the commands available in
11043 Exim filter files include an &%if%& command with its own regular expression
11044 matching condition.
11045
11046 .vitem "&$acl_arg1$&, &$acl_arg2$&, etc"
11047 Within an acl condition, expansion condition or expansion item
11048 any arguments are copied to these variables,
11049 any unused variables being made empty.
11050
11051 .vitem "&$acl_c...$&"
11052 Values can be placed in these variables by the &%set%& modifier in an ACL. They
11053 can be given any name that starts with &$acl_c$& and is at least six characters
11054 long, but the sixth character must be either a digit or an underscore. For
11055 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
11056 variables persist throughout the lifetime of an SMTP connection. They can be
11057 used to pass information between ACLs and between different invocations of the
11058 same ACL. When a message is received, the values of these variables are saved
11059 with the message, and can be accessed by filters, routers, and transports
11060 during subsequent delivery.
11061
11062 .vitem "&$acl_m...$&"
11063 These variables are like the &$acl_c...$& variables, except that their values
11064 are reset after a message has been received. Thus, if several messages are
11065 received in one SMTP connection, &$acl_m...$& values are not passed on from one
11066 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
11067 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
11068 message is received, the values of these variables are saved with the message,
11069 and can be accessed by filters, routers, and transports during subsequent
11070 delivery.
11071
11072 .vitem &$acl_narg$&
11073 Within an acl condition, expansion condition or expansion item
11074 this variable has the number of arguments.
11075
11076 .vitem &$acl_verify_message$&
11077 .vindex "&$acl_verify_message$&"
11078 After an address verification has failed, this variable contains the failure
11079 message. It retains its value for use in subsequent modifiers. The message can
11080 be preserved by coding like this:
11081 .code
11082 warn !verify = sender
11083      set acl_m0 = $acl_verify_message
11084 .endd
11085 You can use &$acl_verify_message$& during the expansion of the &%message%& or
11086 &%log_message%& modifiers, to include information about the verification
11087 failure.
11088
11089 .vitem &$address_data$&
11090 .vindex "&$address_data$&"
11091 This variable is set by means of the &%address_data%& option in routers. The
11092 value then remains with the address while it is processed by subsequent routers
11093 and eventually a transport. If the transport is handling multiple addresses,
11094 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
11095 for more details. &*Note*&: The contents of &$address_data$& are visible in
11096 user filter files.
11097
11098 If &$address_data$& is set when the routers are called from an ACL to verify
11099 a recipient address, the final value is still in the variable for subsequent
11100 conditions and modifiers of the ACL statement. If routing the address caused it
11101 to be redirected to just one address, the child address is also routed as part
11102 of the verification, and in this case the final value of &$address_data$& is
11103 from the child's routing.
11104
11105 If &$address_data$& is set when the routers are called from an ACL to verify a
11106 sender address, the final value is also preserved, but this time in
11107 &$sender_address_data$&, to distinguish it from data from a recipient
11108 address.
11109
11110 In both cases (recipient and sender verification), the value does not persist
11111 after the end of the current ACL statement. If you want to preserve
11112 these values for longer, you can save them in ACL variables.
11113
11114 .vitem &$address_file$&
11115 .vindex "&$address_file$&"
11116 When, as a result of aliasing, forwarding, or filtering, a message is directed
11117 to a specific file, this variable holds the name of the file when the transport
11118 is running. At other times, the variable is empty. For example, using the
11119 default configuration, if user &%r2d2%& has a &_.forward_& file containing
11120 .code
11121 /home/r2d2/savemail
11122 .endd
11123 then when the &(address_file)& transport is running, &$address_file$&
11124 contains the text string &`/home/r2d2/savemail`&.
11125 .cindex "Sieve filter" "value of &$address_file$&"
11126 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
11127 then up to the transport configuration to generate an appropriate absolute path
11128 to the relevant file.
11129
11130 .vitem &$address_pipe$&
11131 .vindex "&$address_pipe$&"
11132 When, as a result of aliasing or forwarding, a message is directed to a pipe,
11133 this variable holds the pipe command when the transport is running.
11134
11135 .vitem "&$auth1$& &-- &$auth3$&"
11136 .vindex "&$auth1$&, &$auth2$&, etc"
11137 These variables are used in SMTP authenticators (see chapters
11138 &<<CHAPplaintext>>&&--&<<CHAPspa>>&). Elsewhere, they are empty.
11139
11140 .vitem &$authenticated_id$&
11141 .cindex "authentication" "id"
11142 .vindex "&$authenticated_id$&"
11143 When a server successfully authenticates a client it may be configured to
11144 preserve some of the authentication information in the variable
11145 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
11146 user/password authenticator configuration might preserve the user name for use
11147 in the routers. Note that this is not the same information that is saved in
11148 &$sender_host_authenticated$&.
11149 When a message is submitted locally (that is, not over a TCP connection)
11150 the value of &$authenticated_id$& is normally the login name of the calling
11151 process. However, a trusted user can override this by means of the &%-oMai%&
11152 command line option.
11153
11154 .vitem &$authenticated_fail_id$&
11155 .cindex "authentication" "fail" "id"
11156 .vindex "&$authenticated_fail_id$&"
11157 When an authentication attempt fails, the variable &$authenticated_fail_id$&
11158 will contain the failed authentication id. If more than one authentication
11159 id is attempted, it will contain only the last one. The variable is
11160 available for processing in the ACL's, generally the quit or notquit ACL.
11161 A message to a local recipient could still be accepted without requiring
11162 authentication, which means this variable could also be visible in all of
11163 the ACL's as well.
11164
11165
11166 .vitem &$authenticated_sender$&
11167 .cindex "sender" "authenticated"
11168 .cindex "authentication" "sender"
11169 .cindex "AUTH" "on MAIL command"
11170 .vindex "&$authenticated_sender$&"
11171 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
11172 SMTP MAIL command if it believes the sender is sufficiently trusted, as
11173 described in section &<<SECTauthparamail>>&. Unless the data is the string
11174 &"<>"&, it is set as the authenticated sender of the message, and the value is
11175 available during delivery in the &$authenticated_sender$& variable. If the
11176 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
11177
11178 .vindex "&$qualify_domain$&"
11179 When a message is submitted locally (that is, not over a TCP connection), the
11180 value of &$authenticated_sender$& is an address constructed from the login
11181 name of the calling process and &$qualify_domain$&, except that a trusted user
11182 can override this by means of the &%-oMas%& command line option.
11183
11184
11185 .vitem &$authentication_failed$&
11186 .cindex "authentication" "failure"
11187 .vindex "&$authentication_failed$&"
11188 This variable is set to &"1"& in an Exim server if a client issues an AUTH
11189 command that does not succeed. Otherwise it is set to &"0"&. This makes it
11190 possible to distinguish between &"did not try to authenticate"&
11191 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
11192 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
11193 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
11194 negative response to an AUTH command, including (for example) an attempt to use
11195 an undefined mechanism.
11196
11197 .vitem &$av_failed$&
11198 .cindex "content scanning" "AV scanner failure"
11199 This variable is available when Exim is compiled with the content-scanning
11200 extension. It is set to &"0"& by default, but will be set to &"1"& if any
11201 problem occurs with the virus scanner (specified by &%av_scanner%&) during
11202 the ACL malware condition.
11203
11204 .vitem &$body_linecount$&
11205 .cindex "message body" "line count"
11206 .cindex "body of message" "line count"
11207 .vindex "&$body_linecount$&"
11208 When a message is being received or delivered, this variable contains the
11209 number of lines in the message's body. See also &$message_linecount$&.
11210
11211 .vitem &$body_zerocount$&
11212 .cindex "message body" "binary zero count"
11213 .cindex "body of message" "binary zero count"
11214 .cindex "binary zero" "in message body"
11215 .vindex "&$body_zerocount$&"
11216 When a message is being received or delivered, this variable contains the
11217 number of binary zero bytes (ASCII NULs) in the message's body.
11218
11219 .vitem &$bounce_recipient$&
11220 .vindex "&$bounce_recipient$&"
11221 This is set to the recipient address of a bounce message while Exim is creating
11222 it. It is useful if a customized bounce message text file is in use (see
11223 chapter &<<CHAPemsgcust>>&).
11224
11225 .vitem &$bounce_return_size_limit$&
11226 .vindex "&$bounce_return_size_limit$&"
11227 This contains the value set in the &%bounce_return_size_limit%& option, rounded
11228 up to a multiple of 1000. It is useful when a customized error message text
11229 file is in use (see chapter &<<CHAPemsgcust>>&).
11230
11231 .vitem &$caller_gid$&
11232 .cindex "gid (group id)" "caller"
11233 .vindex "&$caller_gid$&"
11234 The real group id under which the process that called Exim was running. This is
11235 not the same as the group id of the originator of a message (see
11236 &$originator_gid$&). If Exim re-execs itself, this variable in the new
11237 incarnation normally contains the Exim gid.
11238
11239 .vitem &$caller_uid$&
11240 .cindex "uid (user id)" "caller"
11241 .vindex "&$caller_uid$&"
11242 The real user id under which the process that called Exim was running. This is
11243 not the same as the user id of the originator of a message (see
11244 &$originator_uid$&). If Exim re-execs itself, this variable in the new
11245 incarnation normally contains the Exim uid.
11246
11247 .vitem &$compile_date$&
11248 .vindex "&$compile_date$&"
11249 The date on which the Exim binary was compiled.
11250
11251 .vitem &$compile_number$&
11252 .vindex "&$compile_number$&"
11253 The building process for Exim keeps a count of the number
11254 of times it has been compiled. This serves to distinguish different
11255 compilations of the same version of the program.
11256
11257 .vitem &$demime_errorlevel$&
11258 .vindex "&$demime_errorlevel$&"
11259 This variable is available when Exim is compiled with
11260 the content-scanning extension and the obsolete &%demime%& condition. For
11261 details, see section &<<SECTdemimecond>>&.
11262
11263 .vitem &$demime_reason$&
11264 .vindex "&$demime_reason$&"
11265 This variable is available when Exim is compiled with the
11266 content-scanning extension and the obsolete &%demime%& condition. For details,
11267 see section &<<SECTdemimecond>>&.
11268
11269 .vitem &$dnslist_domain$& &&&
11270        &$dnslist_matched$& &&&
11271        &$dnslist_text$& &&&
11272        &$dnslist_value$&
11273 .vindex "&$dnslist_domain$&"
11274 .vindex "&$dnslist_matched$&"
11275 .vindex "&$dnslist_text$&"
11276 .vindex "&$dnslist_value$&"
11277 .cindex "black list (DNS)"
11278 When a DNS (black) list lookup succeeds, these variables are set to contain
11279 the following data from the lookup: the list's domain name, the key that was
11280 looked up, the contents of any associated TXT record, and the value from the
11281 main A record. See section &<<SECID204>>& for more details.
11282
11283 .vitem &$domain$&
11284 .vindex "&$domain$&"
11285 When an address is being routed, or delivered on its own, this variable
11286 contains the domain. Uppercase letters in the domain are converted into lower
11287 case for &$domain$&.
11288
11289 Global address rewriting happens when a message is received, so the value of
11290 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
11291 is set during user filtering, but not during system filtering, because a
11292 message may have many recipients and the system filter is called just once.
11293
11294 When more than one address is being delivered at once (for example, several
11295 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
11296 have the same domain. Transports can be restricted to handling only one domain
11297 at a time if the value of &$domain$& is required at transport time &-- this is
11298 the default for local transports. For further details of the environment in
11299 which local transports are run, see chapter &<<CHAPenvironment>>&.
11300
11301 .oindex "&%delay_warning_condition%&"
11302 At the end of a delivery, if all deferred addresses have the same domain, it is
11303 set in &$domain$& during the expansion of &%delay_warning_condition%&.
11304
11305 The &$domain$& variable is also used in some other circumstances:
11306
11307 .ilist
11308 When an ACL is running for a RCPT command, &$domain$& contains the domain of
11309 the recipient address. The domain of the &'sender'& address is in
11310 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
11311 normally set during the running of the MAIL ACL. However, if the sender address
11312 is verified with a callout during the MAIL ACL, the sender domain is placed in
11313 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
11314 the &(smtp)& transport.
11315
11316 .next
11317 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11318 &$domain$& contains the domain portion of the address that is being rewritten;
11319 it can be used in the expansion of the replacement address, for example, to
11320 rewrite domains by file lookup.
11321
11322 .next
11323 With one important exception, whenever a domain list is being scanned,
11324 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
11325 a &%sender_domains%& condition in an ACL is being processed, the subject domain
11326 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
11327 that, in a RCPT ACL, the sender domain list can be dependent on the
11328 recipient domain (which is what is in &$domain$& at this time).
11329
11330 .next
11331 .cindex "ETRN" "value of &$domain$&"
11332 .oindex "&%smtp_etrn_command%&"
11333 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
11334 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
11335 .endlist
11336
11337
11338 .vitem &$domain_data$&
11339 .vindex "&$domain_data$&"
11340 When the &%domains%& option on a router matches a domain by
11341 means of a lookup, the data read by the lookup is available during the running
11342 of the router as &$domain_data$&. In addition, if the driver routes the
11343 address to a transport, the value is available in that transport. If the
11344 transport is handling multiple addresses, the value from the first address is
11345 used.
11346
11347 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
11348 domain by means of a lookup. The data read by the lookup is available during
11349 the rest of the ACL statement. In all other situations, this variable expands
11350 to nothing.
11351
11352 .vitem &$exim_gid$&
11353 .vindex "&$exim_gid$&"
11354 This variable contains the numerical value of the Exim group id.
11355
11356 .vitem &$exim_path$&
11357 .vindex "&$exim_path$&"
11358 This variable contains the path to the Exim binary.
11359
11360 .vitem &$exim_uid$&
11361 .vindex "&$exim_uid$&"
11362 This variable contains the numerical value of the Exim user id.
11363
11364 .vitem &$found_extension$&
11365 .vindex "&$found_extension$&"
11366 This variable is available when Exim is compiled with the
11367 content-scanning extension and the obsolete &%demime%& condition. For details,
11368 see section &<<SECTdemimecond>>&.
11369
11370 .vitem &$header_$&<&'name'&>
11371 This is not strictly an expansion variable. It is expansion syntax for
11372 inserting the message header line with the given name. Note that the name must
11373 be terminated by colon or white space, because it may contain a wide variety of
11374 characters. Note also that braces must &'not'& be used.
11375
11376 .vitem &$headers_added$&
11377 .vindex "&$headers_added$&"
11378 Within an ACL this variable contains the headers added so far by
11379 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
11380 The headers are a newline-separated list.
11381
11382 .vitem &$home$&
11383 .vindex "&$home$&"
11384 When the &%check_local_user%& option is set for a router, the user's home
11385 directory is placed in &$home$& when the check succeeds. In particular, this
11386 means it is set during the running of users' filter files. A router may also
11387 explicitly set a home directory for use by a transport; this can be overridden
11388 by a setting on the transport itself.
11389
11390 When running a filter test via the &%-bf%& option, &$home$& is set to the value
11391 of the environment variable HOME.
11392
11393 .vitem &$host$&
11394 .vindex "&$host$&"
11395 If a router assigns an address to a transport (any transport), and passes a
11396 list of hosts with the address, the value of &$host$& when the transport starts
11397 to run is the name of the first host on the list. Note that this applies both
11398 to local and remote transports.
11399
11400 .cindex "transport" "filter"
11401 .cindex "filter" "transport filter"
11402 For the &(smtp)& transport, if there is more than one host, the value of
11403 &$host$& changes as the transport works its way through the list. In
11404 particular, when the &(smtp)& transport is expanding its options for encryption
11405 using TLS, or for specifying a transport filter (see chapter
11406 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
11407 is connected.
11408
11409 When used in the client part of an authenticator configuration (see chapter
11410 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
11411 client is connected.
11412
11413
11414 .vitem &$host_address$&
11415 .vindex "&$host_address$&"
11416 This variable is set to the remote host's IP address whenever &$host$& is set
11417 for a remote connection. It is also set to the IP address that is being checked
11418 when the &%ignore_target_hosts%& option is being processed.
11419
11420 .vitem &$host_data$&
11421 .vindex "&$host_data$&"
11422 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
11423 result of the lookup is made available in the &$host_data$& variable. This
11424 allows you, for example, to do things like this:
11425 .code
11426 deny  hosts = net-lsearch;/some/file
11427 message = $host_data
11428 .endd
11429 .vitem &$host_lookup_deferred$&
11430 .cindex "host name" "lookup, failure of"
11431 .vindex "&$host_lookup_deferred$&"
11432 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
11433 message comes from a remote host and there is an attempt to look up the host's
11434 name from its IP address, and the attempt is not successful, one of these
11435 variables is set to &"1"&.
11436
11437 .ilist
11438 If the lookup receives a definite negative response (for example, a DNS lookup
11439 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
11440
11441 .next
11442 If there is any kind of problem during the lookup, such that Exim cannot
11443 tell whether or not the host name is defined (for example, a timeout for a DNS
11444 lookup), &$host_lookup_deferred$& is set to &"1"&.
11445 .endlist ilist
11446
11447 Looking up a host's name from its IP address consists of more than just a
11448 single reverse lookup. Exim checks that a forward lookup of at least one of the
11449 names it receives from a reverse lookup yields the original IP address. If this
11450 is not the case, Exim does not accept the looked up name(s), and
11451 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
11452 IP address (for example, the existence of a PTR record in the DNS) is not
11453 sufficient on its own for the success of a host name lookup. If the reverse
11454 lookup succeeds, but there is a lookup problem such as a timeout when checking
11455 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
11456 &"1"&. See also &$sender_host_name$&.
11457
11458 .vitem &$host_lookup_failed$&
11459 .vindex "&$host_lookup_failed$&"
11460 See &$host_lookup_deferred$&.
11461
11462 .vitem &$host_port$&
11463 .vindex "&$host_port$&"
11464 This variable is set to the remote host's TCP port whenever &$host$& is set
11465 for an outbound connection.
11466
11467
11468 .vitem &$inode$&
11469 .vindex "&$inode$&"
11470 The only time this variable is set is while expanding the &%directory_file%&
11471 option in the &(appendfile)& transport. The variable contains the inode number
11472 of the temporary file which is about to be renamed. It can be used to construct
11473 a unique name for the file.
11474
11475 .vitem &$interface_address$&
11476 .vindex "&$interface_address$&"
11477 This is an obsolete name for &$received_ip_address$&.
11478
11479 .vitem &$interface_port$&
11480 .vindex "&$interface_port$&"
11481 This is an obsolete name for &$received_port$&.
11482
11483 .vitem &$item$&
11484 .vindex "&$item$&"
11485 This variable is used during the expansion of &*forall*& and &*forany*&
11486 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
11487 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
11488 empty.
11489
11490 .vitem &$ldap_dn$&
11491 .vindex "&$ldap_dn$&"
11492 This variable, which is available only when Exim is compiled with LDAP support,
11493 contains the DN from the last entry in the most recently successful LDAP
11494 lookup.
11495
11496 .vitem &$load_average$&
11497 .vindex "&$load_average$&"
11498 This variable contains the system load average, multiplied by 1000 so that it
11499 is an integer. For example, if the load average is 0.21, the value of the
11500 variable is 210. The value is recomputed every time the variable is referenced.
11501
11502 .vitem &$local_part$&
11503 .vindex "&$local_part$&"
11504 When an address is being routed, or delivered on its own, this
11505 variable contains the local part. When a number of addresses are being
11506 delivered together (for example, multiple RCPT commands in an SMTP
11507 session), &$local_part$& is not set.
11508
11509 Global address rewriting happens when a message is received, so the value of
11510 &$local_part$& during routing and delivery is the value after rewriting.
11511 &$local_part$& is set during user filtering, but not during system filtering,
11512 because a message may have many recipients and the system filter is called just
11513 once.
11514
11515 .vindex "&$local_part_prefix$&"
11516 .vindex "&$local_part_suffix$&"
11517 If a local part prefix or suffix has been recognized, it is not included in the
11518 value of &$local_part$& during routing and subsequent delivery. The values of
11519 any prefix or suffix are in &$local_part_prefix$& and
11520 &$local_part_suffix$&, respectively.
11521
11522 When a message is being delivered to a file, pipe, or autoreply transport as a
11523 result of aliasing or forwarding, &$local_part$& is set to the local part of
11524 the parent address, not to the file name or command (see &$address_file$& and
11525 &$address_pipe$&).
11526
11527 When an ACL is running for a RCPT command, &$local_part$& contains the
11528 local part of the recipient address.
11529
11530 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11531 &$local_part$& contains the local part of the address that is being rewritten;
11532 it can be used in the expansion of the replacement address, for example.
11533
11534 In all cases, all quoting is removed from the local part. For example, for both
11535 the addresses
11536 .code
11537 "abc:xyz"@test.example
11538 abc\:xyz@test.example
11539 .endd
11540 the value of &$local_part$& is
11541 .code
11542 abc:xyz
11543 .endd
11544 If you use &$local_part$& to create another address, you should always wrap it
11545 inside a quoting operator. For example, in a &(redirect)& router you could
11546 have:
11547 .code
11548 data = ${quote_local_part:$local_part}@new.domain.example
11549 .endd
11550 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
11551 to process local parts in a case-dependent manner in a router, you can set the
11552 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
11553
11554 .vitem &$local_part_data$&
11555 .vindex "&$local_part_data$&"
11556 When the &%local_parts%& option on a router matches a local part by means of a
11557 lookup, the data read by the lookup is available during the running of the
11558 router as &$local_part_data$&. In addition, if the driver routes the address
11559 to a transport, the value is available in that transport. If the transport is
11560 handling multiple addresses, the value from the first address is used.
11561
11562 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
11563 matches a local part by means of a lookup. The data read by the lookup is
11564 available during the rest of the ACL statement. In all other situations, this
11565 variable expands to nothing.
11566
11567 .vitem &$local_part_prefix$&
11568 .vindex "&$local_part_prefix$&"
11569 When an address is being routed or delivered, and a
11570 specific prefix for the local part was recognized, it is available in this
11571 variable, having been removed from &$local_part$&.
11572
11573 .vitem &$local_part_suffix$&
11574 .vindex "&$local_part_suffix$&"
11575 When an address is being routed or delivered, and a
11576 specific suffix for the local part was recognized, it is available in this
11577 variable, having been removed from &$local_part$&.
11578
11579 .vitem &$local_scan_data$&
11580 .vindex "&$local_scan_data$&"
11581 This variable contains the text returned by the &[local_scan()]& function when
11582 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
11583
11584 .vitem &$local_user_gid$&
11585 .vindex "&$local_user_gid$&"
11586 See &$local_user_uid$&.
11587
11588 .vitem &$local_user_uid$&
11589 .vindex "&$local_user_uid$&"
11590 This variable and &$local_user_gid$& are set to the uid and gid after the
11591 &%check_local_user%& router precondition succeeds. This means that their values
11592 are available for the remaining preconditions (&%senders%&, &%require_files%&,
11593 and &%condition%&), for the &%address_data%& expansion, and for any
11594 router-specific expansions. At all other times, the values in these variables
11595 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
11596
11597 .vitem &$localhost_number$&
11598 .vindex "&$localhost_number$&"
11599 This contains the expanded value of the
11600 &%localhost_number%& option. The expansion happens after the main options have
11601 been read.
11602
11603 .vitem &$log_inodes$&
11604 .vindex "&$log_inodes$&"
11605 The number of free inodes in the disk partition where Exim's
11606 log files are being written. The value is recalculated whenever the variable is
11607 referenced. If the relevant file system does not have the concept of inodes,
11608 the value of is -1. See also the &%check_log_inodes%& option.
11609
11610 .vitem &$log_space$&
11611 .vindex "&$log_space$&"
11612 The amount of free space (as a number of kilobytes) in the disk
11613 partition where Exim's log files are being written. The value is recalculated
11614 whenever the variable is referenced. If the operating system does not have the
11615 ability to find the amount of free space (only true for experimental systems),
11616 the space value is -1. See also the &%check_log_space%& option.
11617
11618
11619 .vitem &$lookup_dnssec_authenticated$&
11620 .vindex "&$lookup_dnssec_authenticated$&"
11621 This variable is set after a DNS lookup done by
11622 a dnsdb lookup expansion, dnslookup router or smtp transport.
11623 It will be empty if &(DNSSEC)& was not requested,
11624 &"no"& if the result was not labelled as authenticated data
11625 and &"yes"& if it was.
11626
11627 .vitem &$mailstore_basename$&
11628 .vindex "&$mailstore_basename$&"
11629 This variable is set only when doing deliveries in &"mailstore"& format in the
11630 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
11631 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
11632 contains the basename of the files that are being written, that is, the name
11633 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
11634 variable is empty.
11635
11636 .vitem &$malware_name$&
11637 .vindex "&$malware_name$&"
11638 This variable is available when Exim is compiled with the
11639 content-scanning extension. It is set to the name of the virus that was found
11640 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
11641
11642 .vitem &$max_received_linelength$&
11643 .vindex "&$max_received_linelength$&"
11644 .cindex "maximum" "line length"
11645 .cindex "line length" "maximum"
11646 This variable contains the number of bytes in the longest line that was
11647 received as part of the message, not counting the line termination
11648 character(s).
11649
11650 .vitem &$message_age$&
11651 .cindex "message" "age of"
11652 .vindex "&$message_age$&"
11653 This variable is set at the start of a delivery attempt to contain the number
11654 of seconds since the message was received. It does not change during a single
11655 delivery attempt.
11656
11657 .vitem &$message_body$&
11658 .cindex "body of message" "expansion variable"
11659 .cindex "message body" "in expansion"
11660 .cindex "binary zero" "in message body"
11661 .vindex "&$message_body$&"
11662 .oindex "&%message_body_visible%&"
11663 This variable contains the initial portion of a message's body while it is
11664 being delivered, and is intended mainly for use in filter files. The maximum
11665 number of characters of the body that are put into the variable is set by the
11666 &%message_body_visible%& configuration option; the default is 500.
11667
11668 .oindex "&%message_body_newlines%&"
11669 By default, newlines are converted into spaces in &$message_body$&, to make it
11670 easier to search for phrases that might be split over a line break. However,
11671 this can be disabled by setting &%message_body_newlines%& to be true. Binary
11672 zeros are always converted into spaces.
11673
11674 .vitem &$message_body_end$&
11675 .cindex "body of message" "expansion variable"
11676 .cindex "message body" "in expansion"
11677 .vindex "&$message_body_end$&"
11678 This variable contains the final portion of a message's
11679 body while it is being delivered. The format and maximum size are as for
11680 &$message_body$&.
11681
11682 .vitem &$message_body_size$&
11683 .cindex "body of message" "size"
11684 .cindex "message body" "size"
11685 .vindex "&$message_body_size$&"
11686 When a message is being delivered, this variable contains the size of the body
11687 in bytes. The count starts from the character after the blank line that
11688 separates the body from the header. Newlines are included in the count. See
11689 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
11690
11691 .vitem &$message_exim_id$&
11692 .vindex "&$message_exim_id$&"
11693 When a message is being received or delivered, this variable contains the
11694 unique message id that is generated and used by Exim to identify the message.
11695 An id is not created for a message until after its header has been successfully
11696 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
11697 line; it is the local id that Exim assigns to the message, for example:
11698 &`1BXTIK-0001yO-VA`&.
11699
11700 .vitem &$message_headers$&
11701 .vindex &$message_headers$&
11702 This variable contains a concatenation of all the header lines when a message
11703 is being processed, except for lines added by routers or transports. The header
11704 lines are separated by newline characters. Their contents are decoded in the
11705 same way as a header line that is inserted by &%bheader%&.
11706
11707 .vitem &$message_headers_raw$&
11708 .vindex &$message_headers_raw$&
11709 This variable is like &$message_headers$& except that no processing of the
11710 contents of header lines is done.
11711
11712 .vitem &$message_id$&
11713 This is an old name for &$message_exim_id$&. It is now deprecated.
11714
11715 .vitem &$message_linecount$&
11716 .vindex "&$message_linecount$&"
11717 This variable contains the total number of lines in the header and body of the
11718 message. Compare &$body_linecount$&, which is the count for the body only.
11719 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
11720 number of lines received. Before delivery happens (that is, before filters,
11721 routers, and transports run) the count is increased to include the
11722 &'Received:'& header line that Exim standardly adds, and also any other header
11723 lines that are added by ACLs. The blank line that separates the message header
11724 from the body is not counted.
11725
11726 As with the special case of &$message_size$&, during the expansion of the
11727 appendfile transport's maildir_tag option in maildir format, the value of
11728 &$message_linecount$& is the precise size of the number of newlines in the
11729 file that has been written (minus one for the blank line between the
11730 header and the body).
11731
11732 Here is an example of the use of this variable in a DATA ACL:
11733 .code
11734 deny message   = Too many lines in message header
11735      condition = \
11736       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
11737 .endd
11738 In the MAIL and RCPT ACLs, the value is zero because at that stage the
11739 message has not yet been received.
11740
11741 .vitem &$message_size$&
11742 .cindex "size" "of message"
11743 .cindex "message" "size"
11744 .vindex "&$message_size$&"
11745 When a message is being processed, this variable contains its size in bytes. In
11746 most cases, the size includes those headers that were received with the
11747 message, but not those (such as &'Envelope-to:'&) that are added to individual
11748 deliveries as they are written. However, there is one special case: during the
11749 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
11750 doing a delivery in maildir format, the value of &$message_size$& is the
11751 precise size of the file that has been written. See also
11752 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
11753
11754 .cindex "RCPT" "value of &$message_size$&"
11755 While running a per message ACL (mail/rcpt/predata), &$message_size$&
11756 contains the size supplied on the MAIL command, or -1 if no size was given. The
11757 value may not, of course, be truthful.
11758
11759 .vitem &$mime_$&&'xxx'&
11760 A number of variables whose names start with &$mime$& are
11761 available when Exim is compiled with the content-scanning extension. For
11762 details, see section &<<SECTscanmimepart>>&.
11763
11764 .vitem "&$n0$& &-- &$n9$&"
11765 These variables are counters that can be incremented by means
11766 of the &%add%& command in filter files.
11767
11768 .vitem &$original_domain$&
11769 .vindex "&$domain$&"
11770 .vindex "&$original_domain$&"
11771 When a top-level address is being processed for delivery, this contains the
11772 same value as &$domain$&. However, if a &"child"& address (for example,
11773 generated by an alias, forward, or filter file) is being processed, this
11774 variable contains the domain of the original address (lower cased). This
11775 differs from &$parent_domain$& only when there is more than one level of
11776 aliasing or forwarding. When more than one address is being delivered in a
11777 single transport run, &$original_domain$& is not set.
11778
11779 If a new address is created by means of a &%deliver%& command in a system
11780 filter, it is set up with an artificial &"parent"& address. This has the local
11781 part &'system-filter'& and the default qualify domain.
11782
11783 .vitem &$original_local_part$&
11784 .vindex "&$local_part$&"
11785 .vindex "&$original_local_part$&"
11786 When a top-level address is being processed for delivery, this contains the
11787 same value as &$local_part$&, unless a prefix or suffix was removed from the
11788 local part, because &$original_local_part$& always contains the full local
11789 part. When a &"child"& address (for example, generated by an alias, forward, or
11790 filter file) is being processed, this variable contains the full local part of
11791 the original address.
11792
11793 If the router that did the redirection processed the local part
11794 case-insensitively, the value in &$original_local_part$& is in lower case.
11795 This variable differs from &$parent_local_part$& only when there is more than
11796 one level of aliasing or forwarding. When more than one address is being
11797 delivered in a single transport run, &$original_local_part$& is not set.
11798
11799 If a new address is created by means of a &%deliver%& command in a system
11800 filter, it is set up with an artificial &"parent"& address. This has the local
11801 part &'system-filter'& and the default qualify domain.
11802
11803 .vitem &$originator_gid$&
11804 .cindex "gid (group id)" "of originating user"
11805 .cindex "sender" "gid"
11806 .vindex "&$caller_gid$&"
11807 .vindex "&$originator_gid$&"
11808 This variable contains the value of &$caller_gid$& that was set when the
11809 message was received. For messages received via the command line, this is the
11810 gid of the sending user. For messages received by SMTP over TCP/IP, this is
11811 normally the gid of the Exim user.
11812
11813 .vitem &$originator_uid$&
11814 .cindex "uid (user id)" "of originating user"
11815 .cindex "sender" "uid"
11816 .vindex "&$caller_uid$&"
11817 .vindex "&$originaltor_uid$&"
11818 The value of &$caller_uid$& that was set when the message was received. For
11819 messages received via the command line, this is the uid of the sending user.
11820 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
11821 user.
11822
11823 .vitem &$parent_domain$&
11824 .vindex "&$parent_domain$&"
11825 This variable is similar to &$original_domain$& (see
11826 above), except that it refers to the immediately preceding parent address.
11827
11828 .vitem &$parent_local_part$&
11829 .vindex "&$parent_local_part$&"
11830 This variable is similar to &$original_local_part$&
11831 (see above), except that it refers to the immediately preceding parent address.
11832
11833 .vitem &$pid$&
11834 .cindex "pid (process id)" "of current process"
11835 .vindex "&$pid$&"
11836 This variable contains the current process id.
11837
11838 .vitem &$pipe_addresses$&
11839 .cindex "filter" "transport filter"
11840 .cindex "transport" "filter"
11841 .vindex "&$pipe_addresses$&"
11842 This is not an expansion variable, but is mentioned here because the string
11843 &`$pipe_addresses`& is handled specially in the command specification for the
11844 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
11845 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
11846 It cannot be used in general expansion strings, and provokes an &"unknown
11847 variable"& error if encountered.
11848
11849 .vitem &$primary_hostname$&
11850 .vindex "&$primary_hostname$&"
11851 This variable contains the value set by &%primary_hostname%& in the
11852 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
11853 a single-component name, Exim calls &[gethostbyname()]& (or
11854 &[getipnodebyname()]& where available) in an attempt to acquire a fully
11855 qualified host name. See also &$smtp_active_hostname$&.
11856
11857
11858 .vitem &$prvscheck_address$&
11859 This variable is used in conjunction with the &%prvscheck%& expansion item,
11860 which is described in sections &<<SECTexpansionitems>>& and
11861 &<<SECTverifyPRVS>>&.
11862
11863 .vitem &$prvscheck_keynum$&
11864 This variable is used in conjunction with the &%prvscheck%& expansion item,
11865 which is described in sections &<<SECTexpansionitems>>& and
11866 &<<SECTverifyPRVS>>&.
11867
11868 .vitem &$prvscheck_result$&
11869 This variable is used in conjunction with the &%prvscheck%& expansion item,
11870 which is described in sections &<<SECTexpansionitems>>& and
11871 &<<SECTverifyPRVS>>&.
11872
11873 .vitem &$qualify_domain$&
11874 .vindex "&$qualify_domain$&"
11875 The value set for the &%qualify_domain%& option in the configuration file.
11876
11877 .vitem &$qualify_recipient$&
11878 .vindex "&$qualify_recipient$&"
11879 The value set for the &%qualify_recipient%& option in the configuration file,
11880 or if not set, the value of &$qualify_domain$&.
11881
11882 .vitem &$rcpt_count$&
11883 .vindex "&$rcpt_count$&"
11884 When a message is being received by SMTP, this variable contains the number of
11885 RCPT commands received for the current message. If this variable is used in a
11886 RCPT ACL, its value includes the current command.
11887
11888 .vitem &$rcpt_defer_count$&
11889 .vindex "&$rcpt_defer_count$&"
11890 .cindex "4&'xx'& responses" "count of"
11891 When a message is being received by SMTP, this variable contains the number of
11892 RCPT commands in the current message that have previously been rejected with a
11893 temporary (4&'xx'&) response.
11894
11895 .vitem &$rcpt_fail_count$&
11896 .vindex "&$rcpt_fail_count$&"
11897 When a message is being received by SMTP, this variable contains the number of
11898 RCPT commands in the current message that have previously been rejected with a
11899 permanent (5&'xx'&) response.
11900
11901 .vitem &$received_count$&
11902 .vindex "&$received_count$&"
11903 This variable contains the number of &'Received:'& header lines in the message,
11904 including the one added by Exim (so its value is always greater than zero). It
11905 is available in the DATA ACL, the non-SMTP ACL, and while routing and
11906 delivering.
11907
11908 .vitem &$received_for$&
11909 .vindex "&$received_for$&"
11910 If there is only a single recipient address in an incoming message, this
11911 variable contains that address when the &'Received:'& header line is being
11912 built. The value is copied after recipient rewriting has happened, but before
11913 the &[local_scan()]& function is run.
11914
11915 .vitem &$received_ip_address$&
11916 .vindex "&$received_ip_address$&"
11917 As soon as an Exim server starts processing an incoming TCP/IP connection, this
11918 variable is set to the address of the local IP interface, and &$received_port$&
11919 is set to the local port number. (The remote IP address and port are in
11920 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
11921 the port value is -1 unless it has been set using the &%-oMi%& command line
11922 option.
11923
11924 As well as being useful in ACLs (including the &"connect"& ACL), these variable
11925 could be used, for example, to make the file name for a TLS certificate depend
11926 on which interface and/or port is being used for the incoming connection. The
11927 values of &$received_ip_address$& and &$received_port$& are saved with any
11928 messages that are received, thus making these variables available at delivery
11929 time.
11930 For outbound connections see &$sending_ip_address$&.
11931
11932 .vitem &$received_port$&
11933 .vindex "&$received_port$&"
11934 See &$received_ip_address$&.
11935
11936 .vitem &$received_protocol$&
11937 .vindex "&$received_protocol$&"
11938 When a message is being processed, this variable contains the name of the
11939 protocol by which it was received. Most of the names used by Exim are defined
11940 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
11941 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
11942 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
11943 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
11944 connection and the client was successfully authenticated.
11945
11946 Exim uses the protocol name &"smtps"& for the case when encryption is
11947 automatically set up on connection without the use of STARTTLS (see
11948 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
11949 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
11950 where the client initially uses EHLO, sets up an encrypted connection using
11951 STARTTLS, and then uses HELO afterwards.
11952
11953 The &%-oMr%& option provides a way of specifying a custom protocol name for
11954 messages that are injected locally by trusted callers. This is commonly used to
11955 identify messages that are being re-injected after some kind of scanning.
11956
11957 .vitem &$received_time$&
11958 .vindex "&$received_time$&"
11959 This variable contains the date and time when the current message was received,
11960 as a number of seconds since the start of the Unix epoch.
11961
11962 .vitem &$recipient_data$&
11963 .vindex "&$recipient_data$&"
11964 This variable is set after an indexing lookup success in an ACL &%recipients%&
11965 condition. It contains the data from the lookup, and the value remains set
11966 until the next &%recipients%& test. Thus, you can do things like this:
11967 .display
11968 &`require recipients  = cdb*@;/some/file`&
11969 &`deny    `&&'some further test involving'& &`$recipient_data`&
11970 .endd
11971 &*Warning*&: This variable is set only when a lookup is used as an indexing
11972 method in the address list, using the semicolon syntax as in the example above.
11973 The variable is not set for a lookup that is used as part of the string
11974 expansion that all such lists undergo before being interpreted.
11975
11976 .vitem &$recipient_verify_failure$&
11977 .vindex "&$recipient_verify_failure$&"
11978 In an ACL, when a recipient verification fails, this variable contains
11979 information about the failure. It is set to one of the following words:
11980
11981 .ilist
11982 &"qualify"&: The address was unqualified (no domain), and the message
11983 was neither local nor came from an exempted host.
11984
11985 .next
11986 &"route"&: Routing failed.
11987
11988 .next
11989 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
11990 or before the MAIL command (that is, on initial connection, HELO, or
11991 MAIL).
11992
11993 .next
11994 &"recipient"&: The RCPT command in a callout was rejected.
11995 .next
11996
11997 &"postmaster"&: The postmaster check in a callout was rejected.
11998 .endlist
11999
12000 The main use of this variable is expected to be to distinguish between
12001 rejections of MAIL and rejections of RCPT.
12002
12003 .vitem &$recipients$&
12004 .vindex "&$recipients$&"
12005 This variable contains a list of envelope recipients for a message. A comma and
12006 a space separate the addresses in the replacement text. However, the variable
12007 is not generally available, to prevent exposure of Bcc recipients in
12008 unprivileged users' filter files. You can use &$recipients$& only in these
12009 cases:
12010
12011 .olist
12012 In a system filter file.
12013 .next
12014 In the ACLs associated with the DATA command and with non-SMTP messages, that
12015 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
12016 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
12017 &%acl_not_smtp_mime%&.
12018 .next
12019 From within a &[local_scan()]& function.
12020 .endlist
12021
12022
12023 .vitem &$recipients_count$&
12024 .vindex "&$recipients_count$&"
12025 When a message is being processed, this variable contains the number of
12026 envelope recipients that came with the message. Duplicates are not excluded
12027 from the count. While a message is being received over SMTP, the number
12028 increases for each accepted recipient. It can be referenced in an ACL.
12029
12030
12031 .vitem &$regex_match_string$&
12032 .vindex "&$regex_match_string$&"
12033 This variable is set to contain the matching regular expression after a
12034 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
12035
12036
12037 .vitem &$reply_address$&
12038 .vindex "&$reply_address$&"
12039 When a message is being processed, this variable contains the contents of the
12040 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
12041 contents of the &'From:'& header line. Apart from the removal of leading
12042 white space, the value is not processed in any way. In particular, no RFC 2047
12043 decoding or character code translation takes place.
12044
12045 .vitem &$return_path$&
12046 .vindex "&$return_path$&"
12047 When a message is being delivered, this variable contains the return path &--
12048 the sender field that will be sent as part of the envelope. It is not enclosed
12049 in <> characters. At the start of routing an address, &$return_path$& has the
12050 same value as &$sender_address$&, but if, for example, an incoming message to a
12051 mailing list has been expanded by a router which specifies a different address
12052 for bounce messages, &$return_path$& subsequently contains the new bounce
12053 address, whereas &$sender_address$& always contains the original sender address
12054 that was received with the message. In other words, &$sender_address$& contains
12055 the incoming envelope sender, and &$return_path$& contains the outgoing
12056 envelope sender.
12057
12058 .vitem &$return_size_limit$&
12059 .vindex "&$return_size_limit$&"
12060 This is an obsolete name for &$bounce_return_size_limit$&.
12061
12062 .vitem &$router_name$&
12063 .cindex "router" "name"
12064 .cindex "name" "of router"
12065 .vindex "&$router_name$&"
12066 During the running of a router this variable contains its name.
12067
12068 .vitem &$runrc$&
12069 .cindex "return code" "from &%run%& expansion"
12070 .vindex "&$runrc$&"
12071 This variable contains the return code from a command that is run by the
12072 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
12073 assume the order in which option values are expanded, except for those
12074 preconditions whose order of testing is documented. Therefore, you cannot
12075 reliably expect to set &$runrc$& by the expansion of one option, and use it in
12076 another.
12077
12078 .vitem &$self_hostname$&
12079 .oindex "&%self%&" "value of host name"
12080 .vindex "&$self_hostname$&"
12081 When an address is routed to a supposedly remote host that turns out to be the
12082 local host, what happens is controlled by the &%self%& generic router option.
12083 One of its values causes the address to be passed to another router. When this
12084 happens, &$self_hostname$& is set to the name of the local host that the
12085 original router encountered. In other circumstances its contents are null.
12086
12087 .vitem &$sender_address$&
12088 .vindex "&$sender_address$&"
12089 When a message is being processed, this variable contains the sender's address
12090 that was received in the message's envelope. The case of letters in the address
12091 is retained, in both the local part and the domain. For bounce messages, the
12092 value of this variable is the empty string. See also &$return_path$&.
12093
12094 .vitem &$sender_address_data$&
12095 .vindex "&$address_data$&"
12096 .vindex "&$sender_address_data$&"
12097 If &$address_data$& is set when the routers are called from an ACL to verify a
12098 sender address, the final value is preserved in &$sender_address_data$&, to
12099 distinguish it from data from a recipient address. The value does not persist
12100 after the end of the current ACL statement. If you want to preserve it for
12101 longer, you can save it in an ACL variable.
12102
12103 .vitem &$sender_address_domain$&
12104 .vindex "&$sender_address_domain$&"
12105 The domain portion of &$sender_address$&.
12106
12107 .vitem &$sender_address_local_part$&
12108 .vindex "&$sender_address_local_part$&"
12109 The local part portion of &$sender_address$&.
12110
12111 .vitem &$sender_data$&
12112 .vindex "&$sender_data$&"
12113 This variable is set after a lookup success in an ACL &%senders%& condition or
12114 in a router &%senders%& option. It contains the data from the lookup, and the
12115 value remains set until the next &%senders%& test. Thus, you can do things like
12116 this:
12117 .display
12118 &`require senders      = cdb*@;/some/file`&
12119 &`deny    `&&'some further test involving'& &`$sender_data`&
12120 .endd
12121 &*Warning*&: This variable is set only when a lookup is used as an indexing
12122 method in the address list, using the semicolon syntax as in the example above.
12123 The variable is not set for a lookup that is used as part of the string
12124 expansion that all such lists undergo before being interpreted.
12125
12126 .vitem &$sender_fullhost$&
12127 .vindex "&$sender_fullhost$&"
12128 When a message is received from a remote host, this variable contains the host
12129 name and IP address in a single string. It ends with the IP address in square
12130 brackets, followed by a colon and a port number if the logging of ports is
12131 enabled. The format of the rest of the string depends on whether the host
12132 issued a HELO or EHLO SMTP command, and whether the host name was verified by
12133 looking up its IP address. (Looking up the IP address can be forced by the
12134 &%host_lookup%& option, independent of verification.) A plain host name at the
12135 start of the string is a verified host name; if this is not present,
12136 verification either failed or was not requested. A host name in parentheses is
12137 the argument of a HELO or EHLO command. This is omitted if it is identical to
12138 the verified host name or to the host's IP address in square brackets.
12139
12140 .vitem &$sender_helo_name$&
12141 .vindex "&$sender_helo_name$&"
12142 When a message is received from a remote host that has issued a HELO or EHLO
12143 command, the argument of that command is placed in this variable. It is also
12144 set if HELO or EHLO is used when a message is received using SMTP locally via
12145 the &%-bs%& or &%-bS%& options.
12146
12147 .vitem &$sender_host_address$&
12148 .vindex "&$sender_host_address$&"
12149 When a message is received from a remote host using SMTP,
12150 this variable contains that
12151 host's IP address. For locally non-SMTP submitted messages, it is empty.
12152
12153 .vitem &$sender_host_authenticated$&
12154 .vindex "&$sender_host_authenticated$&"
12155 This variable contains the name (not the public name) of the authenticator
12156 driver that successfully authenticated the client from which the message was
12157 received. It is empty if there was no successful authentication. See also
12158 &$authenticated_id$&.
12159
12160 .vitem &$sender_host_dnssec$&
12161 .vindex "&$sender_host_dnssec$&"
12162 If an attempt to populate &$sender_host_name$& has been made
12163 (by reference, &%hosts_lookup%& or
12164 otherwise) then this boolean will have been set true if, and only if, the
12165 resolver library states that the reverse DNS was authenticated data.  At all
12166 other times, this variable is false.
12167
12168 It is likely that you will need to coerce DNSSEC support on in the resolver
12169 library, by setting:
12170 .code
12171 dns_dnssec_ok = 1
12172 .endd
12173
12174 Exim does not perform DNSSEC validation itself, instead leaving that to a
12175 validating resolver (eg, unbound, or bind with suitable configuration).
12176
12177 Exim does not (currently) check to see if the forward DNS was also secured
12178 with DNSSEC, only the reverse DNS.
12179
12180 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
12181 mechanism in the list, then this variable will be false.
12182
12183
12184 .vitem &$sender_host_name$&
12185 .vindex "&$sender_host_name$&"
12186 When a message is received from a remote host, this variable contains the
12187 host's name as obtained by looking up its IP address. For messages received by
12188 other means, this variable is empty.
12189
12190 .vindex "&$host_lookup_failed$&"
12191 If the host name has not previously been looked up, a reference to
12192 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
12193 A looked up name is accepted only if it leads back to the original IP address
12194 via a forward lookup. If either the reverse or the forward lookup fails to find
12195 any data, or if the forward lookup does not yield the original IP address,
12196 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
12197
12198 .vindex "&$host_lookup_deferred$&"
12199 However, if either of the lookups cannot be completed (for example, there is a
12200 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
12201 &$host_lookup_failed$& remains set to &"0"&.
12202
12203 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
12204 host name again if there is a subsequent reference to &$sender_host_name$&
12205 in the same Exim process, but it does try again if &$host_lookup_deferred$&
12206 is set to &"1"&.
12207
12208 Exim does not automatically look up every calling host's name. If you want
12209 maximum efficiency, you should arrange your configuration so that it avoids
12210 these lookups altogether. The lookup happens only if one or more of the
12211 following are true:
12212
12213 .ilist
12214 A string containing &$sender_host_name$& is expanded.
12215 .next
12216 The calling host matches the list in &%host_lookup%&. In the default
12217 configuration, this option is set to *, so it must be changed if lookups are
12218 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
12219 .next
12220 Exim needs the host name in order to test an item in a host list. The items
12221 that require this are described in sections &<<SECThoslispatnam>>& and
12222 &<<SECThoslispatnamsk>>&.
12223 .next
12224 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
12225 In this case, the host name is required to compare with the name quoted in any
12226 EHLO or HELO commands that the client issues.
12227 .next
12228 The remote host issues a EHLO or HELO command that quotes one of the
12229 domains in &%helo_lookup_domains%&. The default value of this option is
12230 . ==== As this is a nested list, any displays it contains must be indented
12231 . ==== as otherwise they are too far to the left.
12232 .code
12233   helo_lookup_domains = @ : @[]
12234 .endd
12235 which causes a lookup if a remote host (incorrectly) gives the server's name or
12236 IP address in an EHLO or HELO command.
12237 .endlist
12238
12239
12240 .vitem &$sender_host_port$&
12241 .vindex "&$sender_host_port$&"
12242 When a message is received from a remote host, this variable contains the port
12243 number that was used on the remote host.
12244
12245 .vitem &$sender_ident$&
12246 .vindex "&$sender_ident$&"
12247 When a message is received from a remote host, this variable contains the
12248 identification received in response to an RFC 1413 request. When a message has
12249 been received locally, this variable contains the login name of the user that
12250 called Exim.
12251
12252 .vitem &$sender_rate_$&&'xxx'&
12253 A number of variables whose names begin &$sender_rate_$& are set as part of the
12254 &%ratelimit%& ACL condition. Details are given in section
12255 &<<SECTratelimiting>>&.
12256
12257 .vitem &$sender_rcvhost$&
12258 .cindex "DNS" "reverse lookup"
12259 .cindex "reverse DNS lookup"
12260 .vindex "&$sender_rcvhost$&"
12261 This is provided specifically for use in &'Received:'& headers. It starts with
12262 either the verified host name (as obtained from a reverse DNS lookup) or, if
12263 there is no verified host name, the IP address in square brackets. After that
12264 there may be text in parentheses. When the first item is a verified host name,
12265 the first thing in the parentheses is the IP address in square brackets,
12266 followed by a colon and a port number if port logging is enabled. When the
12267 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
12268 the parentheses.
12269
12270 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
12271 was used and its argument was not identical to the real host name or IP
12272 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
12273 all three items are present in the parentheses, a newline and tab are inserted
12274 into the string, to improve the formatting of the &'Received:'& header.
12275
12276 .vitem &$sender_verify_failure$&
12277 .vindex "&$sender_verify_failure$&"
12278 In an ACL, when a sender verification fails, this variable contains information
12279 about the failure. The details are the same as for
12280 &$recipient_verify_failure$&.
12281
12282 .vitem &$sending_ip_address$&
12283 .vindex "&$sending_ip_address$&"
12284 This variable is set whenever an outgoing SMTP connection to another host has
12285 been set up. It contains the IP address of the local interface that is being
12286 used. This is useful if a host that has more than one IP address wants to take
12287 on different personalities depending on which one is being used. For incoming
12288 connections, see &$received_ip_address$&.
12289
12290 .vitem &$sending_port$&
12291 .vindex "&$sending_port$&"
12292 This variable is set whenever an outgoing SMTP connection to another host has
12293 been set up. It contains the local port that is being used. For incoming
12294 connections, see &$received_port$&.
12295
12296 .vitem &$smtp_active_hostname$&
12297 .vindex "&$smtp_active_hostname$&"
12298 During an incoming SMTP session, this variable contains the value of the active
12299 host name, as specified by the &%smtp_active_hostname%& option. The value of
12300 &$smtp_active_hostname$& is saved with any message that is received, so its
12301 value can be consulted during routing and delivery.
12302
12303 .vitem &$smtp_command$&
12304 .vindex "&$smtp_command$&"
12305 During the processing of an incoming SMTP command, this variable contains the
12306 entire command. This makes it possible to distinguish between HELO and EHLO in
12307 the HELO ACL, and also to distinguish between commands such as these:
12308 .code
12309 MAIL FROM:<>
12310 MAIL FROM: <>
12311 .endd
12312 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
12313 command, the address in &$smtp_command$& is the original address before any
12314 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
12315 the address after SMTP-time rewriting.
12316
12317 .vitem &$smtp_command_argument$&
12318 .cindex "SMTP" "command, argument for"
12319 .vindex "&$smtp_command_argument$&"
12320 While an ACL is running to check an SMTP command, this variable contains the
12321 argument, that is, the text that follows the command name, with leading white
12322 space removed. Following the introduction of &$smtp_command$&, this variable is
12323 somewhat redundant, but is retained for backwards compatibility.
12324
12325 .vitem &$smtp_count_at_connection_start$&
12326 .vindex "&$smtp_count_at_connection_start$&"
12327 This variable is set greater than zero only in processes spawned by the Exim
12328 daemon for handling incoming SMTP connections. The name is deliberately long,
12329 in order to emphasize what the contents are. When the daemon accepts a new
12330 connection, it increments this variable. A copy of the variable is passed to
12331 the child process that handles the connection, but its value is fixed, and
12332 never changes. It is only an approximation of how many incoming connections
12333 there actually are, because many other connections may come and go while a
12334 single connection is being processed. When a child process terminates, the
12335 daemon decrements its copy of the variable.
12336
12337 .vitem "&$sn0$& &-- &$sn9$&"
12338 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
12339 that were current at the end of the system filter file. This allows a system
12340 filter file to set values that can be tested in users' filter files. For
12341 example, a system filter could set a value indicating how likely it is that a
12342 message is junk mail.
12343
12344 .vitem &$spam_$&&'xxx'&
12345 A number of variables whose names start with &$spam$& are available when Exim
12346 is compiled with the content-scanning extension. For details, see section
12347 &<<SECTscanspamass>>&.
12348
12349
12350 .vitem &$spool_directory$&
12351 .vindex "&$spool_directory$&"
12352 The name of Exim's spool directory.
12353
12354 .vitem &$spool_inodes$&
12355 .vindex "&$spool_inodes$&"
12356 The number of free inodes in the disk partition where Exim's spool files are
12357 being written. The value is recalculated whenever the variable is referenced.
12358 If the relevant file system does not have the concept of inodes, the value of
12359 is -1. See also the &%check_spool_inodes%& option.
12360
12361 .vitem &$spool_space$&
12362 .vindex "&$spool_space$&"
12363 The amount of free space (as a number of kilobytes) in the disk partition where
12364 Exim's spool files are being written. The value is recalculated whenever the
12365 variable is referenced. If the operating system does not have the ability to
12366 find the amount of free space (only true for experimental systems), the space
12367 value is -1. For example, to check in an ACL that there is at least 50
12368 megabytes free on the spool, you could write:
12369 .code
12370 condition = ${if > {$spool_space}{50000}}
12371 .endd
12372 See also the &%check_spool_space%& option.
12373
12374
12375 .vitem &$thisaddress$&
12376 .vindex "&$thisaddress$&"
12377 This variable is set only during the processing of the &%foranyaddress%&
12378 command in a filter file. Its use is explained in the description of that
12379 command, which can be found in the separate document entitled &'Exim's
12380 interfaces to mail filtering'&.
12381
12382 .vitem &$tls_in_bits$&
12383 .vindex "&$tls_in_bits$&"
12384 Contains an approximation of the TLS cipher's bit-strength
12385 on the inbound connection; the meaning of
12386 this depends upon the TLS implementation used.
12387 If TLS has not been negotiated, the value will be 0.
12388 The value of this is automatically fed into the Cyrus SASL authenticator
12389 when acting as a server, to specify the "external SSF" (a SASL term).
12390
12391 The deprecated &$tls_bits$& variable refers to the inbound side
12392 except when used in the context of an outbound SMTP delivery, when it refers to
12393 the outbound.
12394
12395 .vitem &$tls_out_bits$&
12396 .vindex "&$tls_out_bits$&"
12397 Contains an approximation of the TLS cipher's bit-strength
12398 on an outbound SMTP connection; the meaning of
12399 this depends upon the TLS implementation used.
12400 If TLS has not been negotiated, the value will be 0.
12401
12402 .vitem &$tls_in_ourcert$&
12403 .vindex "&$tls_in_ourcert$&"
12404 This variable refers to the certificate presented to the peer of an
12405 inbound connection when the message was received.
12406 It is only useful as the argument of a
12407 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12408 or a &%def%& condition.
12409
12410 .vitem &$tls_in_peercert$&
12411 .vindex "&$tls_in_peercert$&"
12412 This variable refers to the certificate presented by the peer of an
12413 inbound connection when the message was received.
12414 It is only useful as the argument of a
12415 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12416 or a &%def%& condition.
12417
12418 .vitem &$tls_out_ourcert$&
12419 .vindex "&$tls_out_ourcert$&"
12420 This variable refers to the certificate presented to the peer of an
12421 outbound connection.  It is only useful as the argument of a
12422 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12423 or a &%def%& condition.
12424
12425 .vitem &$tls_out_peercert$&
12426 .vindex "&$tls_out_peercert$&"
12427 This variable refers to the certificate presented by the peer of an
12428 outbound connection.  It is only useful as the argument of a
12429 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12430 or a &%def%& condition.
12431
12432 .vitem &$tls_in_certificate_verified$&
12433 .vindex "&$tls_in_certificate_verified$&"
12434 This variable is set to &"1"& if a TLS certificate was verified when the
12435 message was received, and &"0"& otherwise.
12436
12437 The deprecated &$tls_certificate_verfied$& variable refers to the inbound side
12438 except when used in the context of an outbound SMTP delivery, when it refers to
12439 the outbound.
12440
12441 .vitem &$tls_out_certificate_verified$&
12442 .vindex "&$tls_out_certificate_verified$&"
12443 This variable is set to &"1"& if a TLS certificate was verified when an
12444 outbound SMTP connection was made,
12445 and &"0"& otherwise.
12446
12447 .vitem &$tls_in_cipher$&
12448 .vindex "&$tls_in_cipher$&"
12449 .vindex "&$tls_cipher$&"
12450 When a message is received from a remote host over an encrypted SMTP
12451 connection, this variable is set to the cipher suite that was negotiated, for
12452 example DES-CBC3-SHA. In other circumstances, in particular, for message
12453 received over unencrypted connections, the variable is empty. Testing
12454 &$tls_cipher$& for emptiness is one way of distinguishing between encrypted and
12455 non-encrypted connections during ACL processing.
12456
12457 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
12458 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
12459 becomes the same as &$tls_out_cipher$&.
12460
12461 .vitem &$tls_out_cipher$&
12462 .vindex "&$tls_out_cipher$&"
12463 This variable is
12464 cleared before any outgoing SMTP connection is made,
12465 and then set to the outgoing cipher suite if one is negotiated. See chapter
12466 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
12467 details of the &(smtp)& transport.
12468
12469 .vitem &$tls_in_ocsp$&
12470 .vindex "&$tls_in_ocsp$&"
12471 When a message is received from a remote client connection
12472 the result of any OCSP request from the client is encoded in this variable:
12473 .code
12474 0 OCSP proof was not requested (default value)
12475 1 No response to request
12476 2 Response not verified
12477 3 Verification failed
12478 4 Verification succeeded
12479 .endd
12480
12481 .vitem &$tls_out_ocsp$&
12482 .vindex "&$tls_out_ocsp$&"
12483 When a message is sent to a remote host connection
12484 the result of any OCSP request made is encoded in this variable.
12485 See &$tls_in_ocsp$& for values.
12486
12487 .vitem &$tls_in_peerdn$&
12488 .vindex "&$tls_in_peerdn$&"
12489 .vindex "&$tls_peerdn$&"
12490 When a message is received from a remote host over an encrypted SMTP
12491 connection, and Exim is configured to request a certificate from the client,
12492 the value of the Distinguished Name of the certificate is made available in the
12493 &$tls_in_peerdn$& during subsequent processing.
12494
12495 The deprecated &$tls_peerdn$& variable refers to the inbound side
12496 except when used in the context of an outbound SMTP delivery, when it refers to
12497 the outbound.
12498
12499 .vitem &$tls_out_peerdn$&
12500 .vindex "&$tls_out_peerdn$&"
12501 When a message is being delivered to a remote host over an encrypted SMTP
12502 connection, and Exim is configured to request a certificate from the server,
12503 the value of the Distinguished Name of the certificate is made available in the
12504 &$tls_out_peerdn$& during subsequent processing.
12505
12506 .vitem &$tls_in_sni$&
12507 .vindex "&$tls_in_sni$&"
12508 .vindex "&$tls_sni$&"
12509 .cindex "TLS" "Server Name Indication"
12510 When a TLS session is being established, if the client sends the Server
12511 Name Indication extension, the value will be placed in this variable.
12512 If the variable appears in &%tls_certificate%& then this option and
12513 some others, described in &<<SECTtlssni>>&,
12514 will be re-expanded early in the TLS session, to permit
12515 a different certificate to be presented (and optionally a different key to be
12516 used) to the client, based upon the value of the SNI extension.
12517
12518 The deprecated &$tls_sni$& variable refers to the inbound side
12519 except when used in the context of an outbound SMTP delivery, when it refers to
12520 the outbound.
12521
12522 .vitem &$tls_out_sni$&
12523 .vindex "&$tls_out_sni$&"
12524 .cindex "TLS" "Server Name Indication"
12525 During outbound
12526 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
12527 the transport.
12528
12529 .vitem &$tod_bsdinbox$&
12530 .vindex "&$tod_bsdinbox$&"
12531 The time of day and the date, in the format required for BSD-style mailbox
12532 files, for example: Thu Oct 17 17:14:09 1995.
12533
12534 .vitem &$tod_epoch$&
12535 .vindex "&$tod_epoch$&"
12536 The time and date as a number of seconds since the start of the Unix epoch.
12537
12538 .vitem &$tod_epoch_l$&
12539 .vindex "&$tod_epoch_l$&"
12540 The time and date as a number of microseconds since the start of the Unix epoch.
12541
12542 .vitem &$tod_full$&
12543 .vindex "&$tod_full$&"
12544 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
12545 +0100. The timezone is always given as a numerical offset from UTC, with
12546 positive values used for timezones that are ahead (east) of UTC, and negative
12547 values for those that are behind (west).
12548
12549 .vitem &$tod_log$&
12550 .vindex "&$tod_log$&"
12551 The time and date in the format used for writing Exim's log files, for example:
12552 1995-10-12 15:32:29, but without a timezone.
12553
12554 .vitem &$tod_logfile$&
12555 .vindex "&$tod_logfile$&"
12556 This variable contains the date in the format yyyymmdd. This is the format that
12557 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
12558 flag.
12559
12560 .vitem &$tod_zone$&
12561 .vindex "&$tod_zone$&"
12562 This variable contains the numerical value of the local timezone, for example:
12563 -0500.
12564
12565 .vitem &$tod_zulu$&
12566 .vindex "&$tod_zulu$&"
12567 This variable contains the UTC date and time in &"Zulu"& format, as specified
12568 by ISO 8601, for example: 20030221154023Z.
12569
12570 .vitem &$transport_name$&
12571 .cindex "transport" "name"
12572 .cindex "name" "of transport"
12573 .vindex "&$transport_name$&"
12574 During the running of a transport, this variable contains its name.
12575
12576 .vitem &$value$&
12577 .vindex "&$value$&"
12578 This variable contains the result of an expansion lookup, extraction operation,
12579 or external command, as described above. It is also used during a
12580 &*reduce*& expansion.
12581
12582 .vitem &$verify_mode$&
12583 .vindex "&$verify_mode$&"
12584 While a router or transport is being run in verify mode
12585 or for cutthrough delivery,
12586 contains "S" for sender-verification or "R" for recipient-verification.
12587 Otherwise, empty.
12588
12589 .vitem &$version_number$&
12590 .vindex "&$version_number$&"
12591 The version number of Exim.
12592
12593 .vitem &$warn_message_delay$&
12594 .vindex "&$warn_message_delay$&"
12595 This variable is set only during the creation of a message warning about a
12596 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
12597
12598 .vitem &$warn_message_recipients$&
12599 .vindex "&$warn_message_recipients$&"
12600 This variable is set only during the creation of a message warning about a
12601 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
12602 .endlist
12603 .ecindex IIDstrexp
12604
12605
12606
12607 . ////////////////////////////////////////////////////////////////////////////
12608 . ////////////////////////////////////////////////////////////////////////////
12609
12610 .chapter "Embedded Perl" "CHAPperl"
12611 .scindex IIDperl "Perl" "calling from Exim"
12612 Exim can be built to include an embedded Perl interpreter. When this is done,
12613 Perl subroutines can be called as part of the string expansion process. To make
12614 use of the Perl support, you need version 5.004 or later of Perl installed on
12615 your system. To include the embedded interpreter in the Exim binary, include
12616 the line
12617 .code
12618 EXIM_PERL = perl.o
12619 .endd
12620 in your &_Local/Makefile_& and then build Exim in the normal way.
12621
12622
12623 .section "Setting up so Perl can be used" "SECID85"
12624 .oindex "&%perl_startup%&"
12625 Access to Perl subroutines is via a global configuration option called
12626 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
12627 no &%perl_startup%& option in the Exim configuration file then no Perl
12628 interpreter is started and there is almost no overhead for Exim (since none of
12629 the Perl library will be paged in unless used). If there is a &%perl_startup%&
12630 option then the associated value is taken to be Perl code which is executed in
12631 a newly created Perl interpreter.
12632
12633 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
12634 need backslashes before any characters to escape special meanings. The option
12635 should usually be something like
12636 .code
12637 perl_startup = do '/etc/exim.pl'
12638 .endd
12639 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
12640 use from Exim. Exim can be configured either to start up a Perl interpreter as
12641 soon as it is entered, or to wait until the first time it is needed. Starting
12642 the interpreter at the beginning ensures that it is done while Exim still has
12643 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
12644 fact used in a particular run. Also, note that this does not mean that Exim is
12645 necessarily running as root when Perl is called at a later time. By default,
12646 the interpreter is started only when it is needed, but this can be changed in
12647 two ways:
12648
12649 .ilist
12650 .oindex "&%perl_at_start%&"
12651 Setting &%perl_at_start%& (a boolean option) in the configuration requests
12652 a startup when Exim is entered.
12653 .next
12654 The command line option &%-ps%& also requests a startup when Exim is entered,
12655 overriding the setting of &%perl_at_start%&.
12656 .endlist
12657
12658 There is also a command line option &%-pd%& (for delay) which suppresses the
12659 initial startup, even if &%perl_at_start%& is set.
12660
12661
12662 .section "Calling Perl subroutines" "SECID86"
12663 When the configuration file includes a &%perl_startup%& option you can make use
12664 of the string expansion item to call the Perl subroutines that are defined
12665 by the &%perl_startup%& code. The operator is used in any of the following
12666 forms:
12667 .code
12668 ${perl{foo}}
12669 ${perl{foo}{argument}}
12670 ${perl{foo}{argument1}{argument2} ... }
12671 .endd
12672 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
12673 arguments may be passed. Passing more than this results in an expansion failure
12674 with an error message of the form
12675 .code
12676 Too many arguments passed to Perl subroutine "foo" (max is 8)
12677 .endd
12678 The return value of the Perl subroutine is evaluated in a scalar context before
12679 it is passed back to Exim to be inserted into the expanded string. If the
12680 return value is &'undef'&, the expansion is forced to fail in the same way as
12681 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
12682 by obeying Perl's &%die%& function, the expansion fails with the error message
12683 that was passed to &%die%&.
12684
12685
12686 .section "Calling Exim functions from Perl" "SECID87"
12687 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
12688 is available to call back into Exim's string expansion function. For example,
12689 the Perl code
12690 .code
12691 my $lp = Exim::expand_string('$local_part');
12692 .endd
12693 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
12694 Note those are single quotes and not double quotes to protect against
12695 &$local_part$& being interpolated as a Perl variable.
12696
12697 If the string expansion is forced to fail by a &"fail"& item, the result of
12698 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
12699 expansion string, the Perl call from the original expansion string fails with
12700 an appropriate error message, in the same way as if &%die%& were used.
12701
12702 .cindex "debugging" "from embedded Perl"
12703 .cindex "log" "writing from embedded Perl"
12704 Two other Exim functions are available for use from within Perl code.
12705 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
12706 debugging is enabled. If you want a newline at the end, you must supply it.
12707 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
12708 timestamp. In this case, you should not supply a terminating newline.
12709
12710
12711 .section "Use of standard output and error by Perl" "SECID88"
12712 .cindex "Perl" "standard output and error"
12713 You should not write to the standard error or output streams from within your
12714 Perl code, as it is not defined how these are set up. In versions of Exim
12715 before 4.50, it is possible for the standard output or error to refer to the
12716 SMTP connection during message reception via the daemon. Writing to this stream
12717 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
12718 error streams are connected to &_/dev/null_& in the daemon. The chaos is
12719 avoided, but the output is lost.
12720
12721 .cindex "Perl" "use of &%warn%&"
12722 The Perl &%warn%& statement writes to the standard error stream by default.
12723 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
12724 you have no control. When Exim starts up the Perl interpreter, it arranges for
12725 output from the &%warn%& statement to be written to the Exim main log. You can
12726 change this by including appropriate Perl magic somewhere in your Perl code.
12727 For example, to discard &%warn%& output completely, you need this:
12728 .code
12729 $SIG{__WARN__} = sub { };
12730 .endd
12731 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
12732 example, the code for the subroutine is empty, so it does nothing, but you can
12733 include any Perl code that you like. The text of the &%warn%& message is passed
12734 as the first subroutine argument.
12735 .ecindex IIDperl
12736
12737
12738 . ////////////////////////////////////////////////////////////////////////////
12739 . ////////////////////////////////////////////////////////////////////////////
12740
12741 .chapter "Starting the daemon and the use of network interfaces" &&&
12742          "CHAPinterfaces" &&&
12743          "Starting the daemon"
12744 .cindex "daemon" "starting"
12745 .cindex "interface" "listening"
12746 .cindex "network interface"
12747 .cindex "interface" "network"
12748 .cindex "IP address" "for listening"
12749 .cindex "daemon" "listening IP addresses"
12750 .cindex "TCP/IP" "setting listening interfaces"
12751 .cindex "TCP/IP" "setting listening ports"
12752 A host that is connected to a TCP/IP network may have one or more physical
12753 hardware network interfaces. Each of these interfaces may be configured as one
12754 or more &"logical"& interfaces, which are the entities that a program actually
12755 works with. Each of these logical interfaces is associated with an IP address.
12756 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
12757 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
12758 knowledge about the host's interfaces for use in three different circumstances:
12759
12760 .olist
12761 When a listening daemon is started, Exim needs to know which interfaces
12762 and ports to listen on.
12763 .next
12764 When Exim is routing an address, it needs to know which IP addresses
12765 are associated with local interfaces. This is required for the correct
12766 processing of MX lists by removing the local host and others with the
12767 same or higher priority values. Also, Exim needs to detect cases
12768 when an address is routed to an IP address that in fact belongs to the
12769 local host. Unless the &%self%& router option or the &%allow_localhost%&
12770 option of the smtp transport is set (as appropriate), this is treated
12771 as an error situation.
12772 .next
12773 When Exim connects to a remote host, it may need to know which interface to use
12774 for the outgoing connection.
12775 .endlist
12776
12777
12778 Exim's default behaviour is likely to be appropriate in the vast majority
12779 of cases. If your host has only one interface, and you want all its IP
12780 addresses to be treated in the same way, and you are using only the
12781 standard SMTP port, you should not need to take any special action. The
12782 rest of this chapter does not apply to you.
12783
12784 In a more complicated situation you may want to listen only on certain
12785 interfaces, or on different ports, and for this reason there are a number of
12786 options that can be used to influence Exim's behaviour. The rest of this
12787 chapter describes how they operate.
12788
12789 When a message is received over TCP/IP, the interface and port that were
12790 actually used are set in &$received_ip_address$& and &$received_port$&.
12791
12792
12793
12794 .section "Starting a listening daemon" "SECID89"
12795 When a listening daemon is started (by means of the &%-bd%& command line
12796 option), the interfaces and ports on which it listens are controlled by the
12797 following options:
12798
12799 .ilist
12800 &%daemon_smtp_ports%& contains a list of default ports
12801 or service names.
12802 (For backward compatibility, this option can also be specified in the singular.)
12803 .next
12804 &%local_interfaces%& contains list of interface IP addresses on which to
12805 listen. Each item may optionally also specify a port.
12806 .endlist
12807
12808 The default list separator in both cases is a colon, but this can be changed as
12809 described in section &<<SECTlistconstruct>>&. When IPv6 addresses are involved,
12810 it is usually best to change the separator to avoid having to double all the
12811 colons. For example:
12812 .code
12813 local_interfaces = <; 127.0.0.1 ; \
12814                       192.168.23.65 ; \
12815                       ::1 ; \
12816                       3ffe:ffff:836f::fe86:a061
12817 .endd
12818 There are two different formats for specifying a port along with an IP address
12819 in &%local_interfaces%&:
12820
12821 .olist
12822 The port is added onto the address with a dot separator. For example, to listen
12823 on port 1234 on two different IP addresses:
12824 .code
12825 local_interfaces = <; 192.168.23.65.1234 ; \
12826                       3ffe:ffff:836f::fe86:a061.1234
12827 .endd
12828 .next
12829 The IP address is enclosed in square brackets, and the port is added
12830 with a colon separator, for example:
12831 .code
12832 local_interfaces = <; [192.168.23.65]:1234 ; \
12833                       [3ffe:ffff:836f::fe86:a061]:1234
12834 .endd
12835 .endlist
12836
12837 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
12838 default setting contains just one port:
12839 .code
12840 daemon_smtp_ports = smtp
12841 .endd
12842 If more than one port is listed, each interface that does not have its own port
12843 specified listens on all of them. Ports that are listed in
12844 &%daemon_smtp_ports%& can be identified either by name (defined in
12845 &_/etc/services_&) or by number. However, when ports are given with individual
12846 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
12847
12848
12849
12850 .section "Special IP listening addresses" "SECID90"
12851 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
12852 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
12853 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
12854 instead of setting up separate listening sockets for each interface. The
12855 default value of &%local_interfaces%& is
12856 .code
12857 local_interfaces = 0.0.0.0
12858 .endd
12859 when Exim is built without IPv6 support; otherwise it is:
12860 .code
12861 local_interfaces = <; ::0 ; 0.0.0.0
12862 .endd
12863 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
12864
12865
12866
12867 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
12868 The &%-oX%& command line option can be used to override the values of
12869 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
12870 instance. Another way of doing this would be to use macros and the &%-D%&
12871 option. However, &%-oX%& can be used by any admin user, whereas modification of
12872 the runtime configuration by &%-D%& is allowed only when the caller is root or
12873 exim.
12874
12875 The value of &%-oX%& is a list of items. The default colon separator can be
12876 changed in the usual way if required. If there are any items that do not
12877 contain dots or colons (that is, are not IP addresses), the value of
12878 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
12879 items that do contain dots or colons, the value of &%local_interfaces%& is
12880 replaced by those items. Thus, for example,
12881 .code
12882 -oX 1225
12883 .endd
12884 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
12885 whereas
12886 .code
12887 -oX 192.168.34.5.1125
12888 .endd
12889 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
12890 (However, since &%local_interfaces%& now contains no items without ports, the
12891 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
12892
12893
12894
12895 .section "Support for the obsolete SSMTP (or SMTPS) protocol" "SECTsupobssmt"
12896 .cindex "ssmtp protocol"
12897 .cindex "smtps protocol"
12898 .cindex "SMTP" "ssmtp protocol"
12899 .cindex "SMTP" "smtps protocol"
12900 Exim supports the obsolete SSMTP protocol (also known as SMTPS) that was used
12901 before the STARTTLS command was standardized for SMTP. Some legacy clients
12902 still use this protocol. If the &%tls_on_connect_ports%& option is set to a
12903 list of port numbers or service names,
12904 connections to those ports must use SSMTP. The most
12905 common use of this option is expected to be
12906 .code
12907 tls_on_connect_ports = 465
12908 .endd
12909 because 465 is the usual port number used by the legacy clients. There is also
12910 a command line option &%-tls-on-connect%&, which forces all ports to behave in
12911 this way when a daemon is started.
12912
12913 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
12914 daemon to listen on those ports. You must still specify them in
12915 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
12916 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
12917 connections via the daemon.)
12918
12919
12920
12921
12922 .section "IPv6 address scopes" "SECID92"
12923 .cindex "IPv6" "address scopes"
12924 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
12925 can, in principle, have the same link-local IPv6 address on different
12926 interfaces. Thus, additional information is needed, over and above the IP
12927 address, to distinguish individual interfaces. A convention of using a
12928 percent sign followed by something (often the interface name) has been
12929 adopted in some cases, leading to addresses like this:
12930 .code
12931 fe80::202:b3ff:fe03:45c1%eth0
12932 .endd
12933 To accommodate this usage, a percent sign followed by an arbitrary string is
12934 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
12935 to convert a textual IPv6 address for actual use. This function recognizes the
12936 percent convention in operating systems that support it, and it processes the
12937 address appropriately. Unfortunately, some older libraries have problems with
12938 &[getaddrinfo()]&. If
12939 .code
12940 IPV6_USE_INET_PTON=yes
12941 .endd
12942 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
12943 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
12944 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
12945 function.) Of course, this means that the additional functionality of
12946 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
12947
12948 .section "Disabling IPv6" "SECID93"
12949 .cindex "IPv6" "disabling"
12950 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
12951 run on a host whose kernel does not support IPv6. The binary will fall back to
12952 using IPv4, but it may waste resources looking up AAAA records, and trying to
12953 connect to IPv6 addresses, causing delays to mail delivery. If you set the
12954 .oindex "&%disable_ipv6%&"
12955 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
12956 activities take place. AAAA records are never looked up, and any IPv6 addresses
12957 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
12958 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
12959 to handle IPv6 literal addresses.
12960
12961 On the other hand, when IPv6 is in use, there may be times when you want to
12962 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
12963 option to globally suppress the lookup of AAAA records for specified domains,
12964 and you can use the &%ignore_target_hosts%& generic router option to ignore
12965 IPv6 addresses in an individual router.
12966
12967
12968
12969 .section "Examples of starting a listening daemon" "SECID94"
12970 The default case in an IPv6 environment is
12971 .code
12972 daemon_smtp_ports = smtp
12973 local_interfaces = <; ::0 ; 0.0.0.0
12974 .endd
12975 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
12976 Either one or two sockets may be used, depending on the characteristics of
12977 the TCP/IP stack. (This is complicated and messy; for more information,
12978 read the comments in the &_daemon.c_& source file.)
12979
12980 To specify listening on ports 25 and 26 on all interfaces:
12981 .code
12982 daemon_smtp_ports = 25 : 26
12983 .endd
12984 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
12985 .code
12986 local_interfaces = <; ::0.25     ; ::0.26 \
12987                       0.0.0.0.25 ; 0.0.0.0.26
12988 .endd
12989 To listen on the default port on all IPv4 interfaces, and on port 26 on the
12990 IPv4 loopback address only:
12991 .code
12992 local_interfaces = 0.0.0.0 : 127.0.0.1.26
12993 .endd
12994 To specify listening on the default port on specific interfaces only:
12995 .code
12996 local_interfaces = 10.0.0.67 : 192.168.34.67
12997 .endd
12998 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
12999
13000
13001
13002 .section "Recognizing the local host" "SECTreclocipadd"
13003 The &%local_interfaces%& option is also used when Exim needs to determine
13004 whether or not an IP address refers to the local host. That is, the IP
13005 addresses of all the interfaces on which a daemon is listening are always
13006 treated as local.
13007
13008 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
13009 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
13010 available interfaces from the operating system, and extracts the relevant
13011 (that is, IPv4 or IPv6) addresses to use for checking.
13012
13013 Some systems set up large numbers of virtual interfaces in order to provide
13014 many virtual web servers. In this situation, you may want to listen for
13015 email on only a few of the available interfaces, but nevertheless treat all
13016 interfaces as local when routing. You can do this by setting
13017 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
13018 &"all"& wildcard values. These addresses are recognized as local, but are not
13019 used for listening. Consider this example:
13020 .code
13021 local_interfaces = <; 127.0.0.1 ; ::1 ; \
13022                       192.168.53.235 ; \
13023                       3ffe:2101:12:1:a00:20ff:fe86:a061
13024
13025 extra_local_interfaces = <; ::0 ; 0.0.0.0
13026 .endd
13027 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
13028 address, but all available interface addresses are treated as local when
13029 Exim is routing.
13030
13031 In some environments the local host name may be in an MX list, but with an IP
13032 address that is not assigned to any local interface. In other cases it may be
13033 desirable to treat other host names as if they referred to the local host. Both
13034 these cases can be handled by setting the &%hosts_treat_as_local%& option.
13035 This contains host names rather than IP addresses. When a host is referenced
13036 during routing, either via an MX record or directly, it is treated as the local
13037 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
13038 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
13039
13040
13041
13042 .section "Delivering to a remote host" "SECID95"
13043 Delivery to a remote host is handled by the smtp transport. By default, it
13044 allows the system's TCP/IP functions to choose which interface to use (if
13045 there is more than one) when connecting to a remote host. However, the
13046 &%interface%& option can be set to specify which interface is used. See the
13047 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
13048 details.
13049
13050
13051
13052
13053 . ////////////////////////////////////////////////////////////////////////////
13054 . ////////////////////////////////////////////////////////////////////////////
13055
13056 .chapter "Main configuration" "CHAPmainconfig"
13057 .scindex IIDconfima "configuration file" "main section"
13058 .scindex IIDmaiconf "main configuration"
13059 The first part of the run time configuration file contains three types of item:
13060
13061 .ilist
13062 Macro definitions: These lines start with an upper case letter. See section
13063 &<<SECTmacrodefs>>& for details of macro processing.
13064 .next
13065 Named list definitions: These lines start with one of the words &"domainlist"&,
13066 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
13067 section &<<SECTnamedlists>>&.
13068 .next
13069 Main configuration settings: Each setting occupies one line of the file
13070 (with possible continuations). If any setting is preceded by the word
13071 &"hide"&, the &%-bP%& command line option displays its value to admin users
13072 only. See section &<<SECTcos>>& for a description of the syntax of these option
13073 settings.
13074 .endlist
13075
13076 This chapter specifies all the main configuration options, along with their
13077 types and default values. For ease of finding a particular option, they appear
13078 in alphabetical order in section &<<SECTalomo>>& below. However, because there
13079 are now so many options, they are first listed briefly in functional groups, as
13080 an aid to finding the name of the option you are looking for. Some options are
13081 listed in more than one group.
13082
13083 .section "Miscellaneous" "SECID96"
13084 .table2
13085 .row &%bi_command%&                  "to run for &%-bi%& command line option"
13086 .row &%disable_ipv6%&                "do no IPv6 processing"
13087 .row &%keep_malformed%&              "for broken files &-- should not happen"
13088 .row &%localhost_number%&            "for unique message ids in clusters"
13089 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
13090 .row &%message_body_visible%&        "how much to show in &$message_body$&"
13091 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
13092 .row &%print_topbitchars%&           "top-bit characters are printing"
13093 .row &%timezone%&                    "force time zone"
13094 .endtable
13095
13096
13097 .section "Exim parameters" "SECID97"
13098 .table2
13099 .row &%exim_group%&                  "override compiled-in value"
13100 .row &%exim_path%&                   "override compiled-in value"
13101 .row &%exim_user%&                   "override compiled-in value"
13102 .row &%primary_hostname%&            "default from &[uname()]&"
13103 .row &%split_spool_directory%&       "use multiple directories"
13104 .row &%spool_directory%&             "override compiled-in value"
13105 .endtable
13106
13107
13108
13109 .section "Privilege controls" "SECID98"
13110 .table2
13111 .row &%admin_groups%&                "groups that are Exim admin users"
13112 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
13113 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
13114 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
13115 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
13116 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
13117 .row &%never_users%&                 "do not run deliveries as these"
13118 .row &%prod_requires_admin%&         "forced delivery requires admin user"
13119 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
13120 .row &%trusted_groups%&              "groups that are trusted"
13121 .row &%trusted_users%&               "users that are trusted"
13122 .endtable
13123
13124
13125
13126 .section "Logging" "SECID99"
13127 .table2
13128 .row &%hosts_connection_nolog%&      "exemption from connect logging"
13129 .row &%log_file_path%&               "override compiled-in value"
13130 .row &%log_selector%&                "set/unset optional logging"
13131 .row &%log_timezone%&                "add timezone to log lines"
13132 .row &%message_logs%&                "create per-message logs"
13133 .row &%preserve_message_logs%&       "after message completion"
13134 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
13135 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
13136 .row &%syslog_facility%&             "set syslog &""facility""& field"
13137 .row &%syslog_processname%&          "set syslog &""ident""& field"
13138 .row &%syslog_timestamp%&            "timestamp syslog lines"
13139 .row &%write_rejectlog%&             "control use of message log"
13140 .endtable
13141
13142
13143
13144 .section "Frozen messages" "SECID100"
13145 .table2
13146 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
13147 .row &%freeze_tell%&                 "send message when freezing"
13148 .row &%move_frozen_messages%&        "to another directory"
13149 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
13150 .endtable
13151
13152
13153
13154 .section "Data lookups" "SECID101"
13155 .table2
13156 .row &%ibase_servers%&               "InterBase servers"
13157 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
13158 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
13159 .row &%ldap_cert_file%&              "client cert file for LDAP"
13160 .row &%ldap_cert_key%&               "client key file for LDAP"
13161 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
13162 .row &%ldap_default_servers%&        "used if no server in query"
13163 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
13164 .row &%ldap_start_tls%&              "require TLS within LDAP"
13165 .row &%ldap_version%&                "set protocol version"
13166 .row &%lookup_open_max%&             "lookup files held open"
13167 .row &%mysql_servers%&               "default MySQL servers"
13168 .row &%oracle_servers%&              "Oracle servers"
13169 .row &%pgsql_servers%&               "default PostgreSQL servers"
13170 .row &%sqlite_lock_timeout%&         "as it says"
13171 .endtable
13172
13173
13174
13175 .section "Message ids" "SECID102"
13176 .table2
13177 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
13178 .row &%message_id_header_text%&      "ditto"
13179 .endtable
13180
13181
13182
13183 .section "Embedded Perl Startup" "SECID103"
13184 .table2
13185 .row &%perl_at_start%&               "always start the interpreter"
13186 .row &%perl_startup%&                "code to obey when starting Perl"
13187 .endtable
13188
13189
13190
13191 .section "Daemon" "SECID104"
13192 .table2
13193 .row &%daemon_smtp_ports%&           "default ports"
13194 .row &%daemon_startup_retries%&      "number of times to retry"
13195 .row &%daemon_startup_sleep%&        "time to sleep between tries"
13196 .row &%extra_local_interfaces%&      "not necessarily listened on"
13197 .row &%local_interfaces%&            "on which to listen, with optional ports"
13198 .row &%pid_file_path%&               "override compiled-in value"
13199 .row &%queue_run_max%&               "maximum simultaneous queue runners"
13200 .endtable
13201
13202
13203
13204 .section "Resource control" "SECID105"
13205 .table2
13206 .row &%check_log_inodes%&            "before accepting a message"
13207 .row &%check_log_space%&             "before accepting a message"
13208 .row &%check_spool_inodes%&          "before accepting a message"
13209 .row &%check_spool_space%&           "before accepting a message"
13210 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
13211 .row &%queue_only_load%&             "queue incoming if load high"
13212 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13213 .row &%queue_run_max%&               "maximum simultaneous queue runners"
13214 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13215 .row &%smtp_accept_max%&             "simultaneous incoming connections"
13216 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
13217 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
13218 .row &%smtp_accept_max_per_connection%& "messages per connection"
13219 .row &%smtp_accept_max_per_host%&    "connections from one host"
13220 .row &%smtp_accept_queue%&           "queue mail if more connections"
13221 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
13222                                            connection"
13223 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
13224 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
13225 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
13226 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
13227 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
13228 .endtable
13229
13230
13231
13232 .section "Policy controls" "SECID106"
13233 .table2
13234 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
13235 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
13236 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
13237 .row &%acl_smtp_auth%&               "ACL for AUTH"
13238 .row &%acl_smtp_connect%&            "ACL for connection"
13239 .row &%acl_smtp_data%&               "ACL for DATA"
13240 .row &%acl_smtp_data_prdr%&          "ACL for DATA, per-recipient"
13241 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
13242 .row &%acl_smtp_etrn%&               "ACL for ETRN"
13243 .row &%acl_smtp_expn%&               "ACL for EXPN"
13244 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
13245 .row &%acl_smtp_mail%&               "ACL for MAIL"
13246 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
13247 .row &%acl_smtp_mime%&               "ACL for MIME parts"
13248 .row &%acl_smtp_predata%&            "ACL for start of data"
13249 .row &%acl_smtp_quit%&               "ACL for QUIT"
13250 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
13251 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
13252 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
13253 .row &%av_scanner%&                  "specify virus scanner"
13254 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13255                                       words""&"
13256 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
13257 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
13258 .row &%header_maxsize%&              "total size of message header"
13259 .row &%header_line_maxsize%&         "individual header line limit"
13260 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
13261 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
13262 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
13263 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
13264 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
13265 .row &%host_lookup%&                 "host name looked up for these hosts"
13266 .row &%host_lookup_order%&           "order of DNS and local name lookups"
13267 .row &%host_reject_connection%&      "reject connection from these hosts"
13268 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
13269 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
13270 .row &%message_size_limit%&          "for all messages"
13271 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
13272 .row &%spamd_address%&               "set interface to SpamAssassin"
13273 .row &%strict_acl_vars%&             "object to unset ACL variables"
13274 .endtable
13275
13276
13277
13278 .section "Callout cache" "SECID107"
13279 .table2
13280 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
13281                                          item"
13282 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
13283                                          item"
13284 .row &%callout_negative_expire%&     "timeout for negative address cache item"
13285 .row &%callout_positive_expire%&     "timeout for positive address cache item"
13286 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
13287 .endtable
13288
13289
13290
13291 .section "TLS" "SECID108"
13292 .table2
13293 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
13294 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
13295 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
13296 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13297 .row &%tls_certificate%&             "location of server certificate"
13298 .row &%tls_crl%&                     "certificate revocation list"
13299 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
13300 .row &%tls_dhparam%&                 "DH parameters for server"
13301 .row &%tls_ocsp_file%&               "location of server certificate status proof"
13302 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
13303 .row &%tls_privatekey%&              "location of server private key"
13304 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
13305 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
13306 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
13307 .row &%tls_verify_certificates%&     "expected client certificates"
13308 .row &%tls_verify_hosts%&            "insist on client certificate verify"
13309 .endtable
13310
13311
13312
13313 .section "Local user handling" "SECID109"
13314 .table2
13315 .row &%finduser_retries%&            "useful in NIS environments"
13316 .row &%gecos_name%&                  "used when creating &'Sender:'&"
13317 .row &%gecos_pattern%&               "ditto"
13318 .row &%max_username_length%&         "for systems that truncate"
13319 .row &%unknown_login%&               "used when no login name found"
13320 .row &%unknown_username%&            "ditto"
13321 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
13322 .row &%uucp_from_sender%&            "ditto"
13323 .endtable
13324
13325
13326
13327 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
13328 .table2
13329 .row &%header_maxsize%&              "total size of message header"
13330 .row &%header_line_maxsize%&         "individual header line limit"
13331 .row &%message_size_limit%&          "applies to all messages"
13332 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
13333 .row &%received_header_text%&        "expanded to make &'Received:'&"
13334 .row &%received_headers_max%&        "for mail loop detection"
13335 .row &%recipients_max%&              "limit per message"
13336 .row &%recipients_max_reject%&       "permanently reject excess recipients"
13337 .endtable
13338
13339
13340
13341
13342 .section "Non-SMTP incoming messages" "SECID111"
13343 .table2
13344 .row &%receive_timeout%&             "for non-SMTP messages"
13345 .endtable
13346
13347
13348
13349
13350
13351 .section "Incoming SMTP messages" "SECID112"
13352 See also the &'Policy controls'& section above.
13353
13354 .table2
13355 .row &%host_lookup%&                 "host name looked up for these hosts"
13356 .row &%host_lookup_order%&           "order of DNS and local name lookups"
13357 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
13358 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
13359 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
13360 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
13361 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
13362 .row &%smtp_accept_max%&             "simultaneous incoming connections"
13363 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
13364 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
13365 .row &%smtp_accept_max_per_connection%& "messages per connection"
13366 .row &%smtp_accept_max_per_host%&    "connections from one host"
13367 .row &%smtp_accept_queue%&           "queue mail if more connections"
13368 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
13369                                            connection"
13370 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
13371 .row &%smtp_active_hostname%&        "host name to use in messages"
13372 .row &%smtp_banner%&                 "text for welcome banner"
13373 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
13374 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
13375 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
13376 .row &%smtp_etrn_command%&           "what to run for ETRN"
13377 .row &%smtp_etrn_serialize%&         "only one at once"
13378 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
13379 .row &%smtp_max_unknown_commands%&   "before dropping connection"
13380 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
13381 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
13382 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
13383 .row &%smtp_receive_timeout%&        "per command or data line"
13384 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
13385 .row &%smtp_return_error_details%&   "give detail on rejections"
13386 .endtable
13387
13388
13389
13390 .section "SMTP extensions" "SECID113"
13391 .table2
13392 .row &%accept_8bitmime%&             "advertise 8BITMIME"
13393 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
13394 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
13395 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
13396 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
13397 .row &%prdr_enable%&                 "advertise PRDR to all hosts"
13398 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13399 .endtable
13400
13401
13402
13403 .section "Processing messages" "SECID114"
13404 .table2
13405 .row &%allow_domain_literals%&       "recognize domain literal syntax"
13406 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
13407 .row &%allow_utf8_domains%&          "in addresses"
13408 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13409                                       words""&"
13410 .row &%delivery_date_remove%&        "from incoming messages"
13411 .row &%envelope_to_remove%&          "from incoming messages"
13412 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
13413 .row &%headers_charset%&             "default for translations"
13414 .row &%qualify_domain%&              "default for senders"
13415 .row &%qualify_recipient%&           "default for recipients"
13416 .row &%return_path_remove%&          "from incoming messages"
13417 .row &%strip_excess_angle_brackets%& "in addresses"
13418 .row &%strip_trailing_dot%&          "at end of addresses"
13419 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
13420 .endtable
13421
13422
13423
13424 .section "System filter" "SECID115"
13425 .table2
13426 .row &%system_filter%&               "locate system filter"
13427 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
13428                                             directory"
13429 .row &%system_filter_file_transport%& "transport for delivery to a file"
13430 .row &%system_filter_group%&         "group for filter running"
13431 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
13432 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
13433 .row &%system_filter_user%&          "user for filter running"
13434 .endtable
13435
13436
13437
13438 .section "Routing and delivery" "SECID116"
13439 .table2
13440 .row &%disable_ipv6%&                "do no IPv6 processing"
13441 .row &%dns_again_means_nonexist%&    "for broken domains"
13442 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
13443 .row &%dns_dnssec_ok%&               "parameter for resolver"
13444 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
13445 .row &%dns_retrans%&                 "parameter for resolver"
13446 .row &%dns_retry%&                   "parameter for resolver"
13447 .row &%dns_use_edns0%&               "parameter for resolver"
13448 .row &%hold_domains%&                "hold delivery for these domains"
13449 .row &%local_interfaces%&            "for routing checks"
13450 .row &%queue_domains%&               "no immediate delivery for these"
13451 .row &%queue_only%&                  "no immediate delivery at all"
13452 .row &%queue_only_file%&             "no immediate delivery if file exists"
13453 .row &%queue_only_load%&             "no immediate delivery if load is high"
13454 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13455 .row &%queue_only_override%&         "allow command line to override"
13456 .row &%queue_run_in_order%&          "order of arrival"
13457 .row &%queue_run_max%&               "of simultaneous queue runners"
13458 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
13459 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13460 .row &%remote_sort_domains%&         "order of remote deliveries"
13461 .row &%retry_data_expire%&           "timeout for retry data"
13462 .row &%retry_interval_max%&          "safety net for retry rules"
13463 .endtable
13464
13465
13466
13467 .section "Bounce and warning messages" "SECID117"
13468 .table2
13469 .row &%bounce_message_file%&         "content of bounce"
13470 .row &%bounce_message_text%&         "content of bounce"
13471 .row &%bounce_return_body%&          "include body if returning message"
13472 .row &%bounce_return_message%&       "include original message in bounce"
13473 .row &%bounce_return_size_limit%&    "limit on returned message"
13474 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
13475 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
13476 .row &%errors_copy%&                 "copy bounce messages"
13477 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
13478 .row &%delay_warning%&               "time schedule"
13479 .row &%delay_warning_condition%&     "condition for warning messages"
13480 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
13481 .row &%smtp_return_error_details%&   "give detail on rejections"
13482 .row &%warn_message_file%&           "content of warning message"
13483 .endtable
13484
13485
13486
13487 .section "Alphabetical list of main options" "SECTalomo"
13488 Those options that undergo string expansion before use are marked with
13489 &dagger;.
13490
13491 .option accept_8bitmime main boolean true
13492 .cindex "8BITMIME"
13493 .cindex "8-bit characters"
13494 .cindex "log" "selectors"
13495 .cindex "log" "8BITMIME"
13496 This option causes Exim to send 8BITMIME in its response to an SMTP
13497 EHLO command, and to accept the BODY= parameter on MAIL commands.
13498 However, though Exim is 8-bit clean, it is not a protocol converter, and it
13499 takes no steps to do anything special with messages received by this route.
13500
13501 Historically Exim kept this option off by default, but the maintainers
13502 feel that in today's Internet, this causes more problems than it solves.
13503 It now defaults to true.
13504 A more detailed analysis of the issues is provided by Dan Bernstein:
13505 .display
13506 &url(http://cr.yp.to/smtp/8bitmime.html)
13507 .endd
13508
13509 To log received 8BITMIME status use
13510 .code
13511 log_selector = +8bitmime
13512 .endd
13513
13514 .option acl_not_smtp main string&!! unset
13515 .cindex "&ACL;" "for non-SMTP messages"
13516 .cindex "non-SMTP messages" "ACLs for"
13517 This option defines the ACL that is run when a non-SMTP message has been
13518 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
13519 further details.
13520
13521 .option acl_not_smtp_mime main string&!! unset
13522 This option defines the ACL that is run for individual MIME parts of non-SMTP
13523 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
13524 SMTP messages.
13525
13526 .option acl_not_smtp_start main string&!! unset
13527 .cindex "&ACL;" "at start of non-SMTP message"
13528 .cindex "non-SMTP messages" "ACLs for"
13529 This option defines the ACL that is run before Exim starts reading a
13530 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
13531
13532 .option acl_smtp_auth main string&!! unset
13533 .cindex "&ACL;" "setting up for SMTP commands"
13534 .cindex "AUTH" "ACL for"
13535 This option defines the ACL that is run when an SMTP AUTH command is
13536 received. See chapter &<<CHAPACL>>& for further details.
13537
13538 .option acl_smtp_connect main string&!! unset
13539 .cindex "&ACL;" "on SMTP connection"
13540 This option defines the ACL that is run when an SMTP connection is received.
13541 See chapter &<<CHAPACL>>& for further details.
13542
13543 .option acl_smtp_data main string&!! unset
13544 .cindex "DATA" "ACL for"
13545 This option defines the ACL that is run after an SMTP DATA command has been
13546 processed and the message itself has been received, but before the final
13547 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
13548
13549 .option acl_smtp_data_prdr main string&!! accept
13550 .cindex "PRDR" "ACL for"
13551 .cindex "DATA" "PRDR ACL for"
13552 .cindex "&ACL;" "PRDR-related"
13553 .cindex "&ACL;" "per-user data processing"
13554 This option defines the ACL that,
13555 if the PRDR feature has been negotiated,
13556 is run for each recipient after an SMTP DATA command has been
13557 processed and the message itself has been received, but before the
13558 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
13559
13560 .option acl_smtp_etrn main string&!! unset
13561 .cindex "ETRN" "ACL for"
13562 This option defines the ACL that is run when an SMTP ETRN command is
13563 received. See chapter &<<CHAPACL>>& for further details.
13564
13565 .option acl_smtp_expn main string&!! unset
13566 .cindex "EXPN" "ACL for"
13567 This option defines the ACL that is run when an SMTP EXPN command is
13568 received. See chapter &<<CHAPACL>>& for further details.
13569
13570 .option acl_smtp_helo main string&!! unset
13571 .cindex "EHLO" "ACL for"
13572 .cindex "HELO" "ACL for"
13573 This option defines the ACL that is run when an SMTP EHLO or HELO
13574 command is received. See chapter &<<CHAPACL>>& for further details.
13575
13576
13577 .option acl_smtp_mail main string&!! unset
13578 .cindex "MAIL" "ACL for"
13579 This option defines the ACL that is run when an SMTP MAIL command is
13580 received. See chapter &<<CHAPACL>>& for further details.
13581
13582 .option acl_smtp_mailauth main string&!! unset
13583 .cindex "AUTH" "on MAIL command"
13584 This option defines the ACL that is run when there is an AUTH parameter on
13585 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
13586 &<<CHAPSMTPAUTH>>& for details of authentication.
13587
13588 .option acl_smtp_mime main string&!! unset
13589 .cindex "MIME content scanning" "ACL for"
13590 This option is available when Exim is built with the content-scanning
13591 extension. It defines the ACL that is run for each MIME part in a message. See
13592 section &<<SECTscanmimepart>>& for details.
13593
13594 .option acl_smtp_predata main string&!! unset
13595 This option defines the ACL that is run when an SMTP DATA command is
13596 received, before the message itself is received. See chapter &<<CHAPACL>>& for
13597 further details.
13598
13599 .option acl_smtp_quit main string&!! unset
13600 .cindex "QUIT, ACL for"
13601 This option defines the ACL that is run when an SMTP QUIT command is
13602 received. See chapter &<<CHAPACL>>& for further details.
13603
13604 .option acl_smtp_rcpt main string&!! unset
13605 .cindex "RCPT" "ACL for"
13606 This option defines the ACL that is run when an SMTP RCPT command is
13607 received. See chapter &<<CHAPACL>>& for further details.
13608
13609 .option acl_smtp_starttls main string&!! unset
13610 .cindex "STARTTLS, ACL for"
13611 This option defines the ACL that is run when an SMTP STARTTLS command is
13612 received. See chapter &<<CHAPACL>>& for further details.
13613
13614 .option acl_smtp_vrfy main string&!! unset
13615 .cindex "VRFY" "ACL for"
13616 This option defines the ACL that is run when an SMTP VRFY command is
13617 received. See chapter &<<CHAPACL>>& for further details.
13618
13619 .option admin_groups main "string list&!!" unset
13620 .cindex "admin user"
13621 This option is expanded just once, at the start of Exim's processing. If the
13622 current group or any of the supplementary groups of an Exim caller is in this
13623 colon-separated list, the caller has admin privileges. If all your system
13624 programmers are in a specific group, for example, you can give them all Exim
13625 admin privileges by putting that group in &%admin_groups%&. However, this does
13626 not permit them to read Exim's spool files (whose group owner is the Exim gid).
13627 To permit this, you have to add individuals to the Exim group.
13628
13629 .option allow_domain_literals main boolean false
13630 .cindex "domain literal"
13631 If this option is set, the RFC 2822 domain literal format is permitted in
13632 email addresses. The option is not set by default, because the domain literal
13633 format is not normally required these days, and few people know about it. It
13634 has, however, been exploited by mail abusers.
13635
13636 Unfortunately, it seems that some DNS black list maintainers are using this
13637 format to report black listing to postmasters. If you want to accept messages
13638 addressed to your hosts by IP address, you need to set
13639 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
13640 domains (defined in the named domain list &%local_domains%& in the default
13641 configuration). This &"magic string"& matches the domain literal form of all
13642 the local host's IP addresses.
13643
13644
13645 .option allow_mx_to_ip main boolean false
13646 .cindex "MX record" "pointing to IP address"
13647 It appears that more and more DNS zone administrators are breaking the rules
13648 and putting domain names that look like IP addresses on the right hand side of
13649 MX records. Exim follows the rules and rejects this, giving an error message
13650 that explains the mis-configuration. However, some other MTAs support this
13651 practice, so to avoid &"Why can't Exim do this?"& complaints,
13652 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
13653 recommended, except when you have no other choice.
13654
13655 .option allow_utf8_domains main boolean false
13656 .cindex "domain" "UTF-8 characters in"
13657 .cindex "UTF-8" "in domain name"
13658 Lots of discussion is going on about internationalized domain names. One
13659 camp is strongly in favour of just using UTF-8 characters, and it seems
13660 that at least two other MTAs permit this. This option allows Exim users to
13661 experiment if they wish.
13662
13663 If it is set true, Exim's domain parsing function allows valid
13664 UTF-8 multicharacters to appear in domain name components, in addition to
13665 letters, digits, and hyphens. However, just setting this option is not
13666 enough; if you want to look up these domain names in the DNS, you must also
13667 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
13668 suitable setting is:
13669 .code
13670 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
13671   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
13672 .endd
13673 Alternatively, you can just disable this feature by setting
13674 .code
13675 dns_check_names_pattern =
13676 .endd
13677 That is, set the option to an empty string so that no check is done.
13678
13679
13680 .option auth_advertise_hosts main "host list&!!" *
13681 .cindex "authentication" "advertising"
13682 .cindex "AUTH" "advertising"
13683 If any server authentication mechanisms are configured, Exim advertises them in
13684 response to an EHLO command only if the calling host matches this list.
13685 Otherwise, Exim does not advertise AUTH.
13686 Exim does not accept AUTH commands from clients to which it has not
13687 advertised the availability of AUTH. The advertising of individual
13688 authentication mechanisms can be controlled by the use of the
13689 &%server_advertise_condition%& generic authenticator option on the individual
13690 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
13691
13692 Certain mail clients (for example, Netscape) require the user to provide a name
13693 and password for authentication if AUTH is advertised, even though it may
13694 not be needed (the host may accept messages from hosts on its local LAN without
13695 authentication, for example). The &%auth_advertise_hosts%& option can be used
13696 to make these clients more friendly by excluding them from the set of hosts to
13697 which Exim advertises AUTH.
13698
13699 .cindex "AUTH" "advertising when encrypted"
13700 If you want to advertise the availability of AUTH only when the connection
13701 is encrypted using TLS, you can make use of the fact that the value of this
13702 option is expanded, with a setting like this:
13703 .code
13704 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
13705 .endd
13706 .vindex "&$tls_in_cipher$&"
13707 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
13708 the expansion is empty, thus matching no hosts. Otherwise, the result of the
13709 expansion is *, which matches all hosts.
13710
13711
13712 .option auto_thaw main time 0s
13713 .cindex "thawing messages"
13714 .cindex "unfreezing messages"
13715 If this option is set to a time greater than zero, a queue runner will try a
13716 new delivery attempt on any frozen message, other than a bounce message, if
13717 this much time has passed since it was frozen. This may result in the message
13718 being re-frozen if nothing has changed since the last attempt. It is a way of
13719 saying &"keep on trying, even though there are big problems"&.
13720
13721 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
13722 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
13723 thought to be very useful any more, and its use should probably be avoided.
13724
13725
13726 .option av_scanner main string "see below"
13727 This option is available if Exim is built with the content-scanning extension.
13728 It specifies which anti-virus scanner to use. The default value is:
13729 .code
13730 sophie:/var/run/sophie
13731 .endd
13732 If the value of &%av_scanner%& starts with a dollar character, it is expanded
13733 before use. See section &<<SECTscanvirus>>& for further details.
13734
13735
13736 .option bi_command main string unset
13737 .oindex "&%-bi%&"
13738 This option supplies the name of a command that is run when Exim is called with
13739 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
13740 just the command name, it is not a complete command line. If an argument is
13741 required, it must come from the &%-oA%& command line option.
13742
13743
13744 .option bounce_message_file main string unset
13745 .cindex "bounce message" "customizing"
13746 .cindex "customizing" "bounce message"
13747 This option defines a template file containing paragraphs of text to be used
13748 for constructing bounce messages.  Details of the file's contents are given in
13749 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
13750
13751
13752 .option bounce_message_text main string unset
13753 When this option is set, its contents are included in the default bounce
13754 message immediately after &"This message was created automatically by mail
13755 delivery software."& It is not used if &%bounce_message_file%& is set.
13756
13757 .option bounce_return_body main boolean true
13758 .cindex "bounce message" "including body"
13759 This option controls whether the body of an incoming message is included in a
13760 bounce message when &%bounce_return_message%& is true. The default setting
13761 causes the entire message, both header and body, to be returned (subject to the
13762 value of &%bounce_return_size_limit%&). If this option is false, only the
13763 message header is included. In the case of a non-SMTP message containing an
13764 error that is detected during reception, only those header lines preceding the
13765 point at which the error was detected are returned.
13766 .cindex "bounce message" "including original"
13767
13768 .option bounce_return_message main boolean true
13769 If this option is set false, none of the original message is included in
13770 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
13771 &%bounce_return_body%&.
13772
13773
13774 .option bounce_return_size_limit main integer 100K
13775 .cindex "size" "of bounce, limit"
13776 .cindex "bounce message" "size limit"
13777 .cindex "limit" "bounce message size"
13778 This option sets a limit in bytes on the size of messages that are returned to
13779 senders as part of bounce messages when &%bounce_return_message%& is true. The
13780 limit should be less than the value of the global &%message_size_limit%& and of
13781 any &%message_size_limit%& settings on transports, to allow for the bounce text
13782 that Exim generates. If this option is set to zero there is no limit.
13783
13784 When the body of any message that is to be included in a bounce message is
13785 greater than the limit, it is truncated, and a comment pointing this out is
13786 added at the top. The actual cutoff may be greater than the value given, owing
13787 to the use of buffering for transferring the message in chunks (typically 8K in
13788 size). The idea is to save bandwidth on those undeliverable 15-megabyte
13789 messages.
13790
13791 .option bounce_sender_authentication main string unset
13792 .cindex "bounce message" "sender authentication"
13793 .cindex "authentication" "bounce message"
13794 .cindex "AUTH" "on bounce message"
13795 This option provides an authenticated sender address that is sent with any
13796 bounce messages generated by Exim that are sent over an authenticated SMTP
13797 connection. A typical setting might be:
13798 .code
13799 bounce_sender_authentication = mailer-daemon@my.domain.example
13800 .endd
13801 which would cause bounce messages to be sent using the SMTP command:
13802 .code
13803 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
13804 .endd
13805 The value of &%bounce_sender_authentication%& must always be a complete email
13806 address.
13807
13808 .option callout_domain_negative_expire main time 3h
13809 .cindex "caching" "callout timeouts"
13810 .cindex "callout" "caching timeouts"
13811 This option specifies the expiry time for negative callout cache data for a
13812 domain. See section &<<SECTcallver>>& for details of callout verification, and
13813 section &<<SECTcallvercache>>& for details of the caching.
13814
13815
13816 .option callout_domain_positive_expire main time 7d
13817 This option specifies the expiry time for positive callout cache data for a
13818 domain. See section &<<SECTcallver>>& for details of callout verification, and
13819 section &<<SECTcallvercache>>& for details of the caching.
13820
13821
13822 .option callout_negative_expire main time 2h
13823 This option specifies the expiry time for negative callout cache data for an
13824 address. See section &<<SECTcallver>>& for details of callout verification, and
13825 section &<<SECTcallvercache>>& for details of the caching.
13826
13827
13828 .option callout_positive_expire main time 24h
13829 This option specifies the expiry time for positive callout cache data for an
13830 address. See section &<<SECTcallver>>& for details of callout verification, and
13831 section &<<SECTcallvercache>>& for details of the caching.
13832
13833
13834 .option callout_random_local_part main string&!! "see below"
13835 This option defines the &"random"& local part that can be used as part of
13836 callout verification. The default value is
13837 .code
13838 $primary_hostname-$tod_epoch-testing
13839 .endd
13840 See section &<<CALLaddparcall>>& for details of how this value is used.
13841
13842
13843 .option check_log_inodes main integer 0
13844 See &%check_spool_space%& below.
13845
13846
13847 .option check_log_space main integer 0
13848 See &%check_spool_space%& below.
13849
13850 .oindex "&%check_rfc2047_length%&"
13851 .cindex "RFC 2047" "disabling length check"
13852 .option check_rfc2047_length main boolean true
13853 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
13854 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
13855 word; strings to be encoded that exceed this length are supposed to use
13856 multiple encoded words. By default, Exim does not recognize encoded words that
13857 exceed the maximum length. However, it seems that some software, in violation
13858 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
13859 set false, Exim recognizes encoded words of any length.
13860
13861
13862 .option check_spool_inodes main integer 0
13863 See &%check_spool_space%& below.
13864
13865
13866 .option check_spool_space main integer 0
13867 .cindex "checking disk space"
13868 .cindex "disk space, checking"
13869 .cindex "spool directory" "checking space"
13870 The four &%check_...%& options allow for checking of disk resources before a
13871 message is accepted.
13872
13873 .vindex "&$log_inodes$&"
13874 .vindex "&$log_space$&"
13875 .vindex "&$spool_inodes$&"
13876 .vindex "&$spool_space$&"
13877 When any of these options are set, they apply to all incoming messages. If you
13878 want to apply different checks to different kinds of message, you can do so by
13879 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
13880 &$spool_space$& in an ACL with appropriate additional conditions.
13881
13882
13883 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
13884 either value is greater than zero, for example:
13885 .code
13886 check_spool_space = 10M
13887 check_spool_inodes = 100
13888 .endd
13889 The spool partition is the one that contains the directory defined by
13890 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
13891 transit.
13892
13893 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
13894 files are written if either is greater than zero. These should be set only if
13895 &%log_file_path%& and &%spool_directory%& refer to different partitions.
13896
13897 If there is less space or fewer inodes than requested, Exim refuses to accept
13898 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
13899 error response to the MAIL command. If ESMTP is in use and there was a
13900 SIZE parameter on the MAIL command, its value is added to the
13901 &%check_spool_space%& value, and the check is performed even if
13902 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
13903
13904 The values for &%check_spool_space%& and &%check_log_space%& are held as a
13905 number of kilobytes. If a non-multiple of 1024 is specified, it is rounded up.
13906
13907 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
13908 failure a message is written to stderr and Exim exits with a non-zero code, as
13909 it obviously cannot send an error message of any kind.
13910
13911 .option daemon_smtp_ports main string &`smtp`&
13912 .cindex "port" "for daemon"
13913 .cindex "TCP/IP" "setting listening ports"
13914 This option specifies one or more default SMTP ports on which the Exim daemon
13915 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
13916 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
13917
13918 .option daemon_startup_retries main integer 9
13919 .cindex "daemon startup, retrying"
13920 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
13921 the daemon at startup when it cannot immediately bind a listening socket
13922 (typically because the socket is already in use): &%daemon_startup_retries%&
13923 defines the number of retries after the first failure, and
13924 &%daemon_startup_sleep%& defines the length of time to wait between retries.
13925
13926 .option daemon_startup_sleep main time 30s
13927 See &%daemon_startup_retries%&.
13928
13929 .option delay_warning main "time list" 24h
13930 .cindex "warning of delay"
13931 .cindex "delay warning, specifying"
13932 When a message is delayed, Exim sends a warning message to the sender at
13933 intervals specified by this option. The data is a colon-separated list of times
13934 after which to send warning messages. If the value of the option is an empty
13935 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
13936 message has been on the queue for longer than the last time, the last interval
13937 between the times is used to compute subsequent warning times. For example,
13938 with
13939 .code
13940 delay_warning = 4h:8h:24h
13941 .endd
13942 the first message is sent after 4 hours, the second after 8 hours, and
13943 the third one after 24 hours. After that, messages are sent every 16 hours,
13944 because that is the interval between the last two times on the list. If you set
13945 just one time, it specifies the repeat interval. For example, with:
13946 .code
13947 delay_warning = 6h
13948 .endd
13949 messages are repeated every six hours. To stop warnings after a given time, set
13950 a very large time at the end of the list. For example:
13951 .code
13952 delay_warning = 2h:12h:99d
13953 .endd
13954 Note that the option is only evaluated at the time a delivery attempt fails,
13955 which depends on retry and queue-runner configuration.
13956 Typically retries will be configured more frequently than warning messages.
13957
13958 .option delay_warning_condition main string&!! "see below"
13959 .vindex "&$domain$&"
13960 The string is expanded at the time a warning message might be sent. If all the
13961 deferred addresses have the same domain, it is set in &$domain$& during the
13962 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
13963 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
13964 &"false"& (the comparison being done caselessly) then the warning message is
13965 not sent. The default is:
13966 .code
13967 delay_warning_condition = ${if or {\
13968   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
13969   { match{$h_precedence:}{(?i)bulk|list|junk} }\
13970   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
13971   } {no}{yes}}
13972 .endd
13973 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
13974 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
13975 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
13976 &"auto-replied"& in an &'Auto-Submitted:'& header.
13977
13978 .option deliver_drop_privilege main boolean false
13979 .cindex "unprivileged delivery"
13980 .cindex "delivery" "unprivileged"
13981 If this option is set true, Exim drops its root privilege at the start of a
13982 delivery process, and runs as the Exim user throughout. This severely restricts
13983 the kinds of local delivery that are possible, but is viable in certain types
13984 of configuration. There is a discussion about the use of root privilege in
13985 chapter &<<CHAPsecurity>>&.
13986
13987 .option deliver_queue_load_max main fixed-point unset
13988 .cindex "load average"
13989 .cindex "queue runner" "abandoning"
13990 When this option is set, a queue run is abandoned if the system load average
13991 becomes greater than the value of the option. The option has no effect on
13992 ancient operating systems on which Exim cannot determine the load average.
13993 See also &%queue_only_load%& and &%smtp_load_reserve%&.
13994
13995
13996 .option delivery_date_remove main boolean true
13997 .cindex "&'Delivery-date:'& header line"
13998 Exim's transports have an option for adding a &'Delivery-date:'& header to a
13999 message when it is delivered, in exactly the same way as &'Return-path:'& is
14000 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
14001 should not be present in incoming messages, and this option causes them to be
14002 removed at the time the message is received, to avoid any problems that might
14003 occur when a delivered message is subsequently sent on to some other recipient.
14004
14005 .option disable_fsync main boolean false
14006 .cindex "&[fsync()]&, disabling"
14007 This option is available only if Exim was built with the compile-time option
14008 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
14009 a runtime configuration generates an &"unknown option"& error. You should not
14010 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
14011 really, really, really understand what you are doing. &'No pre-compiled
14012 distributions of Exim should ever make this option available.'&
14013
14014 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
14015 updated files' data to be written to disc before continuing. Unexpected events
14016 such as crashes and power outages may cause data to be lost or scrambled.
14017 Here be Dragons. &*Beware.*&
14018
14019
14020 .option disable_ipv6 main boolean false
14021 .cindex "IPv6" "disabling"
14022 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
14023 activities take place. AAAA records are never looked up, and any IPv6 addresses
14024 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
14025 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
14026 to handle IPv6 literal addresses.
14027
14028
14029 .option dns_again_means_nonexist main "domain list&!!" unset
14030 .cindex "DNS" "&""try again""& response; overriding"
14031 DNS lookups give a &"try again"& response for the DNS errors
14032 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
14033 keep trying to deliver a message, or to give repeated temporary errors to
14034 incoming mail. Sometimes the effect is caused by a badly set up name server and
14035 may persist for a long time. If a domain which exhibits this problem matches
14036 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
14037 This option should be used with care. You can make it apply to reverse lookups
14038 by a setting such as this:
14039 .code
14040 dns_again_means_nonexist = *.in-addr.arpa
14041 .endd
14042 This option applies to all DNS lookups that Exim does. It also applies when the
14043 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
14044 since these are most likely to be caused by DNS lookup problems. The
14045 &(dnslookup)& router has some options of its own for controlling what happens
14046 when lookups for MX or SRV records give temporary errors. These more specific
14047 options are applied after this global option.
14048
14049 .option dns_check_names_pattern main string "see below"
14050 .cindex "DNS" "pre-check of name syntax"
14051 When this option is set to a non-empty string, it causes Exim to check domain
14052 names for characters that are not allowed in host names before handing them to
14053 the DNS resolver, because some resolvers give temporary errors for names that
14054 contain unusual characters. If a domain name contains any unwanted characters,
14055 a &"not found"& result is forced, and the resolver is not called. The check is
14056 done by matching the domain name against a regular expression, which is the
14057 value of this option. The default pattern is
14058 .code
14059 dns_check_names_pattern = \
14060   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
14061 .endd
14062 which permits only letters, digits, slashes, and hyphens in components, but
14063 they must start and end with a letter or digit. Slashes are not, in fact,
14064 permitted in host names, but they are found in certain NS records (which can be
14065 accessed in Exim by using a &%dnsdb%& lookup). If you set
14066 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
14067 empty string.
14068
14069 .option dns_csa_search_limit main integer 5
14070 This option controls the depth of parental searching for CSA SRV records in the
14071 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
14072
14073 .option dns_csa_use_reverse main boolean true
14074 This option controls whether or not an IP address, given as a CSA domain, is
14075 reversed and looked up in the reverse DNS, as described in more detail in
14076 section &<<SECTverifyCSA>>&.
14077
14078
14079 .option dns_dnssec_ok main integer -1
14080 .cindex "DNS" "resolver options"
14081 .cindex "DNS" "DNSSEC"
14082 If this option is set to a non-negative number then Exim will initialise the
14083 DNS resolver library to either use or not use DNSSEC, overriding the system
14084 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
14085
14086 If the resolver library does not support DNSSEC then this option has no effect.
14087
14088
14089 .option dns_ipv4_lookup main "domain list&!!" unset
14090 .cindex "IPv6" "DNS lookup for AAAA records"
14091 .cindex "DNS" "IPv6 lookup for AAAA records"
14092 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
14093 looks for IPv6 address records (AAAA records) as well as IPv4 address records
14094 (A records) when trying to find IP addresses for hosts, unless the host's
14095 domain matches this list.
14096
14097 This is a fudge to help with name servers that give big delays or otherwise do
14098 not work for the AAAA record type. In due course, when the world's name
14099 servers have all been upgraded, there should be no need for this option.
14100
14101
14102 .option dns_retrans main time 0s
14103 .cindex "DNS" "resolver options"
14104 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
14105 retransmission and retry parameters for DNS lookups. Values of zero (the
14106 defaults) leave the system default settings unchanged. The first value is the
14107 time between retries, and the second is the number of retries. It isn't
14108 totally clear exactly how these settings affect the total time a DNS lookup may
14109 take. I haven't found any documentation about timeouts on DNS lookups; these
14110 parameter values are available in the external resolver interface structure,
14111 but nowhere does it seem to describe how they are used or what you might want
14112 to set in them.
14113
14114
14115 .option dns_retry main integer 0
14116 See &%dns_retrans%& above.
14117
14118
14119 .option dns_use_edns0 main integer -1
14120 .cindex "DNS" "resolver options"
14121 .cindex "DNS" "EDNS0"
14122 If this option is set to a non-negative number then Exim will initialise the
14123 DNS resolver library to either use or not use EDNS0 extensions, overriding
14124 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
14125 on.
14126
14127 If the resolver library does not support EDNS0 then this option has no effect.
14128
14129
14130 .option drop_cr main boolean false
14131 This is an obsolete option that is now a no-op. It used to affect the way Exim
14132 handled CR and LF characters in incoming messages. What happens now is
14133 described in section &<<SECTlineendings>>&.
14134
14135 .option dsn_from main "string&!!" "see below"
14136 .cindex "&'From:'& header line" "in bounces"
14137 .cindex "bounce messages" "&'From:'& line, specifying"
14138 This option can be used to vary the contents of &'From:'& header lines in
14139 bounces and other automatically generated messages (&"Delivery Status
14140 Notifications"& &-- hence the name of the option). The default setting is:
14141 .code
14142 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
14143 .endd
14144 The value is expanded every time it is needed. If the expansion fails, a
14145 panic is logged, and the default value is used.
14146
14147 .option envelope_to_remove main boolean true
14148 .cindex "&'Envelope-to:'& header line"
14149 Exim's transports have an option for adding an &'Envelope-to:'& header to a
14150 message when it is delivered, in exactly the same way as &'Return-path:'& is
14151 handled. &'Envelope-to:'& records the original recipient address from the
14152 messages's envelope that caused the delivery to happen. Such headers should not
14153 be present in incoming messages, and this option causes them to be removed at
14154 the time the message is received, to avoid any problems that might occur when a
14155 delivered message is subsequently sent on to some other recipient.
14156
14157
14158 .option errors_copy main "string list&!!" unset
14159 .cindex "bounce message" "copy to other address"
14160 .cindex "copy of bounce message"
14161 Setting this option causes Exim to send bcc copies of bounce messages that it
14162 generates to other addresses. &*Note*&: This does not apply to bounce messages
14163 coming from elsewhere. The value of the option is a colon-separated list of
14164 items. Each item consists of a pattern, terminated by white space, followed by
14165 a comma-separated list of email addresses. If a pattern contains spaces, it
14166 must be enclosed in double quotes.
14167
14168 Each pattern is processed in the same way as a single item in an address list
14169 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
14170 the bounce message, the message is copied to the addresses on the list. The
14171 items are scanned in order, and once a matching one is found, no further items
14172 are examined. For example:
14173 .code
14174 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
14175               rqps@mydomain   hostmaster@mydomain.example,\
14176                               postmaster@mydomain.example
14177 .endd
14178 .vindex "&$domain$&"
14179 .vindex "&$local_part$&"
14180 The address list is expanded before use. The expansion variables &$local_part$&
14181 and &$domain$& are set from the original recipient of the error message, and if
14182 there was any wildcard matching in the pattern, the expansion
14183 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
14184 variables &$0$&, &$1$&, etc. are set in the normal way.
14185
14186
14187 .option errors_reply_to main string unset
14188 .cindex "bounce message" "&'Reply-to:'& in"
14189 By default, Exim's bounce and delivery warning messages contain the header line
14190 .display
14191 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
14192 .endd
14193 .oindex &%quota_warn_message%&
14194 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
14195 A warning message that is generated by the &%quota_warn_message%& option in an
14196 &(appendfile)& transport may contain its own &'From:'& header line that
14197 overrides the default.
14198
14199 Experience shows that people reply to bounce messages. If the
14200 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
14201 and warning messages. For example:
14202 .code
14203 errors_reply_to = postmaster@my.domain.example
14204 .endd
14205 The value of the option is not expanded. It must specify a valid RFC 2822
14206 address. However, if a warning message that is generated by the
14207 &%quota_warn_message%& option in an &(appendfile)& transport contain its
14208 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
14209 not used.
14210
14211
14212 .option exim_group main string "compile-time configured"
14213 .cindex "gid (group id)" "Exim's own"
14214 .cindex "Exim group"
14215 This option changes the gid under which Exim runs when it gives up root
14216 privilege. The default value is compiled into the binary. The value of this
14217 option is used only when &%exim_user%& is also set. Unless it consists entirely
14218 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
14219 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
14220 security issues.
14221
14222
14223 .option exim_path main string "see below"
14224 .cindex "Exim binary, path name"
14225 This option specifies the path name of the Exim binary, which is used when Exim
14226 needs to re-exec itself. The default is set up to point to the file &'exim'& in
14227 the directory configured at compile time by the BIN_DIRECTORY setting. It
14228 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
14229 other place.
14230 &*Warning*&: Do not use a macro to define the value of this option, because
14231 you will break those Exim utilities that scan the configuration file to find
14232 where the binary is. (They then use the &%-bP%& option to extract option
14233 settings such as the value of &%spool_directory%&.)
14234
14235
14236 .option exim_user main string "compile-time configured"
14237 .cindex "uid (user id)" "Exim's own"
14238 .cindex "Exim user"
14239 This option changes the uid under which Exim runs when it gives up root
14240 privilege. The default value is compiled into the binary. Ownership of the run
14241 time configuration file and the use of the &%-C%& and &%-D%& command line
14242 options is checked against the values in the binary, not what is set here.
14243
14244 Unless it consists entirely of digits, the string is looked up using
14245 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
14246 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
14247 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
14248
14249
14250 .option extra_local_interfaces main "string list" unset
14251 This option defines network interfaces that are to be considered local when
14252 routing, but which are not used for listening by the daemon. See section
14253 &<<SECTreclocipadd>>& for details.
14254
14255
14256 . Allow this long option name to split; give it unsplit as a fifth argument
14257 . for the automatic .oindex that is generated by .option.
14258
14259 .option "extract_addresses_remove_ &~&~arguments" main boolean true &&&
14260          extract_addresses_remove_arguments
14261 .oindex "&%-t%&"
14262 .cindex "command line" "addresses with &%-t%&"
14263 .cindex "Sendmail compatibility" "&%-t%& option"
14264 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
14265 are present on the command line when the &%-t%& option is used to build an
14266 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
14267 line addresses are removed from the recipients list. This is also how Smail
14268 behaves. However, other Sendmail documentation (the O'Reilly book) states that
14269 command line addresses are added to those obtained from the header lines. When
14270 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
14271 argument headers. If it is set false, Exim adds rather than removes argument
14272 addresses.
14273
14274
14275 .option finduser_retries main integer 0
14276 .cindex "NIS, retrying user lookups"
14277 On systems running NIS or other schemes in which user and group information is
14278 distributed from a remote system, there can be times when &[getpwnam()]& and
14279 related functions fail, even when given valid data, because things time out.
14280 Unfortunately these failures cannot be distinguished from genuine &"not found"&
14281 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
14282 many extra times to find a user or a group, waiting for one second between
14283 retries.
14284
14285 .cindex "&_/etc/passwd_&" "multiple reading of"
14286 You should not set this option greater than zero if your user information is in
14287 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
14288 search the file multiple times for non-existent users, and also cause delay.
14289
14290
14291
14292 .option freeze_tell main "string list, comma separated" unset
14293 .cindex "freezing messages" "sending a message when freezing"
14294 On encountering certain errors, or when configured to do so in a system filter,
14295 ACL, or special router, Exim freezes a message. This means that no further
14296 delivery attempts take place until an administrator thaws the message, or the
14297 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
14298 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
14299 warning message whenever it freezes something, unless the message it is
14300 freezing is a locally-generated bounce message. (Without this exception there
14301 is the possibility of looping.) The warning message is sent to the addresses
14302 supplied as the comma-separated value of this option. If several of the
14303 message's addresses cause freezing, only a single message is sent. If the
14304 freezing was automatic, the reason(s) for freezing can be found in the message
14305 log. If you configure freezing in a filter or ACL, you must arrange for any
14306 logging that you require.
14307
14308
14309 .option gecos_name main string&!! unset
14310 .cindex "HP-UX"
14311 .cindex "&""gecos""& field, parsing"
14312 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
14313 password file to hold other information in addition to users' real names. Exim
14314 looks up this field for use when it is creating &'Sender:'& or &'From:'&
14315 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
14316 of the field are used unchanged, except that, if an ampersand is encountered,
14317 it is replaced by the user's login name with the first character forced to
14318 upper case, since this is a convention that is observed on many systems.
14319
14320 When these options are set, &%gecos_pattern%& is treated as a regular
14321 expression that is to be applied to the field (again with && replaced by the
14322 login name), and if it matches, &%gecos_name%& is expanded and used as the
14323 user's name.
14324
14325 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
14326 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
14327 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
14328 name terminates at the first comma, the following can be used:
14329 .code
14330 gecos_pattern = ([^,]*)
14331 gecos_name = $1
14332 .endd
14333
14334 .option gecos_pattern main string unset
14335 See &%gecos_name%& above.
14336
14337
14338 .option gnutls_compat_mode main boolean unset
14339 This option controls whether GnuTLS is used in compatibility mode in an Exim
14340 server. This reduces security slightly, but improves interworking with older
14341 implementations of TLS.
14342
14343
14344 option gnutls_allow_auto_pkcs11 main boolean unset
14345 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
14346 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
14347
14348 See
14349 &url(http://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
14350 for documentation.
14351
14352
14353
14354 .option headers_charset main string "see below"
14355 This option sets a default character set for translating from encoded MIME
14356 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
14357 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
14358 ultimate default is ISO-8859-1. For more details see the description of header
14359 insertions in section &<<SECTexpansionitems>>&.
14360
14361
14362
14363 .option header_maxsize main integer "see below"
14364 .cindex "header section" "maximum size of"
14365 .cindex "limit" "size of message header section"
14366 This option controls the overall maximum size of a message's header
14367 section. The default is the value of HEADER_MAXSIZE in
14368 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
14369 sections are rejected.
14370
14371
14372 .option header_line_maxsize main integer 0
14373 .cindex "header lines" "maximum size of"
14374 .cindex "limit" "size of one header line"
14375 This option limits the length of any individual header line in a message, after
14376 all the continuations have been joined together. Messages with individual
14377 header lines that are longer than the limit are rejected. The default value of
14378 zero means &"no limit"&.
14379
14380
14381
14382
14383 .option helo_accept_junk_hosts main "host list&!!" unset
14384 .cindex "HELO" "accepting junk data"
14385 .cindex "EHLO" "accepting junk data"
14386 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
14387 mail, and gives an error response for invalid data. Unfortunately, there are
14388 some SMTP clients that send syntactic junk. They can be accommodated by setting
14389 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
14390 if you want to do semantic checking.
14391 See also &%helo_allow_chars%& for a way of extending the permitted character
14392 set.
14393
14394
14395 .option helo_allow_chars main string unset
14396 .cindex "HELO" "underscores in"
14397 .cindex "EHLO" "underscores in"
14398 .cindex "underscore in EHLO/HELO"
14399 This option can be set to a string of rogue characters that are permitted in
14400 all EHLO and HELO names in addition to the standard letters, digits,
14401 hyphens, and dots. If you really must allow underscores, you can set
14402 .code
14403 helo_allow_chars = _
14404 .endd
14405 Note that the value is one string, not a list.
14406
14407
14408 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
14409 .cindex "HELO" "forcing reverse lookup"
14410 .cindex "EHLO" "forcing reverse lookup"
14411 If the domain given by a client in a HELO or EHLO command matches this
14412 list, a reverse lookup is done in order to establish the host's true name. The
14413 default forces a lookup if the client host gives the server's name or any of
14414 its IP addresses (in brackets), something that broken clients have been seen to
14415 do.
14416
14417
14418 .option helo_try_verify_hosts main "host list&!!" unset
14419 .cindex "HELO verifying" "optional"
14420 .cindex "EHLO" "verifying, optional"
14421 By default, Exim just checks the syntax of HELO and EHLO commands (see
14422 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
14423 to do more extensive checking of the data supplied by these commands. The ACL
14424 condition &`verify = helo`& is provided to make this possible.
14425 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
14426 to force the check to occur. From release 4.53 onwards, this is no longer
14427 necessary. If the check has not been done before &`verify = helo`& is
14428 encountered, it is done at that time. Consequently, this option is obsolete.
14429 Its specification is retained here for backwards compatibility.
14430
14431 When an EHLO or HELO command is received, if the calling host matches
14432 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
14433 EHLO command either:
14434
14435 .ilist
14436 is an IP literal matching the calling address of the host, or
14437 .next
14438 .cindex "DNS" "reverse lookup"
14439 .cindex "reverse DNS lookup"
14440 matches the host name that Exim obtains by doing a reverse lookup of the
14441 calling host address, or
14442 .next
14443 when looked up using &[gethostbyname()]& (or &[getipnodebyname()]& when
14444 available) yields the calling host address.
14445 .endlist
14446
14447 However, the EHLO or HELO command is not rejected if any of the checks
14448 fail. Processing continues, but the result of the check is remembered, and can
14449 be detected later in an ACL by the &`verify = helo`& condition.
14450
14451 .option helo_verify_hosts main "host list&!!" unset
14452 .cindex "HELO verifying" "mandatory"
14453 .cindex "EHLO" "verifying, mandatory"
14454 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
14455 backwards compatibility. For hosts that match this option, Exim checks the host
14456 name given in the HELO or EHLO in the same way as for
14457 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
14458 rejected with a 550 error, and entries are written to the main and reject logs.
14459 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
14460 error.
14461
14462 .option hold_domains main "domain list&!!" unset
14463 .cindex "domain" "delaying delivery"
14464 .cindex "delivery" "delaying certain domains"
14465 This option allows mail for particular domains to be held on the queue
14466 manually. The option is overridden if a message delivery is forced with the
14467 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
14468 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
14469 item in &%hold_domains%&, no routing or delivery for that address is done, and
14470 it is deferred every time the message is looked at.
14471
14472 This option is intended as a temporary operational measure for delaying the
14473 delivery of mail while some problem is being sorted out, or some new
14474 configuration tested. If you just want to delay the processing of some
14475 domains until a queue run occurs, you should use &%queue_domains%& or
14476 &%queue_smtp_domains%&, not &%hold_domains%&.
14477
14478 A setting of &%hold_domains%& does not override Exim's code for removing
14479 messages from the queue if they have been there longer than the longest retry
14480 time in any retry rule. If you want to hold messages for longer than the normal
14481 retry times, insert a dummy retry rule with a long retry time.
14482
14483
14484 .option host_lookup main "host list&!!" unset
14485 .cindex "host name" "lookup, forcing"
14486 Exim does not look up the name of a calling host from its IP address unless it
14487 is required to compare against some host list, or the host matches
14488 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
14489 option (which normally contains IP addresses rather than host names). The
14490 default configuration file contains
14491 .code
14492 host_lookup = *
14493 .endd
14494 which causes a lookup to happen for all hosts. If the expense of these lookups
14495 is felt to be too great, the setting can be changed or removed.
14496
14497 After a successful reverse lookup, Exim does a forward lookup on the name it
14498 has obtained, to verify that it yields the IP address that it started with. If
14499 this check fails, Exim behaves as if the name lookup failed.
14500
14501 .vindex "&$host_lookup_failed$&"
14502 .vindex "&$sender_host_name$&"
14503 After any kind of failure, the host name (in &$sender_host_name$&) remains
14504 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
14505 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
14506 &`verify = reverse_host_lookup`& in ACLs.
14507
14508
14509 .option host_lookup_order main "string list" &`bydns:byaddr`&
14510 This option specifies the order of different lookup methods when Exim is trying
14511 to find a host name from an IP address. The default is to do a DNS lookup
14512 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
14513 if that fails. You can change the order of these lookups, or omit one entirely,
14514 if you want.
14515
14516 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
14517 multiple PTR records in the DNS and the IP address is not listed in
14518 &_/etc/hosts_&. Different operating systems give different results in this
14519 case. That is why the default tries a DNS lookup first.
14520
14521
14522
14523 .option host_reject_connection main "host list&!!" unset
14524 .cindex "host" "rejecting connections from"
14525 If this option is set, incoming SMTP calls from the hosts listed are rejected
14526 as soon as the connection is made.
14527 This option is obsolete, and retained only for backward compatibility, because
14528 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
14529 connections immediately.
14530
14531 The ability to give an immediate rejection (either by this option or using an
14532 ACL) is provided for use in unusual cases. Many hosts will just try again,
14533 sometimes without much delay. Normally, it is better to use an ACL to reject
14534 incoming messages at a later stage, such as after RCPT commands. See
14535 chapter &<<CHAPACL>>&.
14536
14537
14538 .option hosts_connection_nolog main "host list&!!" unset
14539 .cindex "host" "not logging connections from"
14540 This option defines a list of hosts for which connection logging does not
14541 happen, even though the &%smtp_connection%& log selector is set. For example,
14542 you might want not to log SMTP connections from local processes, or from
14543 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
14544 the daemon; you should therefore strive to restrict its value to a short inline
14545 list of IP addresses and networks. To disable logging SMTP connections from
14546 local processes, you must create a host list with an empty item. For example:
14547 .code
14548 hosts_connection_nolog = :
14549 .endd
14550 If the &%smtp_connection%& log selector is not set, this option has no effect.
14551
14552
14553
14554 .option hosts_treat_as_local main "domain list&!!" unset
14555 .cindex "local host" "domains treated as"
14556 .cindex "host" "treated as local"
14557 If this option is set, any host names that match the domain list are treated as
14558 if they were the local host when Exim is scanning host lists obtained from MX
14559 records
14560 or other sources. Note that the value of this option is a domain list, not a
14561 host list, because it is always used to check host names, not IP addresses.
14562
14563 This option also applies when Exim is matching the special items
14564 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
14565 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
14566 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
14567 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
14568 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
14569 interfaces and recognizing the local host.
14570
14571
14572 .option ibase_servers main "string list" unset
14573 .cindex "InterBase" "server list"
14574 This option provides a list of InterBase servers and associated connection data,
14575 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
14576 The option is available only if Exim has been built with InterBase support.
14577
14578
14579
14580 .option ignore_bounce_errors_after main time 10w
14581 .cindex "bounce message" "discarding"
14582 .cindex "discarding bounce message"
14583 This option affects the processing of bounce messages that cannot be delivered,
14584 that is, those that suffer a permanent delivery failure. (Bounce messages that
14585 suffer temporary delivery failures are of course retried in the usual way.)
14586
14587 After a permanent delivery failure, bounce messages are frozen,
14588 because there is no sender to whom they can be returned. When a frozen bounce
14589 message has been on the queue for more than the given time, it is unfrozen at
14590 the next queue run, and a further delivery is attempted. If delivery fails
14591 again, the bounce message is discarded. This makes it possible to keep failed
14592 bounce messages around for a shorter time than the normal maximum retry time
14593 for frozen messages. For example,
14594 .code
14595 ignore_bounce_errors_after = 12h
14596 .endd
14597 retries failed bounce message deliveries after 12 hours, discarding any further
14598 failures. If the value of this option is set to a zero time period, bounce
14599 failures are discarded immediately. Setting a very long time (as in the default
14600 value) has the effect of disabling this option. For ways of automatically
14601 dealing with other kinds of frozen message, see &%auto_thaw%& and
14602 &%timeout_frozen_after%&.
14603
14604
14605 .option ignore_fromline_hosts main "host list&!!" unset
14606 .cindex "&""From""& line"
14607 .cindex "UUCP" "&""From""& line"
14608 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
14609 the headers of a message. By default this is treated as the start of the
14610 message's body, which means that any following headers are not recognized as
14611 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
14612 match those hosts that insist on sending it. If the sender is actually a local
14613 process rather than a remote host, and is using &%-bs%& to inject the messages,
14614 &%ignore_fromline_local%& must be set to achieve this effect.
14615
14616
14617 .option ignore_fromline_local main boolean false
14618 See &%ignore_fromline_hosts%& above.
14619
14620
14621 .option keep_malformed main time 4d
14622 This option specifies the length of time to keep messages whose spool files
14623 have been corrupted in some way. This should, of course, never happen. At the
14624 next attempt to deliver such a message, it gets removed. The incident is
14625 logged.
14626
14627
14628 .option ldap_ca_cert_dir main string unset
14629 .cindex "LDAP", "TLS CA certificate directory"
14630 This option indicates which directory contains CA certificates for verifying
14631 a TLS certificate presented by an LDAP server.
14632 While Exim does not provide a default value, your SSL library may.
14633 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
14634 and constrained to be a directory.
14635
14636
14637 .option ldap_ca_cert_file main string unset
14638 .cindex "LDAP", "TLS CA certificate file"
14639 This option indicates which file contains CA certificates for verifying
14640 a TLS certificate presented by an LDAP server.
14641 While Exim does not provide a default value, your SSL library may.
14642 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
14643 and constrained to be a file.
14644
14645
14646 .option ldap_cert_file main string unset
14647 .cindex "LDAP" "TLS client certificate file"
14648 This option indicates which file contains an TLS client certificate which
14649 Exim should present to the LDAP server during TLS negotiation.
14650 Should be used together with &%ldap_cert_key%&.
14651
14652
14653 .option ldap_cert_key main string unset
14654 .cindex "LDAP" "TLS client key file"
14655 This option indicates which file contains the secret/private key to use
14656 to prove identity to the LDAP server during TLS negotiation.
14657 Should be used together with &%ldap_cert_file%&, which contains the
14658 identity to be proven.
14659
14660
14661 .option ldap_cipher_suite main string unset
14662 .cindex "LDAP" "TLS cipher suite"
14663 This controls the TLS cipher-suite negotiation during TLS negotiation with
14664 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
14665 cipher-suite options with OpenSSL (as used by LDAP client libraries).
14666
14667
14668 .option ldap_default_servers main "string list" unset
14669 .cindex "LDAP" "default servers"
14670 This option provides a list of LDAP servers which are tried in turn when an
14671 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
14672 details of LDAP queries. This option is available only when Exim has been built
14673 with LDAP support.
14674
14675
14676 .option ldap_require_cert main string unset.
14677 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
14678 This should be one of the values "hard", "demand", "allow", "try" or "never".
14679 A value other than one of these is interpreted as "never".
14680 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
14681 Although Exim does not set a default, the LDAP library probably defaults
14682 to hard/demand.
14683
14684
14685 .option ldap_start_tls main boolean false
14686 .cindex "LDAP" "whether or not to negotiate TLS"
14687 If set, Exim will attempt to negotiate TLS with the LDAP server when
14688 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
14689 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
14690 of SSL-on-connect.
14691 In the event of failure to negotiate TLS, the action taken is controlled
14692 by &%ldap_require_cert%&.
14693
14694
14695 .option ldap_version main integer unset
14696 .cindex "LDAP" "protocol version, forcing"
14697 This option can be used to force Exim to set a specific protocol version for
14698 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
14699 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
14700 the LDAP headers; otherwise it is 2. This option is available only when Exim
14701 has been built with LDAP support.
14702
14703
14704
14705 .option local_from_check main boolean true
14706 .cindex "&'Sender:'& header line" "disabling addition of"
14707 .cindex "&'From:'& header line" "disabling checking of"
14708 When a message is submitted locally (that is, not over a TCP/IP connection) by
14709 an untrusted user, Exim removes any existing &'Sender:'& header line, and
14710 checks that the &'From:'& header line matches the login of the calling user and
14711 the domain specified by &%qualify_domain%&.
14712
14713 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
14714 locally submitted message is automatically qualified by Exim, unless the
14715 &%-bnq%& command line option is used.
14716
14717 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
14718 on the local part. If the &'From:'& header line does not match, Exim adds a
14719 &'Sender:'& header with an address constructed from the calling user's login
14720 and the default qualify domain.
14721
14722 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
14723 and no &'Sender:'& header is ever added. If, in addition, you want to retain
14724 &'Sender:'& header lines supplied by untrusted users, you must also set
14725 &%local_sender_retain%& to be true.
14726
14727 .cindex "envelope sender"
14728 These options affect only the header lines in the message. The envelope sender
14729 is still forced to be the login id at the qualify domain unless
14730 &%untrusted_set_sender%& permits the user to supply an envelope sender.
14731
14732 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
14733 request similar header line checking. See section &<<SECTthesenhea>>&, which
14734 has more details about &'Sender:'& processing.
14735
14736
14737
14738
14739 .option local_from_prefix main string unset
14740 When Exim checks the &'From:'& header line of locally submitted messages for
14741 matching the login id (see &%local_from_check%& above), it can be configured to
14742 ignore certain prefixes and suffixes in the local part of the address. This is
14743 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
14744 appropriate lists, in the same form as the &%local_part_prefix%& and
14745 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
14746 example, if
14747 .code
14748 local_from_prefix = *-
14749 .endd
14750 is set, a &'From:'& line containing
14751 .code
14752 From: anything-user@your.domain.example
14753 .endd
14754 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
14755 matches the actual sender address that is constructed from the login name and
14756 qualify domain.
14757
14758
14759 .option local_from_suffix main string unset
14760 See &%local_from_prefix%& above.
14761
14762
14763 .option local_interfaces main "string list" "see below"
14764 This option controls which network interfaces are used by the daemon for
14765 listening; they are also used to identify the local host when routing. Chapter
14766 &<<CHAPinterfaces>>& contains a full description of this option and the related
14767 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
14768 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
14769 &%local_interfaces%& is
14770 .code
14771 local_interfaces = 0.0.0.0
14772 .endd
14773 when Exim is built without IPv6 support; otherwise it is
14774 .code
14775 local_interfaces = <; ::0 ; 0.0.0.0
14776 .endd
14777
14778 .option local_scan_timeout main time 5m
14779 .cindex "timeout" "for &[local_scan()]& function"
14780 .cindex "&[local_scan()]& function" "timeout"
14781 This timeout applies to the &[local_scan()]& function (see chapter
14782 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
14783 the incoming message is rejected with a temporary error if it is an SMTP
14784 message. For a non-SMTP message, the message is dropped and Exim ends with a
14785 non-zero code. The incident is logged on the main and reject logs.
14786
14787
14788
14789 .option local_sender_retain main boolean false
14790 .cindex "&'Sender:'& header line" "retaining from local submission"
14791 When a message is submitted locally (that is, not over a TCP/IP connection) by
14792 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
14793 do not want this to happen, you must set &%local_sender_retain%&, and you must
14794 also set &%local_from_check%& to be false (Exim will complain if you do not).
14795 See also the ACL modifier &`control = suppress_local_fixups`&. Section
14796 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
14797
14798
14799
14800
14801 .option localhost_number main string&!! unset
14802 .cindex "host" "locally unique number for"
14803 .cindex "message ids" "with multiple hosts"
14804 .vindex "&$localhost_number$&"
14805 Exim's message ids are normally unique only within the local host. If
14806 uniqueness among a set of hosts is required, each host must set a different
14807 value for the &%localhost_number%& option. The string is expanded immediately
14808 after reading the configuration file (so that a number can be computed from the
14809 host name, for example) and the result of the expansion must be a number in the
14810 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
14811 systems). This is available in subsequent string expansions via the variable
14812 &$localhost_number$&. When &%localhost_number is set%&, the final two
14813 characters of the message id, instead of just being a fractional part of the
14814 time, are computed from the time and the local host number as described in
14815 section &<<SECTmessiden>>&.
14816
14817
14818
14819 .option log_file_path main "string list&!!" "set at compile time"
14820 .cindex "log" "file path for"
14821 This option sets the path which is used to determine the names of Exim's log
14822 files, or indicates that logging is to be to syslog, or both. It is expanded
14823 when Exim is entered, so it can, for example, contain a reference to the host
14824 name. If no specific path is set for the log files at compile or run time, they
14825 are written in a sub-directory called &_log_& in Exim's spool directory.
14826 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
14827 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
14828 used. If this string is fixed at your installation (contains no expansion
14829 variables) it is recommended that you do not set this option in the
14830 configuration file, but instead supply the path using LOG_FILE_PATH in
14831 &_Local/Makefile_& so that it is available to Exim for logging errors detected
14832 early on &-- in particular, failure to read the configuration file.
14833
14834
14835 .option log_selector main string unset
14836 .cindex "log" "selectors"
14837 This option can be used to reduce or increase the number of things that Exim
14838 writes to its log files. Its argument is made up of names preceded by plus or
14839 minus characters. For example:
14840 .code
14841 log_selector = +arguments -retry_defer
14842 .endd
14843 A list of possible names and what they control is given in the chapter on
14844 logging, in section &<<SECTlogselector>>&.
14845
14846
14847 .option log_timezone main boolean false
14848 .cindex "log" "timezone for entries"
14849 .vindex "&$tod_log$&"
14850 .vindex "&$tod_zone$&"
14851 By default, the timestamps on log lines are in local time without the
14852 timezone. This means that if your timezone changes twice a year, the timestamps
14853 in log lines are ambiguous for an hour when the clocks go back. One way of
14854 avoiding this problem is to set the timezone to UTC. An alternative is to set
14855 &%log_timezone%& true. This turns on the addition of the timezone offset to
14856 timestamps in log lines. Turning on this option can add quite a lot to the size
14857 of log files because each line is extended by 6 characters. Note that the
14858 &$tod_log$& variable contains the log timestamp without the zone, but there is
14859 another variable called &$tod_zone$& that contains just the timezone offset.
14860
14861
14862 .option lookup_open_max main integer 25
14863 .cindex "too many open files"
14864 .cindex "open files, too many"
14865 .cindex "file" "too many open"
14866 .cindex "lookup" "maximum open files"
14867 .cindex "limit" "open files for lookups"
14868 This option limits the number of simultaneously open files for single-key
14869 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
14870 Exim normally keeps these files open during routing, because often the same
14871 file is required several times. If the limit is reached, Exim closes the least
14872 recently used file. Note that if you are using the &'ndbm'& library, it
14873 actually opens two files for each logical DBM database, though it still counts
14874 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
14875 open files"& errors with NDBM, you need to reduce the value of
14876 &%lookup_open_max%&.
14877
14878
14879 .option max_username_length main integer 0
14880 .cindex "length of login name"
14881 .cindex "user name" "maximum length"
14882 .cindex "limit" "user name length"
14883 Some operating systems are broken in that they truncate long arguments to
14884 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
14885 this option is set greater than zero, any attempt to call &[getpwnam()]& with
14886 an argument that is longer behaves as if &[getpwnam()]& failed.
14887
14888
14889 .option message_body_newlines main bool false
14890 .cindex "message body" "newlines in variables"
14891 .cindex "newline" "in message body variables"
14892 .vindex "&$message_body$&"
14893 .vindex "&$message_body_end$&"
14894 By default, newlines in the message body are replaced by spaces when setting
14895 the &$message_body$& and &$message_body_end$& expansion variables. If this
14896 option is set true, this no longer happens.
14897
14898
14899 .option message_body_visible main integer 500
14900 .cindex "body of message" "visible size"
14901 .cindex "message body" "visible size"
14902 .vindex "&$message_body$&"
14903 .vindex "&$message_body_end$&"
14904 This option specifies how much of a message's body is to be included in the
14905 &$message_body$& and &$message_body_end$& expansion variables.
14906
14907
14908 .option message_id_header_domain main string&!! unset
14909 .cindex "&'Message-ID:'& header line"
14910 If this option is set, the string is expanded and used as the right hand side
14911 (domain) of the &'Message-ID:'& header that Exim creates if a
14912 locally-originated incoming message does not have one. &"Locally-originated"&
14913 means &"not received over TCP/IP."&
14914 Otherwise, the primary host name is used.
14915 Only letters, digits, dot and hyphen are accepted; any other characters are
14916 replaced by hyphens. If the expansion is forced to fail, or if the result is an
14917 empty string, the option is ignored.
14918
14919
14920 .option message_id_header_text main string&!! unset
14921 If this variable is set, the string is expanded and used to augment the text of
14922 the &'Message-id:'& header that Exim creates if a locally-originated incoming
14923 message does not have one. The text of this header is required by RFC 2822 to
14924 take the form of an address. By default, Exim uses its internal message id as
14925 the local part, and the primary host name as the domain. If this option is set,
14926 it is expanded, and provided the expansion is not forced to fail, and does not
14927 yield an empty string, the result is inserted into the header immediately
14928 before the @, separated from the internal message id by a dot. Any characters
14929 that are illegal in an address are automatically converted into hyphens. This
14930 means that variables such as &$tod_log$& can be used, because the spaces and
14931 colons will become hyphens.
14932
14933
14934 .option message_logs main boolean true
14935 .cindex "message logs" "disabling"
14936 .cindex "log" "message log; disabling"
14937 If this option is turned off, per-message log files are not created in the
14938 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
14939 Exim, by reducing the number of files involved in handling a message from a
14940 minimum of four (header spool file, body spool file, delivery journal, and
14941 per-message log) to three. The other major I/O activity is Exim's main log,
14942 which is not affected by this option.
14943
14944
14945 .option message_size_limit main string&!! 50M
14946 .cindex "message" "size limit"
14947 .cindex "limit" "message size"
14948 .cindex "size" "of message, limit"
14949 This option limits the maximum size of message that Exim will process. The
14950 value is expanded for each incoming connection so, for example, it can be made
14951 to depend on the IP address of the remote host for messages arriving via
14952 TCP/IP. After expansion, the value must be a sequence of decimal digits,
14953 optionally followed by K or M.
14954
14955 &*Note*&: This limit cannot be made to depend on a message's sender or any
14956 other properties of an individual message, because it has to be advertised in
14957 the server's response to EHLO. String expansion failure causes a temporary
14958 error. A value of zero means no limit, but its use is not recommended. See also
14959 &%bounce_return_size_limit%&.
14960
14961 Incoming SMTP messages are failed with a 552 error if the limit is
14962 exceeded; locally-generated messages either get a stderr message or a delivery
14963 failure message to the sender, depending on the &%-oe%& setting. Rejection of
14964 an oversized message is logged in both the main and the reject logs. See also
14965 the generic transport option &%message_size_limit%&, which limits the size of
14966 message that an individual transport can process.
14967
14968 If you use a virus-scanner and set this option to to a value larger than the
14969 maximum size that your virus-scanner is configured to support, you may get
14970 failures triggered by large mails.  The right size to configure for the
14971 virus-scanner depends upon what data is passed and the options in use but it's
14972 probably safest to just set it to a little larger than this value.  Eg, with a
14973 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
14974 some problems may result.
14975
14976 A value of 0 will disable size limit checking; Exim will still advertise the
14977 SIZE extension in an EHLO response, but without a limit, so as to permit
14978 SMTP clients to still indicate the message size along with the MAIL verb.
14979
14980
14981 .option move_frozen_messages main boolean false
14982 .cindex "frozen messages" "moving"
14983 This option, which is available only if Exim has been built with the setting
14984 .code
14985 SUPPORT_MOVE_FROZEN_MESSAGES=yes
14986 .endd
14987 in &_Local/Makefile_&, causes frozen messages and their message logs to be
14988 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
14989 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
14990 standard utilities for handling such moved messages, and they do not show up in
14991 lists generated by &%-bp%& or by the Exim monitor.
14992
14993
14994 .option mua_wrapper main boolean false
14995 Setting this option true causes Exim to run in a very restrictive mode in which
14996 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
14997 contains a full description of this facility.
14998
14999
15000
15001 .option mysql_servers main "string list" unset
15002 .cindex "MySQL" "server list"
15003 This option provides a list of MySQL servers and associated connection data, to
15004 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
15005 option is available only if Exim has been built with MySQL support.
15006
15007
15008 .option never_users main "string list&!!" unset
15009 This option is expanded just once, at the start of Exim's processing. Local
15010 message deliveries are normally run in processes that are setuid to the
15011 recipient, and remote deliveries are normally run under Exim's own uid and gid.
15012 It is usually desirable to prevent any deliveries from running as root, as a
15013 safety precaution.
15014
15015 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
15016 list of users that must not be used for local deliveries. This list is fixed in
15017 the binary and cannot be overridden by the configuration file. By default, it
15018 contains just the single user name &"root"&. The &%never_users%& runtime option
15019 can be used to add more users to the fixed list.
15020
15021 If a message is to be delivered as one of the users on the fixed list or the
15022 &%never_users%& list, an error occurs, and delivery is deferred. A common
15023 example is
15024 .code
15025 never_users = root:daemon:bin
15026 .endd
15027 Including root is redundant if it is also on the fixed list, but it does no
15028 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
15029 transport driver.
15030
15031
15032 .option openssl_options main "string list" "+no_sslv2"
15033 .cindex "OpenSSL "compatibility options"
15034 This option allows an administrator to adjust the SSL options applied
15035 by OpenSSL to connections.  It is given as a space-separated list of items,
15036 each one to be +added or -subtracted from the current value.
15037
15038 This option is only available if Exim is built against OpenSSL.  The values
15039 available for this option vary according to the age of your OpenSSL install.
15040 The &"all"& value controls a subset of flags which are available, typically
15041 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
15042 list the values known on your system and Exim should support all the
15043 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
15044 names lose the leading &"SSL_OP_"& and are lower-cased.
15045
15046 Note that adjusting the options can have severe impact upon the security of
15047 SSL as used by Exim.  It is possible to disable safety checks and shoot
15048 yourself in the foot in various unpleasant ways.  This option should not be
15049 adjusted lightly.  An unrecognised item will be detected at startup, by
15050 invoking Exim with the &%-bV%& flag.
15051
15052 The option affects Exim operating both as a server and as a client.
15053
15054 Historical note: prior to release 4.80, Exim defaulted this value to
15055 "+dont_insert_empty_fragments", which may still be needed for compatibility
15056 with some clients, but which lowers security by increasing exposure to
15057 some now infamous attacks.
15058
15059 Examples:
15060 .code
15061 # Make both old MS and old Eudora happy:
15062 openssl_options = -all +microsoft_big_sslv3_buffer \
15063                        +dont_insert_empty_fragments
15064
15065 # Disable older protocol versions:
15066 openssl_options = +no_sslv2 +no_sslv3
15067 .endd
15068
15069 Possible options may include:
15070 .ilist
15071 &`all`&
15072 .next
15073 &`allow_unsafe_legacy_renegotiation`&
15074 .next
15075 &`cipher_server_preference`&
15076 .next
15077 &`dont_insert_empty_fragments`&
15078 .next
15079 &`ephemeral_rsa`&
15080 .next
15081 &`legacy_server_connect`&
15082 .next
15083 &`microsoft_big_sslv3_buffer`&
15084 .next
15085 &`microsoft_sess_id_bug`&
15086 .next
15087 &`msie_sslv2_rsa_padding`&
15088 .next
15089 &`netscape_challenge_bug`&
15090 .next
15091 &`netscape_reuse_cipher_change_bug`&
15092 .next
15093 &`no_compression`&
15094 .next
15095 &`no_session_resumption_on_renegotiation`&
15096 .next
15097 &`no_sslv2`&
15098 .next
15099 &`no_sslv3`&
15100 .next
15101 &`no_ticket`&
15102 .next
15103 &`no_tlsv1`&
15104 .next
15105 &`no_tlsv1_1`&
15106 .next
15107 &`no_tlsv1_2`&
15108 .next
15109 &`safari_ecdhe_ecdsa_bug`&
15110 .next
15111 &`single_dh_use`&
15112 .next
15113 &`single_ecdh_use`&
15114 .next
15115 &`ssleay_080_client_dh_bug`&
15116 .next
15117 &`sslref2_reuse_cert_type_bug`&
15118 .next
15119 &`tls_block_padding_bug`&
15120 .next
15121 &`tls_d5_bug`&
15122 .next
15123 &`tls_rollback_bug`&
15124 .endlist
15125
15126 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
15127 all clients connecting using the MacOS SecureTransport TLS facility prior
15128 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
15129 to negotiate TLS then this option value might help, provided that your OpenSSL
15130 release is new enough to contain this work-around.  This may be a situation
15131 where you have to upgrade OpenSSL to get buggy clients working.
15132
15133
15134 .option oracle_servers main "string list" unset
15135 .cindex "Oracle" "server list"
15136 This option provides a list of Oracle servers and associated connection data,
15137 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
15138 The option is available only if Exim has been built with Oracle support.
15139
15140
15141 .option percent_hack_domains main "domain list&!!" unset
15142 .cindex "&""percent hack""&"
15143 .cindex "source routing" "in email address"
15144 .cindex "address" "source-routed"
15145 The &"percent hack"& is the convention whereby a local part containing a
15146 percent sign is re-interpreted as a new email address, with the percent
15147 replaced by @. This is sometimes called &"source routing"&, though that term is
15148 also applied to RFC 2822 addresses that begin with an @ character. If this
15149 option is set, Exim implements the percent facility for those domains listed,
15150 but no others. This happens before an incoming SMTP address is tested against
15151 an ACL.
15152
15153 &*Warning*&: The &"percent hack"& has often been abused by people who are
15154 trying to get round relaying restrictions. For this reason, it is best avoided
15155 if at all possible. Unfortunately, a number of less security-conscious MTAs
15156 implement it unconditionally. If you are running Exim on a gateway host, and
15157 routing mail through to internal MTAs without processing the local parts, it is
15158 a good idea to reject recipient addresses with percent characters in their
15159 local parts. Exim's default configuration does this.
15160
15161
15162 .option perl_at_start main boolean false
15163 This option is available only when Exim is built with an embedded Perl
15164 interpreter. See chapter &<<CHAPperl>>& for details of its use.
15165
15166
15167 .option perl_startup main string unset
15168 This option is available only when Exim is built with an embedded Perl
15169 interpreter. See chapter &<<CHAPperl>>& for details of its use.
15170
15171
15172 .option pgsql_servers main "string list" unset
15173 .cindex "PostgreSQL lookup type" "server list"
15174 This option provides a list of PostgreSQL servers and associated connection
15175 data, to be used in conjunction with &(pgsql)& lookups (see section
15176 &<<SECID72>>&). The option is available only if Exim has been built with
15177 PostgreSQL support.
15178
15179
15180 .option pid_file_path main string&!! "set at compile time"
15181 .cindex "daemon" "pid file path"
15182 .cindex "pid file, path for"
15183 This option sets the name of the file to which the Exim daemon writes its
15184 process id. The string is expanded, so it can contain, for example, references
15185 to the host name:
15186 .code
15187 pid_file_path = /var/log/$primary_hostname/exim.pid
15188 .endd
15189 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
15190 spool directory.
15191 The value set by the option can be overridden by the &%-oP%& command line
15192 option. A pid file is not written if a &"non-standard"& daemon is run by means
15193 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
15194
15195
15196 .option pipelining_advertise_hosts main "host list&!!" *
15197 .cindex "PIPELINING" "suppressing advertising"
15198 This option can be used to suppress the advertisement of the SMTP
15199 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
15200 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
15201 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
15202 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
15203 that clients will use it; &"out of order"& commands that are &"expected"& do
15204 not count as protocol errors (see &%smtp_max_synprot_errors%&).
15205
15206
15207 .option prdr_enable main boolean false
15208 .cindex "PRDR" "enabling on server"
15209 This option can be used to enable the Per-Recipient Data Response extension
15210 to SMTP, defined by Eric Hall.
15211 If the option is set, PRDR is advertised by Exim when operating as a server.
15212 If the client requests PRDR, and more than one recipient, for a message 
15213 an additional ACL is called for each recipient after the message content
15214 is recieved.  See section &<<SECTPRDRACL>>&.
15215
15216 .option preserve_message_logs main boolean false
15217 .cindex "message logs" "preserving"
15218 If this option is set, message log files are not deleted when messages are
15219 completed. Instead, they are moved to a sub-directory of the spool directory
15220 called &_msglog.OLD_&, where they remain available for statistical or debugging
15221 purposes. This is a dangerous option to set on systems with any appreciable
15222 volume of mail. Use with care!
15223
15224
15225 .option primary_hostname main string "see below"
15226 .cindex "name" "of local host"
15227 .cindex "host" "name of local"
15228 .cindex "local host" "name of"
15229 .vindex "&$primary_hostname$&"
15230 This specifies the name of the current host. It is used in the default EHLO or
15231 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
15232 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
15233 The value is also used by default in some SMTP response messages from an Exim
15234 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
15235
15236 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
15237 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
15238 contains only one component, Exim passes it to &[gethostbyname()]& (or
15239 &[getipnodebyname()]& when available) in order to obtain the fully qualified
15240 version. The variable &$primary_hostname$& contains the host name, whether set
15241 explicitly by this option, or defaulted.
15242
15243
15244 .option print_topbitchars main boolean false
15245 .cindex "printing characters"
15246 .cindex "8-bit characters"
15247 By default, Exim considers only those characters whose codes lie in the range
15248 32&--126 to be printing characters. In a number of circumstances (for example,
15249 when writing log entries) non-printing characters are converted into escape
15250 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
15251 is set, code values of 128 and above are also considered to be printing
15252 characters.
15253
15254 This option also affects the header syntax checks performed by the
15255 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
15256 the user's full name when constructing From: and Sender: addresses (as
15257 described in section &<<SECTconstr>>&). Setting this option can cause
15258 Exim to generate eight bit message headers that do not conform to the
15259 standards.
15260
15261
15262 .option process_log_path main string unset
15263 .cindex "process log path"
15264 .cindex "log" "process log"
15265 .cindex "&'exiwhat'&"
15266 This option sets the name of the file to which an Exim process writes its
15267 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
15268 utility script. If this option is unset, the file called &_exim-process.info_&
15269 in Exim's spool directory is used. The ability to specify the name explicitly
15270 can be useful in environments where two different Exims are running, using
15271 different spool directories.
15272
15273
15274 .option prod_requires_admin main boolean true
15275 .oindex "&%-M%&"
15276 .oindex "&%-R%&"
15277 .oindex "&%-q%&"
15278 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
15279 admin user unless &%prod_requires_admin%& is set false. See also
15280 &%queue_list_requires_admin%&.
15281
15282
15283 .option qualify_domain main string "see below"
15284 .cindex "domain" "for qualifying addresses"
15285 .cindex "address" "qualification"
15286 This option specifies the domain name that is added to any envelope sender
15287 addresses that do not have a domain qualification. It also applies to
15288 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
15289 are accepted by default only for locally-generated messages. Qualification is
15290 also applied to addresses in header lines such as &'From:'& and &'To:'& for
15291 locally-generated messages, unless the &%-bnq%& command line option is used.
15292
15293 Messages from external sources must always contain fully qualified addresses,
15294 unless the sending host matches &%sender_unqualified_hosts%& or
15295 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
15296 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
15297 necessary. Internally, Exim always works with fully qualified envelope
15298 addresses. If &%qualify_domain%& is not set, it defaults to the
15299 &%primary_hostname%& value.
15300
15301
15302 .option qualify_recipient main string "see below"
15303 This option allows you to specify a different domain for qualifying recipient
15304 addresses to the one that is used for senders. See &%qualify_domain%& above.
15305
15306
15307
15308 .option queue_domains main "domain list&!!" unset
15309 .cindex "domain" "specifying non-immediate delivery"
15310 .cindex "queueing incoming messages"
15311 .cindex "message" "queueing certain domains"
15312 This option lists domains for which immediate delivery is not required.
15313 A delivery process is started whenever a message is received, but only those
15314 domains that do not match are processed. All other deliveries wait until the
15315 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
15316
15317
15318 .option queue_list_requires_admin main boolean true
15319 .oindex "&%-bp%&"
15320 The &%-bp%& command-line option, which lists the messages that are on the
15321 queue, requires the caller to be an admin user unless
15322 &%queue_list_requires_admin%& is set false. See also &%prod_requires_admin%&.
15323
15324
15325 .option queue_only main boolean false
15326 .cindex "queueing incoming messages"
15327 .cindex "message" "queueing unconditionally"
15328 If &%queue_only%& is set, a delivery process is not automatically started
15329 whenever a message is received. Instead, the message waits on the queue for the
15330 next queue run. Even if &%queue_only%& is false, incoming messages may not get
15331 delivered immediately when certain conditions (such as heavy load) occur.
15332
15333 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
15334 and &%-odi%& command line options override &%queue_only%& unless
15335 &%queue_only_override%& is set false. See also &%queue_only_file%&,
15336 &%queue_only_load%&, and &%smtp_accept_queue%&.
15337
15338
15339 .option queue_only_file main string unset
15340 .cindex "queueing incoming messages"
15341 .cindex "message" "queueing by file existence"
15342 This option can be set to a colon-separated list of absolute path names, each
15343 one optionally preceded by &"smtp"&. When Exim is receiving a message,
15344 it tests for the existence of each listed path using a call to &[stat()]&. For
15345 each path that exists, the corresponding queueing option is set.
15346 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
15347 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
15348 .code
15349 queue_only_file = smtp/some/file
15350 .endd
15351 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
15352 &_/some/file_& exists.
15353
15354
15355 .option queue_only_load main fixed-point unset
15356 .cindex "load average"
15357 .cindex "queueing incoming messages"
15358 .cindex "message" "queueing by load"
15359 If the system load average is higher than this value, incoming messages from
15360 all sources are queued, and no automatic deliveries are started. If this
15361 happens during local or remote SMTP input, all subsequent messages received on
15362 the same SMTP connection are queued by default, whatever happens to the load in
15363 the meantime, but this can be changed by setting &%queue_only_load_latch%&
15364 false.
15365
15366 Deliveries will subsequently be performed by queue runner processes. This
15367 option has no effect on ancient operating systems on which Exim cannot
15368 determine the load average. See also &%deliver_queue_load_max%& and
15369 &%smtp_load_reserve%&.
15370
15371
15372 .option queue_only_load_latch main boolean true
15373 .cindex "load average" "re-evaluating per message"
15374 When this option is true (the default), once one message has been queued
15375 because the load average is higher than the value set by &%queue_only_load%&,
15376 all subsequent messages received on the same SMTP connection are also queued.
15377 This is a deliberate choice; even though the load average may fall below the
15378 threshold, it doesn't seem right to deliver later messages on the same
15379 connection when not delivering earlier ones. However, there are special
15380 circumstances such as very long-lived connections from scanning appliances
15381 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
15382 should be set false. This causes the value of the load average to be
15383 re-evaluated for each message.
15384
15385
15386 .option queue_only_override main boolean true
15387 .cindex "queueing incoming messages"
15388 When this option is true, the &%-od%&&'x'& command line options override the
15389 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
15390 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
15391 to override; they are accepted, but ignored.
15392
15393
15394 .option queue_run_in_order main boolean false
15395 .cindex "queue runner" "processing messages in order"
15396 If this option is set, queue runs happen in order of message arrival instead of
15397 in an arbitrary order. For this to happen, a complete list of the entire queue
15398 must be set up before the deliveries start. When the queue is all held in a
15399 single directory (the default), a single list is created for both the ordered
15400 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
15401 single list is not created when &%queue_run_in_order%& is false. In this case,
15402 the sub-directories are processed one at a time (in a random order), and this
15403 avoids setting up one huge list for the whole queue. Thus, setting
15404 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
15405 when the queue is large, because of the extra work in setting up the single,
15406 large list. In most situations, &%queue_run_in_order%& should not be set.
15407
15408
15409
15410 .option queue_run_max main integer 5
15411 .cindex "queue runner" "maximum number of"
15412 This controls the maximum number of queue runner processes that an Exim daemon
15413 can run simultaneously. This does not mean that it starts them all at once,
15414 but rather that if the maximum number are still running when the time comes to
15415 start another one, it refrains from starting another one. This can happen with
15416 very large queues and/or very sluggish deliveries. This option does not,
15417 however, interlock with other processes, so additional queue runners can be
15418 started by other means, or by killing and restarting the daemon.
15419
15420 Setting this option to zero does not suppress queue runs; rather, it disables
15421 the limit, allowing any number of simultaneous queue runner processes to be
15422 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
15423 the daemon's command line.
15424
15425 .option queue_smtp_domains main "domain list&!!" unset
15426 .cindex "queueing incoming messages"
15427 .cindex "message" "queueing remote deliveries"
15428 When this option is set, a delivery process is started whenever a message is
15429 received, routing is performed, and local deliveries take place.
15430 However, if any SMTP deliveries are required for domains that match
15431 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
15432 message waits on the queue for the next queue run. Since routing of the message
15433 has taken place, Exim knows to which remote hosts it must be delivered, and so
15434 when the queue run happens, multiple messages for the same host are delivered
15435 over a single SMTP connection. The &%-odqs%& command line option causes all
15436 SMTP deliveries to be queued in this way, and is equivalent to setting
15437 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
15438 &%queue_domains%&.
15439
15440
15441 .option receive_timeout main time 0s
15442 .cindex "timeout" "for non-SMTP input"
15443 This option sets the timeout for accepting a non-SMTP message, that is, the
15444 maximum time that Exim waits when reading a message on the standard input. If
15445 the value is zero, it will wait for ever. This setting is overridden by the
15446 &%-or%& command line option. The timeout for incoming SMTP messages is
15447 controlled by &%smtp_receive_timeout%&.
15448
15449 .option received_header_text main string&!! "see below"
15450 .cindex "customizing" "&'Received:'& header"
15451 .cindex "&'Received:'& header line" "customizing"
15452 This string defines the contents of the &'Received:'& message header that is
15453 added to each message, except for the timestamp, which is automatically added
15454 on at the end (preceded by a semicolon). The string is expanded each time it is
15455 used. If the expansion yields an empty string, no &'Received:'& header line is
15456 added to the message. Otherwise, the string should start with the text
15457 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
15458 header lines. The default setting is:
15459
15460 .code
15461 received_header_text = Received: \
15462   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
15463   {${if def:sender_ident \
15464   {from ${quote_local_part:$sender_ident} }}\
15465   ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
15466   by $primary_hostname \
15467   ${if def:received_protocol {with $received_protocol}} \
15468   ${if def:tls_in_cipher {($tls_in_cipher)\n\t}}\
15469   (Exim $version_number)\n\t\
15470   ${if def:sender_address \
15471   {(envelope-from <$sender_address>)\n\t}}\
15472   id $message_exim_id\
15473   ${if def:received_for {\n\tfor $received_for}}
15474 .endd
15475
15476 The reference to the TLS cipher is omitted when Exim is built without TLS
15477 support. The use of conditional expansions ensures that this works for both
15478 locally generated messages and messages received from remote hosts, giving
15479 header lines such as the following:
15480 .code
15481 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
15482 by marley.carol.example with esmtp (Exim 4.00)
15483 (envelope-from <bob@carol.example>)
15484 id 16IOWa-00019l-00
15485 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
15486 Received: by scrooge.carol.example with local (Exim 4.00)
15487 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
15488 .endd
15489 Until the body of the message has been received, the timestamp is the time when
15490 the message started to be received. Once the body has arrived, and all policy
15491 checks have taken place, the timestamp is updated to the time at which the
15492 message was accepted.
15493
15494
15495 .option received_headers_max main integer 30
15496 .cindex "loop" "prevention"
15497 .cindex "mail loop prevention"
15498 .cindex "&'Received:'& header line" "counting"
15499 When a message is to be delivered, the number of &'Received:'& headers is
15500 counted, and if it is greater than this parameter, a mail loop is assumed to
15501 have occurred, the delivery is abandoned, and an error message is generated.
15502 This applies to both local and remote deliveries.
15503
15504
15505 .option recipient_unqualified_hosts main "host list&!!" unset
15506 .cindex "unqualified addresses"
15507 .cindex "host" "unqualified addresses from"
15508 This option lists those hosts from which Exim is prepared to accept unqualified
15509 recipient addresses in message envelopes. The addresses are made fully
15510 qualified by the addition of the &%qualify_recipient%& value. This option also
15511 affects message header lines. Exim does not reject unqualified recipient
15512 addresses in headers, but it qualifies them only if the message came from a
15513 host that matches &%recipient_unqualified_hosts%&,
15514 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
15515 option was not set.
15516
15517
15518 .option recipients_max main integer 0
15519 .cindex "limit" "number of recipients"
15520 .cindex "recipient" "maximum number"
15521 If this option is set greater than zero, it specifies the maximum number of
15522 original recipients for any message. Additional recipients that are generated
15523 by aliasing or forwarding do not count. SMTP messages get a 452 response for
15524 all recipients over the limit; earlier recipients are delivered as normal.
15525 Non-SMTP messages with too many recipients are failed, and no deliveries are
15526 done.
15527
15528 .cindex "RCPT" "maximum number of incoming"
15529 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
15530 RCPT commands in a single message.
15531
15532
15533 .option recipients_max_reject main boolean false
15534 If this option is set true, Exim rejects SMTP messages containing too many
15535 recipients by giving 552 errors to the surplus RCPT commands, and a 554
15536 error to the eventual DATA command. Otherwise (the default) it gives a 452
15537 error to the surplus RCPT commands and accepts the message on behalf of the
15538 initial set of recipients. The remote server should then re-send the message
15539 for the remaining recipients at a later time.
15540
15541
15542 .option remote_max_parallel main integer 2
15543 .cindex "delivery" "parallelism for remote"
15544 This option controls parallel delivery of one message to a number of remote
15545 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
15546 does all the remote deliveries for a message one by one. Otherwise, if a single
15547 message has to be delivered to more than one remote host, or if several copies
15548 have to be sent to the same remote host, up to &%remote_max_parallel%&
15549 deliveries are done simultaneously. If more than &%remote_max_parallel%&
15550 deliveries are required, the maximum number of processes are started, and as
15551 each one finishes, another is begun. The order of starting processes is the
15552 same as if sequential delivery were being done, and can be controlled by the
15553 &%remote_sort_domains%& option. If parallel delivery takes place while running
15554 with debugging turned on, the debugging output from each delivery process is
15555 tagged with its process id.
15556
15557 This option controls only the maximum number of parallel deliveries for one
15558 message in one Exim delivery process. Because Exim has no central queue
15559 manager, there is no way of controlling the total number of simultaneous
15560 deliveries if the configuration allows a delivery attempt as soon as a message
15561 is received.
15562
15563 .cindex "number of deliveries"
15564 .cindex "delivery" "maximum number of"
15565 If you want to control the total number of deliveries on the system, you
15566 need to set the &%queue_only%& option. This ensures that all incoming messages
15567 are added to the queue without starting a delivery process. Then set up an Exim
15568 daemon to start queue runner processes at appropriate intervals (probably
15569 fairly often, for example, every minute), and limit the total number of queue
15570 runners by setting the &%queue_run_max%& parameter. Because each queue runner
15571 delivers only one message at a time, the maximum number of deliveries that can
15572 then take place at once is &%queue_run_max%& multiplied by
15573 &%remote_max_parallel%&.
15574
15575 If it is purely remote deliveries you want to control, use
15576 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
15577 doing the SMTP routing before queueing, so that several messages for the same
15578 host will eventually get delivered down the same connection.
15579
15580
15581 .option remote_sort_domains main "domain list&!!" unset
15582 .cindex "sorting remote deliveries"
15583 .cindex "delivery" "sorting remote"
15584 When there are a number of remote deliveries for a message, they are sorted by
15585 domain into the order given by this list. For example,
15586 .code
15587 remote_sort_domains = *.cam.ac.uk:*.uk
15588 .endd
15589 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
15590 then to those in the &%uk%& domain, then to any others.
15591
15592
15593 .option retry_data_expire main time 7d
15594 .cindex "hints database" "data expiry"
15595 This option sets a &"use before"& time on retry information in Exim's hints
15596 database. Any older retry data is ignored. This means that, for example, once a
15597 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
15598 past failures.
15599
15600
15601 .option retry_interval_max main time 24h
15602 .cindex "retry" "limit on interval"
15603 .cindex "limit" "on retry interval"
15604 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
15605 intervals between delivery attempts for messages that cannot be delivered
15606 straight away. This option sets an overall limit to the length of time between
15607 retries. It cannot be set greater than 24 hours; any attempt to do so forces
15608 the default value.
15609
15610
15611 .option return_path_remove main boolean true
15612 .cindex "&'Return-path:'& header line" "removing"
15613 RFC 2821, section 4.4, states that an SMTP server must insert a
15614 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
15615 The &'Return-path:'& header preserves the sender address as received in the
15616 MAIL command. This description implies that this header should not be present
15617 in an incoming message. If &%return_path_remove%& is true, any existing
15618 &'Return-path:'& headers are removed from messages at the time they are
15619 received. Exim's transports have options for adding &'Return-path:'& headers at
15620 the time of delivery. They are normally used only for final local deliveries.
15621
15622
15623 .option return_size_limit main integer 100K
15624 This option is an obsolete synonym for &%bounce_return_size_limit%&.
15625
15626
15627 .option rfc1413_hosts main "host list&!!" *
15628 .cindex "RFC 1413"
15629 .cindex "host" "for RFC 1413 calls"
15630 RFC 1413 identification calls are made to any client host which matches an item
15631 in the list.
15632
15633 .option rfc1413_query_timeout main time 5s
15634 .cindex "RFC 1413" "query timeout"
15635 .cindex "timeout" "for RFC 1413 call"
15636 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
15637 no RFC 1413 calls are ever made.
15638
15639
15640 .option sender_unqualified_hosts main "host list&!!" unset
15641 .cindex "unqualified addresses"
15642 .cindex "host" "unqualified addresses from"
15643 This option lists those hosts from which Exim is prepared to accept unqualified
15644 sender addresses. The addresses are made fully qualified by the addition of
15645 &%qualify_domain%&. This option also affects message header lines. Exim does
15646 not reject unqualified addresses in headers that contain sender addresses, but
15647 it qualifies them only if the message came from a host that matches
15648 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
15649 using TCP/IP), and the &%-bnq%& option was not set.
15650
15651
15652 .option smtp_accept_keepalive main boolean true
15653 .cindex "keepalive" "on incoming connection"
15654 This option controls the setting of the SO_KEEPALIVE option on incoming
15655 TCP/IP socket connections. When set, it causes the kernel to probe idle
15656 connections periodically, by sending packets with &"old"& sequence numbers. The
15657 other end of the connection should send an acknowledgment if the connection is
15658 still okay or a reset if the connection has been aborted. The reason for doing
15659 this is that it has the beneficial effect of freeing up certain types of
15660 connection that can get stuck when the remote host is disconnected without
15661 tidying up the TCP/IP call properly. The keepalive mechanism takes several
15662 hours to detect unreachable hosts.
15663
15664
15665
15666 .option smtp_accept_max main integer 20
15667 .cindex "limit" "incoming SMTP connections"
15668 .cindex "SMTP" "incoming connection count"
15669 .cindex "inetd"
15670 This option specifies the maximum number of simultaneous incoming SMTP calls
15671 that Exim will accept. It applies only to the listening daemon; there is no
15672 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
15673 value is set to zero, no limit is applied. However, it is required to be
15674 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
15675 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
15676
15677 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
15678 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
15679 that limit has not been reached for the client host, &%smtp_accept_reserve%&
15680 and &%smtp_load_reserve%& are then checked before accepting the connection.
15681
15682
15683 .option smtp_accept_max_nonmail main integer 10
15684 .cindex "limit" "non-mail SMTP commands"
15685 .cindex "SMTP" "limiting non-mail commands"
15686 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
15687 the connection if there are too many. This option defines &"too many"&. The
15688 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
15689 client looping sending EHLO, for example. The check is applied only if the
15690 client host matches &%smtp_accept_max_nonmail_hosts%&.
15691
15692 When a new message is expected, one occurrence of RSET is not counted. This
15693 allows a client to send one RSET between messages (this is not necessary,
15694 but some clients do it). Exim also allows one uncounted occurrence of HELO
15695 or EHLO, and one occurrence of STARTTLS between messages. After
15696 starting up a TLS session, another EHLO is expected, and so it too is not
15697 counted. The first occurrence of AUTH in a connection, or immediately
15698 following STARTTLS is not counted. Otherwise, all commands other than
15699 MAIL, RCPT, DATA, and QUIT are counted.
15700
15701
15702 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
15703 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
15704 check by setting this option. The default value makes it apply to all hosts. By
15705 changing the value, you can exclude any badly-behaved hosts that you have to
15706 live with.
15707
15708
15709 . Allow this long option name to split; give it unsplit as a fifth argument
15710 . for the automatic .oindex that is generated by .option.
15711 . We insert " &~&~" which is both pretty nasty visually and results in
15712 . non-searchable text.  HowItWorks.txt mentions an option for inserting
15713 . zero-width-space, which would be nicer visually and results in (at least)
15714 . html that Firefox will split on when it's forced to reflow (rather than
15715 . inserting a horizontal scrollbar).  However, the text is still not
15716 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
15717 . the option name to split.
15718
15719 .option "smtp_accept_max_per_connection" main integer 1000 &&&
15720          smtp_accept_max_per_connection
15721 .cindex "SMTP" "limiting incoming message count"
15722 .cindex "limit" "messages per SMTP connection"
15723 The value of this option limits the number of MAIL commands that Exim is
15724 prepared to accept over a single SMTP connection, whether or not each command
15725 results in the transfer of a message. After the limit is reached, a 421
15726 response is given to subsequent MAIL commands. This limit is a safety
15727 precaution against a client that goes mad (incidents of this type have been
15728 seen).
15729
15730
15731 .option smtp_accept_max_per_host main string&!! unset
15732 .cindex "limit" "SMTP connections from one host"
15733 .cindex "host" "limiting SMTP connections from"
15734 This option restricts the number of simultaneous IP connections from a single
15735 host (strictly, from a single IP address) to the Exim daemon. The option is
15736 expanded, to enable different limits to be applied to different hosts by
15737 reference to &$sender_host_address$&. Once the limit is reached, additional
15738 connection attempts from the same host are rejected with error code 421. This
15739 is entirely independent of &%smtp_accept_reserve%&. The option's default value
15740 of zero imposes no limit. If this option is set greater than zero, it is
15741 required that &%smtp_accept_max%& be non-zero.
15742
15743 &*Warning*&: When setting this option you should not use any expansion
15744 constructions that take an appreciable amount of time. The expansion and test
15745 happen in the main daemon loop, in order to reject additional connections
15746 without forking additional processes (otherwise a denial-of-service attack
15747 could cause a vast number or processes to be created). While the daemon is
15748 doing this processing, it cannot accept any other incoming connections.
15749
15750
15751
15752 .option smtp_accept_queue main integer 0
15753 .cindex "SMTP" "incoming connection count"
15754 .cindex "queueing incoming messages"
15755 .cindex "message" "queueing by SMTP connection count"
15756 If the number of simultaneous incoming SMTP connections being handled via the
15757 listening daemon exceeds this value, messages received by SMTP are just placed
15758 on the queue; no delivery processes are started automatically. The count is
15759 fixed at the start of an SMTP connection. It cannot be updated in the
15760 subprocess that receives messages, and so the queueing or not queueing applies
15761 to all messages received in the same connection.
15762
15763 A value of zero implies no limit, and clearly any non-zero value is useful only
15764 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
15765 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
15766 various &%-od%&&'x'& command line options.
15767
15768
15769 . See the comment on smtp_accept_max_per_connection
15770
15771 .option "smtp_accept_queue_per_connection" main integer 10 &&&
15772          smtp_accept_queue_per_connection
15773 .cindex "queueing incoming messages"
15774 .cindex "message" "queueing by message count"
15775 This option limits the number of delivery processes that Exim starts
15776 automatically when receiving messages via SMTP, whether via the daemon or by
15777 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
15778 and the number of messages received in a single SMTP session exceeds this
15779 number, subsequent messages are placed on the queue, but no delivery processes
15780 are started. This helps to limit the number of Exim processes when a server
15781 restarts after downtime and there is a lot of mail waiting for it on other
15782 systems. On large systems, the default should probably be increased, and on
15783 dial-in client systems it should probably be set to zero (that is, disabled).
15784
15785
15786 .option smtp_accept_reserve main integer 0
15787 .cindex "SMTP" "incoming call count"
15788 .cindex "host" "reserved"
15789 When &%smtp_accept_max%& is set greater than zero, this option specifies a
15790 number of SMTP connections that are reserved for connections from the hosts
15791 that are specified in &%smtp_reserve_hosts%&. The value set in
15792 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
15793 restricted to this number of connections; the option specifies a minimum number
15794 of connection slots for them, not a maximum. It is a guarantee that this group
15795 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
15796 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
15797 individual host.
15798
15799 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
15800 set to 5, once there are 45 active connections (from any hosts), new
15801 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
15802 provided the other criteria for acceptance are met.
15803
15804
15805 .option smtp_active_hostname main string&!! unset
15806 .cindex "host" "name in SMTP responses"
15807 .cindex "SMTP" "host name in responses"
15808 .vindex "&$primary_hostname$&"
15809 This option is provided for multi-homed servers that want to masquerade as
15810 several different hosts. At the start of an incoming SMTP connection, its value
15811 is expanded and used instead of the value of &$primary_hostname$& in SMTP
15812 responses. For example, it is used as domain name in the response to an
15813 incoming HELO or EHLO command.
15814
15815 .vindex "&$smtp_active_hostname$&"
15816 The active hostname is placed in the &$smtp_active_hostname$& variable, which
15817 is saved with any messages that are received. It is therefore available for use
15818 in routers and transports when the message is later delivered.
15819
15820 If this option is unset, or if its expansion is forced to fail, or if the
15821 expansion results in an empty string, the value of &$primary_hostname$& is
15822 used. Other expansion failures cause a message to be written to the main and
15823 panic logs, and the SMTP command receives a temporary error. Typically, the
15824 value of &%smtp_active_hostname%& depends on the incoming interface address.
15825 For example:
15826 .code
15827 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
15828   {cox.mydomain}{box.mydomain}}
15829 .endd
15830
15831 Although &$smtp_active_hostname$& is primarily concerned with incoming
15832 messages, it is also used as the default for HELO commands in callout
15833 verification if there is no remote transport from which to obtain a
15834 &%helo_data%& value.
15835
15836 .option smtp_banner main string&!! "see below"
15837 .cindex "SMTP" "welcome banner"
15838 .cindex "banner for SMTP"
15839 .cindex "welcome banner for SMTP"
15840 .cindex "customizing" "SMTP banner"
15841 This string, which is expanded every time it is used, is output as the initial
15842 positive response to an SMTP connection. The default setting is:
15843 .code
15844 smtp_banner = $smtp_active_hostname ESMTP Exim \
15845   $version_number $tod_full
15846 .endd
15847 Failure to expand the string causes a panic error. If you want to create a
15848 multiline response to the initial SMTP connection, use &"\n"& in the string at
15849 appropriate points, but not at the end. Note that the 220 code is not included
15850 in this string. Exim adds it automatically (several times in the case of a
15851 multiline response).
15852
15853
15854 .option smtp_check_spool_space main boolean true
15855 .cindex "checking disk space"
15856 .cindex "disk space, checking"
15857 .cindex "spool directory" "checking space"
15858 When this option is set, if an incoming SMTP session encounters the SIZE
15859 option on a MAIL command, it checks that there is enough space in the
15860 spool directory's partition to accept a message of that size, while still
15861 leaving free the amount specified by &%check_spool_space%& (even if that value
15862 is zero). If there isn't enough space, a temporary error code is returned.
15863
15864
15865 .option smtp_connect_backlog main integer 20
15866 .cindex "connection backlog"
15867 .cindex "SMTP" "connection backlog"
15868 .cindex "backlog of connections"
15869 This option specifies a maximum number of waiting SMTP connections. Exim passes
15870 this value to the TCP/IP system when it sets up its listener. Once this number
15871 of connections are waiting for the daemon's attention, subsequent connection
15872 attempts are refused at the TCP/IP level. At least, that is what the manuals
15873 say; in some circumstances such connection attempts have been observed to time
15874 out instead. For large systems it is probably a good idea to increase the
15875 value (to 50, say). It also gives some protection against denial-of-service
15876 attacks by SYN flooding.
15877
15878
15879 .option smtp_enforce_sync main boolean true
15880 .cindex "SMTP" "synchronization checking"
15881 .cindex "synchronization checking in SMTP"
15882 The SMTP protocol specification requires the client to wait for a response from
15883 the server at certain points in the dialogue. Without PIPELINING these
15884 synchronization points are after every command; with PIPELINING they are
15885 fewer, but they still exist.
15886
15887 Some spamming sites send out a complete set of SMTP commands without waiting
15888 for any response. Exim protects against this by rejecting a message if the
15889 client has sent further input when it should not have. The error response &"554
15890 SMTP synchronization error"& is sent, and the connection is dropped. Testing
15891 for this error cannot be perfect because of transmission delays (unexpected
15892 input may be on its way but not yet received when Exim checks). However, it
15893 does detect many instances.
15894
15895 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
15896 If you want to disable the check selectively (for example, only for certain
15897 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
15898 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
15899
15900
15901
15902 .option smtp_etrn_command main string&!! unset
15903 .cindex "ETRN" "command to be run"
15904 .vindex "&$domain$&"
15905 If this option is set, the given command is run whenever an SMTP ETRN
15906 command is received from a host that is permitted to issue such commands (see
15907 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
15908 are independently expanded. The expansion variable &$domain$& is set to the
15909 argument of the ETRN command, and no syntax checking is done on it. For
15910 example:
15911 .code
15912 smtp_etrn_command = /etc/etrn_command $domain \
15913                     $sender_host_address
15914 .endd
15915 A new process is created to run the command, but Exim does not wait for it to
15916 complete. Consequently, its status cannot be checked. If the command cannot be
15917 run, a line is written to the panic log, but the ETRN caller still receives
15918 a 250 success response. Exim is normally running under its own uid when
15919 receiving SMTP, so it is not possible for it to change the uid before running
15920 the command.
15921
15922
15923 .option smtp_etrn_serialize main boolean true
15924 .cindex "ETRN" "serializing"
15925 When this option is set, it prevents the simultaneous execution of more than
15926 one identical command as a result of ETRN in an SMTP connection. See
15927 section &<<SECTETRN>>& for details.
15928
15929
15930 .option smtp_load_reserve main fixed-point unset
15931 .cindex "load average"
15932 If the system load average ever gets higher than this, incoming SMTP calls are
15933 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
15934 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
15935 the load is over the limit. The option has no effect on ancient operating
15936 systems on which Exim cannot determine the load average. See also
15937 &%deliver_queue_load_max%& and &%queue_only_load%&.
15938
15939
15940
15941 .option smtp_max_synprot_errors main integer 3
15942 .cindex "SMTP" "limiting syntax and protocol errors"
15943 .cindex "limit" "SMTP syntax and protocol errors"
15944 Exim rejects SMTP commands that contain syntax or protocol errors. In
15945 particular, a syntactically invalid email address, as in this command:
15946 .code
15947 RCPT TO:<abc xyz@a.b.c>
15948 .endd
15949 causes immediate rejection of the command, before any other tests are done.
15950 (The ACL cannot be run if there is no valid address to set up for it.) An
15951 example of a protocol error is receiving RCPT before MAIL. If there are
15952 too many syntax or protocol errors in one SMTP session, the connection is
15953 dropped. The limit is set by this option.
15954
15955 .cindex "PIPELINING" "expected errors"
15956 When the PIPELINING extension to SMTP is in use, some protocol errors are
15957 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
15958 Exim assumes that PIPELINING will be used if it advertises it (see
15959 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
15960 not count towards the limit.
15961
15962
15963
15964 .option smtp_max_unknown_commands main integer 3
15965 .cindex "SMTP" "limiting unknown commands"
15966 .cindex "limit" "unknown SMTP commands"
15967 If there are too many unrecognized commands in an incoming SMTP session, an
15968 Exim server drops the connection. This is a defence against some kinds of abuse
15969 that subvert web
15970 clients
15971 into making connections to SMTP ports; in these circumstances, a number of
15972 non-SMTP command lines are sent first.
15973
15974
15975
15976 .option smtp_ratelimit_hosts main "host list&!!" unset
15977 .cindex "SMTP" "rate limiting"
15978 .cindex "limit" "rate of message arrival"
15979 .cindex "RCPT" "rate limiting"
15980 Some sites find it helpful to be able to limit the rate at which certain hosts
15981 can send them messages, and the rate at which an individual message can specify
15982 recipients.
15983
15984 Exim has two rate-limiting facilities. This section describes the older
15985 facility, which can limit rates within a single connection. The newer
15986 &%ratelimit%& ACL condition can limit rates across all connections. See section
15987 &<<SECTratelimiting>>& for details of the newer facility.
15988
15989 When a host matches &%smtp_ratelimit_hosts%&, the values of
15990 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
15991 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
15992 respectively. Each option, if set, must contain a set of four comma-separated
15993 values:
15994
15995 .ilist
15996 A threshold, before which there is no rate limiting.
15997 .next
15998 An initial time delay. Unlike other times in Exim, numbers with decimal
15999 fractional parts are allowed here.
16000 .next
16001 A factor by which to increase the delay each time.
16002 .next
16003 A maximum value for the delay. This should normally be less than 5 minutes,
16004 because after that time, the client is liable to timeout the SMTP command.
16005 .endlist
16006
16007 For example, these settings have been used successfully at the site which
16008 first suggested this feature, for controlling mail from their customers:
16009 .code
16010 smtp_ratelimit_mail = 2,0.5s,1.05,4m
16011 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
16012 .endd
16013 The first setting specifies delays that are applied to MAIL commands after
16014 two have been received over a single connection. The initial delay is 0.5
16015 seconds, increasing by a factor of 1.05 each time. The second setting applies
16016 delays to RCPT commands when more than four occur in a single message.
16017
16018
16019 .option smtp_ratelimit_mail main string unset
16020 See &%smtp_ratelimit_hosts%& above.
16021
16022
16023 .option smtp_ratelimit_rcpt main string unset
16024 See &%smtp_ratelimit_hosts%& above.
16025
16026
16027 .option smtp_receive_timeout main time 5m
16028 .cindex "timeout" "for SMTP input"
16029 .cindex "SMTP" "input timeout"
16030 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
16031 input, including batch SMTP. If a line of input (either an SMTP command or a
16032 data line) is not received within this time, the SMTP connection is dropped and
16033 the message is abandoned.
16034 A line is written to the log containing one of the following messages:
16035 .code
16036 SMTP command timeout on connection from...
16037 SMTP data timeout on connection from...
16038 .endd
16039 The former means that Exim was expecting to read an SMTP command; the latter
16040 means that it was in the DATA phase, reading the contents of a message.
16041
16042
16043 .oindex "&%-os%&"
16044 The value set by this option can be overridden by the
16045 &%-os%& command-line option. A setting of zero time disables the timeout, but
16046 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
16047 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
16048 timeout is controlled by &%receive_timeout%& and &%-or%&.
16049
16050
16051 .option smtp_reserve_hosts main "host list&!!" unset
16052 This option defines hosts for which SMTP connections are reserved; see
16053 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
16054
16055
16056 .option smtp_return_error_details main boolean false
16057 .cindex "SMTP" "details policy failures"
16058 .cindex "policy control" "rejection, returning details"
16059 In the default state, Exim uses bland messages such as
16060 &"Administrative prohibition"& when it rejects SMTP commands for policy
16061 reasons. Many sysadmins like this because it gives away little information
16062 to spammers. However, some other sysadmins who are applying strict checking
16063 policies want to give out much fuller information about failures. Setting
16064 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
16065 example, instead of &"Administrative prohibition"&, it might give:
16066 .code
16067 550-Rejected after DATA: '>' missing at end of address:
16068 550 failing address in "From" header is: <user@dom.ain
16069 .endd
16070
16071 .option spamd_address main string "see below"
16072 This option is available when Exim is compiled with the content-scanning
16073 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
16074 The default value is
16075 .code
16076 127.0.0.1 783
16077 .endd
16078 See section &<<SECTscanspamass>>& for more details.
16079
16080
16081
16082 .option split_spool_directory main boolean false
16083 .cindex "multiple spool directories"
16084 .cindex "spool directory" "split"
16085 .cindex "directories, multiple"
16086 If this option is set, it causes Exim to split its input directory into 62
16087 subdirectories, each with a single alphanumeric character as its name. The
16088 sixth character of the message id is used to allocate messages to
16089 subdirectories; this is the least significant base-62 digit of the time of
16090 arrival of the message.
16091
16092 Splitting up the spool in this way may provide better performance on systems
16093 where there are long mail queues, by reducing the number of files in any one
16094 directory. The msglog directory is also split up in a similar way to the input
16095 directory; however, if &%preserve_message_logs%& is set, all old msglog files
16096 are still placed in the single directory &_msglog.OLD_&.
16097
16098 It is not necessary to take any special action for existing messages when
16099 changing &%split_spool_directory%&. Exim notices messages that are in the
16100 &"wrong"& place, and continues to process them. If the option is turned off
16101 after a period of being on, the subdirectories will eventually empty and be
16102 automatically deleted.
16103
16104 When &%split_spool_directory%& is set, the behaviour of queue runner processes
16105 changes. Instead of creating a list of all messages in the queue, and then
16106 trying to deliver each one in turn, it constructs a list of those in one
16107 sub-directory and tries to deliver them, before moving on to the next
16108 sub-directory. The sub-directories are processed in a random order. This
16109 spreads out the scanning of the input directories, and uses less memory. It is
16110 particularly beneficial when there are lots of messages on the queue. However,
16111 if &%queue_run_in_order%& is set, none of this new processing happens. The
16112 entire queue has to be scanned and sorted before any deliveries can start.
16113
16114
16115 .option spool_directory main string&!! "set at compile time"
16116 .cindex "spool directory" "path to"
16117 This defines the directory in which Exim keeps its spool, that is, the messages
16118 it is waiting to deliver. The default value is taken from the compile-time
16119 configuration setting, if there is one. If not, this option must be set. The
16120 string is expanded, so it can contain, for example, a reference to
16121 &$primary_hostname$&.
16122
16123 If the spool directory name is fixed on your installation, it is recommended
16124 that you set it at build time rather than from this option, particularly if the
16125 log files are being written to the spool directory (see &%log_file_path%&).
16126 Otherwise log files cannot be used for errors that are detected early on, such
16127 as failures in the configuration file.
16128
16129 By using this option to override the compiled-in path, it is possible to run
16130 tests of Exim without using the standard spool.
16131
16132 .option sqlite_lock_timeout main time 5s
16133 .cindex "sqlite lookup type" "lock timeout"
16134 This option controls the timeout that the &(sqlite)& lookup uses when trying to
16135 access an SQLite database. See section &<<SECTsqlite>>& for more details.
16136
16137 .option strict_acl_vars main boolean false
16138 .cindex "&ACL;" "variables, handling unset"
16139 This option controls what happens if a syntactically valid but undefined ACL
16140 variable is referenced. If it is false (the default), an empty string
16141 is substituted; if it is true, an error is generated. See section
16142 &<<SECTaclvariables>>& for details of ACL variables.
16143
16144 .option strip_excess_angle_brackets main boolean false
16145 .cindex "angle brackets, excess"
16146 If this option is set, redundant pairs of angle brackets round &"route-addr"&
16147 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
16148 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
16149 passed on to another MTA, the excess angle brackets are not passed on. If this
16150 option is not set, multiple pairs of angle brackets cause a syntax error.
16151
16152
16153 .option strip_trailing_dot main boolean false
16154 .cindex "trailing dot on domain"
16155 .cindex "dot" "trailing on domain"
16156 If this option is set, a trailing dot at the end of a domain in an address is
16157 ignored. If this is in the envelope and the message is passed on to another
16158 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
16159 domain causes a syntax error.
16160 However, addresses in header lines are checked only when an ACL requests header
16161 syntax checking.
16162
16163
16164 .option syslog_duplication main boolean true
16165 .cindex "syslog" "duplicate log lines; suppressing"
16166 When Exim is logging to syslog, it writes the log lines for its three
16167 separate logs at different syslog priorities so that they can in principle
16168 be separated on the logging hosts. Some installations do not require this
16169 separation, and in those cases, the duplication of certain log lines is a
16170 nuisance. If &%syslog_duplication%& is set false, only one copy of any
16171 particular log line is written to syslog. For lines that normally go to
16172 both the main log and the reject log, the reject log version (possibly
16173 containing message header lines) is written, at LOG_NOTICE priority.
16174 Lines that normally go to both the main and the panic log are written at
16175 the LOG_ALERT priority.
16176
16177
16178 .option syslog_facility main string unset
16179 .cindex "syslog" "facility; setting"
16180 This option sets the syslog &"facility"& name, used when Exim is logging to
16181 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
16182 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
16183 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
16184 details of Exim's logging.
16185
16186
16187
16188 .option syslog_processname main string &`exim`&
16189 .cindex "syslog" "process name; setting"
16190 This option sets the syslog &"ident"& name, used when Exim is logging to
16191 syslog. The value must be no longer than 32 characters. See chapter
16192 &<<CHAPlog>>& for details of Exim's logging.
16193
16194
16195
16196 .option syslog_timestamp main boolean true
16197 .cindex "syslog" "timestamps"
16198 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
16199 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
16200 details of Exim's logging.
16201
16202
16203 .option system_filter main string&!! unset
16204 .cindex "filter" "system filter"
16205 .cindex "system filter" "specifying"
16206 .cindex "Sieve filter" "not available for system filter"
16207 This option specifies an Exim filter file that is applied to all messages at
16208 the start of each delivery attempt, before any routing is done. System filters
16209 must be Exim filters; they cannot be Sieve filters. If the system filter
16210 generates any deliveries to files or pipes, or any new mail messages, the
16211 appropriate &%system_filter_..._transport%& option(s) must be set, to define
16212 which transports are to be used. Details of this facility are given in chapter
16213 &<<CHAPsystemfilter>>&.
16214
16215
16216 .option system_filter_directory_transport main string&!! unset
16217 .vindex "&$address_file$&"
16218 This sets the name of the transport driver that is to be used when the
16219 &%save%& command in a system message filter specifies a path ending in &"/"&,
16220 implying delivery of each message into a separate file in some directory.
16221 During the delivery, the variable &$address_file$& contains the path name.
16222
16223
16224 .option system_filter_file_transport main string&!! unset
16225 .cindex "file" "transport for system filter"
16226 This sets the name of the transport driver that is to be used when the &%save%&
16227 command in a system message filter specifies a path not ending in &"/"&. During
16228 the delivery, the variable &$address_file$& contains the path name.
16229
16230 .option system_filter_group main string unset
16231 .cindex "gid (group id)" "system filter"
16232 This option is used only when &%system_filter_user%& is also set. It sets the
16233 gid under which the system filter is run, overriding any gid that is associated
16234 with the user. The value may be numerical or symbolic.
16235
16236 .option system_filter_pipe_transport main string&!! unset
16237 .cindex "&(pipe)& transport" "for system filter"
16238 .vindex "&$address_pipe$&"
16239 This specifies the transport driver that is to be used when a &%pipe%& command
16240 is used in a system filter. During the delivery, the variable &$address_pipe$&
16241 contains the pipe command.
16242
16243
16244 .option system_filter_reply_transport main string&!! unset
16245 .cindex "&(autoreply)& transport" "for system filter"
16246 This specifies the transport driver that is to be used when a &%mail%& command
16247 is used in a system filter.
16248
16249
16250 .option system_filter_user main string unset
16251 .cindex "uid (user id)" "system filter"
16252 If this option is set to root, the system filter is run in the main Exim
16253 delivery process, as root.  Otherwise, the system filter runs in a separate
16254 process, as the given user, defaulting to the Exim run-time user.
16255 Unless the string consists entirely of digits, it
16256 is looked up in the password data. Failure to find the named user causes a
16257 configuration error. The gid is either taken from the password data, or
16258 specified by &%system_filter_group%&. When the uid is specified numerically,
16259 &%system_filter_group%& is required to be set.
16260
16261 If the system filter generates any pipe, file, or reply deliveries, the uid
16262 under which the filter is run is used when transporting them, unless a
16263 transport option overrides.
16264
16265
16266 .option tcp_nodelay main boolean true
16267 .cindex "daemon" "TCP_NODELAY on sockets"
16268 .cindex "Nagle algorithm"
16269 .cindex "TCP_NODELAY on listening sockets"
16270 If this option is set false, it stops the Exim daemon setting the
16271 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
16272 turns off the &"Nagle algorithm"&, which is a way of improving network
16273 performance in interactive (character-by-character) situations. Turning it off
16274 should improve Exim's performance a bit, so that is what happens by default.
16275 However, it appears that some broken clients cannot cope, and time out. Hence
16276 this option. It affects only those sockets that are set up for listening by the
16277 daemon. Sockets created by the smtp transport for delivering mail always set
16278 TCP_NODELAY.
16279
16280
16281 .option timeout_frozen_after main time 0s
16282 .cindex "frozen messages" "timing out"
16283 .cindex "timeout" "frozen messages"
16284 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
16285 message of any kind that has been on the queue for longer than the given time
16286 is automatically cancelled at the next queue run. If the frozen message is a
16287 bounce message, it is just discarded; otherwise, a bounce is sent to the
16288 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
16289 If you want to timeout frozen bounce messages earlier than other kinds of
16290 frozen message, see &%ignore_bounce_errors_after%&.
16291
16292 &*Note:*& the default value of zero means no timeouts; with this setting,
16293 frozen messages remain on the queue forever (except for any frozen bounce
16294 messages that are released by &%ignore_bounce_errors_after%&).
16295
16296
16297 .option timezone main string unset
16298 .cindex "timezone, setting"
16299 The value of &%timezone%& is used to set the environment variable TZ while
16300 running Exim (if it is different on entry). This ensures that all timestamps
16301 created by Exim are in the required timezone. If you want all your timestamps
16302 to be in UTC (aka GMT) you should set
16303 .code
16304 timezone = UTC
16305 .endd
16306 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
16307 or, if that is not set, from the value of the TZ environment variable when Exim
16308 is built. If &%timezone%& is set to the empty string, either at build or run
16309 time, any existing TZ variable is removed from the environment when Exim
16310 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
16311 unfortunately not all, operating systems.
16312
16313
16314 .option tls_advertise_hosts main "host list&!!" unset
16315 .cindex "TLS" "advertising"
16316 .cindex "encryption" "on SMTP connection"
16317 .cindex "SMTP" "encrypted connection"
16318 When Exim is built with support for TLS encrypted connections, the availability
16319 of the STARTTLS command to set up an encrypted session is advertised in
16320 response to EHLO only to those client hosts that match this option. See
16321 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
16322
16323
16324 .option tls_certificate main string&!! unset
16325 .cindex "TLS" "server certificate; location of"
16326 .cindex "certificate" "server, location of"
16327 The value of this option is expanded, and must then be the absolute path to a
16328 file which contains the server's certificates. The server's private key is also
16329 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
16330 &<<CHAPTLS>>& for further details.
16331
16332 &*Note*&: The certificates defined by this option are used only when Exim is
16333 receiving incoming messages as a server. If you want to supply certificates for
16334 use when sending messages as a client, you must set the &%tls_certificate%&
16335 option in the relevant &(smtp)& transport.
16336
16337 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
16338 if the OpenSSL build supports TLS extensions and the TLS client sends the
16339 Server Name Indication extension, then this option and others documented in
16340 &<<SECTtlssni>>& will be re-expanded.
16341
16342 .option tls_crl main string&!! unset
16343 .cindex "TLS" "server certificate revocation list"
16344 .cindex "certificate" "revocation list for server"
16345 This option specifies a certificate revocation list. The expanded value must
16346 be the name of a file that contains a CRL in PEM format.
16347
16348 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16349
16350
16351 .option tls_dh_max_bits main integer 2236
16352 .cindex "TLS" "D-H bit count"
16353 The number of bits used for Diffie-Hellman key-exchange may be suggested by
16354 the chosen TLS library.  That value might prove to be too high for
16355 interoperability.  This option provides a maximum clamp on the value
16356 suggested, trading off security for interoperability.
16357
16358 The value must be at least 1024.
16359
16360 The value 2236 was chosen because, at time of adding the option, it was the
16361 hard-coded maximum value supported by the NSS cryptographic library, as used
16362 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
16363
16364 If you prefer more security and are willing to break some clients, raise this
16365 number.
16366
16367 Note that the value passed to GnuTLS for *generating* a new prime may be a
16368 little less than this figure, because GnuTLS is inexact and may produce a
16369 larger prime than requested.
16370
16371
16372 .option tls_dhparam main string&!! unset
16373 .cindex "TLS" "D-H parameters for server"
16374 The value of this option is expanded and indicates the source of DH parameters
16375 to be used by Exim.
16376
16377 If it is a filename starting with a &`/`&, then it names a file from which DH
16378 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
16379 PKCS#3 representation of the DH prime.  If the file does not exist, for
16380 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
16381 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
16382 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
16383 and treated as though the &%tls_dhparam%& were set to "none".
16384
16385 If this option expands to the string "none", then no DH parameters will be
16386 loaded by Exim.
16387
16388 If this option expands to the string "historic" and Exim is using GnuTLS, then
16389 Exim will attempt to load a file from inside the spool directory.  If the file
16390 does not exist, Exim will attempt to create it.
16391 See section &<<SECTgnutlsparam>>& for further details.
16392
16393 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
16394 a default DH prime; the default is the 2048 bit prime described in section
16395 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
16396 in IKE is assigned number 23.
16397
16398 Otherwise, the option must expand to the name used by Exim for any of a number
16399 of DH primes specified in RFC 2409, RFC 3526 and RFC 5114.  As names, Exim uses
16400 "ike" followed by the number used by IKE, of "default" which corresponds to
16401 "ike23".
16402
16403 The available primes are:
16404 &`ike1`&, &`ike2`&, &`ike5`&,
16405 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
16406 &`ike22`&, &`ike23`& (aka &`default`&) and &`ike24`&.
16407
16408 Some of these will be too small to be accepted by clients.
16409 Some may be too large to be accepted by clients.
16410
16411 The TLS protocol does not negotiate an acceptable size for this; clients tend
16412 to hard-drop connections if what is offered by the server is unacceptable,
16413 whether too large or too small, and there's no provision for the client to
16414 tell the server what these constraints are.  Thus, as a server operator, you
16415 need to make an educated guess as to what is most likely to work for your
16416 userbase.
16417
16418 Some known size constraints suggest that a bit-size in the range 2048 to 2236
16419 is most likely to maximise interoperability.  The upper bound comes from
16420 applications using the Mozilla Network Security Services (NSS) library, which
16421 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
16422 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
16423 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
16424 acceptable bound from 1024 to 2048.
16425
16426
16427 .option tls_ocsp_file main string&!! unset
16428 This option
16429 must if set expand to the absolute path to a file which contains a current
16430 status proof for the server's certificate, as obtained from the
16431 Certificate Authority.
16432
16433
16434 .option tls_on_connect_ports main "string list" unset
16435 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
16436 operate the obsolete SSMTP (SMTPS) protocol, where a TLS session is immediately
16437 set up without waiting for the client to issue a STARTTLS command. For
16438 further details, see section &<<SECTsupobssmt>>&.
16439
16440
16441
16442 .option tls_privatekey main string&!! unset
16443 .cindex "TLS" "server private key; location of"
16444 The value of this option is expanded, and must then be the absolute path to a
16445 file which contains the server's private key. If this option is unset, or if
16446 the expansion is forced to fail, or the result is an empty string, the private
16447 key is assumed to be in the same file as the server's certificates. See chapter
16448 &<<CHAPTLS>>& for further details.
16449
16450 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16451
16452
16453 .option tls_remember_esmtp main boolean false
16454 .cindex "TLS" "esmtp state; remembering"
16455 .cindex "TLS" "broken clients"
16456 If this option is set true, Exim violates the RFCs by remembering that it is in
16457 &"esmtp"& state after successfully negotiating a TLS session. This provides
16458 support for broken clients that fail to send a new EHLO after starting a
16459 TLS session.
16460
16461
16462 .option tls_require_ciphers main string&!! unset
16463 .cindex "TLS" "requiring specific ciphers"
16464 .cindex "cipher" "requiring specific"
16465 This option controls which ciphers can be used for incoming TLS connections.
16466 The &(smtp)& transport has an option of the same name for controlling outgoing
16467 connections. This option is expanded for each connection, so can be varied for
16468 different clients if required. The value of this option must be a list of
16469 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
16470 in somewhat different ways. If GnuTLS is being used, the client controls the
16471 preference order of the available ciphers. Details are given in sections
16472 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
16473
16474
16475 .option tls_try_verify_hosts main "host list&!!" unset
16476 .cindex "TLS" "client certificate verification"
16477 .cindex "certificate" "verification of client"
16478 See &%tls_verify_hosts%& below.
16479
16480
16481 .option tls_verify_certificates main string&!! system
16482 .cindex "TLS" "client certificate verification"
16483 .cindex "certificate" "verification of client"
16484 The value of this option is expanded, and must then be either the
16485 word "system"
16486 or the absolute path to
16487 a file or directory containing permitted certificates for clients that
16488 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&.
16489
16490 The "system" value for the option will use a
16491 system default location compiled into the SSL library.
16492 This is not available for GnuTLS versions preceding 3.0.20,
16493 and will be taken as empty; an explicit location
16494 must be specified.
16495
16496 The use of a directory for the option value is not avilable for GnuTLS versions
16497 preceding 3.3.6 and a single file must be used.
16498
16499 With OpenSSL the certificates specified
16500 explicitly
16501 either by file or directory
16502 are added to those given by the system default location.
16503
16504 With OpenSSL the certificates specified
16505 explicitly
16506 either by file or directory
16507 are added to those given by the system default location.
16508
16509 These certificates should be for the certificate authorities trusted, rather
16510 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
16511 the value is a file then the certificates are sent by Exim as a server to
16512 connecting clients, defining the list of accepted certificate authorities.
16513 Thus the values defined should be considered public data.  To avoid this,
16514 use the explicit directory version.
16515
16516 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16517
16518 A forced expansion failure or setting to an empty string is equivalent to
16519 being unset.
16520
16521
16522 .option tls_verify_hosts main "host list&!!" unset
16523 .cindex "TLS" "client certificate verification"
16524 .cindex "certificate" "verification of client"
16525 This option, along with &%tls_try_verify_hosts%&, controls the checking of
16526 certificates from clients. The expected certificates are defined by
16527 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
16528 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
16529 &%tls_verify_certificates%& is not set.
16530
16531 Any client that matches &%tls_verify_hosts%& is constrained by
16532 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
16533 present one of the listed certificates. If it does not, the connection is
16534 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
16535 the host to use TLS. It can still send SMTP commands through unencrypted
16536 connections. Forcing a client to use TLS has to be done separately using an
16537 ACL to reject inappropriate commands when the connection is not encrypted.
16538
16539 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
16540 matches this option (but not &%tls_verify_hosts%&), Exim requests a
16541 certificate and checks it against &%tls_verify_certificates%&, but does not
16542 abort the connection if there is no certificate or if it does not match. This
16543 state can be detected in an ACL, which makes it possible to implement policies
16544 such as &"accept for relay only if a verified certificate has been received,
16545 but accept for local delivery if encrypted, even without a verified
16546 certificate"&.
16547
16548 Client hosts that match neither of these lists are not asked to present
16549 certificates.
16550
16551
16552 .option trusted_groups main "string list&!!" unset
16553 .cindex "trusted groups"
16554 .cindex "groups" "trusted"
16555 This option is expanded just once, at the start of Exim's processing. If this
16556 option is set, any process that is running in one of the listed groups, or
16557 which has one of them as a supplementary group, is trusted. The groups can be
16558 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
16559 details of what trusted callers are permitted to do. If neither
16560 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
16561 are trusted.
16562
16563 .option trusted_users main "string list&!!" unset
16564 .cindex "trusted users"
16565 .cindex "user" "trusted"
16566 This option is expanded just once, at the start of Exim's processing. If this
16567 option is set, any process that is running as one of the listed users is
16568 trusted. The users can be specified numerically or by name. See section
16569 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
16570 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
16571 Exim user are trusted.
16572
16573 .option unknown_login main string&!! unset
16574 .cindex "uid (user id)" "unknown caller"
16575 .vindex "&$caller_uid$&"
16576 This is a specialized feature for use in unusual configurations. By default, if
16577 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
16578 gives up. The &%unknown_login%& option can be used to set a login name to be
16579 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
16580 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
16581 is used for the user's real name (gecos field), unless this has been set by the
16582 &%-F%& option.
16583
16584 .option unknown_username main string unset
16585 See &%unknown_login%&.
16586
16587 .option untrusted_set_sender main "address list&!!" unset
16588 .cindex "trusted users"
16589 .cindex "sender" "setting by untrusted user"
16590 .cindex "untrusted user setting sender"
16591 .cindex "user" "untrusted setting sender"
16592 .cindex "envelope sender"
16593 When an untrusted user submits a message to Exim using the standard input, Exim
16594 normally creates an envelope sender address from the user's login and the
16595 default qualification domain. Data from the &%-f%& option (for setting envelope
16596 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
16597 is used) is ignored.
16598
16599 However, untrusted users are permitted to set an empty envelope sender address,
16600 to declare that a message should never generate any bounces. For example:
16601 .code
16602 exim -f '<>' user@domain.example
16603 .endd
16604 .vindex "&$sender_ident$&"
16605 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
16606 other envelope sender addresses in a controlled way. When it is set, untrusted
16607 users are allowed to set envelope sender addresses that match any of the
16608 patterns in the list. Like all address lists, the string is expanded. The
16609 identity of the user is in &$sender_ident$&, so you can, for example, restrict
16610 users to setting senders that start with their login ids
16611 followed by a hyphen
16612 by a setting like this:
16613 .code
16614 untrusted_set_sender = ^$sender_ident-
16615 .endd
16616 If you want to allow untrusted users to set envelope sender addresses without
16617 restriction, you can use
16618 .code
16619 untrusted_set_sender = *
16620 .endd
16621 The &%untrusted_set_sender%& option applies to all forms of local input, but
16622 only to the setting of the envelope sender. It does not permit untrusted users
16623 to use the other options which trusted user can use to override message
16624 parameters. Furthermore, it does not stop Exim from removing an existing
16625 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
16626 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
16627 overriding these actions. The handling of the &'Sender:'& header is also
16628 described in section &<<SECTthesenhea>>&.
16629
16630 The log line for a message's arrival shows the envelope sender following
16631 &"<="&. For local messages, the user's login always follows, after &"U="&. In
16632 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
16633 envelope sender address, the user's login is shown in parentheses after the
16634 sender address.
16635
16636
16637 .option uucp_from_pattern main string "see below"
16638 .cindex "&""From""& line"
16639 .cindex "UUCP" "&""From""& line"
16640 Some applications that pass messages to an MTA via a command line interface use
16641 an initial line starting with &"From&~"& to pass the envelope sender. In
16642 particular, this is used by UUCP software. Exim recognizes such a line by means
16643 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
16644 matches, the sender address is constructed by expanding the contents of
16645 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
16646 default pattern recognizes lines in the following two forms:
16647 .code
16648 From ph10 Fri Jan  5 12:35 GMT 1996
16649 From ph10 Fri, 7 Jan 97 14:00:00 GMT
16650 .endd
16651 The pattern can be seen by running
16652 .code
16653 exim -bP uucp_from_pattern
16654 .endd
16655 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
16656 year in the second case. The first word after &"From&~"& is matched in the
16657 regular expression by a parenthesized subpattern. The default value for
16658 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
16659 (&"ph10"& in the example above) as the message's sender. See also
16660 &%ignore_fromline_hosts%&.
16661
16662
16663 .option uucp_from_sender main string&!! &`$1`&
16664 See &%uucp_from_pattern%& above.
16665
16666
16667 .option warn_message_file main string unset
16668 .cindex "warning of delay" "customizing the message"
16669 .cindex "customizing" "warning message"
16670 This option defines a template file containing paragraphs of text to be used
16671 for constructing the warning message which is sent by Exim when a message has
16672 been on the queue for a specified amount of time, as specified by
16673 &%delay_warning%&. Details of the file's contents are given in chapter
16674 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
16675
16676
16677 .option write_rejectlog main boolean true
16678 .cindex "reject log" "disabling"
16679 If this option is set false, Exim no longer writes anything to the reject log.
16680 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
16681 .ecindex IIDconfima
16682 .ecindex IIDmaiconf
16683
16684
16685
16686
16687 . ////////////////////////////////////////////////////////////////////////////
16688 . ////////////////////////////////////////////////////////////////////////////
16689
16690 .chapter "Generic options for routers" "CHAProutergeneric"
16691 .scindex IIDgenoprou1 "options" "generic; for routers"
16692 .scindex IIDgenoprou2 "generic options" "router"
16693 This chapter describes the generic options that apply to all routers.
16694 Those that are preconditions are marked with &Dagger; in the &"use"& field.
16695
16696 For a general description of how a router operates, see sections
16697 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
16698 which the preconditions are tested. The order of expansion of the options that
16699 provide data for a transport is: &%errors_to%&, &%headers_add%&,
16700 &%headers_remove%&, &%transport%&.
16701
16702
16703
16704 .option address_data routers string&!! unset
16705 .cindex "router" "data attached to address"
16706 The string is expanded just before the router is run, that is, after all the
16707 precondition tests have succeeded. If the expansion is forced to fail, the
16708 router declines, the value of &%address_data%& remains unchanged, and the
16709 &%more%& option controls what happens next. Other expansion failures cause
16710 delivery of the address to be deferred.
16711
16712 .vindex "&$address_data$&"
16713 When the expansion succeeds, the value is retained with the address, and can be
16714 accessed using the variable &$address_data$& in the current router, subsequent
16715 routers, and the eventual transport.
16716
16717 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
16718 that runs a user's filter file, the contents of &$address_data$& are accessible
16719 in the filter. This is not normally a problem, because such data is usually
16720 either not confidential or it &"belongs"& to the current user, but if you do
16721 put confidential data into &$address_data$& you need to remember this point.
16722
16723 Even if the router declines or passes, the value of &$address_data$& remains
16724 with the address, though it can be changed by another &%address_data%& setting
16725 on a subsequent router. If a router generates child addresses, the value of
16726 &$address_data$& propagates to them. This also applies to the special kind of
16727 &"child"& that is generated by a router with the &%unseen%& option.
16728
16729 The idea of &%address_data%& is that you can use it to look up a lot of data
16730 for the address once, and then pick out parts of the data later. For example,
16731 you could use a single LDAP lookup to return a string of the form
16732 .code
16733 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
16734 .endd
16735 In the transport you could pick out the mailbox by a setting such as
16736 .code
16737 file = ${extract{mailbox}{$address_data}}
16738 .endd
16739 This makes the configuration file less messy, and also reduces the number of
16740 lookups (though Exim does cache lookups).
16741
16742 .vindex "&$sender_address_data$&"
16743 .vindex "&$address_data$&"
16744 The &%address_data%& facility is also useful as a means of passing information
16745 from one router to another, and from a router to a transport. In addition, if
16746 &$address_data$& is set by a router when verifying a recipient address from an
16747 ACL, it remains available for use in the rest of the ACL statement. After
16748 verifying a sender, the value is transferred to &$sender_address_data$&.
16749
16750
16751
16752 .option address_test routers&!? boolean true
16753 .oindex "&%-bt%&"
16754 .cindex "router" "skipping when address testing"
16755 If this option is set false, the router is skipped when routing is being tested
16756 by means of the &%-bt%& command line option. This can be a convenience when
16757 your first router sends messages to an external scanner, because it saves you
16758 having to set the &"already scanned"& indicator when testing real address
16759 routing.
16760
16761
16762
16763 .option cannot_route_message routers string&!! unset
16764 .cindex "router" "customizing &""cannot route""& message"
16765 .cindex "customizing" "&""cannot route""& message"
16766 This option specifies a text message that is used when an address cannot be
16767 routed because Exim has run out of routers. The default message is
16768 &"Unrouteable address"&. This option is useful only on routers that have
16769 &%more%& set false, or on the very last router in a configuration, because the
16770 value that is used is taken from the last router that is considered. This
16771 includes a router that is skipped because its preconditions are not met, as
16772 well as a router that declines. For example, using the default configuration,
16773 you could put:
16774 .code
16775 cannot_route_message = Remote domain not found in DNS
16776 .endd
16777 on the first router, which is a &(dnslookup)& router with &%more%& set false,
16778 and
16779 .code
16780 cannot_route_message = Unknown local user
16781 .endd
16782 on the final router that checks for local users. If string expansion fails for
16783 this option, the default message is used. Unless the expansion failure was
16784 explicitly forced, a message about the failure is written to the main and panic
16785 logs, in addition to the normal message about the routing failure.
16786
16787
16788 .option caseful_local_part routers boolean false
16789 .cindex "case of local parts"
16790 .cindex "router" "case of local parts"
16791 By default, routers handle the local parts of addresses in a case-insensitive
16792 manner, though the actual case is preserved for transmission with the message.
16793 If you want the case of letters to be significant in a router, you must set
16794 this option true. For individual router options that contain address or local
16795 part lists (for example, &%local_parts%&), case-sensitive matching can be
16796 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
16797 more details.
16798
16799 .vindex "&$local_part$&"
16800 .vindex "&$original_local_part$&"
16801 .vindex "&$parent_local_part$&"
16802 The value of the &$local_part$& variable is forced to lower case while a
16803 router is running unless &%caseful_local_part%& is set. When a router assigns
16804 an address to a transport, the value of &$local_part$& when the transport runs
16805 is the same as it was in the router. Similarly, when a router generates child
16806 addresses by aliasing or forwarding, the values of &$original_local_part$&
16807 and &$parent_local_part$& are those that were used by the redirecting router.
16808
16809 This option applies to the processing of an address by a router. When a
16810 recipient address is being processed in an ACL, there is a separate &%control%&
16811 modifier that can be used to specify case-sensitive processing within the ACL
16812 (see section &<<SECTcontrols>>&).
16813
16814
16815
16816 .option check_local_user routers&!? boolean false
16817 .cindex "local user, checking in router"
16818 .cindex "router" "checking for local user"
16819 .cindex "&_/etc/passwd_&"
16820 .vindex "&$home$&"
16821 When this option is true, Exim checks that the local part of the recipient
16822 address (with affixes removed if relevant) is the name of an account on the
16823 local system. The check is done by calling the &[getpwnam()]& function rather
16824 than trying to read &_/etc/passwd_& directly. This means that other methods of
16825 holding password data (such as NIS) are supported. If the local part is a local
16826 user, &$home$& is set from the password data, and can be tested in other
16827 preconditions that are evaluated after this one (the order of evaluation is
16828 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
16829 overridden by &%router_home_directory%&. If the local part is not a local user,
16830 the router is skipped.
16831
16832 If you want to check that the local part is either the name of a local user
16833 or matches something else, you cannot combine &%check_local_user%& with a
16834 setting of &%local_parts%&, because that specifies the logical &'and'& of the
16835 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
16836 setting to achieve this. For example:
16837 .code
16838 local_parts = passwd;$local_part : lsearch;/etc/other/users
16839 .endd
16840 Note, however, that the side effects of &%check_local_user%& (such as setting
16841 up a home directory) do not occur when a &(passwd)& lookup is used in a
16842 &%local_parts%& (or any other) precondition.
16843
16844
16845
16846 .option condition routers&!? string&!! unset
16847 .cindex "router" "customized precondition"
16848 This option specifies a general precondition test that has to succeed for the
16849 router to be called. The &%condition%& option is the last precondition to be
16850 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
16851 result is a forced failure, or an empty string, or one of the strings &"0"& or
16852 &"no"& or &"false"& (checked without regard to the case of the letters), the
16853 router is skipped, and the address is offered to the next one.
16854
16855 If the result is any other value, the router is run (as this is the last
16856 precondition to be evaluated, all the other preconditions must be true).
16857
16858 This option is unusual in that multiple &%condition%& options may be present.
16859 All &%condition%& options must succeed.
16860
16861 The &%condition%& option provides a means of applying custom conditions to the
16862 running of routers. Note that in the case of a simple conditional expansion,
16863 the default expansion values are exactly what is wanted. For example:
16864 .code
16865 condition = ${if >{$message_age}{600}}
16866 .endd
16867 Because of the default behaviour of the string expansion, this is equivalent to
16868 .code
16869 condition = ${if >{$message_age}{600}{true}{}}
16870 .endd
16871
16872 A multiple condition example, which succeeds:
16873 .code
16874 condition = ${if >{$message_age}{600}}
16875 condition = ${if !eq{${lc:$local_part}}{postmaster}}
16876 condition = foobar
16877 .endd
16878
16879 If the expansion fails (other than forced failure) delivery is deferred. Some
16880 of the other precondition options are common special cases that could in fact
16881 be specified using &%condition%&.
16882
16883 Historical note: We have &%condition%& on ACLs and on Routers.  Routers
16884 are far older, and use one set of semantics.  ACLs are newer and when
16885 they were created, the ACL &%condition%& process was given far stricter
16886 parse semantics.  The &%bool{}%& expansion condition uses the same rules as
16887 ACLs.  The &%bool_lax{}%& expansion condition uses the same rules as
16888 Routers.  More pointedly, the &%bool_lax{}%& was written to match the existing
16889 Router rules processing behavior.
16890
16891 This is best illustrated in an example:
16892 .code
16893 # If used in an ACL condition will fail with a syntax error, but
16894 # in a router condition any extra characters are treated as a string
16895
16896 $ exim -be '${if eq {${lc:GOOGLE.com}} {google.com}} {yes} {no}}'
16897 true {yes} {no}}
16898
16899 $ exim -be '${if eq {${lc:WHOIS.com}} {google.com}} {yes} {no}}'
16900  {yes} {no}}
16901 .endd
16902 In each example above, the &%if%& statement actually ends after
16903 &"{google.com}}"&.  Since no true or false braces were defined, the
16904 default &%if%& behavior is to return a boolean true or a null answer
16905 (which evaluates to false). The rest of the line is then treated as a
16906 string. So the first example resulted in the boolean answer &"true"&
16907 with the string &" {yes} {no}}"& appended to it. The second example
16908 resulted in the null output (indicating false) with the string
16909 &" {yes} {no}}"& appended to it.
16910
16911 In fact you can put excess forward braces in too.  In the router
16912 &%condition%&, Exim's parser only looks for &"{"& symbols when they
16913 mean something, like after a &"$"& or when required as part of a
16914 conditional.  But otherwise &"{"& and &"}"& are treated as ordinary
16915 string characters.
16916
16917 Thus, in a Router, the above expansion strings will both always evaluate
16918 true, as the result of expansion is a non-empty string which doesn't
16919 match an explicit false value.  This can be tricky to debug.  By
16920 contrast, in an ACL either of those strings will always result in an
16921 expansion error because the result doesn't look sufficiently boolean.
16922
16923
16924 .option debug_print routers string&!! unset
16925 .cindex "testing" "variables in drivers"
16926 If this option is set and debugging is enabled (see the &%-d%& command line
16927 option) or in address-testing mode (see the &%-bt%& command line option),
16928 the string is expanded and included in the debugging output.
16929 If expansion of the string fails, the error message is written to the debugging
16930 output, and Exim carries on processing.
16931 This option is provided to help with checking out the values of variables and
16932 so on when debugging router configurations. For example, if a &%condition%&
16933 option appears not to be working, &%debug_print%& can be used to output the
16934 variables it references. The output happens after checks for &%domains%&,
16935 &%local_parts%&, and &%check_local_user%& but before any other preconditions
16936 are tested. A newline is added to the text if it does not end with one.
16937 The variable &$router_name$& contains the name of the router.
16938
16939
16940
16941 .option disable_logging routers boolean false
16942 If this option is set true, nothing is logged for any routing errors
16943 or for any deliveries caused by this router. You should not set this option
16944 unless you really, really know what you are doing. See also the generic
16945 transport option of the same name.
16946
16947
16948 .option domains routers&!? "domain list&!!" unset
16949 .cindex "router" "restricting to specific domains"
16950 .vindex "&$domain_data$&"
16951 If this option is set, the router is skipped unless the current domain matches
16952 the list. If the match is achieved by means of a file lookup, the data that the
16953 lookup returned for the domain is placed in &$domain_data$& for use in string
16954 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
16955 a list of the order in which preconditions are evaluated.
16956
16957
16958
16959 .option driver routers string unset
16960 This option must always be set. It specifies which of the available routers is
16961 to be used.
16962
16963
16964
16965 .option errors_to routers string&!! unset
16966 .cindex "envelope sender"
16967 .cindex "router" "changing address for errors"
16968 If a router successfully handles an address, it may assign the address to a
16969 transport for delivery or it may generate child addresses. In both cases, if
16970 there is a delivery problem during later processing, the resulting bounce
16971 message is sent to the address that results from expanding this string,
16972 provided that the address verifies successfully. The &%errors_to%& option is
16973 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
16974
16975 The &%errors_to%& setting associated with an address can be overridden if it
16976 subsequently passes through other routers that have their own &%errors_to%&
16977 settings, or if the message is delivered by a transport with a &%return_path%&
16978 setting.
16979
16980 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
16981 the expansion fails to verify, the errors address associated with the incoming
16982 address is used. At top level, this is the envelope sender. A non-forced
16983 expansion failure causes delivery to be deferred.
16984
16985 If an address for which &%errors_to%& has been set ends up being delivered over
16986 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
16987 any bounces that are generated by other MTAs on the delivery route are also
16988 sent there. You can set &%errors_to%& to the empty string by either of these
16989 settings:
16990 .code
16991 errors_to =
16992 errors_to = ""
16993 .endd
16994 An expansion item that yields an empty string has the same effect. If you do
16995 this, a locally detected delivery error for addresses processed by this router
16996 no longer gives rise to a bounce message; the error is discarded. If the
16997 address is delivered to a remote host, the return path is set to &`<>`&, unless
16998 overridden by the &%return_path%& option on the transport.
16999
17000 .vindex "&$address_data$&"
17001 If for some reason you want to discard local errors, but use a non-empty
17002 MAIL command for remote delivery, you can preserve the original return
17003 path in &$address_data$& in the router, and reinstate it in the transport by
17004 setting &%return_path%&.
17005
17006 The most common use of &%errors_to%& is to direct mailing list bounces to the
17007 manager of the list, as described in section &<<SECTmailinglists>>&, or to
17008 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
17009
17010
17011
17012 .option expn routers&!? boolean true
17013 .cindex "address" "testing"
17014 .cindex "testing" "addresses"
17015 .cindex "EXPN" "router skipping"
17016 .cindex "router" "skipping for EXPN"
17017 If this option is turned off, the router is skipped when testing an address
17018 as a result of processing an SMTP EXPN command. You might, for example,
17019 want to turn it off on a router for users' &_.forward_& files, while leaving it
17020 on for the system alias file.
17021 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17022 are evaluated.
17023
17024 The use of the SMTP EXPN command is controlled by an ACL (see chapter
17025 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
17026 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
17027
17028
17029
17030 .option fail_verify routers boolean false
17031 .cindex "router" "forcing verification failure"
17032 Setting this option has the effect of setting both &%fail_verify_sender%& and
17033 &%fail_verify_recipient%& to the same value.
17034
17035
17036
17037 .option fail_verify_recipient routers boolean false
17038 If this option is true and an address is accepted by this router when
17039 verifying a recipient, verification fails.
17040
17041
17042
17043 .option fail_verify_sender routers boolean false
17044 If this option is true and an address is accepted by this router when
17045 verifying a sender, verification fails.
17046
17047
17048
17049 .option fallback_hosts routers "string list" unset
17050 .cindex "router" "fallback hosts"
17051 .cindex "fallback" "hosts specified on router"
17052 String expansion is not applied to this option. The argument must be a
17053 colon-separated list of host names or IP addresses. The list separator can be
17054 changed (see section &<<SECTlistconstruct>>&), and a port can be specified with
17055 each name or address. In fact, the format of each item is exactly the same as
17056 defined for the list of hosts in a &(manualroute)& router (see section
17057 &<<SECTformatonehostitem>>&).
17058
17059 If a router queues an address for a remote transport, this host list is
17060 associated with the address, and used instead of the transport's fallback host
17061 list. If &%hosts_randomize%& is set on the transport, the order of the list is
17062 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
17063 transport for further details.
17064
17065
17066 .option group routers string&!! "see below"
17067 .cindex "gid (group id)" "local delivery"
17068 .cindex "local transports" "uid and gid"
17069 .cindex "transport" "local"
17070 .cindex "router" "setting group"
17071 When a router queues an address for a transport, and the transport does not
17072 specify a group, the group given here is used when running the delivery
17073 process.
17074 The group may be specified numerically or by name. If expansion fails, the
17075 error is logged and delivery is deferred.
17076 The default is unset, unless &%check_local_user%& is set, when the default
17077 is taken from the password information. See also &%initgroups%& and &%user%&
17078 and the discussion in chapter &<<CHAPenvironment>>&.
17079
17080
17081
17082 .option headers_add routers list&!! unset
17083 .cindex "header lines" "adding"
17084 .cindex "router" "adding header lines"
17085 This option specifies a list of text headers, newline-separated,
17086 that is associated with any addresses that are accepted by the router.
17087 Each item is separately expanded, at routing time.  However, this
17088 option has no effect when an address is just being verified. The way in which
17089 the text is used to add header lines at transport time is described in section
17090 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
17091 message is in the process of being transported. This means that references to
17092 header lines in string expansions in the transport's configuration do not
17093 &"see"& the added header lines.
17094
17095 The &%headers_add%& option is expanded after &%errors_to%&, but before
17096 &%headers_remove%& and &%transport%&. If an item is empty, or if
17097 an item expansion is forced to fail, the item has no effect. Other expansion
17098 failures are treated as configuration errors.
17099
17100 Unlike most options, &%headers_add%& can be specified multiple times
17101 for a router; all listed headers are added.
17102
17103 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
17104 router that has the &%one_time%& option set.
17105
17106 .cindex "duplicate addresses"
17107 .oindex "&%unseen%&"
17108 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
17109 additions are deleted when the address is passed on to subsequent routers.
17110 For a &%redirect%& router, if a generated address is the same as the incoming
17111 address, this can lead to duplicate addresses with different header
17112 modifications. Exim does not do duplicate deliveries (except, in certain
17113 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
17114 which of the duplicates is discarded, so this ambiguous situation should be
17115 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
17116
17117
17118
17119 .option headers_remove routers list&!! unset
17120 .cindex "header lines" "removing"
17121 .cindex "router" "removing header lines"
17122 This option specifies a list of text headers, colon-separated,
17123 that is associated with any addresses that are accepted by the router.
17124 Each item is separately expanded, at routing time.  However, this
17125 option has no effect when an address is just being verified. The way in which
17126 the text is used to remove header lines at transport time is described in
17127 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
17128 the message is in the process of being transported. This means that references
17129 to header lines in string expansions in the transport's configuration still
17130 &"see"& the original header lines.
17131
17132 The &%headers_remove%& option is expanded after &%errors_to%& and
17133 &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail,
17134 the item has no effect. Other expansion failures are treated as configuration
17135 errors.
17136
17137 Unlike most options, &%headers_remove%& can be specified multiple times
17138 for a router; all listed headers are removed.
17139
17140 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
17141 router that has the &%one_time%& option set.
17142
17143 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
17144 removal requests are deleted when the address is passed on to subsequent
17145 routers, and this can lead to problems with duplicates -- see the similar
17146 warning for &%headers_add%& above.
17147
17148
17149 .option ignore_target_hosts routers "host list&!!" unset
17150 .cindex "IP address" "discarding"
17151 .cindex "router" "discarding IP addresses"
17152 Although this option is a host list, it should normally contain IP address
17153 entries rather than names. If any host that is looked up by the router has an
17154 IP address that matches an item in this list, Exim behaves as if that IP
17155 address did not exist. This option allows you to cope with rogue DNS entries
17156 like
17157 .code
17158 remote.domain.example.  A  127.0.0.1
17159 .endd
17160 by setting
17161 .code
17162 ignore_target_hosts = 127.0.0.1
17163 .endd
17164 on the relevant router. If all the hosts found by a &(dnslookup)& router are
17165 discarded in this way, the router declines. In a conventional configuration, an
17166 attempt to mail to such a domain would normally provoke the &"unrouteable
17167 domain"& error, and an attempt to verify an address in the domain would fail.
17168 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
17169 router declines if presented with one of the listed addresses.
17170
17171 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
17172 means of the first or the second of the following settings, respectively:
17173 .code
17174 ignore_target_hosts = 0.0.0.0/0
17175 ignore_target_hosts = <; 0::0/0
17176 .endd
17177 The pattern in the first line matches all IPv4 addresses, whereas the pattern
17178 in the second line matches all IPv6 addresses.
17179
17180 This option may also be useful for ignoring link-local and site-local IPv6
17181 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
17182 is expanded before use as a list, it is possible to make it dependent on the
17183 domain that is being routed.
17184
17185 .vindex "&$host_address$&"
17186 During its expansion, &$host_address$& is set to the IP address that is being
17187 checked.
17188
17189 .option initgroups routers boolean false
17190 .cindex "additional groups"
17191 .cindex "groups" "additional"
17192 .cindex "local transports" "uid and gid"
17193 .cindex "transport" "local"
17194 If the router queues an address for a transport, and this option is true, and
17195 the uid supplied by the router is not overridden by the transport, the
17196 &[initgroups()]& function is called when running the transport to ensure that
17197 any additional groups associated with the uid are set up. See also &%group%&
17198 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
17199
17200
17201
17202 .option local_part_prefix routers&!? "string list" unset
17203 .cindex "router" "prefix for local part"
17204 .cindex "prefix" "for local part, used in router"
17205 If this option is set, the router is skipped unless the local part starts with
17206 one of the given strings, or &%local_part_prefix_optional%& is true. See
17207 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
17208 evaluated.
17209
17210 The list is scanned from left to right, and the first prefix that matches is
17211 used. A limited form of wildcard is available; if the prefix begins with an
17212 asterisk, it matches the longest possible sequence of arbitrary characters at
17213 the start of the local part. An asterisk should therefore always be followed by
17214 some character that does not occur in normal local parts.
17215 .cindex "multiple mailboxes"
17216 .cindex "mailbox" "multiple"
17217 Wildcarding can be used to set up multiple user mailboxes, as described in
17218 section &<<SECTmulbox>>&.
17219
17220 .vindex "&$local_part$&"
17221 .vindex "&$local_part_prefix$&"
17222 During the testing of the &%local_parts%& option, and while the router is
17223 running, the prefix is removed from the local part, and is available in the
17224 expansion variable &$local_part_prefix$&. When a message is being delivered, if
17225 the router accepts the address, this remains true during subsequent delivery by
17226 a transport. In particular, the local part that is transmitted in the RCPT
17227 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
17228 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
17229 the relevant transport.
17230
17231 When an address is being verified, &%local_part_prefix%& affects only the
17232 behaviour of the router. If the callout feature of verification is in use, this
17233 means that the full address, including the prefix, will be used during the
17234 callout.
17235
17236 The prefix facility is commonly used to handle local parts of the form
17237 &%owner-something%&. Another common use is to support local parts of the form
17238 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
17239 to tell a user their forwarding is broken &-- by placing a router like this one
17240 immediately before the router that handles &_.forward_& files:
17241 .code
17242 real_localuser:
17243   driver = accept
17244   local_part_prefix = real-
17245   check_local_user
17246   transport = local_delivery
17247 .endd
17248 For security, it would probably be a good idea to restrict the use of this
17249 router to locally-generated messages, using a condition such as this:
17250 .code
17251   condition = ${if match {$sender_host_address}\
17252                          {\N^(|127\.0\.0\.1)$\N}}
17253 .endd
17254
17255 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
17256 both conditions must be met if not optional. Care must be taken if wildcards
17257 are used in both a prefix and a suffix on the same router. Different
17258 separator characters must be used to avoid ambiguity.
17259
17260
17261 .option local_part_prefix_optional routers boolean false
17262 See &%local_part_prefix%& above.
17263
17264
17265
17266 .option local_part_suffix routers&!? "string list" unset
17267 .cindex "router" "suffix for local part"
17268 .cindex "suffix for local part" "used in router"
17269 This option operates in the same way as &%local_part_prefix%&, except that the
17270 local part must end (rather than start) with the given string, the
17271 &%local_part_suffix_optional%& option determines whether the suffix is
17272 mandatory, and the wildcard * character, if present, must be the last
17273 character of the suffix. This option facility is commonly used to handle local
17274 parts of the form &%something-request%& and multiple user mailboxes of the form
17275 &%username-foo%&.
17276
17277
17278 .option local_part_suffix_optional routers boolean false
17279 See &%local_part_suffix%& above.
17280
17281
17282
17283 .option local_parts routers&!? "local part list&!!" unset
17284 .cindex "router" "restricting to specific local parts"
17285 .cindex "local part" "checking in router"
17286 The router is run only if the local part of the address matches the list.
17287 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17288 are evaluated, and
17289 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
17290 string is expanded, it is possible to make it depend on the domain, for
17291 example:
17292 .code
17293 local_parts = dbm;/usr/local/specials/$domain
17294 .endd
17295 .vindex "&$local_part_data$&"
17296 If the match is achieved by a lookup, the data that the lookup returned
17297 for the local part is placed in the variable &$local_part_data$& for use in
17298 expansions of the router's private options. You might use this option, for
17299 example, if you have a large number of local virtual domains, and you want to
17300 send all postmaster mail to the same place without having to set up an alias in
17301 each virtual domain:
17302 .code
17303 postmaster:
17304   driver = redirect
17305   local_parts = postmaster
17306   data = postmaster@real.domain.example
17307 .endd
17308
17309
17310 .option log_as_local routers boolean "see below"
17311 .cindex "log" "delivery line"
17312 .cindex "delivery" "log line format"
17313 Exim has two logging styles for delivery, the idea being to make local
17314 deliveries stand out more visibly from remote ones. In the &"local"& style, the
17315 recipient address is given just as the local part, without a domain. The use of
17316 this style is controlled by this option. It defaults to true for the &(accept)&
17317 router, and false for all the others. This option applies only when a
17318 router assigns an address to a transport. It has no effect on routers that
17319 redirect addresses.
17320
17321
17322
17323 .option more routers boolean&!! true
17324 The result of string expansion for this option must be a valid boolean value,
17325 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
17326 result causes an error, and delivery is deferred. If the expansion is forced to
17327 fail, the default value for the option (true) is used. Other failures cause
17328 delivery to be deferred.
17329
17330 If this option is set false, and the router declines to handle the address, no
17331 further routers are tried, routing fails, and the address is bounced.
17332 .oindex "&%self%&"
17333 However, if the router explicitly passes an address to the following router by
17334 means of the setting
17335 .code
17336 self = pass
17337 .endd
17338 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
17339 does not affect the behaviour if one of the precondition tests fails. In that
17340 case, the address is always passed to the next router.
17341
17342 Note that &%address_data%& is not considered to be a precondition. If its
17343 expansion is forced to fail, the router declines, and the value of &%more%&
17344 controls what happens next.
17345
17346
17347 .option pass_on_timeout routers boolean false
17348 .cindex "timeout" "of router"
17349 .cindex "router" "timeout"
17350 If a router times out during a host lookup, it normally causes deferral of the
17351 address. If &%pass_on_timeout%& is set, the address is passed on to the next
17352 router, overriding &%no_more%&. This may be helpful for systems that are
17353 intermittently connected to the Internet, or those that want to pass to a smart
17354 host any messages that cannot immediately be delivered.
17355
17356 There are occasional other temporary errors that can occur while doing DNS
17357 lookups. They are treated in the same way as a timeout, and this option
17358 applies to all of them.
17359
17360
17361
17362 .option pass_router routers string unset
17363 .cindex "router" "go to after &""pass""&"
17364 Routers that recognize the generic &%self%& option (&(dnslookup)&,
17365 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
17366 routing to continue, and overriding a false setting of &%more%&. When one of
17367 these routers returns &"pass"&, the address is normally handed on to the next
17368 router in sequence. This can be changed by setting &%pass_router%& to the name
17369 of another router. However (unlike &%redirect_router%&) the named router must
17370 be below the current router, to avoid loops. Note that this option applies only
17371 to the special case of &"pass"&. It does not apply when a router returns
17372 &"decline"& because it cannot handle an address.
17373
17374
17375
17376 .option redirect_router routers string unset
17377 .cindex "router" "start at after redirection"
17378 Sometimes an administrator knows that it is pointless to reprocess addresses
17379 generated from alias or forward files with the same router again. For
17380 example, if an alias file translates real names into login ids there is no
17381 point searching the alias file a second time, especially if it is a large file.
17382
17383 The &%redirect_router%& option can be set to the name of any router instance.
17384 It causes the routing of any generated addresses to start at the named router
17385 instead of at the first router. This option has no effect if the router in
17386 which it is set does not generate new addresses.
17387
17388
17389
17390 .option require_files routers&!? "string list&!!" unset
17391 .cindex "file" "requiring for router"
17392 .cindex "router" "requiring file existence"
17393 This option provides a general mechanism for predicating the running of a
17394 router on the existence or non-existence of certain files or directories.
17395 Before running a router, as one of its precondition tests, Exim works its way
17396 through the &%require_files%& list, expanding each item separately.
17397
17398 Because the list is split before expansion, any colons in expansion items must
17399 be doubled, or the facility for using a different list separator must be used.
17400 If any expansion is forced to fail, the item is ignored. Other expansion
17401 failures cause routing of the address to be deferred.
17402
17403 If any expanded string is empty, it is ignored. Otherwise, except as described
17404 below, each string must be a fully qualified file path, optionally preceded by
17405 &"!"&. The paths are passed to the &[stat()]& function to test for the
17406 existence of the files or directories. The router is skipped if any paths not
17407 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
17408
17409 .cindex "NFS"
17410 If &[stat()]& cannot determine whether a file exists or not, delivery of
17411 the message is deferred. This can happen when NFS-mounted filesystems are
17412 unavailable.
17413
17414 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
17415 options, so you cannot use it to check for the existence of a file in which to
17416 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
17417 full list of the order in which preconditions are evaluated.) However, as
17418 these options are all expanded, you can use the &%exists%& expansion condition
17419 to make such tests. The &%require_files%& option is intended for checking files
17420 that the router may be going to use internally, or which are needed by a
17421 transport (for example &_.procmailrc_&).
17422
17423 During delivery, the &[stat()]& function is run as root, but there is a
17424 facility for some checking of the accessibility of a file by another user.
17425 This is not a proper permissions check, but just a &"rough"& check that
17426 operates as follows:
17427
17428 If an item in a &%require_files%& list does not contain any forward slash
17429 characters, it is taken to be the user (and optional group, separated by a
17430 comma) to be checked for subsequent files in the list. If no group is specified
17431 but the user is specified symbolically, the gid associated with the uid is
17432 used. For example:
17433 .code
17434 require_files = mail:/some/file
17435 require_files = $local_part:$home/.procmailrc
17436 .endd
17437 If a user or group name in a &%require_files%& list does not exist, the
17438 &%require_files%& condition fails.
17439
17440 Exim performs the check by scanning along the components of the file path, and
17441 checking the access for the given uid and gid. It checks for &"x"& access on
17442 directories, and &"r"& access on the final file. Note that this means that file
17443 access control lists, if the operating system has them, are ignored.
17444
17445 &*Warning 1*&: When the router is being run to verify addresses for an
17446 incoming SMTP message, Exim is not running as root, but under its own uid. This
17447 may affect the result of a &%require_files%& check. In particular, &[stat()]&
17448 may yield the error EACCES (&"Permission denied"&). This means that the Exim
17449 user is not permitted to read one of the directories on the file's path.
17450
17451 &*Warning 2*&: Even when Exim is running as root while delivering a message,
17452 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
17453 without root access. In this case, if a check for access by a particular user
17454 is requested, Exim creates a subprocess that runs as that user, and tries the
17455 check again in that process.
17456
17457 The default action for handling an unresolved EACCES is to consider it to
17458 be caused by a configuration error, and routing is deferred because the
17459 existence or non-existence of the file cannot be determined. However, in some
17460 circumstances it may be desirable to treat this condition as if the file did
17461 not exist. If the file name (or the exclamation mark that precedes the file
17462 name for non-existence) is preceded by a plus sign, the EACCES error is treated
17463 as if the file did not exist. For example:
17464 .code
17465 require_files = +/some/file
17466 .endd
17467 If the router is not an essential part of verification (for example, it
17468 handles users' &_.forward_& files), another solution is to set the &%verify%&
17469 option false so that the router is skipped when verifying.
17470
17471
17472
17473 .option retry_use_local_part routers boolean "see below"
17474 .cindex "hints database" "retry keys"
17475 .cindex "local part" "in retry keys"
17476 When a delivery suffers a temporary routing failure, a retry record is created
17477 in Exim's hints database. For addresses whose routing depends only on the
17478 domain, the key for the retry record should not involve the local part, but for
17479 other addresses, both the domain and the local part should be included.
17480 Usually, remote routing is of the former kind, and local routing is of the
17481 latter kind.
17482
17483 This option controls whether the local part is used to form the key for retry
17484 hints for addresses that suffer temporary errors while being handled by this
17485 router. The default value is true for any router that has &%check_local_user%&
17486 set, and false otherwise. Note that this option does not apply to hints keys
17487 for transport delays; they are controlled by a generic transport option of the
17488 same name.
17489
17490 The setting of &%retry_use_local_part%& applies only to the router on which it
17491 appears. If the router generates child addresses, they are routed
17492 independently; this setting does not become attached to them.
17493
17494
17495
17496 .option router_home_directory routers string&!! unset
17497 .cindex "router" "home directory for"
17498 .cindex "home directory" "for router"
17499 .vindex "&$home$&"
17500 This option sets a home directory for use while the router is running. (Compare
17501 &%transport_home_directory%&, which sets a home directory for later
17502 transporting.) In particular, if used on a &(redirect)& router, this option
17503 sets a value for &$home$& while a filter is running. The value is expanded;
17504 forced expansion failure causes the option to be ignored &-- other failures
17505 cause the router to defer.
17506
17507 Expansion of &%router_home_directory%& happens immediately after the
17508 &%check_local_user%& test (if configured), before any further expansions take
17509 place.
17510 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17511 are evaluated.)
17512 While the router is running, &%router_home_directory%& overrides the value of
17513 &$home$& that came from &%check_local_user%&.
17514
17515 When a router accepts an address and assigns it to a local transport (including
17516 the cases when a &(redirect)& router generates a pipe, file, or autoreply
17517 delivery), the home directory setting for the transport is taken from the first
17518 of these values that is set:
17519
17520 .ilist
17521 The &%home_directory%& option on the transport;
17522 .next
17523 The &%transport_home_directory%& option on the router;
17524 .next
17525 The password data if &%check_local_user%& is set on the router;
17526 .next
17527 The &%router_home_directory%& option on the router.
17528 .endlist
17529
17530 In other words, &%router_home_directory%& overrides the password data for the
17531 router, but not for the transport.
17532
17533
17534
17535 .option self routers string freeze
17536 .cindex "MX record" "pointing to local host"
17537 .cindex "local host" "MX pointing to"
17538 This option applies to those routers that use a recipient address to find a
17539 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
17540 and &(manualroute)& routers.
17541 Certain configurations of the &(queryprogram)& router can also specify a list
17542 of remote hosts.
17543 Usually such routers are configured to send the message to a remote host via an
17544 &(smtp)& transport. The &%self%& option specifies what happens when the first
17545 host on the list turns out to be the local host.
17546 The way in which Exim checks for the local host is described in section
17547 &<<SECTreclocipadd>>&.
17548
17549 Normally this situation indicates either an error in Exim's configuration (for
17550 example, the router should be configured not to process this domain), or an
17551 error in the DNS (for example, the MX should not point to this host). For this
17552 reason, the default action is to log the incident, defer the address, and
17553 freeze the message. The following alternatives are provided for use in special
17554 cases:
17555
17556 .vlist
17557 .vitem &%defer%&
17558 Delivery of the message is tried again later, but the message is not frozen.
17559
17560 .vitem "&%reroute%&: <&'domain'&>"
17561 The domain is changed to the given domain, and the address is passed back to
17562 be reprocessed by the routers. No rewriting of headers takes place. This
17563 behaviour is essentially a redirection.
17564
17565 .vitem "&%reroute: rewrite:%& <&'domain'&>"
17566 The domain is changed to the given domain, and the address is passed back to be
17567 reprocessed by the routers. Any headers that contain the original domain are
17568 rewritten.
17569
17570 .vitem &%pass%&
17571 .oindex "&%more%&"
17572 .vindex "&$self_hostname$&"
17573 The router passes the address to the next router, or to the router named in the
17574 &%pass_router%& option if it is set. This overrides &%no_more%&. During
17575 subsequent routing and delivery, the variable &$self_hostname$& contains the
17576 name of the local host that the router encountered. This can be used to
17577 distinguish between different cases for hosts with multiple names. The
17578 combination
17579 .code
17580 self = pass
17581 no_more
17582 .endd
17583 ensures that only those addresses that routed to the local host are passed on.
17584 Without &%no_more%&, addresses that were declined for other reasons would also
17585 be passed to the next router.
17586
17587 .vitem &%fail%&
17588 Delivery fails and an error report is generated.
17589
17590 .vitem &%send%&
17591 .cindex "local host" "sending to"
17592 The anomaly is ignored and the address is queued for the transport. This
17593 setting should be used with extreme caution. For an &(smtp)& transport, it
17594 makes sense only in cases where the program that is listening on the SMTP port
17595 is not this version of Exim. That is, it must be some other MTA, or Exim with a
17596 different configuration file that handles the domain in another way.
17597 .endlist
17598
17599
17600
17601 .option senders routers&!? "address list&!!" unset
17602 .cindex "router" "checking senders"
17603 If this option is set, the router is skipped unless the message's sender
17604 address matches something on the list.
17605 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17606 are evaluated.
17607
17608 There are issues concerning verification when the running of routers is
17609 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
17610 setting, it sets the sender to the null string. When using the &%-bt%& option
17611 to check a configuration file, it is necessary also to use the &%-f%& option to
17612 set an appropriate sender. For incoming mail, the sender is unset when
17613 verifying the sender, but is available when verifying any recipients. If the
17614 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
17615 matters.
17616
17617
17618 .option translate_ip_address routers string&!! unset
17619 .cindex "IP address" "translating"
17620 .cindex "packet radio"
17621 .cindex "router" "IP address translation"
17622 There exist some rare networking situations (for example, packet radio) where
17623 it is helpful to be able to translate IP addresses generated by normal routing
17624 mechanisms into other IP addresses, thus performing a kind of manual IP
17625 routing. This should be done only if the normal IP routing of the TCP/IP stack
17626 is inadequate or broken. Because this is an extremely uncommon requirement, the
17627 code to support this option is not included in the Exim binary unless
17628 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
17629
17630 .vindex "&$host_address$&"
17631 The &%translate_ip_address%& string is expanded for every IP address generated
17632 by the router, with the generated address set in &$host_address$&. If the
17633 expansion is forced to fail, no action is taken.
17634 For any other expansion error, delivery of the message is deferred.
17635 If the result of the expansion is an IP address, that replaces the original
17636 address; otherwise the result is assumed to be a host name &-- this is looked
17637 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
17638 produce one or more replacement IP addresses. For example, to subvert all IP
17639 addresses in some specific networks, this could be added to a router:
17640 .code
17641 translate_ip_address = \
17642   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
17643     {$value}fail}}
17644 .endd
17645 The file would contain lines like
17646 .code
17647 10.2.3.128/26    some.host
17648 10.8.4.34/26     10.44.8.15
17649 .endd
17650 You should not make use of this facility unless you really understand what you
17651 are doing.
17652
17653
17654
17655 .option transport routers string&!! unset
17656 This option specifies the transport to be used when a router accepts an address
17657 and sets it up for delivery. A transport is never needed if a router is used
17658 only for verification. The value of the option is expanded at routing time,
17659 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
17660 and result must be the name of one of the configured transports. If it is not,
17661 delivery is deferred.
17662
17663 The &%transport%& option is not used by the &(redirect)& router, but it does
17664 have some private options that set up transports for pipe and file deliveries
17665 (see chapter &<<CHAPredirect>>&).
17666
17667
17668
17669 .option transport_current_directory routers string&!! unset
17670 .cindex "current directory for local transport"
17671 This option associates a current directory with any address that is routed
17672 to a local transport. This can happen either because a transport is
17673 explicitly configured for the router, or because it generates a delivery to a
17674 file or a pipe. During the delivery process (that is, at transport time), this
17675 option string is expanded and is set as the current directory, unless
17676 overridden by a setting on the transport.
17677 If the expansion fails for any reason, including forced failure, an error is
17678 logged, and delivery is deferred.
17679 See chapter &<<CHAPenvironment>>& for details of the local delivery
17680 environment.
17681
17682
17683
17684
17685 .option transport_home_directory routers string&!! "see below"
17686 .cindex "home directory" "for local transport"
17687 This option associates a home directory with any address that is routed to a
17688 local transport. This can happen either because a transport is explicitly
17689 configured for the router, or because it generates a delivery to a file or a
17690 pipe. During the delivery process (that is, at transport time), the option
17691 string is expanded and is set as the home directory, unless overridden by a
17692 setting of &%home_directory%& on the transport.
17693 If the expansion fails for any reason, including forced failure, an error is
17694 logged, and delivery is deferred.
17695
17696 If the transport does not specify a home directory, and
17697 &%transport_home_directory%& is not set for the router, the home directory for
17698 the transport is taken from the password data if &%check_local_user%& is set for
17699 the router. Otherwise it is taken from &%router_home_directory%& if that option
17700 is set; if not, no home directory is set for the transport.
17701
17702 See chapter &<<CHAPenvironment>>& for further details of the local delivery
17703 environment.
17704
17705
17706
17707
17708 .option unseen routers boolean&!! false
17709 .cindex "router" "carrying on after success"
17710 The result of string expansion for this option must be a valid boolean value,
17711 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
17712 result causes an error, and delivery is deferred. If the expansion is forced to
17713 fail, the default value for the option (false) is used. Other failures cause
17714 delivery to be deferred.
17715
17716 When this option is set true, routing does not cease if the router accepts the
17717 address. Instead, a copy of the incoming address is passed to the next router,
17718 overriding a false setting of &%more%&. There is little point in setting
17719 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
17720 the value of &%unseen%& contains expansion items (and therefore, presumably, is
17721 sometimes true and sometimes false).
17722
17723 .cindex "copy of message (&%unseen%& option)"
17724 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
17725 qualifier in filter files. It can be used to cause copies of messages to be
17726 delivered to some other destination, while also carrying out a normal delivery.
17727 In effect, the current address is made into a &"parent"& that has two children
17728 &-- one that is delivered as specified by this router, and a clone that goes on
17729 to be routed further. For this reason, &%unseen%& may not be combined with the
17730 &%one_time%& option in a &(redirect)& router.
17731
17732 &*Warning*&: Header lines added to the address (or specified for removal) by
17733 this router or by previous routers affect the &"unseen"& copy of the message
17734 only. The clone that continues to be processed by further routers starts with
17735 no added headers and none specified for removal. For a &%redirect%& router, if
17736 a generated address is the same as the incoming address, this can lead to
17737 duplicate addresses with different header modifications. Exim does not do
17738 duplicate deliveries (except, in certain circumstances, to pipes -- see section
17739 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
17740 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
17741 &%redirect%& router may be of help.
17742
17743 Unlike the handling of header modifications, any data that was set by the
17744 &%address_data%& option in the current or previous routers &'is'& passed on to
17745 subsequent routers.
17746
17747
17748 .option user routers string&!! "see below"
17749 .cindex "uid (user id)" "local delivery"
17750 .cindex "local transports" "uid and gid"
17751 .cindex "transport" "local"
17752 .cindex "router" "user for filter processing"
17753 .cindex "filter" "user for processing"
17754 When a router queues an address for a transport, and the transport does not
17755 specify a user, the user given here is used when running the delivery process.
17756 The user may be specified numerically or by name. If expansion fails, the
17757 error is logged and delivery is deferred.
17758 This user is also used by the &(redirect)& router when running a filter file.
17759 The default is unset, except when &%check_local_user%& is set. In this case,
17760 the default is taken from the password information. If the user is specified as
17761 a name, and &%group%& is not set, the group associated with the user is used.
17762 See also &%initgroups%& and &%group%& and the discussion in chapter
17763 &<<CHAPenvironment>>&.
17764
17765
17766
17767 .option verify routers&!? boolean true
17768 Setting this option has the effect of setting &%verify_sender%& and
17769 &%verify_recipient%& to the same value.
17770
17771
17772 .option verify_only routers&!? boolean false
17773 .cindex "EXPN" "with &%verify_only%&"
17774 .oindex "&%-bv%&"
17775 .cindex "router" "used only when verifying"
17776 If this option is set, the router is used only when verifying an address,
17777 delivering in cutthrough mode or
17778 testing with the &%-bv%& option, not when actually doing a delivery, testing
17779 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
17780 restricted to verifying only senders or recipients by means of
17781 &%verify_sender%& and &%verify_recipient%&.
17782
17783 &*Warning*&: When the router is being run to verify addresses for an incoming
17784 SMTP message, Exim is not running as root, but under its own uid. If the router
17785 accesses any files, you need to make sure that they are accessible to the Exim
17786 user or group.
17787
17788
17789 .option verify_recipient routers&!? boolean true
17790 If this option is false, the router is skipped when verifying recipient
17791 addresses,
17792 delivering in cutthrough mode
17793 or testing recipient verification using &%-bv%&.
17794 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17795 are evaluated.
17796 See also the &$verify_mode$& variable.
17797
17798
17799 .option verify_sender routers&!? boolean true
17800 If this option is false, the router is skipped when verifying sender addresses
17801 or testing sender verification using &%-bvs%&.
17802 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17803 are evaluated.
17804 See also the &$verify_mode$& variable.
17805 .ecindex IIDgenoprou1
17806 .ecindex IIDgenoprou2
17807
17808
17809
17810
17811
17812
17813 . ////////////////////////////////////////////////////////////////////////////
17814 . ////////////////////////////////////////////////////////////////////////////
17815
17816 .chapter "The accept router" "CHID4"
17817 .cindex "&(accept)& router"
17818 .cindex "routers" "&(accept)&"
17819 The &(accept)& router has no private options of its own. Unless it is being
17820 used purely for verification (see &%verify_only%&) a transport is required to
17821 be defined by the generic &%transport%& option. If the preconditions that are
17822 specified by generic options are met, the router accepts the address and queues
17823 it for the given transport. The most common use of this router is for setting
17824 up deliveries to local mailboxes. For example:
17825 .code
17826 localusers:
17827   driver = accept
17828   domains = mydomain.example
17829   check_local_user
17830   transport = local_delivery
17831 .endd
17832 The &%domains%& condition in this example checks the domain of the address, and
17833 &%check_local_user%& checks that the local part is the login of a local user.
17834 When both preconditions are met, the &(accept)& router runs, and queues the
17835 address for the &(local_delivery)& transport.
17836
17837
17838
17839
17840
17841
17842 . ////////////////////////////////////////////////////////////////////////////
17843 . ////////////////////////////////////////////////////////////////////////////
17844
17845 .chapter "The dnslookup router" "CHAPdnslookup"
17846 .scindex IIDdnsrou1 "&(dnslookup)& router"
17847 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
17848 The &(dnslookup)& router looks up the hosts that handle mail for the
17849 recipient's domain in the DNS. A transport must always be set for this router,
17850 unless &%verify_only%& is set.
17851
17852 If SRV support is configured (see &%check_srv%& below), Exim first searches for
17853 SRV records. If none are found, or if SRV support is not configured,
17854 MX records are looked up. If no MX records exist, address records are sought.
17855 However, &%mx_domains%& can be set to disable the direct use of address
17856 records.
17857
17858 MX records of equal priority are sorted by Exim into a random order. Exim then
17859 looks for address records for the host names obtained from MX or SRV records.
17860 When a host has more than one IP address, they are sorted into a random order,
17861 except that IPv6 addresses are always sorted before IPv4 addresses. If all the
17862 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
17863 generic option, the router declines.
17864
17865 Unless they have the highest priority (lowest MX value), MX records that point
17866 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
17867 are discarded, together with any other MX records of equal or lower priority.
17868
17869 .cindex "MX record" "pointing to local host"
17870 .cindex "local host" "MX pointing to"
17871 .oindex "&%self%&" "in &(dnslookup)& router"
17872 If the host pointed to by the highest priority MX record, or looked up as an
17873 address record, is the local host, or matches &%hosts_treat_as_local%&, what
17874 happens is controlled by the generic &%self%& option.
17875
17876
17877 .section "Problems with DNS lookups" "SECTprowitdnsloo"
17878 There have been problems with DNS servers when SRV records are looked up.
17879 Some mis-behaving servers return a DNS error or timeout when a non-existent
17880 SRV record is sought. Similar problems have in the past been reported for
17881 MX records. The global &%dns_again_means_nonexist%& option can help with this
17882 problem, but it is heavy-handed because it is a global option.
17883
17884 For this reason, there are two options, &%srv_fail_domains%& and
17885 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
17886 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
17887 an attempt to look up an SRV or MX record causes one of these results, and the
17888 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
17889 such record"&. In the case of an SRV lookup, this means that the router
17890 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
17891 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
17892 case routing fails.
17893
17894
17895 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
17896 .cindex "&(dnslookup)& router" "declines"
17897 There are a few cases where a &(dnslookup)& router will decline to accept
17898 an address; if such a router is expected to handle "all remaining non-local
17899 domains", then it is important to set &%no_more%&.
17900
17901 Reasons for a &(dnslookup)& router to decline currently include:
17902 .ilist
17903 The domain does not exist in DNS
17904 .next
17905 The domain exists but the MX record's host part is just "."; this is a common
17906 convention (borrowed from SRV) used to indicate that there is no such service
17907 for this domain and to not fall back to trying A/AAAA records.
17908 .next
17909 Ditto, but for SRV records, when &%check_srv%& is set on this router.
17910 .next
17911 MX record points to a non-existent host.
17912 .next
17913 MX record points to an IP address and the main section option
17914 &%allow_mx_to_ip%& is not set.
17915 .next
17916 MX records exist and point to valid hosts, but all hosts resolve only to
17917 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
17918 .next
17919 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
17920 &%dns_check_names_pattern%& for handling one variant of this)
17921 .next
17922 &%check_secondary_mx%& is set on this router but the local host can
17923 not be found in the MX records (see below)
17924 .endlist
17925
17926
17927
17928
17929 .section "Private options for dnslookup" "SECID118"
17930 .cindex "options" "&(dnslookup)& router"
17931 The private options for the &(dnslookup)& router are as follows:
17932
17933 .option check_secondary_mx dnslookup boolean false
17934 .cindex "MX record" "checking for secondary"
17935 If this option is set, the router declines unless the local host is found in
17936 (and removed from) the list of hosts obtained by MX lookup. This can be used to
17937 process domains for which the local host is a secondary mail exchanger
17938 differently to other domains. The way in which Exim decides whether a host is
17939 the local host is described in section &<<SECTreclocipadd>>&.
17940
17941
17942 .option check_srv dnslookup string&!! unset
17943 .cindex "SRV record" "enabling use of"
17944 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
17945 addition to MX and address records. The support is disabled by default. To
17946 enable SRV support, set the &%check_srv%& option to the name of the service
17947 required. For example,
17948 .code
17949 check_srv = smtp
17950 .endd
17951 looks for SRV records that refer to the normal smtp service. The option is
17952 expanded, so the service name can vary from message to message or address
17953 to address. This might be helpful if SRV records are being used for a
17954 submission service. If the expansion is forced to fail, the &%check_srv%&
17955 option is ignored, and the router proceeds to look for MX records in the
17956 normal way.
17957
17958 When the expansion succeeds, the router searches first for SRV records for
17959 the given service (it assumes TCP protocol). A single SRV record with a
17960 host name that consists of just a single dot indicates &"no such service for
17961 this domain"&; if this is encountered, the router declines. If other kinds of
17962 SRV record are found, they are used to construct a host list for delivery
17963 according to the rules of RFC 2782. MX records are not sought in this case.
17964
17965 When no SRV records are found, MX records (and address records) are sought in
17966 the traditional way. In other words, SRV records take precedence over MX
17967 records, just as MX records take precedence over address records. Note that
17968 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
17969 defined it. It is apparently believed that MX records are sufficient for email
17970 and that SRV records should not be used for this purpose. However, SRV records
17971 have an additional &"weight"& feature which some people might find useful when
17972 trying to split an SMTP load between hosts of different power.
17973
17974 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
17975 when there is a DNS lookup error.
17976
17977
17978
17979 .option dnssec_request_domains dnslookup "domain list&!!" unset
17980 .cindex "MX record" "security"
17981 .cindex "DNSSEC" "MX lookup"
17982 .cindex "security" "MX lookup"
17983 .cindex "DNS" "DNSSEC"
17984 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
17985 the dnssec request bit set.
17986 This applies to all of the SRV, MX A6, AAAA, A lookup sequence.
17987
17988
17989
17990 .option dnssec_require_domains dnslookup "domain list&!!" unset
17991 .cindex "MX record" "security"
17992 .cindex "DNSSEC" "MX lookup"
17993 .cindex "security" "MX lookup"
17994 .cindex "DNS" "DNSSEC"
17995 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
17996 the dnssec request bit set.  Any returns not having the Authenticated Data bit
17997 (AD bit) set wil be ignored and logged as a host-lookup failure.
17998 This applies to all of the SRV, MX A6, AAAA, A lookup sequence.
17999
18000
18001
18002 .option mx_domains dnslookup "domain list&!!" unset
18003 .cindex "MX record" "required to exist"
18004 .cindex "SRV record" "required to exist"
18005 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
18006 record in order to be recognized. (The name of this option could be improved.)
18007 For example, if all the mail hosts in &'fict.example'& are known to have MX
18008 records, except for those in &'discworld.fict.example'&, you could use this
18009 setting:
18010 .code
18011 mx_domains = ! *.discworld.fict.example : *.fict.example
18012 .endd
18013 This specifies that messages addressed to a domain that matches the list but
18014 has no MX record should be bounced immediately instead of being routed using
18015 the address record.
18016
18017
18018 .option mx_fail_domains dnslookup "domain list&!!" unset
18019 If the DNS lookup for MX records for one of the domains in this list causes a
18020 DNS lookup error, Exim behaves as if no MX records were found. See section
18021 &<<SECTprowitdnsloo>>& for more discussion.
18022
18023
18024
18025
18026 .option qualify_single dnslookup boolean true
18027 .cindex "DNS" "resolver options"
18028 .cindex "DNS" "qualifying single-component names"
18029 When this option is true, the resolver option RES_DEFNAMES is set for DNS
18030 lookups. Typically, but not standardly, this causes the resolver to qualify
18031 single-component names with the default domain. For example, on a machine
18032 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
18033 &'thesaurus.ref.example'& inside the resolver. For details of what your
18034 resolver actually does, consult your man pages for &'resolver'& and
18035 &'resolv.conf'&.
18036
18037
18038
18039 .option rewrite_headers dnslookup boolean true
18040 .cindex "rewriting" "header lines"
18041 .cindex "header lines" "rewriting"
18042 If the domain name in the address that is being processed is not fully
18043 qualified, it may be expanded to its full form by a DNS lookup. For example, if
18044 an address is specified as &'dormouse@teaparty'&, the domain might be
18045 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
18046 occur as a result of setting the &%widen_domains%& option. If
18047 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
18048 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
18049 header lines of the message are rewritten with the full domain name.
18050
18051 This option should be turned off only when it is known that no message is
18052 ever going to be sent outside an environment where the abbreviation makes
18053 sense.
18054
18055 When an MX record is looked up in the DNS and matches a wildcard record, name
18056 servers normally return a record containing the name that has been looked up,
18057 making it impossible to detect whether a wildcard was present or not. However,
18058 some name servers have recently been seen to return the wildcard entry. If the
18059 name returned by a DNS lookup begins with an asterisk, it is not used for
18060 header rewriting.
18061
18062
18063 .option same_domain_copy_routing dnslookup boolean false
18064 .cindex "address" "copying routing"
18065 Addresses with the same domain are normally routed by the &(dnslookup)& router
18066 to the same list of hosts. However, this cannot be presumed, because the router
18067 options and preconditions may refer to the local part of the address. By
18068 default, therefore, Exim routes each address in a message independently. DNS
18069 servers run caches, so repeated DNS lookups are not normally expensive, and in
18070 any case, personal messages rarely have more than a few recipients.
18071
18072 If you are running mailing lists with large numbers of subscribers at the same
18073 domain, and you are using a &(dnslookup)& router which is independent of the
18074 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
18075 lookups for identical domains in one message. In this case, when &(dnslookup)&
18076 routes an address to a remote transport, any other unrouted addresses in the
18077 message that have the same domain are automatically given the same routing
18078 without processing them independently,
18079 provided the following conditions are met:
18080
18081 .ilist
18082 No router that processed the address specified &%headers_add%& or
18083 &%headers_remove%&.
18084 .next
18085 The router did not change the address in any way, for example, by &"widening"&
18086 the domain.
18087 .endlist
18088
18089
18090
18091
18092 .option search_parents dnslookup boolean false
18093 .cindex "DNS" "resolver options"
18094 When this option is true, the resolver option RES_DNSRCH is set for DNS
18095 lookups. This is different from the &%qualify_single%& option in that it
18096 applies to domains containing dots. Typically, but not standardly, it causes
18097 the resolver to search for the name in the current domain and in parent
18098 domains. For example, on a machine in the &'fict.example'& domain, if looking
18099 up &'teaparty.wonderland'& failed, the resolver would try
18100 &'teaparty.wonderland.fict.example'&. For details of what your resolver
18101 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
18102
18103 Setting this option true can cause problems in domains that have a wildcard MX
18104 record, because any domain that does not have its own MX record matches the
18105 local wildcard.
18106
18107
18108
18109 .option srv_fail_domains dnslookup "domain list&!!" unset
18110 If the DNS lookup for SRV records for one of the domains in this list causes a
18111 DNS lookup error, Exim behaves as if no SRV records were found. See section
18112 &<<SECTprowitdnsloo>>& for more discussion.
18113
18114
18115
18116
18117 .option widen_domains dnslookup "string list" unset
18118 .cindex "domain" "partial; widening"
18119 If a DNS lookup fails and this option is set, each of its strings in turn is
18120 added onto the end of the domain, and the lookup is tried again. For example,
18121 if
18122 .code
18123 widen_domains = fict.example:ref.example
18124 .endd
18125 is set and a lookup of &'klingon.dictionary'& fails,
18126 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
18127 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
18128 and &%search_parents%& options can cause some widening to be undertaken inside
18129 the DNS resolver. &%widen_domains%& is not applied to sender addresses
18130 when verifying, unless &%rewrite_headers%& is false (not the default).
18131
18132
18133 .section "Effect of qualify_single and search_parents" "SECID119"
18134 When a domain from an envelope recipient is changed by the resolver as a result
18135 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
18136 corresponding address in the message's header lines unless &%rewrite_headers%&
18137 is set false. Exim then re-routes the address, using the full domain.
18138
18139 These two options affect only the DNS lookup that takes place inside the router
18140 for the domain of the address that is being routed. They do not affect lookups
18141 such as that implied by
18142 .code
18143 domains = @mx_any
18144 .endd
18145 that may happen while processing a router precondition before the router is
18146 entered. No widening ever takes place for these lookups.
18147 .ecindex IIDdnsrou1
18148 .ecindex IIDdnsrou2
18149
18150
18151
18152
18153
18154
18155
18156
18157
18158 . ////////////////////////////////////////////////////////////////////////////
18159 . ////////////////////////////////////////////////////////////////////////////
18160
18161 .chapter "The ipliteral router" "CHID5"
18162 .cindex "&(ipliteral)& router"
18163 .cindex "domain literal" "routing"
18164 .cindex "routers" "&(ipliteral)&"
18165 This router has no private options. Unless it is being used purely for
18166 verification (see &%verify_only%&) a transport is required to be defined by the
18167 generic &%transport%& option. The router accepts the address if its domain part
18168 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
18169 router handles the address
18170 .code
18171 root@[192.168.1.1]
18172 .endd
18173 by setting up delivery to the host with that IP address. IPv4 domain literals
18174 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
18175 are similar, but the address is preceded by &`ipv6:`&. For example:
18176 .code
18177 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
18178 .endd
18179 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
18180 grounds that sooner or later somebody will try it.
18181
18182 .oindex "&%self%&" "in &(ipliteral)& router"
18183 If the IP address matches something in &%ignore_target_hosts%&, the router
18184 declines. If an IP literal turns out to refer to the local host, the generic
18185 &%self%& option determines what happens.
18186
18187 The RFCs require support for domain literals; however, their use is
18188 controversial in today's Internet. If you want to use this router, you must
18189 also set the main configuration option &%allow_domain_literals%&. Otherwise,
18190 Exim will not recognize the domain literal syntax in addresses.
18191
18192
18193
18194 . ////////////////////////////////////////////////////////////////////////////
18195 . ////////////////////////////////////////////////////////////////////////////
18196
18197 .chapter "The iplookup router" "CHID6"
18198 .cindex "&(iplookup)& router"
18199 .cindex "routers" "&(iplookup)&"
18200 The &(iplookup)& router was written to fulfil a specific requirement in
18201 Cambridge University (which in fact no longer exists). For this reason, it is
18202 not included in the binary of Exim by default. If you want to include it, you
18203 must set
18204 .code
18205 ROUTER_IPLOOKUP=yes
18206 .endd
18207 in your &_Local/Makefile_& configuration file.
18208
18209 The &(iplookup)& router routes an address by sending it over a TCP or UDP
18210 connection to one or more specific hosts. The host can then return the same or
18211 a different address &-- in effect rewriting the recipient address in the
18212 message's envelope. The new address is then passed on to subsequent routers. If
18213 this process fails, the address can be passed on to other routers, or delivery
18214 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
18215 must not be specified for it.
18216
18217 .cindex "options" "&(iplookup)& router"
18218 .option hosts iplookup string unset
18219 This option must be supplied. Its value is a colon-separated list of host
18220 names. The hosts are looked up using &[gethostbyname()]&
18221 (or &[getipnodebyname()]& when available)
18222 and are tried in order until one responds to the query. If none respond, what
18223 happens is controlled by &%optional%&.
18224
18225
18226 .option optional iplookup boolean false
18227 If &%optional%& is true, if no response is obtained from any host, the address
18228 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
18229 delivery to the address is deferred.
18230
18231
18232 .option port iplookup integer 0
18233 .cindex "port" "&(iplookup)& router"
18234 This option must be supplied. It specifies the port number for the TCP or UDP
18235 call.
18236
18237
18238 .option protocol iplookup string udp
18239 This option can be set to &"udp"& or &"tcp"& to specify which of the two
18240 protocols is to be used.
18241
18242
18243 .option query iplookup string&!! "see below"
18244 This defines the content of the query that is sent to the remote hosts. The
18245 default value is:
18246 .code
18247 $local_part@$domain $local_part@$domain
18248 .endd
18249 The repetition serves as a way of checking that a response is to the correct
18250 query in the default case (see &%response_pattern%& below).
18251
18252
18253 .option reroute iplookup string&!! unset
18254 If this option is not set, the rerouted address is precisely the byte string
18255 returned by the remote host, up to the first white space, if any. If set, the
18256 string is expanded to form the rerouted address. It can include parts matched
18257 in the response by &%response_pattern%& by means of numeric variables such as
18258 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
18259 whether or not a pattern is in use. In all cases, the rerouted address must end
18260 up in the form &'local_part@domain'&.
18261
18262
18263 .option response_pattern iplookup string unset
18264 This option can be set to a regular expression that is applied to the string
18265 returned from the remote host. If the pattern does not match the response, the
18266 router declines. If &%response_pattern%& is not set, no checking of the
18267 response is done, unless the query was defaulted, in which case there is a
18268 check that the text returned after the first white space is the original
18269 address. This checks that the answer that has been received is in response to
18270 the correct question. For example, if the response is just a new domain, the
18271 following could be used:
18272 .code
18273 response_pattern = ^([^@]+)$
18274 reroute = $local_part@$1
18275 .endd
18276
18277 .option timeout iplookup time 5s
18278 This specifies the amount of time to wait for a response from the remote
18279 machine. The same timeout is used for the &[connect()]& function for a TCP
18280 call. It does not apply to UDP.
18281
18282
18283
18284
18285 . ////////////////////////////////////////////////////////////////////////////
18286 . ////////////////////////////////////////////////////////////////////////////
18287
18288 .chapter "The manualroute router" "CHID7"
18289 .scindex IIDmanrou1 "&(manualroute)& router"
18290 .scindex IIDmanrou2 "routers" "&(manualroute)&"
18291 .cindex "domain" "manually routing"
18292 The &(manualroute)& router is so-called because it provides a way of manually
18293 routing an address according to its domain. It is mainly used when you want to
18294 route addresses to remote hosts according to your own rules, bypassing the
18295 normal DNS routing that looks up MX records. However, &(manualroute)& can also
18296 route to local transports, a facility that may be useful if you want to save
18297 messages for dial-in hosts in local files.
18298
18299 The &(manualroute)& router compares a list of domain patterns with the domain
18300 it is trying to route. If there is no match, the router declines. Each pattern
18301 has associated with it a list of hosts and some other optional data, which may
18302 include a transport. The combination of a pattern and its data is called a
18303 &"routing rule"&. For patterns that do not have an associated transport, the
18304 generic &%transport%& option must specify a transport, unless the router is
18305 being used purely for verification (see &%verify_only%&).
18306
18307 .vindex "&$host$&"
18308 In the case of verification, matching the domain pattern is sufficient for the
18309 router to accept the address. When actually routing an address for delivery,
18310 an address that matches a domain pattern is queued for the associated
18311 transport. If the transport is not a local one, a host list must be associated
18312 with the pattern; IP addresses are looked up for the hosts, and these are
18313 passed to the transport along with the mail address. For local transports, a
18314 host list is optional. If it is present, it is passed in &$host$& as a single
18315 text string.
18316
18317 The list of routing rules can be provided as an inline string in
18318 &%route_list%&, or the data can be obtained by looking up the domain in a file
18319 or database by setting &%route_data%&. Only one of these settings may appear in
18320 any one instance of &(manualroute)&. The format of routing rules is described
18321 below, following the list of private options.
18322
18323
18324 .section "Private options for manualroute" "SECTprioptman"
18325
18326 .cindex "options" "&(manualroute)& router"
18327 The private options for the &(manualroute)& router are as follows:
18328
18329 .option host_all_ignored manualroute string defer
18330 See &%host_find_failed%&.
18331
18332 .option host_find_failed manualroute string freeze
18333 This option controls what happens when &(manualroute)& tries to find an IP
18334 address for a host, and the host does not exist. The option can be set to one
18335 of the following values:
18336 .code
18337 decline
18338 defer
18339 fail
18340 freeze
18341 ignore
18342 pass
18343 .endd
18344 The default (&"freeze"&) assumes that this state is a serious configuration
18345 error. The difference between &"pass"& and &"decline"& is that the former
18346 forces the address to be passed to the next router (or the router defined by
18347 &%pass_router%&),
18348 .oindex "&%more%&"
18349 overriding &%no_more%&, whereas the latter passes the address to the next
18350 router only if &%more%& is true.
18351
18352 The value &"ignore"& causes Exim to completely ignore a host whose IP address
18353 cannot be found. If all the hosts in the list are ignored, the behaviour is
18354 controlled by the &%host_all_ignored%& option. This takes the same values
18355 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
18356
18357 The &%host_find_failed%& option applies only to a definite &"does not exist"&
18358 state; if a host lookup gets a temporary error, delivery is deferred unless the
18359 generic &%pass_on_timeout%& option is set.
18360
18361
18362 .option hosts_randomize manualroute boolean false
18363 .cindex "randomized host list"
18364 .cindex "host" "list of; randomized"
18365 If this option is set, the order of the items in a host list in a routing rule
18366 is randomized each time the list is used, unless an option in the routing rule
18367 overrides (see below). Randomizing the order of a host list can be used to do
18368 crude load sharing. However, if more than one mail address is routed by the
18369 same router to the same host list, the host lists are considered to be the same
18370 (even though they may be randomized into different orders) for the purpose of
18371 deciding whether to batch the deliveries into a single SMTP transaction.
18372
18373 When &%hosts_randomize%& is true, a host list may be split
18374 into groups whose order is separately randomized. This makes it possible to
18375 set up MX-like behaviour. The boundaries between groups are indicated by an
18376 item that is just &`+`& in the host list. For example:
18377 .code
18378 route_list = * host1:host2:host3:+:host4:host5
18379 .endd
18380 The order of the first three hosts and the order of the last two hosts is
18381 randomized for each use, but the first three always end up before the last two.
18382 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
18383 randomized host list is passed to an &(smtp)& transport that also has
18384 &%hosts_randomize set%&, the list is not re-randomized.
18385
18386
18387 .option route_data manualroute string&!! unset
18388 If this option is set, it must expand to yield the data part of a routing rule.
18389 Typically, the expansion string includes a lookup based on the domain. For
18390 example:
18391 .code
18392 route_data = ${lookup{$domain}dbm{/etc/routes}}
18393 .endd
18394 If the expansion is forced to fail, or the result is an empty string, the
18395 router declines. Other kinds of expansion failure cause delivery to be
18396 deferred.
18397
18398
18399 .option route_list manualroute "string list" unset
18400 This string is a list of routing rules, in the form defined below. Note that,
18401 unlike most string lists, the items are separated by semicolons. This is so
18402 that they may contain colon-separated host lists.
18403
18404
18405 .option same_domain_copy_routing manualroute boolean false
18406 .cindex "address" "copying routing"
18407 Addresses with the same domain are normally routed by the &(manualroute)&
18408 router to the same list of hosts. However, this cannot be presumed, because the
18409 router options and preconditions may refer to the local part of the address. By
18410 default, therefore, Exim routes each address in a message independently. DNS
18411 servers run caches, so repeated DNS lookups are not normally expensive, and in
18412 any case, personal messages rarely have more than a few recipients.
18413
18414 If you are running mailing lists with large numbers of subscribers at the same
18415 domain, and you are using a &(manualroute)& router which is independent of the
18416 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
18417 lookups for identical domains in one message. In this case, when
18418 &(manualroute)& routes an address to a remote transport, any other unrouted
18419 addresses in the message that have the same domain are automatically given the
18420 same routing without processing them independently. However, this is only done
18421 if &%headers_add%& and &%headers_remove%& are unset.
18422
18423
18424
18425
18426 .section "Routing rules in route_list" "SECID120"
18427 The value of &%route_list%& is a string consisting of a sequence of routing
18428 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
18429 entered as two semicolons. Alternatively, the list separator can be changed as
18430 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
18431 Empty rules are ignored. The format of each rule is
18432 .display
18433 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
18434 .endd
18435 The following example contains two rules, each with a simple domain pattern and
18436 no options:
18437 .code
18438 route_list = \
18439   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
18440   thes.ref.example  mail-3.ref.example:mail-4.ref.example
18441 .endd
18442 The three parts of a rule are separated by white space. The pattern and the
18443 list of hosts can be enclosed in quotes if necessary, and if they are, the
18444 usual quoting rules apply. Each rule in a &%route_list%& must start with a
18445 single domain pattern, which is the only mandatory item in the rule. The
18446 pattern is in the same format as one item in a domain list (see section
18447 &<<SECTdomainlist>>&),
18448 except that it may not be the name of an interpolated file.
18449 That is, it may be wildcarded, or a regular expression, or a file or database
18450 lookup (with semicolons doubled, because of the use of semicolon as a separator
18451 in a &%route_list%&).
18452
18453 The rules in &%route_list%& are searched in order until one of the patterns
18454 matches the domain that is being routed. The list of hosts and then options are
18455 then used as described below. If there is no match, the router declines. When
18456 &%route_list%& is set, &%route_data%& must not be set.
18457
18458
18459
18460 .section "Routing rules in route_data" "SECID121"
18461 The use of &%route_list%& is convenient when there are only a small number of
18462 routing rules. For larger numbers, it is easier to use a file or database to
18463 hold the routing information, and use the &%route_data%& option instead.
18464 The value of &%route_data%& is a list of hosts, followed by (optional) options.
18465 Most commonly, &%route_data%& is set as a string that contains an
18466 expansion lookup. For example, suppose we place two routing rules in a file
18467 like this:
18468 .code
18469 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
18470 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
18471 .endd
18472 This data can be accessed by setting
18473 .code
18474 route_data = ${lookup{$domain}lsearch{/the/file/name}}
18475 .endd
18476 Failure of the lookup results in an empty string, causing the router to
18477 decline. However, you do not have to use a lookup in &%route_data%&. The only
18478 requirement is that the result of expanding the string is a list of hosts,
18479 possibly followed by options, separated by white space. The list of hosts must
18480 be enclosed in quotes if it contains white space.
18481
18482
18483
18484
18485 .section "Format of the list of hosts" "SECID122"
18486 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
18487 always separately expanded before use. If the expansion fails, the router
18488 declines. The result of the expansion must be a colon-separated list of names
18489 and/or IP addresses, optionally also including ports. The format of each item
18490 in the list is described in the next section. The list separator can be changed
18491 as described in section &<<SECTlistconstruct>>&.
18492
18493 If the list of hosts was obtained from a &%route_list%& item, the following
18494 variables are set during its expansion:
18495
18496 .ilist
18497 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
18498 If the domain was matched against a regular expression, the numeric variables
18499 &$1$&, &$2$&, etc. may be set. For example:
18500 .code
18501 route_list = ^domain(\d+)   host-$1.text.example
18502 .endd
18503 .next
18504 &$0$& is always set to the entire domain.
18505 .next
18506 &$1$& is also set when partial matching is done in a file lookup.
18507
18508 .next
18509 .vindex "&$value$&"
18510 If the pattern that matched the domain was a lookup item, the data that was
18511 looked up is available in the expansion variable &$value$&. For example:
18512 .code
18513 route_list = lsearch;;/some/file.routes  $value
18514 .endd
18515 .endlist
18516
18517 Note the doubling of the semicolon in the pattern that is necessary because
18518 semicolon is the default route list separator.
18519
18520
18521
18522 .section "Format of one host item" "SECTformatonehostitem"
18523 Each item in the list of hosts is either a host name or an IP address,
18524 optionally with an attached port number. When no port is given, an IP address
18525 is not enclosed in brackets. When a port is specified, it overrides the port
18526 specification on the transport. The port is separated from the name or address
18527 by a colon. This leads to some complications:
18528
18529 .ilist
18530 Because colon is the default separator for the list of hosts, either
18531 the colon that specifies a port must be doubled, or the list separator must
18532 be changed. The following two examples have the same effect:
18533 .code
18534 route_list = * "host1.tld::1225 : host2.tld::1226"
18535 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
18536 .endd
18537 .next
18538 When IPv6 addresses are involved, it gets worse, because they contain
18539 colons of their own. To make this case easier, it is permitted to
18540 enclose an IP address (either v4 or v6) in square brackets if a port
18541 number follows. For example:
18542 .code
18543 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
18544 .endd
18545 .endlist
18546
18547 .section "How the list of hosts is used" "SECThostshowused"
18548 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
18549 the hosts is tried, in the order specified, when carrying out the SMTP
18550 delivery. However, the order can be changed by setting the &%hosts_randomize%&
18551 option, either on the router (see section &<<SECTprioptman>>& above), or on the
18552 transport.
18553
18554 Hosts may be listed by name or by IP address. An unadorned name in the list of
18555 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
18556 interpreted as an indirection to a sublist of hosts obtained by looking up MX
18557 records in the DNS. For example:
18558 .code
18559 route_list = *  x.y.z:p.q.r/MX:e.f.g
18560 .endd
18561 If this feature is used with a port specifier, the port must come last. For
18562 example:
18563 .code
18564 route_list = *  dom1.tld/mx::1225
18565 .endd
18566 If the &%hosts_randomize%& option is set, the order of the items in the list is
18567 randomized before any lookups are done. Exim then scans the list; for any name
18568 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
18569 be an interface on the local host and the item is not the first in the list,
18570 Exim discards it and any subsequent items. If it is the first item, what
18571 happens is controlled by the
18572 .oindex "&%self%&" "in &(manualroute)& router"
18573 &%self%& option of the router.
18574
18575 A name on the list that is followed by &`/MX`& is replaced with the list of
18576 hosts obtained by looking up MX records for the name. This is always a DNS
18577 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
18578 below) are not relevant here. The order of these hosts is determined by the
18579 preference values in the MX records, according to the usual rules. Because
18580 randomizing happens before the MX lookup, it does not affect the order that is
18581 defined by MX preferences.
18582
18583 If the local host is present in the sublist obtained from MX records, but is
18584 not the most preferred host in that list, it and any equally or less
18585 preferred hosts are removed before the sublist is inserted into the main list.
18586
18587 If the local host is the most preferred host in the MX list, what happens
18588 depends on where in the original list of hosts the &`/MX`& item appears. If it
18589 is not the first item (that is, there are previous hosts in the main list),
18590 Exim discards this name and any subsequent items in the main list.
18591
18592 If the MX item is first in the list of hosts, and the local host is the
18593 most preferred host, what happens is controlled by the &%self%& option of the
18594 router.
18595
18596 DNS failures when lookup up the MX records are treated in the same way as DNS
18597 failures when looking up IP addresses: &%pass_on_timeout%& and
18598 &%host_find_failed%& are used when relevant.
18599
18600 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
18601 whether obtained from an MX lookup or not.
18602
18603
18604
18605 .section "How the options are used" "SECThowoptused"
18606 The options are a sequence of words; in practice no more than three are ever
18607 present. One of the words can be the name of a transport; this overrides the
18608 &%transport%& option on the router for this particular routing rule only. The
18609 other words (if present) control randomization of the list of hosts on a
18610 per-rule basis, and how the IP addresses of the hosts are to be found when
18611 routing to a remote transport. These options are as follows:
18612
18613 .ilist
18614 &%randomize%&: randomize the order of the hosts in this list, overriding the
18615 setting of &%hosts_randomize%& for this routing rule only.
18616 .next
18617 &%no_randomize%&: do not randomize the order of the hosts in this list,
18618 overriding the setting of &%hosts_randomize%& for this routing rule only.
18619 .next
18620 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
18621 find IP addresses. This function may ultimately cause a DNS lookup, but it may
18622 also look in &_/etc/hosts_& or other sources of information.
18623 .next
18624 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
18625 no address records are found. If there is a temporary DNS error (such as a
18626 timeout), delivery is deferred.
18627 .endlist
18628
18629 For example:
18630 .code
18631 route_list = domain1  host1:host2:host3  randomize bydns;\
18632              domain2  host4:host5
18633 .endd
18634 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
18635 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
18636 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
18637 or &[gethostbyname()]&, and the result of the lookup is the result of that
18638 call.
18639
18640 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
18641 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
18642 instead of TRY_AGAIN. That is why the default action is to try a DNS
18643 lookup first. Only if that gives a definite &"no such host"& is the local
18644 function called.
18645
18646
18647
18648 If no IP address for a host can be found, what happens is controlled by the
18649 &%host_find_failed%& option.
18650
18651 .vindex "&$host$&"
18652 When an address is routed to a local transport, IP addresses are not looked up.
18653 The host list is passed to the transport in the &$host$& variable.
18654
18655
18656
18657 .section "Manualroute examples" "SECID123"
18658 In some of the examples that follow, the presence of the &%remote_smtp%&
18659 transport, as defined in the default configuration file, is assumed:
18660
18661 .ilist
18662 .cindex "smart host" "example router"
18663 The &(manualroute)& router can be used to forward all external mail to a
18664 &'smart host'&. If you have set up, in the main part of the configuration, a
18665 named domain list that contains your local domains, for example:
18666 .code
18667 domainlist local_domains = my.domain.example
18668 .endd
18669 You can arrange for all other domains to be routed to a smart host by making
18670 your first router something like this:
18671 .code
18672 smart_route:
18673   driver = manualroute
18674   domains = !+local_domains
18675   transport = remote_smtp
18676   route_list = * smarthost.ref.example
18677 .endd
18678 This causes all non-local addresses to be sent to the single host
18679 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
18680 they are tried in order
18681 (but you can use &%hosts_randomize%& to vary the order each time).
18682 Another way of configuring the same thing is this:
18683 .code
18684 smart_route:
18685   driver = manualroute
18686   transport = remote_smtp
18687   route_list = !+local_domains  smarthost.ref.example
18688 .endd
18689 There is no difference in behaviour between these two routers as they stand.
18690 However, they behave differently if &%no_more%& is added to them. In the first
18691 example, the router is skipped if the domain does not match the &%domains%&
18692 precondition; the following router is always tried. If the router runs, it
18693 always matches the domain and so can never decline. Therefore, &%no_more%&
18694 would have no effect. In the second case, the router is never skipped; it
18695 always runs. However, if it doesn't match the domain, it declines. In this case
18696 &%no_more%& would prevent subsequent routers from running.
18697
18698 .next
18699 .cindex "mail hub example"
18700 A &'mail hub'& is a host which receives mail for a number of domains via MX
18701 records in the DNS and delivers it via its own private routing mechanism. Often
18702 the final destinations are behind a firewall, with the mail hub being the one
18703 machine that can connect to machines both inside and outside the firewall. The
18704 &(manualroute)& router is usually used on a mail hub to route incoming messages
18705 to the correct hosts. For a small number of domains, the routing can be inline,
18706 using the &%route_list%& option, but for a larger number a file or database
18707 lookup is easier to manage.
18708
18709 If the domain names are in fact the names of the machines to which the mail is
18710 to be sent by the mail hub, the configuration can be quite simple. For
18711 example:
18712 .code
18713 hub_route:
18714   driver = manualroute
18715   transport = remote_smtp
18716   route_list = *.rhodes.tvs.example  $domain
18717 .endd
18718 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
18719 whose names are the same as the mail domains. A similar approach can be taken
18720 if the host name can be obtained from the domain name by a string manipulation
18721 that the expansion facilities can handle. Otherwise, a lookup based on the
18722 domain can be used to find the host:
18723 .code
18724 through_firewall:
18725   driver = manualroute
18726   transport = remote_smtp
18727   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
18728 .endd
18729 The result of the lookup must be the name or IP address of the host (or
18730 hosts) to which the address is to be routed. If the lookup fails, the route
18731 data is empty, causing the router to decline. The address then passes to the
18732 next router.
18733
18734 .next
18735 .cindex "batched SMTP output example"
18736 .cindex "SMTP" "batched outgoing; example"
18737 You can use &(manualroute)& to deliver messages to pipes or files in batched
18738 SMTP format for onward transportation by some other means. This is one way of
18739 storing mail for a dial-up host when it is not connected. The route list entry
18740 can be as simple as a single domain name in a configuration like this:
18741 .code
18742 save_in_file:
18743   driver = manualroute
18744   transport = batchsmtp_appendfile
18745   route_list = saved.domain.example
18746 .endd
18747 though often a pattern is used to pick up more than one domain. If there are
18748 several domains or groups of domains with different transport requirements,
18749 different transports can be listed in the routing information:
18750 .code
18751 save_in_file:
18752   driver = manualroute
18753   route_list = \
18754     *.saved.domain1.example  $domain  batch_appendfile; \
18755     *.saved.domain2.example  \
18756       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
18757       batch_pipe
18758 .endd
18759 .vindex "&$domain$&"
18760 .vindex "&$host$&"
18761 The first of these just passes the domain in the &$host$& variable, which
18762 doesn't achieve much (since it is also in &$domain$&), but the second does a
18763 file lookup to find a value to pass, causing the router to decline to handle
18764 the address if the lookup fails.
18765
18766 .next
18767 .cindex "UUCP" "example of router for"
18768 Routing mail directly to UUCP software is a specific case of the use of
18769 &(manualroute)& in a gateway to another mail environment. This is an example of
18770 one way it can be done:
18771 .code
18772 # Transport
18773 uucp:
18774   driver = pipe
18775   user = nobody
18776   command = /usr/local/bin/uux -r - \
18777     ${substr_-5:$host}!rmail ${local_part}
18778   return_fail_output = true
18779
18780 # Router
18781 uucphost:
18782   transport = uucp
18783   driver = manualroute
18784   route_data = \
18785     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
18786 .endd
18787 The file &_/usr/local/exim/uucphosts_& contains entries like
18788 .code
18789 darksite.ethereal.example:           darksite.UUCP
18790 .endd
18791 It can be set up more simply without adding and removing &".UUCP"& but this way
18792 makes clear the distinction between the domain name
18793 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
18794 .endlist
18795 .ecindex IIDmanrou1
18796 .ecindex IIDmanrou2
18797
18798
18799
18800
18801
18802
18803
18804
18805 . ////////////////////////////////////////////////////////////////////////////
18806 . ////////////////////////////////////////////////////////////////////////////
18807
18808 .chapter "The queryprogram router" "CHAPdriverlast"
18809 .scindex IIDquerou1 "&(queryprogram)& router"
18810 .scindex IIDquerou2 "routers" "&(queryprogram)&"
18811 .cindex "routing" "by external program"
18812 The &(queryprogram)& router routes an address by running an external command
18813 and acting on its output. This is an expensive way to route, and is intended
18814 mainly for use in lightly-loaded systems, or for performing experiments.
18815 However, if it is possible to use the precondition options (&%domains%&,
18816 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
18817 be used in special cases, even on a busy host. There are the following private
18818 options:
18819 .cindex "options" "&(queryprogram)& router"
18820
18821 .option command queryprogram string&!! unset
18822 This option must be set. It specifies the command that is to be run. The
18823 command is split up into a command name and arguments, and then each is
18824 expanded separately (exactly as for a &(pipe)& transport, described in chapter
18825 &<<CHAPpipetransport>>&).
18826
18827
18828 .option command_group queryprogram string unset
18829 .cindex "gid (group id)" "in &(queryprogram)& router"
18830 This option specifies a gid to be set when running the command while routing an
18831 address for deliver. It must be set if &%command_user%& specifies a numerical
18832 uid. If it begins with a digit, it is interpreted as the numerical value of the
18833 gid. Otherwise it is looked up using &[getgrnam()]&.
18834
18835
18836 .option command_user queryprogram string unset
18837 .cindex "uid (user id)" "for &(queryprogram)&"
18838 This option must be set. It specifies the uid which is set when running the
18839 command while routing an address for delivery. If the value begins with a digit,
18840 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
18841 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
18842 not set, a value for the gid also.
18843
18844 &*Warning:*& Changing uid and gid is possible only when Exim is running as
18845 root, which it does during a normal delivery in a conventional configuration.
18846 However, when an address is being verified during message reception, Exim is
18847 usually running as the Exim user, not as root. If the &(queryprogram)& router
18848 is called from a non-root process, Exim cannot change uid or gid before running
18849 the command. In this circumstance the command runs under the current uid and
18850 gid.
18851
18852
18853 .option current_directory queryprogram string /
18854 This option specifies an absolute path which is made the current directory
18855 before running the command.
18856
18857
18858 .option timeout queryprogram time 1h
18859 If the command does not complete within the timeout period, its process group
18860 is killed and the message is frozen. A value of zero time specifies no
18861 timeout.
18862
18863
18864 The standard output of the command is connected to a pipe, which is read when
18865 the command terminates. It should consist of a single line of output,
18866 containing up to five fields, separated by white space. The maximum length of
18867 the line is 1023 characters. Longer lines are silently truncated. The first
18868 field is one of the following words (case-insensitive):
18869
18870 .ilist
18871 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
18872 below).
18873 .next
18874 &'Decline'&: the router declines; pass the address to the next router, unless
18875 &%no_more%& is set.
18876 .next
18877 &'Fail'&: routing failed; do not pass the address to any more routers. Any
18878 subsequent text on the line is an error message. If the router is run as part
18879 of address verification during an incoming SMTP message, the message is
18880 included in the SMTP response.
18881 .next
18882 &'Defer'&: routing could not be completed at this time; try again later. Any
18883 subsequent text on the line is an error message which is logged. It is not
18884 included in any SMTP response.
18885 .next
18886 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
18887 .next
18888 &'Pass'&: pass the address to the next router (or the router specified by
18889 &%pass_router%&), overriding &%no_more%&.
18890 .next
18891 &'Redirect'&: the message is redirected. The remainder of the line is a list of
18892 new addresses, which are routed independently, starting with the first router,
18893 or the router specified by &%redirect_router%&, if set.
18894 .endlist
18895
18896 When the first word is &'accept'&, the remainder of the line consists of a
18897 number of keyed data values, as follows (split into two lines here, to fit on
18898 the page):
18899 .code
18900 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
18901 LOOKUP=byname|bydns DATA=<text>
18902 .endd
18903 The data items can be given in any order, and all are optional. If no transport
18904 is included, the transport specified by the generic &%transport%& option is
18905 used. The list of hosts and the lookup type are needed only if the transport is
18906 an &(smtp)& transport that does not itself supply a list of hosts.
18907
18908 The format of the list of hosts is the same as for the &(manualroute)& router.
18909 As well as host names and IP addresses with optional port numbers, as described
18910 in section &<<SECTformatonehostitem>>&, it may contain names followed by
18911 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
18912 (see section &<<SECThostshowused>>&).
18913
18914 If the lookup type is not specified, Exim behaves as follows when trying to
18915 find an IP address for each host: First, a DNS lookup is done. If this yields
18916 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
18917 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
18918 result of the lookup is the result of that call.
18919
18920 .vindex "&$address_data$&"
18921 If the DATA field is set, its value is placed in the &$address_data$&
18922 variable. For example, this return line
18923 .code
18924 accept hosts=x1.y.example:x2.y.example data="rule1"
18925 .endd
18926 routes the address to the default transport, passing a list of two hosts. When
18927 the transport runs, the string &"rule1"& is in &$address_data$&.
18928 .ecindex IIDquerou1
18929 .ecindex IIDquerou2
18930
18931
18932
18933
18934 . ////////////////////////////////////////////////////////////////////////////
18935 . ////////////////////////////////////////////////////////////////////////////
18936
18937 .chapter "The redirect router" "CHAPredirect"
18938 .scindex IIDredrou1 "&(redirect)& router"
18939 .scindex IIDredrou2 "routers" "&(redirect)&"
18940 .cindex "alias file" "in a &(redirect)& router"
18941 .cindex "address redirection" "&(redirect)& router"
18942 The &(redirect)& router handles several kinds of address redirection. Its most
18943 common uses are for resolving local part aliases from a central alias file
18944 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
18945 files, but it has many other potential uses. The incoming address can be
18946 redirected in several different ways:
18947
18948 .ilist
18949 It can be replaced by one or more new addresses which are themselves routed
18950 independently.
18951 .next
18952 It can be routed to be delivered to a given file or directory.
18953 .next
18954 It can be routed to be delivered to a specified pipe command.
18955 .next
18956 It can cause an automatic reply to be generated.
18957 .next
18958 It can be forced to fail, optionally with a custom error message.
18959 .next
18960 It can be temporarily deferred, optionally with a custom message.
18961 .next
18962 It can be discarded.
18963 .endlist
18964
18965 The generic &%transport%& option must not be set for &(redirect)& routers.
18966 However, there are some private options which define transports for delivery to
18967 files and pipes, and for generating autoreplies. See the &%file_transport%&,
18968 &%pipe_transport%& and &%reply_transport%& descriptions below.
18969
18970
18971
18972 .section "Redirection data" "SECID124"
18973 The router operates by interpreting a text string which it obtains either by
18974 expanding the contents of the &%data%& option, or by reading the entire
18975 contents of a file whose name is given in the &%file%& option. These two
18976 options are mutually exclusive. The first is commonly used for handling system
18977 aliases, in a configuration like this:
18978 .code
18979 system_aliases:
18980   driver = redirect
18981   data = ${lookup{$local_part}lsearch{/etc/aliases}}
18982 .endd
18983 If the lookup fails, the expanded string in this example is empty. When the
18984 expansion of &%data%& results in an empty string, the router declines. A forced
18985 expansion failure also causes the router to decline; other expansion failures
18986 cause delivery to be deferred.
18987
18988 A configuration using &%file%& is commonly used for handling users'
18989 &_.forward_& files, like this:
18990 .code
18991 userforward:
18992   driver = redirect
18993   check_local_user
18994   file = $home/.forward
18995   no_verify
18996 .endd
18997 If the file does not exist, or causes no action to be taken (for example, it is
18998 empty or consists only of comments), the router declines. &*Warning*&: This
18999 is not the case when the file contains syntactically valid items that happen to
19000 yield empty addresses, for example, items containing only RFC 2822 address
19001 comments.
19002
19003
19004
19005 .section "Forward files and address verification" "SECID125"
19006 .cindex "address redirection" "while verifying"
19007 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
19008 &_.forward_& files, as in the example above. There are two reasons for this:
19009
19010 .ilist
19011 When Exim is receiving an incoming SMTP message from a remote host, it is
19012 running under the Exim uid, not as root. Exim is unable to change uid to read
19013 the file as the user, and it may not be able to read it as the Exim user. So in
19014 practice the router may not be able to operate.
19015 .next
19016 However, even when the router can operate, the existence of a &_.forward_& file
19017 is unimportant when verifying an address. What should be checked is whether the
19018 local part is a valid user name or not. Cutting out the redirection processing
19019 saves some resources.
19020 .endlist
19021
19022
19023
19024
19025
19026
19027 .section "Interpreting redirection data" "SECID126"
19028 .cindex "Sieve filter" "specifying in redirection data"
19029 .cindex "filter" "specifying in redirection data"
19030 The contents of the data string, whether obtained from &%data%& or &%file%&,
19031 can be interpreted in two different ways:
19032
19033 .ilist
19034 If the &%allow_filter%& option is set true, and the data begins with the text
19035 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
19036 &'filtering'& instructions in the form of an Exim or Sieve filter file,
19037 respectively. Details of the syntax and semantics of filter files are described
19038 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
19039 document is intended for use by end users.
19040 .next
19041 Otherwise, the data must be a comma-separated list of redirection items, as
19042 described in the next section.
19043 .endlist
19044
19045 When a message is redirected to a file (a &"mail folder"&), the file name given
19046 in a non-filter redirection list must always be an absolute path. A filter may
19047 generate a relative path &-- how this is handled depends on the transport's
19048 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
19049 for the &(appendfile)& transport.
19050
19051
19052
19053 .section "Items in a non-filter redirection list" "SECTitenonfilred"
19054 .cindex "address redirection" "non-filter list items"
19055 When the redirection data is not an Exim or Sieve filter, for example, if it
19056 comes from a conventional alias or forward file, it consists of a list of
19057 addresses, file names, pipe commands, or certain special items (see section
19058 &<<SECTspecitredli>>& below). The special items can be individually enabled or
19059 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
19060 depending on their default values. The items in the list are separated by
19061 commas or newlines.
19062 If a comma is required in an item, the entire item must be enclosed in double
19063 quotes.
19064
19065 Lines starting with a # character are comments, and are ignored, and # may
19066 also appear following a comma, in which case everything between the # and the
19067 next newline character is ignored.
19068
19069 If an item is entirely enclosed in double quotes, these are removed. Otherwise
19070 double quotes are retained because some forms of mail address require their use
19071 (but never to enclose the entire address). In the following description,
19072 &"item"& refers to what remains after any surrounding double quotes have been
19073 removed.
19074
19075 .vindex "&$local_part$&"
19076 &*Warning*&: If you use an Exim expansion to construct a redirection address,
19077 and the expansion contains a reference to &$local_part$&, you should make use
19078 of the &%quote_local_part%& expansion operator, in case the local part contains
19079 special characters. For example, to redirect all mail for the domain
19080 &'obsolete.example'&, retaining the existing local part, you could use this
19081 setting:
19082 .code
19083 data = ${quote_local_part:$local_part}@newdomain.example
19084 .endd
19085
19086
19087 .section "Redirecting to a local mailbox" "SECTredlocmai"
19088 .cindex "routing" "loops in"
19089 .cindex "loop" "while routing, avoidance of"
19090 .cindex "address redirection" "to local mailbox"
19091 A redirection item may safely be the same as the address currently under
19092 consideration. This does not cause a routing loop, because a router is
19093 automatically skipped if any ancestor of the address that is being processed
19094 is the same as the current address and was processed by the current router.
19095 Such an address is therefore passed to the following routers, so it is handled
19096 as if there were no redirection. When making this loop-avoidance test, the
19097 complete local part, including any prefix or suffix, is used.
19098
19099 .cindex "address redirection" "local part without domain"
19100 Specifying the same local part without a domain is a common usage in personal
19101 filter files when the user wants to have messages delivered to the local
19102 mailbox and also forwarded elsewhere. For example, the user whose login is
19103 &'cleo'& might have a &_.forward_& file containing this:
19104 .code
19105 cleo, cleopatra@egypt.example
19106 .endd
19107 .cindex "backslash in alias file"
19108 .cindex "alias file" "backslash in"
19109 For compatibility with other MTAs, such unqualified local parts may be
19110 preceded by &"\"&, but this is not a requirement for loop prevention. However,
19111 it does make a difference if more than one domain is being handled
19112 synonymously.
19113
19114 If an item begins with &"\"& and the rest of the item parses as a valid RFC
19115 2822 address that does not include a domain, the item is qualified using the
19116 domain of the incoming address. In the absence of a leading &"\"&, unqualified
19117 addresses are qualified using the value in &%qualify_recipient%&, but you can
19118 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
19119
19120 Care must be taken if there are alias names for local users.
19121 Consider an MTA handling a single local domain where the system alias file
19122 contains:
19123 .code
19124 Sam.Reman: spqr
19125 .endd
19126 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
19127 messages in the local mailbox, and also forward copies elsewhere. He creates
19128 this forward file:
19129 .code
19130 Sam.Reman, spqr@reme.elsewhere.example
19131 .endd
19132 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
19133 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
19134 second time round, because it has previously routed it,
19135 and the following routers presumably cannot handle the alias. The forward file
19136 should really contain
19137 .code
19138 spqr, spqr@reme.elsewhere.example
19139 .endd
19140 but because this is such a common error, the &%check_ancestor%& option (see
19141 below) exists to provide a way to get round it. This is normally set on a
19142 &(redirect)& router that is handling users' &_.forward_& files.
19143
19144
19145
19146 .section "Special items in redirection lists" "SECTspecitredli"
19147 In addition to addresses, the following types of item may appear in redirection
19148 lists (that is, in non-filter redirection data):
19149
19150 .ilist
19151 .cindex "pipe" "in redirection list"
19152 .cindex "address redirection" "to pipe"
19153 An item is treated as a pipe command if it begins with &"|"& and does not parse
19154 as a valid RFC 2822 address that includes a domain. A transport for running the
19155 command must be specified by the &%pipe_transport%& option.
19156 Normally, either the router or the transport specifies a user and a group under
19157 which to run the delivery. The default is to use the Exim user and group.
19158
19159 Single or double quotes can be used for enclosing the individual arguments of
19160 the pipe command; no interpretation of escapes is done for single quotes. If
19161 the command contains a comma character, it is necessary to put the whole item
19162 in double quotes, for example:
19163 .code
19164 "|/some/command ready,steady,go"
19165 .endd
19166 since items in redirection lists are terminated by commas. Do not, however,
19167 quote just the command. An item such as
19168 .code
19169 |"/some/command ready,steady,go"
19170 .endd
19171 is interpreted as a pipe with a rather strange command name, and no arguments.
19172
19173 Note that the above example assumes that the text comes from a lookup source
19174 of some sort, so that the quotes are part of the data.  If composing a
19175 redirect router with a &%data%& option directly specifying this command, the
19176 quotes will be used by the configuration parser to define the extent of one
19177 string, but will not be passed down into the redirect router itself.  There
19178 are two main approaches to get around this: escape quotes to be part of the
19179 data itself, or avoid using this mechanism and instead create a custom
19180 transport with the &%command%& option set and reference that transport from
19181 an &%accept%& router.
19182
19183 .next
19184 .cindex "file" "in redirection list"
19185 .cindex "address redirection" "to file"
19186 An item is interpreted as a path name if it begins with &"/"& and does not
19187 parse as a valid RFC 2822 address that includes a domain. For example,
19188 .code
19189 /home/world/minbari
19190 .endd
19191 is treated as a file name, but
19192 .code
19193 /s=molari/o=babylon/@x400gate.way
19194 .endd
19195 is treated as an address. For a file name, a transport must be specified using
19196 the &%file_transport%& option. However, if the generated path name ends with a
19197 forward slash character, it is interpreted as a directory name rather than a
19198 file name, and &%directory_transport%& is used instead.
19199
19200 Normally, either the router or the transport specifies a user and a group under
19201 which to run the delivery. The default is to use the Exim user and group.
19202
19203 .cindex "&_/dev/null_&"
19204 However, if a redirection item is the path &_/dev/null_&, delivery to it is
19205 bypassed at a high level, and the log entry shows &"**bypassed**"&
19206 instead of a transport name. In this case the user and group are not used.
19207
19208 .next
19209 .cindex "included address list"
19210 .cindex "address redirection" "included external list"
19211 If an item is of the form
19212 .code
19213 :include:<path name>
19214 .endd
19215 a list of further items is taken from the given file and included at that
19216 point. &*Note*&: Such a file can not be a filter file; it is just an
19217 out-of-line addition to the list. The items in the included list are separated
19218 by commas or newlines and are not subject to expansion. If this is the first
19219 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
19220 the alias name. This example is incorrect:
19221 .code
19222 list1    :include:/opt/lists/list1
19223 .endd
19224 It must be given as
19225 .code
19226 list1:   :include:/opt/lists/list1
19227 .endd
19228 .next
19229 .cindex "address redirection" "to black hole"
19230 Sometimes you want to throw away mail to a particular local part. Making the
19231 &%data%& option expand to an empty string does not work, because that causes
19232 the router to decline. Instead, the alias item
19233 .cindex "black hole"
19234 .cindex "abandoning mail"
19235 &':blackhole:'& can be used. It does what its name implies. No delivery is
19236 done, and no error message is generated. This has the same effect as specifing
19237 &_/dev/null_& as a destination, but it can be independently disabled.
19238
19239 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
19240 delivery is done for the original local part, even if other redirection items
19241 are present. If you are generating a multi-item list (for example, by reading a
19242 database) and need the ability to provide a no-op item, you must use
19243 &_/dev/null_&.
19244
19245 .next
19246 .cindex "delivery" "forcing failure"
19247 .cindex "delivery" "forcing deferral"
19248 .cindex "failing delivery" "forcing"
19249 .cindex "deferred delivery, forcing"
19250 .cindex "customizing" "failure message"
19251 An attempt to deliver a particular address can be deferred or forced to fail by
19252 redirection items of the form
19253 .code
19254 :defer:
19255 :fail:
19256 .endd
19257 respectively. When a redirection list contains such an item, it applies
19258 to the entire redirection; any other items in the list are ignored. Any
19259 text following &':fail:'& or &':defer:'& is placed in the error text
19260 associated with the failure. For example, an alias file might contain:
19261 .code
19262 X.Employee:  :fail: Gone away, no forwarding address
19263 .endd
19264 In the case of an address that is being verified from an ACL or as the subject
19265 of a
19266 .cindex "VRFY" "error text, display of"
19267 VRFY command, the text is included in the SMTP error response by
19268 default.
19269 .cindex "EXPN" "error text, display of"
19270 The text is not included in the response to an EXPN command. In non-SMTP cases
19271 the text is included in the error message that Exim generates.
19272
19273 .cindex "SMTP" "error codes"
19274 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
19275 &':fail:'&. However, if the message starts with three digits followed by a
19276 space, optionally followed by an extended code of the form &'n.n.n'&, also
19277 followed by a space, and the very first digit is the same as the default error
19278 code, the code from the message is used instead. If the very first digit is
19279 incorrect, a panic error is logged, and the default code is used. You can
19280 suppress the use of the supplied code in a redirect router by setting the
19281 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
19282 ignored.
19283
19284 .vindex "&$acl_verify_message$&"
19285 In an ACL, an explicitly provided message overrides the default, but the
19286 default message is available in the variable &$acl_verify_message$& and can
19287 therefore be included in a custom message if this is desired.
19288
19289 Normally the error text is the rest of the redirection list &-- a comma does
19290 not terminate it &-- but a newline does act as a terminator. Newlines are not
19291 normally present in alias expansions. In &(lsearch)& lookups they are removed
19292 as part of the continuation process, but they may exist in other kinds of
19293 lookup and in &':include:'& files.
19294
19295 During routing for message delivery (as opposed to verification), a redirection
19296 containing &':fail:'& causes an immediate failure of the incoming address,
19297 whereas &':defer:'& causes the message to remain on the queue so that a
19298 subsequent delivery attempt can happen at a later time. If an address is
19299 deferred for too long, it will ultimately fail, because the normal retry
19300 rules still apply.
19301
19302 .next
19303 .cindex "alias file" "exception to default"
19304 Sometimes it is useful to use a single-key search type with a default (see
19305 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
19306 for exceptions to the default. These can be handled by aliasing them to
19307 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
19308 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
19309 results in an empty redirection list has the same effect.
19310 .endlist
19311
19312
19313 .section "Duplicate addresses" "SECTdupaddr"
19314 .cindex "duplicate addresses"
19315 .cindex "address duplicate, discarding"
19316 .cindex "pipe" "duplicated"
19317 Exim removes duplicate addresses from the list to which it is delivering, so as
19318 to deliver just one copy to each address. This does not apply to deliveries
19319 routed to pipes by different immediate parent addresses, but an indirect
19320 aliasing scheme of the type
19321 .code
19322 pipe:       |/some/command $local_part
19323 localpart1: pipe
19324 localpart2: pipe
19325 .endd
19326 does not work with a message that is addressed to both local parts, because
19327 when the second is aliased to the intermediate local part &"pipe"& it gets
19328 discarded as being the same as a previously handled address. However, a scheme
19329 such as
19330 .code
19331 localpart1: |/some/command $local_part
19332 localpart2: |/some/command $local_part
19333 .endd
19334 does result in two different pipe deliveries, because the immediate parents of
19335 the pipes are distinct.
19336
19337
19338
19339 .section "Repeated redirection expansion" "SECID128"
19340 .cindex "repeated redirection expansion"
19341 .cindex "address redirection" "repeated for each delivery attempt"
19342 When a message cannot be delivered to all of its recipients immediately,
19343 leading to two or more delivery attempts, redirection expansion is carried out
19344 afresh each time for those addresses whose children were not all previously
19345 delivered. If redirection is being used as a mailing list, this can lead to new
19346 members of the list receiving copies of old messages. The &%one_time%& option
19347 can be used to avoid this.
19348
19349
19350 .section "Errors in redirection lists" "SECID129"
19351 .cindex "address redirection" "errors"
19352 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
19353 error is skipped, and an entry is written to the main log. This may be useful
19354 for mailing lists that are automatically managed. Otherwise, if an error is
19355 detected while generating the list of new addresses, the original address is
19356 deferred. See also &%syntax_errors_to%&.
19357
19358
19359
19360 .section "Private options for the redirect router" "SECID130"
19361
19362 .cindex "options" "&(redirect)& router"
19363 The private options for the &(redirect)& router are as follows:
19364
19365
19366 .option allow_defer redirect boolean false
19367 Setting this option allows the use of &':defer:'& in non-filter redirection
19368 data, or the &%defer%& command in an Exim filter file.
19369
19370
19371 .option allow_fail redirect boolean false
19372 .cindex "failing delivery" "from filter"
19373 If this option is true, the &':fail:'& item can be used in a redirection list,
19374 and the &%fail%& command may be used in an Exim filter file.
19375
19376
19377 .option allow_filter redirect boolean false
19378 .cindex "filter" "enabling use of"
19379 .cindex "Sieve filter" "enabling use of"
19380 Setting this option allows Exim to interpret redirection data that starts with
19381 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
19382 are some features of Exim filter files that some administrators may wish to
19383 lock out; see the &%forbid_filter_%&&'xxx'& options below.
19384
19385 It is also possible to lock out Exim filters or Sieve filters while allowing
19386 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
19387
19388
19389 The filter is run using the uid and gid set by the generic &%user%& and
19390 &%group%& options. These take their defaults from the password data if
19391 &%check_local_user%& is set, so in the normal case of users' personal filter
19392 files, the filter is run as the relevant user. When &%allow_filter%& is set
19393 true, Exim insists that either &%check_local_user%& or &%user%& is set.
19394
19395
19396
19397 .option allow_freeze redirect boolean false
19398 .cindex "freezing messages" "allowing in filter"
19399 Setting this option allows the use of the &%freeze%& command in an Exim filter.
19400 This command is more normally encountered in system filters, and is disabled by
19401 default for redirection filters because it isn't something you usually want to
19402 let ordinary users do.
19403
19404
19405
19406 .option check_ancestor redirect boolean false
19407 This option is concerned with handling generated addresses that are the same
19408 as some address in the list of redirection ancestors of the current address.
19409 Although it is turned off by default in the code, it is set in the default
19410 configuration file for handling users' &_.forward_& files. It is recommended
19411 for this use of the &(redirect)& router.
19412
19413 When &%check_ancestor%& is set, if a generated address (including the domain)
19414 is the same as any ancestor of the current address, it is replaced by a copy of
19415 the current address. This helps in the case where local part A is aliased to B,
19416 and B has a &_.forward_& file pointing back to A. For example, within a single
19417 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
19418 &_&~jb/.forward_& contains:
19419 .code
19420 \Joe.Bloggs, <other item(s)>
19421 .endd
19422 Without the &%check_ancestor%& setting, either local part (&"jb"& or
19423 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
19424 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
19425 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
19426 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
19427 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
19428 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
19429 original address. See also the &%repeat_use%& option below.
19430
19431
19432 .option check_group redirect boolean "see below"
19433 When the &%file%& option is used, the group owner of the file is checked only
19434 when this option is set. The permitted groups are those listed in the
19435 &%owngroups%& option, together with the user's default group if
19436 &%check_local_user%& is set. If the file has the wrong group, routing is
19437 deferred. The default setting for this option is true if &%check_local_user%&
19438 is set and the &%modemask%& option permits the group write bit, or if the
19439 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
19440
19441
19442
19443 .option check_owner redirect boolean "see below"
19444 When the &%file%& option is used, the owner of the file is checked only when
19445 this option is set. If &%check_local_user%& is set, the local user is
19446 permitted; otherwise the owner must be one of those listed in the &%owners%&
19447 option. The default value for this option is true if &%check_local_user%& or
19448 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
19449
19450
19451 .option data redirect string&!! unset
19452 This option is mutually exclusive with &%file%&. One or other of them must be
19453 set, but not both. The contents of &%data%& are expanded, and then used as the
19454 list of forwarding items, or as a set of filtering instructions. If the
19455 expansion is forced to fail, or the result is an empty string or a string that
19456 has no effect (consists entirely of comments), the router declines.
19457
19458 When filtering instructions are used, the string must begin with &"#Exim
19459 filter"&, and all comments in the string, including this initial one, must be
19460 terminated with newline characters. For example:
19461 .code
19462 data = #Exim filter\n\
19463        if $h_to: contains Exim then save $home/mail/exim endif
19464 .endd
19465 If you are reading the data from a database where newlines cannot be included,
19466 you can use the &${sg}$& expansion item to turn the escape string of your
19467 choice into a newline.
19468
19469
19470 .option directory_transport redirect string&!! unset
19471 A &(redirect)& router sets up a direct delivery to a directory when a path name
19472 ending with a slash is specified as a new &"address"&. The transport used is
19473 specified by this option, which, after expansion, must be the name of a
19474 configured transport. This should normally be an &(appendfile)& transport.
19475
19476
19477 .option file redirect string&!! unset
19478 This option specifies the name of a file that contains the redirection data. It
19479 is mutually exclusive with the &%data%& option. The string is expanded before
19480 use; if the expansion is forced to fail, the router declines. Other expansion
19481 failures cause delivery to be deferred. The result of a successful expansion
19482 must be an absolute path. The entire file is read and used as the redirection
19483 data. If the data is an empty string or a string that has no effect (consists
19484 entirely of comments), the router declines.
19485
19486 .cindex "NFS" "checking for file existence"
19487 If the attempt to open the file fails with a &"does not exist"& error, Exim
19488 runs a check on the containing directory,
19489 unless &%ignore_enotdir%& is true (see below).
19490 If the directory does not appear to exist, delivery is deferred. This can
19491 happen when users' &_.forward_& files are in NFS-mounted directories, and there
19492 is a mount problem. If the containing directory does exist, but the file does
19493 not, the router declines.
19494
19495
19496 .option file_transport redirect string&!! unset
19497 .vindex "&$address_file$&"
19498 A &(redirect)& router sets up a direct delivery to a file when a path name not
19499 ending in a slash is specified as a new &"address"&. The transport used is
19500 specified by this option, which, after expansion, must be the name of a
19501 configured transport. This should normally be an &(appendfile)& transport. When
19502 it is running, the file name is in &$address_file$&.
19503
19504
19505 .option filter_prepend_home redirect boolean true
19506 When this option is true, if a &(save)& command in an Exim filter specifies a
19507 relative path, and &$home$& is defined, it is automatically prepended to the
19508 relative path. If this option is set false, this action does not happen. The
19509 relative path is then passed to the transport unmodified.
19510
19511
19512 .option forbid_blackhole redirect boolean false
19513 If this option is true, the &':blackhole:'& item may not appear in a
19514 redirection list.
19515
19516
19517 .option forbid_exim_filter redirect boolean false
19518 If this option is set true, only Sieve filters are permitted when
19519 &%allow_filter%& is true.
19520
19521
19522
19523
19524 .option forbid_file redirect boolean false
19525 .cindex "delivery" "to file; forbidding"
19526 .cindex "Sieve filter" "forbidding delivery to a file"
19527 .cindex "Sieve filter" "&""keep""& facility; disabling"
19528 If this option is true, this router may not generate a new address that
19529 specifies delivery to a local file or directory, either from a filter or from a
19530 conventional forward file. This option is forced to be true if &%one_time%& is
19531 set. It applies to Sieve filters as well as to Exim filters, but if true, it
19532 locks out the Sieve's &"keep"& facility.
19533
19534
19535 .option forbid_filter_dlfunc redirect boolean false
19536 .cindex "filter" "locking out certain features"
19537 If this option is true, string expansions in Exim filters are not allowed to
19538 make use of the &%dlfunc%& expansion facility to run dynamically loaded
19539 functions.
19540
19541 .option forbid_filter_existstest redirect boolean false
19542 .cindex "expansion" "statting a file"
19543 If this option is true, string expansions in Exim filters are not allowed to
19544 make use of the &%exists%& condition or the &%stat%& expansion item.
19545
19546 .option forbid_filter_logwrite redirect boolean false
19547 If this option is true, use of the logging facility in Exim filters is not
19548 permitted. Logging is in any case available only if the filter is being run
19549 under some unprivileged uid (which is normally the case for ordinary users'
19550 &_.forward_& files).
19551
19552
19553 .option forbid_filter_lookup redirect boolean false
19554 If this option is true, string expansions in Exim filter files are not allowed
19555 to make use of &%lookup%& items.
19556
19557
19558 .option forbid_filter_perl redirect boolean false
19559 This option has an effect only if Exim is built with embedded Perl support. If
19560 it is true, string expansions in Exim filter files are not allowed to make use
19561 of the embedded Perl support.
19562
19563
19564 .option forbid_filter_readfile redirect boolean false
19565 If this option is true, string expansions in Exim filter files are not allowed
19566 to make use of &%readfile%& items.
19567
19568
19569 .option forbid_filter_readsocket redirect boolean false
19570 If this option is true, string expansions in Exim filter files are not allowed
19571 to make use of &%readsocket%& items.
19572
19573
19574 .option forbid_filter_reply redirect boolean false
19575 If this option is true, this router may not generate an automatic reply
19576 message. Automatic replies can be generated only from Exim or Sieve filter
19577 files, not from traditional forward files. This option is forced to be true if
19578 &%one_time%& is set.
19579
19580
19581 .option forbid_filter_run redirect boolean false
19582 If this option is true, string expansions in Exim filter files are not allowed
19583 to make use of &%run%& items.
19584
19585
19586 .option forbid_include redirect boolean false
19587 If this option is true, items of the form
19588 .code
19589 :include:<path name>
19590 .endd
19591 are not permitted in non-filter redirection lists.
19592
19593
19594 .option forbid_pipe redirect boolean false
19595 .cindex "delivery" "to pipe; forbidding"
19596 If this option is true, this router may not generate a new address which
19597 specifies delivery to a pipe, either from an Exim filter or from a conventional
19598 forward file. This option is forced to be true if &%one_time%& is set.
19599
19600
19601 .option forbid_sieve_filter redirect boolean false
19602 If this option is set true, only Exim filters are permitted when
19603 &%allow_filter%& is true.
19604
19605
19606 .cindex "SMTP" "error codes"
19607 .option forbid_smtp_code redirect boolean false
19608 If this option is set true, any SMTP error codes that are present at the start
19609 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
19610 the default codes (451 and 550, respectively) are always used.
19611
19612
19613
19614
19615 .option hide_child_in_errmsg redirect boolean false
19616 .cindex "bounce message" "redirection details; suppressing"
19617 If this option is true, it prevents Exim from quoting a child address if it
19618 generates a bounce or delay message for it. Instead it says &"an address
19619 generated from <&'the top level address'&>"&. Of course, this applies only to
19620 bounces generated locally. If a message is forwarded to another host, &'its'&
19621 bounce may well quote the generated address.
19622
19623
19624 .option ignore_eacces redirect boolean false
19625 .cindex "EACCES"
19626 If this option is set and an attempt to open a redirection file yields the
19627 EACCES error (permission denied), the &(redirect)& router behaves as if the
19628 file did not exist.
19629
19630
19631 .option ignore_enotdir redirect boolean false
19632 .cindex "ENOTDIR"
19633 If this option is set and an attempt to open a redirection file yields the
19634 ENOTDIR error (something on the path is not a directory), the &(redirect)&
19635 router behaves as if the file did not exist.
19636
19637 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
19638 router that has the &%file%& option set discovers that the file does not exist
19639 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
19640 against unmounted NFS directories. If the parent can not be statted, delivery
19641 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
19642 is set, because that option tells Exim to ignore &"something on the path is not
19643 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
19644 that some operating systems give ENOENT where others give ENOTDIR.
19645
19646
19647
19648 .option include_directory redirect string unset
19649 If this option is set, the path names of any &':include:'& items in a
19650 redirection list must start with this directory.
19651
19652
19653 .option modemask redirect "octal integer" 022
19654 This specifies mode bits which must not be set for a file specified by the
19655 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
19656
19657
19658 .option one_time redirect boolean false
19659 .cindex "one-time aliasing/forwarding expansion"
19660 .cindex "alias file" "one-time expansion"
19661 .cindex "forward file" "one-time expansion"
19662 .cindex "mailing lists" "one-time expansion"
19663 .cindex "address redirection" "one-time expansion"
19664 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
19665 files each time it tries to deliver a message causes a problem when one or more
19666 of the generated addresses fails be delivered at the first attempt. The problem
19667 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
19668 but of what happens when the redirection list changes during the time that the
19669 message is on Exim's queue. This is particularly true in the case of mailing
19670 lists, where new subscribers might receive copies of messages that were posted
19671 before they subscribed.
19672
19673 If &%one_time%& is set and any addresses generated by the router fail to
19674 deliver at the first attempt, the failing addresses are added to the message as
19675 &"top level"& addresses, and the parent address that generated them is marked
19676 &"delivered"&. Thus, redirection does not happen again at the next delivery
19677 attempt.
19678
19679 &*Warning 1*&: Any header line addition or removal that is specified by this
19680 router would be lost if delivery did not succeed at the first attempt. For this
19681 reason, the &%headers_add%& and &%headers_remove%& generic options are not
19682 permitted when &%one_time%& is set.
19683
19684 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
19685 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
19686 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
19687
19688 &*Warning 3*&: The &%unseen%& generic router option may not be set with
19689 &%one_time%&.
19690
19691 The original top-level address is remembered with each of the generated
19692 addresses, and is output in any log messages. However, any intermediate parent
19693 addresses are not recorded. This makes a difference to the log only if
19694 &%all_parents%& log selector is set. It is expected that &%one_time%& will
19695 typically be used for mailing lists, where there is normally just one level of
19696 expansion.
19697
19698
19699 .option owners redirect "string list" unset
19700 .cindex "ownership" "alias file"
19701 .cindex "ownership" "forward file"
19702 .cindex "alias file" "ownership"
19703 .cindex "forward file" "ownership"
19704 This specifies a list of permitted owners for the file specified by &%file%&.
19705 This list is in addition to the local user when &%check_local_user%& is set.
19706 See &%check_owner%& above.
19707
19708
19709 .option owngroups redirect "string list" unset
19710 This specifies a list of permitted groups for the file specified by &%file%&.
19711 The list is in addition to the local user's primary group when
19712 &%check_local_user%& is set. See &%check_group%& above.
19713
19714
19715 .option pipe_transport redirect string&!! unset
19716 .vindex "&$address_pipe$&"
19717 A &(redirect)& router sets up a direct delivery to a pipe when a string
19718 starting with a vertical bar character is specified as a new &"address"&. The
19719 transport used is specified by this option, which, after expansion, must be the
19720 name of a configured transport. This should normally be a &(pipe)& transport.
19721 When the transport is run, the pipe command is in &$address_pipe$&.
19722
19723
19724 .option qualify_domain redirect string&!! unset
19725 .vindex "&$qualify_recipient$&"
19726 If this option is set, and an unqualified address (one without a domain) is
19727 generated, and that address would normally be qualified by the global setting
19728 in &%qualify_recipient%&, it is instead qualified with the domain specified by
19729 expanding this string. If the expansion fails, the router declines. If you want
19730 to revert to the default, you can have the expansion generate
19731 &$qualify_recipient$&.
19732
19733 This option applies to all unqualified addresses generated by Exim filters,
19734 but for traditional &_.forward_& files, it applies only to addresses that are
19735 not preceded by a backslash. Sieve filters cannot generate unqualified
19736 addresses.
19737
19738 .option qualify_preserve_domain redirect boolean false
19739 .cindex "domain" "in redirection; preserving"
19740 .cindex "preserving domain in redirection"
19741 .cindex "address redirection" "domain; preserving"
19742 If this option is set, the router's local &%qualify_domain%& option must not be
19743 set (a configuration error occurs if it is). If an unqualified address (one
19744 without a domain) is generated, it is qualified with the domain of the parent
19745 address (the immediately preceding ancestor) instead of the global
19746 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
19747 this applies whether or not the address is preceded by a backslash.
19748
19749
19750 .option repeat_use redirect boolean true
19751 If this option is set false, the router is skipped for a child address that has
19752 any ancestor that was routed by this router. This test happens before any of
19753 the other preconditions are tested. Exim's default anti-looping rules skip
19754 only when the ancestor is the same as the current address. See also
19755 &%check_ancestor%& above and the generic &%redirect_router%& option.
19756
19757
19758 .option reply_transport redirect string&!! unset
19759 A &(redirect)& router sets up an automatic reply when a &%mail%& or
19760 &%vacation%& command is used in a filter file. The transport used is specified
19761 by this option, which, after expansion, must be the name of a configured
19762 transport. This should normally be an &(autoreply)& transport. Other transports
19763 are unlikely to do anything sensible or useful.
19764
19765
19766 .option rewrite redirect boolean true
19767 .cindex "address redirection" "disabling rewriting"
19768 If this option is set false, addresses generated by the router are not
19769 subject to address rewriting. Otherwise, they are treated like new addresses
19770 and are rewritten according to the global rewriting rules.
19771
19772
19773 .option sieve_subaddress redirect string&!! unset
19774 The value of this option is passed to a Sieve filter to specify the
19775 :subaddress part of an address.
19776
19777 .option sieve_useraddress redirect string&!! unset
19778 The value of this option is passed to a Sieve filter to specify the :user part
19779 of an address. However, if it is unset, the entire original local part
19780 (including any prefix or suffix) is used for :user.
19781
19782
19783 .option sieve_vacation_directory redirect string&!! unset
19784 .cindex "Sieve filter" "vacation directory"
19785 To enable the &"vacation"& extension for Sieve filters, you must set
19786 &%sieve_vacation_directory%& to the directory where vacation databases are held
19787 (do not put anything else in that directory), and ensure that the
19788 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
19789 needs their own directory; Exim will create it if necessary.
19790
19791
19792
19793 .option skip_syntax_errors redirect boolean false
19794 .cindex "forward file" "broken"
19795 .cindex "address redirection" "broken files"
19796 .cindex "alias file" "broken"
19797 .cindex "broken alias or forward files"
19798 .cindex "ignoring faulty addresses"
19799 .cindex "skipping faulty addresses"
19800 .cindex "error" "skipping bad syntax"
19801 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
19802 non-filter redirection data are skipped, and each failing address is logged. If
19803 &%syntax_errors_to%& is set, a message is sent to the address it defines,
19804 giving details of the failures. If &%syntax_errors_text%& is set, its contents
19805 are expanded and placed at the head of the error message generated by
19806 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
19807 be the same address as the generic &%errors_to%& option. The
19808 &%skip_syntax_errors%& option is often used when handling mailing lists.
19809
19810 If all the addresses in a redirection list are skipped because of syntax
19811 errors, the router declines to handle the original address, and it is passed to
19812 the following routers.
19813
19814 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
19815 error in the filter causes filtering to be abandoned without any action being
19816 taken. The incident is logged, and the router declines to handle the address,
19817 so it is passed to the following routers.
19818
19819 .cindex "Sieve filter" "syntax errors in"
19820 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
19821 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
19822 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
19823
19824 &%skip_syntax_errors%& can be used to specify that errors in users' forward
19825 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
19826 option, used with an address that does not get redirected, can be used to
19827 notify users of these errors, by means of a router like this:
19828 .code
19829 userforward:
19830   driver = redirect
19831   allow_filter
19832   check_local_user
19833   file = $home/.forward
19834   file_transport = address_file
19835   pipe_transport = address_pipe
19836   reply_transport = address_reply
19837   no_verify
19838   skip_syntax_errors
19839   syntax_errors_to = real-$local_part@$domain
19840   syntax_errors_text = \
19841    This is an automatically generated message. An error has\n\
19842    been found in your .forward file. Details of the error are\n\
19843    reported below. While this error persists, you will receive\n\
19844    a copy of this message for every message that is addressed\n\
19845    to you. If your .forward file is a filter file, or if it is\n\
19846    a non-filter file containing no valid forwarding addresses,\n\
19847    a copy of each incoming message will be put in your normal\n\
19848    mailbox. If a non-filter file contains at least one valid\n\
19849    forwarding address, forwarding to the valid addresses will\n\
19850    happen, and those will be the only deliveries that occur.
19851 .endd
19852 You also need a router to ensure that local addresses that are prefixed by
19853 &`real-`& are recognized, but not forwarded or filtered. For example, you could
19854 put this immediately before the &(userforward)& router:
19855 .code
19856 real_localuser:
19857   driver = accept
19858   check_local_user
19859   local_part_prefix = real-
19860   transport = local_delivery
19861 .endd
19862 For security, it would probably be a good idea to restrict the use of this
19863 router to locally-generated messages, using a condition such as this:
19864 .code
19865   condition = ${if match {$sender_host_address}\
19866                          {\N^(|127\.0\.0\.1)$\N}}
19867 .endd
19868
19869
19870 .option syntax_errors_text redirect string&!! unset
19871 See &%skip_syntax_errors%& above.
19872
19873
19874 .option syntax_errors_to redirect string unset
19875 See &%skip_syntax_errors%& above.
19876 .ecindex IIDredrou1
19877 .ecindex IIDredrou2
19878
19879
19880
19881
19882
19883
19884 . ////////////////////////////////////////////////////////////////////////////
19885 . ////////////////////////////////////////////////////////////////////////////
19886
19887 .chapter "Environment for running local transports" "CHAPenvironment" &&&
19888          "Environment for local transports"
19889 .scindex IIDenvlotra1 "local transports" "environment for"
19890 .scindex IIDenvlotra2 "environment for local transports"
19891 .scindex IIDenvlotra3 "transport" "local; environment for"
19892 Local transports handle deliveries to files and pipes. (The &(autoreply)&
19893 transport can be thought of as similar to a pipe.) Exim always runs transports
19894 in subprocesses, under specified uids and gids. Typical deliveries to local
19895 mailboxes run under the uid and gid of the local user.
19896
19897 Exim also sets a specific current directory while running the transport; for
19898 some transports a home directory setting is also relevant. The &(pipe)&
19899 transport is the only one that sets up environment variables; see section
19900 &<<SECTpipeenv>>& for details.
19901
19902 The values used for the uid, gid, and the directories may come from several
19903 different places. In many cases, the router that handles the address associates
19904 settings with that address as a result of its &%check_local_user%&, &%group%&,
19905 or &%user%& options. However, values may also be given in the transport's own
19906 configuration, and these override anything that comes from the router.
19907
19908
19909
19910 .section "Concurrent deliveries" "SECID131"
19911 .cindex "concurrent deliveries"
19912 .cindex "simultaneous deliveries"
19913 If two different messages for the same local recipient arrive more or less
19914 simultaneously, the two delivery processes are likely to run concurrently. When
19915 the &(appendfile)& transport is used to write to a file, Exim applies locking
19916 rules to stop concurrent processes from writing to the same file at the same
19917 time.
19918
19919 However, when you use a &(pipe)& transport, it is up to you to arrange any
19920 locking that is needed. Here is a silly example:
19921 .code
19922 my_transport:
19923   driver = pipe
19924   command = /bin/sh -c 'cat >>/some/file'
19925 .endd
19926 This is supposed to write the message at the end of the file. However, if two
19927 messages arrive at the same time, the file will be scrambled. You can use the
19928 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
19929 file using the same algorithm that Exim itself uses.
19930
19931
19932
19933
19934 .section "Uids and gids" "SECTenvuidgid"
19935 .cindex "local transports" "uid and gid"
19936 .cindex "transport" "local; uid and gid"
19937 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
19938 overrides any group that the router set in the address, even if &%user%& is not
19939 set for the transport. This makes it possible, for example, to run local mail
19940 delivery under the uid of the recipient (set by the router), but in a special
19941 group (set by the transport). For example:
19942 .code
19943 # Routers ...
19944 # User/group are set by check_local_user in this router
19945 local_users:
19946   driver = accept
19947   check_local_user
19948   transport = group_delivery
19949
19950 # Transports ...
19951 # This transport overrides the group
19952 group_delivery:
19953   driver = appendfile
19954   file = /var/spool/mail/$local_part
19955   group = mail
19956 .endd
19957 If &%user%& is set for a transport, its value overrides what is set in the
19958 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
19959 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
19960 set.
19961
19962 .oindex "&%initgroups%&"
19963 When the uid is taken from the transport's configuration, the &[initgroups()]&
19964 function is called for the groups associated with that uid if the
19965 &%initgroups%& option is set for the transport. When the uid is not specified
19966 by the transport, but is associated with the address by a router, the option
19967 for calling &[initgroups()]& is taken from the router configuration.
19968
19969 .cindex "&(pipe)& transport" "uid for"
19970 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
19971 is set and &%user%& is not set, the uid of the process that called Exim to
19972 receive the message is used, and if &%group%& is not set, the corresponding
19973 original gid is also used.
19974
19975 This is the detailed preference order for obtaining a gid; the first of the
19976 following that is set is used:
19977
19978 .ilist
19979 A &%group%& setting of the transport;
19980 .next
19981 A &%group%& setting of the router;
19982 .next
19983 A gid associated with a user setting of the router, either as a result of
19984 &%check_local_user%& or an explicit non-numeric &%user%& setting;
19985 .next
19986 The group associated with a non-numeric &%user%& setting of the transport;
19987 .next
19988 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
19989 the uid is the creator's uid;
19990 .next
19991 The Exim gid if the Exim uid is being used as a default.
19992 .endlist
19993
19994 If, for example, the user is specified numerically on the router and there are
19995 no group settings, no gid is available. In this situation, an error occurs.
19996 This is different for the uid, for which there always is an ultimate default.
19997 The first of the following that is set is used:
19998
19999 .ilist
20000 A &%user%& setting of the transport;
20001 .next
20002 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
20003 .next
20004 A &%user%& setting of the router;
20005 .next
20006 A &%check_local_user%& setting of the router;
20007 .next
20008 The Exim uid.
20009 .endlist
20010
20011 Of course, an error will still occur if the uid that is chosen is on the
20012 &%never_users%& list.
20013
20014
20015
20016
20017
20018 .section "Current and home directories" "SECID132"
20019 .cindex "current directory for local transport"
20020 .cindex "home directory" "for local transport"
20021 .cindex "transport" "local; home directory for"
20022 .cindex "transport" "local; current directory for"
20023 Routers may set current and home directories for local transports by means of
20024 the &%transport_current_directory%& and &%transport_home_directory%& options.
20025 However, if the transport's &%current_directory%& or &%home_directory%& options
20026 are set, they override the router's values. In detail, the home directory
20027 for a local transport is taken from the first of these values that is set:
20028
20029 .ilist
20030 The &%home_directory%& option on the transport;
20031 .next
20032 The &%transport_home_directory%& option on the router;
20033 .next
20034 The password data if &%check_local_user%& is set on the router;
20035 .next
20036 The &%router_home_directory%& option on the router.
20037 .endlist
20038
20039 The current directory is taken from the first of these values that is set:
20040
20041 .ilist
20042 The &%current_directory%& option on the transport;
20043 .next
20044 The &%transport_current_directory%& option on the router.
20045 .endlist
20046
20047
20048 If neither the router nor the transport sets a current directory, Exim uses the
20049 value of the home directory, if it is set. Otherwise it sets the current
20050 directory to &_/_& before running a local transport.
20051
20052
20053
20054 .section "Expansion variables derived from the address" "SECID133"
20055 .vindex "&$domain$&"
20056 .vindex "&$local_part$&"
20057 .vindex "&$original_domain$&"
20058 Normally a local delivery is handling a single address, and in that case the
20059 variables such as &$domain$& and &$local_part$& are set during local
20060 deliveries. However, in some circumstances more than one address may be handled
20061 at once (for example, while writing batch SMTP for onward transmission by some
20062 other means). In this case, the variables associated with the local part are
20063 never set, &$domain$& is set only if all the addresses have the same domain,
20064 and &$original_domain$& is never set.
20065 .ecindex IIDenvlotra1
20066 .ecindex IIDenvlotra2
20067 .ecindex IIDenvlotra3
20068
20069
20070
20071
20072
20073
20074
20075 . ////////////////////////////////////////////////////////////////////////////
20076 . ////////////////////////////////////////////////////////////////////////////
20077
20078 .chapter "Generic options for transports" "CHAPtransportgeneric"
20079 .scindex IIDgenoptra1 "generic options" "transport"
20080 .scindex IIDgenoptra2 "options" "generic; for transports"
20081 .scindex IIDgenoptra3 "transport" "generic options for"
20082 The following generic options apply to all transports:
20083
20084
20085 .option body_only transports boolean false
20086 .cindex "transport" "body only"
20087 .cindex "message" "transporting body only"
20088 .cindex "body of message" "transporting"
20089 If this option is set, the message's headers are not transported. It is
20090 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
20091 or &(pipe)& transports, the settings of &%message_prefix%& and
20092 &%message_suffix%& should be checked, because this option does not
20093 automatically suppress them.
20094
20095
20096 .option current_directory transports string&!! unset
20097 .cindex "transport" "current directory for"
20098 This specifies the current directory that is to be set while running the
20099 transport, overriding any value that may have been set by the router.
20100 If the expansion fails for any reason, including forced failure, an error is
20101 logged, and delivery is deferred.
20102
20103
20104 .option disable_logging transports boolean false
20105 If this option is set true, nothing is logged for any
20106 deliveries by the transport or for any
20107 transport errors. You should not set this option unless you really, really know
20108 what you are doing.
20109
20110
20111 .option debug_print transports string&!! unset
20112 .cindex "testing" "variables in drivers"
20113 If this option is set and debugging is enabled (see the &%-d%& command line
20114 option), the string is expanded and included in the debugging output when the
20115 transport is run.
20116 If expansion of the string fails, the error message is written to the debugging
20117 output, and Exim carries on processing.
20118 This facility is provided to help with checking out the values of variables and
20119 so on when debugging driver configurations. For example, if a &%headers_add%&
20120 option is not working properly, &%debug_print%& could be used to output the
20121 variables it references. A newline is added to the text if it does not end with
20122 one.
20123 The variables &$transport_name$& and &$router_name$& contain the name of the
20124 transport and the router that called it.
20125
20126 .option delivery_date_add transports boolean false
20127 .cindex "&'Delivery-date:'& header line"
20128 If this option is true, a &'Delivery-date:'& header is added to the message.
20129 This gives the actual time the delivery was made. As this is not a standard
20130 header, Exim has a configuration option (&%delivery_date_remove%&) which
20131 requests its removal from incoming messages, so that delivered messages can
20132 safely be resent to other recipients.
20133
20134
20135 .option driver transports string unset
20136 This specifies which of the available transport drivers is to be used.
20137 There is no default, and this option must be set for every transport.
20138
20139
20140 .option envelope_to_add transports boolean false
20141 .cindex "&'Envelope-to:'& header line"
20142 If this option is true, an &'Envelope-to:'& header is added to the message.
20143 This gives the original address(es) in the incoming envelope that caused this
20144 delivery to happen. More than one address may be present if the transport is
20145 configured to handle several addresses at once, or if more than one original
20146 address was redirected to the same final address. As this is not a standard
20147 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
20148 its removal from incoming messages, so that delivered messages can safely be
20149 resent to other recipients.
20150
20151
20152 .option group transports string&!! "Exim group"
20153 .cindex "transport" "group; specifying"
20154 This option specifies a gid for running the transport process, overriding any
20155 value that the router supplies, and also overriding any value associated with
20156 &%user%& (see below).
20157
20158
20159 .option headers_add transports list&!! unset
20160 .cindex "header lines" "adding in transport"
20161 .cindex "transport" "header lines; adding"
20162 This option specifies a list of text headers, newline-separated,
20163 which are (separately) expanded and added to the header
20164 portion of a message as it is transported, as described in section
20165 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
20166 routers. If the result of the expansion is an empty string, or if the expansion
20167 is forced to fail, no action is taken. Other expansion failures are treated as
20168 errors and cause the delivery to be deferred.
20169
20170 Unlike most options, &%headers_add%& can be specified multiple times
20171 for a transport; all listed headers are added.
20172
20173
20174 .option headers_only transports boolean false
20175 .cindex "transport" "header lines only"
20176 .cindex "message" "transporting headers only"
20177 .cindex "header lines" "transporting"
20178 If this option is set, the message's body is not transported. It is mutually
20179 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
20180 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
20181 checked, since this option does not automatically suppress them.
20182
20183
20184 .option headers_remove transports list&!! unset
20185 .cindex "header lines" "removing"
20186 .cindex "transport" "header lines; removing"
20187 This option specifies a list of header names, colon-separated;
20188 these headers are omitted from the message as it is transported, as described
20189 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
20190 routers.
20191 Each list item is separately expanded.
20192 If the result of the expansion is an empty string, or if the expansion
20193 is forced to fail, no action is taken. Other expansion failures are treated as
20194 errors and cause the delivery to be deferred.
20195
20196 Unlike most options, &%headers_remove%& can be specified multiple times
20197 for a router; all listed headers are removed.
20198
20199
20200
20201 .option headers_rewrite transports string unset
20202 .cindex "transport" "header lines; rewriting"
20203 .cindex "rewriting" "at transport time"
20204 This option allows addresses in header lines to be rewritten at transport time,
20205 that is, as the message is being copied to its destination. The contents of the
20206 option are a colon-separated list of rewriting rules. Each rule is in exactly
20207 the same form as one of the general rewriting rules that are applied when a
20208 message is received. These are described in chapter &<<CHAPrewrite>>&. For
20209 example,
20210 .code
20211 headers_rewrite = a@b c@d f : \
20212                   x@y w@z
20213 .endd
20214 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
20215 &'w@z'& in all address-bearing header lines. The rules are applied to the
20216 header lines just before they are written out at transport time, so they affect
20217 only those copies of the message that pass through the transport. However, only
20218 the message's original header lines, and any that were added by a system
20219 filter, are rewritten. If a router or transport adds header lines, they are not
20220 affected by this option. These rewriting rules are &'not'& applied to the
20221 envelope. You can change the return path using &%return_path%&, but you cannot
20222 change envelope recipients at this time.
20223
20224
20225 .option home_directory transports string&!! unset
20226 .cindex "transport" "home directory for"
20227 .vindex "&$home$&"
20228 This option specifies a home directory setting for a local transport,
20229 overriding any value that may be set by the router. The home directory is
20230 placed in &$home$& while expanding the transport's private options. It is also
20231 used as the current directory if no current directory is set by the
20232 &%current_directory%& option on the transport or the
20233 &%transport_current_directory%& option on the router. If the expansion fails
20234 for any reason, including forced failure, an error is logged, and delivery is
20235 deferred.
20236
20237
20238 .option initgroups transports boolean false
20239 .cindex "additional groups"
20240 .cindex "groups" "additional"
20241 .cindex "transport" "group; additional"
20242 If this option is true and the uid for the delivery process is provided by the
20243 transport, the &[initgroups()]& function is called when running the transport
20244 to ensure that any additional groups associated with the uid are set up.
20245
20246
20247 .option message_size_limit transports string&!! 0
20248 .cindex "limit" "message size per transport"
20249 .cindex "size" "of message, limit"
20250 .cindex "transport" "message size; limiting"
20251 This option controls the size of messages passed through the transport. It is
20252 expanded before use; the result of the expansion must be a sequence of decimal
20253 digits, optionally followed by K or M. If the expansion fails for any reason,
20254 including forced failure, or if the result is not of the required form,
20255 delivery is deferred. If the value is greater than zero and the size of a
20256 message exceeds this limit, the address is failed. If there is any chance that
20257 the resulting bounce message could be routed to the same transport, you should
20258 ensure that &%return_size_limit%& is less than the transport's
20259 &%message_size_limit%&, as otherwise the bounce message will fail to get
20260 delivered.
20261
20262
20263
20264 .option rcpt_include_affixes transports boolean false
20265 .cindex "prefix" "for local part, including in envelope"
20266 .cindex "suffix for local part" "including in envelope"
20267 .cindex "local part" "prefix"
20268 .cindex "local part" "suffix"
20269 When this option is false (the default), and an address that has had any
20270 affixes (prefixes or suffixes) removed from the local part is delivered by any
20271 form of SMTP or LMTP, the affixes are not included. For example, if a router
20272 that contains
20273 .code
20274 local_part_prefix = *-
20275 .endd
20276 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
20277 is delivered with
20278 .code
20279 RCPT TO:<xyz@some.domain>
20280 .endd
20281 This is also the case when an ACL-time callout is being used to verify a
20282 recipient address. However, if &%rcpt_include_affixes%& is set true, the
20283 whole local part is included in the RCPT command. This option applies to BSMTP
20284 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
20285 &(lmtp)& and &(smtp)& transports.
20286
20287
20288 .option retry_use_local_part transports boolean "see below"
20289 .cindex "hints database" "retry keys"
20290 When a delivery suffers a temporary failure, a retry record is created
20291 in Exim's hints database. For remote deliveries, the key for the retry record
20292 is based on the name and/or IP address of the failing remote host. For local
20293 deliveries, the key is normally the entire address, including both the local
20294 part and the domain. This is suitable for most common cases of local delivery
20295 temporary failure &-- for example, exceeding a mailbox quota should delay only
20296 deliveries to that mailbox, not to the whole domain.
20297
20298 However, in some special cases you may want to treat a temporary local delivery
20299 as a failure associated with the domain, and not with a particular local part.
20300 (For example, if you are storing all mail for some domain in files.) You can do
20301 this by setting &%retry_use_local_part%& false.
20302
20303 For all the local transports, its default value is true. For remote transports,
20304 the default value is false for tidiness, but changing the value has no effect
20305 on a remote transport in the current implementation.
20306
20307
20308 .option return_path transports string&!! unset
20309 .cindex "envelope sender"
20310 .cindex "transport" "return path; changing"
20311 .cindex "return path" "changing in transport"
20312 If this option is set, the string is expanded at transport time and replaces
20313 the existing return path (envelope sender) value in the copy of the message
20314 that is being delivered. An empty return path is permitted. This feature is
20315 designed for remote deliveries, where the value of this option is used in the
20316 SMTP MAIL command. If you set &%return_path%& for a local transport, the
20317 only effect is to change the address that is placed in the &'Return-path:'&
20318 header line, if one is added to the message (see the next option).
20319
20320 &*Note:*& A changed return path is not logged unless you add
20321 &%return_path_on_delivery%& to the log selector.
20322
20323 .vindex "&$return_path$&"
20324 The expansion can refer to the existing value via &$return_path$&. This is
20325 either the message's envelope sender, or an address set by the
20326 &%errors_to%& option on a router. If the expansion is forced to fail, no
20327 replacement occurs; if it fails for another reason, delivery is deferred. This
20328 option can be used to support VERP (Variable Envelope Return Paths) &-- see
20329 section &<<SECTverp>>&.
20330
20331 &*Note*&: If a delivery error is detected locally, including the case when a
20332 remote server rejects a message at SMTP time, the bounce message is not sent to
20333 the value of this option. It is sent to the previously set errors address.
20334 This defaults to the incoming sender address, but can be changed by setting
20335 &%errors_to%& in a router.
20336
20337
20338
20339 .option return_path_add transports boolean false
20340 .cindex "&'Return-path:'& header line"
20341 If this option is true, a &'Return-path:'& header is added to the message.
20342 Although the return path is normally available in the prefix line of BSD
20343 mailboxes, this is commonly not displayed by MUAs, and so the user does not
20344 have easy access to it.
20345
20346 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
20347 the delivery SMTP server makes the final delivery"&. This implies that this
20348 header should not be present in incoming messages. Exim has a configuration
20349 option, &%return_path_remove%&, which requests removal of this header from
20350 incoming messages, so that delivered messages can safely be resent to other
20351 recipients.
20352
20353
20354 .option shadow_condition transports string&!! unset
20355 See &%shadow_transport%& below.
20356
20357
20358 .option shadow_transport transports string unset
20359 .cindex "shadow transport"
20360 .cindex "transport" "shadow"
20361 A local transport may set the &%shadow_transport%& option to the name of
20362 another local transport. Shadow remote transports are not supported.
20363
20364 Whenever a delivery to the main transport succeeds, and either
20365 &%shadow_condition%& is unset, or its expansion does not result in the empty
20366 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
20367 passed to the shadow transport, with the same delivery address or addresses. If
20368 expansion fails, no action is taken except that non-forced expansion failures
20369 cause a log line to be written.
20370
20371 The result of the shadow transport is discarded and does not affect the
20372 subsequent processing of the message. Only a single level of shadowing is
20373 provided; the &%shadow_transport%& option is ignored on any transport when it
20374 is running as a shadow. Options concerned with output from pipes are also
20375 ignored. The log line for the successful delivery has an item added on the end,
20376 of the form
20377 .code
20378 ST=<shadow transport name>
20379 .endd
20380 If the shadow transport did not succeed, the error message is put in
20381 parentheses afterwards. Shadow transports can be used for a number of different
20382 purposes, including keeping more detailed log information than Exim normally
20383 provides, and implementing automatic acknowledgment policies based on message
20384 headers that some sites insist on.
20385
20386
20387 .option transport_filter transports string&!! unset
20388 .cindex "transport" "filter"
20389 .cindex "filter" "transport filter"
20390 This option sets up a filtering (in the Unix shell sense) process for messages
20391 at transport time. It should not be confused with mail filtering as set up by
20392 individual users or via a system filter.
20393
20394 When the message is about to be written out, the command specified by
20395 &%transport_filter%& is started up in a separate, parallel process, and
20396 the entire message, including the header lines, is passed to it on its standard
20397 input (this in fact is done from a third process, to avoid deadlock). The
20398 command must be specified as an absolute path.
20399
20400 The lines of the message that are written to the transport filter are
20401 terminated by newline (&"\n"&). The message is passed to the filter before any
20402 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
20403 lines beginning with a dot, and also before any processing implied by the
20404 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
20405 &(pipe)& transports.
20406
20407 The standard error for the filter process is set to the same destination as its
20408 standard output; this is read and written to the message's ultimate
20409 destination. The process that writes the message to the filter, the
20410 filter itself, and the original process that reads the result and delivers it
20411 are all run in parallel, like a shell pipeline.
20412
20413 The filter can perform any transformations it likes, but of course should take
20414 care not to break RFC 2822 syntax. Exim does not check the result, except to
20415 test for a final newline when SMTP is in use. All messages transmitted over
20416 SMTP must end with a newline, so Exim supplies one if it is missing.
20417
20418 .cindex "content scanning" "per user"
20419 A transport filter can be used to provide content-scanning on a per-user basis
20420 at delivery time if the only required effect of the scan is to modify the
20421 message. For example, a content scan could insert a new header line containing
20422 a spam score. This could be interpreted by a filter in the user's MUA. It is
20423 not possible to discard a message at this stage.
20424
20425 .cindex "SMTP" "SIZE"
20426 A problem might arise if the filter increases the size of a message that is
20427 being sent down an SMTP connection. If the receiving SMTP server has indicated
20428 support for the SIZE parameter, Exim will have sent the size of the message
20429 at the start of the SMTP session. If what is actually sent is substantially
20430 more, the server might reject the message. This can be worked round by setting
20431 the &%size_addition%& option on the &(smtp)& transport, either to allow for
20432 additions to the message, or to disable the use of SIZE altogether.
20433
20434 .vindex "&$pipe_addresses$&"
20435 The value of the &%transport_filter%& option is the command string for starting
20436 the filter, which is run directly from Exim, not under a shell. The string is
20437 parsed by Exim in the same way as a command string for the &(pipe)& transport:
20438 Exim breaks it up into arguments and then expands each argument separately (see
20439 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
20440 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
20441 of arguments, one for each address that applies to this delivery. (This isn't
20442 an ideal name for this feature here, but as it was already implemented for the
20443 &(pipe)& transport, it seemed sensible not to change it.)
20444
20445 .vindex "&$host$&"
20446 .vindex "&$host_address$&"
20447 The expansion variables &$host$& and &$host_address$& are available when the
20448 transport is a remote one. They contain the name and IP address of the host to
20449 which the message is being sent. For example:
20450 .code
20451 transport_filter = /some/directory/transport-filter.pl \
20452   $host $host_address $sender_address $pipe_addresses
20453 .endd
20454
20455 Two problems arise if you want to use more complicated expansion items to
20456 generate transport filter commands, both of which due to the fact that the
20457 command is split up &'before'& expansion.
20458 .ilist
20459 If an expansion item contains white space, you must quote it, so that it is all
20460 part of the same command item. If the entire option setting is one such
20461 expansion item, you have to take care what kind of quoting you use. For
20462 example:
20463 .code
20464 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
20465 .endd
20466 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
20467 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
20468 stripped by Exim when it read the option's value. When the value is used, if
20469 the single quotes were missing, the line would be split into two items,
20470 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
20471 Exim tried to expand the first one.
20472 .next
20473 Except for the special case of &$pipe_addresses$& that is mentioned above, an
20474 expansion cannot generate multiple arguments, or a command name followed by
20475 arguments. Consider this example:
20476 .code
20477 transport_filter = ${lookup{$host}lsearch{/a/file}\
20478                     {$value}{/bin/cat}}
20479 .endd
20480 The result of the lookup is interpreted as the name of the command, even
20481 if it contains white space. The simplest way round this is to use a shell:
20482 .code
20483 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
20484                                {$value}{/bin/cat}}
20485 .endd
20486 .endlist
20487
20488 The filter process is run under the same uid and gid as the normal delivery.
20489 For remote deliveries this is the Exim uid/gid by default. The command should
20490 normally yield a zero return code. Transport filters are not supposed to fail.
20491 A non-zero code is taken to mean that the transport filter encountered some
20492 serious problem. Delivery of the message is deferred; the message remains on
20493 the queue and is tried again later. It is not possible to cause a message to be
20494 bounced from a transport filter.
20495
20496 If a transport filter is set on an autoreply transport, the original message is
20497 passed through the filter as it is being copied into the newly generated
20498 message, which happens if the &%return_message%& option is set.
20499
20500
20501 .option transport_filter_timeout transports time 5m
20502 .cindex "transport" "filter, timeout"
20503 When Exim is reading the output of a transport filter, it applies a timeout
20504 that can be set by this option. Exceeding the timeout is normally treated as a
20505 temporary delivery failure. However, if a transport filter is used with a
20506 &(pipe)& transport, a timeout in the transport filter is treated in the same
20507 way as a timeout in the pipe command itself. By default, a timeout is a hard
20508 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
20509 becomes a temporary error.
20510
20511
20512 .option user transports string&!! "Exim user"
20513 .cindex "uid (user id)" "local delivery"
20514 .cindex "transport" "user, specifying"
20515 This option specifies the user under whose uid the delivery process is to be
20516 run, overriding any uid that may have been set by the router. If the user is
20517 given as a name, the uid is looked up from the password data, and the
20518 associated group is taken as the value of the gid to be used if the &%group%&
20519 option is not set.
20520
20521 For deliveries that use local transports, a user and group are normally
20522 specified explicitly or implicitly (for example, as a result of
20523 &%check_local_user%&) by the router or transport.
20524
20525 .cindex "hints database" "access by remote transport"
20526 For remote transports, you should leave this option unset unless you really are
20527 sure you know what you are doing. When a remote transport is running, it needs
20528 to be able to access Exim's hints databases, because each host may have its own
20529 retry data.
20530 .ecindex IIDgenoptra1
20531 .ecindex IIDgenoptra2
20532 .ecindex IIDgenoptra3
20533
20534
20535
20536
20537
20538
20539 . ////////////////////////////////////////////////////////////////////////////
20540 . ////////////////////////////////////////////////////////////////////////////
20541
20542 .chapter "Address batching in local transports" "CHAPbatching" &&&
20543          "Address batching"
20544 .cindex "transport" "local; address batching in"
20545 The only remote transport (&(smtp)&) is normally configured to handle more than
20546 one address at a time, so that when several addresses are routed to the same
20547 remote host, just one copy of the message is sent. Local transports, however,
20548 normally handle one address at a time. That is, a separate instance of the
20549 transport is run for each address that is routed to the transport. A separate
20550 copy of the message is delivered each time.
20551
20552 .cindex "batched local delivery"
20553 .oindex "&%batch_max%&"
20554 .oindex "&%batch_id%&"
20555 In special cases, it may be desirable to handle several addresses at once in a
20556 local transport, for example:
20557
20558 .ilist
20559 In an &(appendfile)& transport, when storing messages in files for later
20560 delivery by some other means, a single copy of the message with multiple
20561 recipients saves space.
20562 .next
20563 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
20564 a single copy saves time, and is the normal way LMTP is expected to work.
20565 .next
20566 In a &(pipe)& transport, when passing the message
20567 to a scanner program or
20568 to some other delivery mechanism such as UUCP, multiple recipients may be
20569 acceptable.
20570 .endlist
20571
20572 These three local transports all have the same options for controlling multiple
20573 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
20574 repeating the information for each transport, these options are described here.
20575
20576 The &%batch_max%& option specifies the maximum number of addresses that can be
20577 delivered together in a single run of the transport. Its default value is one
20578 (no batching). When more than one address is routed to a transport that has a
20579 &%batch_max%& value greater than one, the addresses are delivered in a batch
20580 (that is, in a single run of the transport with multiple recipients), subject
20581 to certain conditions:
20582
20583 .ilist
20584 .vindex "&$local_part$&"
20585 If any of the transport's options contain a reference to &$local_part$&, no
20586 batching is possible.
20587 .next
20588 .vindex "&$domain$&"
20589 If any of the transport's options contain a reference to &$domain$&, only
20590 addresses with the same domain are batched.
20591 .next
20592 .cindex "customizing" "batching condition"
20593 If &%batch_id%& is set, it is expanded for each address, and only those
20594 addresses with the same expanded value are batched. This allows you to specify
20595 customized batching conditions. Failure of the expansion for any reason,
20596 including forced failure, disables batching, but it does not stop the delivery
20597 from taking place.
20598 .next
20599 Batched addresses must also have the same errors address (where to send
20600 delivery errors), the same header additions and removals, the same user and
20601 group for the transport, and if a host list is present, the first host must
20602 be the same.
20603 .endlist
20604
20605 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
20606 both when the file or pipe command is specified in the transport, and when it
20607 is specified by a &(redirect)& router, but all the batched addresses must of
20608 course be routed to the same file or pipe command. These two transports have an
20609 option called &%use_bsmtp%&, which causes them to deliver the message in
20610 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
20611 &%check_string%& and &%escape_string%& options are forced to the values
20612 .code
20613 check_string = "."
20614 escape_string = ".."
20615 .endd
20616 when batched SMTP is in use. A full description of the batch SMTP mechanism is
20617 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
20618 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
20619
20620 .cindex "&'Envelope-to:'& header line"
20621 If the generic &%envelope_to_add%& option is set for a batching transport, the
20622 &'Envelope-to:'& header that is added to the message contains all the addresses
20623 that are being processed together. If you are using a batching &(appendfile)&
20624 transport without &%use_bsmtp%&, the only way to preserve the recipient
20625 addresses is to set the &%envelope_to_add%& option.
20626
20627 .cindex "&(pipe)& transport" "with multiple addresses"
20628 .vindex "&$pipe_addresses$&"
20629 If you are using a &(pipe)& transport without BSMTP, and setting the
20630 transport's &%command%& option, you can include &$pipe_addresses$& as part of
20631 the command. This is not a true variable; it is a bit of magic that causes each
20632 of the recipient addresses to be inserted into the command as a separate
20633 argument. This provides a way of accessing all the addresses that are being
20634 delivered in the batch. &*Note:*& This is not possible for pipe commands that
20635 are specified by a &(redirect)& router.
20636
20637
20638
20639
20640 . ////////////////////////////////////////////////////////////////////////////
20641 . ////////////////////////////////////////////////////////////////////////////
20642
20643 .chapter "The appendfile transport" "CHAPappendfile"
20644 .scindex IIDapptra1 "&(appendfile)& transport"
20645 .scindex IIDapptra2 "transports" "&(appendfile)&"
20646 .cindex "directory creation"
20647 .cindex "creating directories"
20648 The &(appendfile)& transport delivers a message by appending it to an existing
20649 file, or by creating an entirely new file in a specified directory. Single
20650 files to which messages are appended can be in the traditional Unix mailbox
20651 format, or optionally in the MBX format supported by the Pine MUA and
20652 University of Washington IMAP daemon, &'inter alia'&. When each message is
20653 being delivered as a separate file, &"maildir"& format can optionally be used
20654 to give added protection against failures that happen part-way through the
20655 delivery. A third form of separate-file delivery known as &"mailstore"& is also
20656 supported. For all file formats, Exim attempts to create as many levels of
20657 directory as necessary, provided that &%create_directory%& is set.
20658
20659 The code for the optional formats is not included in the Exim binary by
20660 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
20661 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
20662 included.
20663
20664 .cindex "quota" "system"
20665 Exim recognizes system quota errors, and generates an appropriate message. Exim
20666 also supports its own quota control within the transport, for use when the
20667 system facility is unavailable or cannot be used for some reason.
20668
20669 If there is an error while appending to a file (for example, quota exceeded or
20670 partition filled), Exim attempts to reset the file's length and last
20671 modification time back to what they were before. If there is an error while
20672 creating an entirely new file, the new file is removed.
20673
20674 Before appending to a file, a number of security checks are made, and the
20675 file is locked. A detailed description is given below, after the list of
20676 private options.
20677
20678 The &(appendfile)& transport is most commonly used for local deliveries to
20679 users' mailboxes. However, it can also be used as a pseudo-remote transport for
20680 putting messages into files for remote delivery by some means other than Exim.
20681 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
20682 option).
20683
20684
20685
20686 .section "The file and directory options" "SECTfildiropt"
20687 The &%file%& option specifies a single file, to which the message is appended;
20688 the &%directory%& option specifies a directory, in which a new file containing
20689 the message is created. Only one of these two options can be set, and for
20690 normal deliveries to mailboxes, one of them &'must'& be set.
20691
20692 .vindex "&$address_file$&"
20693 .vindex "&$local_part$&"
20694 However, &(appendfile)& is also used for delivering messages to files or
20695 directories whose names (or parts of names) are obtained from alias,
20696 forwarding, or filtering operations (for example, a &%save%& command in a
20697 user's Exim filter). When such a transport is running, &$local_part$& contains
20698 the local part that was aliased or forwarded, and &$address_file$& contains the
20699 name (or partial name) of the file or directory generated by the redirection
20700 operation. There are two cases:
20701
20702 .ilist
20703 If neither &%file%& nor &%directory%& is set, the redirection operation
20704 must specify an absolute path (one that begins with &`/`&). This is the most
20705 common case when users with local accounts use filtering to sort mail into
20706 different folders. See for example, the &(address_file)& transport in the
20707 default configuration. If the path ends with a slash, it is assumed to be the
20708 name of a directory. A delivery to a directory can also be forced by setting
20709 &%maildir_format%& or &%mailstore_format%&.
20710 .next
20711 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
20712 used to determine the file or directory name for the delivery. Normally, the
20713 contents of &$address_file$& are used in some way in the string expansion.
20714 .endlist
20715
20716
20717 .cindex "Sieve filter" "configuring &(appendfile)&"
20718 .cindex "Sieve filter" "relative mailbox path handling"
20719 As an example of the second case, consider an environment where users do not
20720 have home directories. They may be permitted to use Exim filter commands of the
20721 form:
20722 .code
20723 save folder23
20724 .endd
20725 or Sieve filter commands of the form:
20726 .code
20727 require "fileinto";
20728 fileinto "folder23";
20729 .endd
20730 In this situation, the expansion of &%file%& or &%directory%& in the transport
20731 must transform the relative path into an appropriate absolute file name. In the
20732 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
20733 is used as a result of a &"keep"& action in the filter. This example shows one
20734 way of handling this requirement:
20735 .code
20736 file = ${if eq{$address_file}{inbox} \
20737             {/var/mail/$local_part} \
20738             {${if eq{${substr_0_1:$address_file}}{/} \
20739                   {$address_file} \
20740                   {$home/mail/$address_file} \
20741             }} \
20742        }
20743 .endd
20744 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
20745 location, absolute paths are used without change, and other folders are in the
20746 &_mail_& directory within the home directory.
20747
20748 &*Note 1*&: While processing an Exim filter, a relative path such as
20749 &_folder23_& is turned into an absolute path if a home directory is known to
20750 the router. In particular, this is the case if &%check_local_user%& is set. If
20751 you want to prevent this happening at routing time, you can set
20752 &%router_home_directory%& empty. This forces the router to pass the relative
20753 path to the transport.
20754
20755 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
20756 the &%file%& or &%directory%& option is still used if it is set.
20757
20758
20759
20760
20761 .section "Private options for appendfile" "SECID134"
20762 .cindex "options" "&(appendfile)& transport"
20763
20764
20765
20766 .option allow_fifo appendfile boolean false
20767 .cindex "fifo (named pipe)"
20768 .cindex "named pipe (fifo)"
20769 .cindex "pipe" "named (fifo)"
20770 Setting this option permits delivery to named pipes (FIFOs) as well as to
20771 regular files. If no process is reading the named pipe at delivery time, the
20772 delivery is deferred.
20773
20774
20775 .option allow_symlink appendfile boolean false
20776 .cindex "symbolic link" "to mailbox"
20777 .cindex "mailbox" "symbolic link"
20778 By default, &(appendfile)& will not deliver if the path name for the file is
20779 that of a symbolic link. Setting this option relaxes that constraint, but there
20780 are security issues involved in the use of symbolic links. Be sure you know
20781 what you are doing if you set this. Details of exactly what this option affects
20782 are included in the discussion which follows this list of options.
20783
20784
20785 .option batch_id appendfile string&!! unset
20786 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
20787 However, batching is automatically disabled for &(appendfile)& deliveries that
20788 happen as a result of forwarding or aliasing or other redirection directly to a
20789 file.
20790
20791
20792 .option batch_max appendfile integer 1
20793 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
20794
20795
20796 .option check_group appendfile boolean false
20797 When this option is set, the group owner of the file defined by the &%file%&
20798 option is checked to see that it is the same as the group under which the
20799 delivery process is running. The default setting is false because the default
20800 file mode is 0600, which means that the group is irrelevant.
20801
20802
20803 .option check_owner appendfile boolean true
20804 When this option is set, the owner of the file defined by the &%file%& option
20805 is checked to ensure that it is the same as the user under which the delivery
20806 process is running.
20807
20808
20809 .option check_string appendfile string "see below"
20810 .cindex "&""From""& line"
20811 As &(appendfile)& writes the message, the start of each line is tested for
20812 matching &%check_string%&, and if it does, the initial matching characters are
20813 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
20814 a literal string, not a regular expression, and the case of any letters it
20815 contains is significant.
20816
20817 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
20818 are forced to &"."& and &".."& respectively, and any settings in the
20819 configuration are ignored. Otherwise, they default to &"From&~"& and
20820 &">From&~"& when the &%file%& option is set, and unset when any of the
20821 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
20822
20823 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
20824 suitable for traditional &"BSD"& mailboxes, where a line beginning with
20825 &"From&~"& indicates the start of a new message. All four options need changing
20826 if another format is used. For example, to deliver to mailboxes in MMDF format:
20827 .cindex "MMDF format mailbox"
20828 .cindex "mailbox" "MMDF format"
20829 .code
20830 check_string = "\1\1\1\1\n"
20831 escape_string = "\1\1\1\1 \n"
20832 message_prefix = "\1\1\1\1\n"
20833 message_suffix = "\1\1\1\1\n"
20834 .endd
20835 .option create_directory appendfile boolean true
20836 .cindex "directory creation"
20837 When this option is true, Exim attempts to create any missing superior
20838 directories for the file that it is about to write. A created directory's mode
20839 is given by the &%directory_mode%& option.
20840
20841 The group ownership of a newly created directory is highly dependent on the
20842 operating system (and possibly the file system) that is being used. For
20843 example, in Solaris, if the parent directory has the setgid bit set, its group
20844 is propagated to the child; if not, the currently set group is used. However,
20845 in FreeBSD, the parent's group is always used.
20846
20847
20848
20849 .option create_file appendfile string anywhere
20850 This option constrains the location of files and directories that are created
20851 by this transport. It applies to files defined by the &%file%& option and
20852 directories defined by the &%directory%& option. In the case of maildir
20853 delivery, it applies to the top level directory, not the maildir directories
20854 beneath.
20855
20856 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
20857 &"belowhome"&. In the second and third cases, a home directory must have been
20858 set for the transport. This option is not useful when an explicit file name is
20859 given for normal mailbox deliveries. It is intended for the case when file
20860 names are generated from users' &_.forward_& files. These are usually handled
20861 by an &(appendfile)& transport called &%address_file%&. See also
20862 &%file_must_exist%&.
20863
20864
20865 .option directory appendfile string&!! unset
20866 This option is mutually exclusive with the &%file%& option, but one of &%file%&
20867 or &%directory%& must be set, unless the delivery is the direct result of a
20868 redirection (see section &<<SECTfildiropt>>&).
20869
20870 When &%directory%& is set, the string is expanded, and the message is delivered
20871 into a new file or files in or below the given directory, instead of being
20872 appended to a single mailbox file. A number of different formats are provided
20873 (see &%maildir_format%& and &%mailstore_format%&), and see section
20874 &<<SECTopdir>>& for further details of this form of delivery.
20875
20876
20877 .option directory_file appendfile string&!! "see below"
20878 .cindex "base62"
20879 .vindex "&$inode$&"
20880 When &%directory%& is set, but neither &%maildir_format%& nor
20881 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
20882 whose name is obtained by expanding this string. The default value is:
20883 .code
20884 q${base62:$tod_epoch}-$inode
20885 .endd
20886 This generates a unique name from the current time, in base 62 form, and the
20887 inode of the file. The variable &$inode$& is available only when expanding this
20888 option.
20889
20890
20891 .option directory_mode appendfile "octal integer" 0700
20892 If &(appendfile)& creates any directories as a result of the
20893 &%create_directory%& option, their mode is specified by this option.
20894
20895
20896 .option escape_string appendfile string "see description"
20897 See &%check_string%& above.
20898
20899
20900 .option file appendfile string&!! unset
20901 This option is mutually exclusive with the &%directory%& option, but one of
20902 &%file%& or &%directory%& must be set, unless the delivery is the direct result
20903 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
20904 specifies a single file, to which the message is appended. One or more of
20905 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
20906 &%file%&.
20907
20908 .cindex "NFS" "lock file"
20909 .cindex "locking files"
20910 .cindex "lock files"
20911 If you are using more than one host to deliver over NFS into the same
20912 mailboxes, you should always use lock files.
20913
20914 The string value is expanded for each delivery, and must yield an absolute
20915 path. The most common settings of this option are variations on one of these
20916 examples:
20917 .code
20918 file = /var/spool/mail/$local_part
20919 file = /home/$local_part/inbox
20920 file = $home/inbox
20921 .endd
20922 .cindex "&""sticky""& bit"
20923 In the first example, all deliveries are done into the same directory. If Exim
20924 is configured to use lock files (see &%use_lockfile%& below) it must be able to
20925 create a file in the directory, so the &"sticky"& bit must be turned on for
20926 deliveries to be possible, or alternatively the &%group%& option can be used to
20927 run the delivery under a group id which has write access to the directory.
20928
20929
20930
20931 .option file_format appendfile string unset
20932 .cindex "file" "mailbox; checking existing format"
20933 This option requests the transport to check the format of an existing file
20934 before adding to it. The check consists of matching a specific string at the
20935 start of the file. The value of the option consists of an even number of
20936 colon-separated strings. The first of each pair is the test string, and the
20937 second is the name of a transport. If the transport associated with a matched
20938 string is not the current transport, control is passed over to the other
20939 transport. For example, suppose the standard &(local_delivery)& transport has
20940 this added to it:
20941 .code
20942 file_format = "From       : local_delivery :\
20943                \1\1\1\1\n : local_mmdf_delivery"
20944 .endd
20945 Mailboxes that begin with &"From"& are still handled by this transport, but if
20946 a mailbox begins with four binary ones followed by a newline, control is passed
20947 to a transport called &%local_mmdf_delivery%&, which presumably is configured
20948 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
20949 is assumed to match the current transport. If the start of a mailbox doesn't
20950 match any string, or if the transport named for a given string is not defined,
20951 delivery is deferred.
20952
20953
20954 .option file_must_exist appendfile boolean false
20955 If this option is true, the file specified by the &%file%& option must exist.
20956 A temporary error occurs if it does not, causing delivery to be deferred.
20957 If this option is false, the file is created if it does not exist.
20958
20959
20960 .option lock_fcntl_timeout appendfile time 0s
20961 .cindex "timeout" "mailbox locking"
20962 .cindex "mailbox" "locking, blocking and non-blocking"
20963 .cindex "locking files"
20964 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
20965 when locking an open mailbox file. If the call fails, the delivery process
20966 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
20967 Non-blocking calls are used so that the file is not kept open during the wait
20968 for the lock; the reason for this is to make it as safe as possible for
20969 deliveries over NFS in the case when processes might be accessing an NFS
20970 mailbox without using a lock file. This should not be done, but
20971 misunderstandings and hence misconfigurations are not unknown.
20972
20973 On a busy system, however, the performance of a non-blocking lock approach is
20974 not as good as using a blocking lock with a timeout. In this case, the waiting
20975 is done inside the system call, and Exim's delivery process acquires the lock
20976 and can proceed as soon as the previous lock holder releases it.
20977
20978 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
20979 timeout, are used. There may still be some retrying: the maximum number of
20980 retries is
20981 .code
20982 (lock_retries * lock_interval) / lock_fcntl_timeout
20983 .endd
20984 rounded up to the next whole number. In other words, the total time during
20985 which &(appendfile)& is trying to get a lock is roughly the same, unless
20986 &%lock_fcntl_timeout%& is set very large.
20987
20988 You should consider setting this option if you are getting a lot of delayed
20989 local deliveries because of errors of the form
20990 .code
20991 failed to lock mailbox /some/file (fcntl)
20992 .endd
20993
20994 .option lock_flock_timeout appendfile time 0s
20995 This timeout applies to file locking when using &[flock()]& (see
20996 &%use_flock%&); the timeout operates in a similar manner to
20997 &%lock_fcntl_timeout%&.
20998
20999
21000 .option lock_interval appendfile time 3s
21001 This specifies the time to wait between attempts to lock the file. See below
21002 for details of locking.
21003
21004
21005 .option lock_retries appendfile integer 10
21006 This specifies the maximum number of attempts to lock the file. A value of zero
21007 is treated as 1. See below for details of locking.
21008
21009
21010 .option lockfile_mode appendfile "octal integer" 0600
21011 This specifies the mode of the created lock file, when a lock file is being
21012 used (see &%use_lockfile%& and &%use_mbx_lock%&).
21013
21014
21015 .option lockfile_timeout appendfile time 30m
21016 .cindex "timeout" "mailbox locking"
21017 When a lock file is being used (see &%use_lockfile%&), if a lock file already
21018 exists and is older than this value, it is assumed to have been left behind by
21019 accident, and Exim attempts to remove it.
21020
21021
21022 .option mailbox_filecount appendfile string&!! unset
21023 .cindex "mailbox" "specifying size of"
21024 .cindex "size" "of mailbox"
21025 If this option is set, it is expanded, and the result is taken as the current
21026 number of files in the mailbox. It must be a decimal number, optionally
21027 followed by K or M. This provides a way of obtaining this information from an
21028 external source that maintains the data.
21029
21030
21031 .option mailbox_size appendfile string&!! unset
21032 .cindex "mailbox" "specifying size of"
21033 .cindex "size" "of mailbox"
21034 If this option is set, it is expanded, and the result is taken as the current
21035 size the mailbox. It must be a decimal number, optionally followed by K or M.
21036 This provides a way of obtaining this information from an external source that
21037 maintains the data. This is likely to be helpful for maildir deliveries where
21038 it is computationally expensive to compute the size of a mailbox.
21039
21040
21041
21042 .option maildir_format appendfile boolean false
21043 .cindex "maildir format" "specifying"
21044 If this option is set with the &%directory%& option, the delivery is into a new
21045 file, in the &"maildir"& format that is used by other mail software. When the
21046 transport is activated directly from a &(redirect)& router (for example, the
21047 &(address_file)& transport in the default configuration), setting
21048 &%maildir_format%& causes the path received from the router to be treated as a
21049 directory, whether or not it ends with &`/`&. This option is available only if
21050 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
21051 &<<SECTmaildirdelivery>>& below for further details.
21052
21053
21054 .option maildir_quota_directory_regex appendfile string "See below"
21055 .cindex "maildir format" "quota; directories included in"
21056 .cindex "quota" "maildir; directories included in"
21057 This option is relevant only when &%maildir_use_size_file%& is set. It defines
21058 a regular expression for specifying directories, relative to the quota
21059 directory (see &%quota_directory%&), that should be included in the quota
21060 calculation. The default value is:
21061 .code
21062 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
21063 .endd
21064 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
21065 (directories whose names begin with a dot). If you want to exclude the
21066 &_Trash_&
21067 folder from the count (as some sites do), you need to change this setting to
21068 .code
21069 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
21070 .endd
21071 This uses a negative lookahead in the regular expression to exclude the
21072 directory whose name is &_.Trash_&. When a directory is excluded from quota
21073 calculations, quota processing is bypassed for any messages that are delivered
21074 directly into that directory.
21075
21076
21077 .option maildir_retries appendfile integer 10
21078 This option specifies the number of times to retry when writing a file in
21079 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
21080
21081
21082 .option maildir_tag appendfile string&!! unset
21083 This option applies only to deliveries in maildir format, and is described in
21084 section &<<SECTmaildirdelivery>>& below.
21085
21086
21087 .option maildir_use_size_file appendfile&!! boolean false
21088 .cindex "maildir format" "&_maildirsize_& file"
21089 The result of string expansion for this option must be a valid boolean value.
21090 If it is true, it enables support for &_maildirsize_& files. Exim
21091 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
21092 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
21093 value is zero. See &%maildir_quota_directory_regex%& above and section
21094 &<<SECTmaildirdelivery>>& below for further details.
21095
21096 .option maildirfolder_create_regex appendfile string unset
21097 .cindex "maildir format" "&_maildirfolder_& file"
21098 .cindex "&_maildirfolder_&, creating"
21099 The value of this option is a regular expression. If it is unset, it has no
21100 effect. Otherwise, before a maildir delivery takes place, the pattern is
21101 matched against the name of the maildir directory, that is, the directory
21102 containing the &_new_& and &_tmp_& subdirectories that will be used for the
21103 delivery. If there is a match, Exim checks for the existence of a file called
21104 &_maildirfolder_& in the directory, and creates it if it does not exist.
21105 See section &<<SECTmaildirdelivery>>& for more details.
21106
21107
21108 .option mailstore_format appendfile boolean false
21109 .cindex "mailstore format" "specifying"
21110 If this option is set with the &%directory%& option, the delivery is into two
21111 new files in  &"mailstore"& format. The option is available only if
21112 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
21113 below for further details.
21114
21115
21116 .option mailstore_prefix appendfile string&!! unset
21117 This option applies only to deliveries in mailstore format, and is described in
21118 section &<<SECTopdir>>& below.
21119
21120
21121 .option mailstore_suffix appendfile string&!! unset
21122 This option applies only to deliveries in mailstore format, and is described in
21123 section &<<SECTopdir>>& below.
21124
21125
21126 .option mbx_format appendfile boolean false
21127 .cindex "locking files"
21128 .cindex "file" "locking"
21129 .cindex "file" "MBX format"
21130 .cindex "MBX format, specifying"
21131 This option is available only if Exim has been compiled with SUPPORT_MBX
21132 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
21133 the message is appended to the mailbox file in MBX format instead of
21134 traditional Unix format. This format is supported by Pine4 and its associated
21135 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
21136
21137 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
21138 automatically changed by the use of &%mbx_format%&. They should normally be set
21139 empty when using MBX format, so this option almost always appears in this
21140 combination:
21141 .code
21142 mbx_format = true
21143 message_prefix =
21144 message_suffix =
21145 .endd
21146 If none of the locking options are mentioned in the configuration,
21147 &%use_mbx_lock%& is assumed and the other locking options default to false. It
21148 is possible to specify the other kinds of locking with &%mbx_format%&, but
21149 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
21150 interworks with &'c-client'&, providing for shared access to the mailbox. It
21151 should not be used if any program that does not use this form of locking is
21152 going to access the mailbox, nor should it be used if the mailbox file is NFS
21153 mounted, because it works only when the mailbox is accessed from a single host.
21154
21155 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
21156 the standard version of &'c-client'&, because as long as it has a mailbox open
21157 (this means for the whole of a Pine or IMAP session), Exim will not be able to
21158 append messages to it.
21159
21160
21161 .option message_prefix appendfile string&!! "see below"
21162 .cindex "&""From""& line"
21163 The string specified here is expanded and output at the start of every message.
21164 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
21165 in which case it is:
21166 .code
21167 message_prefix = "From ${if def:return_path{$return_path}\
21168   {MAILER-DAEMON}} $tod_bsdinbox\n"
21169 .endd
21170 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21171 &`\n`& to &`\r\n`& in &%message_prefix%&.
21172
21173 .option message_suffix appendfile string&!! "see below"
21174 The string specified here is expanded and output at the end of every message.
21175 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
21176 in which case it is a single newline character. The suffix can be suppressed by
21177 setting
21178 .code
21179 message_suffix =
21180 .endd
21181 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21182 &`\n`& to &`\r\n`& in &%message_suffix%&.
21183
21184 .option mode appendfile "octal integer" 0600
21185 If the output file is created, it is given this mode. If it already exists and
21186 has wider permissions, they are reduced to this mode. If it has narrower
21187 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
21188 if the delivery is the result of a &%save%& command in a filter file specifying
21189 a particular mode, the mode of the output file is always forced to take that
21190 value, and this option is ignored.
21191
21192
21193 .option mode_fail_narrower appendfile boolean true
21194 This option applies in the case when an existing mailbox file has a narrower
21195 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
21196 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
21197 continues with the delivery attempt, using the existing mode of the file.
21198
21199
21200 .option notify_comsat appendfile boolean false
21201 If this option is true, the &'comsat'& daemon is notified after every
21202 successful delivery to a user mailbox. This is the daemon that notifies logged
21203 on users about incoming mail.
21204
21205
21206 .option quota appendfile string&!! unset
21207 .cindex "quota" "imposed by Exim"
21208 This option imposes a limit on the size of the file to which Exim is appending,
21209 or to the total space used in the directory tree when the &%directory%& option
21210 is set. In the latter case, computation of the space used is expensive, because
21211 all the files in the directory (and any sub-directories) have to be
21212 individually inspected and their sizes summed. (See &%quota_size_regex%& and
21213 &%maildir_use_size_file%& for ways to avoid this in environments where users
21214 have no shell access to their mailboxes).
21215
21216 As there is no interlock against two simultaneous deliveries into a
21217 multi-file mailbox, it is possible for the quota to be overrun in this case.
21218 For single-file mailboxes, of course, an interlock is a necessity.
21219
21220 A file's size is taken as its &'used'& value. Because of blocking effects, this
21221 may be a lot less than the actual amount of disk space allocated to the file.
21222 If the sizes of a number of files are being added up, the rounding effect can
21223 become quite noticeable, especially on systems that have large block sizes.
21224 Nevertheless, it seems best to stick to the &'used'& figure, because this is
21225 the obvious value which users understand most easily.
21226
21227 The value of the option is expanded, and must then be a numerical value
21228 (decimal point allowed), optionally followed by one of the letters K, M, or G,
21229 for kilobytes, megabytes, or gigabytes. If Exim is running on a system with
21230 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
21231 be handled.
21232
21233 &*Note*&: A value of zero is interpreted as &"no quota"&.
21234
21235 The expansion happens while Exim is running as root, before it changes uid for
21236 the delivery. This means that files that are inaccessible to the end user can
21237 be used to hold quota values that are looked up in the expansion. When delivery
21238 fails because this quota is exceeded, the handling of the error is as for
21239 system quota failures.
21240
21241 By default, Exim's quota checking mimics system quotas, and restricts the
21242 mailbox to the specified maximum size, though the value is not accurate to the
21243 last byte, owing to separator lines and additional headers that may get added
21244 during message delivery. When a mailbox is nearly full, large messages may get
21245 refused even though small ones are accepted, because the size of the current
21246 message is added to the quota when the check is made. This behaviour can be
21247 changed by setting &%quota_is_inclusive%& false. When this is done, the check
21248 for exceeding the quota does not include the current message. Thus, deliveries
21249 continue until the quota has been exceeded; thereafter, no further messages are
21250 delivered. See also &%quota_warn_threshold%&.
21251
21252
21253 .option quota_directory appendfile string&!! unset
21254 This option defines the directory to check for quota purposes when delivering
21255 into individual files. The default is the delivery directory, or, if a file
21256 called &_maildirfolder_& exists in a maildir directory, the parent of the
21257 delivery directory.
21258
21259
21260 .option quota_filecount appendfile string&!! 0
21261 This option applies when the &%directory%& option is set. It limits the total
21262 number of files in the directory (compare the inode limit in system quotas). It
21263 can only be used if &%quota%& is also set. The value is expanded; an expansion
21264 failure causes delivery to be deferred. A value of zero is interpreted as
21265 &"no quota"&.
21266
21267
21268 .option quota_is_inclusive appendfile boolean true
21269 See &%quota%& above.
21270
21271
21272 .option quota_size_regex appendfile string unset
21273 This option applies when one of the delivery modes that writes a separate file
21274 for each message is being used. When Exim wants to find the size of one of
21275 these files in order to test the quota, it first checks &%quota_size_regex%&.
21276 If this is set to a regular expression that matches the file name, and it
21277 captures one string, that string is interpreted as a representation of the
21278 file's size. The value of &%quota_size_regex%& is not expanded.
21279
21280 This feature is useful only when users have no shell access to their mailboxes
21281 &-- otherwise they could defeat the quota simply by renaming the files. This
21282 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
21283 the file length to the file name. For example:
21284 .code
21285 maildir_tag = ,S=$message_size
21286 quota_size_regex = ,S=(\d+)
21287 .endd
21288 An alternative to &$message_size$& is &$message_linecount$&, which contains the
21289 number of lines in the message.
21290
21291 The regular expression should not assume that the length is at the end of the
21292 file name (even though &%maildir_tag%& puts it there) because maildir MUAs
21293 sometimes add other information onto the ends of message file names.
21294
21295 Section &<<SECID136>>& contains further information.
21296
21297
21298 .option quota_warn_message appendfile string&!! "see below"
21299 See below for the use of this option. If it is not set when
21300 &%quota_warn_threshold%& is set, it defaults to
21301 .code
21302 quota_warn_message = "\
21303   To: $local_part@$domain\n\
21304   Subject: Your mailbox\n\n\
21305   This message is automatically created \
21306   by mail delivery software.\n\n\
21307   The size of your mailbox has exceeded \
21308   a warning threshold that is\n\
21309   set by the system administrator.\n"
21310 .endd
21311
21312
21313 .option quota_warn_threshold appendfile string&!! 0
21314 .cindex "quota" "warning threshold"
21315 .cindex "mailbox" "size warning"
21316 .cindex "size" "of mailbox"
21317 This option is expanded in the same way as &%quota%& (see above). If the
21318 resulting value is greater than zero, and delivery of the message causes the
21319 size of the file or total space in the directory tree to cross the given
21320 threshold, a warning message is sent. If &%quota%& is also set, the threshold
21321 may be specified as a percentage of it by following the value with a percent
21322 sign. For example:
21323 .code
21324 quota = 10M
21325 quota_warn_threshold = 75%
21326 .endd
21327 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
21328 percent sign is ignored.
21329
21330 The warning message itself is specified by the &%quota_warn_message%& option,
21331 and it must start with a &'To:'& header line containing the recipient(s) of the
21332 warning message. These do not necessarily have to include the recipient(s) of
21333 the original message. A &'Subject:'& line should also normally be supplied. You
21334 can include any other header lines that you want. If you do not include a
21335 &'From:'& line, the default is:
21336 .code
21337 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
21338 .endd
21339 .oindex &%errors_reply_to%&
21340 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
21341 option.
21342
21343 The &%quota%& option does not have to be set in order to use this option; they
21344 are independent of one another except when the threshold is specified as a
21345 percentage.
21346
21347
21348 .option use_bsmtp appendfile boolean false
21349 .cindex "envelope sender"
21350 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
21351 format, with the envelope sender and recipient(s) included as SMTP commands. If
21352 you want to include a leading HELO command with such messages, you can do
21353 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
21354 for details of batch SMTP.
21355
21356
21357 .option use_crlf appendfile boolean false
21358 .cindex "carriage return"
21359 .cindex "linefeed"
21360 This option causes lines to be terminated with the two-character CRLF sequence
21361 (carriage return, linefeed) instead of just a linefeed character. In the case
21362 of batched SMTP, the byte sequence written to the file is then an exact image
21363 of what would be sent down a real SMTP connection.
21364
21365 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
21366 (which are used to supply the traditional &"From&~"& and blank line separators
21367 in Berkeley-style mailboxes) are written verbatim, so must contain their own
21368 carriage return characters if these are needed. In cases where these options
21369 have non-empty defaults, the values end with a single linefeed, so they must be
21370 changed to end with &`\r\n`& if &%use_crlf%& is set.
21371
21372
21373 .option use_fcntl_lock appendfile boolean "see below"
21374 This option controls the use of the &[fcntl()]& function to lock a file for
21375 exclusive use when a message is being appended. It is set by default unless
21376 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
21377 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
21378 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
21379
21380
21381 .option use_flock_lock appendfile boolean false
21382 This option is provided to support the use of &[flock()]& for file locking, for
21383 the few situations where it is needed. Most modern operating systems support
21384 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
21385 each other. Exim uses &[fcntl()]& locking by default.
21386
21387 This option is required only if you are using an operating system where
21388 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
21389 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
21390 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
21391
21392 .cindex "Solaris" "&[flock()]& support"
21393 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
21394 have it (and some, I think, provide a not quite right version built on top of
21395 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
21396 the ability to use it, and any attempt to do so will cause a configuration
21397 error.
21398
21399 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
21400 is just being mapped onto &[fcntl()]& by the OS).
21401
21402
21403 .option use_lockfile appendfile boolean "see below"
21404 If this option is turned off, Exim does not attempt to create a lock file when
21405 appending to a mailbox file. In this situation, the only locking is by
21406 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
21407 sure that every MUA that is ever going to look at your users' mailboxes uses
21408 &[fcntl()]& rather than a lock file, and even then only when you are not
21409 delivering over NFS from more than one host.
21410
21411 .cindex "NFS" "lock file"
21412 In order to append to an NFS file safely from more than one host, it is
21413 necessary to take out a lock &'before'& opening the file, and the lock file
21414 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
21415 file corruption.
21416
21417 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
21418 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
21419 except when &%mbx_format%& is set.
21420
21421
21422 .option use_mbx_lock appendfile boolean "see below"
21423 This option is available only if Exim has been compiled with SUPPORT_MBX
21424 set in &_Local/Makefile_&. Setting the option specifies that special MBX
21425 locking rules be used. It is set by default if &%mbx_format%& is set and none
21426 of the locking options are mentioned in the configuration. The locking rules
21427 are the same as are used by the &'c-client'& library that underlies Pine and
21428 the IMAP4 and POP daemons that come with it (see the discussion below). The
21429 rules allow for shared access to the mailbox. However, this kind of locking
21430 does not work when the mailbox is NFS mounted.
21431
21432 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
21433 &%use_flock_lock%& to control what kind of locking is used in implementing the
21434 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
21435 without &%use_fcntl_lock%& or &%use_flock_lock%&.
21436
21437
21438
21439
21440 .section "Operational details for appending" "SECTopappend"
21441 .cindex "appending to a file"
21442 .cindex "file" "appending"
21443 Before appending to a file, the following preparations are made:
21444
21445 .ilist
21446 If the name of the file is &_/dev/null_&, no action is taken, and a success
21447 return is given.
21448
21449 .next
21450 .cindex "directory creation"
21451 If any directories on the file's path are missing, Exim creates them if the
21452 &%create_directory%& option is set. A created directory's mode is given by the
21453 &%directory_mode%& option.
21454
21455 .next
21456 If &%file_format%& is set, the format of an existing file is checked. If this
21457 indicates that a different transport should be used, control is passed to that
21458 transport.
21459
21460 .next
21461 .cindex "file" "locking"
21462 .cindex "locking files"
21463 .cindex "NFS" "lock file"
21464 If &%use_lockfile%& is set, a lock file is built in a way that will work
21465 reliably over NFS, as follows:
21466
21467 .olist
21468 Create a &"hitching post"& file whose name is that of the lock file with the
21469 current time, primary host name, and process id added, by opening for writing
21470 as a new file. If this fails with an access error, delivery is deferred.
21471 .next
21472 Close the hitching post file, and hard link it to the lock file name.
21473 .next
21474 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
21475 Unlink the hitching post name.
21476 .next
21477 Otherwise, use &[stat()]& to get information about the hitching post file, and
21478 then unlink hitching post name. If the number of links is exactly two, creation
21479 of the lock file succeeded but something (for example, an NFS server crash and
21480 restart) caused this fact not to be communicated to the &[link()]& call.
21481 .next
21482 If creation of the lock file failed, wait for &%lock_interval%& and try again,
21483 up to &%lock_retries%& times. However, since any program that writes to a
21484 mailbox should complete its task very quickly, it is reasonable to time out old
21485 lock files that are normally the result of user agent and system crashes. If an
21486 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
21487 it before trying again.
21488 .endlist olist
21489
21490 .next
21491 A call is made to &[lstat()]& to discover whether the main file exists, and if
21492 so, what its characteristics are. If &[lstat()]& fails for any reason other
21493 than non-existence, delivery is deferred.
21494
21495 .next
21496 .cindex "symbolic link" "to mailbox"
21497 .cindex "mailbox" "symbolic link"
21498 If the file does exist and is a symbolic link, delivery is deferred, unless the
21499 &%allow_symlink%& option is set, in which case the ownership of the link is
21500 checked, and then &[stat()]& is called to find out about the real file, which
21501 is then subjected to the checks below. The check on the top-level link
21502 ownership prevents one user creating a link for another's mailbox in a sticky
21503 directory, though allowing symbolic links in this case is definitely not a good
21504 idea. If there is a chain of symbolic links, the intermediate ones are not
21505 checked.
21506
21507 .next
21508 If the file already exists but is not a regular file, or if the file's owner
21509 and group (if the group is being checked &-- see &%check_group%& above) are
21510 different from the user and group under which the delivery is running,
21511 delivery is deferred.
21512
21513 .next
21514 If the file's permissions are more generous than specified, they are reduced.
21515 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
21516 is set false, in which case the delivery is tried using the existing
21517 permissions.
21518
21519 .next
21520 The file's inode number is saved, and the file is then opened for appending.
21521 If this fails because the file has vanished, &(appendfile)& behaves as if it
21522 hadn't existed (see below). For any other failures, delivery is deferred.
21523
21524 .next
21525 If the file is opened successfully, check that the inode number hasn't
21526 changed, that it is still a regular file, and that the owner and permissions
21527 have not changed. If anything is wrong, defer delivery and freeze the message.
21528
21529 .next
21530 If the file did not exist originally, defer delivery if the &%file_must_exist%&
21531 option is set. Otherwise, check that the file is being created in a permitted
21532 directory if the &%create_file%& option is set (deferring on failure), and then
21533 open for writing as a new file, with the O_EXCL and O_CREAT options,
21534 except when dealing with a symbolic link (the &%allow_symlink%& option must be
21535 set). In this case, which can happen if the link points to a non-existent file,
21536 the file is opened for writing using O_CREAT but not O_EXCL, because
21537 that prevents link following.
21538
21539 .next
21540 .cindex "loop" "while file testing"
21541 If opening fails because the file exists, obey the tests given above for
21542 existing files. However, to avoid looping in a situation where the file is
21543 being continuously created and destroyed, the exists/not-exists loop is broken
21544 after 10 repetitions, and the message is then frozen.
21545
21546 .next
21547 If opening fails with any other error, defer delivery.
21548
21549 .next
21550 .cindex "file" "locking"
21551 .cindex "locking files"
21552 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
21553 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
21554 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
21555 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
21556 file, and an exclusive lock on the file whose name is
21557 .code
21558 /tmp/.<device-number>.<inode-number>
21559 .endd
21560 using the device and inode numbers of the open mailbox file, in accordance with
21561 the MBX locking rules. This file is created with a mode that is specified by
21562 the &%lockfile_mode%& option.
21563
21564 If Exim fails to lock the file, there are two possible courses of action,
21565 depending on the value of the locking timeout. This is obtained from
21566 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
21567
21568 If the timeout value is zero, the file is closed, Exim waits for
21569 &%lock_interval%&, and then goes back and re-opens the file as above and tries
21570 to lock it again. This happens up to &%lock_retries%& times, after which the
21571 delivery is deferred.
21572
21573 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
21574 &[flock()]& are used (with the given timeout), so there has already been some
21575 waiting involved by the time locking fails. Nevertheless, Exim does not give up
21576 immediately. It retries up to
21577 .code
21578 (lock_retries * lock_interval) / <timeout>
21579 .endd
21580 times (rounded up).
21581 .endlist
21582
21583 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
21584 and/or &[flock()]& locks) and then deletes the lock file if one was created.
21585
21586
21587 .section "Operational details for delivery to a new file" "SECTopdir"
21588 .cindex "delivery" "to single file"
21589 .cindex "&""From""& line"
21590 When the &%directory%& option is set instead of &%file%&, each message is
21591 delivered into a newly-created file or set of files. When &(appendfile)& is
21592 activated directly from a &(redirect)& router, neither &%file%& nor
21593 &%directory%& is normally set, because the path for delivery is supplied by the
21594 router. (See for example, the &(address_file)& transport in the default
21595 configuration.) In this case, delivery is to a new file if either the path name
21596 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
21597
21598 No locking is required while writing the message to a new file, so the various
21599 locking options of the transport are ignored. The &"From"& line that by default
21600 separates messages in a single file is not normally needed, nor is the escaping
21601 of message lines that start with &"From"&, and there is no need to ensure a
21602 newline at the end of each message. Consequently, the default values for
21603 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
21604 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
21605
21606 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
21607 the files in the delivery directory by default. However, you can specify a
21608 different directory by setting &%quota_directory%&. Also, for maildir
21609 deliveries (see below) the &_maildirfolder_& convention is honoured.
21610
21611
21612 .cindex "maildir format"
21613 .cindex "mailstore format"
21614 There are three different ways in which delivery to individual files can be
21615 done, controlled by the settings of the &%maildir_format%& and
21616 &%mailstore_format%& options. Note that code to support maildir or mailstore
21617 formats is not included in the binary unless SUPPORT_MAILDIR or
21618 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
21619
21620 .cindex "directory creation"
21621 In all three cases an attempt is made to create the directory and any necessary
21622 sub-directories if they do not exist, provided that the &%create_directory%&
21623 option is set (the default). The location of a created directory can be
21624 constrained by setting &%create_file%&. A created directory's mode is given by
21625 the &%directory_mode%& option. If creation fails, or if the
21626 &%create_directory%& option is not set when creation is required, delivery is
21627 deferred.
21628
21629
21630
21631 .section "Maildir delivery" "SECTmaildirdelivery"
21632 .cindex "maildir format" "description of"
21633 If the &%maildir_format%& option is true, Exim delivers each message by writing
21634 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
21635 directory that is defined by the &%directory%& option (the &"delivery
21636 directory"&). If the delivery is successful, the file is renamed into the
21637 &_new_& subdirectory.
21638
21639 In the file name, <&'stime'&> is the current time of day in seconds, and
21640 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
21641 Exim checks that the time-of-day clock has moved on by at least one microsecond
21642 before terminating the delivery process. This guarantees uniqueness for the
21643 file name. However, as a precaution, Exim calls &[stat()]& for the file before
21644 opening it. If any response other than ENOENT (does not exist) is given,
21645 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
21646
21647 Before Exim carries out a maildir delivery, it ensures that subdirectories
21648 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
21649 do not exist, Exim tries to create them and any superior directories in their
21650 path, subject to the &%create_directory%& and &%create_file%& options. If the
21651 &%maildirfolder_create_regex%& option is set, and the regular expression it
21652 contains matches the delivery directory, Exim also ensures that a file called
21653 &_maildirfolder_& exists in the delivery directory. If a missing directory or
21654 &_maildirfolder_& file cannot be created, delivery is deferred.
21655
21656 These features make it possible to use Exim to create all the necessary files
21657 and directories in a maildir mailbox, including subdirectories for maildir++
21658 folders. Consider this example:
21659 .code
21660 maildir_format = true
21661 directory = /var/mail/$local_part\
21662            ${if eq{$local_part_suffix}{}{}\
21663            {/.${substr_1:$local_part_suffix}}}
21664 maildirfolder_create_regex = /\.[^/]+$
21665 .endd
21666 If &$local_part_suffix$& is empty (there was no suffix for the local part),
21667 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
21668 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
21669 not match this name, so Exim will not look for or create the file
21670 &_/var/mail/pimbo/maildirfolder_&, though it will create
21671 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
21672
21673 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
21674 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
21675 does match &%maildirfolder_create_regex%&. In this case, Exim will create
21676 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
21677 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
21678
21679 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
21680 not inadvertently match the toplevel maildir directory, because a
21681 &_maildirfolder_& file at top level would completely break quota calculations.
21682
21683 .cindex "quota" "in maildir delivery"
21684 .cindex "maildir++"
21685 If Exim is required to check a &%quota%& setting before a maildir delivery, and
21686 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
21687 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
21688 Exim assumes the directory is a maildir++ folder directory, which is one level
21689 down from the user's top level mailbox directory. This causes it to start at
21690 the parent directory instead of the current directory when calculating the
21691 amount of space used.
21692
21693 One problem with delivering into a multi-file mailbox is that it is
21694 computationally expensive to compute the size of the mailbox for quota
21695 checking. Various approaches have been taken to reduce the amount of work
21696 needed. The next two sections describe two of them. A third alternative is to
21697 use some external process for maintaining the size data, and use the expansion
21698 of the &%mailbox_size%& option as a way of importing it into Exim.
21699
21700
21701
21702
21703 .section "Using tags to record message sizes" "SECID135"
21704 If &%maildir_tag%& is set, the string is expanded for each delivery.
21705 When the maildir file is renamed into the &_new_& sub-directory, the
21706 tag is added to its name. However, if adding the tag takes the length of the
21707 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
21708 the tag is dropped and the maildir file is created with no tag.
21709
21710
21711 .vindex "&$message_size$&"
21712 Tags can be used to encode the size of files in their names; see
21713 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
21714 happens after the message has been written. The value of the &$message_size$&
21715 variable is set to the number of bytes actually written. If the expansion is
21716 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
21717 be deferred. The expanded tag may contain any printing characters except &"/"&.
21718 Non-printing characters in the string are ignored; if the resulting string is
21719 empty, it is ignored. If it starts with an alphanumeric character, a leading
21720 colon is inserted; this default has not proven to be the path that popular
21721 maildir implementations have chosen (but changing it in Exim would break
21722 backwards compatibility).
21723
21724 For one common implementation, you might set:
21725 .code
21726 maildir_tag = ,S=${message_size}
21727 .endd
21728 but you should check the documentation of the other software to be sure.
21729
21730 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
21731 as this allows Exim to extract the size from your tag, instead of having to
21732 &[stat()]& each message file.
21733
21734
21735 .section "Using a maildirsize file" "SECID136"
21736 .cindex "quota" "in maildir delivery"
21737 .cindex "maildir format" "&_maildirsize_& file"
21738 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
21739 storing quota and message size information in a file called &_maildirsize_&
21740 within the toplevel maildir directory. If this file does not exist, Exim
21741 creates it, setting the quota from the &%quota%& option of the transport. If
21742 the maildir directory itself does not exist, it is created before any attempt
21743 to write a &_maildirsize_& file.
21744
21745 The &_maildirsize_& file is used to hold information about the sizes of
21746 messages in the maildir, thus speeding up quota calculations. The quota value
21747 in the file is just a cache; if the quota is changed in the transport, the new
21748 value overrides the cached value when the next message is delivered. The cache
21749 is maintained for the benefit of other programs that access the maildir and
21750 need to know the quota.
21751
21752 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
21753 file is maintained (with a zero quota setting), but no quota is imposed.
21754
21755 A regular expression is available for controlling which directories in the
21756 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
21757 See the description of the &%maildir_quota_directory_regex%& option above for
21758 details.
21759
21760
21761 .section "Mailstore delivery" "SECID137"
21762 .cindex "mailstore format" "description of"
21763 If the &%mailstore_format%& option is true, each message is written as two
21764 files in the given directory. A unique base name is constructed from the
21765 message id and the current delivery process, and the files that are written use
21766 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
21767 contains the message's envelope, and the &_.msg_& file contains the message
21768 itself. The base name is placed in the variable &$mailstore_basename$&.
21769
21770 During delivery, the envelope is first written to a file with the suffix
21771 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
21772 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
21773 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
21774 file before accessing either of them. An alternative approach is to wait for
21775 the absence of a &_.tmp_& file.
21776
21777 The envelope file starts with any text defined by the &%mailstore_prefix%&
21778 option, expanded and terminated by a newline if there isn't one. Then follows
21779 the sender address on one line, then all the recipient addresses, one per line.
21780 There can be more than one recipient only if the &%batch_max%& option is set
21781 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
21782 appended to the file, followed by a newline if it does not end with one.
21783
21784 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
21785 failure, it is ignored. Other expansion errors are treated as serious
21786 configuration errors, and delivery is deferred. The variable
21787 &$mailstore_basename$& is available for use during these expansions.
21788
21789
21790 .section "Non-special new file delivery" "SECID138"
21791 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
21792 file is created directly in the named directory. For example, when delivering
21793 messages into files in batched SMTP format for later delivery to some host (see
21794 section &<<SECTbatchSMTP>>&), a setting such as
21795 .code
21796 directory = /var/bsmtp/$host
21797 .endd
21798 might be used. A message is written to a file with a temporary name, which is
21799 then renamed when the delivery is complete. The final name is obtained by
21800 expanding the contents of the &%directory_file%& option.
21801 .ecindex IIDapptra1
21802 .ecindex IIDapptra2
21803
21804
21805
21806
21807
21808
21809 . ////////////////////////////////////////////////////////////////////////////
21810 . ////////////////////////////////////////////////////////////////////////////
21811
21812 .chapter "The autoreply transport" "CHID8"
21813 .scindex IIDauttra1 "transports" "&(autoreply)&"
21814 .scindex IIDauttra2 "&(autoreply)& transport"
21815 The &(autoreply)& transport is not a true transport in that it does not cause
21816 the message to be transmitted. Instead, it generates a new mail message as an
21817 automatic reply to the incoming message. &'References:'& and
21818 &'Auto-Submitted:'& header lines are included. These are constructed according
21819 to the rules in RFCs 2822 and 3834, respectively.
21820
21821 If the router that passes the message to this transport does not have the
21822 &%unseen%& option set, the original message (for the current recipient) is not
21823 delivered anywhere. However, when the &%unseen%& option is set on the router
21824 that passes the message to this transport, routing of the address continues, so
21825 another router can set up a normal message delivery.
21826
21827
21828 The &(autoreply)& transport is usually run as the result of mail filtering, a
21829 &"vacation"& message being the standard example. However, it can also be run
21830 directly from a router like any other transport. To reduce the possibility of
21831 message cascades, messages created by the &(autoreply)& transport always have
21832 empty envelope sender addresses, like bounce messages.
21833
21834 The parameters of the message to be sent can be specified in the configuration
21835 by options described below. However, these are used only when the address
21836 passed to the transport does not contain its own reply information. When the
21837 transport is run as a consequence of a
21838 &%mail%&
21839 or &%vacation%& command in a filter file, the parameters of the message are
21840 supplied by the filter, and passed with the address. The transport's options
21841 that define the message are then ignored (so they are not usually set in this
21842 case). The message is specified entirely by the filter or by the transport; it
21843 is never built from a mixture of options. However, the &%file_optional%&,
21844 &%mode%&, and &%return_message%& options apply in all cases.
21845
21846 &(Autoreply)& is implemented as a local transport. When used as a result of a
21847 command in a user's filter file, &(autoreply)& normally runs under the uid and
21848 gid of the user, and with appropriate current and home directories (see chapter
21849 &<<CHAPenvironment>>&).
21850
21851 There is a subtle difference between routing a message to a &(pipe)& transport
21852 that generates some text to be returned to the sender, and routing it to an
21853 &(autoreply)& transport. This difference is noticeable only if more than one
21854 address from the same message is so handled. In the case of a pipe, the
21855 separate outputs from the different addresses are gathered up and returned to
21856 the sender in a single message, whereas if &(autoreply)& is used, a separate
21857 message is generated for each address that is passed to it.
21858
21859 Non-printing characters are not permitted in the header lines generated for the
21860 message that &(autoreply)& creates, with the exception of newlines that are
21861 immediately followed by white space. If any non-printing characters are found,
21862 the transport defers.
21863 Whether characters with the top bit set count as printing characters or not is
21864 controlled by the &%print_topbitchars%& global option.
21865
21866 If any of the generic options for manipulating headers (for example,
21867 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
21868 of the original message that is included in the generated message when
21869 &%return_message%& is set. They do not apply to the generated message itself.
21870
21871 .vindex "&$sender_address$&"
21872 If the &(autoreply)& transport receives return code 2 from Exim when it submits
21873 the message, indicating that there were no recipients, it does not treat this
21874 as an error. This means that autoreplies sent to &$sender_address$& when this
21875 is empty (because the incoming message is a bounce message) do not cause
21876 problems. They are just discarded.
21877
21878
21879
21880 .section "Private options for autoreply" "SECID139"
21881 .cindex "options" "&(autoreply)& transport"
21882
21883 .option bcc autoreply string&!! unset
21884 This specifies the addresses that are to receive &"blind carbon copies"& of the
21885 message when the message is specified by the transport.
21886
21887
21888 .option cc autoreply string&!! unset
21889 This specifies recipients of the message and the contents of the &'Cc:'& header
21890 when the message is specified by the transport.
21891
21892
21893 .option file autoreply string&!! unset
21894 The contents of the file are sent as the body of the message when the message
21895 is specified by the transport. If both &%file%& and &%text%& are set, the text
21896 string comes first.
21897
21898
21899 .option file_expand autoreply boolean false
21900 If this is set, the contents of the file named by the &%file%& option are
21901 subjected to string expansion as they are added to the message.
21902
21903
21904 .option file_optional autoreply boolean false
21905 If this option is true, no error is generated if the file named by the &%file%&
21906 option or passed with the address does not exist or cannot be read.
21907
21908
21909 .option from autoreply string&!! unset
21910 This specifies the contents of the &'From:'& header when the message is
21911 specified by the transport.
21912
21913
21914 .option headers autoreply string&!! unset
21915 This specifies additional RFC 2822 headers that are to be added to the message
21916 when the message is specified by the transport. Several can be given by using
21917 &"\n"& to separate them. There is no check on the format.
21918
21919
21920 .option log autoreply string&!! unset
21921 This option names a file in which a record of every message sent is logged when
21922 the message is specified by the transport.
21923
21924
21925 .option mode autoreply "octal integer" 0600
21926 If either the log file or the &"once"& file has to be created, this mode is
21927 used.
21928
21929
21930 .option never_mail autoreply "address list&!!" unset
21931 If any run of the transport creates a message with a recipient that matches any
21932 item in the list, that recipient is quietly discarded. If all recipients are
21933 discarded, no message is created. This applies both when the recipients are
21934 generated by a filter and when they are specified in the transport.
21935
21936
21937
21938 .option once autoreply string&!! unset
21939 This option names a file or DBM database in which a record of each &'To:'&
21940 recipient is kept when the message is specified by the transport. &*Note*&:
21941 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
21942
21943 If &%once%& is unset, or is set to an empty string, the message is always sent.
21944 By default, if &%once%& is set to a non-empty file name, the message
21945 is not sent if a potential recipient is already listed in the database.
21946 However, if the &%once_repeat%& option specifies a time greater than zero, the
21947 message is sent if that much time has elapsed since a message was last sent to
21948 this recipient. A setting of zero time for &%once_repeat%& (the default)
21949 prevents a message from being sent a second time &-- in this case, zero means
21950 infinity.
21951
21952 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
21953 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
21954 greater than zero, it changes the way Exim implements the &%once%& option.
21955 Instead of using a DBM file to record every recipient it sends to, it uses a
21956 regular file, whose size will never get larger than the given value.
21957
21958 In the file, Exim keeps a linear list of recipient addresses and the times at
21959 which they were sent messages. If the file is full when a new address needs to
21960 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
21961 means that a given recipient may receive multiple messages, but at
21962 unpredictable intervals that depend on the rate of turnover of addresses in the
21963 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
21964
21965
21966 .option once_file_size autoreply integer 0
21967 See &%once%& above.
21968
21969
21970 .option once_repeat autoreply time&!! 0s
21971 See &%once%& above.
21972 After expansion, the value of this option must be a valid time value.
21973
21974
21975 .option reply_to autoreply string&!! unset
21976 This specifies the contents of the &'Reply-To:'& header when the message is
21977 specified by the transport.
21978
21979
21980 .option return_message autoreply boolean false
21981 If this is set, a copy of the original message is returned with the new
21982 message, subject to the maximum size set in the &%return_size_limit%& global
21983 configuration option.
21984
21985
21986 .option subject autoreply string&!! unset
21987 This specifies the contents of the &'Subject:'& header when the message is
21988 specified by the transport. It is tempting to quote the original subject in
21989 automatic responses. For example:
21990 .code
21991 subject = Re: $h_subject:
21992 .endd
21993 There is a danger in doing this, however. It may allow a third party to
21994 subscribe your users to an opt-in mailing list, provided that the list accepts
21995 bounce messages as subscription confirmations. Well-managed lists require a
21996 non-bounce message to confirm a subscription, so the danger is relatively
21997 small.
21998
21999
22000
22001 .option text autoreply string&!! unset
22002 This specifies a single string to be used as the body of the message when the
22003 message is specified by the transport. If both &%text%& and &%file%& are set,
22004 the text comes first.
22005
22006
22007 .option to autoreply string&!! unset
22008 This specifies recipients of the message and the contents of the &'To:'& header
22009 when the message is specified by the transport.
22010 .ecindex IIDauttra1
22011 .ecindex IIDauttra2
22012
22013
22014
22015
22016 . ////////////////////////////////////////////////////////////////////////////
22017 . ////////////////////////////////////////////////////////////////////////////
22018
22019 .chapter "The lmtp transport" "CHAPLMTP"
22020 .cindex "transports" "&(lmtp)&"
22021 .cindex "&(lmtp)& transport"
22022 .cindex "LMTP" "over a pipe"
22023 .cindex "LMTP" "over a socket"
22024 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
22025 specified command
22026 or by interacting with a Unix domain socket.
22027 This transport is something of a cross between the &(pipe)& and &(smtp)&
22028 transports. Exim also has support for using LMTP over TCP/IP; this is
22029 implemented as an option for the &(smtp)& transport. Because LMTP is expected
22030 to be of minority interest, the default build-time configure in &_src/EDITME_&
22031 has it commented out. You need to ensure that
22032 .code
22033 TRANSPORT_LMTP=yes
22034 .endd
22035 .cindex "options" "&(lmtp)& transport"
22036 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
22037 included in the Exim binary. The private options of the &(lmtp)& transport are
22038 as follows:
22039
22040 .option batch_id lmtp string&!! unset
22041 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22042
22043
22044 .option batch_max lmtp integer 1
22045 This limits the number of addresses that can be handled in a single delivery.
22046 Most LMTP servers can handle several addresses at once, so it is normally a
22047 good idea to increase this value. See the description of local delivery
22048 batching in chapter &<<CHAPbatching>>&.
22049
22050
22051 .option command lmtp string&!! unset
22052 This option must be set if &%socket%& is not set. The string is a command which
22053 is run in a separate process. It is split up into a command name and list of
22054 arguments, each of which is separately expanded (so expansion cannot change the
22055 number of arguments). The command is run directly, not via a shell. The message
22056 is passed to the new process using the standard input and output to operate the
22057 LMTP protocol.
22058
22059 .option ignore_quota lmtp boolean false
22060 .cindex "LMTP" "ignoring quota errors"
22061 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
22062 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
22063 in its response to the LHLO command.
22064
22065 .option socket lmtp string&!! unset
22066 This option must be set if &%command%& is not set. The result of expansion must
22067 be the name of a Unix domain socket. The transport connects to the socket and
22068 delivers the message to it using the LMTP protocol.
22069
22070
22071 .option timeout lmtp time 5m
22072 The transport is aborted if the created process or Unix domain socket does not
22073 respond to LMTP commands or message input within this timeout. Delivery
22074 is deferred, and will be tried again later. Here is an example of a typical
22075 LMTP transport:
22076 .code
22077 lmtp:
22078   driver = lmtp
22079   command = /some/local/lmtp/delivery/program
22080   batch_max = 20
22081   user = exim
22082 .endd
22083 This delivers up to 20 addresses at a time, in a mixture of domains if
22084 necessary, running as the user &'exim'&.
22085
22086
22087
22088 . ////////////////////////////////////////////////////////////////////////////
22089 . ////////////////////////////////////////////////////////////////////////////
22090
22091 .chapter "The pipe transport" "CHAPpipetransport"
22092 .scindex IIDpiptra1 "transports" "&(pipe)&"
22093 .scindex IIDpiptra2 "&(pipe)& transport"
22094 The &(pipe)& transport is used to deliver messages via a pipe to a command
22095 running in another process. One example is the use of &(pipe)& as a
22096 pseudo-remote transport for passing messages to some other delivery mechanism
22097 (such as UUCP). Another is the use by individual users to automatically process
22098 their incoming messages. The &(pipe)& transport can be used in one of the
22099 following ways:
22100
22101 .ilist
22102 .vindex "&$local_part$&"
22103 A router routes one address to a transport in the normal way, and the
22104 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
22105 contains the local part of the address (as usual), and the command that is run
22106 is specified by the &%command%& option on the transport.
22107 .next
22108 .vindex "&$pipe_addresses$&"
22109 If the &%batch_max%& option is set greater than 1 (the default is 1), the
22110 transport can handle more than one address in a single run. In this case, when
22111 more than one address is routed to the transport, &$local_part$& is not set
22112 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
22113 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
22114 that are routed to the transport.
22115 .next
22116 .vindex "&$address_pipe$&"
22117 A router redirects an address directly to a pipe command (for example, from an
22118 alias or forward file). In this case, &$address_pipe$& contains the text of the
22119 pipe command, and the &%command%& option on the transport is ignored unless
22120 &%force_command%& is set. If only one address is being transported
22121 (&%batch_max%& is not greater than one, or only one address was redirected to
22122 this pipe command), &$local_part$& contains the local part that was redirected.
22123 .endlist
22124
22125
22126 The &(pipe)& transport is a non-interactive delivery method. Exim can also
22127 deliver messages over pipes using the LMTP interactive protocol. This is
22128 implemented by the &(lmtp)& transport.
22129
22130 In the case when &(pipe)& is run as a consequence of an entry in a local user's
22131 &_.forward_& file, the command runs under the uid and gid of that user. In
22132 other cases, the uid and gid have to be specified explicitly, either on the
22133 transport or on the router that handles the address. Current and &"home"&
22134 directories are also controllable. See chapter &<<CHAPenvironment>>& for
22135 details of the local delivery environment and chapter &<<CHAPbatching>>&
22136 for a discussion of local delivery batching.
22137
22138
22139 .section "Concurrent delivery" "SECID140"
22140 If two messages arrive at almost the same time, and both are routed to a pipe
22141 delivery, the two pipe transports may be run concurrently. You must ensure that
22142 any pipe commands you set up are robust against this happening. If the commands
22143 write to a file, the &%exim_lock%& utility might be of use.
22144
22145
22146
22147
22148 .section "Returned status and data" "SECID141"
22149 .cindex "&(pipe)& transport" "returned data"
22150 If the command exits with a non-zero return code, the delivery is deemed to
22151 have failed, unless either the &%ignore_status%& option is set (in which case
22152 the return code is treated as zero), or the return code is one of those listed
22153 in the &%temp_errors%& option, which are interpreted as meaning &"try again
22154 later"&. In this case, delivery is deferred. Details of a permanent failure are
22155 logged, but are not included in the bounce message, which merely contains
22156 &"local delivery failed"&.
22157
22158 If the command exits on a signal and the &%freeze_signal%& option is set then
22159 the message will be frozen in the queue. If that option is not set, a bounce
22160 will be sent as normal.
22161
22162 If the return code is greater than 128 and the command being run is a shell
22163 script, it normally means that the script was terminated by a signal whose
22164 value is the return code minus 128. The &%freeze_signal%& option does not
22165 apply in this case.
22166
22167 If Exim is unable to run the command (that is, if &[execve()]& fails), the
22168 return code is set to 127. This is the value that a shell returns if it is
22169 asked to run a non-existent command. The wording for the log line suggests that
22170 a non-existent command may be the problem.
22171
22172 The &%return_output%& option can affect the result of a pipe delivery. If it is
22173 set and the command produces any output on its standard output or standard
22174 error streams, the command is considered to have failed, even if it gave a zero
22175 return code or if &%ignore_status%& is set. The output from the command is
22176 included as part of the bounce message. The &%return_fail_output%& option is
22177 similar, except that output is returned only when the command exits with a
22178 failure return code, that is, a value other than zero or a code that matches
22179 &%temp_errors%&.
22180
22181
22182
22183 .section "How the command is run" "SECThowcommandrun"
22184 .cindex "&(pipe)& transport" "path for command"
22185 The command line is (by default) broken down into a command name and arguments
22186 by the &(pipe)& transport itself. The &%allow_commands%& and
22187 &%restrict_to_path%& options can be used to restrict the commands that may be
22188 run.
22189
22190 .cindex "quoting" "in pipe command"
22191 Unquoted arguments are delimited by white space. If an argument appears in
22192 double quotes, backslash is interpreted as an escape character in the usual
22193 way. If an argument appears in single quotes, no escaping is done.
22194
22195 String expansion is applied to the command line except when it comes from a
22196 traditional &_.forward_& file (commands from a filter file are expanded). The
22197 expansion is applied to each argument in turn rather than to the whole line.
22198 For this reason, any string expansion item that contains white space must be
22199 quoted so as to be contained within a single argument. A setting such as
22200 .code
22201 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
22202 .endd
22203 will not work, because the expansion item gets split between several
22204 arguments. You have to write
22205 .code
22206 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
22207 .endd
22208 to ensure that it is all in one argument. The expansion is done in this way,
22209 argument by argument, so that the number of arguments cannot be changed as a
22210 result of expansion, and quotes or backslashes in inserted variables do not
22211 interact with external quoting. However, this leads to problems if you want to
22212 generate multiple arguments (or the command name plus arguments) from a single
22213 expansion. In this situation, the simplest solution is to use a shell. For
22214 example:
22215 .code
22216 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
22217 .endd
22218
22219 .cindex "transport" "filter"
22220 .cindex "filter" "transport filter"
22221 .vindex "&$pipe_addresses$&"
22222 Special handling takes place when an argument consists of precisely the text
22223 &`$pipe_addresses`&. This is not a general expansion variable; the only
22224 place this string is recognized is when it appears as an argument for a pipe or
22225 transport filter command. It causes each address that is being handled to be
22226 inserted in the argument list at that point &'as a separate argument'&. This
22227 avoids any problems with spaces or shell metacharacters, and is of use when a
22228 &(pipe)& transport is handling groups of addresses in a batch.
22229
22230 If &%force_command%& is enabled on the transport, Special handling takes place
22231 for an argument that consists of precisely the text &`$address_pipe`&.  It
22232 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
22233 argument is inserted in the argument list at that point
22234 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
22235 the only item in the argument; in fact, if it were then &%force_command%&
22236 should behave as a no-op.  Rather, it should be used to adjust the command
22237 run while preserving the argument vector separation.
22238
22239 After splitting up into arguments and expansion, the resulting command is run
22240 in a subprocess directly from the transport, &'not'& under a shell. The
22241 message that is being delivered is supplied on the standard input, and the
22242 standard output and standard error are both connected to a single pipe that is
22243 read by Exim. The &%max_output%& option controls how much output the command
22244 may produce, and the &%return_output%& and &%return_fail_output%& options
22245 control what is done with it.
22246
22247 Not running the command under a shell (by default) lessens the security risks
22248 in cases when a command from a user's filter file is built out of data that was
22249 taken from an incoming message. If a shell is required, it can of course be
22250 explicitly specified as the command to be run. However, there are circumstances
22251 where existing commands (for example, in &_.forward_& files) expect to be run
22252 under a shell and cannot easily be modified. To allow for these cases, there is
22253 an option called &%use_shell%&, which changes the way the &(pipe)& transport
22254 works. Instead of breaking up the command line as just described, it expands it
22255 as a single string and passes the result to &_/bin/sh_&. The
22256 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
22257 with &%use_shell%&, and the whole mechanism is inherently less secure.
22258
22259
22260
22261 .section "Environment variables" "SECTpipeenv"
22262 .cindex "&(pipe)& transport" "environment for command"
22263 .cindex "environment for pipe transport"
22264 The environment variables listed below are set up when the command is invoked.
22265 This list is a compromise for maximum compatibility with other MTAs. Note that
22266 the &%environment%& option can be used to add additional variables to this
22267 environment.
22268 .display
22269 &`DOMAIN            `&   the domain of the address
22270 &`HOME              `&   the home directory, if set
22271 &`HOST              `&   the host name when called from a router (see below)
22272 &`LOCAL_PART        `&   see below
22273 &`LOCAL_PART_PREFIX `&   see below
22274 &`LOCAL_PART_SUFFIX `&   see below
22275 &`LOGNAME           `&   see below
22276 &`MESSAGE_ID        `&   Exim's local ID for the message
22277 &`PATH              `&   as specified by the &%path%& option below
22278 &`QUALIFY_DOMAIN    `&   the sender qualification domain
22279 &`RECIPIENT         `&   the complete recipient address
22280 &`SENDER            `&   the sender of the message (empty if a bounce)
22281 &`SHELL             `&   &`/bin/sh`&
22282 &`TZ                `&   the value of the &%timezone%& option, if set
22283 &`USER              `&   see below
22284 .endd
22285 When a &(pipe)& transport is called directly from (for example) an &(accept)&
22286 router, LOCAL_PART is set to the local part of the address. When it is
22287 called as a result of a forward or alias expansion, LOCAL_PART is set to
22288 the local part of the address that was expanded. In both cases, any affixes are
22289 removed from the local part, and made available in LOCAL_PART_PREFIX and
22290 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
22291 same value as LOCAL_PART for compatibility with other MTAs.
22292
22293 .cindex "HOST"
22294 HOST is set only when a &(pipe)& transport is called from a router that
22295 associates hosts with an address, typically when using &(pipe)& as a
22296 pseudo-remote transport. HOST is set to the first host name specified by
22297 the router.
22298
22299 .cindex "HOME"
22300 If the transport's generic &%home_directory%& option is set, its value is used
22301 for the HOME environment variable. Otherwise, a home directory may be set
22302 by the router's &%transport_home_directory%& option, which defaults to the
22303 user's home directory if &%check_local_user%& is set.
22304
22305
22306 .section "Private options for pipe" "SECID142"
22307 .cindex "options" "&(pipe)& transport"
22308
22309
22310
22311 .option allow_commands pipe "string list&!!" unset
22312 .cindex "&(pipe)& transport" "permitted commands"
22313 The string is expanded, and is then interpreted as a colon-separated list of
22314 permitted commands. If &%restrict_to_path%& is not set, the only commands
22315 permitted are those in the &%allow_commands%& list. They need not be absolute
22316 paths; the &%path%& option is still used for relative paths. If
22317 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
22318 in the &%allow_commands%& list, or a name without any slashes that is found on
22319 the path. In other words, if neither &%allow_commands%& nor
22320 &%restrict_to_path%& is set, there is no restriction on the command, but
22321 otherwise only commands that are permitted by one or the other are allowed. For
22322 example, if
22323 .code
22324 allow_commands = /usr/bin/vacation
22325 .endd
22326 and &%restrict_to_path%& is not set, the only permitted command is
22327 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
22328 &%use_shell%& is set.
22329
22330
22331 .option batch_id pipe string&!! unset
22332 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22333
22334
22335 .option batch_max pipe integer 1
22336 This limits the number of addresses that can be handled in a single delivery.
22337 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22338
22339
22340 .option check_string pipe string unset
22341 As &(pipe)& writes the message, the start of each line is tested for matching
22342 &%check_string%&, and if it does, the initial matching characters are replaced
22343 by the contents of &%escape_string%&, provided both are set. The value of
22344 &%check_string%& is a literal string, not a regular expression, and the case of
22345 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
22346 of &%check_string%& and &%escape_string%& are forced to values that implement
22347 the SMTP escaping protocol. Any settings made in the configuration file are
22348 ignored.
22349
22350
22351 .option command pipe string&!! unset
22352 This option need not be set when &(pipe)& is being used to deliver to pipes
22353 obtained directly from address redirections. In other cases, the option must be
22354 set, to provide a command to be run. It need not yield an absolute path (see
22355 the &%path%& option below). The command is split up into separate arguments by
22356 Exim, and each argument is separately expanded, as described in section
22357 &<<SECThowcommandrun>>& above.
22358
22359
22360 .option environment pipe string&!! unset
22361 .cindex "&(pipe)& transport" "environment for command"
22362 .cindex "environment for &(pipe)& transport"
22363 This option is used to add additional variables to the environment in which the
22364 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
22365 a string which is expanded, and then interpreted as a colon-separated list of
22366 environment settings of the form <&'name'&>=<&'value'&>.
22367
22368
22369 .option escape_string pipe string unset
22370 See &%check_string%& above.
22371
22372
22373 .option freeze_exec_fail pipe boolean false
22374 .cindex "exec failure"
22375 .cindex "failure of exec"
22376 .cindex "&(pipe)& transport" "failure of exec"
22377 Failure to exec the command in a pipe transport is by default treated like
22378 any other failure while running the command. However, if &%freeze_exec_fail%&
22379 is set, failure to exec is treated specially, and causes the message to be
22380 frozen, whatever the setting of &%ignore_status%&.
22381
22382
22383 .option freeze_signal pipe boolean false
22384 .cindex "signal exit"
22385 .cindex "&(pipe)& transport", "signal exit"
22386 Normally if the process run by a command in a pipe transport exits on a signal,
22387 a bounce message is sent. If &%freeze_signal%& is set, the message will be
22388 frozen in Exim's queue instead.
22389
22390
22391 .option force_command pipe boolean false
22392 .cindex "force command"
22393 .cindex "&(pipe)& transport", "force command"
22394 Normally when a router redirects an address directly to a pipe command
22395 the &%command%& option on the transport is ignored.  If &%force_command%&
22396 is set, the &%command%& option will used. This is especially
22397 useful for forcing a wrapper or additional argument to be added to the
22398 command. For example:
22399 .code
22400 command = /usr/bin/remote_exec myhost -- $address_pipe
22401 force_command
22402 .endd
22403
22404 Note that &$address_pipe$& is handled specially in &%command%& when
22405 &%force_command%& is set, expanding out to the original argument vector as
22406 separate items, similarly to a Unix shell &`"$@"`& construct.
22407
22408 .option ignore_status pipe boolean false
22409 If this option is true, the status returned by the subprocess that is set up to
22410 run the command is ignored, and Exim behaves as if zero had been returned.
22411 Otherwise, a non-zero status or termination by signal causes an error return
22412 from the transport unless the status value is one of those listed in
22413 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
22414
22415 &*Note*&: This option does not apply to timeouts, which do not return a status.
22416 See the &%timeout_defer%& option for how timeouts are handled.
22417
22418 .option log_defer_output pipe boolean false
22419 .cindex "&(pipe)& transport" "logging output"
22420 If this option is set, and the status returned by the command is
22421 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
22422 and any output was produced, the first line of it is written to the main log.
22423
22424
22425 .option log_fail_output pipe boolean false
22426 If this option is set, and the command returns any output, and also ends with a
22427 return code that is neither zero nor one of the return codes listed in
22428 &%temp_errors%& (that is, the delivery failed), the first line of output is
22429 written to the main log. This option and &%log_output%& are mutually exclusive.
22430 Only one of them may be set.
22431
22432
22433
22434 .option log_output pipe boolean false
22435 If this option is set and the command returns any output, the first line of
22436 output is written to the main log, whatever the return code. This option and
22437 &%log_fail_output%& are mutually exclusive. Only one of them may be set.
22438
22439
22440
22441 .option max_output pipe integer 20K
22442 This specifies the maximum amount of output that the command may produce on its
22443 standard output and standard error file combined. If the limit is exceeded, the
22444 process running the command is killed. This is intended as a safety measure to
22445 catch runaway processes. The limit is applied independently of the settings of
22446 the options that control what is done with such output (for example,
22447 &%return_output%&). Because of buffering effects, the amount of output may
22448 exceed the limit by a small amount before Exim notices.
22449
22450
22451 .option message_prefix pipe string&!! "see below"
22452 The string specified here is expanded and output at the start of every message.
22453 The default is unset if &%use_bsmtp%& is set. Otherwise it is
22454 .code
22455 message_prefix = \
22456   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
22457   ${tod_bsdinbox}\n
22458 .endd
22459 .cindex "Cyrus"
22460 .cindex "&%tmail%&"
22461 .cindex "&""From""& line"
22462 This is required by the commonly used &_/usr/bin/vacation_& program.
22463 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
22464 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
22465 setting
22466 .code
22467 message_prefix =
22468 .endd
22469 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22470 &`\n`& to &`\r\n`& in &%message_prefix%&.
22471
22472
22473 .option message_suffix pipe string&!! "see below"
22474 The string specified here is expanded and output at the end of every message.
22475 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
22476 The suffix can be suppressed by setting
22477 .code
22478 message_suffix =
22479 .endd
22480 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22481 &`\n`& to &`\r\n`& in &%message_suffix%&.
22482
22483
22484 .option path pipe string "see below"
22485 This option specifies the string that is set up in the PATH environment
22486 variable of the subprocess. The default is:
22487 .code
22488 /bin:/usr/bin
22489 .endd
22490 If the &%command%& option does not yield an absolute path name, the command is
22491 sought in the PATH directories, in the usual way. &*Warning*&: This does not
22492 apply to a command specified as a transport filter.
22493
22494
22495 .option permit_coredump pipe boolean false
22496 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
22497 a core-dump of a pipe command, enable this command.  This enables core-dumps
22498 during delivery and affects both the Exim binary and the pipe command run.
22499 It is recommended that this option remain off unless and until you have a need
22500 for it and that this only be enabled when needed, as the risk of excessive
22501 resource consumption can be quite high.  Note also that Exim is typically
22502 installed as a setuid binary and most operating systems will inhibit coredumps
22503 of these by default, so further OS-specific action may be required.
22504
22505
22506 .option pipe_as_creator pipe boolean false
22507 .cindex "uid (user id)" "local delivery"
22508 If the generic &%user%& option is not set and this option is true, the delivery
22509 process is run under the uid that was in force when Exim was originally called
22510 to accept the message. If the group id is not otherwise set (via the generic
22511 &%group%& option), the gid that was in force when Exim was originally called to
22512 accept the message is used.
22513
22514
22515 .option restrict_to_path pipe boolean false
22516 When this option is set, any command name not listed in &%allow_commands%& must
22517 contain no slashes. The command is searched for only in the directories listed
22518 in the &%path%& option. This option is intended for use in the case when a pipe
22519 command has been generated from a user's &_.forward_& file. This is usually
22520 handled by a &(pipe)& transport called &%address_pipe%&.
22521
22522
22523 .option return_fail_output pipe boolean false
22524 If this option is true, and the command produced any output and ended with a
22525 return code other than zero or one of the codes listed in &%temp_errors%& (that
22526 is, the delivery failed), the output is returned in the bounce message.
22527 However, if the message has a null sender (that is, it is itself a bounce
22528 message), output from the command is discarded. This option and
22529 &%return_output%& are mutually exclusive. Only one of them may be set.
22530
22531
22532
22533 .option return_output pipe boolean false
22534 If this option is true, and the command produced any output, the delivery is
22535 deemed to have failed whatever the return code from the command, and the output
22536 is returned in the bounce message. Otherwise, the output is just discarded.
22537 However, if the message has a null sender (that is, it is a bounce message),
22538 output from the command is always discarded, whatever the setting of this
22539 option. This option and &%return_fail_output%& are mutually exclusive. Only one
22540 of them may be set.
22541
22542
22543
22544 .option temp_errors pipe "string list" "see below"
22545 .cindex "&(pipe)& transport" "temporary failure"
22546 This option contains either a colon-separated list of numbers, or a single
22547 asterisk. If &%ignore_status%& is false
22548 and &%return_output%& is not set,
22549 and the command exits with a non-zero return code, the failure is treated as
22550 temporary and the delivery is deferred if the return code matches one of the
22551 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
22552 codes are treated as permanent errors. The default setting contains the codes
22553 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
22554 compiled on a system that does not define these macros, it assumes values of 75
22555 and 73, respectively.
22556
22557
22558 .option timeout pipe time 1h
22559 If the command fails to complete within this time, it is killed. This normally
22560 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
22561 specifies no timeout. In order to ensure that any subprocesses created by the
22562 command are also killed, Exim makes the initial process a process group leader,
22563 and kills the whole process group on a timeout. However, this can be defeated
22564 if one of the processes starts a new process group.
22565
22566 .option timeout_defer pipe boolean false
22567 A timeout in a &(pipe)& transport, either in the command that the transport
22568 runs, or in a transport filter that is associated with it, is by default
22569 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
22570 is set true, both kinds of timeout become temporary errors, causing the
22571 delivery to be deferred.
22572
22573 .option umask pipe "octal integer" 022
22574 This specifies the umask setting for the subprocess that runs the command.
22575
22576
22577 .option use_bsmtp pipe boolean false
22578 .cindex "envelope sender"
22579 If this option is set true, the &(pipe)& transport writes messages in &"batch
22580 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
22581 commands. If you want to include a leading HELO command with such messages,
22582 you can do so by setting the &%message_prefix%& option. See section
22583 &<<SECTbatchSMTP>>& for details of batch SMTP.
22584
22585 .option use_classresources pipe boolean false
22586 .cindex "class resources (BSD)"
22587 This option is available only when Exim is running on FreeBSD, NetBSD, or
22588 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
22589 resource limits when a &(pipe)& transport is run to perform a delivery. The
22590 limits for the uid under which the pipe is to run are obtained from the login
22591 class database.
22592
22593
22594 .option use_crlf pipe boolean false
22595 .cindex "carriage return"
22596 .cindex "linefeed"
22597 This option causes lines to be terminated with the two-character CRLF sequence
22598 (carriage return, linefeed) instead of just a linefeed character. In the case
22599 of batched SMTP, the byte sequence written to the pipe is then an exact image
22600 of what would be sent down a real SMTP connection.
22601
22602 The contents of the &%message_prefix%& and &%message_suffix%& options are
22603 written verbatim, so must contain their own carriage return characters if these
22604 are needed. When &%use_bsmtp%& is not set, the default values for both
22605 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
22606 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
22607
22608
22609 .option use_shell pipe boolean false
22610 .vindex "&$pipe_addresses$&"
22611 If this option is set, it causes the command to be passed to &_/bin/sh_&
22612 instead of being run directly from the transport, as described in section
22613 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
22614 where the command is expected to be run under a shell and cannot easily be
22615 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
22616 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
22617 command is expanded as a single string, and handed to &_/bin/sh_& as data for
22618 its &%-c%& option.
22619
22620
22621
22622 .section "Using an external local delivery agent" "SECID143"
22623 .cindex "local delivery" "using an external agent"
22624 .cindex "&'procmail'&"
22625 .cindex "external local delivery"
22626 .cindex "delivery" "&'procmail'&"
22627 .cindex "delivery" "by external agent"
22628 The &(pipe)& transport can be used to pass all messages that require local
22629 delivery to a separate local delivery agent such as &%procmail%&. When doing
22630 this, care must be taken to ensure that the pipe is run under an appropriate
22631 uid and gid. In some configurations one wants this to be a uid that is trusted
22632 by the delivery agent to supply the correct sender of the message. It may be
22633 necessary to recompile or reconfigure the delivery agent so that it trusts an
22634 appropriate user. The following is an example transport and router
22635 configuration for &%procmail%&:
22636 .code
22637 # transport
22638 procmail_pipe:
22639   driver = pipe
22640   command = /usr/local/bin/procmail -d $local_part
22641   return_path_add
22642   delivery_date_add
22643   envelope_to_add
22644   check_string = "From "
22645   escape_string = ">From "
22646   umask = 077
22647   user = $local_part
22648   group = mail
22649
22650 # router
22651 procmail:
22652   driver = accept
22653   check_local_user
22654   transport = procmail_pipe
22655 .endd
22656 In this example, the pipe is run as the local user, but with the group set to
22657 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
22658 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
22659 user to supply a correct sender address. If you do not specify either a
22660 &%group%& or a &%user%& option, the pipe command is run as the local user. The
22661 home directory is the user's home directory by default.
22662
22663 &*Note*&: The command that the pipe transport runs does &'not'& begin with
22664 .code
22665 IFS=" "
22666 .endd
22667 as shown in some &%procmail%& documentation, because Exim does not by default
22668 use a shell to run pipe commands.
22669
22670 .cindex "Cyrus"
22671 The next example shows a transport and a router for a system where local
22672 deliveries are handled by the Cyrus IMAP server.
22673 .code
22674 # transport
22675 local_delivery_cyrus:
22676   driver = pipe
22677   command = /usr/cyrus/bin/deliver \
22678             -m ${substr_1:$local_part_suffix} -- $local_part
22679   user = cyrus
22680   group = mail
22681   return_output
22682   log_output
22683   message_prefix =
22684   message_suffix =
22685
22686 # router
22687 local_user_cyrus:
22688   driver = accept
22689   check_local_user
22690   local_part_suffix = .*
22691   transport = local_delivery_cyrus
22692 .endd
22693 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
22694 &%return_output%& to cause any text written by Cyrus to be returned to the
22695 sender.
22696 .ecindex IIDpiptra1
22697 .ecindex IIDpiptra2
22698
22699
22700 . ////////////////////////////////////////////////////////////////////////////
22701 . ////////////////////////////////////////////////////////////////////////////
22702
22703 .chapter "The smtp transport" "CHAPsmtptrans"
22704 .scindex IIDsmttra1 "transports" "&(smtp)&"
22705 .scindex IIDsmttra2 "&(smtp)& transport"
22706 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
22707 or LMTP protocol. The list of hosts to try can either be taken from the address
22708 that is being processed (having been set up by the router), or specified
22709 explicitly for the transport. Timeout and retry processing (see chapter
22710 &<<CHAPretry>>&) is applied to each IP address independently.
22711
22712
22713 .section "Multiple messages on a single connection" "SECID144"
22714 The sending of multiple messages over a single TCP/IP connection can arise in
22715 two ways:
22716
22717 .ilist
22718 If a message contains more than &%max_rcpt%& (see below) addresses that are
22719 routed to the same host, more than one copy of the message has to be sent to
22720 that host. In this situation, multiple copies may be sent in a single run of
22721 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
22722 does when it has too many addresses to send in one message also depends on the
22723 value of the global &%remote_max_parallel%& option. Details are given in
22724 section &<<SECToutSMTPTCP>>&.)
22725 .next
22726 .cindex "hints database" "remembering routing"
22727 When a message has been successfully delivered over a TCP/IP connection, Exim
22728 looks in its hints database to see if there are any other messages awaiting a
22729 connection to the same host. If there are, a new delivery process is started
22730 for one of them, and the current TCP/IP connection is passed on to it. The new
22731 process may in turn send multiple copies and possibly create yet another
22732 process.
22733 .endlist
22734
22735
22736 For each copy sent over the same TCP/IP connection, a sequence counter is
22737 incremented, and if it ever gets to the value of &%connection_max_messages%&,
22738 no further messages are sent over that connection.
22739
22740
22741
22742 .section "Use of the $host and $host_address variables" "SECID145"
22743 .vindex "&$host$&"
22744 .vindex "&$host_address$&"
22745 At the start of a run of the &(smtp)& transport, the values of &$host$& and
22746 &$host_address$& are the name and IP address of the first host on the host list
22747 passed by the router. However, when the transport is about to connect to a
22748 specific host, and while it is connected to that host, &$host$& and
22749 &$host_address$& are set to the values for that host. These are the values
22750 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
22751 &%serialize_hosts%&, and the various TLS options are expanded.
22752
22753
22754 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
22755 .vindex &$tls_bits$&
22756 .vindex &$tls_cipher$&
22757 .vindex &$tls_peerdn$&
22758 .vindex &$tls_sni$&
22759 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
22760 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
22761 are the values that were set when the message was received.
22762 These are the values that are used for options that are expanded before any
22763 SMTP connections are made. Just before each connection is made, these four
22764 variables are emptied. If TLS is subsequently started, they are set to the
22765 appropriate values for the outgoing connection, and these are the values that
22766 are in force when any authenticators are run and when the
22767 &%authenticated_sender%& option is expanded.
22768
22769 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
22770 and will be removed in a future release.
22771
22772
22773 .section "Private options for smtp" "SECID146"
22774 .cindex "options" "&(smtp)& transport"
22775 The private options of the &(smtp)& transport are as follows:
22776
22777
22778 .option address_retry_include_sender smtp boolean true
22779 .cindex "4&'xx'& responses" "retrying after"
22780 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
22781 is the combination of sender and recipient that is delayed in subsequent queue
22782 runs until the retry time is reached. You can delay the recipient without
22783 reference to the sender (which is what earlier versions of Exim did), by
22784 setting &%address_retry_include_sender%& false. However, this can lead to
22785 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
22786
22787 .option allow_localhost smtp boolean false
22788 .cindex "local host" "sending to"
22789 .cindex "fallback" "hosts specified on transport"
22790 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
22791 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
22792 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
22793 the delivery anyway. This should be used only in special cases when the
22794 configuration ensures that no looping will result (for example, a differently
22795 configured Exim is listening on the port to which the message is sent).
22796
22797
22798 .option authenticated_sender smtp string&!! unset
22799 .cindex "Cyrus"
22800 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
22801 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
22802 overriding any existing authenticated sender value. If the string expansion is
22803 forced to fail, the option is ignored. Other expansion failures cause delivery
22804 to be deferred. If the result of expansion is an empty string, that is also
22805 ignored.
22806
22807 The expansion happens after the outgoing connection has been made and TLS
22808 started, if required. This means that the &$host$&, &$host_address$&,
22809 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
22810 particular connection.
22811
22812 If the SMTP session is not authenticated, the expansion of
22813 &%authenticated_sender%& still happens (and can cause the delivery to be
22814 deferred if it fails), but no AUTH= item is added to MAIL commands
22815 unless &%authenticated_sender_force%& is true.
22816
22817 This option allows you to use the &(smtp)& transport in LMTP mode to
22818 deliver mail to Cyrus IMAP and provide the proper local part as the
22819 &"authenticated sender"&, via a setting such as:
22820 .code
22821 authenticated_sender = $local_part
22822 .endd
22823 This removes the need for IMAP subfolders to be assigned special ACLs to
22824 allow direct delivery to those subfolders.
22825
22826 Because of expected uses such as that just described for Cyrus (when no
22827 domain is involved), there is no checking on the syntax of the provided
22828 value.
22829
22830
22831 .option authenticated_sender_force smtp boolean false
22832 If this option is set true, the &%authenticated_sender%& option's value
22833 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
22834 authenticated as a client.
22835
22836
22837 .option command_timeout smtp time 5m
22838 This sets a timeout for receiving a response to an SMTP command that has been
22839 sent out. It is also used when waiting for the initial banner line from the
22840 remote host. Its value must not be zero.
22841
22842
22843 .option connect_timeout smtp time 5m
22844 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
22845 to a remote host. A setting of zero allows the system timeout (typically
22846 several minutes) to act. To have any effect, the value of this option must be
22847 less than the system timeout. However, it has been observed that on some
22848 systems there is no system timeout, which is why the default value for this
22849 option is 5 minutes, a value recommended by RFC 1123.
22850
22851
22852 .option connection_max_messages smtp integer 500
22853 .cindex "SMTP" "passed connection"
22854 .cindex "SMTP" "multiple deliveries"
22855 .cindex "multiple SMTP deliveries"
22856 This controls the maximum number of separate message deliveries that are sent
22857 over a single TCP/IP connection. If the value is zero, there is no limit.
22858 For testing purposes, this value can be overridden by the &%-oB%& command line
22859 option.
22860
22861
22862 .option data_timeout smtp time 5m
22863 This sets a timeout for the transmission of each block in the data portion of
22864 the message. As a result, the overall timeout for a message depends on the size
22865 of the message. Its value must not be zero. See also &%final_timeout%&.
22866
22867
22868 .option delay_after_cutoff smtp boolean true
22869 This option controls what happens when all remote IP addresses for a given
22870 domain have been inaccessible for so long that they have passed their retry
22871 cutoff times.
22872
22873 In the default state, if the next retry time has not been reached for any of
22874 them, the address is bounced without trying any deliveries. In other words,
22875 Exim delays retrying an IP address after the final cutoff time until a new
22876 retry time is reached, and can therefore bounce an address without ever trying
22877 a delivery, when machines have been down for a long time. Some people are
22878 unhappy at this prospect, so...
22879
22880 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
22881 addresses are past their final cutoff time, Exim tries to deliver to those
22882 IP addresses that have not been tried since the message arrived. If there are
22883 none, of if they all fail, the address is bounced. In other words, it does not
22884 delay when a new message arrives, but immediately tries those expired IP
22885 addresses that haven't been tried since the message arrived. If there is a
22886 continuous stream of messages for the dead hosts, unsetting
22887 &%delay_after_cutoff%& means that there will be many more attempts to deliver
22888 to them.
22889
22890
22891 .option dns_qualify_single smtp boolean true
22892 If the &%hosts%& or &%fallback_hosts%& option is being used,
22893 and the &%gethostbyname%& option is false,
22894 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
22895 in chapter &<<CHAPdnslookup>>& for more details.
22896
22897
22898 .option dns_search_parents smtp boolean false
22899 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
22900 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
22901 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
22902 details.
22903
22904
22905 .option dnssec_request_domains smtp "domain list&!!" unset
22906 .cindex "MX record" "security"
22907 .cindex "DNSSEC" "MX lookup"
22908 .cindex "security" "MX lookup"
22909 .cindex "DNS" "DNSSEC"
22910 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
22911 the dnssec request bit set.
22912 This applies to all of the SRV, MX A6, AAAA, A lookup sequence.
22913
22914
22915
22916 .option dnssec_require_domains smtp "domain list&!!" unset
22917 .cindex "MX record" "security"
22918 .cindex "DNSSEC" "MX lookup"
22919 .cindex "security" "MX lookup"
22920 .cindex "DNS" "DNSSEC"
22921 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
22922 the dnssec request bit set.  Any returns not having the Authenticated Data bit
22923 (AD bit) set wil be ignored and logged as a host-lookup failure.
22924 This applies to all of the SRV, MX A6, AAAA, A lookup sequence.
22925
22926
22927
22928 .option dscp smtp string&!! unset
22929 .cindex "DCSP" "outbound"
22930 This option causes the DSCP value associated with a socket to be set to one
22931 of a number of fixed strings or to numeric value.
22932 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
22933 Common values include &`throughput`&, &`mincost`&, and on newer systems
22934 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
22935
22936 The outbound packets from Exim will be marked with this value in the header
22937 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
22938 that these values will have any effect, not be stripped by networking
22939 equipment, or do much of anything without cooperation with your Network
22940 Engineer and those of all network operators between the source and destination.
22941
22942
22943 .option fallback_hosts smtp "string list" unset
22944 .cindex "fallback" "hosts specified on transport"
22945 String expansion is not applied to this option. The argument must be a
22946 colon-separated list of host names or IP addresses, optionally also including
22947 port numbers, though the separator can be changed, as described in section
22948 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
22949 item in a &%route_list%& setting for the &(manualroute)& router, as described
22950 in section &<<SECTformatonehostitem>>&.
22951
22952 Fallback hosts can also be specified on routers, which associate them with the
22953 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
22954 &%fallback_hosts%& specified on the transport is used only if the address does
22955 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
22956 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
22957 However, &%hosts_randomize%& does apply to fallback host lists.
22958
22959 If Exim is unable to deliver to any of the hosts for a particular address, and
22960 the errors are not permanent rejections, the address is put on a separate
22961 transport queue with its host list replaced by the fallback hosts, unless the
22962 address was routed via MX records and the current host was in the original MX
22963 list. In that situation, the fallback host list is not used.
22964
22965 Once normal deliveries are complete, the fallback queue is delivered by
22966 re-running the same transports with the new host lists. If several failing
22967 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
22968 copy of the message is sent.
22969
22970 The resolution of the host names on the fallback list is controlled by the
22971 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
22972 both to cases when the host list comes with the address and when it is taken
22973 from &%hosts%&. This option provides a &"use a smart host only if delivery
22974 fails"& facility.
22975
22976
22977 .option final_timeout smtp time 10m
22978 This is the timeout that applies while waiting for the response to the final
22979 line containing just &"."& that terminates a message. Its value must not be
22980 zero.
22981
22982 .option gethostbyname smtp boolean false
22983 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
22984 being used, names are looked up using &[gethostbyname()]&
22985 (or &[getipnodebyname()]& when available)
22986 instead of using the DNS. Of course, that function may in fact use the DNS, but
22987 it may also consult other sources of information such as &_/etc/hosts_&.
22988
22989 .option gnutls_compat_mode smtp boolean unset
22990 This option controls whether GnuTLS is used in compatibility mode in an Exim
22991 server. This reduces security slightly, but improves interworking with older
22992 implementations of TLS.
22993
22994 .option helo_data smtp string&!! "see below"
22995 .cindex "HELO" "argument, setting"
22996 .cindex "EHLO" "argument, setting"
22997 .cindex "LHLO argument setting"
22998 The value of this option is expanded after a connection to a another host has
22999 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
23000 command that starts the outgoing SMTP or LMTP session. The default value of the
23001 option is:
23002 .code
23003 $primary_hostname
23004 .endd
23005 During the expansion, the variables &$host$& and &$host_address$& are set to
23006 the identity of the remote host, and the variables &$sending_ip_address$& and
23007 &$sending_port$& are set to the local IP address and port number that are being
23008 used. These variables can be used to generate different values for different
23009 servers or different local IP addresses. For example, if you want the string
23010 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
23011 interface address, you could use this:
23012 .code
23013 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
23014   {$primary_hostname}}
23015 .endd
23016 The use of &%helo_data%& applies both to sending messages and when doing
23017 callouts.
23018
23019 .option hosts smtp "string list&!!" unset
23020 Hosts are associated with an address by a router such as &(dnslookup)&, which
23021 finds the hosts by looking up the address domain in the DNS, or by
23022 &(manualroute)&, which has lists of hosts in its configuration. However,
23023 email addresses can be passed to the &(smtp)& transport by any router, and not
23024 all of them can provide an associated list of hosts.
23025
23026 The &%hosts%& option specifies a list of hosts to be used if the address being
23027 processed does not have any hosts associated with it. The hosts specified by
23028 &%hosts%& are also used, whether or not the address has its own hosts, if
23029 &%hosts_override%& is set.
23030
23031 The string is first expanded, before being interpreted as a colon-separated
23032 list of host names or IP addresses, possibly including port numbers. The
23033 separator may be changed to something other than colon, as described in section
23034 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
23035 item in a &%route_list%& setting for the &(manualroute)& router, as described
23036 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
23037 of the &(manualroute)& router is not available here.
23038
23039 If the expansion fails, delivery is deferred. Unless the failure was caused by
23040 the inability to complete a lookup, the error is logged to the panic log as
23041 well as the main log. Host names are looked up either by searching directly for
23042 address records in the DNS or by calling &[gethostbyname()]& (or
23043 &[getipnodebyname()]& when available), depending on the setting of the
23044 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
23045 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
23046 address are used.
23047
23048 During delivery, the hosts are tried in order, subject to their retry status,
23049 unless &%hosts_randomize%& is set.
23050
23051
23052 .option hosts_avoid_esmtp smtp "host list&!!" unset
23053 .cindex "ESMTP, avoiding use of"
23054 .cindex "HELO" "forcing use of"
23055 .cindex "EHLO" "avoiding use of"
23056 .cindex "PIPELINING" "avoiding the use of"
23057 This option is for use with broken hosts that announce ESMTP facilities (for
23058 example, PIPELINING) and then fail to implement them properly. When a host
23059 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
23060 start of the SMTP session. This means that it cannot use any of the ESMTP
23061 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
23062
23063
23064 .option hosts_avoid_pipelining smtp "host list&!!" unset
23065 .cindex "PIPELINING" "avoiding the use of"
23066 Exim will not use the SMTP PIPELINING extension when delivering to any host
23067 that matches this list, even if the server host advertises PIPELINING support.
23068
23069
23070 .option hosts_avoid_tls smtp "host list&!!" unset
23071 .cindex "TLS" "avoiding for certain hosts"
23072 Exim will not try to start a TLS session when delivering to any host that
23073 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
23074
23075 .option hosts_verify_avoid_tls smtp "host list&!!" *
23076 .cindex "TLS" "avoiding for certain hosts"
23077 Exim will not try to start a TLS session for a verify callout,
23078 or when delivering in cutthrough mode,
23079 to any host that matches this list.
23080 Note that the default is to not use TLS.
23081
23082
23083 .option hosts_max_try smtp integer 5
23084 .cindex "host" "maximum number to try"
23085 .cindex "limit" "number of hosts tried"
23086 .cindex "limit" "number of MX tried"
23087 .cindex "MX record" "maximum tried"
23088 This option limits the number of IP addresses that are tried for any one
23089 delivery in cases where there are temporary delivery errors. Section
23090 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
23091
23092
23093 .option hosts_max_try_hardlimit smtp integer 50
23094 This is an additional check on the maximum number of IP addresses that Exim
23095 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
23096 why it exists.
23097
23098
23099
23100 .option hosts_nopass_tls smtp "host list&!!" unset
23101 .cindex "TLS" "passing connection"
23102 .cindex "multiple SMTP deliveries"
23103 .cindex "TLS" "multiple message deliveries"
23104 For any host that matches this list, a connection on which a TLS session has
23105 been started will not be passed to a new delivery process for sending another
23106 message on the same connection. See section &<<SECTmulmessam>>& for an
23107 explanation of when this might be needed.
23108
23109
23110 .option hosts_override smtp boolean false
23111 If this option is set and the &%hosts%& option is also set, any hosts that are
23112 attached to the address are ignored, and instead the hosts specified by the
23113 &%hosts%& option are always used. This option does not apply to
23114 &%fallback_hosts%&.
23115
23116
23117 .option hosts_randomize smtp boolean false
23118 .cindex "randomized host list"
23119 .cindex "host" "list of; randomized"
23120 .cindex "fallback" "randomized hosts"
23121 If this option is set, and either the list of hosts is taken from the
23122 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
23123 were not obtained from MX records (this includes fallback hosts from the
23124 router), and were not randomized by the router, the order of trying the hosts
23125 is randomized each time the transport runs. Randomizing the order of a host
23126 list can be used to do crude load sharing.
23127
23128 When &%hosts_randomize%& is true, a host list may be split into groups whose
23129 order is separately randomized. This makes it possible to set up MX-like
23130 behaviour. The boundaries between groups are indicated by an item that is just
23131 &`+`& in the host list. For example:
23132 .code
23133 hosts = host1:host2:host3:+:host4:host5
23134 .endd
23135 The order of the first three hosts and the order of the last two hosts is
23136 randomized for each use, but the first three always end up before the last two.
23137 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
23138
23139 .option hosts_require_auth smtp "host list&!!" unset
23140 .cindex "authentication" "required by client"
23141 This option provides a list of servers for which authentication must succeed
23142 before Exim will try to transfer a message. If authentication fails for
23143 servers which are not in this list, Exim tries to send unauthenticated. If
23144 authentication fails for one of these servers, delivery is deferred. This
23145 temporary error is detectable in the retry rules, so it can be turned into a
23146 hard failure if required. See also &%hosts_try_auth%&, and chapter
23147 &<<CHAPSMTPAUTH>>& for details of authentication.
23148
23149
23150 .option hosts_request_ocsp smtp "host list&!!" *
23151 .cindex "TLS" "requiring for certain servers"
23152 Exim will request a Certificate Status on a
23153 TLS session for any host that matches this list.
23154 &%tls_verify_certificates%& should also be set for the transport.
23155
23156 .option hosts_require_ocsp smtp "host list&!!" unset
23157 .cindex "TLS" "requiring for certain servers"
23158 Exim will request, and check for a valid Certificate Status being given, on a
23159 TLS session for any host that matches this list.
23160 &%tls_verify_certificates%& should also be set for the transport.
23161
23162 .option hosts_require_tls smtp "host list&!!" unset
23163 .cindex "TLS" "requiring for certain servers"
23164 Exim will insist on using a TLS session when delivering to any host that
23165 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
23166 &*Note*&: This option affects outgoing mail only. To insist on TLS for
23167 incoming messages, use an appropriate ACL.
23168
23169 .option hosts_try_auth smtp "host list&!!" unset
23170 .cindex "authentication" "optional in client"
23171 This option provides a list of servers to which, provided they announce
23172 authentication support, Exim will attempt to authenticate as a client when it
23173 connects. If authentication fails, Exim will try to transfer the message
23174 unauthenticated. See also &%hosts_require_auth%&, and chapter
23175 &<<CHAPSMTPAUTH>>& for details of authentication.
23176
23177 .option hosts_try_prdr smtp "host list&!!" *
23178 .cindex "PRDR" "enabling, optional in client"
23179 This option provides a list of servers to which, provided they announce
23180 PRDR support, Exim will attempt to negotiate PRDR
23181 for multi-recipient messages.
23182 The option can usually be left as default.
23183
23184 .option interface smtp "string list&!!" unset
23185 .cindex "bind IP address"
23186 .cindex "IP address" "binding"
23187 .vindex "&$host$&"
23188 .vindex "&$host_address$&"
23189 This option specifies which interface to bind to when making an outgoing SMTP
23190 call. The value is an IP address, not an interface name such as
23191 &`eth0`&. Do not confuse this with the interface address that was used when a
23192 message was received, which is in &$received_ip_address$&, formerly known as
23193 &$interface_address$&. The name was changed to minimize confusion with the
23194 outgoing interface address. There is no variable that contains an outgoing
23195 interface address because, unless it is set by this option, its value is
23196 unknown.
23197
23198 During the expansion of the &%interface%& option the variables &$host$& and
23199 &$host_address$& refer to the host to which a connection is about to be made
23200 during the expansion of the string. Forced expansion failure, or an empty
23201 string result causes the option to be ignored. Otherwise, after expansion, the
23202 string must be a list of IP addresses, colon-separated by default, but the
23203 separator can be changed in the usual way. For example:
23204 .code
23205 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
23206 .endd
23207 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
23208 connection. If none of them are the correct type, the option is ignored. If
23209 &%interface%& is not set, or is ignored, the system's IP functions choose which
23210 interface to use if the host has more than one.
23211
23212
23213 .option keepalive smtp boolean true
23214 .cindex "keepalive" "on outgoing connection"
23215 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
23216 connections. When set, it causes the kernel to probe idle connections
23217 periodically, by sending packets with &"old"& sequence numbers. The other end
23218 of the connection should send a acknowledgment if the connection is still okay
23219 or a reset if the connection has been aborted. The reason for doing this is
23220 that it has the beneficial effect of freeing up certain types of connection
23221 that can get stuck when the remote host is disconnected without tidying up the
23222 TCP/IP call properly. The keepalive mechanism takes several hours to detect
23223 unreachable hosts.
23224
23225
23226 .option lmtp_ignore_quota smtp boolean false
23227 .cindex "LMTP" "ignoring quota errors"
23228 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
23229 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
23230 has advertised support for IGNOREQUOTA in its response to the LHLO command.
23231
23232 .option max_rcpt smtp integer 100
23233 .cindex "RCPT" "maximum number of outgoing"
23234 This option limits the number of RCPT commands that are sent in a single
23235 SMTP message transaction. Each set of addresses is treated independently, and
23236 so can cause parallel connections to the same host if &%remote_max_parallel%&
23237 permits this.
23238
23239
23240 .option multi_domain smtp boolean&!! true
23241 .vindex "&$domain$&"
23242 When this option is set, the &(smtp)& transport can handle a number of
23243 addresses containing a mixture of different domains provided they all resolve
23244 to the same list of hosts. Turning the option off restricts the transport to
23245 handling only one domain at a time. This is useful if you want to use
23246 &$domain$& in an expansion for the transport, because it is set only when there
23247 is a single domain involved in a remote delivery.
23248
23249 It is expanded per-address and can depend on any of
23250 &$address_data$&, &$domain_data$&, &$local_part_data$&,
23251 &$host$&, &$host_address$& and &$host_port$&.
23252
23253 .option port smtp string&!! "see below"
23254 .cindex "port" "sending TCP/IP"
23255 .cindex "TCP/IP" "setting outgoing port"
23256 This option specifies the TCP/IP port on the server to which Exim connects.
23257 &*Note:*& Do not confuse this with the port that was used when a message was
23258 received, which is in &$received_port$&, formerly known as &$interface_port$&.
23259 The name was changed to minimize confusion with the outgoing port. There is no
23260 variable that contains an outgoing port.
23261
23262 If the value of this option begins with a digit it is taken as a port number;
23263 otherwise it is looked up using &[getservbyname()]&. The default value is
23264 normally &"smtp"&, but if &%protocol%& is set to &"lmtp"&, the default is
23265 &"lmtp"&. If the expansion fails, or if a port number cannot be found, delivery
23266 is deferred.
23267
23268
23269
23270 .option protocol smtp string smtp
23271 .cindex "LMTP" "over TCP/IP"
23272 .cindex "ssmtp protocol" "outbound"
23273 .cindex "TLS" "SSL-on-connect outbound"
23274 .vindex "&$port$&"
23275 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
23276 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
23277 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
23278 deliveries into closed message stores. Exim also has support for running LMTP
23279 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
23280
23281 If this option is set to &"smtps"&, the default vaule for the &%port%& option
23282 changes to &"smtps"&, and the transport initiates TLS immediately after
23283 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
23284 The Internet standards bodies strongly discourage use of this mode.
23285
23286
23287 .option retry_include_ip_address smtp boolean&!! true
23288 Exim normally includes both the host name and the IP address in the key it
23289 constructs for indexing retry data after a temporary delivery failure. This
23290 means that when one of several IP addresses for a host is failing, it gets
23291 tried periodically (controlled by the retry rules), but use of the other IP
23292 addresses is not affected.
23293
23294 However, in some dialup environments hosts are assigned a different IP address
23295 each time they connect. In this situation the use of the IP address as part of
23296 the retry key leads to undesirable behaviour. Setting this option false causes
23297 Exim to use only the host name.
23298 Since it is expanded it can be made to depend on the host or domain.
23299
23300
23301 .option serialize_hosts smtp "host list&!!" unset
23302 .cindex "serializing connections"
23303 .cindex "host" "serializing connections"
23304 Because Exim operates in a distributed manner, if several messages for the same
23305 host arrive at around the same time, more than one simultaneous connection to
23306 the remote host can occur. This is not usually a problem except when there is a
23307 slow link between the hosts. In that situation it may be helpful to restrict
23308 Exim to one connection at a time. This can be done by setting
23309 &%serialize_hosts%& to match the relevant hosts.
23310
23311 .cindex "hints database" "serializing deliveries to a host"
23312 Exim implements serialization by means of a hints database in which a record is
23313 written whenever a process connects to one of the restricted hosts. The record
23314 is deleted when the connection is completed. Obviously there is scope for
23315 records to get left lying around if there is a system or program crash. To
23316 guard against this, Exim ignores any records that are more than six hours old.
23317
23318 If you set up this kind of serialization, you should also arrange to delete the
23319 relevant hints database whenever your system reboots. The names of the files
23320 start with &_misc_& and they are kept in the &_spool/db_& directory. There
23321 may be one or two files, depending on the type of DBM in use. The same files
23322 are used for ETRN serialization.
23323
23324
23325 .option size_addition smtp integer 1024
23326 .cindex "SMTP" "SIZE"
23327 .cindex "message" "size issue for transport filter"
23328 .cindex "size" "of message"
23329 .cindex "transport" "filter"
23330 .cindex "filter" "transport filter"
23331 If a remote SMTP server indicates that it supports the SIZE option of the
23332 MAIL command, Exim uses this to pass over the message size at the start of
23333 an SMTP transaction. It adds the value of &%size_addition%& to the value it
23334 sends, to allow for headers and other text that may be added during delivery by
23335 configuration options or in a transport filter. It may be necessary to increase
23336 this if a lot of text is added to messages.
23337
23338 Alternatively, if the value of &%size_addition%& is set negative, it disables
23339 the use of the SIZE option altogether.
23340
23341
23342 .option tls_certificate smtp string&!! unset
23343 .cindex "TLS" "client certificate, location of"
23344 .cindex "certificate" "client, location of"
23345 .vindex "&$host$&"
23346 .vindex "&$host_address$&"
23347 The value of this option must be the absolute path to a file which contains the
23348 client's certificate, for possible use when sending a message over an encrypted
23349 connection. The values of &$host$& and &$host_address$& are set to the name and
23350 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
23351 details of TLS.
23352
23353 &*Note*&: This option must be set if you want Exim to be able to use a TLS
23354 certificate when sending messages as a client. The global option of the same
23355 name specifies the certificate for Exim as a server; it is not automatically
23356 assumed that the same certificate should be used when Exim is operating as a
23357 client.
23358
23359
23360 .option tls_crl smtp string&!! unset
23361 .cindex "TLS" "client certificate revocation list"
23362 .cindex "certificate" "revocation list for client"
23363 This option specifies a certificate revocation list. The expanded value must
23364 be the name of a file that contains a CRL in PEM format.
23365
23366
23367 .option tls_dh_min_bits smtp integer 1024
23368 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
23369 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
23370 key agreement is negotiated, the server will provide a large prime number
23371 for use.  This option establishes the minimum acceptable size of that number.
23372 If the parameter offered by the server is too small, then the TLS handshake
23373 will fail.
23374
23375 Only supported when using GnuTLS.
23376
23377
23378 .option tls_privatekey smtp string&!! unset
23379 .cindex "TLS" "client private key, location of"
23380 .vindex "&$host$&"
23381 .vindex "&$host_address$&"
23382 The value of this option must be the absolute path to a file which contains the
23383 client's private key. This is used when sending a message over an encrypted
23384 connection using a client certificate. The values of &$host$& and
23385 &$host_address$& are set to the name and address of the server during the
23386 expansion. If this option is unset, or the expansion is forced to fail, or the
23387 result is an empty string, the private key is assumed to be in the same file as
23388 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
23389
23390
23391 .option tls_require_ciphers smtp string&!! unset
23392 .cindex "TLS" "requiring specific ciphers"
23393 .cindex "cipher" "requiring specific"
23394 .vindex "&$host$&"
23395 .vindex "&$host_address$&"
23396 The value of this option must be a list of permitted cipher suites, for use
23397 when setting up an outgoing encrypted connection. (There is a global option of
23398 the same name for controlling incoming connections.) The values of &$host$& and
23399 &$host_address$& are set to the name and address of the server during the
23400 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
23401 is used in different ways by OpenSSL and GnuTLS (see sections
23402 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
23403 ciphers is a preference order.
23404
23405
23406
23407 .option tls_sni smtp string&!! unset
23408 .cindex "TLS" "Server Name Indication"
23409 .vindex "&$tls_sni$&"
23410 If this option is set then it sets the $tls_out_sni variable and causes any
23411 TLS session to pass this value as the Server Name Indication extension to
23412 the remote side, which can be used by the remote side to select an appropriate
23413 certificate and private key for the session.
23414
23415 See &<<SECTtlssni>>& for more information.
23416
23417 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
23418 TLS extensions.
23419
23420
23421
23422
23423 .option tls_tempfail_tryclear smtp boolean true
23424 .cindex "4&'xx'& responses" "to STARTTLS"
23425 When the server host is not in &%hosts_require_tls%&, and there is a problem in
23426 setting up a TLS session, this option determines whether or not Exim should try
23427 to deliver the message unencrypted. If it is set false, delivery to the
23428 current host is deferred; if there are other hosts, they are tried. If this
23429 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
23430 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
23431 TLS negotiation fails, Exim closes the current connection (because it is in an
23432 unknown state), opens a new one to the same host, and then tries the delivery
23433 in clear.
23434
23435
23436 .option tls_try_verify_hosts smtp "host list&!!" *
23437 .cindex "TLS" "server certificate verification"
23438 .cindex "certificate" "verification of server"
23439 This option gives a list of hosts for which, on encrypted connections,
23440 certificate verification will be tried but need not succeed.
23441 The &%tls_verify_certificates%& option must also be set.
23442 Note that unless the host is in this list
23443 TLS connections will be denied to hosts using self-signed certificates
23444 when &%tls_verify_certificates%& is matched.
23445 The &$tls_out_certificate_verified$& variable is set when
23446 certificate verification succeeds.
23447
23448
23449 .option tls_verify_cert_hostnames smtp "host list&!!" *
23450 .cindex "TLS" "server certificate hostname verification"
23451 .cindex "certificate" "verification of server"
23452 This option give a list of hosts for which,
23453 while verifying the server certificate,
23454 checks will be included on the host name
23455 (note that this will generally be the result of a DNS MX lookup)
23456 versus Subject and Subject-Alternate-Name fields.  Wildcard names are permitted
23457 limited to being the initial component of a 3-or-more component FQDN.
23458
23459 There is no equivalent checking on client certificates.
23460
23461
23462 .option tls_verify_certificates smtp string&!! system
23463 .cindex "TLS" "server certificate verification"
23464 .cindex "certificate" "verification of server"
23465 .vindex "&$host$&"
23466 .vindex "&$host_address$&"
23467 The value of this option must be either the
23468 word "system"
23469 or the absolute path to
23470 a file or directory containing permitted certificates for servers,
23471 for use when setting up an encrypted connection.
23472
23473 The "system" value for the option will use a location compiled into the SSL library.
23474 This is not available for GnuTLS versions preceding 3.0.20; a value of "system"
23475 is taken as empty and an explicit location
23476 must be specified.
23477
23478 The use of a directory for the option value is not avilable for GnuTLS versions
23479 preceding 3.3.6 and a single file must be used.
23480
23481 With OpenSSL the certificates specified
23482 explicitly
23483 either by file or directory
23484 are added to those given by the system default location.
23485
23486 The values of &$host$& and
23487 &$host_address$& are set to the name and address of the server during the
23488 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
23489
23490 For back-compatability,
23491 if neither tls_verify_hosts nor tls_try_verify_hosts are set
23492 (a single-colon empty list counts as being set)
23493 and certificate verification fails the TLS connection is closed.
23494
23495
23496 .option tls_verify_hosts smtp "host list&!!" unset
23497 .cindex "TLS" "server certificate verification"
23498 .cindex "certificate" "verification of server"
23499 This option gives a list of hosts for which. on encrypted connections,
23500 certificate verification must succeed.
23501 The &%tls_verify_certificates%& option must also be set.
23502 If both this option and &%tls_try_verify_hosts%& are unset
23503 operation is as if this option selected all hosts.
23504
23505
23506
23507
23508 .section "How the limits for the number of hosts to try are used" &&&
23509          "SECTvalhosmax"
23510 .cindex "host" "maximum number to try"
23511 .cindex "limit" "hosts; maximum number tried"
23512 There are two options that are concerned with the number of hosts that are
23513 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
23514 &%hosts_max_try_hardlimit%&.
23515
23516
23517 The &%hosts_max_try%& option limits the number of hosts that are tried
23518 for a single delivery. However, despite the term &"host"& in its name, the
23519 option actually applies to each IP address independently. In other words, a
23520 multihomed host is treated as several independent hosts, just as it is for
23521 retrying.
23522
23523 Many of the larger ISPs have multiple MX records which often point to
23524 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
23525 created as a result of routing one of these domains.
23526
23527 Trying every single IP address on such a long list does not seem sensible; if
23528 several at the top of the list fail, it is reasonable to assume there is some
23529 problem that is likely to affect all of them. Roughly speaking, the value of
23530 &%hosts_max_try%& is the maximum number that are tried before deferring the
23531 delivery. However, the logic cannot be quite that simple.
23532
23533 Firstly, IP addresses that are skipped because their retry times have not
23534 arrived do not count, and in addition, addresses that are past their retry
23535 limits are also not counted, even when they are tried. This means that when
23536 some IP addresses are past their retry limits, more than the value of
23537 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
23538 that all IP addresses are considered before timing out an email address (but
23539 see below for an exception).
23540
23541 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
23542 list to see if there is a subsequent host with a different (higher valued) MX.
23543 If there is, that host is considered next, and the current IP address is used
23544 but not counted. This behaviour helps in the case of a domain with a retry rule
23545 that hardly ever delays any hosts, as is now explained:
23546
23547 Consider the case of a long list of hosts with one MX value, and a few with a
23548 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
23549 hosts at the top of the list are tried at first. With the default retry rule,
23550 which specifies increasing retry times, the higher MX hosts are eventually
23551 tried when those at the top of the list are skipped because they have not
23552 reached their retry times.
23553
23554 However, it is common practice to put a fixed short retry time on domains for
23555 large ISPs, on the grounds that their servers are rarely down for very long.
23556 Unfortunately, these are exactly the domains that tend to resolve to long lists
23557 of hosts. The short retry time means that the lowest MX hosts are tried every
23558 time. The attempts may be in a different order because of random sorting, but
23559 without the special MX check, the higher MX hosts would never be tried until
23560 all the lower MX hosts had timed out (which might be several days), because
23561 there are always some lower MX hosts that have reached their retry times. With
23562 the special check, Exim considers at least one IP address from each MX value at
23563 every delivery attempt, even if the &%hosts_max_try%& limit has already been
23564 reached.
23565
23566 The above logic means that &%hosts_max_try%& is not a hard limit, and in
23567 particular, Exim normally eventually tries all the IP addresses before timing
23568 out an email address. When &%hosts_max_try%& was implemented, this seemed a
23569 reasonable thing to do. Recently, however, some lunatic DNS configurations have
23570 been set up with hundreds of IP addresses for some domains. It can
23571 take a very long time indeed for an address to time out in these cases.
23572
23573 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
23574 Exim never tries more than this number of IP addresses; if it hits this limit
23575 and they are all timed out, the email address is bounced, even though not all
23576 possible IP addresses have been tried.
23577 .ecindex IIDsmttra1
23578 .ecindex IIDsmttra2
23579
23580
23581
23582
23583
23584 . ////////////////////////////////////////////////////////////////////////////
23585 . ////////////////////////////////////////////////////////////////////////////
23586
23587 .chapter "Address rewriting" "CHAPrewrite"
23588 .scindex IIDaddrew "rewriting" "addresses"
23589 There are some circumstances in which Exim automatically rewrites domains in
23590 addresses. The two most common are when an address is given without a domain
23591 (referred to as an &"unqualified address"&) or when an address contains an
23592 abbreviated domain that is expanded by DNS lookup.
23593
23594 Unqualified envelope addresses are accepted only for locally submitted
23595 messages, or for messages that are received from hosts matching
23596 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
23597 appropriate. Unqualified addresses in header lines are qualified if they are in
23598 locally submitted messages, or messages from hosts that are permitted to send
23599 unqualified envelope addresses. Otherwise, unqualified addresses in header
23600 lines are neither qualified nor rewritten.
23601
23602 One situation in which Exim does &'not'& automatically rewrite a domain is
23603 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
23604 such a domain should be rewritten using the &"canonical"& name, and some MTAs
23605 do this. The new RFCs do not contain this suggestion.
23606
23607
23608 .section "Explicitly configured address rewriting" "SECID147"
23609 This chapter describes the rewriting rules that can be used in the
23610 main rewrite section of the configuration file, and also in the generic
23611 &%headers_rewrite%& option that can be set on any transport.
23612
23613 Some people believe that configured address rewriting is a Mortal Sin.
23614 Others believe that life is not possible without it. Exim provides the
23615 facility; you do not have to use it.
23616
23617 The main rewriting rules that appear in the &"rewrite"& section of the
23618 configuration file are applied to addresses in incoming messages, both envelope
23619 addresses and addresses in header lines. Each rule specifies the types of
23620 address to which it applies.
23621
23622 Whether or not addresses in header lines are rewritten depends on the origin of
23623 the headers and the type of rewriting. Global rewriting, that is, rewriting
23624 rules from the rewrite section of the configuration file, is applied only to
23625 those headers that were received with the message. Header lines that are added
23626 by ACLs or by a system filter or by individual routers or transports (which
23627 are specific to individual recipient addresses) are not rewritten by the global
23628 rules.
23629
23630 Rewriting at transport time, by means of the &%headers_rewrite%& option,
23631 applies all headers except those added by routers and transports. That is, as
23632 well as the headers that were received with the message, it also applies to
23633 headers that were added by an ACL or a system filter.
23634
23635
23636 In general, rewriting addresses from your own system or domain has some
23637 legitimacy. Rewriting other addresses should be done only with great care and
23638 in special circumstances. The author of Exim believes that rewriting should be
23639 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
23640 Although it can sometimes be used as a routing tool, this is very strongly
23641 discouraged.
23642
23643 There are two commonly encountered circumstances where rewriting is used, as
23644 illustrated by these examples:
23645
23646 .ilist
23647 The company whose domain is &'hitch.fict.example'& has a number of hosts that
23648 exchange mail with each other behind a firewall, but there is only a single
23649 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
23650 &'hitch.fict.example'& when sending mail off-site.
23651 .next
23652 A host rewrites the local parts of its own users so that, for example,
23653 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
23654 .endlist
23655
23656
23657
23658 .section "When does rewriting happen?" "SECID148"
23659 .cindex "rewriting" "timing of"
23660 .cindex "&ACL;" "rewriting addresses in"
23661 Configured address rewriting can take place at several different stages of a
23662 message's processing.
23663
23664 .vindex "&$sender_address$&"
23665 At the start of an ACL for MAIL, the sender address may have been rewritten
23666 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
23667 ordinary rewrite rules have yet been applied. If, however, the sender address
23668 is verified in the ACL, it is rewritten before verification, and remains
23669 rewritten thereafter. The subsequent value of &$sender_address$& is the
23670 rewritten address. This also applies if sender verification happens in a
23671 RCPT ACL. Otherwise, when the sender address is not verified, it is
23672 rewritten as soon as a message's header lines have been received.
23673
23674 .vindex "&$domain$&"
23675 .vindex "&$local_part$&"
23676 Similarly, at the start of an ACL for RCPT, the current recipient's address
23677 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
23678 rewrite rules have yet been applied to it. However, the behaviour is different
23679 from the sender address when a recipient is verified. The address is rewritten
23680 for the verification, but the rewriting is not remembered at this stage. The
23681 value of &$local_part$& and &$domain$& after verification are always the same
23682 as they were before (that is, they contain the unrewritten &-- except for
23683 SMTP-time rewriting &-- address).
23684
23685 As soon as a message's header lines have been received, all the envelope
23686 recipient addresses are permanently rewritten, and rewriting is also applied to
23687 the addresses in the header lines (if configured). This happens before adding
23688 any header lines that were specified in MAIL or RCPT ACLs, and
23689 .cindex "&[local_scan()]& function" "address rewriting; timing of"
23690 before the DATA ACL and &[local_scan()]& functions are run.
23691
23692 When an address is being routed, either for delivery or for verification,
23693 rewriting is applied immediately to child addresses that are generated by
23694 redirection, unless &%no_rewrite%& is set on the router.
23695
23696 .cindex "envelope sender" "rewriting at transport time"
23697 .cindex "rewriting" "at transport time"
23698 .cindex "header lines" "rewriting at transport time"
23699 At transport time, additional rewriting of addresses in header lines can be
23700 specified by setting the generic &%headers_rewrite%& option on a transport.
23701 This option contains rules that are identical in form to those in the rewrite
23702 section of the configuration file. They are applied to the original message
23703 header lines and any that were added by ACLs or a system filter. They are not
23704 applied to header lines that are added by routers or the transport.
23705
23706 The outgoing envelope sender can be rewritten by means of the &%return_path%&
23707 transport option. However, it is not possible to rewrite envelope recipients at
23708 transport time.
23709
23710
23711
23712
23713 .section "Testing the rewriting rules that apply on input" "SECID149"
23714 .cindex "rewriting" "testing"
23715 .cindex "testing" "rewriting"
23716 Exim's input rewriting configuration appears in a part of the run time
23717 configuration file headed by &"begin rewrite"&. It can be tested by the
23718 &%-brw%& command line option. This takes an address (which can be a full RFC
23719 2822 address) as its argument. The output is a list of how the address would be
23720 transformed by the rewriting rules for each of the different places it might
23721 appear in an incoming message, that is, for each different header and for the
23722 envelope sender and recipient fields. For example,
23723 .code
23724 exim -brw ph10@exim.workshop.example
23725 .endd
23726 might produce the output
23727 .code
23728 sender: Philip.Hazel@exim.workshop.example
23729 from: Philip.Hazel@exim.workshop.example
23730 to: ph10@exim.workshop.example
23731 cc: ph10@exim.workshop.example
23732 bcc: ph10@exim.workshop.example
23733 reply-to: Philip.Hazel@exim.workshop.example
23734 env-from: Philip.Hazel@exim.workshop.example
23735 env-to: ph10@exim.workshop.example
23736 .endd
23737 which shows that rewriting has been set up for that address when used in any of
23738 the source fields, but not when it appears as a recipient address. At the
23739 present time, there is no equivalent way of testing rewriting rules that are
23740 set for a particular transport.
23741
23742
23743 .section "Rewriting rules" "SECID150"
23744 .cindex "rewriting" "rules"
23745 The rewrite section of the configuration file consists of lines of rewriting
23746 rules in the form
23747 .display
23748 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
23749 .endd
23750 Rewriting rules that are specified for the &%headers_rewrite%& generic
23751 transport option are given as a colon-separated list. Each item in the list
23752 takes the same form as a line in the main rewriting configuration (except that
23753 any colons must be doubled, of course).
23754
23755 The formats of source patterns and replacement strings are described below.
23756 Each is terminated by white space, unless enclosed in double quotes, in which
23757 case normal quoting conventions apply inside the quotes. The flags are single
23758 characters which may appear in any order. Spaces and tabs between them are
23759 ignored.
23760
23761 For each address that could potentially be rewritten, the rules are scanned in
23762 order, and replacements for the address from earlier rules can themselves be
23763 replaced by later rules (but see the &"q"& and &"R"& flags).
23764
23765 The order in which addresses are rewritten is undefined, may change between
23766 releases, and must not be relied on, with one exception: when a message is
23767 received, the envelope sender is always rewritten first, before any header
23768 lines are rewritten. For example, the replacement string for a rewrite of an
23769 address in &'To:'& must not assume that the message's address in &'From:'& has
23770 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
23771 that the envelope sender has already been rewritten.
23772
23773 .vindex "&$domain$&"
23774 .vindex "&$local_part$&"
23775 The variables &$local_part$& and &$domain$& can be used in the replacement
23776 string to refer to the address that is being rewritten. Note that lookup-driven
23777 rewriting can be done by a rule of the form
23778 .code
23779 *@*   ${lookup ...
23780 .endd
23781 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
23782 refer to the address that is being rewritten.
23783
23784
23785 .section "Rewriting patterns" "SECID151"
23786 .cindex "rewriting" "patterns"
23787 .cindex "address list" "in a rewriting pattern"
23788 The source pattern in a rewriting rule is any item which may appear in an
23789 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
23790 single-item address list, which means that it is expanded before being tested
23791 against the address. As always, if you use a regular expression as a pattern,
23792 you must take care to escape dollar and backslash characters, or use the &`\N`&
23793 facility to suppress string expansion within the regular expression.
23794
23795 Domains in patterns should be given in lower case. Local parts in patterns are
23796 case-sensitive. If you want to do case-insensitive matching of local parts, you
23797 can use a regular expression that starts with &`^(?i)`&.
23798
23799 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
23800 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
23801 depending on the type of match which occurred. These can be used in the
23802 replacement string to insert portions of the incoming address. &$0$& always
23803 refers to the complete incoming address. When a regular expression is used, the
23804 numerical variables are set from its capturing subexpressions. For other types
23805 of pattern they are set as follows:
23806
23807 .ilist
23808 If a local part or domain starts with an asterisk, the numerical variables
23809 refer to the character strings matched by asterisks, with &$1$& associated with
23810 the first asterisk, and &$2$& with the second, if present. For example, if the
23811 pattern
23812 .code
23813 *queen@*.fict.example
23814 .endd
23815 is matched against the address &'hearts-queen@wonderland.fict.example'& then
23816 .code
23817 $0 = hearts-queen@wonderland.fict.example
23818 $1 = hearts-
23819 $2 = wonderland
23820 .endd
23821 Note that if the local part does not start with an asterisk, but the domain
23822 does, it is &$1$& that contains the wild part of the domain.
23823
23824 .next
23825 If the domain part of the pattern is a partial lookup, the wild and fixed parts
23826 of the domain are placed in the next available numerical variables. Suppose,
23827 for example, that the address &'foo@bar.baz.example'& is processed by a
23828 rewriting rule of the form
23829 .display
23830 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
23831 .endd
23832 and the key in the file that matches the domain is &`*.baz.example`&. Then
23833 .code
23834 $1 = foo
23835 $2 = bar
23836 $3 = baz.example
23837 .endd
23838 If the address &'foo@baz.example'& is looked up, this matches the same
23839 wildcard file entry, and in this case &$2$& is set to the empty string, but
23840 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
23841 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
23842 whole domain. For non-partial domain lookups, no numerical variables are set.
23843 .endlist
23844
23845
23846 .section "Rewriting replacements" "SECID152"
23847 .cindex "rewriting" "replacements"
23848 If the replacement string for a rule is a single asterisk, addresses that
23849 match the pattern and the flags are &'not'& rewritten, and no subsequent
23850 rewriting rules are scanned. For example,
23851 .code
23852 hatta@lookingglass.fict.example  *  f
23853 .endd
23854 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
23855 &'From:'& headers.
23856
23857 .vindex "&$domain$&"
23858 .vindex "&$local_part$&"
23859 If the replacement string is not a single asterisk, it is expanded, and must
23860 yield a fully qualified address. Within the expansion, the variables
23861 &$local_part$& and &$domain$& refer to the address that is being rewritten.
23862 Any letters they contain retain their original case &-- they are not lower
23863 cased. The numerical variables are set up according to the type of pattern that
23864 matched the address, as described above. If the expansion is forced to fail by
23865 the presence of &"fail"& in a conditional or lookup item, rewriting by the
23866 current rule is abandoned, but subsequent rules may take effect. Any other
23867 expansion failure causes the entire rewriting operation to be abandoned, and an
23868 entry written to the panic log.
23869
23870
23871
23872 .section "Rewriting flags" "SECID153"
23873 There are three different kinds of flag that may appear on rewriting rules:
23874
23875 .ilist
23876 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
23877 c, f, h, r, s, t.
23878 .next
23879 A flag that specifies rewriting at SMTP time: S.
23880 .next
23881 Flags that control the rewriting process: Q, q, R, w.
23882 .endlist
23883
23884 For rules that are part of the &%headers_rewrite%& generic transport option,
23885 E, F, T, and S are not permitted.
23886
23887
23888
23889 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
23890          "SECID154"
23891 .cindex "rewriting" "flags"
23892 If none of the following flag letters, nor the &"S"& flag (see section
23893 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
23894 and to both the sender and recipient fields of the envelope, whereas a
23895 transport-time rewriting rule just applies to all headers. Otherwise, the
23896 rewriting rule is skipped unless the relevant addresses are being processed.
23897 .display
23898 &`E`&       rewrite all envelope fields
23899 &`F`&       rewrite the envelope From field
23900 &`T`&       rewrite the envelope To field
23901 &`b`&       rewrite the &'Bcc:'& header
23902 &`c`&       rewrite the &'Cc:'& header
23903 &`f`&       rewrite the &'From:'& header
23904 &`h`&       rewrite all headers
23905 &`r`&       rewrite the &'Reply-To:'& header
23906 &`s`&       rewrite the &'Sender:'& header
23907 &`t`&       rewrite the &'To:'& header
23908 .endd
23909 "All headers" means all of the headers listed above that can be selected
23910 individually, plus their &'Resent-'& versions. It does not include
23911 other headers such as &'Subject:'& etc.
23912
23913 You should be particularly careful about rewriting &'Sender:'& headers, and
23914 restrict this to special known cases in your own domains.
23915
23916
23917 .section "The SMTP-time rewriting flag" "SECTrewriteS"
23918 .cindex "SMTP" "rewriting malformed addresses"
23919 .cindex "RCPT" "rewriting argument of"
23920 .cindex "MAIL" "rewriting argument of"
23921 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
23922 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
23923 before any other processing; even before syntax checking. The pattern is
23924 required to be a regular expression, and it is matched against the whole of the
23925 data for the command, including any surrounding angle brackets.
23926
23927 .vindex "&$domain$&"
23928 .vindex "&$local_part$&"
23929 This form of rewrite rule allows for the handling of addresses that are not
23930 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
23931 input). Because the input is not required to be a syntactically valid address,
23932 the variables &$local_part$& and &$domain$& are not available during the
23933 expansion of the replacement string. The result of rewriting replaces the
23934 original address in the MAIL or RCPT command.
23935
23936
23937 .section "Flags controlling the rewriting process" "SECID155"
23938 There are four flags which control the way the rewriting process works. These
23939 take effect only when a rule is invoked, that is, when the address is of the
23940 correct type (matches the flags) and matches the pattern:
23941
23942 .ilist
23943 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
23944 unqualified local part. It is qualified with &%qualify_recipient%&. In the
23945 absence of &"Q"& the rewritten address must always include a domain.
23946 .next
23947 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
23948 even if no rewriting actually takes place because of a &"fail"& in the
23949 expansion. The &"q"& flag is not effective if the address is of the wrong type
23950 (does not match the flags) or does not match the pattern.
23951 .next
23952 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
23953 address, up to ten times. It can be combined with the &"q"& flag, to stop
23954 rewriting once it fails to match (after at least one successful rewrite).
23955 .next
23956 .cindex "rewriting" "whole addresses"
23957 When an address in a header is rewritten, the rewriting normally applies only
23958 to the working part of the address, with any comments and RFC 2822 &"phrase"&
23959 left unchanged. For example, rewriting might change
23960 .code
23961 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
23962 .endd
23963 into
23964 .code
23965 From: Ford Prefect <prefectf@hitch.fict.example>
23966 .endd
23967 .cindex "RFC 2047"
23968 Sometimes there is a need to replace the whole address item, and this can be
23969 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
23970 causes an address in a header line to be rewritten, the entire address is
23971 replaced, not just the working part. The replacement must be a complete RFC
23972 2822 address, including the angle brackets if necessary. If text outside angle
23973 brackets contains a character whose value is greater than 126 or less than 32
23974 (except for tab), the text is encoded according to RFC 2047. The character set
23975 is taken from &%headers_charset%&, which defaults to ISO-8859-1.
23976
23977 When the &"w"& flag is set on a rule that causes an envelope address to be
23978 rewritten, all but the working part of the replacement address is discarded.
23979 .endlist
23980
23981
23982 .section "Rewriting examples" "SECID156"
23983 Here is an example of the two common rewriting paradigms:
23984 .code
23985 *@*.hitch.fict.example  $1@hitch.fict.example
23986 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
23987                      {$value}fail}@hitch.fict.example bctfrF
23988 .endd
23989 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
23990 the string expansion to fail if the lookup does not succeed. In this context it
23991 has the effect of leaving the original address unchanged, but Exim goes on to
23992 consider subsequent rewriting rules, if any, because the &"q"& flag is not
23993 present in that rule. An alternative to &"fail"& would be to supply &$1$&
23994 explicitly, which would cause the rewritten address to be the same as before,
23995 at the cost of a small bit of processing. Not supplying either of these is an
23996 error, since the rewritten address would then contain no local part.
23997
23998 The first example above replaces the domain with a superior, more general
23999 domain. This may not be desirable for certain local parts. If the rule
24000 .code
24001 root@*.hitch.fict.example  *
24002 .endd
24003 were inserted before the first rule, rewriting would be suppressed for the
24004 local part &'root'& at any domain ending in &'hitch.fict.example'&.
24005
24006 Rewriting can be made conditional on a number of tests, by making use of
24007 &${if$& in the expansion item. For example, to apply a rewriting rule only to
24008 messages that originate outside the local host:
24009 .code
24010 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
24011                          {$1@hitch.fict.example}fail}"
24012 .endd
24013 The replacement string is quoted in this example because it contains white
24014 space.
24015
24016 .cindex "rewriting" "bang paths"
24017 .cindex "bang paths" "rewriting"
24018 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
24019 an address it treats it as an unqualified local part which it qualifies with
24020 the local qualification domain (if the source of the message is local or if the
24021 remote host is permitted to send unqualified addresses). Rewriting can
24022 sometimes be used to handle simple bang paths with a fixed number of
24023 components. For example, the rule
24024 .code
24025 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
24026 .endd
24027 rewrites a two-component bang path &'host.name!user'& as the domain address
24028 &'user@host.name'&. However, there is a security implication in using this as
24029 a global rewriting rule for envelope addresses. It can provide a backdoor
24030 method for using your system as a relay, because the incoming addresses appear
24031 to be local. If the bang path addresses are received via SMTP, it is safer to
24032 use the &"S"& flag to rewrite them as they are received, so that relay checking
24033 can be done on the rewritten addresses.
24034 .ecindex IIDaddrew
24035
24036
24037
24038
24039
24040 . ////////////////////////////////////////////////////////////////////////////
24041 . ////////////////////////////////////////////////////////////////////////////
24042
24043 .chapter "Retry configuration" "CHAPretry"
24044 .scindex IIDretconf1 "retry" "configuration, description of"
24045 .scindex IIDregconf2 "configuration file" "retry section"
24046 The &"retry"& section of the runtime configuration file contains a list of
24047 retry rules that control how often Exim tries to deliver messages that cannot
24048 be delivered at the first attempt. If there are no retry rules (the section is
24049 empty or not present), there are no retries. In this situation, temporary
24050 errors are treated as permanent. The default configuration contains a single,
24051 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
24052 line option can be used to test which retry rule will be used for a given
24053 address, domain and error.
24054
24055 The most common cause of retries is temporary failure to deliver to a remote
24056 host because the host is down, or inaccessible because of a network problem.
24057 Exim's retry processing in this case is applied on a per-host (strictly, per IP
24058 address) basis, not on a per-message basis. Thus, if one message has recently
24059 been delayed, delivery of a new message to the same host is not immediately
24060 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
24061 log selector is set, the message
24062 .cindex "retry" "time not reached"
24063 &"retry time not reached"& is written to the main log whenever a delivery is
24064 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
24065 the handling of errors during remote deliveries.
24066
24067 Retry processing applies to routing as well as to delivering, except as covered
24068 in the next paragraph. The retry rules do not distinguish between these
24069 actions. It is not possible, for example, to specify different behaviour for
24070 failures to route the domain &'snark.fict.example'& and failures to deliver to
24071 the host &'snark.fict.example'&. I didn't think anyone would ever need this
24072 added complication, so did not implement it. However, although they share the
24073 same retry rule, the actual retry times for routing and transporting a given
24074 domain are maintained independently.
24075
24076 When a delivery is not part of a queue run (typically an immediate delivery on
24077 receipt of a message), the routers are always run, and local deliveries are
24078 always attempted, even if retry times are set for them. This makes for better
24079 behaviour if one particular message is causing problems (for example, causing
24080 quota overflow, or provoking an error in a filter file). If such a delivery
24081 suffers a temporary failure, the retry data is updated as normal, and
24082 subsequent delivery attempts from queue runs occur only when the retry time for
24083 the local address is reached.
24084
24085 .section "Changing retry rules" "SECID157"
24086 If you change the retry rules in your configuration, you should consider
24087 whether or not to delete the retry data that is stored in Exim's spool area in
24088 files with names like &_db/retry_&. Deleting any of Exim's hints files is
24089 always safe; that is why they are called &"hints"&.
24090
24091 The hints retry data contains suggested retry times based on the previous
24092 rules. In the case of a long-running problem with a remote host, it might
24093 record the fact that the host has timed out. If your new rules increase the
24094 timeout time for such a host, you should definitely remove the old retry data
24095 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
24096 messages that it should now be retaining.
24097
24098
24099
24100 .section "Format of retry rules" "SECID158"
24101 .cindex "retry" "rules"
24102 Each retry rule occupies one line and consists of three or four parts,
24103 separated by white space: a pattern, an error name, an optional list of sender
24104 addresses, and a list of retry parameters. The pattern and sender lists must be
24105 enclosed in double quotes if they contain white space. The rules are searched
24106 in order until one is found where the pattern, error name, and sender list (if
24107 present) match the failing host or address, the error that occurred, and the
24108 message's sender, respectively.
24109
24110
24111 The pattern is any single item that may appear in an address list (see section
24112 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
24113 which means that it is expanded before being tested against the address that
24114 has been delayed. A negated address list item is permitted. Address
24115 list processing treats a plain domain name as if it were preceded by &"*@"&,
24116 which makes it possible for many retry rules to start with just a domain. For
24117 example,
24118 .code
24119 lookingglass.fict.example        *  F,24h,30m;
24120 .endd
24121 provides a rule for any address in the &'lookingglass.fict.example'& domain,
24122 whereas
24123 .code
24124 alice@lookingglass.fict.example  *  F,24h,30m;
24125 .endd
24126 applies only to temporary failures involving the local part &%alice%&.
24127 In practice, almost all rules start with a domain name pattern without a local
24128 part.
24129
24130 .cindex "regular expressions" "in retry rules"
24131 &*Warning*&: If you use a regular expression in a retry rule pattern, it
24132 must match a complete address, not just a domain, because that is how regular
24133 expressions work in address lists.
24134 .display
24135 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
24136 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
24137 .endd
24138
24139
24140 .section "Choosing which retry rule to use for address errors" "SECID159"
24141 When Exim is looking for a retry rule after a routing attempt has failed (for
24142 example, after a DNS timeout), each line in the retry configuration is tested
24143 against the complete address only if &%retry_use_local_part%& is set for the
24144 router. Otherwise, only the domain is used, except when matching against a
24145 regular expression, when the local part of the address is replaced with &"*"&.
24146 A domain on its own can match a domain pattern, or a pattern that starts with
24147 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
24148 &%check_local_user%& is true, and false for other routers.
24149
24150 Similarly, when Exim is looking for a retry rule after a local delivery has
24151 failed (for example, after a mailbox full error), each line in the retry
24152 configuration is tested against the complete address only if
24153 &%retry_use_local_part%& is set for the transport (it defaults true for all
24154 local transports).
24155
24156 .cindex "4&'xx'& responses" "retry rules for"
24157 However, when Exim is looking for a retry rule after a remote delivery attempt
24158 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
24159 whole address is always used as the key when searching the retry rules. The
24160 rule that is found is used to create a retry time for the combination of the
24161 failing address and the message's sender. It is the combination of sender and
24162 recipient that is delayed in subsequent queue runs until its retry time is
24163 reached. You can delay the recipient without regard to the sender by setting
24164 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
24165 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
24166 commands.
24167
24168
24169
24170 .section "Choosing which retry rule to use for host and message errors" &&&
24171          "SECID160"
24172 For a temporary error that is not related to an individual address (for
24173 example, a connection timeout), each line in the retry configuration is checked
24174 twice. First, the name of the remote host is used as a domain name (preceded by
24175 &"*@"& when matching a regular expression). If this does not match the line,
24176 the domain from the email address is tried in a similar fashion. For example,
24177 suppose the MX records for &'a.b.c.example'& are
24178 .code
24179 a.b.c.example  MX  5  x.y.z.example
24180                MX  6  p.q.r.example
24181                MX  7  m.n.o.example
24182 .endd
24183 and the retry rules are
24184 .code
24185 p.q.r.example    *      F,24h,30m;
24186 a.b.c.example    *      F,4d,45m;
24187 .endd
24188 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
24189 first rule matches neither the host nor the domain, so Exim looks at the second
24190 rule. This does not match the host, but it does match the domain, so it is used
24191 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
24192 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
24193 first retry rule is used, because it matches the host.
24194
24195 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
24196 first rule to determine retry times, but for all the other hosts for the domain
24197 &'a.b.c.example'&, the second rule is used. The second rule is also used if
24198 routing to &'a.b.c.example'& suffers a temporary failure.
24199
24200 &*Note*&: The host name is used when matching the patterns, not its IP address.
24201 However, if a message is routed directly to an IP address without the use of a
24202 host name, for example, if a &(manualroute)& router contains a setting such as:
24203 .code
24204 route_list = *.a.example  192.168.34.23
24205 .endd
24206 then the &"host name"& that is used when searching for a retry rule is the
24207 textual form of the IP address.
24208
24209 .section "Retry rules for specific errors" "SECID161"
24210 .cindex "retry" "specific errors; specifying"
24211 The second field in a retry rule is the name of a particular error, or an
24212 asterisk, which matches any error. The errors that can be tested for are:
24213
24214 .vlist
24215 .vitem &%auth_failed%&
24216 Authentication failed when trying to send to a host in the
24217 &%hosts_require_auth%& list in an &(smtp)& transport.
24218
24219 .vitem &%data_4xx%&
24220 A 4&'xx'& error was received for an outgoing DATA command, either immediately
24221 after the command, or after sending the message's data.
24222
24223 .vitem &%mail_4xx%&
24224 A 4&'xx'& error was received for an outgoing MAIL command.
24225
24226 .vitem &%rcpt_4xx%&
24227 A 4&'xx'& error was received for an outgoing RCPT command.
24228 .endlist
24229
24230 For the three 4&'xx'& errors, either the first or both of the x's can be given
24231 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
24232 recognize 452 errors given to RCPT commands for addresses in a certain domain,
24233 and have retries every ten minutes with a one-hour timeout, you could set up a
24234 retry rule of this form:
24235 .code
24236 the.domain.name  rcpt_452   F,1h,10m
24237 .endd
24238 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
24239 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
24240
24241 .vlist
24242 .vitem &%lost_connection%&
24243 A server unexpectedly closed the SMTP connection. There may, of course,
24244 legitimate reasons for this (host died, network died), but if it repeats a lot
24245 for the same host, it indicates something odd.
24246
24247 .vitem &%refused_MX%&
24248 A connection to a host obtained from an MX record was refused.
24249
24250 .vitem &%refused_A%&
24251 A connection to a host not obtained from an MX record was refused.
24252
24253 .vitem &%refused%&
24254 A connection was refused.
24255
24256 .vitem &%timeout_connect_MX%&
24257 A connection attempt to a host obtained from an MX record timed out.
24258
24259 .vitem &%timeout_connect_A%&
24260 A connection attempt to a host not obtained from an MX record timed out.
24261
24262 .vitem &%timeout_connect%&
24263 A connection attempt timed out.
24264
24265 .vitem &%timeout_MX%&
24266 There was a timeout while connecting or during an SMTP session with a host
24267 obtained from an MX record.
24268
24269 .vitem &%timeout_A%&
24270 There was a timeout while connecting or during an SMTP session with a host not
24271 obtained from an MX record.
24272
24273 .vitem &%timeout%&
24274 There was a timeout while connecting or during an SMTP session.
24275
24276 .vitem &%tls_required%&
24277 The server was required to use TLS (it matched &%hosts_require_tls%& in the
24278 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
24279 to STARTTLS, or there was a problem setting up the TLS connection.
24280
24281 .vitem &%quota%&
24282 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
24283 transport.
24284
24285 .vitem &%quota_%&<&'time'&>
24286 .cindex "quota" "error testing in retry rule"
24287 .cindex "retry" "quota error testing"
24288 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
24289 transport, and the mailbox has not been accessed for <&'time'&>. For example,
24290 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
24291 for four days.
24292 .endlist
24293
24294 .cindex "mailbox" "time of last read"
24295 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
24296 timeouts when the mailbox is full and is not being read by its owner. Ideally,
24297 it should be based on the last time that the user accessed the mailbox.
24298 However, it is not always possible to determine this. Exim uses the following
24299 heuristic rules:
24300
24301 .ilist
24302 If the mailbox is a single file, the time of last access (the &"atime"&) is
24303 used. As no new messages are being delivered (because the mailbox is over
24304 quota), Exim does not access the file, so this is the time of last user access.
24305 .next
24306 .cindex "maildir format" "time of last read"
24307 For a maildir delivery, the time of last modification of the &_new_&
24308 subdirectory is used. As the mailbox is over quota, no new files are created in
24309 the &_new_& subdirectory, because no new messages are being delivered. Any
24310 change to the &_new_& subdirectory is therefore assumed to be the result of an
24311 MUA moving a new message to the &_cur_& directory when it is first read. The
24312 time that is used is therefore the last time that the user read a new message.
24313 .next
24314 For other kinds of multi-file mailbox, the time of last access cannot be
24315 obtained, so a retry rule that uses this type of error field is never matched.
24316 .endlist
24317
24318 The quota errors apply both to system-enforced quotas and to Exim's own quota
24319 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
24320 when a local delivery is deferred because a partition is full (the ENOSPC
24321 error).
24322
24323
24324
24325 .section "Retry rules for specified senders" "SECID162"
24326 .cindex "retry" "rules; sender-specific"
24327 You can specify retry rules that apply only when the failing message has a
24328 specific sender. In particular, this can be used to define retry rules that
24329 apply only to bounce messages. The third item in a retry rule can be of this
24330 form:
24331 .display
24332 &`senders=`&<&'address list'&>
24333 .endd
24334 The retry timings themselves are then the fourth item. For example:
24335 .code
24336 *   rcpt_4xx   senders=:   F,1h,30m
24337 .endd
24338 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
24339 host. If the address list contains white space, it must be enclosed in quotes.
24340 For example:
24341 .code
24342 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
24343 .endd
24344 &*Warning*&: This facility can be unhelpful if it is used for host errors
24345 (which do not depend on the recipient). The reason is that the sender is used
24346 only to match the retry rule. Once the rule has been found for a host error,
24347 its contents are used to set a retry time for the host, and this will apply to
24348 all messages, not just those with specific senders.
24349
24350 When testing retry rules using &%-brt%&, you can supply a sender using the
24351 &%-f%& command line option, like this:
24352 .code
24353 exim -f "" -brt user@dom.ain
24354 .endd
24355 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
24356 list is never matched.
24357
24358
24359
24360
24361
24362 .section "Retry parameters" "SECID163"
24363 .cindex "retry" "parameters in rules"
24364 The third (or fourth, if a senders list is present) field in a retry rule is a
24365 sequence of retry parameter sets, separated by semicolons. Each set consists of
24366 .display
24367 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
24368 .endd
24369 The letter identifies the algorithm for computing a new retry time; the cutoff
24370 time is the time beyond which this algorithm no longer applies, and the
24371 arguments vary the algorithm's action. The cutoff time is measured from the
24372 time that the first failure for the domain (combined with the local part if
24373 relevant) was detected, not from the time the message was received.
24374
24375 .cindex "retry" "algorithms"
24376 .cindex "retry" "fixed intervals"
24377 .cindex "retry" "increasing intervals"
24378 .cindex "retry" "random intervals"
24379 The available algorithms are:
24380
24381 .ilist
24382 &'F'&: retry at fixed intervals. There is a single time parameter specifying
24383 the interval.
24384 .next
24385 &'G'&: retry at geometrically increasing intervals. The first argument
24386 specifies a starting value for the interval, and the second a multiplier, which
24387 is used to increase the size of the interval at each retry.
24388 .next
24389 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
24390 retry, the previous interval is multiplied by the factor in order to get a
24391 maximum for the next interval. The minimum interval is the first argument of
24392 the parameter, and an actual interval is chosen randomly between them. Such a
24393 rule has been found to be helpful in cluster configurations when all the
24394 members of the cluster restart at once, and may therefore synchronize their
24395 queue processing times.
24396 .endlist
24397
24398 When computing the next retry time, the algorithm definitions are scanned in
24399 order until one whose cutoff time has not yet passed is reached. This is then
24400 used to compute a new retry time that is later than the current time. In the
24401 case of fixed interval retries, this simply means adding the interval to the
24402 current time. For geometrically increasing intervals, retry intervals are
24403 computed from the rule's parameters until one that is greater than the previous
24404 interval is found. The main configuration variable
24405 .cindex "limit" "retry interval"
24406 .cindex "retry" "interval, maximum"
24407 .oindex "&%retry_interval_max%&"
24408 &%retry_interval_max%& limits the maximum interval between retries. It
24409 cannot be set greater than &`24h`&, which is its default value.
24410
24411 A single remote domain may have a number of hosts associated with it, and each
24412 host may have more than one IP address. Retry algorithms are selected on the
24413 basis of the domain name, but are applied to each IP address independently. If,
24414 for example, a host has two IP addresses and one is unusable, Exim will
24415 generate retry times for it and will not try to use it until its next retry
24416 time comes. Thus the good IP address is likely to be tried first most of the
24417 time.
24418
24419 .cindex "hints database" "use for retrying"
24420 Retry times are hints rather than promises. Exim does not make any attempt to
24421 run deliveries exactly at the computed times. Instead, a queue runner process
24422 starts delivery processes for delayed messages periodically, and these attempt
24423 new deliveries only for those addresses that have passed their next retry time.
24424 If a new message arrives for a deferred address, an immediate delivery attempt
24425 occurs only if the address has passed its retry time. In the absence of new
24426 messages, the minimum time between retries is the interval between queue runner
24427 processes. There is not much point in setting retry times of five minutes if
24428 your queue runners happen only once an hour, unless there are a significant
24429 number of incoming messages (which might be the case on a system that is
24430 sending everything to a smart host, for example).
24431
24432 The data in the retry hints database can be inspected by using the
24433 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
24434 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
24435 &'exinext'& utility script can be used to find out what the next retry times
24436 are for the hosts associated with a particular mail domain, and also for local
24437 deliveries that have been deferred.
24438
24439
24440 .section "Retry rule examples" "SECID164"
24441 Here are some example retry rules:
24442 .code
24443 alice@wonderland.fict.example quota_5d  F,7d,3h
24444 wonderland.fict.example       quota_5d
24445 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
24446 lookingglass.fict.example     *         F,24h,30m;
24447 *                 refused_A   F,2h,20m;
24448 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
24449 .endd
24450 The first rule sets up special handling for mail to
24451 &'alice@wonderland.fict.example'& when there is an over-quota error and the
24452 mailbox has not been read for at least 5 days. Retries continue every three
24453 hours for 7 days. The second rule handles over-quota errors for all other local
24454 parts at &'wonderland.fict.example'&; the absence of a local part has the same
24455 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
24456 fail are bounced immediately if the mailbox has not been read for at least 5
24457 days.
24458
24459 The third rule handles all other errors at &'wonderland.fict.example'&; retries
24460 happen every 15 minutes for an hour, then with geometrically increasing
24461 intervals until two days have passed since a delivery first failed. After the
24462 first hour there is a delay of one hour, then two hours, then four hours, and
24463 so on (this is a rather extreme example).
24464
24465 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
24466 They happen every 30 minutes for 24 hours only. The remaining two rules handle
24467 all other domains, with special action for connection refusal from hosts that
24468 were not obtained from an MX record.
24469
24470 The final rule in a retry configuration should always have asterisks in the
24471 first two fields so as to provide a general catch-all for any addresses that do
24472 not have their own special handling. This example tries every 15 minutes for 2
24473 hours, then with intervals starting at one hour and increasing by a factor of
24474 1.5 up to 16 hours, then every 8 hours up to 5 days.
24475
24476
24477
24478 .section "Timeout of retry data" "SECID165"
24479 .cindex "timeout" "of retry data"
24480 .oindex "&%retry_data_expire%&"
24481 .cindex "hints database" "data expiry"
24482 .cindex "retry" "timeout of data"
24483 Exim timestamps the data that it writes to its retry hints database. When it
24484 consults the data during a delivery it ignores any that is older than the value
24485 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
24486 been tried for 7 days, Exim will try to deliver to it immediately a message
24487 arrives, and if that fails, it will calculate a retry time as if it were
24488 failing for the first time.
24489
24490 This improves the behaviour for messages routed to rarely-used hosts such as MX
24491 backups. If such a host was down at one time, and happens to be down again when
24492 Exim tries a month later, using the old retry data would imply that it had been
24493 down all the time, which is not a justified assumption.
24494
24495 If a host really is permanently dead, this behaviour causes a burst of retries
24496 every now and again, but only if messages routed to it are rare. If there is a
24497 message at least once every 7 days the retry data never expires.
24498
24499
24500
24501
24502 .section "Long-term failures" "SECID166"
24503 .cindex "delivery failure, long-term"
24504 .cindex "retry" "after long-term failure"
24505 Special processing happens when an email address has been failing for so long
24506 that the cutoff time for the last algorithm is reached. For example, using the
24507 default retry rule:
24508 .code
24509 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
24510 .endd
24511 the cutoff time is four days. Reaching the retry cutoff is independent of how
24512 long any specific message has been failing; it is the length of continuous
24513 failure for the recipient address that counts.
24514
24515 When the cutoff time is reached for a local delivery, or for all the IP
24516 addresses associated with a remote delivery, a subsequent delivery failure
24517 causes Exim to give up on the address, and a bounce message is generated.
24518 In order to cater for new messages that use the failing address, a next retry
24519 time is still computed from the final algorithm, and is used as follows:
24520
24521 For local deliveries, one delivery attempt is always made for any subsequent
24522 messages. If this delivery fails, the address fails immediately. The
24523 post-cutoff retry time is not used.
24524
24525 If the delivery is remote, there are two possibilities, controlled by the
24526 .oindex "&%delay_after_cutoff%&"
24527 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
24528 default. Until the post-cutoff retry time for one of the IP addresses is
24529 reached, the failing email address is bounced immediately, without a delivery
24530 attempt taking place. After that time, one new delivery attempt is made to
24531 those IP addresses that are past their retry times, and if that still fails,
24532 the address is bounced and new retry times are computed.
24533
24534 In other words, when all the hosts for a given email address have been failing
24535 for a long time, Exim bounces rather then defers until one of the hosts' retry
24536 times is reached. Then it tries once, and bounces if that attempt fails. This
24537 behaviour ensures that few resources are wasted in repeatedly trying to deliver
24538 to a broken destination, but if the host does recover, Exim will eventually
24539 notice.
24540
24541 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
24542 addresses are past their final cutoff time, Exim tries to deliver to those IP
24543 addresses that have not been tried since the message arrived. If there are
24544 no suitable IP addresses, or if they all fail, the address is bounced. In other
24545 words, it does not delay when a new message arrives, but tries the expired
24546 addresses immediately, unless they have been tried since the message arrived.
24547 If there is a continuous stream of messages for the failing domains, setting
24548 &%delay_after_cutoff%& false means that there will be many more attempts to
24549 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
24550 true.
24551
24552 .section "Deliveries that work intermittently" "SECID167"
24553 .cindex "retry" "intermittently working deliveries"
24554 Some additional logic is needed to cope with cases where a host is
24555 intermittently available, or when a message has some attribute that prevents
24556 its delivery when others to the same address get through. In this situation,
24557 because some messages are successfully delivered, the &"retry clock"& for the
24558 host or address keeps getting reset by the successful deliveries, and so
24559 failing messages remain on the queue for ever because the cutoff time is never
24560 reached.
24561
24562 Two exceptional actions are applied to prevent this happening. The first
24563 applies to errors that are related to a message rather than a remote host.
24564 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
24565 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
24566 commands, and quota failures. For this type of error, if a message's arrival
24567 time is earlier than the &"first failed"& time for the error, the earlier time
24568 is used when scanning the retry rules to decide when to try next and when to
24569 time out the address.
24570
24571 The exceptional second action applies in all cases. If a message has been on
24572 the queue for longer than the cutoff time of any applicable retry rule for a
24573 given address, a delivery is attempted for that address, even if it is not yet
24574 time, and if this delivery fails, the address is timed out. A new retry time is
24575 not computed in this case, so that other messages for the same address are
24576 considered immediately.
24577 .ecindex IIDretconf1
24578 .ecindex IIDregconf2
24579
24580
24581
24582
24583
24584
24585 . ////////////////////////////////////////////////////////////////////////////
24586 . ////////////////////////////////////////////////////////////////////////////
24587
24588 .chapter "SMTP authentication" "CHAPSMTPAUTH"
24589 .scindex IIDauthconf1 "SMTP" "authentication configuration"
24590 .scindex IIDauthconf2 "authentication"
24591 The &"authenticators"& section of Exim's run time configuration is concerned
24592 with SMTP authentication. This facility is an extension to the SMTP protocol,
24593 described in RFC 2554, which allows a client SMTP host to authenticate itself
24594 to a server. This is a common way for a server to recognize clients that are
24595 permitted to use it as a relay. SMTP authentication is not of relevance to the
24596 transfer of mail between servers that have no managerial connection with each
24597 other.
24598
24599 .cindex "AUTH" "description of"
24600 Very briefly, the way SMTP authentication works is as follows:
24601
24602 .ilist
24603 The server advertises a number of authentication &'mechanisms'& in response to
24604 the client's EHLO command.
24605 .next
24606 The client issues an AUTH command, naming a specific mechanism. The command
24607 may, optionally, contain some authentication data.
24608 .next
24609 The server may issue one or more &'challenges'&, to which the client must send
24610 appropriate responses. In simple authentication mechanisms, the challenges are
24611 just prompts for user names and passwords. The server does not have to issue
24612 any challenges &-- in some mechanisms the relevant data may all be transmitted
24613 with the AUTH command.
24614 .next
24615 The server either accepts or denies authentication.
24616 .next
24617 If authentication succeeds, the client may optionally make use of the AUTH
24618 option on the MAIL command to pass an authenticated sender in subsequent
24619 mail transactions. Authentication lasts for the remainder of the SMTP
24620 connection.
24621 .next
24622 If authentication fails, the client may give up, or it may try a different
24623 authentication mechanism, or it may try transferring mail over the
24624 unauthenticated connection.
24625 .endlist
24626
24627 If you are setting up a client, and want to know which authentication
24628 mechanisms the server supports, you can use Telnet to connect to port 25 (the
24629 SMTP port) on the server, and issue an EHLO command. The response to this
24630 includes the list of supported mechanisms. For example:
24631 .display
24632 &`$ `&&*&`telnet server.example 25`&*&
24633 &`Trying 192.168.34.25...`&
24634 &`Connected to server.example.`&
24635 &`Escape character is &#x0027;^]&#x0027;.`&
24636 &`220 server.example ESMTP Exim 4.20 ...`&
24637 &*&`ehlo client.example`&*&
24638 &`250-server.example Hello client.example [10.8.4.5]`&
24639 &`250-SIZE 52428800`&
24640 &`250-PIPELINING`&
24641 &`250-AUTH PLAIN`&
24642 &`250 HELP`&
24643 .endd
24644 The second-last line of this example output shows that the server supports
24645 authentication using the PLAIN mechanism. In Exim, the different authentication
24646 mechanisms are configured by specifying &'authenticator'& drivers. Like the
24647 routers and transports, which authenticators are included in the binary is
24648 controlled by build-time definitions. The following are currently available,
24649 included by setting
24650 .code
24651 AUTH_CRAM_MD5=yes
24652 AUTH_CYRUS_SASL=yes
24653 AUTH_DOVECOT=yes
24654 AUTH_GSASL=yes
24655 AUTH_HEIMDAL_GSSAPI=yes
24656 AUTH_PLAINTEXT=yes
24657 AUTH_SPA=yes
24658 .endd
24659 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
24660 authentication mechanism (RFC 2195), and the second provides an interface to
24661 the Cyrus SASL authentication library.
24662 The third is an interface to Dovecot's authentication system, delegating the
24663 work via a socket interface.
24664 The fourth provides an interface to the GNU SASL authentication library, which
24665 provides mechanisms but typically not data sources.
24666 The fifth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
24667 supporting setting a server keytab.
24668 The sixth can be configured to support
24669 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
24670 not formally documented, but used by several MUAs. The seventh authenticator
24671 supports Microsoft's &'Secure Password Authentication'& mechanism.
24672
24673 The authenticators are configured using the same syntax as other drivers (see
24674 section &<<SECTfordricon>>&). If no authenticators are required, no
24675 authentication section need be present in the configuration file. Each
24676 authenticator can in principle have both server and client functions. When Exim
24677 is receiving SMTP mail, it is acting as a server; when it is sending out
24678 messages over SMTP, it is acting as a client. Authenticator configuration
24679 options are provided for use in both these circumstances.
24680
24681 To make it clear which options apply to which situation, the prefixes
24682 &%server_%& and &%client_%& are used on option names that are specific to
24683 either the server or the client function, respectively. Server and client
24684 functions are disabled if none of their options are set. If an authenticator is
24685 to be used for both server and client functions, a single definition, using
24686 both sets of options, is required. For example:
24687 .code
24688 cram:
24689   driver = cram_md5
24690   public_name = CRAM-MD5
24691   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
24692   client_name = ph10
24693   client_secret = secret2
24694 .endd
24695 The &%server_%& option is used when Exim is acting as a server, and the
24696 &%client_%& options when it is acting as a client.
24697
24698 Descriptions of the individual authenticators are given in subsequent chapters.
24699 The remainder of this chapter covers the generic options for the
24700 authenticators, followed by general discussion of the way authentication works
24701 in Exim.
24702
24703 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
24704 per-mechanism basis.  Please read carefully to determine which variables hold
24705 account labels such as usercodes and which hold passwords or other
24706 authenticating data.
24707
24708 Note that some mechanisms support two different identifiers for accounts: the
24709 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
24710 and &'authz'& are commonly encountered.  The American spelling is standard here.
24711 Conceptually, authentication data such as passwords are tied to the identifier
24712 used to authenticate; servers may have rules to permit one user to act as a
24713 second user, so that after login the session is treated as though that second
24714 user had logged in.  That second user is the &'authorization id'&.  A robust
24715 configuration might confirm that the &'authz'& field is empty or matches the
24716 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
24717 as verified data, the &'authz'& as an unverified request which the server might
24718 choose to honour.
24719
24720 A &'realm'& is a text string, typically a domain name, presented by a server
24721 to a client to help it select an account and credentials to use.  In some
24722 mechanisms, the client and server provably agree on the realm, but clients
24723 typically can not treat the realm as secure data to be blindly trusted.
24724
24725
24726
24727 .section "Generic options for authenticators" "SECID168"
24728 .cindex "authentication" "generic options"
24729 .cindex "options" "generic; for authenticators"
24730
24731 .option client_condition authenticators string&!! unset
24732 When Exim is authenticating as a client, it skips any authenticator whose
24733 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
24734 used, for example, to skip plain text authenticators when the connection is not
24735 encrypted by a setting such as:
24736 .code
24737 client_condition = ${if !eq{$tls_out_cipher}{}}
24738 .endd
24739
24740
24741 .option client_set_id authenticators string&!! unset
24742 When client authentication succeeds, this condition is expanded; the
24743 result is used in the log lines for outbound messasges.
24744 Typically it will be the user name used for authentication.
24745
24746
24747 .option driver authenticators string unset
24748 This option must always be set. It specifies which of the available
24749 authenticators is to be used.
24750
24751
24752 .option public_name authenticators string unset
24753 This option specifies the name of the authentication mechanism that the driver
24754 implements, and by which it is known to the outside world. These names should
24755 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
24756 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
24757 defaults to the driver's instance name.
24758
24759
24760 .option server_advertise_condition authenticators string&!! unset
24761 When a server is about to advertise an authentication mechanism, the condition
24762 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
24763 mechanism is not advertised.
24764 If the expansion fails, the mechanism is not advertised. If the failure was not
24765 forced, and was not caused by a lookup defer, the incident is logged.
24766 See section &<<SECTauthexiser>>& below for further discussion.
24767
24768
24769 .option server_condition authenticators string&!! unset
24770 This option must be set for a &%plaintext%& server authenticator, where it
24771 is used directly to control authentication. See section &<<SECTplainserver>>&
24772 for details.
24773
24774 For the &(gsasl)& authenticator, this option is required for various
24775 mechanisms; see chapter &<<CHAPgsasl>>& for details.
24776
24777 For the other authenticators, &%server_condition%& can be used as an additional
24778 authentication or authorization mechanism that is applied after the other
24779 authenticator conditions succeed. If it is set, it is expanded when the
24780 authenticator would otherwise return a success code. If the expansion is forced
24781 to fail, authentication fails. Any other expansion failure causes a temporary
24782 error code to be returned. If the result of a successful expansion is an empty
24783 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
24784 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
24785 other result, a temporary error code is returned, with the expanded string as
24786 the error text.
24787
24788
24789 .option server_debug_print authenticators string&!! unset
24790 If this option is set and authentication debugging is enabled (see the &%-d%&
24791 command line option), the string is expanded and included in the debugging
24792 output when the authenticator is run as a server. This can help with checking
24793 out the values of variables.
24794 If expansion of the string fails, the error message is written to the debugging
24795 output, and Exim carries on processing.
24796
24797
24798 .option server_set_id authenticators string&!! unset
24799 .vindex "&$authenticated_id$&"
24800 When an Exim server successfully authenticates a client, this string is
24801 expanded using data from the authentication, and preserved for any incoming
24802 messages in the variable &$authenticated_id$&. It is also included in the log
24803 lines for incoming messages. For example, a user/password authenticator
24804 configuration might preserve the user name that was used to authenticate, and
24805 refer to it subsequently during delivery of the message.
24806 If expansion fails, the option is ignored.
24807
24808
24809 .option server_mail_auth_condition authenticators string&!! unset
24810 This option allows a server to discard authenticated sender addresses supplied
24811 as part of MAIL commands in SMTP connections that are authenticated by the
24812 driver on which &%server_mail_auth_condition%& is set. The option is not used
24813 as part of the authentication process; instead its (unexpanded) value is
24814 remembered for later use.
24815 How it is used is described in the following section.
24816
24817
24818
24819
24820
24821 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
24822 .cindex "authentication" "sender; authenticated"
24823 .cindex "AUTH" "on MAIL command"
24824 When a client supplied an AUTH= item on a MAIL command, Exim applies
24825 the following checks before accepting it as the authenticated sender of the
24826 message:
24827
24828 .ilist
24829 If the connection is not using extended SMTP (that is, HELO was used rather
24830 than EHLO), the use of AUTH= is a syntax error.
24831 .next
24832 If the value of the AUTH= parameter is &"<>"&, it is ignored.
24833 .next
24834 .vindex "&$authenticated_sender$&"
24835 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
24836 running, the value of &$authenticated_sender$& is set to the value obtained
24837 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
24838 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
24839 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
24840 given for the MAIL command.
24841 .next
24842 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
24843 is accepted and placed in &$authenticated_sender$& only if the client has
24844 authenticated.
24845 .next
24846 If the AUTH= value was accepted by either of the two previous rules, and
24847 the client has authenticated, and the authenticator has a setting for the
24848 &%server_mail_auth_condition%&, the condition is checked at this point. The
24849 valued that was saved from the authenticator is expanded. If the expansion
24850 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
24851 &$authenticated_sender$& is deleted. If the expansion yields any other value,
24852 the value of &$authenticated_sender$& is retained and passed on with the
24853 message.
24854 .endlist
24855
24856
24857 When &$authenticated_sender$& is set for a message, it is passed on to other
24858 hosts to which Exim authenticates as a client. Do not confuse this value with
24859 &$authenticated_id$&, which is a string obtained from the authentication
24860 process, and which is not usually a complete email address.
24861
24862 .vindex "&$sender_address$&"
24863 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
24864 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
24865 therefore make use of &$authenticated_sender$&. The converse is not true: the
24866 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
24867 ACL is run.
24868
24869
24870
24871 .section "Authentication on an Exim server" "SECTauthexiser"
24872 .cindex "authentication" "on an Exim server"
24873 When Exim receives an EHLO command, it advertises the public names of those
24874 authenticators that are configured as servers, subject to the following
24875 conditions:
24876
24877 .ilist
24878 The client host must match &%auth_advertise_hosts%& (default *).
24879 .next
24880 It the &%server_advertise_condition%& option is set, its expansion must not
24881 yield the empty string, &"0"&, &"no"&, or &"false"&.
24882 .endlist
24883
24884 The order in which the authenticators are defined controls the order in which
24885 the mechanisms are advertised.
24886
24887 Some mail clients (for example, some versions of Netscape) require the user to
24888 provide a name and password for authentication whenever AUTH is advertised,
24889 even though authentication may not in fact be needed (for example, Exim may be
24890 set up to allow unconditional relaying from the client by an IP address check).
24891 You can make such clients more friendly by not advertising AUTH to them.
24892 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
24893 that runs for RCPT) to relay without authentication, you should set
24894 .code
24895 auth_advertise_hosts = ! 10.9.8.0/24
24896 .endd
24897 so that no authentication mechanisms are advertised to them.
24898
24899 The &%server_advertise_condition%& controls the advertisement of individual
24900 authentication mechanisms. For example, it can be used to restrict the
24901 advertisement of a particular mechanism to encrypted connections, by a setting
24902 such as:
24903 .code
24904 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
24905 .endd
24906 .vindex "&$tls_in_cipher$&"
24907 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
24908 yields &"yes"&, which allows the advertisement to happen.
24909
24910 When an Exim server receives an AUTH command from a client, it rejects it
24911 immediately if AUTH was not advertised in response to an earlier EHLO
24912 command. This is the case if
24913
24914 .ilist
24915 The client host does not match &%auth_advertise_hosts%&; or
24916 .next
24917 No authenticators are configured with server options; or
24918 .next
24919 Expansion of &%server_advertise_condition%& blocked the advertising of all the
24920 server authenticators.
24921 .endlist
24922
24923
24924 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
24925 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
24926 AUTH is accepted from any client host.
24927
24928 If AUTH is not rejected by the ACL, Exim searches its configuration for a
24929 server authentication mechanism that was advertised in response to EHLO and
24930 that matches the one named in the AUTH command. If it finds one, it runs
24931 the appropriate authentication protocol, and authentication either succeeds or
24932 fails. If there is no matching advertised mechanism, the AUTH command is
24933 rejected with a 504 error.
24934
24935 .vindex "&$received_protocol$&"
24936 .vindex "&$sender_host_authenticated$&"
24937 When a message is received from an authenticated host, the value of
24938 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
24939 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
24940 public name) of the authenticator driver that successfully authenticated the
24941 client from which the message was received. This variable is empty if there was
24942 no successful authentication.
24943
24944
24945
24946
24947 .section "Testing server authentication" "SECID169"
24948 .cindex "authentication" "testing a server"
24949 .cindex "AUTH" "testing a server"
24950 .cindex "base64 encoding" "creating authentication test data"
24951 Exim's &%-bh%& option can be useful for testing server authentication
24952 configurations. The data for the AUTH command has to be sent using base64
24953 encoding. A quick way to produce such data for testing is the following Perl
24954 script:
24955 .code
24956 use MIME::Base64;
24957 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
24958 .endd
24959 .cindex "binary zero" "in authentication data"
24960 This interprets its argument as a Perl string, and then encodes it. The
24961 interpretation as a Perl string allows binary zeros, which are required for
24962 some kinds of authentication, to be included in the data. For example, a
24963 command line to run this script on such data might be
24964 .code
24965 encode '\0user\0password'
24966 .endd
24967 Note the use of single quotes to prevent the shell interpreting the
24968 backslashes, so that they can be interpreted by Perl to specify characters
24969 whose code value is zero.
24970
24971 &*Warning 1*&: If either of the user or password strings starts with an octal
24972 digit, you must use three zeros instead of one after the leading backslash. If
24973 you do not, the octal digit that starts your string will be incorrectly
24974 interpreted as part of the code for the first character.
24975
24976 &*Warning 2*&: If there are characters in the strings that Perl interprets
24977 specially, you must use a Perl escape to prevent them being misinterpreted. For
24978 example, a command such as
24979 .code
24980 encode '\0user@domain.com\0pas$$word'
24981 .endd
24982 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
24983
24984 If you have the &%mimencode%& command installed, another way to do produce
24985 base64-encoded strings is to run the command
24986 .code
24987 echo -e -n `\0user\0password' | mimencode
24988 .endd
24989 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
24990 in the argument, and the &%-n%& option specifies no newline at the end of its
24991 output. However, not all versions of &%echo%& recognize these options, so you
24992 should check your version before relying on this suggestion.
24993
24994
24995
24996 .section "Authentication by an Exim client" "SECID170"
24997 .cindex "authentication" "on an Exim client"
24998 The &(smtp)& transport has two options called &%hosts_require_auth%& and
24999 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
25000 announces support for authentication, and the host matches an entry in either
25001 of these options, Exim (as a client) tries to authenticate as follows:
25002
25003 .ilist
25004 For each authenticator that is configured as a client, in the order in which
25005 they are defined in the configuration, it searches the authentication
25006 mechanisms announced by the server for one whose name matches the public name
25007 of the authenticator.
25008 .next
25009 .vindex "&$host$&"
25010 .vindex "&$host_address$&"
25011 When it finds one that matches, it runs the authenticator's client code. The
25012 variables &$host$& and &$host_address$& are available for any string expansions
25013 that the client might do. They are set to the server's name and IP address. If
25014 any expansion is forced to fail, the authentication attempt is abandoned, and
25015 Exim moves on to the next authenticator. Otherwise an expansion failure causes
25016 delivery to be deferred.
25017 .next
25018 If the result of the authentication attempt is a temporary error or a timeout,
25019 Exim abandons trying to send the message to the host for the moment. It will
25020 try again later. If there are any backup hosts available, they are tried in the
25021 usual way.
25022 .next
25023 If the response to authentication is a permanent error (5&'xx'& code), Exim
25024 carries on searching the list of authenticators and tries another one if
25025 possible. If all authentication attempts give permanent errors, or if there are
25026 no attempts because no mechanisms match (or option expansions force failure),
25027 what happens depends on whether the host matches &%hosts_require_auth%& or
25028 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
25029 delivery is deferred. The error can be detected in the retry rules, and thereby
25030 turned into a permanent error if you wish. In the second case, Exim tries to
25031 deliver the message unauthenticated.
25032 .endlist
25033
25034 .cindex "AUTH" "on MAIL command"
25035 When Exim has authenticated itself to a remote server, it adds the AUTH
25036 parameter to the MAIL commands it sends, if it has an authenticated sender for
25037 the message. If the message came from a remote host, the authenticated sender
25038 is the one that was receiving on an incoming MAIL command, provided that the
25039 incoming connection was authenticated and the &%server_mail_auth%& condition
25040 allowed the authenticated sender to be retained. If a local process calls Exim
25041 to send a message, the sender address that is built from the login name and
25042 &%qualify_domain%& is treated as authenticated. However, if the
25043 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
25044 the authenticated sender that was received with the message.
25045 .ecindex IIDauthconf1
25046 .ecindex IIDauthconf2
25047
25048
25049
25050
25051
25052
25053 . ////////////////////////////////////////////////////////////////////////////
25054 . ////////////////////////////////////////////////////////////////////////////
25055
25056 .chapter "The plaintext authenticator" "CHAPplaintext"
25057 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
25058 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
25059 The &(plaintext)& authenticator can be configured to support the PLAIN and
25060 LOGIN authentication mechanisms, both of which transfer authentication data as
25061 plain (unencrypted) text (though base64 encoded). The use of plain text is a
25062 security risk; you are strongly advised to insist on the use of SMTP encryption
25063 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
25064 use unencrypted plain text, you should not use the same passwords for SMTP
25065 connections as you do for login accounts.
25066
25067 .section "Plaintext options" "SECID171"
25068 .cindex "options" "&(plaintext)& authenticator (server)"
25069 When configured as a server, &(plaintext)& uses the following options:
25070
25071 .option server_condition authenticators string&!! unset
25072 This is actually a global authentication option, but it must be set in order to
25073 configure the &(plaintext)& driver as a server. Its use is described below.
25074
25075 .option server_prompts plaintext string&!! unset
25076 The contents of this option, after expansion, must be a colon-separated list of
25077 prompt strings. If expansion fails, a temporary authentication rejection is
25078 given.
25079
25080 .section "Using plaintext in a server" "SECTplainserver"
25081 .cindex "AUTH" "in &(plaintext)& authenticator"
25082 .cindex "binary zero" "in &(plaintext)& authenticator"
25083 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
25084         "in &(plaintext)& authenticator"
25085 .vindex "&$auth1$&, &$auth2$&, etc"
25086 .cindex "base64 encoding" "in &(plaintext)& authenticator"
25087
25088 When running as a server, &(plaintext)& performs the authentication test by
25089 expanding a string. The data sent by the client with the AUTH command, or in
25090 response to subsequent prompts, is base64 encoded, and so may contain any byte
25091 values when decoded. If any data is supplied with the command, it is treated as
25092 a list of strings, separated by NULs (binary zeros), the first three of which
25093 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
25094 (neither LOGIN nor PLAIN uses more than three strings).
25095
25096 For compatibility with previous releases of Exim, the values are also placed in
25097 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
25098 variables for this purpose is now deprecated, as it can lead to confusion in
25099 string expansions that also use them for other things.
25100
25101 If there are more strings in &%server_prompts%& than the number of strings
25102 supplied with the AUTH command, the remaining prompts are used to obtain more
25103 data. Each response from the client may be a list of NUL-separated strings.
25104
25105 .vindex "&$authenticated_id$&"
25106 Once a sufficient number of data strings have been received,
25107 &%server_condition%& is expanded. If the expansion is forced to fail,
25108 authentication fails. Any other expansion failure causes a temporary error code
25109 to be returned. If the result of a successful expansion is an empty string,
25110 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
25111 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
25112 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
25113 For any other result, a temporary error code is returned, with the expanded
25114 string as the error text
25115
25116 &*Warning*&: If you use a lookup in the expansion to find the user's
25117 password, be sure to make the authentication fail if the user is unknown.
25118 There are good and bad examples at the end of the next section.
25119
25120
25121
25122 .section "The PLAIN authentication mechanism" "SECID172"
25123 .cindex "PLAIN authentication mechanism"
25124 .cindex "authentication" "PLAIN mechanism"
25125 .cindex "binary zero" "in &(plaintext)& authenticator"
25126 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
25127 sent as one item of data (that is, one combined string containing two NUL
25128 separators). The data is sent either as part of the AUTH command, or
25129 subsequently in response to an empty prompt from the server.
25130
25131 The second and third strings are a user name and a corresponding password.
25132 Using a single fixed user name and password as an example, this could be
25133 configured as follows:
25134 .code
25135 fixed_plain:
25136   driver = plaintext
25137   public_name = PLAIN
25138   server_prompts = :
25139   server_condition = \
25140     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
25141   server_set_id = $auth2
25142 .endd
25143 Note that the default result strings from &%if%& (&"true"& or an empty string)
25144 are exactly what we want here, so they need not be specified. Obviously, if the
25145 password contains expansion-significant characters such as dollar, backslash,
25146 or closing brace, they have to be escaped.
25147
25148 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
25149 the end of a string list are ignored). If all the data comes as part of the
25150 AUTH command, as is commonly the case, the prompt is not used. This
25151 authenticator is advertised in the response to EHLO as
25152 .code
25153 250-AUTH PLAIN
25154 .endd
25155 and a client host can authenticate itself by sending the command
25156 .code
25157 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
25158 .endd
25159 As this contains three strings (more than the number of prompts), no further
25160 data is required from the client. Alternatively, the client may just send
25161 .code
25162 AUTH PLAIN
25163 .endd
25164 to initiate authentication, in which case the server replies with an empty
25165 prompt. The client must respond with the combined data string.
25166
25167 The data string is base64 encoded, as required by the RFC. This example,
25168 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
25169 represents a zero byte. This is split up into three strings, the first of which
25170 is empty. The &%server_condition%& option in the authenticator checks that the
25171 second two are &`username`& and &`mysecret`& respectively.
25172
25173 Having just one fixed user name and password, as in this example, is not very
25174 realistic, though for a small organization with only a handful of
25175 authenticating clients it could make sense.
25176
25177 A more sophisticated instance of this authenticator could use the user name in
25178 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
25179 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
25180 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
25181 This is an incorrect example:
25182 .code
25183 server_condition = \
25184   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
25185 .endd
25186 The expansion uses the user name (&$auth2$&) as the key to look up a password,
25187 which it then compares to the supplied password (&$auth3$&). Why is this example
25188 incorrect? It works fine for existing users, but consider what happens if a
25189 non-existent user name is given. The lookup fails, but as no success/failure
25190 strings are given for the lookup, it yields an empty string. Thus, to defeat
25191 the authentication, all a client has to do is to supply a non-existent user
25192 name and an empty password. The correct way of writing this test is:
25193 .code
25194 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
25195   {${if eq{$value}{$auth3}}} {false}}
25196 .endd
25197 In this case, if the lookup succeeds, the result is checked; if the lookup
25198 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
25199 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
25200 always fails if its second argument is empty. However, the second way of
25201 writing the test makes the logic clearer.
25202
25203
25204 .section "The LOGIN authentication mechanism" "SECID173"
25205 .cindex "LOGIN authentication mechanism"
25206 .cindex "authentication" "LOGIN mechanism"
25207 The LOGIN authentication mechanism is not documented in any RFC, but is in use
25208 in a number of programs. No data is sent with the AUTH command. Instead, a
25209 user name and password are supplied separately, in response to prompts. The
25210 plaintext authenticator can be configured to support this as in this example:
25211 .code
25212 fixed_login:
25213   driver = plaintext
25214   public_name = LOGIN
25215   server_prompts = User Name : Password
25216   server_condition = \
25217     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
25218   server_set_id = $auth1
25219 .endd
25220 Because of the way plaintext operates, this authenticator accepts data supplied
25221 with the AUTH command (in contravention of the specification of LOGIN), but
25222 if the client does not supply it (as is the case for LOGIN clients), the prompt
25223 strings are used to obtain two data items.
25224
25225 Some clients are very particular about the precise text of the prompts. For
25226 example, Outlook Express is reported to recognize only &"Username:"& and
25227 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
25228 strings. It uses the &%ldapauth%& expansion condition to check the user
25229 name and password by binding to an LDAP server:
25230 .code
25231 login:
25232   driver = plaintext
25233   public_name = LOGIN
25234   server_prompts = Username:: : Password::
25235   server_condition = ${if and{{ \
25236     !eq{}{$auth1} }{ \
25237     ldapauth{\
25238       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
25239       pass=${quote:$auth2} \
25240       ldap://ldap.example.org/} }} }
25241   server_set_id = uid=$auth1,ou=people,o=example.org
25242 .endd
25243 We have to check that the username is not empty before using it, because LDAP
25244 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
25245 operator to correctly quote the DN for authentication. However, the basic
25246 &%quote%& operator, rather than any of the LDAP quoting operators, is the
25247 correct one to use for the password, because quoting is needed only to make
25248 the password conform to the Exim syntax. At the LDAP level, the password is an
25249 uninterpreted string.
25250
25251
25252 .section "Support for different kinds of authentication" "SECID174"
25253 A number of string expansion features are provided for the purpose of
25254 interfacing to different ways of user authentication. These include checking
25255 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
25256 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
25257 &<<SECTexpcond>>&.
25258
25259
25260
25261
25262 .section "Using plaintext in a client" "SECID175"
25263 .cindex "options" "&(plaintext)& authenticator (client)"
25264 The &(plaintext)& authenticator has two client options:
25265
25266 .option client_ignore_invalid_base64 plaintext boolean false
25267 If the client receives a server prompt that is not a valid base64 string,
25268 authentication is abandoned by default. However, if this option is set true,
25269 the error in the challenge is ignored and the client sends the response as
25270 usual.
25271
25272 .option client_send plaintext string&!! unset
25273 The string is a colon-separated list of authentication data strings. Each
25274 string is independently expanded before being sent to the server. The first
25275 string is sent with the AUTH command; any more strings are sent in response
25276 to prompts from the server. Before each string is expanded, the value of the
25277 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
25278 with &$auth1$& for the first prompt. Up to three prompts are stored in this
25279 way. Thus, the prompt that is received in response to sending the first string
25280 (with the AUTH command) can be used in the expansion of the second string, and
25281 so on. If an invalid base64 string is received when
25282 &%client_ignore_invalid_base64%& is set, an empty string is put in the
25283 &$auth$&<&'n'&> variable.
25284
25285 &*Note*&: You cannot use expansion to create multiple strings, because
25286 splitting takes priority and happens first.
25287
25288 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
25289 the data, further processing is applied to each string before it is sent. If
25290 there are any single circumflex characters in the string, they are converted to
25291 NULs. Should an actual circumflex be required as data, it must be doubled in
25292 the string.
25293
25294 This is an example of a client configuration that implements the PLAIN
25295 authentication mechanism with a fixed user name and password:
25296 .code
25297 fixed_plain:
25298   driver = plaintext
25299   public_name = PLAIN
25300   client_send = ^username^mysecret
25301 .endd
25302 The lack of colons means that the entire text is sent with the AUTH
25303 command, with the circumflex characters converted to NULs. A similar example
25304 that uses the LOGIN mechanism is:
25305 .code
25306 fixed_login:
25307   driver = plaintext
25308   public_name = LOGIN
25309   client_send = : username : mysecret
25310 .endd
25311 The initial colon means that the first string is empty, so no data is sent with
25312 the AUTH command itself. The remaining strings are sent in response to
25313 prompts.
25314 .ecindex IIDplaiauth1
25315 .ecindex IIDplaiauth2
25316
25317
25318
25319
25320 . ////////////////////////////////////////////////////////////////////////////
25321 . ////////////////////////////////////////////////////////////////////////////
25322
25323 .chapter "The cram_md5 authenticator" "CHID9"
25324 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
25325 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
25326 .cindex "CRAM-MD5 authentication mechanism"
25327 .cindex "authentication" "CRAM-MD5 mechanism"
25328 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
25329 sends a challenge string to the client, and the response consists of a user
25330 name and the CRAM-MD5 digest of the challenge string combined with a secret
25331 string (password) which is known to both server and client. Thus, the secret
25332 is not sent over the network as plain text, which makes this authenticator more
25333 secure than &(plaintext)&. However, the downside is that the secret has to be
25334 available in plain text at either end.
25335
25336
25337 .section "Using cram_md5 as a server" "SECID176"
25338 .cindex "options" "&(cram_md5)& authenticator (server)"
25339 This authenticator has one server option, which must be set to configure the
25340 authenticator as a server:
25341
25342 .option server_secret cram_md5 string&!! unset
25343 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
25344 When the server receives the client's response, the user name is placed in
25345 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
25346 obtain the password for that user. The server then computes the CRAM-MD5 digest
25347 that the client should have sent, and checks that it received the correct
25348 string. If the expansion of &%server_secret%& is forced to fail, authentication
25349 fails. If the expansion fails for some other reason, a temporary error code is
25350 returned to the client.
25351
25352 For compatibility with previous releases of Exim, the user name is also placed
25353 in &$1$&. However, the use of this variables for this purpose is now
25354 deprecated, as it can lead to confusion in string expansions that also use
25355 numeric variables for other things.
25356
25357 For example, the following authenticator checks that the user name given by the
25358 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
25359 user name, authentication fails.
25360 .code
25361 fixed_cram:
25362   driver = cram_md5
25363   public_name = CRAM-MD5
25364   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
25365   server_set_id = $auth1
25366 .endd
25367 .vindex "&$authenticated_id$&"
25368 If authentication succeeds, the setting of &%server_set_id%& preserves the user
25369 name in &$authenticated_id$&. A more typical configuration might look up the
25370 secret string in a file, using the user name as the key. For example:
25371 .code
25372 lookup_cram:
25373   driver = cram_md5
25374   public_name = CRAM-MD5
25375   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
25376                   {$value}fail}
25377   server_set_id = $auth1
25378 .endd
25379 Note that this expansion explicitly forces failure if the lookup fails
25380 because &$auth1$& contains an unknown user name.
25381
25382 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
25383 using the relevant libraries, you need to know the realm to specify in the
25384 lookup and then ask for the &"userPassword"& attribute for that user in that
25385 realm, with:
25386 .code
25387 cyrusless_crammd5:
25388   driver = cram_md5
25389   public_name = CRAM-MD5
25390   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
25391                   dbmjz{/etc/sasldb2}}
25392   server_set_id = $auth1
25393 .endd
25394
25395 .section "Using cram_md5 as a client" "SECID177"
25396 .cindex "options" "&(cram_md5)& authenticator (client)"
25397 When used as a client, the &(cram_md5)& authenticator has two options:
25398
25399
25400
25401 .option client_name cram_md5 string&!! "the primary host name"
25402 This string is expanded, and the result used as the user name data when
25403 computing the response to the server's challenge.
25404
25405
25406 .option client_secret cram_md5 string&!! unset
25407 This option must be set for the authenticator to work as a client. Its value is
25408 expanded and the result used as the secret string when computing the response.
25409
25410
25411 .vindex "&$host$&"
25412 .vindex "&$host_address$&"
25413 Different user names and secrets can be used for different servers by referring
25414 to &$host$& or &$host_address$& in the options. Forced failure of either
25415 expansion string is treated as an indication that this authenticator is not
25416 prepared to handle this case. Exim moves on to the next configured client
25417 authenticator. Any other expansion failure causes Exim to give up trying to
25418 send the message to the current server.
25419
25420 A simple example configuration of a &(cram_md5)& authenticator, using fixed
25421 strings, is:
25422 .code
25423 fixed_cram:
25424   driver = cram_md5
25425   public_name = CRAM-MD5
25426   client_name = ph10
25427   client_secret = secret
25428 .endd
25429 .ecindex IIDcramauth1
25430 .ecindex IIDcramauth2
25431
25432
25433
25434 . ////////////////////////////////////////////////////////////////////////////
25435 . ////////////////////////////////////////////////////////////////////////////
25436
25437 .chapter "The cyrus_sasl authenticator" "CHID10"
25438 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
25439 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
25440 .cindex "Cyrus" "SASL library"
25441 .cindex "Kerberos"
25442 The code for this authenticator was provided by Matthew Byng-Maddick of A L
25443 Digital Ltd (&url(http://www.aldigital.co.uk)).
25444
25445 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
25446 library implementation of the RFC 2222 (&"Simple Authentication and Security
25447 Layer"&). This library supports a number of authentication mechanisms,
25448 including PLAIN and LOGIN, but also several others that Exim does not support
25449 directly. In particular, there is support for Kerberos authentication.
25450
25451 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
25452 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
25453 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
25454 name of the driver to determine which mechanism to support.
25455
25456 Where access to some kind of secret file is required, for example in GSSAPI
25457 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
25458 user, and that the Cyrus SASL library has no way of escalating privileges
25459 by default. You may also find you need to set environment variables,
25460 depending on the driver you are using.
25461
25462 The application name provided by Exim is &"exim"&, so various SASL options may
25463 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
25464 Kerberos, note that because of limitations in the GSSAPI interface,
25465 changing the server keytab might need to be communicated down to the Kerberos
25466 layer independently. The mechanism for doing so is dependent upon the Kerberos
25467 implementation.
25468
25469 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
25470 may be set to point to an alternative keytab file. Exim will pass this
25471 variable through from its own inherited environment when started as root or the
25472 Exim user. The keytab file needs to be readable by the Exim user.
25473 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
25474 environment variable.  In practice, for those releases, the Cyrus authenticator
25475 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
25476 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
25477
25478
25479 .section "Using cyrus_sasl as a server" "SECID178"
25480 The &(cyrus_sasl)& authenticator has four private options. It puts the username
25481 (on a successful authentication) into &$auth1$&. For compatibility with
25482 previous releases of Exim, the username is also placed in &$1$&. However, the
25483 use of this variable for this purpose is now deprecated, as it can lead to
25484 confusion in string expansions that also use numeric variables for other
25485 things.
25486
25487
25488 .option server_hostname cyrus_sasl string&!! "see below"
25489 This option selects the hostname that is used when communicating with the
25490 library. The default value is &`$primary_hostname`&. It is up to the underlying
25491 SASL plug-in what it does with this data.
25492
25493
25494 .option server_mech cyrus_sasl string "see below"
25495 This option selects the authentication mechanism this driver should use. The
25496 default is the value of the generic &%public_name%& option. This option allows
25497 you to use a different underlying mechanism from the advertised name. For
25498 example:
25499 .code
25500 sasl:
25501   driver = cyrus_sasl
25502   public_name = X-ANYTHING
25503   server_mech = CRAM-MD5
25504   server_set_id = $auth1
25505 .endd
25506
25507 .option server_realm cyrus_sasl string&!! unset
25508 This specifies the SASL realm that the server claims to be in.
25509
25510
25511 .option server_service cyrus_sasl string &`smtp`&
25512 This is the SASL service that the server claims to implement.
25513
25514
25515 For straightforward cases, you do not need to set any of the authenticator's
25516 private options. All you need to do is to specify an appropriate mechanism as
25517 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
25518 PLAIN, you could have two authenticators as follows:
25519 .code
25520 sasl_cram_md5:
25521   driver = cyrus_sasl
25522   public_name = CRAM-MD5
25523   server_set_id = $auth1
25524
25525 sasl_plain:
25526   driver = cyrus_sasl
25527   public_name = PLAIN
25528   server_set_id = $auth2
25529 .endd
25530 Cyrus SASL does implement the LOGIN authentication method, even though it is
25531 not a standard method. It is disabled by default in the source distribution,
25532 but it is present in many binary distributions.
25533 .ecindex IIDcyrauth1
25534 .ecindex IIDcyrauth2
25535
25536
25537
25538
25539 . ////////////////////////////////////////////////////////////////////////////
25540 . ////////////////////////////////////////////////////////////////////////////
25541 .chapter "The dovecot authenticator" "CHAPdovecot"
25542 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
25543 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
25544 This authenticator is an interface to the authentication facility of the
25545 Dovecot POP/IMAP server, which can support a number of authentication methods.
25546 Note that Dovecot must be configured to use auth-client not auth-userdb.
25547 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
25548 to use the same mechanisms for SMTP authentication. This is a server
25549 authenticator only. There is only one option:
25550
25551 .option server_socket dovecot string unset
25552
25553 This option must specify the socket that is the interface to Dovecot
25554 authentication. The &%public_name%& option must specify an authentication
25555 mechanism that Dovecot is configured to support. You can have several
25556 authenticators for different mechanisms. For example:
25557 .code
25558 dovecot_plain:
25559   driver = dovecot
25560   public_name = PLAIN
25561   server_socket = /var/run/dovecot/auth-client
25562   server_set_id = $auth1
25563
25564 dovecot_ntlm:
25565   driver = dovecot
25566   public_name = NTLM
25567   server_socket = /var/run/dovecot/auth-client
25568   server_set_id = $auth1
25569 .endd
25570 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
25571 &$received_ip_address$& (that is, the connection is local), the &"secured"&
25572 option is passed in the Dovecot authentication command. If, for a TLS
25573 connection, a client certificate has been verified, the &"valid-client-cert"&
25574 option is passed. When authentication succeeds, the identity of the user
25575 who authenticated is placed in &$auth1$&.
25576 .ecindex IIDdcotauth1
25577 .ecindex IIDdcotauth2
25578
25579
25580 . ////////////////////////////////////////////////////////////////////////////
25581 . ////////////////////////////////////////////////////////////////////////////
25582 .chapter "The gsasl authenticator" "CHAPgsasl"
25583 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
25584 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
25585 .cindex "authentication" "GNU SASL"
25586 .cindex "authentication" "SASL"
25587 .cindex "authentication" "EXTERNAL"
25588 .cindex "authentication" "ANONYMOUS"
25589 .cindex "authentication" "PLAIN"
25590 .cindex "authentication" "LOGIN"
25591 .cindex "authentication" "DIGEST-MD5"
25592 .cindex "authentication" "CRAM-MD5"
25593 .cindex "authentication" "SCRAM-SHA-1"
25594 The &(gsasl)& authenticator provides server integration for the GNU SASL
25595 library and the mechanisms it provides.  This is new as of the 4.80 release
25596 and there are a few areas where the library does not let Exim smoothly
25597 scale to handle future authentication mechanisms, so no guarantee can be
25598 made that any particular new authentication mechanism will be supported
25599 without code changes in Exim.
25600
25601
25602 .option server_channelbinding gsasl boolean false
25603 Some authentication mechanisms are able to use external context at both ends
25604 of the session to bind the authentication to that context, and fail the
25605 authentication process if that context differs.  Specifically, some TLS
25606 ciphersuites can provide identifying information about the cryptographic
25607 context.
25608
25609 This means that certificate identity and verification becomes a non-issue,
25610 as a man-in-the-middle attack will cause the correct client and server to
25611 see different identifiers and authentication will fail.
25612
25613 This is currently only supported when using the GnuTLS library.  This is
25614 only usable by mechanisms which support "channel binding"; at time of
25615 writing, that's the SCRAM family.
25616
25617 This defaults off to ensure smooth upgrade across Exim releases, in case
25618 this option causes some clients to start failing.  Some future release
25619 of Exim may switch the default to be true.
25620
25621
25622 .option server_hostname gsasl string&!! "see below"
25623 This option selects the hostname that is used when communicating with the
25624 library. The default value is &`$primary_hostname`&.
25625 Some mechanisms will use this data.
25626
25627
25628 .option server_mech gsasl string "see below"
25629 This option selects the authentication mechanism this driver should use. The
25630 default is the value of the generic &%public_name%& option. This option allows
25631 you to use a different underlying mechanism from the advertised name. For
25632 example:
25633 .code
25634 sasl:
25635   driver = gsasl
25636   public_name = X-ANYTHING
25637   server_mech = CRAM-MD5
25638   server_set_id = $auth1
25639 .endd
25640
25641
25642 .option server_password gsasl string&!! unset
25643 Various mechanisms need access to the cleartext password on the server, so
25644 that proof-of-possession can be demonstrated on the wire, without sending
25645 the password itself.
25646
25647 The data available for lookup varies per mechanism.
25648 In all cases, &$auth1$& is set to the &'authentication id'&.
25649 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
25650 if available, else the empty string.
25651 The &$auth3$& variable will always be the &'realm'& if available,
25652 else the empty string.
25653
25654 A forced failure will cause authentication to defer.
25655
25656 If using this option, it may make sense to set the &%server_condition%&
25657 option to be simply "true".
25658
25659
25660 .option server_realm gsasl string&!! unset
25661 This specifies the SASL realm that the server claims to be in.
25662 Some mechanisms will use this data.
25663
25664
25665 .option server_scram_iter gsasl string&!! unset
25666 This option provides data for the SCRAM family of mechanisms.
25667 &$auth1$& is not available at evaluation time.
25668 (This may change, as we receive feedback on use)
25669
25670
25671 .option server_scram_salt gsasl string&!! unset
25672 This option provides data for the SCRAM family of mechanisms.
25673 &$auth1$& is not available at evaluation time.
25674 (This may change, as we receive feedback on use)
25675
25676
25677 .option server_service gsasl string &`smtp`&
25678 This is the SASL service that the server claims to implement.
25679 Some mechanisms will use this data.
25680
25681
25682 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
25683 .vindex "&$auth1$&, &$auth2$&, etc"
25684 These may be set when evaluating specific options, as detailed above.
25685 They will also be set when evaluating &%server_condition%&.
25686
25687 Unless otherwise stated below, the &(gsasl)& integration will use the following
25688 meanings for these variables:
25689
25690 .ilist
25691 .vindex "&$auth1$&"
25692 &$auth1$&: the &'authentication id'&
25693 .next
25694 .vindex "&$auth2$&"
25695 &$auth2$&: the &'authorization id'&
25696 .next
25697 .vindex "&$auth3$&"
25698 &$auth3$&: the &'realm'&
25699 .endlist
25700
25701 On a per-mechanism basis:
25702
25703 .ilist
25704 .cindex "authentication" "EXTERNAL"
25705 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
25706 the &%server_condition%& option must be present.
25707 .next
25708 .cindex "authentication" "ANONYMOUS"
25709 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
25710 the &%server_condition%& option must be present.
25711 .next
25712 .cindex "authentication" "GSSAPI"
25713 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
25714 &$auth2$& will be set to the &'authorization id'&,
25715 the &%server_condition%& option must be present.
25716 .endlist
25717
25718 An &'anonymous token'& is something passed along as an unauthenticated
25719 identifier; this is analogous to FTP anonymous authentication passing an
25720 email address, or software-identifier@, as the "password".
25721
25722
25723 An example showing the password having the realm specified in the callback
25724 and demonstrating a Cyrus SASL to GSASL migration approach is:
25725 .code
25726 gsasl_cyrusless_crammd5:
25727   driver = gsasl
25728   public_name = CRAM-MD5
25729   server_realm = imap.example.org
25730   server_password = ${lookup{$auth1:$auth3:userPassword}\
25731                     dbmjz{/etc/sasldb2}{$value}fail}
25732   server_set_id = ${quote:$auth1}
25733   server_condition = yes
25734 .endd
25735
25736
25737 . ////////////////////////////////////////////////////////////////////////////
25738 . ////////////////////////////////////////////////////////////////////////////
25739
25740 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
25741 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
25742 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
25743 .cindex "authentication" "GSSAPI"
25744 .cindex "authentication" "Kerberos"
25745 The &(heimdal_gssapi)& authenticator provides server integration for the
25746 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
25747 reliably.
25748
25749 .option server_hostname heimdal_gssapi string&!! "see below"
25750 This option selects the hostname that is used, with &%server_service%&,
25751 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
25752 identifier.  The default value is &`$primary_hostname`&.
25753
25754 .option server_keytab heimdal_gssapi string&!! unset
25755 If set, then Heimdal will not use the system default keytab (typically
25756 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
25757 The value should be a pathname, with no &"file:"& prefix.
25758
25759 .option server_service heimdal_gssapi string&!! "smtp"
25760 This option specifies the service identifier used, in conjunction with
25761 &%server_hostname%&, for building the identifer for finding credentials
25762 from the keytab.
25763
25764
25765 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
25766 Beware that these variables will typically include a realm, thus will appear
25767 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
25768 not verified, so a malicious client can set it to anything.
25769
25770 The &$auth1$& field should be safely trustable as a value from the Key
25771 Distribution Center.  Note that these are not quite email addresses.
25772 Each identifier is for a role, and so the left-hand-side may include a
25773 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
25774
25775 .vindex "&$auth1$&, &$auth2$&, etc"
25776 .ilist
25777 .vindex "&$auth1$&"
25778 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
25779 .next
25780 .vindex "&$auth2$&"
25781 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
25782 authentication.  If that was empty, this will also be set to the
25783 GSS Display Name.
25784 .endlist
25785
25786
25787 . ////////////////////////////////////////////////////////////////////////////
25788 . ////////////////////////////////////////////////////////////////////////////
25789
25790 .chapter "The spa authenticator" "CHAPspa"
25791 .scindex IIDspaauth1 "&(spa)& authenticator"
25792 .scindex IIDspaauth2 "authenticators" "&(spa)&"
25793 .cindex "authentication" "Microsoft Secure Password"
25794 .cindex "authentication" "NTLM"
25795 .cindex "Microsoft Secure Password Authentication"
25796 .cindex "NTLM authentication"
25797 The &(spa)& authenticator provides client support for Microsoft's &'Secure
25798 Password Authentication'& mechanism,
25799 which is also sometimes known as NTLM (NT LanMan). The code for client side of
25800 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
25801 taken from the Samba project (&url(http://www.samba.org)). The code for the
25802 server side was subsequently contributed by Tom Kistner. The mechanism works as
25803 follows:
25804
25805 .ilist
25806 After the AUTH command has been accepted, the client sends an SPA
25807 authentication request based on the user name and optional domain.
25808 .next
25809 The server sends back a challenge.
25810 .next
25811 The client builds a challenge response which makes use of the user's password
25812 and sends it to the server, which then accepts or rejects it.
25813 .endlist
25814
25815 Encryption is used to protect the password in transit.
25816
25817
25818
25819 .section "Using spa as a server" "SECID179"
25820 .cindex "options" "&(spa)& authenticator (server)"
25821 The &(spa)& authenticator has just one server option:
25822
25823 .option server_password spa string&!! unset
25824 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
25825 This option is expanded, and the result must be the cleartext password for the
25826 authenticating user, whose name is at this point in &$auth1$&. For
25827 compatibility with previous releases of Exim, the user name is also placed in
25828 &$1$&. However, the use of this variable for this purpose is now deprecated, as
25829 it can lead to confusion in string expansions that also use numeric variables
25830 for other things. For example:
25831 .code
25832 spa:
25833   driver = spa
25834   public_name = NTLM
25835   server_password = \
25836     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
25837 .endd
25838 If the expansion is forced to fail, authentication fails. Any other expansion
25839 failure causes a temporary error code to be returned.
25840
25841
25842
25843
25844
25845 .section "Using spa as a client" "SECID180"
25846 .cindex "options" "&(spa)& authenticator (client)"
25847 The &(spa)& authenticator has the following client options:
25848
25849
25850
25851 .option client_domain spa string&!! unset
25852 This option specifies an optional domain for the authentication.
25853
25854
25855 .option client_password spa string&!! unset
25856 This option specifies the user's password, and must be set.
25857
25858
25859 .option client_username spa string&!! unset
25860 This option specifies the user name, and must be set. Here is an example of a
25861 configuration of this authenticator for use with the mail servers at
25862 &'msn.com'&:
25863 .code
25864 msn:
25865   driver = spa
25866   public_name = MSN
25867   client_username = msn/msn_username
25868   client_password = msn_plaintext_password
25869   client_domain = DOMAIN_OR_UNSET
25870 .endd
25871 .ecindex IIDspaauth1
25872 .ecindex IIDspaauth2
25873
25874
25875
25876
25877
25878 . ////////////////////////////////////////////////////////////////////////////
25879 . ////////////////////////////////////////////////////////////////////////////
25880
25881 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
25882          "Encrypted SMTP connections"
25883 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
25884 .scindex IIDencsmtp2 "SMTP" "encryption"
25885 .cindex "TLS" "on SMTP connection"
25886 .cindex "OpenSSL"
25887 .cindex "GnuTLS"
25888 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
25889 Sockets Layer), is implemented by making use of the OpenSSL library or the
25890 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
25891 cryptographic code in the Exim distribution itself for implementing TLS. In
25892 order to use this feature you must install OpenSSL or GnuTLS, and then build a
25893 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
25894 You also need to understand the basic concepts of encryption at a managerial
25895 level, and in particular, the way that public keys, private keys, and
25896 certificates are used.
25897
25898 RFC 3207 defines how SMTP connections can make use of encryption. Once a
25899 connection is established, the client issues a STARTTLS command. If the
25900 server accepts this, the client and the server negotiate an encryption
25901 mechanism. If the negotiation succeeds, the data that subsequently passes
25902 between them is encrypted.
25903
25904 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
25905 and if so, what cipher suite is in use, whether the client supplied a
25906 certificate, and whether or not that certificate was verified. This makes it
25907 possible for an Exim server to deny or accept certain commands based on the
25908 encryption state.
25909
25910 &*Warning*&: Certain types of firewall and certain anti-virus products can
25911 disrupt TLS connections. You need to turn off SMTP scanning for these products
25912 in order to get TLS to work.
25913
25914
25915
25916 .section "Support for the legacy &""ssmtp""& (aka &""smtps""&) protocol" &&&
25917          "SECID284"
25918 .cindex "ssmtp protocol"
25919 .cindex "smtps protocol"
25920 .cindex "SMTP" "ssmtp protocol"
25921 .cindex "SMTP" "smtps protocol"
25922 Early implementations of encrypted SMTP used a different TCP port from normal
25923 SMTP, and expected an encryption negotiation to start immediately, instead of
25924 waiting for a STARTTLS command from the client using the standard SMTP
25925 port. The protocol was called &"ssmtp"& or &"smtps"&, and port 465 was
25926 allocated for this purpose.
25927
25928 This approach was abandoned when encrypted SMTP was standardized, but there are
25929 still some legacy clients that use it. Exim supports these clients by means of
25930 the &%tls_on_connect_ports%& global option. Its value must be a list of port
25931 numbers; the most common use is expected to be:
25932 .code
25933 tls_on_connect_ports = 465
25934 .endd
25935 The port numbers specified by this option apply to all SMTP connections, both
25936 via the daemon and via &'inetd'&. You still need to specify all the ports that
25937 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
25938 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
25939 an extra port &-- rather, it specifies different behaviour on a port that is
25940 defined elsewhere.
25941
25942 There is also a &%-tls-on-connect%& command line option. This overrides
25943 &%tls_on_connect_ports%&; it forces the legacy behaviour for all ports.
25944
25945
25946
25947
25948
25949
25950 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
25951 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
25952 The first TLS support in Exim was implemented using OpenSSL. Support for GnuTLS
25953 followed later, when the first versions of GnuTLS were released. To build Exim
25954 to use GnuTLS, you need to set
25955 .code
25956 USE_GNUTLS=yes
25957 .endd
25958 in Local/Makefile, in addition to
25959 .code
25960 SUPPORT_TLS=yes
25961 .endd
25962 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
25963 include files and libraries for GnuTLS can be found.
25964
25965 There are some differences in usage when using GnuTLS instead of OpenSSL:
25966
25967 .ilist
25968 The &%tls_verify_certificates%& option
25969 cannot be the path of a directory
25970 for GnuTLS versions before 3.3.6
25971 (for later versions, or OpenSSL, it can be either).
25972 .next
25973 The default value for &%tls_dhparam%& differs for historical reasons.
25974 .next
25975 .vindex "&$tls_in_peerdn$&"
25976 .vindex "&$tls_out_peerdn$&"
25977 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
25978 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
25979 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
25980 .next
25981 OpenSSL identifies cipher suites using hyphens as separators, for example:
25982 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
25983 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
25984 in a cipher list. To make life simpler, Exim changes underscores to hyphens
25985 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
25986 to handle its own older variants) when processing lists of cipher suites in the
25987 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
25988 option).
25989 .next
25990 The &%tls_require_ciphers%& options operate differently, as described in the
25991 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
25992 .next
25993 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
25994 When using OpenSSL, this option is ignored.
25995 (If an API is found to let OpenSSL be configured in this way,
25996 let the Exim Maintainers know and we'll likely use it).
25997 .next
25998 Some other recently added features may only be available in one or the other.
25999 This should be documented with the feature.  If the documentation does not
26000 explicitly state that the feature is infeasible in the other TLS
26001 implementation, then patches are welcome.
26002 .endlist
26003
26004
26005 .section "GnuTLS parameter computation" "SECTgnutlsparam"
26006 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
26007 an explicit path; if the latter, then the text about generation still applies,
26008 but not the chosen filename.
26009 By default, as of Exim 4.80 a hard-coded D-H prime is used.
26010 See the documentation of &%tls_dhparam%& for more information.
26011
26012 GnuTLS uses D-H parameters that may take a substantial amount of time
26013 to compute. It is unreasonable to re-compute them for every TLS session.
26014 Therefore, Exim keeps this data in a file in its spool directory, called
26015 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
26016 of bits requested.
26017 The file is owned by the Exim user and is readable only by
26018 its owner. Every Exim process that start up GnuTLS reads the D-H
26019 parameters from this file. If the file does not exist, the first Exim process
26020 that needs it computes the data and writes it to a temporary file which is
26021 renamed once it is complete. It does not matter if several Exim processes do
26022 this simultaneously (apart from wasting a few resources). Once a file is in
26023 place, new Exim processes immediately start using it.
26024
26025 For maximum security, the parameters that are stored in this file should be
26026 recalculated periodically, the frequency depending on your paranoia level.
26027 If you are avoiding using the fixed D-H primes published in RFCs, then you
26028 are concerned about some advanced attacks and will wish to do this; if you do
26029 not regenerate then you might as well stick to the standard primes.
26030
26031 Arranging this is easy in principle; just delete the file when you want new
26032 values to be computed. However, there may be a problem. The calculation of new
26033 parameters needs random numbers, and these are obtained from &_/dev/random_&.
26034 If the system is not very active, &_/dev/random_& may delay returning data
26035 until enough randomness (entropy) is available. This may cause Exim to hang for
26036 a substantial amount of time, causing timeouts on incoming connections.
26037
26038 The solution is to generate the parameters externally to Exim. They are stored
26039 in &_gnutls-params-N_& in PEM format, which means that they can be
26040 generated externally using the &(certtool)& command that is part of GnuTLS.
26041
26042 To replace the parameters with new ones, instead of deleting the file
26043 and letting Exim re-create it, you can generate new parameters using
26044 &(certtool)& and, when this has been done, replace Exim's cache file by
26045 renaming. The relevant commands are something like this:
26046 .code
26047 # ls
26048 [ look for file; assume gnutls-params-2236 is the most recent ]
26049 # rm -f new-params
26050 # touch new-params
26051 # chown exim:exim new-params
26052 # chmod 0600 new-params
26053 # certtool --generate-dh-params --bits 2236 >>new-params
26054 # openssl dhparam -noout -text -in new-params | head
26055 [ check the first line, make sure it's not more than 2236;
26056   if it is, then go back to the start ("rm") and repeat
26057   until the size generated is at most the size requested ]
26058 # chmod 0400 new-params
26059 # mv new-params gnutls-params-2236
26060 .endd
26061 If Exim never has to generate the parameters itself, the possibility of
26062 stalling is removed.
26063
26064 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
26065 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
26066 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
26067 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
26068 and Exim does so.  This attempt to remove Exim from TLS policy decisions
26069 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
26070 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
26071 which applies to all D-H usage, client or server.  If the value returned by
26072 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
26073 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
26074 limit, which is still much higher than Exim historically used.
26075
26076 The filename and bits used will change as the GnuTLS maintainers change the
26077 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
26078 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
26079 2432 bits, while NSS is limited to 2236 bits.
26080
26081 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
26082 increase the chance of the generated prime actually being within acceptable
26083 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
26084 procedure above.  There is no sane procedure available to Exim to double-check
26085 the size of the generated prime, so it might still be too large.
26086
26087
26088 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
26089 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
26090 .oindex "&%tls_require_ciphers%&" "OpenSSL"
26091 There is a function in the OpenSSL library that can be passed a list of cipher
26092 suites before the cipher negotiation takes place. This specifies which ciphers
26093 are acceptable. The list is colon separated and may contain names like
26094 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
26095 directly to this function call.
26096 Many systems will install the OpenSSL manual-pages, so you may have
26097 &'ciphers(1)'& available to you.
26098 The following quotation from the OpenSSL
26099 documentation specifies what forms of item are allowed in the cipher string:
26100
26101 .ilist
26102 It can consist of a single cipher suite such as RC4-SHA.
26103 .next
26104 It can represent a list of cipher suites containing a certain algorithm,
26105 or cipher suites of a certain type. For example SHA1 represents all
26106 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
26107 SSL v3 algorithms.
26108 .next
26109 Lists of cipher suites can be combined in a single cipher string using
26110 the + character. This is used as a logical and operation. For example
26111 SHA1+DES represents all cipher suites containing the SHA1 and the DES
26112 algorithms.
26113 .endlist
26114
26115 Each cipher string can be optionally preceded by one of the characters &`!`&,
26116 &`-`& or &`+`&.
26117 .ilist
26118 If &`!`& is used, the ciphers are permanently deleted from the list. The
26119 ciphers deleted can never reappear in the list even if they are explicitly
26120 stated.
26121 .next
26122 If &`-`& is used, the ciphers are deleted from the list, but some or all
26123 of the ciphers can be added again by later options.
26124 .next
26125 If &`+`& is used, the ciphers are moved to the end of the list. This
26126 option does not add any new ciphers; it just moves matching existing ones.
26127 .endlist
26128
26129 If none of these characters is present, the string is interpreted as
26130 a list of ciphers to be appended to the current preference list. If the list
26131 includes any ciphers already present they will be ignored: that is, they will
26132 not be moved to the end of the list.
26133 .endlist
26134
26135 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
26136 string:
26137 .code
26138 # note single-quotes to get ! past any shell history expansion
26139 $ openssl ciphers 'HIGH:!MD5:!SHA1'
26140 .endd
26141
26142 This example will let the library defaults be permitted on the MX port, where
26143 there's probably no identity verification anyway, but ups the ante on the
26144 submission ports where the administrator might have some influence on the
26145 choice of clients used:
26146 .code
26147 # OpenSSL variant; see man ciphers(1)
26148 tls_require_ciphers = ${if =={$received_port}{25}\
26149                            {DEFAULT}\
26150                            {HIGH:!MD5:!SHA1}}
26151 .endd
26152
26153
26154
26155 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
26156          "SECTreqciphgnu"
26157 .cindex "GnuTLS" "specifying parameters for"
26158 .cindex "TLS" "specifying ciphers (GnuTLS)"
26159 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
26160 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
26161 .cindex "TLS" "specifying protocols (GnuTLS)"
26162 .cindex "TLS" "specifying priority string (GnuTLS)"
26163 .oindex "&%tls_require_ciphers%&" "GnuTLS"
26164 The GnuTLS library allows the caller to provide a "priority string", documented
26165 as part of the &[gnutls_priority_init]& function.  This is very similar to the
26166 ciphersuite specification in OpenSSL.
26167
26168 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string
26169 and controls both protocols and ciphers.
26170
26171 The &%tls_require_ciphers%& option is available both as an global option,
26172 controlling how Exim behaves as a server, and also as an option of the
26173 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
26174 the value is string expanded.  The resulting string is not an Exim list and
26175 the string is given to the GnuTLS library, so that Exim does not need to be
26176 aware of future feature enhancements of GnuTLS.
26177
26178 Documentation of the strings accepted may be found in the GnuTLS manual, under
26179 "Priority strings".  This is online as
26180 &url(http://www.gnutls.org/manual/html_node/Priority-Strings.html),
26181 but beware that this relates to GnuTLS 3, which may be newer than the version
26182 installed on your system.  If you are using GnuTLS 3,
26183 &url(http://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string, then the example code)
26184 on that site can be used to test a given string.
26185
26186 For example:
26187 .code
26188 # Disable older versions of protocols
26189 tls_require_ciphers = NORMAL:%LATEST_RECORD_VERSION:-VERS-SSL3.0
26190 .endd
26191
26192 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
26193 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
26194 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
26195
26196 This example will let the library defaults be permitted on the MX port, where
26197 there's probably no identity verification anyway, and lowers security further
26198 by increasing compatibility; but this ups the ante on the submission ports
26199 where the administrator might have some influence on the choice of clients
26200 used:
26201 .code
26202 # GnuTLS variant
26203 tls_require_ciphers = ${if =={$received_port}{25}\
26204                            {NORMAL:%COMPAT}\
26205                            {SECURE128}}
26206 .endd
26207
26208
26209 .section "Configuring an Exim server to use TLS" "SECID182"
26210 .cindex "TLS" "configuring an Exim server"
26211 When Exim has been built with TLS support, it advertises the availability of
26212 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
26213 but not to any others. The default value of this option is unset, which means
26214 that STARTTLS is not advertised at all. This default is chosen because you
26215 need to set some other options in order to make TLS available, and also it is
26216 sensible for systems that want to use TLS only as a client.
26217
26218 If a client issues a STARTTLS command and there is some configuration
26219 problem in the server, the command is rejected with a 454 error. If the client
26220 persists in trying to issue SMTP commands, all except QUIT are rejected
26221 with the error
26222 .code
26223 554 Security failure
26224 .endd
26225 If a STARTTLS command is issued within an existing TLS session, it is
26226 rejected with a 554 error code.
26227
26228 To enable TLS operations on a server, you must set &%tls_advertise_hosts%& to
26229 match some hosts. You can, of course, set it to * to match all hosts.
26230 However, this is not all you need to do. TLS sessions to a server won't work
26231 without some further configuration at the server end.
26232
26233 It is rumoured that all existing clients that support TLS/SSL use RSA
26234 encryption. To make this work you need to set, in the server,
26235 .code
26236 tls_certificate = /some/file/name
26237 tls_privatekey = /some/file/name
26238 .endd
26239 These options are, in fact, expanded strings, so you can make them depend on
26240 the identity of the client that is connected if you wish. The first file
26241 contains the server's X509 certificate, and the second contains the private key
26242 that goes with it. These files need to be
26243 PEM format and readable by the Exim user, and must
26244 always be given as full path names.
26245 The key must not be password-protected.
26246 They can be the same file if both the
26247 certificate and the key are contained within it. If &%tls_privatekey%& is not
26248 set, or if its expansion is forced to fail or results in an empty string, this
26249 is assumed to be the case. The certificate file may also contain intermediate
26250 certificates that need to be sent to the client to enable it to authenticate
26251 the server's certificate.
26252
26253 If you do not understand about certificates and keys, please try to find a
26254 source of this background information, which is not Exim-specific. (There are a
26255 few comments below in section &<<SECTcerandall>>&.)
26256
26257 &*Note*&: These options do not apply when Exim is operating as a client &--
26258 they apply only in the case of a server. If you need to use a certificate in an
26259 Exim client, you must set the options of the same names in an &(smtp)&
26260 transport.
26261
26262 With just these options, an Exim server will be able to use TLS. It does not
26263 require the client to have a certificate (but see below for how to insist on
26264 this). There is one other option that may be needed in other situations. If
26265 .code
26266 tls_dhparam = /some/file/name
26267 .endd
26268 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
26269 with the parameters contained in the file.
26270 Set this to &`none`& to disable use of DH entirely, by making no prime
26271 available:
26272 .code
26273 tls_dhparam = none
26274 .endd
26275 This may also be set to a string identifying a standard prime to be used for
26276 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
26277 used is &`ike23`&.  There are a few standard primes available, see the
26278 documentation for &%tls_dhparam%& for the complete list.
26279
26280 See the command
26281 .code
26282 openssl dhparam
26283 .endd
26284 for a way of generating file data.
26285
26286 The strings supplied for these three options are expanded every time a client
26287 host connects. It is therefore possible to use different certificates and keys
26288 for different hosts, if you so wish, by making use of the client's IP address
26289 in &$sender_host_address$& to control the expansion. If a string expansion is
26290 forced to fail, Exim behaves as if the option is not set.
26291
26292 .cindex "cipher" "logging"
26293 .cindex "log" "TLS cipher"
26294 .vindex "&$tls_in_cipher$&"
26295 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
26296 an incoming TLS connection. It is included in the &'Received:'& header of an
26297 incoming message (by default &-- you can, of course, change this), and it is
26298 also included in the log line that records a message's arrival, keyed by
26299 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
26300 condition can be used to test for specific cipher suites in ACLs.
26301
26302 Once TLS has been established, the ACLs that run for subsequent SMTP commands
26303 can check the name of the cipher suite and vary their actions accordingly. The
26304 cipher suite names vary, depending on which TLS library is being used. For
26305 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
26306 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
26307 documentation for more details.
26308
26309 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
26310 (again depending on the &%tls_cipher%& log selector).
26311
26312
26313 .section "Requesting and verifying client certificates" "SECID183"
26314 .cindex "certificate" "verification of client"
26315 .cindex "TLS" "client certificate verification"
26316 If you want an Exim server to request a certificate when negotiating a TLS
26317 session with a client, you must set either &%tls_verify_hosts%& or
26318 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
26319 apply to all TLS connections. For any host that matches one of these options,
26320 Exim requests a certificate as part of the setup of the TLS session. The
26321 contents of the certificate are verified by comparing it with a list of
26322 expected certificates.
26323 These may be the system default set (depending on library version),
26324 an explicit file or,
26325 depending on library version, a directory, identified by
26326 &%tls_verify_certificates%&.
26327
26328 A file can contain multiple certificates, concatenated end to end. If a
26329 directory is used
26330 (OpenSSL only),
26331 each certificate must be in a separate file, with a name (or a symbolic link)
26332 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
26333 certificate. You can compute the relevant hash by running the command
26334 .code
26335 openssl x509 -hash -noout -in /cert/file
26336 .endd
26337 where &_/cert/file_& contains a single certificate.
26338
26339 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
26340 what happens if the client does not supply a certificate, or if the certificate
26341 does not match any of the certificates in the collection named by
26342 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
26343 attempt to set up a TLS session is aborted, and the incoming connection is
26344 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
26345 session continues. ACLs that run for subsequent SMTP commands can detect the
26346 fact that no certificate was verified, and vary their actions accordingly. For
26347 example, you can insist on a certificate before accepting a message for
26348 relaying, but not when the message is destined for local delivery.
26349
26350 .vindex "&$tls_in_peerdn$&"
26351 When a client supplies a certificate (whether it verifies or not), the value of
26352 the Distinguished Name of the certificate is made available in the variable
26353 &$tls_in_peerdn$& during subsequent processing of the message.
26354
26355 .cindex "log" "distinguished name"
26356 Because it is often a long text string, it is not included in the log line or
26357 &'Received:'& header by default. You can arrange for it to be logged, keyed by
26358 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
26359 &%received_header_text%& to change the &'Received:'& header. When no
26360 certificate is supplied, &$tls_in_peerdn$& is empty.
26361
26362
26363 .section "Revoked certificates" "SECID184"
26364 .cindex "TLS" "revoked certificates"
26365 .cindex "revocation list"
26366 .cindex "certificate" "revocation list"
26367 .cindex "OCSP" "stapling"
26368 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
26369 certificates are revoked. If you have such a list, you can pass it to an Exim
26370 server using the global option called &%tls_crl%& and to an Exim client using
26371 an identically named option for the &(smtp)& transport. In each case, the value
26372 of the option is expanded and must then be the name of a file that contains a
26373 CRL in PEM format.
26374 The downside is that clients have to periodically re-download a potentially huge
26375 file from every certificate authority they know of.
26376
26377 The way with most moving parts at query time is Online Certificate
26378 Status Protocol (OCSP), where the client verifies the certificate
26379 against an OCSP server run by the CA.  This lets the CA track all
26380 usage of the certs.  It requires running software with access to the
26381 private key of the CA, to sign the responses to the OCSP queries.  OCSP
26382 is based on HTTP and can be proxied accordingly.
26383
26384 The only widespread OCSP server implementation (known to this writer)
26385 comes as part of OpenSSL and aborts on an invalid request, such as
26386 connecting to the port and then disconnecting.  This requires
26387 re-entering the passphrase each time some random client does this.
26388
26389 The third way is OCSP Stapling; in this, the server using a certificate
26390 issued by the CA periodically requests an OCSP proof of validity from
26391 the OCSP server, then serves it up inline as part of the TLS
26392 negotiation.   This approach adds no extra round trips, does not let the
26393 CA track users, scales well with number of certs issued by the CA and is
26394 resilient to temporary OCSP server failures, as long as the server
26395 starts retrying to fetch an OCSP proof some time before its current
26396 proof expires.  The downside is that it requires server support.
26397
26398 Unless Exim is built with the support disabled,
26399 or with GnuTLS earlier than version 3.1.3,
26400 support for OCSP stapling is included.
26401
26402 There is a global option called &%tls_ocsp_file%&.
26403 The file specified therein is expected to be in DER format, and contain
26404 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
26405 option will be re-expanded for SNI, if the &%tls_certificate%& option
26406 contains &`tls_in_sni`&, as per other TLS options.
26407
26408 Exim does not at this time implement any support for fetching a new OCSP
26409 proof.  The burden is on the administrator to handle this, outside of
26410 Exim.  The file specified should be replaced atomically, so that the
26411 contents are always valid.  Exim will expand the &%tls_ocsp_file%& option
26412 on each connection, so a new file will be handled transparently on the
26413 next connection.
26414
26415 When built with OpenSSL Exim will check for a valid next update timestamp
26416 in the OCSP proof; if not present, or if the proof has expired, it will be
26417 ignored.
26418
26419 For the client to be able to verify the stapled OCSP the server must
26420 also supply, in its stapled information, any intermediate
26421 certificates for the chain leading to the OCSP proof from the signer
26422 of the server certificate.  There may be zero or one such. These
26423 intermediate certificates should be added to the server OCSP stapling
26424 file named by &%tls_ocsp_file%&.
26425
26426 Note that the proof only covers the terminal server certificate,
26427 not any of the chain from CA to it.
26428
26429 There is no current way to staple a proof for a client certificate.
26430
26431 .code
26432   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
26433   OCSP server is supplied.  The server URL may be included in the
26434   server certificate, if the CA is helpful.
26435
26436   One failure mode seen was the OCSP Signer cert expiring before the end
26437   of validity of the OCSP proof. The checking done by Exim/OpenSSL
26438   noted this as invalid overall, but the re-fetch script did not.
26439 .endd
26440
26441
26442
26443
26444 .section "Configuring an Exim client to use TLS" "SECID185"
26445 .cindex "cipher" "logging"
26446 .cindex "log" "TLS cipher"
26447 .cindex "log" "distinguished name"
26448 .cindex "TLS" "configuring an Exim client"
26449 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
26450 deliveries as well as to incoming, the latter one causing logging of the
26451 server certificate's DN. The remaining client configuration for TLS is all
26452 within the &(smtp)& transport.
26453
26454 It is not necessary to set any options to have TLS work in the &(smtp)&
26455 transport. If Exim is built with TLS support, and TLS is advertised by a
26456 server, the &(smtp)& transport always tries to start a TLS session. However,
26457 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
26458 transport) to a list of server hosts for which TLS should not be used.
26459
26460 If you do not want Exim to attempt to send messages unencrypted when an attempt
26461 to set up an encrypted connection fails in any way, you can set
26462 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
26463 those hosts, delivery is always deferred if an encrypted connection cannot be
26464 set up. If there are any other hosts for the address, they are tried in the
26465 usual way.
26466
26467 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
26468 the message unencrypted. It always does this if the response to STARTTLS is
26469 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
26470 session after a success response code, what happens is controlled by the
26471 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
26472 delivery to this host is deferred, and other hosts (if available) are tried. If
26473 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
26474 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
26475 negotiation fails, Exim closes the current connection (because it is in an
26476 unknown state), opens a new one to the same host, and then tries the delivery
26477 unencrypted.
26478
26479 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
26480 transport provide the client with a certificate, which is passed to the server
26481 if it requests it. If the server is Exim, it will request a certificate only if
26482 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
26483
26484 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
26485 specifies a collection of expected server certificates.
26486 These may be the system default set (depeding on library version),
26487 a file or,
26488 depnding on liibrary version, a directory,
26489 must name a file or,
26490 for OpenSSL only (not GnuTLS), a directory.
26491 The client verifies the server's certificate
26492 against this collection, taking into account any revoked certificates that are
26493 in the list defined by &%tls_crl%&.
26494 Failure to verify fails the TLS connection unless either of the
26495 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
26496
26497 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
26498 certificate verification to the listed servers.  Verification either must
26499 or need not succeed respectively.
26500
26501 The &(smtp)& transport has two OCSP-related options:
26502 &%hosts_require_ocsp%&; a host-list for which a Certificate Status
26503 is requested and required for the connection to proceed.  The default
26504 value is empty.
26505 &%hosts_request_ocsp%&; a host-list for which (additionally)
26506 a Certificate Status is requested (but not necessarily verified).  The default
26507 value is "*" meaning that requests are made unless configured
26508 otherwise.
26509
26510 The host(s) should also be in &%hosts_require_tls%&, and
26511 &%tls_verify_certificates%& configured for the transport,
26512 for OCSP to be relevant.
26513
26514 If
26515 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
26516 list of permitted cipher suites. If either of these checks fails, delivery to
26517 the current host is abandoned, and the &(smtp)& transport tries to deliver to
26518 alternative hosts, if any.
26519
26520  &*Note*&:
26521 These options must be set in the &(smtp)& transport for Exim to use TLS when it
26522 is operating as a client. Exim does not assume that a server certificate (set
26523 by the global options of the same name) should also be used when operating as a
26524 client.
26525
26526 .vindex "&$host$&"
26527 .vindex "&$host_address$&"
26528 All the TLS options in the &(smtp)& transport are expanded before use, with
26529 &$host$& and &$host_address$& containing the name and address of the server to
26530 which the client is connected. Forced failure of an expansion causes Exim to
26531 behave as if the relevant option were unset.
26532
26533 .vindex &$tls_out_bits$&
26534 .vindex &$tls_out_cipher$&
26535 .vindex &$tls_out_peerdn$&
26536 .vindex &$tls_out_sni$&
26537 Before an SMTP connection is established, the
26538 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
26539 variables are emptied. (Until the first connection, they contain the values
26540 that were set when the message was received.) If STARTTLS is subsequently
26541 successfully obeyed, these variables are set to the relevant values for the
26542 outgoing connection.
26543
26544
26545
26546 .section "Use of TLS Server Name Indication" "SECTtlssni"
26547 .cindex "TLS" "Server Name Indication"
26548 .vindex "&$tls_in_sni$&"
26549 .oindex "&%tls_in_sni%&"
26550 With TLS1.0 or above, there is an extension mechanism by which extra
26551 information can be included at various points in the protocol.  One of these
26552 extensions, documented in RFC 6066 (and before that RFC 4366) is
26553 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
26554 client in the initial handshake, so that the server can examine the servername
26555 within and possibly choose to use different certificates and keys (and more)
26556 for this session.
26557
26558 This is analagous to HTTP's &"Host:"& header, and is the main mechanism by
26559 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
26560 address.
26561
26562 With SMTP to MX, there are the same problems here as in choosing the identity
26563 against which to validate a certificate: you can't rely on insecure DNS to
26564 provide the identity which you then cryptographically verify.  So this will
26565 be of limited use in that environment.
26566
26567 With SMTP to Submission, there is a well-defined hostname which clients are
26568 connecting to and can validate certificates against.  Thus clients &*can*&
26569 choose to include this information in the TLS negotiation.  If this becomes
26570 wide-spread, then hosters can choose to present different certificates to
26571 different clients.  Or even negotiate different cipher suites.
26572
26573 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
26574 if not empty, will be sent on a TLS session as part of the handshake.  There's
26575 nothing more to it.  Choosing a sensible value not derived insecurely is the
26576 only point of caution.  The &$tls_out_sni$& variable will be set to this string
26577 for the lifetime of the client connection (including during authentication).
26578
26579 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
26580 received from a client.
26581 It can be logged with the &%log_selector%& item &`+tls_sni`&.
26582
26583 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
26584 option (prior to expansion) then the following options will be re-expanded
26585 during TLS session handshake, to permit alternative values to be chosen:
26586
26587 .ilist
26588 .vindex "&%tls_certificate%&"
26589 &%tls_certificate%&
26590 .next
26591 .vindex "&%tls_crl%&"
26592 &%tls_crl%&
26593 .next
26594 .vindex "&%tls_privatekey%&"
26595 &%tls_privatekey%&
26596 .next
26597 .vindex "&%tls_verify_certificates%&"
26598 &%tls_verify_certificates%&
26599 .next
26600 .vindex "&%tls_ocsp_file%&"
26601 &%tls_ocsp_file%&
26602 .endlist
26603
26604 Great care should be taken to deal with matters of case, various injection
26605 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
26606 can always be referenced; it is important to remember that &$tls_sni$& is
26607 arbitrary unverified data provided prior to authentication.
26608
26609 The Exim developers are proceeding cautiously and so far no other TLS options
26610 are re-expanded.
26611
26612 When Exim is built againt OpenSSL, OpenSSL must have been built with support
26613 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
26614 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
26615 see &`-servername`& in the output, then OpenSSL has support.
26616
26617 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
26618 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
26619 built, then you have SNI support).
26620
26621
26622
26623 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
26624          "SECTmulmessam"
26625 .cindex "multiple SMTP deliveries with TLS"
26626 .cindex "TLS" "multiple message deliveries"
26627 Exim sends multiple messages down the same TCP/IP connection by starting up
26628 an entirely new delivery process for each message, passing the socket from
26629 one process to the next. This implementation does not fit well with the use
26630 of TLS, because there is quite a lot of state information associated with a TLS
26631 connection, not just a socket identification. Passing all the state information
26632 to a new process is not feasible. Consequently, Exim shuts down an existing TLS
26633 session before passing the socket to a new process. The new process may then
26634 try to start a new TLS session, and if successful, may try to re-authenticate
26635 if AUTH is in use, before sending the next message.
26636
26637 The RFC is not clear as to whether or not an SMTP session continues in clear
26638 after TLS has been shut down, or whether TLS may be restarted again later, as
26639 just described. However, if the server is Exim, this shutdown and
26640 reinitialization works. It is not known which (if any) other servers operate
26641 successfully if the client closes a TLS session and continues with unencrypted
26642 SMTP, but there are certainly some that do not work. For such servers, Exim
26643 should not pass the socket to another process, because the failure of the
26644 subsequent attempt to use it would cause Exim to record a temporary host error,
26645 and delay other deliveries to that host.
26646
26647 To test for this case, Exim sends an EHLO command to the server after
26648 closing down the TLS session. If this fails in any way, the connection is
26649 closed instead of being passed to a new delivery process, but no retry
26650 information is recorded.
26651
26652 There is also a manual override; you can set &%hosts_nopass_tls%& on the
26653 &(smtp)& transport to match those hosts for which Exim should not pass
26654 connections to new processes if TLS has been used.
26655
26656
26657
26658
26659 .section "Certificates and all that" "SECTcerandall"
26660 .cindex "certificate" "references to discussion"
26661 In order to understand fully how TLS works, you need to know about
26662 certificates, certificate signing, and certificate authorities. This is not the
26663 place to give a tutorial, especially as I do not know very much about it
26664 myself. Some helpful introduction can be found in the FAQ for the SSL addition
26665 to Apache, currently at
26666 .display
26667 &url(http://www.modssl.org/docs/2.7/ssl_faq.html#ToC24)
26668 .endd
26669 Other parts of the &'modssl'& documentation are also helpful, and have
26670 links to further files.
26671 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
26672 0-201-61598-3), contains both introductory and more in-depth descriptions.
26673 Some sample programs taken from the book are available from
26674 .display
26675 &url(http://www.rtfm.com/openssl-examples/)
26676 .endd
26677
26678
26679 .section "Certificate chains" "SECID186"
26680 The file named by &%tls_certificate%& may contain more than one
26681 certificate. This is useful in the case where the certificate that is being
26682 sent is validated by an intermediate certificate which the other end does
26683 not have. Multiple certificates must be in the correct order in the file.
26684 First the host's certificate itself, then the first intermediate
26685 certificate to validate the issuer of the host certificate, then the next
26686 intermediate certificate to validate the issuer of the first intermediate
26687 certificate, and so on, until finally (optionally) the root certificate.
26688 The root certificate must already be trusted by the recipient for
26689 validation to succeed, of course, but if it's not preinstalled, sending the
26690 root certificate along with the rest makes it available for the user to
26691 install if the receiving end is a client MUA that can interact with a user.
26692
26693 Note that certificates using MD5 are unlikely to work on today's Internet;
26694 even if your libraries allow loading them for use in Exim when acting as a
26695 server, increasingly clients will not accept such certificates.  The error
26696 diagnostics in such a case can be frustratingly vague.
26697
26698
26699
26700 .section "Self-signed certificates" "SECID187"
26701 .cindex "certificate" "self-signed"
26702 You can create a self-signed certificate using the &'req'& command provided
26703 with OpenSSL, like this:
26704 . ==== Do not shorten the duration here without reading and considering
26705 . ==== the text below.  Please leave it at 9999 days.
26706 .code
26707 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
26708             -days 9999 -nodes
26709 .endd
26710 &_file1_& and &_file2_& can be the same file; the key and the certificate are
26711 delimited and so can be identified independently. The &%-days%& option
26712 specifies a period for which the certificate is valid. The &%-nodes%& option is
26713 important: if you do not set it, the key is encrypted with a passphrase
26714 that you are prompted for, and any use that is made of the key causes more
26715 prompting for the passphrase. This is not helpful if you are going to use
26716 this certificate and key in an MTA, where prompting is not possible.
26717
26718 . ==== I expect to still be working 26 years from now.  The less technical
26719 . ==== debt I create, in terms of storing up trouble for my later years, the
26720 . ==== happier I will be then.  We really have reached the point where we
26721 . ==== should start, at the very least, provoking thought and making folks
26722 . ==== pause before proceeding, instead of leaving all the fixes until two
26723 . ==== years before 2^31 seconds after the 1970 Unix epoch.
26724 . ==== -pdp, 2012
26725 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
26726 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
26727 the above command might produce a date in the past.  Think carefully about
26728 the lifetime of the systems you're deploying, and either reduce the duration
26729 of the certificate or reconsider your platform deployment.  (At time of
26730 writing, reducing the duration is the most likely choice, but the inexorable
26731 progression of time takes us steadily towards an era where this will not
26732 be a sensible resolution).
26733
26734 A self-signed certificate made in this way is sufficient for testing, and
26735 may be adequate for all your requirements if you are mainly interested in
26736 encrypting transfers, and not in secure identification.
26737
26738 However, many clients require that the certificate presented by the server be a
26739 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
26740 certificate. In this situation, the self-signed certificate described above
26741 must be installed on the client host as a trusted root &'certification
26742 authority'& (CA), and the certificate used by Exim must be a user certificate
26743 signed with that self-signed certificate.
26744
26745 For information on creating self-signed CA certificates and using them to sign
26746 user certificates, see the &'General implementation overview'& chapter of the
26747 Open-source PKI book, available online at
26748 &url(http://ospkibook.sourceforge.net/).
26749 .ecindex IIDencsmtp1
26750 .ecindex IIDencsmtp2
26751
26752
26753
26754 . ////////////////////////////////////////////////////////////////////////////
26755 . ////////////////////////////////////////////////////////////////////////////
26756
26757 .chapter "Access control lists" "CHAPACL"
26758 .scindex IIDacl "&ACL;" "description"
26759 .cindex "control of incoming mail"
26760 .cindex "message" "controlling incoming"
26761 .cindex "policy control" "access control lists"
26762 Access Control Lists (ACLs) are defined in a separate section of the run time
26763 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
26764 name, terminated by a colon. Here is a complete ACL section that contains just
26765 one very small ACL:
26766 .code
26767 begin acl
26768 small_acl:
26769   accept   hosts = one.host.only
26770 .endd
26771 You can have as many lists as you like in the ACL section, and the order in
26772 which they appear does not matter. The lists are self-terminating.
26773
26774 The majority of ACLs are used to control Exim's behaviour when it receives
26775 certain SMTP commands. This applies both to incoming TCP/IP connections, and
26776 when a local process submits a message using SMTP by specifying the &%-bs%&
26777 option. The most common use is for controlling which recipients are accepted
26778 in incoming messages. In addition, you can define an ACL that is used to check
26779 local non-SMTP messages. The default configuration file contains an example of
26780 a realistic ACL for checking RCPT commands. This is discussed in chapter
26781 &<<CHAPdefconfil>>&.
26782
26783
26784 .section "Testing ACLs" "SECID188"
26785 The &%-bh%& command line option provides a way of testing your ACL
26786 configuration locally by running a fake SMTP session with which you interact.
26787 The host &'relay-test.mail-abuse.org'& provides a service for checking your
26788 relaying configuration (see section &<<SECTcheralcon>>& for more details).
26789
26790
26791
26792 .section "Specifying when ACLs are used" "SECID189"
26793 .cindex "&ACL;" "options for specifying"
26794 In order to cause an ACL to be used, you have to name it in one of the relevant
26795 options in the main part of the configuration. These options are:
26796 .cindex "AUTH" "ACL for"
26797 .cindex "DATA" "ACLs for"
26798 .cindex "ETRN" "ACL for"
26799 .cindex "EXPN" "ACL for"
26800 .cindex "HELO" "ACL for"
26801 .cindex "EHLO" "ACL for"
26802 .cindex "MAIL" "ACL for"
26803 .cindex "QUIT, ACL for"
26804 .cindex "RCPT" "ACL for"
26805 .cindex "STARTTLS, ACL for"
26806 .cindex "VRFY" "ACL for"
26807 .cindex "SMTP" "connection, ACL for"
26808 .cindex "non-SMTP messages" "ACLs for"
26809 .cindex "MIME content scanning" "ACL for"
26810 .cindex "PRDR" "ACL for"
26811
26812 .table2 140pt
26813 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
26814 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
26815 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
26816 .irow &%acl_smtp_auth%&        "ACL for AUTH"
26817 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
26818 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
26819 .irow &%acl_smtp_data_prdr%&   "ACL for each recipient, after DATA is complete"
26820 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
26821 .irow &%acl_smtp_expn%&        "ACL for EXPN"
26822 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
26823 .irow &%acl_smtp_mail%&        "ACL for MAIL"
26824 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
26825 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
26826 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
26827 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
26828 .irow &%acl_smtp_quit%&        "ACL for QUIT"
26829 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
26830 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
26831 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
26832 .endtable
26833
26834 For example, if you set
26835 .code
26836 acl_smtp_rcpt = small_acl
26837 .endd
26838 the little ACL defined above is used whenever Exim receives a RCPT command
26839 in an SMTP dialogue. The majority of policy tests on incoming messages can be
26840 done when RCPT commands arrive. A rejection of RCPT should cause the
26841 sending MTA to give up on the recipient address contained in the RCPT
26842 command, whereas rejection at other times may cause the client MTA to keep on
26843 trying to deliver the message. It is therefore recommended that you do as much
26844 testing as possible at RCPT time.
26845
26846
26847 .section "The non-SMTP ACLs" "SECID190"
26848 .cindex "non-SMTP messages" "ACLs for"
26849 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
26850 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
26851 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
26852 the state of the SMTP connection such as encryption and authentication) are not
26853 relevant and are forbidden in these ACLs. However, the sender and recipients
26854 are known, so the &%senders%& and &%sender_domains%& conditions and the
26855 &$sender_address$& and &$recipients$& variables can be used. Variables such as
26856 &$authenticated_sender$& are also available. You can specify added header lines
26857 in any of these ACLs.
26858
26859 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
26860 non-SMTP message, before any of the message has been read. (This is the
26861 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
26862 batched SMTP input, it runs after the DATA command has been reached. The
26863 result of this ACL is ignored; it cannot be used to reject a message. If you
26864 really need to, you could set a value in an ACL variable here and reject based
26865 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
26866 controls, and in particular, it can be used to set
26867 .code
26868 control = suppress_local_fixups
26869 .endd
26870 This cannot be used in the other non-SMTP ACLs because by the time they are
26871 run, it is too late.
26872
26873 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
26874 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
26875
26876 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
26877 kind of rejection is treated as permanent, because there is no way of sending a
26878 temporary error for these kinds of message.
26879
26880
26881 .section "The SMTP connect ACL" "SECID191"
26882 .cindex "SMTP" "connection, ACL for"
26883 .oindex &%smtp_banner%&
26884 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
26885 session, after the test specified by &%host_reject_connection%& (which is now
26886 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
26887 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
26888 the message override the banner message that is otherwise specified by the
26889 &%smtp_banner%& option.
26890
26891
26892 .section "The EHLO/HELO ACL" "SECID192"
26893 .cindex "EHLO" "ACL for"
26894 .cindex "HELO" "ACL for"
26895 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
26896 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
26897 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
26898 Note that a client may issue more than one EHLO or HELO command in an SMTP
26899 session, and indeed is required to issue a new EHLO or HELO after successfully
26900 setting up encryption following a STARTTLS command.
26901
26902 If the command is accepted by an &%accept%& verb that has a &%message%&
26903 modifier, the message may not contain more than one line (it will be truncated
26904 at the first newline and a panic logged if it does). Such a message cannot
26905 affect the EHLO options that are listed on the second and subsequent lines of
26906 an EHLO response.
26907
26908
26909 .section "The DATA ACLs" "SECID193"
26910 .cindex "DATA" "ACLs for"
26911 Two ACLs are associated with the DATA command, because it is two-stage
26912 command, with two responses being sent to the client.
26913 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
26914 is obeyed. This gives you control after all the RCPT commands, but before
26915 the message itself is received. It offers the opportunity to give a negative
26916 response to the DATA command before the data is transmitted. Header lines
26917 added by MAIL or RCPT ACLs are not visible at this time, but any that
26918 are defined here are visible when the &%acl_smtp_data%& ACL is run.
26919
26920 You cannot test the contents of the message, for example, to verify addresses
26921 in the headers, at RCPT time or when the DATA command is received. Such
26922 tests have to appear in the ACL that is run after the message itself has been
26923 received, before the final response to the DATA command is sent. This is
26924 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
26925 associated with the DATA command.
26926
26927 For both of these ACLs, it is not possible to reject individual recipients. An
26928 error response rejects the entire message. Unfortunately, it is known that some
26929 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
26930 before or after the data) correctly &-- they keep the message on their queues
26931 and try again later, but that is their problem, though it does waste some of
26932 your resources.
26933
26934 The &%acl_smtp_data%& ACL is run after
26935 the &%acl_smtp_data_prdr%&,
26936 the &%acl_smtp_dkim%&
26937 and the &%acl_smtp_mime%& ACLs.
26938
26939 .section "The SMTP DKIM ACL" "SECTDKIMACL"
26940 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
26941 enabled (which is the default).
26942
26943 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
26944 received, and is executed for each DKIM signature found in a message.  If not
26945 otherwise specified, the default action is to accept.
26946
26947 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
26948
26949 For details on the operation of DKIM, see chapter &<<CHAPdkim>>&.
26950
26951
26952 .section "The SMTP MIME ACL" "SECID194"
26953 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
26954 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
26955
26956 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
26957
26958
26959 .section "The SMTP PRDR ACL" "SECTPRDRACL"
26960 .cindex "PRDR" "ACL for"
26961 .oindex "&%prdr_enable%&"
26962 The &%acl_smtp_data_prdr%& ACL is available only when Exim is compiled
26963 with PRDR support enabled (which is the default).
26964 It becomes active only when the PRDR feature is negotiated between
26965 client and server for a message, and more than one recipient
26966 has been accepted.
26967
26968 The ACL test specfied by &%acl_smtp_data_prdr%& happens after a message
26969 has been recieved, and is executed once for each recipient of the message
26970 with &$local_part$& and &$domain$& valid.
26971 The test may accept, defer or deny for inividual recipients.
26972 The &%acl_smtp_data%& will still be called after this ACL and
26973 can reject the message overall, even if this ACL has accepted it
26974 for some or all recipients.
26975
26976 PRDR may be used to support per-user content filtering.  Without it
26977 one must defer any recipient after the first that has a different
26978 content-filter configuration.  With PRDR, the RCPT-time check
26979 for this can be disabled when the MAIL-time $smtp_command included
26980 "PRDR".  Any required difference in behaviour of the main DATA-time
26981 ACL should however depend on the PRDR-time ACL having run, as Exim
26982 will avoid doing so in some situations (eg.  single-recipient mails).
26983
26984 See also the &%prdr_enable%& global option
26985 and the &%hosts_try_prdr%& smtp transport option.
26986
26987 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
26988 If the ACL is not defined, processing completes as if
26989 the feature was not requested by the client.
26990
26991 .section "The QUIT ACL" "SECTQUITACL"
26992 .cindex "QUIT, ACL for"
26993 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
26994 does not affect the response code to QUIT, which is always 221. Thus, the ACL
26995 does not in fact control any access. For this reason, the only verbs that are
26996 permitted are &%accept%& and &%warn%&.
26997
26998 This ACL can be used for tasks such as custom logging at the end of an SMTP
26999 session. For example, you can use ACL variables in other ACLs to count
27000 messages, recipients, etc., and log the totals at QUIT time using one or
27001 more &%logwrite%& modifiers on a &%warn%& verb.
27002
27003 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
27004 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
27005
27006 You do not need to have a final &%accept%&, but if you do, you can use a
27007 &%message%& modifier to specify custom text that is sent as part of the 221
27008 response to QUIT.
27009
27010 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
27011 failure (for example, failure to open a log file, or when Exim is bombing out
27012 because it has detected an unrecoverable error), all SMTP commands from the
27013 client are given temporary error responses until QUIT is received or the
27014 connection is closed. In these special cases, the QUIT ACL does not run.
27015
27016
27017 .section "The not-QUIT ACL" "SECTNOTQUITACL"
27018 .vindex &$acl_smtp_notquit$&
27019 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
27020 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
27021 trouble, such as being unable to write to its log files, this ACL is not run,
27022 because it might try to do things (such as write to log files) that make the
27023 situation even worse.
27024
27025 Like the QUIT ACL, this ACL is provided to make it possible to do customized
27026 logging or to gather statistics, and its outcome is ignored. The &%delay%&
27027 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
27028 and &%warn%&.
27029
27030 .vindex &$smtp_notquit_reason$&
27031 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
27032 to a string that indicates the reason for the termination of the SMTP
27033 connection. The possible values are:
27034 .table2
27035 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
27036 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
27037 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
27038 .irow &`connection-lost`&          "The SMTP connection has been lost"
27039 .irow &`data-timeout`&             "Timeout while reading message data"
27040 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
27041 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
27042 .irow &`signal-exit`&              "SIGTERM or SIGINT"
27043 .irow &`synchronization-error`&    "SMTP synchronization error"
27044 .irow &`tls-failed`&               "TLS failed to start"
27045 .endtable
27046 In most cases when an SMTP connection is closed without having received QUIT,
27047 Exim sends an SMTP response message before actually closing the connection.
27048 With the exception of the &`acl-drop`& case, the default message can be
27049 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
27050 &%drop%& verb in another ACL, it is the message from the other ACL that is
27051 used.
27052
27053
27054 .section "Finding an ACL to use" "SECID195"
27055 .cindex "&ACL;" "finding which to use"
27056 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
27057 you can use different ACLs in different circumstances. For example,
27058 .code
27059 acl_smtp_rcpt = ${if ={25}{$interface_port} \
27060                      {acl_check_rcpt} {acl_check_rcpt_submit} }
27061 .endd
27062 In the default configuration file there are some example settings for
27063 providing an RFC 4409 message submission service on port 587 and a
27064 non-standard &"smtps"& service on port 465. You can use a string
27065 expansion like this to choose an ACL for MUAs on these ports which is
27066 more appropriate for this purpose than the default ACL on port 25.
27067
27068 The expanded string does not have to be the name of an ACL in the
27069 configuration file; there are other possibilities. Having expanded the
27070 string, Exim searches for an ACL as follows:
27071
27072 .ilist
27073 If the string begins with a slash, Exim uses it as a file name, and reads its
27074 contents as an ACL. The lines are processed in the same way as lines in the
27075 Exim configuration file. In particular, continuation lines are supported, blank
27076 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
27077 If the file does not exist or cannot be read, an error occurs (typically
27078 causing a temporary failure of whatever caused the ACL to be run). For example:
27079 .code
27080 acl_smtp_data = /etc/acls/\
27081   ${lookup{$sender_host_address}lsearch\
27082   {/etc/acllist}{$value}{default}}
27083 .endd
27084 This looks up an ACL file to use on the basis of the host's IP address, falling
27085 back to a default if the lookup fails. If an ACL is successfully read from a
27086 file, it is retained in memory for the duration of the Exim process, so that it
27087 can be re-used without having to re-read the file.
27088 .next
27089 If the string does not start with a slash, and does not contain any spaces,
27090 Exim searches the ACL section of the configuration for an ACL whose name
27091 matches the string.
27092 .next
27093 If no named ACL is found, or if the string contains spaces, Exim parses
27094 the string as an inline ACL. This can save typing in cases where you just
27095 want to have something like
27096 .code
27097 acl_smtp_vrfy = accept
27098 .endd
27099 in order to allow free use of the VRFY command. Such a string may contain
27100 newlines; it is processed in the same way as an ACL that is read from a file.
27101 .endlist
27102
27103
27104
27105
27106 .section "ACL return codes" "SECID196"
27107 .cindex "&ACL;" "return codes"
27108 Except for the QUIT ACL, which does not affect the SMTP return code (see
27109 section &<<SECTQUITACL>>& above), the result of running an ACL is either
27110 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
27111 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
27112 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
27113 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
27114 This also causes a 4&'xx'& return code.
27115
27116 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
27117 &"deny"&, because there is no mechanism for passing temporary errors to the
27118 submitters of non-SMTP messages.
27119
27120
27121 ACLs that are relevant to message reception may also return &"discard"&. This
27122 has the effect of &"accept"&, but causes either the entire message or an
27123 individual recipient address to be discarded. In other words, it is a
27124 blackholing facility. Use it with care.
27125
27126 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
27127 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
27128 RCPT ACL is to discard just the one recipient address. If there are no
27129 recipients left when the message's data is received, the DATA ACL is not
27130 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
27131 remaining recipients. The &"discard"& return is not permitted for the
27132 &%acl_smtp_predata%& ACL.
27133
27134
27135 .cindex "&[local_scan()]& function" "when all recipients discarded"
27136 The &[local_scan()]& function is always run, even if there are no remaining
27137 recipients; it may create new recipients.
27138
27139
27140
27141 .section "Unset ACL options" "SECID197"
27142 .cindex "&ACL;" "unset options"
27143 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
27144 all the same. &*Note*&: These defaults apply only when the relevant ACL is
27145 not defined at all. For any defined ACL, the default action when control
27146 reaches the end of the ACL statements is &"deny"&.
27147
27148 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
27149 these two are ACLs that are used only for their side effects. They cannot be
27150 used to accept or reject anything.
27151
27152 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
27153 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
27154 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
27155 when the ACL is not defined is &"accept"&.
27156
27157 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
27158 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
27159 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
27160 messages over an SMTP connection. For an example, see the ACL in the default
27161 configuration file.
27162
27163
27164
27165
27166 .section "Data for message ACLs" "SECID198"
27167 .cindex "&ACL;" "data for message ACL"
27168 .vindex &$domain$&
27169 .vindex &$local_part$&
27170 .vindex &$sender_address$&
27171 .vindex &$sender_host_address$&
27172 .vindex &$smtp_command$&
27173 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
27174 that contain information about the host and the message's sender (for example,
27175 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
27176 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
27177 &$local_part$& are set from the argument address. The entire SMTP command
27178 is available in &$smtp_command$&.
27179
27180 When an ACL for the AUTH parameter of MAIL is running, the variables that
27181 contain information about the host are set, but &$sender_address$& is not yet
27182 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
27183 how it is used.
27184
27185 .vindex "&$message_size$&"
27186 The &$message_size$& variable is set to the value of the SIZE parameter on
27187 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
27188 that parameter is not given. The value is updated to the true message size by
27189 the time the final DATA ACL is run (after the message data has been
27190 received).
27191
27192 .vindex "&$rcpt_count$&"
27193 .vindex "&$recipients_count$&"
27194 The &$rcpt_count$& variable increases by one for each RCPT command received.
27195 The &$recipients_count$& variable increases by one each time a RCPT command is
27196 accepted, so while an ACL for RCPT is being processed, it contains the number
27197 of previously accepted recipients. At DATA time (for both the DATA ACLs),
27198 &$rcpt_count$& contains the total number of RCPT commands, and
27199 &$recipients_count$& contains the total number of accepted recipients.
27200
27201
27202
27203
27204
27205 .section "Data for non-message ACLs" "SECTdatfornon"
27206 .cindex "&ACL;" "data for non-message ACL"
27207 .vindex &$smtp_command_argument$&
27208 .vindex &$smtp_command$&
27209 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
27210 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
27211 and the entire SMTP command is available in &$smtp_command$&.
27212 These variables can be tested using a &%condition%& condition. For example,
27213 here is an ACL for use with AUTH, which insists that either the session is
27214 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
27215 does not permit authentication methods that use cleartext passwords on
27216 unencrypted connections.
27217 .code
27218 acl_check_auth:
27219   accept encrypted = *
27220   accept condition = ${if eq{${uc:$smtp_command_argument}}\
27221                      {CRAM-MD5}}
27222   deny   message   = TLS encryption or CRAM-MD5 required
27223 .endd
27224 (Another way of applying this restriction is to arrange for the authenticators
27225 that use cleartext passwords not to be advertised when the connection is not
27226 encrypted. You can use the generic &%server_advertise_condition%& authenticator
27227 option to do this.)
27228
27229
27230
27231 .section "Format of an ACL" "SECID199"
27232 .cindex "&ACL;" "format of"
27233 .cindex "&ACL;" "verbs, definition of"
27234 An individual ACL consists of a number of statements. Each statement starts
27235 with a verb, optionally followed by a number of conditions and &"modifiers"&.
27236 Modifiers can change the way the verb operates, define error and log messages,
27237 set variables, insert delays, and vary the processing of accepted messages.
27238
27239 If all the conditions are met, the verb is obeyed. The same condition may be
27240 used (with different arguments) more than once in the same statement. This
27241 provides a means of specifying an &"and"& conjunction between conditions. For
27242 example:
27243 .code
27244 deny  dnslists = list1.example
27245 dnslists = list2.example
27246 .endd
27247 If there are no conditions, the verb is always obeyed. Exim stops evaluating
27248 the conditions and modifiers when it reaches a condition that fails. What
27249 happens then depends on the verb (and in one case, on a special modifier). Not
27250 all the conditions make sense at every testing point. For example, you cannot
27251 test a sender address in the ACL that is run for a VRFY command.
27252
27253
27254 .section "ACL verbs" "SECID200"
27255 The ACL verbs are as follows:
27256
27257 .ilist
27258 .cindex "&%accept%& ACL verb"
27259 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
27260 of the conditions are not met, what happens depends on whether &%endpass%&
27261 appears among the conditions (for syntax see below). If the failing condition
27262 is before &%endpass%&, control is passed to the next ACL statement; if it is
27263 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
27264 check a RCPT command:
27265 .code
27266 accept domains = +local_domains
27267 endpass
27268 verify = recipient
27269 .endd
27270 If the recipient domain does not match the &%domains%& condition, control
27271 passes to the next statement. If it does match, the recipient is verified, and
27272 the command is accepted if verification succeeds. However, if verification
27273 fails, the ACL yields &"deny"&, because the failing condition is after
27274 &%endpass%&.
27275
27276 The &%endpass%& feature has turned out to be confusing to many people, so its
27277 use is not recommended nowadays. It is always possible to rewrite an ACL so
27278 that &%endpass%& is not needed, and it is no longer used in the default
27279 configuration.
27280
27281 .cindex "&%message%& ACL modifier" "with &%accept%&"
27282 If a &%message%& modifier appears on an &%accept%& statement, its action
27283 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
27284 (when an &%accept%& verb either accepts or passes control to the next
27285 statement), &%message%& can be used to vary the message that is sent when an
27286 SMTP command is accepted. For example, in a RCPT ACL you could have:
27287 .display
27288 &`accept  `&<&'some conditions'&>
27289 &`        message = OK, I will allow you through today`&
27290 .endd
27291 You can specify an SMTP response code, optionally followed by an &"extended
27292 response code"& at the start of the message, but the first digit must be the
27293 same as would be sent by default, which is 2 for an &%accept%& verb.
27294
27295 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
27296 an error message that is used when access is denied. This behaviour is retained
27297 for backward compatibility, but current &"best practice"& is to avoid the use
27298 of &%endpass%&.
27299
27300
27301 .next
27302 .cindex "&%defer%& ACL verb"
27303 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
27304 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
27305 &%defer%& is the same as &%deny%&, because there is no way of sending a
27306 temporary error. For a RCPT command, &%defer%& is much the same as using a
27307 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
27308 be used in any ACL, and even for a recipient it might be a simpler approach.
27309
27310
27311 .next
27312 .cindex "&%deny%& ACL verb"
27313 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
27314 the conditions are not met, control is passed to the next ACL statement. For
27315 example,
27316 .code
27317 deny dnslists = blackholes.mail-abuse.org
27318 .endd
27319 rejects commands from hosts that are on a DNS black list.
27320
27321
27322 .next
27323 .cindex "&%discard%& ACL verb"
27324 &%discard%&: This verb behaves like &%accept%&, except that it returns
27325 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
27326 that are concerned with receiving messages. When all the conditions are true,
27327 the sending entity receives a &"success"& response. However, &%discard%& causes
27328 recipients to be discarded. If it is used in an ACL for RCPT, just the one
27329 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
27330 message's recipients are discarded. Recipients that are discarded before DATA
27331 do not appear in the log line when the &%received_recipients%& log selector is set.
27332
27333 If the &%log_message%& modifier is set when &%discard%& operates,
27334 its contents are added to the line that is automatically written to the log.
27335 The &%message%& modifier operates exactly as it does for &%accept%&.
27336
27337
27338 .next
27339 .cindex "&%drop%& ACL verb"
27340 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
27341 forcibly closed after the 5&'xx'& error message has been sent. For example:
27342 .code
27343 drop   message   = I don't take more than 20 RCPTs
27344        condition = ${if > {$rcpt_count}{20}}
27345 .endd
27346 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
27347 The connection is always dropped after sending a 550 response.
27348
27349 .next
27350 .cindex "&%require%& ACL verb"
27351 &%require%&: If all the conditions are met, control is passed to the next ACL
27352 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
27353 example, when checking a RCPT command,
27354 .code
27355 require message = Sender did not verify
27356         verify  = sender
27357 .endd
27358 passes control to subsequent statements only if the message's sender can be
27359 verified. Otherwise, it rejects the command. Note the positioning of the
27360 &%message%& modifier, before the &%verify%& condition. The reason for this is
27361 discussed in section &<<SECTcondmodproc>>&.
27362
27363 .next
27364 .cindex "&%warn%& ACL verb"
27365 &%warn%&: If all the conditions are true, a line specified by the
27366 &%log_message%& modifier is written to Exim's main log. Control always passes
27367 to the next ACL statement. If any condition is false, the log line is not
27368 written. If an identical log line is requested several times in the same
27369 message, only one copy is actually written to the log. If you want to force
27370 duplicates to be written, use the &%logwrite%& modifier instead.
27371
27372 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
27373 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
27374 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
27375 first failing condition. There is more about adding header lines in section
27376 &<<SECTaddheadacl>>&.
27377
27378 If any condition on a &%warn%& statement cannot be completed (that is, there is
27379 some sort of defer), the log line specified by &%log_message%& is not written.
27380 This does not include the case of a forced failure from a lookup, which
27381 is considered to be a successful completion. After a defer, no further
27382 conditions or modifiers in the &%warn%& statement are processed. The incident
27383 is logged, and the ACL continues to be processed, from the next statement
27384 onwards.
27385
27386
27387 .vindex "&$acl_verify_message$&"
27388 When one of the &%warn%& conditions is an address verification that fails, the
27389 text of the verification failure message is in &$acl_verify_message$&. If you
27390 want this logged, you must set it up explicitly. For example:
27391 .code
27392 warn   !verify = sender
27393        log_message = sender verify failed: $acl_verify_message
27394 .endd
27395 .endlist
27396
27397 At the end of each ACL there is an implicit unconditional &%deny%&.
27398
27399 As you can see from the examples above, the conditions and modifiers are
27400 written one to a line, with the first one on the same line as the verb, and
27401 subsequent ones on following lines. If you have a very long condition, you can
27402 continue it onto several physical lines by the usual backslash continuation
27403 mechanism. It is conventional to align the conditions vertically.
27404
27405
27406
27407 .section "ACL variables" "SECTaclvariables"
27408 .cindex "&ACL;" "variables"
27409 There are some special variables that can be set during ACL processing. They
27410 can be used to pass information between different ACLs, different invocations
27411 of the same ACL in the same SMTP connection, and between ACLs and the routers,
27412 transports, and filters that are used to deliver a message. The names of these
27413 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
27414 an underscore, but the remainder of the name can be any sequence of
27415 alphanumeric characters and underscores that you choose. There is no limit on
27416 the number of ACL variables. The two sets act as follows:
27417 .ilist
27418 The values of those variables whose names begin with &$acl_c$& persist
27419 throughout an SMTP connection. They are never reset. Thus, a value that is set
27420 while receiving one message is still available when receiving the next message
27421 on the same SMTP connection.
27422 .next
27423 The values of those variables whose names begin with &$acl_m$& persist only
27424 while a message is being received. They are reset afterwards. They are also
27425 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
27426 .endlist
27427
27428 When a message is accepted, the current values of all the ACL variables are
27429 preserved with the message and are subsequently made available at delivery
27430 time. The ACL variables are set by a modifier called &%set%&. For example:
27431 .code
27432 accept hosts = whatever
27433        set acl_m4 = some value
27434 accept authenticated = *
27435        set acl_c_auth = yes
27436 .endd
27437 &*Note*&: A leading dollar sign is not used when naming a variable that is to
27438 be set. If you want to set a variable without taking any action, you can use a
27439 &%warn%& verb without any other modifiers or conditions.
27440
27441 .oindex &%strict_acl_vars%&
27442 What happens if a syntactically valid but undefined ACL variable is
27443 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
27444 false (the default), an empty string is substituted; if it is true, an
27445 error is generated.
27446
27447 Versions of Exim before 4.64 have a limited set of numbered variables, but
27448 their names are compatible, so there is no problem with upgrading.
27449
27450
27451 .section "Condition and modifier processing" "SECTcondmodproc"
27452 .cindex "&ACL;" "conditions; processing"
27453 .cindex "&ACL;" "modifiers; processing"
27454 An exclamation mark preceding a condition negates its result. For example:
27455 .code
27456 deny   domains = *.dom.example
27457       !verify  = recipient
27458 .endd
27459 causes the ACL to return &"deny"& if the recipient domain ends in
27460 &'dom.example'& and the recipient address cannot be verified. Sometimes
27461 negation can be used on the right-hand side of a condition. For example, these
27462 two statements are equivalent:
27463 .code
27464 deny  hosts = !192.168.3.4
27465 deny !hosts =  192.168.3.4
27466 .endd
27467 However, for many conditions (&%verify%& being a good example), only left-hand
27468 side negation of the whole condition is possible.
27469
27470 The arguments of conditions and modifiers are expanded. A forced failure
27471 of an expansion causes a condition to be ignored, that is, it behaves as if the
27472 condition is true. Consider these two statements:
27473 .code
27474 accept  senders = ${lookup{$host_name}lsearch\
27475                   {/some/file}{$value}fail}
27476 accept  senders = ${lookup{$host_name}lsearch\
27477                   {/some/file}{$value}{}}
27478 .endd
27479 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
27480 the returned list is searched, but if the lookup fails the behaviour is
27481 different in the two cases. The &%fail%& in the first statement causes the
27482 condition to be ignored, leaving no further conditions. The &%accept%& verb
27483 therefore succeeds. The second statement, however, generates an empty list when
27484 the lookup fails. No sender can match an empty list, so the condition fails,
27485 and therefore the &%accept%& also fails.
27486
27487 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
27488 specify actions that are taken as the conditions for a statement are checked;
27489 others specify text for messages that are used when access is denied or a
27490 warning is generated. The &%control%& modifier affects the way an incoming
27491 message is handled.
27492
27493 The positioning of the modifiers in an ACL statement is important, because the
27494 processing of a verb ceases as soon as its outcome is known. Only those
27495 modifiers that have already been encountered will take effect. For example,
27496 consider this use of the &%message%& modifier:
27497 .code
27498 require message = Can't verify sender
27499         verify  = sender
27500         message = Can't verify recipient
27501         verify  = recipient
27502         message = This message cannot be used
27503 .endd
27504 If sender verification fails, Exim knows that the result of the statement is
27505 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
27506 so its text is used as the error message. If sender verification succeeds, but
27507 recipient verification fails, the second message is used. If recipient
27508 verification succeeds, the third message becomes &"current"&, but is never used
27509 because there are no more conditions to cause failure.
27510
27511 For the &%deny%& verb, on the other hand, it is always the last &%message%&
27512 modifier that is used, because all the conditions must be true for rejection to
27513 happen. Specifying more than one &%message%& modifier does not make sense, and
27514 the message can even be specified after all the conditions. For example:
27515 .code
27516 deny   hosts = ...
27517       !senders = *@my.domain.example
27518        message = Invalid sender from client host
27519 .endd
27520 The &"deny"& result does not happen until the end of the statement is reached,
27521 by which time Exim has set up the message.
27522
27523
27524
27525 .section "ACL modifiers" "SECTACLmodi"
27526 .cindex "&ACL;" "modifiers; list of"
27527 The ACL modifiers are as follows:
27528
27529 .vlist
27530 .vitem &*add_header*&&~=&~<&'text'&>
27531 This modifier specifies one or more header lines that are to be added to an
27532 incoming message, assuming, of course, that the message is ultimately
27533 accepted. For details, see section &<<SECTaddheadacl>>&.
27534
27535 .vitem &*continue*&&~=&~<&'text'&>
27536 .cindex "&%continue%& ACL modifier"
27537 .cindex "database" "updating in ACL"
27538 This modifier does nothing of itself, and processing of the ACL always
27539 continues with the next condition or modifier. The value of &%continue%& is in
27540 the side effects of expanding its argument. Typically this could be used to
27541 update a database. It is really just a syntactic tidiness, to avoid having to
27542 write rather ugly lines like this:
27543 .display
27544 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
27545 .endd
27546 Instead, all you need is
27547 .display
27548 &`continue = `&<&'some expansion'&>
27549 .endd
27550
27551 .vitem &*control*&&~=&~<&'text'&>
27552 .cindex "&%control%& ACL modifier"
27553 This modifier affects the subsequent processing of the SMTP connection or of an
27554 incoming message that is accepted. The effect of the first type of control
27555 lasts for the duration of the connection, whereas the effect of the second type
27556 lasts only until the current message has been received. The message-specific
27557 controls always apply to the whole message, not to individual recipients,
27558 even if the &%control%& modifier appears in a RCPT ACL.
27559
27560 As there are now quite a few controls that can be applied, they are described
27561 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
27562 in several different ways. For example:
27563
27564 . ==== As this is a nested list, any displays it contains must be indented
27565 . ==== as otherwise they are too far to the left. That comment applies only
27566 . ==== when xmlto and fop are used; formatting with sdop gets it right either
27567 . ==== way.
27568
27569 .ilist
27570 It can be at the end of an &%accept%& statement:
27571 .code
27572     accept  ...some conditions
27573             control = queue_only
27574 .endd
27575 In this case, the control is applied when this statement yields &"accept"&, in
27576 other words, when the conditions are all true.
27577
27578 .next
27579 It can be in the middle of an &%accept%& statement:
27580 .code
27581     accept  ...some conditions...
27582             control = queue_only
27583             ...some more conditions...
27584 .endd
27585 If the first set of conditions are true, the control is applied, even if the
27586 statement does not accept because one of the second set of conditions is false.
27587 In this case, some subsequent statement must yield &"accept"& for the control
27588 to be relevant.
27589
27590 .next
27591 It can be used with &%warn%& to apply the control, leaving the
27592 decision about accepting or denying to a subsequent verb. For
27593 example:
27594 .code
27595     warn    ...some conditions...
27596             control = freeze
27597     accept  ...
27598 .endd
27599 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
27600 &%logwrite%&, so it does not add anything to the message and does not write a
27601 log entry.
27602
27603 .next
27604 If you want to apply a control unconditionally, you can use it with a
27605 &%require%& verb. For example:
27606 .code
27607     require  control = no_multiline_responses
27608 .endd
27609 .endlist
27610
27611 .vitem &*delay*&&~=&~<&'time'&>
27612 .cindex "&%delay%& ACL modifier"
27613 .oindex "&%-bh%&"
27614 This modifier may appear in any ACL except notquit. It causes Exim to wait for
27615 the time interval before proceeding. However, when testing Exim using the
27616 &%-bh%& option, the delay is not actually imposed (an appropriate message is
27617 output instead). The time is given in the usual Exim notation, and the delay
27618 happens as soon as the modifier is processed. In an SMTP session, pending
27619 output is flushed before the delay is imposed.
27620
27621 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
27622 example:
27623 .code
27624 deny    ...some conditions...
27625         delay = 30s
27626 .endd
27627 The delay happens if all the conditions are true, before the statement returns
27628 &"deny"&. Compare this with:
27629 .code
27630 deny    delay = 30s
27631         ...some conditions...
27632 .endd
27633 which waits for 30s before processing the conditions. The &%delay%& modifier
27634 can also be used with &%warn%& and together with &%control%&:
27635 .code
27636 warn    ...some conditions...
27637         delay = 2m
27638         control = freeze
27639 accept  ...
27640 .endd
27641
27642 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
27643 responses to several commands are no longer buffered and sent in one packet (as
27644 they would normally be) because all output is flushed before imposing the
27645 delay. This optimization is disabled so that a number of small delays do not
27646 appear to the client as one large aggregated delay that might provoke an
27647 unwanted timeout. You can, however, disable output flushing for &%delay%& by
27648 using a &%control%& modifier to set &%no_delay_flush%&.
27649
27650
27651 .vitem &*endpass*&
27652 .cindex "&%endpass%& ACL modifier"
27653 This modifier, which has no argument, is recognized only in &%accept%& and
27654 &%discard%& statements. It marks the boundary between the conditions whose
27655 failure causes control to pass to the next statement, and the conditions whose
27656 failure causes the ACL to return &"deny"&. This concept has proved to be
27657 confusing to some people, so the use of &%endpass%& is no longer recommended as
27658 &"best practice"&. See the description of &%accept%& above for more details.
27659
27660
27661 .vitem &*log_message*&&~=&~<&'text'&>
27662 .cindex "&%log_message%& ACL modifier"
27663 This modifier sets up a message that is used as part of the log message if the
27664 ACL denies access or a &%warn%& statement's conditions are true. For example:
27665 .code
27666 require log_message = wrong cipher suite $tls_in_cipher
27667         encrypted   = DES-CBC3-SHA
27668 .endd
27669 &%log_message%& is also used when recipients are discarded by &%discard%&. For
27670 example:
27671 .display
27672 &`discard `&<&'some conditions'&>
27673 &`        log_message = Discarded $local_part@$domain because...`&
27674 .endd
27675 When access is denied, &%log_message%& adds to any underlying error message
27676 that may exist because of a condition failure. For example, while verifying a
27677 recipient address, a &':fail:'& redirection might have already set up a
27678 message.
27679
27680 The message may be defined before the conditions to which it applies, because
27681 the string expansion does not happen until Exim decides that access is to be
27682 denied. This means that any variables that are set by the condition are
27683 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
27684 variables are set after a DNS black list lookup succeeds. If the expansion of
27685 &%log_message%& fails, or if the result is an empty string, the modifier is
27686 ignored.
27687
27688 .vindex "&$acl_verify_message$&"
27689 If you want to use a &%warn%& statement to log the result of an address
27690 verification, you can use &$acl_verify_message$& to include the verification
27691 error message.
27692
27693 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
27694 the start of the logged message. If the same warning log message is requested
27695 more than once while receiving  a single email message, only one copy is
27696 actually logged. If you want to log multiple copies, use &%logwrite%& instead
27697 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
27698 is logged for a successful &%warn%& statement.
27699
27700 If &%log_message%& is not present and there is no underlying error message (for
27701 example, from the failure of address verification), but &%message%& is present,
27702 the &%message%& text is used for logging rejections. However, if any text for
27703 logging contains newlines, only the first line is logged. In the absence of
27704 both &%log_message%& and &%message%&, a default built-in message is used for
27705 logging rejections.
27706
27707
27708 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
27709 .cindex "&%log_reject_target%& ACL modifier"
27710 .cindex "logging in ACL" "specifying which log"
27711 This modifier makes it possible to specify which logs are used for messages
27712 about ACL rejections. Its argument is a colon-separated list of words that can
27713 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
27714 may be empty, in which case a rejection is not logged at all. For example, this
27715 ACL fragment writes no logging information when access is denied:
27716 .display
27717 &`deny `&<&'some conditions'&>
27718 &`     log_reject_target =`&
27719 .endd
27720 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
27721 permanent and temporary rejections. Its effect lasts for the rest of the
27722 current ACL.
27723
27724
27725 .vitem &*logwrite*&&~=&~<&'text'&>
27726 .cindex "&%logwrite%& ACL modifier"
27727 .cindex "logging in ACL" "immediate"
27728 This modifier writes a message to a log file as soon as it is encountered when
27729 processing an ACL. (Compare &%log_message%&, which, except in the case of
27730 &%warn%& and &%discard%&, is used only if the ACL statement denies
27731 access.) The &%logwrite%& modifier can be used to log special incidents in
27732 ACLs. For example:
27733 .display
27734 &`accept `&<&'some special conditions'&>
27735 &`       control  = freeze`&
27736 &`       logwrite = froze message because ...`&
27737 .endd
27738 By default, the message is written to the main log. However, it may begin
27739 with a colon, followed by a comma-separated list of log names, and then
27740 another colon, to specify exactly which logs are to be written. For
27741 example:
27742 .code
27743 logwrite = :main,reject: text for main and reject logs
27744 logwrite = :panic: text for panic log only
27745 .endd
27746
27747
27748 .vitem &*message*&&~=&~<&'text'&>
27749 .cindex "&%message%& ACL modifier"
27750 This modifier sets up a text string that is expanded and used as a response
27751 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
27752 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
27753 there is some complication if &%endpass%& is involved; see the description of
27754 &%accept%& for details.)
27755
27756 The expansion of the message happens at the time Exim decides that the ACL is
27757 to end, not at the time it processes &%message%&. If the expansion fails, or
27758 generates an empty string, the modifier is ignored. Here is an example where
27759 &%message%& must be specified first, because the ACL ends with a rejection if
27760 the &%hosts%& condition fails:
27761 .code
27762 require  message = Host not recognized
27763          hosts = 10.0.0.0/8
27764 .endd
27765 (Once a condition has failed, no further conditions or modifiers are
27766 processed.)
27767
27768 .cindex "SMTP" "error codes"
27769 .oindex "&%smtp_banner%&
27770 For ACLs that are triggered by SMTP commands, the message is returned as part
27771 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
27772 is meaningful only for SMTP, as no message is returned when a non-SMTP message
27773 is accepted. In the case of the connect ACL, accepting with a message modifier
27774 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
27775 accept message may not contain more than one line (otherwise it will be
27776 truncated at the first newline and a panic logged), and it cannot affect the
27777 EHLO options.
27778
27779 When SMTP is involved, the message may begin with an overriding response code,
27780 consisting of three digits optionally followed by an &"extended response code"&
27781 of the form &'n.n.n'&, each code being followed by a space. For example:
27782 .code
27783 deny  message = 599 1.2.3 Host not welcome
27784       hosts = 192.168.34.0/24
27785 .endd
27786 The first digit of the supplied response code must be the same as would be sent
27787 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
27788 access, but for the predata ACL, note that the default success code is 354, not
27789 2&'xx'&.
27790
27791 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
27792 the message modifier cannot override the 221 response code.
27793
27794 The text in a &%message%& modifier is literal; any quotes are taken as
27795 literals, but because the string is expanded, backslash escapes are processed
27796 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
27797 response.
27798
27799 .vindex "&$acl_verify_message$&"
27800 For ACLs that are called by an &%acl =%& ACL condition, the message is
27801 stored in &$acl_verify_message$&, from which the calling ACL may use it.
27802
27803 If &%message%& is used on a statement that verifies an address, the message
27804 specified overrides any message that is generated by the verification process.
27805 However, the original message is available in the variable
27806 &$acl_verify_message$&, so you can incorporate it into your message if you
27807 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
27808 routers to be passed back as part of the SMTP response, you should either not
27809 use a &%message%& modifier, or make use of &$acl_verify_message$&.
27810
27811 For compatibility with previous releases of Exim, a &%message%& modifier that
27812 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
27813 modifier, but this usage is now deprecated. However, &%message%& acts only when
27814 all the conditions are true, wherever it appears in an ACL command, whereas
27815 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
27816 &%warn%& in an ACL that is not concerned with receiving a message, it has no
27817 effect.
27818
27819
27820 .vitem &*remove_header*&&~=&~<&'text'&>
27821 This modifier specifies one or more header names in a colon-separated list
27822  that are to be removed from an incoming message, assuming, of course, that
27823 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
27824
27825
27826 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
27827 .cindex "&%set%& ACL modifier"
27828 This modifier puts a value into one of the ACL variables (see section
27829 &<<SECTaclvariables>>&).
27830
27831
27832 .vitem &*udpsend*&&~=&~<&'parameters'&>
27833 This modifier sends a UDP packet, for purposes such as statistics
27834 collection or behaviour monitoring. The parameters are expanded, and
27835 the result of the expansion must be a colon-separated list consisting
27836 of a destination server, port number, and the packet contents. The
27837 server can be specified as a host name or IPv4 or IPv6 address. The
27838 separator can be changed with the usual angle bracket syntax. For
27839 example, you might want to collect information on which hosts connect
27840 when:
27841 .code
27842 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
27843              $tod_zulu $sender_host_address
27844 .endd
27845 .endlist
27846
27847
27848
27849
27850 .section "Use of the control modifier" "SECTcontrols"
27851 .cindex "&%control%& ACL modifier"
27852 The &%control%& modifier supports the following settings:
27853
27854 .vlist
27855 .vitem &*control&~=&~allow_auth_unadvertised*&
27856 This modifier allows a client host to use the SMTP AUTH command even when it
27857 has not been advertised in response to EHLO. Furthermore, because there are
27858 apparently some really broken clients that do this, Exim will accept AUTH after
27859 HELO (rather than EHLO) when this control is set. It should be used only if you
27860 really need it, and you should limit its use to those broken clients that do
27861 not work without it. For example:
27862 .code
27863 warn hosts   = 192.168.34.25
27864      control = allow_auth_unadvertised
27865 .endd
27866 Normally, when an Exim server receives an AUTH command, it checks the name of
27867 the authentication mechanism that is given in the command to ensure that it
27868 matches an advertised mechanism. When this control is set, the check that a
27869 mechanism has been advertised is bypassed. Any configured mechanism can be used
27870 by the client. This control is permitted only in the connection and HELO ACLs.
27871
27872
27873 .vitem &*control&~=&~caseful_local_part*& &&&
27874        &*control&~=&~caselower_local_part*&
27875 .cindex "&ACL;" "case of local part in"
27876 .cindex "case of local parts"
27877 .vindex "&$local_part$&"
27878 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
27879 (that is, during RCPT processing). By default, the contents of &$local_part$&
27880 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
27881 any uppercase letters in the original local part are restored in &$local_part$&
27882 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
27883 is encountered.
27884
27885 These controls affect only the current recipient. Moreover, they apply only to
27886 local part handling that takes place directly in the ACL (for example, as a key
27887 in lookups). If a test to verify the recipient is obeyed, the case-related
27888 handling of the local part during the verification is controlled by the router
27889 configuration (see the &%caseful_local_part%& generic router option).
27890
27891 This facility could be used, for example, to add a spam score to local parts
27892 containing upper case letters. For example, using &$acl_m4$& to accumulate the
27893 spam score:
27894 .code
27895 warn  control = caseful_local_part
27896       set acl_m4 = ${eval:\
27897                      $acl_m4 + \
27898                      ${if match{$local_part}{[A-Z]}{1}{0}}\
27899                     }
27900       control = caselower_local_part
27901 .endd
27902 Notice that we put back the lower cased version afterwards, assuming that
27903 is what is wanted for subsequent tests.
27904
27905
27906 .vitem &*control&~=&~cutthrough_delivery*&
27907 .cindex "&ACL;" "cutthrough routing"
27908 .cindex "cutthrough" "requesting"
27909 This option requests delivery be attempted while the item is being received.
27910
27911 The option usable in the RCPT ACL.
27912 If enabled for a message recieved via smtp and routed to an smtp transport,
27913 and the message has only one recipient,
27914 then the delivery connection is made while the receiving connection is open
27915 and data is copied from one to the other.
27916
27917 If a recipient-verify callout connection is subsequently
27918 requested in the same ACL it is held open and used for the data,
27919 otherwise one is made after the initial RCPT ACL completes.
27920
27921 Note that routers are used in verify mode,
27922 and cannot depend on content of received headers.
27923 Note also that headers cannot be
27924 modified by any of the post-data ACLs (DATA, MIME and DKIM).
27925 Headers may be modified by routers (subject to the above) and transports.
27926
27927 Cutthrough delivery is not supported via transport-filters or when DKIM signing
27928 of outgoing messages is done, because it sends data to the ultimate destination
27929 before the entire message has been received from the source.
27930
27931 Should the ultimate destination system positively accept or reject the mail,
27932 a corresponding indication is given to the source system and nothing is queued.
27933 If there is a temporary error the item is queued for later delivery in the
27934 usual fashion. If the item is successfully delivered in cutthrough mode
27935 the log line is tagged with ">>" rather than "=>" and appears
27936 before the acceptance "<=" line.
27937
27938 Delivery in this mode avoids the generation of a bounce mail to a
27939 (possibly faked)
27940 sender when the destination system is doing content-scan based rejection.
27941
27942
27943 .vitem &*control&~=&~debug/*&<&'options'&>
27944 .cindex "&ACL;" "enabling debug logging"
27945 .cindex "debugging" "enabling from an ACL"
27946 This control turns on debug logging, almost as though Exim had been invoked
27947 with &`-d`&, with the output going to a new logfile, by default called
27948 &'debuglog'&.  The filename can be adjusted with the &'tag'& option, which
27949 may access any variables already defined.  The logging may be adjusted with
27950 the &'opts'& option, which takes the same values as the &`-d`& command-line
27951 option.  Some examples (which depend on variables that don't exist in all
27952 contexts):
27953 .code
27954       control = debug
27955       control = debug/tag=.$sender_host_address
27956       control = debug/opts=+expand+acl
27957       control = debug/tag=.$message_exim_id/opts=+expand
27958 .endd
27959
27960
27961 .vitem &*control&~=&~dkim_disable_verify*&
27962 .cindex "disable DKIM verify"
27963 .cindex "DKIM" "disable verify"
27964 This control turns off DKIM verification processing entirely.  For details on
27965 the operation and configuration of DKIM, see chapter &<<CHAPdkim>>&.
27966
27967
27968 .vitem &*control&~=&~dscp/*&<&'value'&>
27969 .cindex "&ACL;" "setting DSCP value"
27970 .cindex "DSCP" "inbound"
27971 This option causes the DSCP value associated with the socket for the inbound
27972 connection to be adjusted to a given value, given as one of a number of fixed
27973 strings or to numeric value.
27974 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
27975 Common values include &`throughput`&, &`mincost`&, and on newer systems
27976 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
27977
27978 The outbound packets from Exim will be marked with this value in the header
27979 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
27980 that these values will have any effect, not be stripped by networking
27981 equipment, or do much of anything without cooperation with your Network
27982 Engineer and those of all network operators between the source and destination.
27983
27984
27985 .vitem &*control&~=&~enforce_sync*& &&&
27986        &*control&~=&~no_enforce_sync*&
27987 .cindex "SMTP" "synchronization checking"
27988 .cindex "synchronization checking in SMTP"
27989 These controls make it possible to be selective about when SMTP synchronization
27990 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
27991 state of the switch (it is true by default). See the description of this option
27992 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
27993
27994 The effect of these two controls lasts for the remainder of the SMTP
27995 connection. They can appear in any ACL except the one for the non-SMTP
27996 messages. The most straightforward place to put them is in the ACL defined by
27997 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
27998 before the first synchronization check. The expected use is to turn off the
27999 synchronization checks for badly-behaved hosts that you nevertheless need to
28000 work with.
28001
28002
28003 .vitem &*control&~=&~fakedefer/*&<&'message'&>
28004 .cindex "fake defer"
28005 .cindex "defer, fake"
28006 This control works in exactly the same way as &%fakereject%& (described below)
28007 except that it causes an SMTP 450 response after the message data instead of a
28008 550 response. You must take care when using &%fakedefer%& because it causes the
28009 messages to be duplicated when the sender retries. Therefore, you should not
28010 use &%fakedefer%& if the message is to be delivered normally.
28011
28012 .vitem &*control&~=&~fakereject/*&<&'message'&>
28013 .cindex "fake rejection"
28014 .cindex "rejection, fake"
28015 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
28016 words, only when an SMTP message is being received. If Exim accepts the
28017 message, instead the final 250 response, a 550 rejection message is sent.
28018 However, Exim proceeds to deliver the message as normal. The control applies
28019 only to the current message, not to any subsequent ones that may be received in
28020 the same SMTP connection.
28021
28022 The text for the 550 response is taken from the &%control%& modifier. If no
28023 message is supplied, the following is used:
28024 .code
28025 550-Your message has been rejected but is being
28026 550-kept for evaluation.
28027 550-If it was a legitimate message, it may still be
28028 550 delivered to the target recipient(s).
28029 .endd
28030 This facility should be used with extreme caution.
28031
28032 .vitem &*control&~=&~freeze*&
28033 .cindex "frozen messages" "forcing in ACL"
28034 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
28035 other words, only when a message is being received. If the message is accepted,
28036 it is placed on Exim's queue and frozen. The control applies only to the
28037 current message, not to any subsequent ones that may be received in the same
28038 SMTP connection.
28039
28040 This modifier can optionally be followed by &`/no_tell`&. If the global option
28041 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
28042 is told about the freezing), provided all the &*control=freeze*& modifiers that
28043 are obeyed for the current message have the &`/no_tell`& option.
28044
28045 .vitem &*control&~=&~no_delay_flush*&
28046 .cindex "SMTP" "output flushing, disabling for delay"
28047 Exim normally flushes SMTP output before implementing a delay in an ACL, to
28048 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
28049 use. This control, as long as it is encountered before the &%delay%& modifier,
28050 disables such output flushing.
28051
28052 .vitem &*control&~=&~no_callout_flush*&
28053 .cindex "SMTP" "output flushing, disabling for callout"
28054 Exim normally flushes SMTP output before performing a callout in an ACL, to
28055 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
28056 use. This control, as long as it is encountered before the &%verify%& condition
28057 that causes the callout, disables such output flushing.
28058
28059 .vitem &*control&~=&~no_mbox_unspool*&
28060 This control is available when Exim is compiled with the content scanning
28061 extension. Content scanning may require a copy of the current message, or parts
28062 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
28063 or spam scanner. Normally, such copies are deleted when they are no longer
28064 needed. If this control is set, the copies are not deleted. The control applies
28065 only to the current message, not to any subsequent ones that may be received in
28066 the same SMTP connection. It is provided for debugging purposes and is unlikely
28067 to be useful in production.
28068
28069 .vitem &*control&~=&~no_multiline_responses*&
28070 .cindex "multiline responses, suppressing"
28071 This control is permitted for any ACL except the one for non-SMTP messages.
28072 It seems that there are broken clients in use that cannot handle multiline
28073 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
28074
28075 If this control is set, multiline SMTP responses from ACL rejections are
28076 suppressed. One way of doing this would have been to put out these responses as
28077 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
28078 (&"use multiline responses for more"& it says &-- ha!), and some of the
28079 responses might get close to that. So this facility, which is after all only a
28080 sop to broken clients, is implemented by doing two very easy things:
28081
28082 .ilist
28083 Extra information that is normally output as part of a rejection caused by
28084 sender verification failure is omitted. Only the final line (typically &"sender
28085 verification failed"&) is sent.
28086 .next
28087 If a &%message%& modifier supplies a multiline response, only the first
28088 line is output.
28089 .endlist
28090
28091 The setting of the switch can, of course, be made conditional on the
28092 calling host. Its effect lasts until the end of the SMTP connection.
28093
28094 .vitem &*control&~=&~no_pipelining*&
28095 .cindex "PIPELINING" "suppressing advertising"
28096 This control turns off the advertising of the PIPELINING extension to SMTP in
28097 the current session. To be useful, it must be obeyed before Exim sends its
28098 response to an EHLO command. Therefore, it should normally appear in an ACL
28099 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
28100 &%pipelining_advertise_hosts%&.
28101
28102 .vitem &*control&~=&~queue_only*&
28103 .oindex "&%queue_only%&"
28104 .cindex "queueing incoming messages"
28105 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
28106 other words, only when a message is being received. If the message is accepted,
28107 it is placed on Exim's queue and left there for delivery by a subsequent queue
28108 runner. No immediate delivery process is started. In other words, it has the
28109 effect as the &%queue_only%& global option. However, the control applies only
28110 to the current message, not to any subsequent ones that may be received in the
28111 same SMTP connection.
28112
28113 .vitem &*control&~=&~submission/*&<&'options'&>
28114 .cindex "message" "submission"
28115 .cindex "submission mode"
28116 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
28117 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
28118 the current message is a submission from a local MUA. In this case, Exim
28119 operates in &"submission mode"&, and applies certain fixups to the message if
28120 necessary. For example, it adds a &'Date:'& header line if one is not present.
28121 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
28122 late (the message has already been created).
28123
28124 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
28125 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
28126 submission mode; the available options for this control are described there.
28127 The control applies only to the current message, not to any subsequent ones
28128 that may be received in the same SMTP connection.
28129
28130 .vitem &*control&~=&~suppress_local_fixups*&
28131 .cindex "submission fixups, suppressing"
28132 This control applies to locally submitted (non TCP/IP) messages, and is the
28133 complement of &`control = submission`&. It disables the fixups that are
28134 normally applied to locally-submitted messages. Specifically:
28135
28136 .ilist
28137 Any &'Sender:'& header line is left alone (in this respect, it is a
28138 dynamic version of &%local_sender_retain%&).
28139 .next
28140 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
28141 .next
28142 There is no check that &'From:'& corresponds to the actual sender.
28143 .endlist ilist
28144
28145 This control may be useful when a remotely-originated message is accepted,
28146 passed to some scanning program, and then re-submitted for delivery. It can be
28147 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
28148 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
28149 data is read.
28150
28151 &*Note:*& This control applies only to the current message, not to any others
28152 that are being submitted at the same time using &%-bs%& or &%-bS%&.
28153 .endlist vlist
28154
28155
28156 .section "Summary of message fixup control" "SECTsummesfix"
28157 All four possibilities for message fixups can be specified:
28158
28159 .ilist
28160 Locally submitted, fixups applied: the default.
28161 .next
28162 Locally submitted, no fixups applied: use
28163 &`control = suppress_local_fixups`&.
28164 .next
28165 Remotely submitted, no fixups applied: the default.
28166 .next
28167 Remotely submitted, fixups applied: use &`control = submission`&.
28168 .endlist
28169
28170
28171
28172 .section "Adding header lines in ACLs" "SECTaddheadacl"
28173 .cindex "header lines" "adding in an ACL"
28174 .cindex "header lines" "position of added lines"
28175 .cindex "&%add_header%& ACL modifier"
28176 The &%add_header%& modifier can be used to add one or more extra header lines
28177 to an incoming message, as in this example:
28178 .code
28179 warn dnslists = sbl.spamhaus.org : \
28180                 dialup.mail-abuse.org
28181      add_header = X-blacklisted-at: $dnslist_domain
28182 .endd
28183 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
28184 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
28185 receiving a message). The message must ultimately be accepted for
28186 &%add_header%& to have any significant effect. You can use &%add_header%& with
28187 any ACL verb, including &%deny%& (though this is potentially useful only in a
28188 RCPT ACL).
28189
28190 Headers will not be added to the message if the modifier is used in
28191 DATA, MIME or DKIM ACLs for messages delivered by cutthrough routing.
28192
28193 Leading and trailing newlines are removed from
28194 the data for the &%add_header%& modifier; if it then
28195 contains one or more newlines that
28196 are not followed by a space or a tab, it is assumed to contain multiple header
28197 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
28198 front of any line that is not a valid header line.
28199
28200 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
28201 They are added to the message before processing the DATA and MIME ACLs.
28202 However, if an identical header line is requested more than once, only one copy
28203 is actually added to the message. Further header lines may be accumulated
28204 during the DATA and MIME ACLs, after which they are added to the message, again
28205 with duplicates suppressed. Thus, it is possible to add two identical header
28206 lines to an SMTP message, but only if one is added before DATA and one after.
28207 In the case of non-SMTP messages, new headers are accumulated during the
28208 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
28209 message is rejected after DATA or by the non-SMTP ACL, all added header lines
28210 are included in the entry that is written to the reject log.
28211
28212 .cindex "header lines" "added; visibility of"
28213 Header lines are not visible in string expansions
28214 of message headers
28215 until they are added to the
28216 message. It follows that header lines defined in the MAIL, RCPT, and predata
28217 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
28218 header lines that are added by the DATA or MIME ACLs are not visible in those
28219 ACLs. Because of this restriction, you cannot use header lines as a way of
28220 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
28221 this, you can use ACL variables, as described in section
28222 &<<SECTaclvariables>>&.
28223
28224 The list of headers yet to be added is given by the &%$headers_added%& variable.
28225
28226 The &%add_header%& modifier acts immediately as it is encountered during the
28227 processing of an ACL. Notice the difference between these two cases:
28228 .display
28229 &`accept add_header = ADDED: some text`&
28230 &`       `&<&'some condition'&>
28231
28232 &`accept `&<&'some condition'&>
28233 &`       add_header = ADDED: some text`&
28234 .endd
28235 In the first case, the header line is always added, whether or not the
28236 condition is true. In the second case, the header line is added only if the
28237 condition is true. Multiple occurrences of &%add_header%& may occur in the same
28238 ACL statement. All those that are encountered before a condition fails are
28239 honoured.
28240
28241 .cindex "&%warn%& ACL verb"
28242 For compatibility with previous versions of Exim, a &%message%& modifier for a
28243 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
28244 effect only if all the conditions are true, even if it appears before some of
28245 them. Furthermore, only the last occurrence of &%message%& is honoured. This
28246 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
28247 are present on a &%warn%& verb, both are processed according to their
28248 specifications.
28249
28250 By default, new header lines are added to a message at the end of the existing
28251 header lines. However, you can specify that any particular header line should
28252 be added right at the start (before all the &'Received:'& lines), immediately
28253 after the first block of &'Received:'& lines, or immediately before any line
28254 that is not a &'Received:'& or &'Resent-something:'& header.
28255
28256 This is done by specifying &":at_start:"&, &":after_received:"&, or
28257 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
28258 header line, respectively. (Header text cannot start with a colon, as there has
28259 to be a header name first.) For example:
28260 .code
28261 warn add_header = \
28262        :after_received:X-My-Header: something or other...
28263 .endd
28264 If more than one header line is supplied in a single &%add_header%& modifier,
28265 each one is treated independently and can therefore be placed differently. If
28266 you add more than one line at the start, or after the Received: block, they end
28267 up in reverse order.
28268
28269 &*Warning*&: This facility currently applies only to header lines that are
28270 added in an ACL. It does NOT work for header lines that are added in a
28271 system filter or in a router or transport.
28272
28273
28274
28275 .section "Removing header lines in ACLs" "SECTremoveheadacl"
28276 .cindex "header lines" "removing in an ACL"
28277 .cindex "header lines" "position of removed lines"
28278 .cindex "&%remove_header%& ACL modifier"
28279 The &%remove_header%& modifier can be used to remove one or more header lines
28280 from an incoming message, as in this example:
28281 .code
28282 warn   message        = Remove internal headers
28283        remove_header  = x-route-mail1 : x-route-mail2
28284 .endd
28285 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
28286 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
28287 receiving a message). The message must ultimately be accepted for
28288 &%remove_header%& to have any significant effect. You can use &%remove_header%&
28289 with any ACL verb, including &%deny%&, though this is really not useful for
28290 any verb that doesn't result in a delivered message.
28291
28292 Headers will not be removed to the message if the modifier is used in
28293 DATA, MIME or DKIM ACLs for messages delivered by cutthrough routing.
28294
28295 More than one header can be removed at the same time by using a colon separated
28296 list of header names. The header matching is case insensitive. Wildcards are
28297 not permitted, nor is list expansion performed, so you cannot use hostlists to
28298 create a list of headers, however both connection and message variable expansion
28299 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
28300 .code
28301 warn   hosts           = +internal_hosts
28302        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
28303 warn   message         = Remove internal headers
28304        remove_header   = $acl_c_ihdrs
28305 .endd
28306 Removed header lines are accumulated during the MAIL, RCPT, and predata ACLs.
28307 They are removed from the message before processing the DATA and MIME ACLs.
28308 There is no harm in attempting to remove the same header twice nor is removing
28309 a non-existent header. Further header lines to be removed may be accumulated
28310 during the DATA and MIME ACLs, after which they are removed from the message,
28311 if present. In the case of non-SMTP messages, headers to be removed are
28312 accumulated during the non-SMTP ACLs, and are removed from the message after
28313 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
28314 ACL, there really is no effect because there is no logging of what headers
28315 would have been removed.
28316
28317 .cindex "header lines" "removed; visibility of"
28318 Header lines are not visible in string expansions until the DATA phase when it
28319 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
28320 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
28321 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
28322 this restriction, you cannot use header lines as a way of controlling data
28323 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
28324 you should instead use ACL variables, as described in section
28325 &<<SECTaclvariables>>&.
28326
28327 The &%remove_header%& modifier acts immediately as it is encountered during the
28328 processing of an ACL. Notice the difference between these two cases:
28329 .display
28330 &`accept remove_header = X-Internal`&
28331 &`       `&<&'some condition'&>
28332
28333 &`accept `&<&'some condition'&>
28334 &`       remove_header = X-Internal`&
28335 .endd
28336 In the first case, the header line is always removed, whether or not the
28337 condition is true. In the second case, the header line is removed only if the
28338 condition is true. Multiple occurrences of &%remove_header%& may occur in the
28339 same ACL statement. All those that are encountered before a condition fails
28340 are honoured.
28341
28342 &*Warning*&: This facility currently applies only to header lines that are
28343 present during ACL processing. It does NOT remove header lines that are added
28344 in a system filter or in a router or transport.
28345
28346
28347
28348
28349 .section "ACL conditions" "SECTaclconditions"
28350 .cindex "&ACL;" "conditions; list of"
28351 Some of the conditions listed in this section are available only when Exim is
28352 compiled with the content-scanning extension. They are included here briefly
28353 for completeness. More detailed descriptions can be found in the discussion on
28354 content scanning in chapter &<<CHAPexiscan>>&.
28355
28356 Not all conditions are relevant in all circumstances. For example, testing
28357 senders and recipients does not make sense in an ACL that is being run as the
28358 result of the arrival of an ETRN command, and checks on message headers can be
28359 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
28360 can use the same condition (with different parameters) more than once in the
28361 same ACL statement. This provides a way of specifying an &"and"& conjunction.
28362 The conditions are as follows:
28363
28364
28365 .vlist
28366 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
28367 .cindex "&ACL;" "nested"
28368 .cindex "&ACL;" "indirect"
28369 .cindex "&ACL;" "arguments"
28370 .cindex "&%acl%& ACL condition"
28371 The possible values of the argument are the same as for the
28372 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
28373 &"accept"& the condition is true; if it returns &"deny"& the condition is
28374 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
28375 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
28376 condition false. This means that further processing of the &%warn%& verb
28377 ceases, but processing of the ACL continues.
28378
28379 If the argument is a named ACL, up to nine space-separated optional values
28380 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
28381 and $acl_narg is set to the count of values.
28382 Previous values of these variables are restored after the call returns.
28383 The name and values are expanded separately.
28384 Note that spaces in complex expansions which are used as arguments
28385 will act as argument separators.
28386
28387 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
28388 the connection is dropped. If it returns &"discard"&, the verb must be
28389 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
28390 conditions are tested.
28391
28392 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
28393 loops. This condition allows you to use different ACLs in different
28394 circumstances. For example, different ACLs can be used to handle RCPT commands
28395 for different local users or different local domains.
28396
28397 .vitem &*authenticated&~=&~*&<&'string&~list'&>
28398 .cindex "&%authenticated%& ACL condition"
28399 .cindex "authentication" "ACL checking"
28400 .cindex "&ACL;" "testing for authentication"
28401 If the SMTP connection is not authenticated, the condition is false. Otherwise,
28402 the name of the authenticator is tested against the list. To test for
28403 authentication by any authenticator, you can set
28404 .code
28405 authenticated = *
28406 .endd
28407
28408 .vitem &*condition&~=&~*&<&'string'&>
28409 .cindex "&%condition%& ACL condition"
28410 .cindex "customizing" "ACL condition"
28411 .cindex "&ACL;" "customized test"
28412 .cindex "&ACL;" "testing, customized"
28413 This feature allows you to make up custom conditions. If the result of
28414 expanding the string is an empty string, the number zero, or one of the strings
28415 &"no"& or &"false"&, the condition is false. If the result is any non-zero
28416 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
28417 any other value, some error is assumed to have occurred, and the ACL returns
28418 &"defer"&. However, if the expansion is forced to fail, the condition is
28419 ignored. The effect is to treat it as true, whether it is positive or
28420 negative.
28421
28422 .vitem &*decode&~=&~*&<&'location'&>
28423 .cindex "&%decode%& ACL condition"
28424 This condition is available only when Exim is compiled with the
28425 content-scanning extension, and it is allowed only in the ACL defined by
28426 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
28427 If all goes well, the condition is true. It is false only if there are
28428 problems such as a syntax error or a memory shortage. For more details, see
28429 chapter &<<CHAPexiscan>>&.
28430
28431 .vitem &*demime&~=&~*&<&'extension&~list'&>
28432 .cindex "&%demime%& ACL condition"
28433 This condition is available only when Exim is compiled with the
28434 content-scanning extension. Its use is described in section
28435 &<<SECTdemimecond>>&.
28436
28437 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
28438 .cindex "&%dnslists%& ACL condition"
28439 .cindex "DNS list" "in ACL"
28440 .cindex "black list (DNS)"
28441 .cindex "&ACL;" "testing a DNS list"
28442 This condition checks for entries in DNS black lists. These are also known as
28443 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
28444 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
28445 different variants of this condition to describe briefly here. See sections
28446 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
28447
28448 .vitem &*domains&~=&~*&<&'domain&~list'&>
28449 .cindex "&%domains%& ACL condition"
28450 .cindex "domain" "ACL checking"
28451 .cindex "&ACL;" "testing a recipient domain"
28452 .vindex "&$domain_data$&"
28453 This condition is relevant only after a RCPT command. It checks that the domain
28454 of the recipient address is in the domain list. If percent-hack processing is
28455 enabled, it is done before this test is done. If the check succeeds with a
28456 lookup, the result of the lookup is placed in &$domain_data$& until the next
28457 &%domains%& test.
28458
28459 &*Note carefully*& (because many people seem to fall foul of this): you cannot
28460 use &%domains%& in a DATA ACL.
28461
28462
28463 .vitem &*encrypted&~=&~*&<&'string&~list'&>
28464 .cindex "&%encrypted%& ACL condition"
28465 .cindex "encryption" "checking in an ACL"
28466 .cindex "&ACL;" "testing for encryption"
28467 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
28468 name of the cipher suite in use is tested against the list. To test for
28469 encryption without testing for any specific cipher suite(s), set
28470 .code
28471 encrypted = *
28472 .endd
28473
28474
28475 .vitem &*hosts&~=&~*&<&'host&~list'&>
28476 .cindex "&%hosts%& ACL condition"
28477 .cindex "host" "ACL checking"
28478 .cindex "&ACL;" "testing the client host"
28479 This condition tests that the calling host matches the host list. If you have
28480 name lookups or wildcarded host names and IP addresses in the same host list,
28481 you should normally put the IP addresses first. For example, you could have:
28482 .code
28483 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
28484 .endd
28485 The lookup in this example uses the host name for its key. This is implied by
28486 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
28487 and it wouldn't matter which way round you had these two items.)
28488
28489 The reason for the problem with host names lies in the left-to-right way that
28490 Exim processes lists. It can test IP addresses without doing any DNS lookups,
28491 but when it reaches an item that requires a host name, it fails if it cannot
28492 find a host name to compare with the pattern. If the above list is given in the
28493 opposite order, the &%accept%& statement fails for a host whose name cannot be
28494 found, even if its IP address is 10.9.8.7.
28495
28496 If you really do want to do the name check first, and still recognize the IP
28497 address even if the name lookup fails, you can rewrite the ACL like this:
28498 .code
28499 accept hosts = dbm;/etc/friendly/hosts
28500 accept hosts = 10.9.8.7
28501 .endd
28502 The default action on failing to find the host name is to assume that the host
28503 is not in the list, so the first &%accept%& statement fails. The second
28504 statement can then check the IP address.
28505
28506 .vindex "&$host_data$&"
28507 If a &%hosts%& condition is satisfied by means of a lookup, the result
28508 of the lookup is made available in the &$host_data$& variable. This
28509 allows you, for example, to set up a statement like this:
28510 .code
28511 deny  hosts = net-lsearch;/some/file
28512 message = $host_data
28513 .endd
28514 which gives a custom error message for each denied host.
28515
28516 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
28517 .cindex "&%local_parts%& ACL condition"
28518 .cindex "local part" "ACL checking"
28519 .cindex "&ACL;" "testing a local part"
28520 .vindex "&$local_part_data$&"
28521 This condition is relevant only after a RCPT command. It checks that the local
28522 part of the recipient address is in the list. If percent-hack processing is
28523 enabled, it is done before this test. If the check succeeds with a lookup, the
28524 result of the lookup is placed in &$local_part_data$&, which remains set until
28525 the next &%local_parts%& test.
28526
28527 .vitem &*malware&~=&~*&<&'option'&>
28528 .cindex "&%malware%& ACL condition"
28529 .cindex "&ACL;" "virus scanning"
28530 .cindex "&ACL;" "scanning for viruses"
28531 This condition is available only when Exim is compiled with the
28532 content-scanning extension. It causes the incoming message to be scanned for
28533 viruses. For details, see chapter &<<CHAPexiscan>>&.
28534
28535 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
28536 .cindex "&%mime_regex%& ACL condition"
28537 .cindex "&ACL;" "testing by regex matching"
28538 This condition is available only when Exim is compiled with the
28539 content-scanning extension, and it is allowed only in the ACL defined by
28540 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
28541 with any of the regular expressions. For details, see chapter
28542 &<<CHAPexiscan>>&.
28543
28544 .vitem &*ratelimit&~=&~*&<&'parameters'&>
28545 .cindex "rate limiting"
28546 This condition can be used to limit the rate at which a user or host submits
28547 messages. Details are given in section &<<SECTratelimiting>>&.
28548
28549 .vitem &*recipients&~=&~*&<&'address&~list'&>
28550 .cindex "&%recipients%& ACL condition"
28551 .cindex "recipient" "ACL checking"
28552 .cindex "&ACL;" "testing a recipient"
28553 This condition is relevant only after a RCPT command. It checks the entire
28554 recipient address against a list of recipients.
28555
28556 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
28557 .cindex "&%regex%& ACL condition"
28558 .cindex "&ACL;" "testing by regex matching"
28559 This condition is available only when Exim is compiled with the
28560 content-scanning extension, and is available only in the DATA, MIME, and
28561 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
28562 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
28563
28564 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
28565 .cindex "&%sender_domains%& ACL condition"
28566 .cindex "sender" "ACL checking"
28567 .cindex "&ACL;" "testing a sender domain"
28568 .vindex "&$domain$&"
28569 .vindex "&$sender_address_domain$&"
28570 This condition tests the domain of the sender of the message against the given
28571 domain list. &*Note*&: The domain of the sender address is in
28572 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
28573 of this condition. This is an exception to the general rule for testing domain
28574 lists. It is done this way so that, if this condition is used in an ACL for a
28575 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
28576 influence the sender checking.
28577
28578 &*Warning*&: It is a bad idea to use this condition on its own as a control on
28579 relaying, because sender addresses are easily, and commonly, forged.
28580
28581 .vitem &*senders&~=&~*&<&'address&~list'&>
28582 .cindex "&%senders%& ACL condition"
28583 .cindex "sender" "ACL checking"
28584 .cindex "&ACL;" "testing a sender"
28585 This condition tests the sender of the message against the given list. To test
28586 for a bounce message, which has an empty sender, set
28587 .code
28588 senders = :
28589 .endd
28590 &*Warning*&: It is a bad idea to use this condition on its own as a control on
28591 relaying, because sender addresses are easily, and commonly, forged.
28592
28593 .vitem &*spam&~=&~*&<&'username'&>
28594 .cindex "&%spam%& ACL condition"
28595 .cindex "&ACL;" "scanning for spam"
28596 This condition is available only when Exim is compiled with the
28597 content-scanning extension. It causes the incoming message to be scanned by
28598 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
28599
28600 .vitem &*verify&~=&~certificate*&
28601 .cindex "&%verify%& ACL condition"
28602 .cindex "TLS" "client certificate verification"
28603 .cindex "certificate" "verification of client"
28604 .cindex "&ACL;" "certificate verification"
28605 .cindex "&ACL;" "testing a TLS certificate"
28606 This condition is true in an SMTP session if the session is encrypted, and a
28607 certificate was received from the client, and the certificate was verified. The
28608 server requests a certificate only if the client matches &%tls_verify_hosts%&
28609 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
28610
28611 .vitem &*verify&~=&~csa*&
28612 .cindex "CSA verification"
28613 This condition checks whether the sending host (the client) is authorized to
28614 send email. Details of how this works are given in section
28615 &<<SECTverifyCSA>>&.
28616
28617 .vitem &*verify&~=&~header_names_ascii*&
28618 .cindex "&%verify%& ACL condition"
28619 .cindex "&ACL;" "verifying header names only ASCII"
28620 .cindex "header lines" "verifying header names only ASCII"
28621 .cindex "verifying" "header names only ASCII"
28622 This condition is relevant only in an ACL that is run after a message has been
28623 received, that is, in an ACL specified by &%acl_smtp_data%& or
28624 &%acl_not_smtp%&.  It checks all header names (not the content) to make sure
28625 there are no non-ASCII characters, also excluding control characters.  The
28626 allowable characters are decimal ASCII values 33 through 126.
28627
28628 Exim itself will handle headers with non-ASCII characters, but it can cause
28629 problems for downstream applications, so this option will allow their
28630 detection and rejection in the DATA ACL's.
28631
28632 .vitem &*verify&~=&~header_sender/*&<&'options'&>
28633 .cindex "&%verify%& ACL condition"
28634 .cindex "&ACL;" "verifying sender in the header"
28635 .cindex "header lines" "verifying the sender in"
28636 .cindex "sender" "verifying in header"
28637 .cindex "verifying" "sender in header"
28638 This condition is relevant only in an ACL that is run after a message has been
28639 received, that is, in an ACL specified by &%acl_smtp_data%& or
28640 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
28641 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
28642 is loosely thought of as a &"sender"& address (hence the name of the test).
28643 However, an address that appears in one of these headers need not be an address
28644 that accepts bounce messages; only sender addresses in envelopes are required
28645 to accept bounces. Therefore, if you use the callout option on this check, you
28646 might want to arrange for a non-empty address in the MAIL command.
28647
28648 Details of address verification and the options are given later, starting at
28649 section &<<SECTaddressverification>>& (callouts are described in section
28650 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
28651 condition to restrict it to bounce messages only:
28652 .code
28653 deny    senders = :
28654         message = A valid sender header is required for bounces
28655        !verify  = header_sender
28656 .endd
28657
28658 .vitem &*verify&~=&~header_syntax*&
28659 .cindex "&%verify%& ACL condition"
28660 .cindex "&ACL;" "verifying header syntax"
28661 .cindex "header lines" "verifying syntax"
28662 .cindex "verifying" "header syntax"
28663 This condition is relevant only in an ACL that is run after a message has been
28664 received, that is, in an ACL specified by &%acl_smtp_data%& or
28665 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
28666 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
28667 and &'Bcc:'&). Unqualified addresses (local parts without domains) are
28668 permitted only in locally generated messages and from hosts that match
28669 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
28670 appropriate.
28671
28672 Note that this condition is a syntax check only. However, a common spamming
28673 ploy used to be to send syntactically invalid headers such as
28674 .code
28675 To: @
28676 .endd
28677 and this condition can be used to reject such messages, though they are not as
28678 common as they used to be.
28679
28680 .vitem &*verify&~=&~helo*&
28681 .cindex "&%verify%& ACL condition"
28682 .cindex "&ACL;" "verifying HELO/EHLO"
28683 .cindex "HELO" "verifying"
28684 .cindex "EHLO" "verifying"
28685 .cindex "verifying" "EHLO"
28686 .cindex "verifying" "HELO"
28687 This condition is true if a HELO or EHLO command has been received from the
28688 client host, and its contents have been verified. If there has been no previous
28689 attempt to verify the HELO/EHLO contents, it is carried out when this
28690 condition is encountered. See the description of the &%helo_verify_hosts%& and
28691 &%helo_try_verify_hosts%& options for details of how to request verification
28692 independently of this condition.
28693
28694 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
28695 option), this condition is always true.
28696
28697
28698 .vitem &*verify&~=&~not_blind*&
28699 .cindex "verifying" "not blind"
28700 .cindex "bcc recipients, verifying none"
28701 This condition checks that there are no blind (bcc) recipients in the message.
28702 Every envelope recipient must appear either in a &'To:'& header line or in a
28703 &'Cc:'& header line for this condition to be true. Local parts are checked
28704 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
28705 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
28706 used only in a DATA or non-SMTP ACL.
28707
28708 There are, of course, many legitimate messages that make use of blind (bcc)
28709 recipients. This check should not be used on its own for blocking messages.
28710
28711
28712 .vitem &*verify&~=&~recipient/*&<&'options'&>
28713 .cindex "&%verify%& ACL condition"
28714 .cindex "&ACL;" "verifying recipient"
28715 .cindex "recipient" "verifying"
28716 .cindex "verifying" "recipient"
28717 .vindex "&$address_data$&"
28718 This condition is relevant only after a RCPT command. It verifies the current
28719 recipient. Details of address verification are given later, starting at section
28720 &<<SECTaddressverification>>&. After a recipient has been verified, the value
28721 of &$address_data$& is the last value that was set while routing the address.
28722 This applies even if the verification fails. When an address that is being
28723 verified is redirected to a single address, verification continues with the new
28724 address, and in that case, the subsequent value of &$address_data$& is the
28725 value for the child address.
28726
28727 .vitem &*verify&~=&~reverse_host_lookup*&
28728 .cindex "&%verify%& ACL condition"
28729 .cindex "&ACL;" "verifying host reverse lookup"
28730 .cindex "host" "verifying reverse lookup"
28731 This condition ensures that a verified host name has been looked up from the IP
28732 address of the client host. (This may have happened already if the host name
28733 was needed for checking a host list, or if the host matched &%host_lookup%&.)
28734 Verification ensures that the host name obtained from a reverse DNS lookup, or
28735 one of its aliases, does, when it is itself looked up in the DNS, yield the
28736 original IP address.
28737
28738 If this condition is used for a locally generated message (that is, when there
28739 is no client host involved), it always succeeds.
28740
28741 .vitem &*verify&~=&~sender/*&<&'options'&>
28742 .cindex "&%verify%& ACL condition"
28743 .cindex "&ACL;" "verifying sender"
28744 .cindex "sender" "verifying"
28745 .cindex "verifying" "sender"
28746 This condition is relevant only after a MAIL or RCPT command, or after a
28747 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
28748 the message's sender is empty (that is, this is a bounce message), the
28749 condition is true. Otherwise, the sender address is verified.
28750
28751 .vindex "&$address_data$&"
28752 .vindex "&$sender_address_data$&"
28753 If there is data in the &$address_data$& variable at the end of routing, its
28754 value is placed in &$sender_address_data$& at the end of verification. This
28755 value can be used in subsequent conditions and modifiers in the same ACL
28756 statement. It does not persist after the end of the current statement. If you
28757 want to preserve the value for longer, you can save it in an ACL variable.
28758
28759 Details of verification are given later, starting at section
28760 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
28761 to avoid doing it more than once per message.
28762
28763 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
28764 .cindex "&%verify%& ACL condition"
28765 This is a variation of the previous option, in which a modified address is
28766 verified as a sender.
28767 .endlist
28768
28769
28770
28771 .section "Using DNS lists" "SECTmorednslists"
28772 .cindex "DNS list" "in ACL"
28773 .cindex "black list (DNS)"
28774 .cindex "&ACL;" "testing a DNS list"
28775 In its simplest form, the &%dnslists%& condition tests whether the calling host
28776 is on at least one of a number of DNS lists by looking up the inverted IP
28777 address in one or more DNS domains. (Note that DNS list domains are not mail
28778 domains, so the &`+`& syntax for named lists doesn't work - it is used for
28779 special options instead.) For example, if the calling host's IP
28780 address is 192.168.62.43, and the ACL statement is
28781 .code
28782 deny dnslists = blackholes.mail-abuse.org : \
28783                 dialups.mail-abuse.org
28784 .endd
28785 the following records are looked up:
28786 .code
28787 43.62.168.192.blackholes.mail-abuse.org
28788 43.62.168.192.dialups.mail-abuse.org
28789 .endd
28790 As soon as Exim finds an existing DNS record, processing of the list stops.
28791 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
28792 to test that a host is on more than one list (an &"and"& conjunction), you can
28793 use two separate conditions:
28794 .code
28795 deny dnslists = blackholes.mail-abuse.org
28796      dnslists = dialups.mail-abuse.org
28797 .endd
28798 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
28799 behaves as if the host does not match the list item, that is, as if the DNS
28800 record does not exist. If there are further items in the DNS list, they are
28801 processed.
28802
28803 This is usually the required action when &%dnslists%& is used with &%deny%&
28804 (which is the most common usage), because it prevents a DNS failure from
28805 blocking mail. However, you can change this behaviour by putting one of the
28806 following special items in the list:
28807 .display
28808 &`+include_unknown `&   behave as if the item is on the list
28809 &`+exclude_unknown `&   behave as if the item is not on the list (default)
28810 &`+defer_unknown   `&   give a temporary error
28811 .endd
28812 .cindex "&`+include_unknown`&"
28813 .cindex "&`+exclude_unknown`&"
28814 .cindex "&`+defer_unknown`&"
28815 Each of these applies to any subsequent items on the list. For example:
28816 .code
28817 deny dnslists = +defer_unknown : foo.bar.example
28818 .endd
28819 Testing the list of domains stops as soon as a match is found. If you want to
28820 warn for one list and block for another, you can use two different statements:
28821 .code
28822 deny  dnslists = blackholes.mail-abuse.org
28823 warn  message  = X-Warn: sending host is on dialups list
28824       dnslists = dialups.mail-abuse.org
28825 .endd
28826 DNS list lookups are cached by Exim for the duration of the SMTP session,
28827 so a lookup based on the IP address is done at most once for any incoming
28828 connection. Exim does not share information between multiple incoming
28829 connections (but your local name server cache should be active).
28830
28831
28832
28833 .section "Specifying the IP address for a DNS list lookup" "SECID201"
28834 .cindex "DNS list" "keyed by explicit IP address"
28835 By default, the IP address that is used in a DNS list lookup is the IP address
28836 of the calling host. However, you can specify another IP address by listing it
28837 after the domain name, introduced by a slash. For example:
28838 .code
28839 deny dnslists = black.list.tld/192.168.1.2
28840 .endd
28841 This feature is not very helpful with explicit IP addresses; it is intended for
28842 use with IP addresses that are looked up, for example, the IP addresses of the
28843 MX hosts or nameservers of an email sender address. For an example, see section
28844 &<<SECTmulkeyfor>>& below.
28845
28846
28847
28848
28849 .section "DNS lists keyed on domain names" "SECID202"
28850 .cindex "DNS list" "keyed by domain name"
28851 There are some lists that are keyed on domain names rather than inverted IP
28852 addresses (see for example the &'domain based zones'& link at
28853 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
28854 with these lists. You can change the name that is looked up in a DNS list by
28855 listing it after the domain name, introduced by a slash. For example,
28856 .code
28857 deny  message  = Sender's domain is listed at $dnslist_domain
28858       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
28859 .endd
28860 This particular example is useful only in ACLs that are obeyed after the
28861 RCPT or DATA commands, when a sender address is available. If (for
28862 example) the message's sender is &'user@tld.example'& the name that is looked
28863 up by this example is
28864 .code
28865 tld.example.dsn.rfc-ignorant.org
28866 .endd
28867 A single &%dnslists%& condition can contain entries for both names and IP
28868 addresses. For example:
28869 .code
28870 deny dnslists = sbl.spamhaus.org : \
28871                 dsn.rfc-ignorant.org/$sender_address_domain
28872 .endd
28873 The first item checks the sending host's IP address; the second checks a domain
28874 name. The whole condition is true if either of the DNS lookups succeeds.
28875
28876
28877
28878
28879 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
28880 .cindex "DNS list" "multiple keys for"
28881 The syntax described above for looking up explicitly-defined values (either
28882 names or IP addresses) in a DNS blacklist is a simplification. After the domain
28883 name for the DNS list, what follows the slash can in fact be a list of items.
28884 As with all lists in Exim, the default separator is a colon. However, because
28885 this is a sublist within the list of DNS blacklist domains, it is necessary
28886 either to double the separators like this:
28887 .code
28888 dnslists = black.list.tld/name.1::name.2
28889 .endd
28890 or to change the separator character, like this:
28891 .code
28892 dnslists = black.list.tld/<;name.1;name.2
28893 .endd
28894 If an item in the list is an IP address, it is inverted before the DNS
28895 blacklist domain is appended. If it is not an IP address, no inversion
28896 occurs. Consider this condition:
28897 .code
28898 dnslists = black.list.tld/<;192.168.1.2;a.domain
28899 .endd
28900 The DNS lookups that occur are:
28901 .code
28902 2.1.168.192.black.list.tld
28903 a.domain.black.list.tld
28904 .endd
28905 Once a DNS record has been found (that matches a specific IP return
28906 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
28907 are done. If there is a temporary DNS error, the rest of the sublist of domains
28908 or IP addresses is tried. A temporary error for the whole dnslists item occurs
28909 only if no other DNS lookup in this sublist succeeds. In other words, a
28910 successful lookup for any of the items in the sublist overrides a temporary
28911 error for a previous item.
28912
28913 The ability to supply a list of items after the slash is in some sense just a
28914 syntactic convenience. These two examples have the same effect:
28915 .code
28916 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
28917 dnslists = black.list.tld/a.domain::b.domain
28918 .endd
28919 However, when the data for the list is obtained from a lookup, the second form
28920 is usually much more convenient. Consider this example:
28921 .code
28922 deny message  = The mail servers for the domain \
28923                 $sender_address_domain \
28924                 are listed at $dnslist_domain ($dnslist_value); \
28925                 see $dnslist_text.
28926      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
28927                                    ${lookup dnsdb {>|mxh=\
28928                                    $sender_address_domain} }} }
28929 .endd
28930 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
28931 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
28932 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
28933 of expanding the condition might be something like this:
28934 .code
28935 dnslists = sbl.spahmaus.org/<|192.168.2.3|192.168.5.6|...
28936 .endd
28937 Thus, this example checks whether or not the IP addresses of the sender
28938 domain's mail servers are on the Spamhaus black list.
28939
28940 The key that was used for a successful DNS list lookup is put into the variable
28941 &$dnslist_matched$& (see section &<<SECID204>>&).
28942
28943
28944
28945
28946 .section "Data returned by DNS lists" "SECID203"
28947 .cindex "DNS list" "data returned from"
28948 DNS lists are constructed using address records in the DNS. The original RBL
28949 just used the address 127.0.0.1 on the right hand side of each record, but the
28950 RBL+ list and some other lists use a number of values with different meanings.
28951 The values used on the RBL+ list are:
28952 .display
28953 127.1.0.1  RBL
28954 127.1.0.2  DUL
28955 127.1.0.3  DUL and RBL
28956 127.1.0.4  RSS
28957 127.1.0.5  RSS and RBL
28958 127.1.0.6  RSS and DUL
28959 127.1.0.7  RSS and DUL and RBL
28960 .endd
28961 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
28962 different values. Some DNS lists may return more than one address record;
28963 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
28964
28965
28966 .section "Variables set from DNS lists" "SECID204"
28967 .cindex "expansion" "variables, set from DNS list"
28968 .cindex "DNS list" "variables set from"
28969 .vindex "&$dnslist_domain$&"
28970 .vindex "&$dnslist_matched$&"
28971 .vindex "&$dnslist_text$&"
28972 .vindex "&$dnslist_value$&"
28973 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
28974 the name of the overall domain that matched (for example,
28975 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
28976 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
28977 the DNS record. When the key is an IP address, it is not reversed in
28978 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
28979 cases, for example:
28980 .code
28981 deny dnslists = spamhaus.example
28982 .endd
28983 the key is also available in another variable (in this case,
28984 &$sender_host_address$&). In more complicated cases, however, this is not true.
28985 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
28986 might generate a dnslists lookup like this:
28987 .code
28988 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
28989 .endd
28990 If this condition succeeds, the value in &$dnslist_matched$& might be
28991 &`192.168.6.7`& (for example).
28992
28993 If more than one address record is returned by the DNS lookup, all the IP
28994 addresses are included in &$dnslist_value$&, separated by commas and spaces.
28995 The variable &$dnslist_text$& contains the contents of any associated TXT
28996 record. For lists such as RBL+ the TXT record for a merged entry is often not
28997 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
28998 information.
28999
29000 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
29001 &-- although these appear before the condition in the ACL, they are not
29002 expanded until after it has failed. For example:
29003 .code
29004 deny    hosts = !+local_networks
29005         message = $sender_host_address is listed \
29006                   at $dnslist_domain
29007         dnslists = rbl-plus.mail-abuse.example
29008 .endd
29009
29010
29011
29012 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
29013 .cindex "DNS list" "matching specific returned data"
29014 You can add an equals sign and an IP address after a &%dnslists%& domain name
29015 in order to restrict its action to DNS records with a matching right hand side.
29016 For example,
29017 .code
29018 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
29019 .endd
29020 rejects only those hosts that yield 127.0.0.2. Without this additional data,
29021 any address record is considered to be a match. For the moment, we assume
29022 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
29023 describes how multiple records are handled.
29024
29025 More than one IP address may be given for checking, using a comma as a
29026 separator. These are alternatives &-- if any one of them matches, the
29027 &%dnslists%& condition is true. For example:
29028 .code
29029 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
29030 .endd
29031 If you want to specify a constraining address list and also specify names or IP
29032 addresses to be looked up, the constraining address list must be specified
29033 first. For example:
29034 .code
29035 deny dnslists = dsn.rfc-ignorant.org\
29036                 =127.0.0.2/$sender_address_domain
29037 .endd
29038
29039 If the character &`&&`& is used instead of &`=`&, the comparison for each
29040 listed IP address is done by a bitwise &"and"& instead of by an equality test.
29041 In other words, the listed addresses are used as bit masks. The comparison is
29042 true if all the bits in the mask are present in the address that is being
29043 tested. For example:
29044 .code
29045 dnslists = a.b.c&0.0.0.3
29046 .endd
29047 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
29048 want to test whether one bit or another bit is present (as opposed to both
29049 being present), you must use multiple values. For example:
29050 .code
29051 dnslists = a.b.c&0.0.0.1,0.0.0.2
29052 .endd
29053 matches if the final component of the address is an odd number or two times
29054 an odd number.
29055
29056
29057
29058 .section "Negated DNS matching conditions" "SECID205"
29059 You can supply a negative list of IP addresses as part of a &%dnslists%&
29060 condition. Whereas
29061 .code
29062 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
29063 .endd
29064 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
29065 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
29066 .code
29067 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
29068 .endd
29069 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
29070 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
29071 words, the result of the test is inverted if an exclamation mark appears before
29072 the &`=`& (or the &`&&`&) sign.
29073
29074 &*Note*&: This kind of negation is not the same as negation in a domain,
29075 host, or address list (which is why the syntax is different).
29076
29077 If you are using just one list, the negation syntax does not gain you much. The
29078 previous example is precisely equivalent to
29079 .code
29080 deny  dnslists = a.b.c
29081      !dnslists = a.b.c=127.0.0.2,127.0.0.3
29082 .endd
29083 However, if you are using multiple lists, the negation syntax is clearer.
29084 Consider this example:
29085 .code
29086 deny  dnslists = sbl.spamhaus.org : \
29087                  list.dsbl.org : \
29088                  dnsbl.njabl.org!=127.0.0.3 : \
29089                  relays.ordb.org
29090 .endd
29091 Using only positive lists, this would have to be:
29092 .code
29093 deny  dnslists = sbl.spamhaus.org : \
29094                  list.dsbl.org
29095 deny  dnslists = dnsbl.njabl.org
29096      !dnslists = dnsbl.njabl.org=127.0.0.3
29097 deny  dnslists = relays.ordb.org
29098 .endd
29099 which is less clear, and harder to maintain.
29100
29101
29102
29103
29104 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
29105 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
29106 thereby providing more than one IP address. When an item in a &%dnslists%& list
29107 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
29108 the match to specific results from the DNS lookup, there are two ways in which
29109 the checking can be handled. For example, consider the condition:
29110 .code
29111 dnslists = a.b.c=127.0.0.1
29112 .endd
29113 What happens if the DNS lookup for the incoming IP address yields both
29114 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
29115 condition true because at least one given value was found, or is it false
29116 because at least one of the found values was not listed? And how does this
29117 affect negated conditions? Both possibilities are provided for with the help of
29118 additional separators &`==`& and &`=&&`&.
29119
29120 .ilist
29121 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
29122 IP addresses matches one of the listed addresses. For the example above, the
29123 condition is true because 127.0.0.1 matches.
29124 .next
29125 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
29126 looked up IP addresses matches one of the listed addresses. If the condition is
29127 changed to:
29128 .code
29129 dnslists = a.b.c==127.0.0.1
29130 .endd
29131 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
29132 false because 127.0.0.2 is not listed. You would need to have:
29133 .code
29134 dnslists = a.b.c==127.0.0.1,127.0.0.2
29135 .endd
29136 for the condition to be true.
29137 .endlist
29138
29139 When &`!`& is used to negate IP address matching, it inverts the result, giving
29140 the precise opposite of the behaviour above. Thus:
29141 .ilist
29142 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
29143 addresses matches one of the listed addresses. Consider:
29144 .code
29145 dnslists = a.b.c!&0.0.0.1
29146 .endd
29147 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
29148 false because 127.0.0.1 matches.
29149 .next
29150 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
29151 looked up IP address that does not match. Consider:
29152 .code
29153 dnslists = a.b.c!=&0.0.0.1
29154 .endd
29155 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
29156 true, because 127.0.0.2 does not match. You would need to have:
29157 .code
29158 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
29159 .endd
29160 for the condition to be false.
29161 .endlist
29162 When the DNS lookup yields only a single IP address, there is no difference
29163 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
29164
29165
29166
29167
29168 .section "Detailed information from merged DNS lists" "SECTmordetinf"
29169 .cindex "DNS list" "information from merged"
29170 When the facility for restricting the matching IP values in a DNS list is used,
29171 the text from the TXT record that is set in &$dnslist_text$& may not reflect
29172 the true reason for rejection. This happens when lists are merged and the IP
29173 address in the A record is used to distinguish them; unfortunately there is
29174 only one TXT record. One way round this is not to use merged lists, but that
29175 can be inefficient because it requires multiple DNS lookups where one would do
29176 in the vast majority of cases when the host of interest is not on any of the
29177 lists.
29178
29179 A less inefficient way of solving this problem is available. If
29180 two domain names, comma-separated, are given, the second is used first to
29181 do an initial check, making use of any IP value restrictions that are set.
29182 If there is a match, the first domain is used, without any IP value
29183 restrictions, to get the TXT record. As a byproduct of this, there is also
29184 a check that the IP being tested is indeed on the first list. The first
29185 domain is the one that is put in &$dnslist_domain$&. For example:
29186 .code
29187 reject message  = \
29188          rejected because $sender_host_address is blacklisted \
29189          at $dnslist_domain\n$dnslist_text
29190        dnslists = \
29191          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
29192          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
29193 .endd
29194 For the first blacklist item, this starts by doing a lookup in
29195 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
29196 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
29197 value, and as long as something is found, it looks for the corresponding TXT
29198 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
29199 The second blacklist item is processed similarly.
29200
29201 If you are interested in more than one merged list, the same list must be
29202 given several times, but because the results of the DNS lookups are cached,
29203 the DNS calls themselves are not repeated. For example:
29204 .code
29205 reject dnslists = \
29206          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
29207          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
29208          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
29209          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
29210 .endd
29211 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
29212 values matches (or if no record is found), this is the only lookup that is
29213 done. Only if there is a match is one of the more specific lists consulted.
29214
29215
29216
29217 .section "DNS lists and IPv6" "SECTmorednslistslast"
29218 .cindex "IPv6" "DNS black lists"
29219 .cindex "DNS list" "IPv6 usage"
29220 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
29221 nibble by nibble. For example, if the calling host's IP address is
29222 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
29223 .code
29224 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
29225   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
29226 .endd
29227 (split over two lines here to fit on the page). Unfortunately, some of the DNS
29228 lists contain wildcard records, intended for IPv4, that interact badly with
29229 IPv6. For example, the DNS entry
29230 .code
29231 *.3.some.list.example.    A    127.0.0.1
29232 .endd
29233 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
29234 Unfortunately, it also matches the entire 3::/4 IPv6 network.
29235
29236 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
29237 &%condition%& condition, as in this example:
29238 .code
29239 deny   condition = ${if isip4{$sender_host_address}}
29240        dnslists  = some.list.example
29241 .endd
29242
29243 If an explicit key is being used for a DNS lookup and it may be an IPv6
29244 address you should specify alternate list separators for both the outer
29245 (DNS list name) list and inner (lookup keys) list:
29246 .code
29247        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
29248 .endd
29249
29250 .section "Rate limiting incoming messages" "SECTratelimiting"
29251 .cindex "rate limiting" "client sending"
29252 .cindex "limiting client sending rates"
29253 .oindex "&%smtp_ratelimit_*%&"
29254 The &%ratelimit%& ACL condition can be used to measure and control the rate at
29255 which clients can send email. This is more powerful than the
29256 &%smtp_ratelimit_*%& options, because those options control the rate of
29257 commands in a single SMTP session only, whereas the &%ratelimit%& condition
29258 works across all connections (concurrent and sequential) from the same client
29259 host. The syntax of the &%ratelimit%& condition is:
29260 .display
29261 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
29262 .endd
29263 If the average client sending rate is less than &'m'& messages per time
29264 period &'p'& then the condition is false; otherwise it is true.
29265
29266 As a side-effect, the &%ratelimit%& condition sets the expansion variable
29267 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
29268 configured value of &'m'&, and &$sender_rate_period$& to the configured value
29269 of &'p'&.
29270
29271 The parameter &'p'& is the smoothing time constant, in the form of an Exim
29272 time interval, for example, &`8h`& for eight hours. A larger time constant
29273 means that it takes Exim longer to forget a client's past behaviour. The
29274 parameter &'m'& is the maximum number of messages that a client is permitted to
29275 send in each time interval. It also specifies the number of messages permitted
29276 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
29277 constant, you can allow a client to send more messages in a burst without
29278 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
29279 both small, messages must be sent at an even rate.
29280
29281 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
29282 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
29283 when deploying the &%ratelimit%& ACL condition. The script prints usage
29284 instructions when it is run with no arguments.
29285
29286 The key is used to look up the data for calculating the client's average
29287 sending rate. This data is stored in Exim's spool directory, alongside the
29288 retry and other hints databases. The default key is &$sender_host_address$&,
29289 which means Exim computes the sending rate of each client host IP address.
29290 By changing the key you can change how Exim identifies clients for the purpose
29291 of ratelimiting. For example, to limit the sending rate of each authenticated
29292 user, independent of the computer they are sending from, set the key to
29293 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
29294 example, &$authenticated_id$& is only meaningful if the client has
29295 authenticated (which you can check with the &%authenticated%& ACL condition).
29296
29297 The lookup key does not have to identify clients: If you want to limit the
29298 rate at which a recipient receives messages, you can use the key
29299 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
29300 ACL.
29301
29302 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
29303 specifies what Exim measures the rate of, for example messages or recipients
29304 or bytes. You can adjust the measurement using the &%unique=%& and/or
29305 &%count=%& options. You can also control when Exim updates the recorded rate
29306 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
29307 separated by a slash, like the other parameters. They may appear in any order.
29308
29309 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
29310 any options that alter the meaning of the stored data. The limit &'m'& is not
29311 stored, so you can alter the configured maximum rate and Exim will still
29312 remember clients' past behaviour. If you change the &%per_*%& mode or add or
29313 remove the &%unique=%& option, the lookup key changes so Exim will forget past
29314 behaviour. The lookup key is not affected by changes to the update mode and
29315 the &%count=%& option.
29316
29317
29318 .section "Ratelimit options for what is being measured" "ratoptmea"
29319 .cindex "rate limiting" "per_* options"
29320 The &%per_conn%& option limits the client's connection rate. It is not
29321 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
29322 &%acl_not_smtp_start%& ACLs.
29323
29324 The &%per_mail%& option limits the client's rate of sending messages. This is
29325 the default if none of the &%per_*%& options is specified. It can be used in
29326 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
29327 &%acl_smtp_data%&, or &%acl_not_smtp%&.
29328
29329 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
29330 the same ACLs as the &%per_mail%& option, though it is best to use this option
29331 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
29332 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
29333 in its MAIL command, which may be inaccurate or completely missing. You can
29334 follow the limit &'m'& in the configuration with K, M, or G to specify limits
29335 in kilobytes, megabytes, or gigabytes, respectively.
29336
29337 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
29338 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
29339 &%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In
29340 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
29341 ACLs the rate is updated with the total recipient count in one go. Note that
29342 in either case the rate limiting engine will see a message with many
29343 recipients as a large high-speed burst.
29344
29345 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
29346 number of different recipients that the client has sent messages to in the
29347 last time period. That is, if the client repeatedly sends messages to the same
29348 recipient, its measured rate is not increased. This option can only be used in
29349 &%acl_smtp_rcpt%&.
29350
29351 The &%per_cmd%& option causes Exim to recompute the rate every time the
29352 condition is processed. This can be used to limit the rate of any SMTP
29353 command. If it is used in multiple ACLs it can limit the aggregate rate of
29354 multiple different commands.
29355
29356 The &%count=%& option can be used to alter how much Exim adds to the client's
29357 measured rate. For example, the &%per_byte%& option is equivalent to
29358 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
29359 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
29360 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
29361
29362 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
29363
29364
29365 .section "Ratelimit update modes" "ratoptupd"
29366 .cindex "rate limiting" "reading data without updating"
29367 You can specify one of three options with the &%ratelimit%& condition to
29368 control when its database is updated. This section describes the &%readonly%&
29369 mode, and the next section describes the &%strict%& and &%leaky%& modes.
29370
29371 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
29372 previously-computed rate to check against the limit.
29373
29374 For example, you can test the client's sending rate and deny it access (when
29375 it is too fast) in the connect ACL. If the client passes this check then it
29376 can go on to send a message, in which case its recorded rate will be updated
29377 in the MAIL ACL. Subsequent connections from the same client will check this
29378 new rate.
29379 .code
29380 acl_check_connect:
29381  deny ratelimit = 100 / 5m / readonly
29382     log_message = RATE CHECK: $sender_rate/$sender_rate_period \
29383                   (max $sender_rate_limit)
29384 # ...
29385 acl_check_mail:
29386  warn ratelimit = 100 / 5m / strict
29387     log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
29388                   (max $sender_rate_limit)
29389 .endd
29390
29391 If Exim encounters multiple &%ratelimit%& conditions with the same key when
29392 processing a message then it may increase the client's measured rate more than
29393 it should. For example, this will happen if you check the &%per_rcpt%& option
29394 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
29395 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
29396 multiple update problems by using the &%readonly%& option on later ratelimit
29397 checks.
29398
29399 The &%per_*%& options described above do not make sense in some ACLs. If you
29400 use a &%per_*%& option in an ACL where it is not normally permitted then the
29401 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
29402 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
29403 next section) so you must specify the &%readonly%& option explicitly.
29404
29405
29406 .section "Ratelimit options for handling fast clients" "ratoptfast"
29407 .cindex "rate limiting" "strict and leaky modes"
29408 If a client's average rate is greater than the maximum, the rate limiting
29409 engine can react in two possible ways, depending on the presence of the
29410 &%strict%& or &%leaky%& update modes. This is independent of the other
29411 counter-measures (such as rejecting the message) that may be specified by the
29412 rest of the ACL.
29413
29414 The &%leaky%& (default) option means that the client's recorded rate is not
29415 updated if it is above the limit. The effect of this is that Exim measures the
29416 client's average rate of successfully sent email, which cannot be greater than
29417 the maximum allowed. If the client is over the limit it may suffer some
29418 counter-measures (as specified in the ACL), but it will still be able to send
29419 email at the configured maximum rate, whatever the rate of its attempts. This
29420 is generally the better choice if you have clients that retry automatically.
29421 For example, it does not prevent a sender with an over-aggressive retry rate
29422 from getting any email through.
29423
29424 The &%strict%& option means that the client's recorded rate is always
29425 updated. The effect of this is that Exim measures the client's average rate
29426 of attempts to send email, which can be much higher than the maximum it is
29427 actually allowed. If the client is over the limit it may be subjected to
29428 counter-measures by the ACL. It must slow down and allow sufficient time to
29429 pass that its computed rate falls below the maximum before it can send email
29430 again. The time (the number of smoothing periods) it must wait and not
29431 attempt to send mail can be calculated with this formula:
29432 .code
29433         ln(peakrate/maxrate)
29434 .endd
29435
29436
29437 .section "Limiting the rate of different events" "ratoptuniq"
29438 .cindex "rate limiting" "counting unique events"
29439 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
29440 rate of different events. For example, the &%per_addr%& option uses this
29441 mechanism to count the number of different recipients that the client has
29442 sent messages to in the last time period; it is equivalent to
29443 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
29444 measure the rate that a client uses different sender addresses with the
29445 options &`per_mail/unique=$sender_address`&.
29446
29447 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
29448 has seen for that key. The whole set is thrown away when it is older than the
29449 rate smoothing period &'p'&, so each different event is counted at most once
29450 per period. In the &%leaky%& update mode, an event that causes the client to
29451 go over the limit is not added to the set, in the same way that the client's
29452 recorded rate is not updated in the same situation.
29453
29454 When you combine the &%unique=%& and &%readonly%& options, the specific
29455 &%unique=%& value is ignored, and Exim just retrieves the client's stored
29456 rate.
29457
29458 The &%unique=%& mechanism needs more space in the ratelimit database than the
29459 other &%ratelimit%& options in order to store the event set. The number of
29460 unique values is potentially as large as the rate limit, so the extra space
29461 required increases with larger limits.
29462
29463 The uniqueification is not perfect: there is a small probability that Exim
29464 will think a new event has happened before. If the sender's rate is less than
29465 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
29466 the measured rate can go above the limit, in which case Exim may under-count
29467 events by a significant margin. Fortunately, if the rate is high enough (2.7
29468 times the limit) that the false positive rate goes above 9%, then Exim will
29469 throw away the over-full event set before the measured rate falls below the
29470 limit. Therefore the only harm should be that exceptionally high sending rates
29471 are logged incorrectly; any countermeasures you configure will be as effective
29472 as intended.
29473
29474
29475 .section "Using rate limiting" "useratlim"
29476 Exim's other ACL facilities are used to define what counter-measures are taken
29477 when the rate limit is exceeded. This might be anything from logging a warning
29478 (for example, while measuring existing sending rates in order to define
29479 policy), through time delays to slow down fast senders, up to rejecting the
29480 message. For example:
29481 .code
29482 # Log all senders' rates
29483 warn ratelimit = 0 / 1h / strict
29484      log_message = Sender rate $sender_rate / $sender_rate_period
29485
29486 # Slow down fast senders; note the need to truncate $sender_rate
29487 # at the decimal point.
29488 warn ratelimit = 100 / 1h / per_rcpt / strict
29489      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
29490                    $sender_rate_limit }s
29491
29492 # Keep authenticated users under control
29493 deny authenticated = *
29494      ratelimit = 100 / 1d / strict / $authenticated_id
29495
29496 # System-wide rate limit
29497 defer message = Sorry, too busy. Try again later.
29498      ratelimit = 10 / 1s / $primary_hostname
29499
29500 # Restrict incoming rate from each host, with a default
29501 # set using a macro and special cases looked up in a table.
29502 defer message = Sender rate exceeds $sender_rate_limit \
29503                messages per $sender_rate_period
29504      ratelimit = ${lookup {$sender_host_address} \
29505                    cdb {DB/ratelimits.cdb} \
29506                    {$value} {RATELIMIT} }
29507 .endd
29508 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
29509 especially with the &%per_rcpt%& option, you may suffer from a performance
29510 bottleneck caused by locking on the ratelimit hints database. Apart from
29511 making your ACLs less complicated, you can reduce the problem by using a
29512 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
29513 this means that Exim will lose its hints data after a reboot (including retry
29514 hints, the callout cache, and ratelimit data).
29515
29516
29517
29518 .section "Address verification" "SECTaddressverification"
29519 .cindex "verifying address" "options for"
29520 .cindex "policy control" "address verification"
29521 Several of the &%verify%& conditions described in section
29522 &<<SECTaclconditions>>& cause addresses to be verified. Section
29523 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
29524 The verification conditions can be followed by options that modify the
29525 verification process. The options are separated from the keyword and from each
29526 other by slashes, and some of them contain parameters. For example:
29527 .code
29528 verify = sender/callout
29529 verify = recipient/defer_ok/callout=10s,defer_ok
29530 .endd
29531 The first stage of address verification, which always happens, is to run the
29532 address through the routers, in &"verify mode"&. Routers can detect the
29533 difference between verification and routing for delivery, and their actions can
29534 be varied by a number of generic options such as &%verify%& and &%verify_only%&
29535 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
29536 The available options are as follows:
29537
29538 .ilist
29539 If the &%callout%& option is specified, successful routing to one or more
29540 remote hosts is followed by a &"callout"& to those hosts as an additional
29541 check. Callouts and their sub-options are discussed in the next section.
29542 .next
29543 If there is a defer error while doing verification routing, the ACL
29544 normally returns &"defer"&. However, if you include &%defer_ok%& in the
29545 options, the condition is forced to be true instead. Note that this is a main
29546 verification option as well as a suboption for callouts.
29547 .next
29548 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
29549 discusses the reporting of sender address verification failures.
29550 .next
29551 The &%success_on_redirect%& option causes verification always to succeed
29552 immediately after a successful redirection. By default, if a redirection
29553 generates just one address, that address is also verified. See further
29554 discussion in section &<<SECTredirwhilveri>>&.
29555 .endlist
29556
29557 .cindex "verifying address" "differentiating failures"
29558 .vindex "&$recipient_verify_failure$&"
29559 .vindex "&$sender_verify_failure$&"
29560 .vindex "&$acl_verify_message$&"
29561 After an address verification failure, &$acl_verify_message$& contains the
29562 error message that is associated with the failure. It can be preserved by
29563 coding like this:
29564 .code
29565 warn  !verify = sender
29566        set acl_m0 = $acl_verify_message
29567 .endd
29568 If you are writing your own custom rejection message or log message when
29569 denying access, you can use this variable to include information about the
29570 verification failure.
29571
29572 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
29573 appropriate) contains one of the following words:
29574
29575 .ilist
29576 &%qualify%&: The address was unqualified (no domain), and the message
29577 was neither local nor came from an exempted host.
29578 .next
29579 &%route%&: Routing failed.
29580 .next
29581 &%mail%&: Routing succeeded, and a callout was attempted; rejection
29582 occurred at or before the MAIL command (that is, on initial
29583 connection, HELO, or MAIL).
29584 .next
29585 &%recipient%&: The RCPT command in a callout was rejected.
29586 .next
29587 &%postmaster%&: The postmaster check in a callout was rejected.
29588 .endlist
29589
29590 The main use of these variables is expected to be to distinguish between
29591 rejections of MAIL and rejections of RCPT in callouts.
29592
29593
29594
29595
29596 .section "Callout verification" "SECTcallver"
29597 .cindex "verifying address" "by callout"
29598 .cindex "callout" "verification"
29599 .cindex "SMTP" "callout verification"
29600 For non-local addresses, routing verifies the domain, but is unable to do any
29601 checking of the local part. There are situations where some means of verifying
29602 the local part is desirable. One way this can be done is to make an SMTP
29603 &'callback'& to a delivery host for the sender address or a &'callforward'& to
29604 a subsequent host for a recipient address, to see if the host accepts the
29605 address. We use the term &'callout'& to cover both cases. Note that for a
29606 sender address, the callback is not to the client host that is trying to
29607 deliver the message, but to one of the hosts that accepts incoming mail for the
29608 sender's domain.
29609
29610 Exim does not do callouts by default. If you want them to happen, you must
29611 request them by setting appropriate options on the &%verify%& condition, as
29612 described below. This facility should be used with care, because it can add a
29613 lot of resource usage to the cost of verifying an address. However, Exim does
29614 cache the results of callouts, which helps to reduce the cost. Details of
29615 caching are in section &<<SECTcallvercache>>&.
29616
29617 Recipient callouts are usually used only between hosts that are controlled by
29618 the same administration. For example, a corporate gateway host could use
29619 callouts to check for valid recipients on an internal mailserver. A successful
29620 callout does not guarantee that a real delivery to the address would succeed;
29621 on the other hand, a failing callout does guarantee that a delivery would fail.
29622
29623 If the &%callout%& option is present on a condition that verifies an address, a
29624 second stage of verification occurs if the address is successfully routed to
29625 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
29626 &(manualroute)& router, where the router specifies the hosts. However, if a
29627 router that does not set up hosts routes to an &(smtp)& transport with a
29628 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
29629 &%hosts_override%& set, its hosts are always used, whether or not the router
29630 supplies a host list.
29631 Callouts are only supported on &(smtp)& transports.
29632
29633 The port that is used is taken from the transport, if it is specified and is a
29634 remote transport. (For routers that do verification only, no transport need be
29635 specified.) Otherwise, the default SMTP port is used. If a remote transport
29636 specifies an outgoing interface, this is used; otherwise the interface is not
29637 specified. Likewise, the text that is used for the HELO command is taken from
29638 the transport's &%helo_data%& option; if there is no transport, the value of
29639 &$smtp_active_hostname$& is used.
29640
29641 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
29642 test whether a bounce message could be delivered to the sender address. The
29643 following SMTP commands are sent:
29644 .display
29645 &`HELO `&<&'local host name'&>
29646 &`MAIL FROM:<>`&
29647 &`RCPT TO:`&<&'the address to be tested'&>
29648 &`QUIT`&
29649 .endd
29650 LHLO is used instead of HELO if the transport's &%protocol%& option is
29651 set to &"lmtp"&.
29652
29653 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
29654 settings.
29655
29656 A recipient callout check is similar. By default, it also uses an empty address
29657 for the sender. This default is chosen because most hosts do not make use of
29658 the sender address when verifying a recipient. Using the same address means
29659 that a single cache entry can be used for each recipient. Some sites, however,
29660 do make use of the sender address when verifying. These are catered for by the
29661 &%use_sender%& and &%use_postmaster%& options, described in the next section.
29662
29663 If the response to the RCPT command is a 2&'xx'& code, the verification
29664 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
29665 Exim tries the next host, if any. If there is a problem with all the remote
29666 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
29667 &%callout%& option is given, in which case the condition is forced to succeed.
29668
29669 .cindex "SMTP" "output flushing, disabling for callout"
29670 A callout may take a little time. For this reason, Exim normally flushes SMTP
29671 output before performing a callout in an ACL, to avoid unexpected timeouts in
29672 clients when the SMTP PIPELINING extension is in use. The flushing can be
29673 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
29674
29675
29676
29677
29678 .section "Additional parameters for callouts" "CALLaddparcall"
29679 .cindex "callout" "additional parameters for"
29680 The &%callout%& option can be followed by an equals sign and a number of
29681 optional parameters, separated by commas. For example:
29682 .code
29683 verify = recipient/callout=10s,defer_ok
29684 .endd
29685 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
29686 separate verify options, is retained for backwards compatibility, but is now
29687 deprecated. The additional parameters for &%callout%& are as follows:
29688
29689
29690 .vlist
29691 .vitem <&'a&~time&~interval'&>
29692 .cindex "callout" "timeout, specifying"
29693 This specifies the timeout that applies for the callout attempt to each host.
29694 For example:
29695 .code
29696 verify = sender/callout=5s
29697 .endd
29698 The default is 30 seconds. The timeout is used for each response from the
29699 remote host. It is also used for the initial connection, unless overridden by
29700 the &%connect%& parameter.
29701
29702
29703 .vitem &*connect&~=&~*&<&'time&~interval'&>
29704 .cindex "callout" "connection timeout, specifying"
29705 This parameter makes it possible to set a different (usually smaller) timeout
29706 for making the SMTP connection. For example:
29707 .code
29708 verify = sender/callout=5s,connect=1s
29709 .endd
29710 If not specified, this timeout defaults to the general timeout value.
29711
29712 .vitem &*defer_ok*&
29713 .cindex "callout" "defer, action on"
29714 When this parameter is present, failure to contact any host, or any other kind
29715 of temporary error, is treated as success by the ACL. However, the cache is not
29716 updated in this circumstance.
29717
29718 .vitem &*fullpostmaster*&
29719 .cindex "callout" "full postmaster check"
29720 This operates like the &%postmaster%& option (see below), but if the check for
29721 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
29722 accordance with the specification in RFC 2821. The RFC states that the
29723 unqualified address &'postmaster'& should be accepted.
29724
29725
29726 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
29727 .cindex "callout" "sender when verifying header"
29728 When verifying addresses in header lines using the &%header_sender%&
29729 verification option, Exim behaves by default as if the addresses are envelope
29730 sender addresses from a message. Callout verification therefore tests to see
29731 whether a bounce message could be delivered, by using an empty address in the
29732 MAIL command. However, it is arguable that these addresses might never be used
29733 as envelope senders, and could therefore justifiably reject bounce messages
29734 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
29735 address to use in the MAIL command. For example:
29736 .code
29737 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
29738 .endd
29739 This parameter is available only for the &%header_sender%& verification option.
29740
29741
29742 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
29743 .cindex "callout" "overall timeout, specifying"
29744 This parameter sets an overall timeout for performing a callout verification.
29745 For example:
29746 .code
29747 verify = sender/callout=5s,maxwait=30s
29748 .endd
29749 This timeout defaults to four times the callout timeout for individual SMTP
29750 commands. The overall timeout applies when there is more than one host that can
29751 be tried. The timeout is checked before trying the next host. This prevents
29752 very long delays if there are a large number of hosts and all are timing out
29753 (for example, when network connections are timing out).
29754
29755
29756 .vitem &*no_cache*&
29757 .cindex "callout" "cache, suppressing"
29758 .cindex "caching callout, suppressing"
29759 When this parameter is given, the callout cache is neither read nor updated.
29760
29761 .vitem &*postmaster*&
29762 .cindex "callout" "postmaster; checking"
29763 When this parameter is set, a successful callout check is followed by a similar
29764 check for the local part &'postmaster'& at the same domain. If this address is
29765 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
29766 the postmaster check is recorded in a cache record; if it is a failure, this is
29767 used to fail subsequent callouts for the domain without a connection being
29768 made, until the cache record expires.
29769
29770 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
29771 The postmaster check uses an empty sender in the MAIL command by default.
29772 You can use this parameter to do a postmaster check using a different address.
29773 For example:
29774 .code
29775 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
29776 .endd
29777 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
29778 one overrides. The &%postmaster%& parameter is equivalent to this example:
29779 .code
29780 require  verify = sender/callout=postmaster_mailfrom=
29781 .endd
29782 &*Warning*&: The caching arrangements for postmaster checking do not take
29783 account of the sender address. It is assumed that either the empty address or
29784 a fixed non-empty address will be used. All that Exim remembers is that the
29785 postmaster check for the domain succeeded or failed.
29786
29787
29788 .vitem &*random*&
29789 .cindex "callout" "&""random""& check"
29790 When this parameter is set, before doing the normal callout check, Exim does a
29791 check for a &"random"& local part at the same domain. The local part is not
29792 really random &-- it is defined by the expansion of the option
29793 &%callout_random_local_part%&, which defaults to
29794 .code
29795 $primary_hostname-$tod_epoch-testing
29796 .endd
29797 The idea here is to try to determine whether the remote host accepts all local
29798 parts without checking. If it does, there is no point in doing callouts for
29799 specific local parts. If the &"random"& check succeeds, the result is saved in
29800 a cache record, and used to force the current and subsequent callout checks to
29801 succeed without a connection being made, until the cache record expires.
29802
29803 .vitem &*use_postmaster*&
29804 .cindex "callout" "sender for recipient check"
29805 This parameter applies to recipient callouts only. For example:
29806 .code
29807 deny  !verify = recipient/callout=use_postmaster
29808 .endd
29809 .vindex "&$qualify_domain$&"
29810 It causes a non-empty postmaster address to be used in the MAIL command when
29811 performing the callout for the recipient, and also for a &"random"& check if
29812 that is configured. The local part of the address is &`postmaster`& and the
29813 domain is the contents of &$qualify_domain$&.
29814
29815 .vitem &*use_sender*&
29816 This option applies to recipient callouts only. For example:
29817 .code
29818 require  verify = recipient/callout=use_sender
29819 .endd
29820 It causes the message's actual sender address to be used in the MAIL
29821 command when performing the callout, instead of an empty address. There is no
29822 need to use this option unless you know that the called hosts make use of the
29823 sender when checking recipients. If used indiscriminately, it reduces the
29824 usefulness of callout caching.
29825 .endlist
29826
29827 If you use any of the parameters that set a non-empty sender for the MAIL
29828 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
29829 &%use_sender%&), you should think about possible loops. Recipient checking is
29830 usually done between two hosts that are under the same management, and the host
29831 that receives the callouts is not normally configured to do callouts itself.
29832 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
29833 these circumstances.
29834
29835 However, if you use a non-empty sender address for a callout to an arbitrary
29836 host, there is the likelihood that the remote host will itself initiate a
29837 callout check back to your host. As it is checking what appears to be a message
29838 sender, it is likely to use an empty address in MAIL, thus avoiding a
29839 callout loop. However, to be on the safe side it would be best to set up your
29840 own ACLs so that they do not do sender verification checks when the recipient
29841 is the address you use for header sender or postmaster callout checking.
29842
29843 Another issue to think about when using non-empty senders for callouts is
29844 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
29845 by the sender/recipient combination; thus, for any given recipient, many more
29846 actual callouts are performed than when an empty sender or postmaster is used.
29847
29848
29849
29850
29851 .section "Callout caching" "SECTcallvercache"
29852 .cindex "hints database" "callout cache"
29853 .cindex "callout" "cache, description of"
29854 .cindex "caching" "callout"
29855 Exim caches the results of callouts in order to reduce the amount of resources
29856 used, unless you specify the &%no_cache%& parameter with the &%callout%&
29857 option. A hints database called &"callout"& is used for the cache. Two
29858 different record types are used: one records the result of a callout check for
29859 a specific address, and the other records information that applies to the
29860 entire domain (for example, that it accepts the local part &'postmaster'&).
29861
29862 When an original callout fails, a detailed SMTP error message is given about
29863 the failure. However, for subsequent failures use the cache data, this message
29864 is not available.
29865
29866 The expiry times for negative and positive address cache records are
29867 independent, and can be set by the global options &%callout_negative_expire%&
29868 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
29869
29870 If a host gives a negative response to an SMTP connection, or rejects any
29871 commands up to and including
29872 .code
29873 MAIL FROM:<>
29874 .endd
29875 (but not including the MAIL command with a non-empty address),
29876 any callout attempt is bound to fail. Exim remembers such failures in a
29877 domain cache record, which it uses to fail callouts for the domain without
29878 making new connections, until the domain record times out. There are two
29879 separate expiry times for domain cache records:
29880 &%callout_domain_negative_expire%& (default 3h) and
29881 &%callout_domain_positive_expire%& (default 7d).
29882
29883 Domain records expire when the negative expiry time is reached if callouts
29884 cannot be made for the domain, or if the postmaster check failed.
29885 Otherwise, they expire when the positive expiry time is reached. This
29886 ensures that, for example, a host that stops accepting &"random"& local parts
29887 will eventually be noticed.
29888
29889 The callout caching mechanism is based on the domain of the address that is
29890 being tested. If the domain routes to several hosts, it is assumed that their
29891 behaviour will be the same.
29892
29893
29894
29895 .section "Sender address verification reporting" "SECTsenaddver"
29896 .cindex "verifying" "suppressing error details"
29897 See section &<<SECTaddressverification>>& for a general discussion of
29898 verification. When sender verification fails in an ACL, the details of the
29899 failure are given as additional output lines before the 550 response to the
29900 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
29901 you might see:
29902 .code
29903 MAIL FROM:<xyz@abc.example>
29904 250 OK
29905 RCPT TO:<pqr@def.example>
29906 550-Verification failed for <xyz@abc.example>
29907 550-Called:   192.168.34.43
29908 550-Sent:     RCPT TO:<xyz@abc.example>
29909 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
29910 550 Sender verification failed
29911 .endd
29912 If more than one RCPT command fails in the same way, the details are given
29913 only for the first of them. However, some administrators do not want to send
29914 out this much information. You can suppress the details by adding
29915 &`/no_details`& to the ACL statement that requests sender verification. For
29916 example:
29917 .code
29918 verify = sender/no_details
29919 .endd
29920
29921 .section "Redirection while verifying" "SECTredirwhilveri"
29922 .cindex "verifying" "redirection while"
29923 .cindex "address redirection" "while verifying"
29924 A dilemma arises when a local address is redirected by aliasing or forwarding
29925 during verification: should the generated addresses themselves be verified,
29926 or should the successful expansion of the original address be enough to verify
29927 it? By default, Exim takes the following pragmatic approach:
29928
29929 .ilist
29930 When an incoming address is redirected to just one child address, verification
29931 continues with the child address, and if that fails to verify, the original
29932 verification also fails.
29933 .next
29934 When an incoming address is redirected to more than one child address,
29935 verification does not continue. A success result is returned.
29936 .endlist
29937
29938 This seems the most reasonable behaviour for the common use of aliasing as a
29939 way of redirecting different local parts to the same mailbox. It means, for
29940 example, that a pair of alias entries of the form
29941 .code
29942 A.Wol:   aw123
29943 aw123:   :fail: Gone away, no forwarding address
29944 .endd
29945 work as expected, with both local parts causing verification failure. When a
29946 redirection generates more than one address, the behaviour is more like a
29947 mailing list, where the existence of the alias itself is sufficient for
29948 verification to succeed.
29949
29950 It is possible, however, to change the default behaviour so that all successful
29951 redirections count as successful verifications, however many new addresses are
29952 generated. This is specified by the &%success_on_redirect%& verification
29953 option. For example:
29954 .code
29955 require verify = recipient/success_on_redirect/callout=10s
29956 .endd
29957 In this example, verification succeeds if a router generates a new address, and
29958 the callout does not occur, because no address was routed to a remote host.
29959
29960 When verification is being tested via the &%-bv%& option, the treatment of
29961 redirections is as just described, unless the &%-v%& or any debugging option is
29962 also specified. In that case, full verification is done for every generated
29963 address and a report is output for each of them.
29964
29965
29966
29967 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
29968 .cindex "CSA" "verifying"
29969 Client SMTP Authorization is a system that allows a site to advertise
29970 which machines are and are not permitted to send email. This is done by placing
29971 special SRV records in the DNS; these are looked up using the client's HELO
29972 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
29973 Authorization checks in Exim are performed by the ACL condition:
29974 .code
29975 verify = csa
29976 .endd
29977 This fails if the client is not authorized. If there is a DNS problem, or if no
29978 valid CSA SRV record is found, or if the client is authorized, the condition
29979 succeeds. These three cases can be distinguished using the expansion variable
29980 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
29981 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
29982 be likely to cause problems for legitimate email.
29983
29984 The error messages produced by the CSA code include slightly more
29985 detail. If &$csa_status$& is &"defer"&, this may be because of problems
29986 looking up the CSA SRV record, or problems looking up the CSA target
29987 address record. There are four reasons for &$csa_status$& being &"fail"&:
29988
29989 .ilist
29990 The client's host name is explicitly not authorized.
29991 .next
29992 The client's IP address does not match any of the CSA target IP addresses.
29993 .next
29994 The client's host name is authorized but it has no valid target IP addresses
29995 (for example, the target's addresses are IPv6 and the client is using IPv4).
29996 .next
29997 The client's host name has no CSA SRV record but a parent domain has asserted
29998 that all subdomains must be explicitly authorized.
29999 .endlist
30000
30001 The &%csa%& verification condition can take an argument which is the domain to
30002 use for the DNS query. The default is:
30003 .code
30004 verify = csa/$sender_helo_name
30005 .endd
30006 This implementation includes an extension to CSA. If the query domain
30007 is an address literal such as [192.0.2.95], or if it is a bare IP
30008 address, Exim searches for CSA SRV records in the reverse DNS as if
30009 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
30010 meaningful to say:
30011 .code
30012 verify = csa/$sender_host_address
30013 .endd
30014 In fact, this is the check that Exim performs if the client does not say HELO.
30015 This extension can be turned off by setting the main configuration option
30016 &%dns_csa_use_reverse%& to be false.
30017
30018 If a CSA SRV record is not found for the domain itself, a search
30019 is performed through its parent domains for a record which might be
30020 making assertions about subdomains. The maximum depth of this search is limited
30021 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
30022 default. Exim does not look for CSA SRV records in a top level domain, so the
30023 default settings handle HELO domains as long as seven
30024 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
30025 of legitimate HELO domains.
30026
30027 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
30028 direct SRV lookups, this is not sufficient because of the extra parent domain
30029 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
30030 addresses into lookups in the reverse DNS space. The result of a successful
30031 lookup such as:
30032 .code
30033 ${lookup dnsdb {csa=$sender_helo_name}}
30034 .endd
30035 has two space-separated fields: an authorization code and a target host name.
30036 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
30037 authorization required but absent, or &"?"& for unknown.
30038
30039
30040
30041
30042 .section "Bounce address tag validation" "SECTverifyPRVS"
30043 .cindex "BATV, verifying"
30044 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
30045 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
30046 Genuine incoming bounce messages should therefore always be addressed to
30047 recipients that have a valid tag. This scheme is a way of detecting unwanted
30048 bounce messages caused by sender address forgeries (often called &"collateral
30049 spam"&), because the recipients of such messages do not include valid tags.
30050
30051 There are two expansion items to help with the implementation of the BATV
30052 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
30053 the original envelope sender address by using a simple key to add a hash of the
30054 address and some time-based randomizing information. The &%prvs%& expansion
30055 item creates a signed address, and the &%prvscheck%& expansion item checks one.
30056 The syntax of these expansion items is described in section
30057 &<<SECTexpansionitems>>&.
30058
30059 As an example, suppose the secret per-address keys are stored in an MySQL
30060 database. A query to look up the key for an address could be defined as a macro
30061 like this:
30062 .code
30063 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
30064                 WHERE sender='${quote_mysql:$prvscheck_address}'\
30065                 }{$value}}
30066 .endd
30067 Suppose also that the senders who make use of BATV are defined by an address
30068 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
30069 use this:
30070 .code
30071 # Bounces: drop unsigned addresses for BATV senders
30072 deny message = This address does not send an unsigned reverse path
30073      senders = :
30074      recipients = +batv_senders
30075
30076 # Bounces: In case of prvs-signed address, check signature.
30077 deny message = Invalid reverse path signature.
30078      senders = :
30079      condition  = ${prvscheck {$local_part@$domain}\
30080                   {PRVSCHECK_SQL}{1}}
30081      !condition = $prvscheck_result
30082 .endd
30083 The first statement rejects recipients for bounce messages that are addressed
30084 to plain BATV sender addresses, because it is known that BATV senders do not
30085 send out messages with plain sender addresses. The second statement rejects
30086 recipients that are prvs-signed, but with invalid signatures (either because
30087 the key is wrong, or the signature has timed out).
30088
30089 A non-prvs-signed address is not rejected by the second statement, because the
30090 &%prvscheck%& expansion yields an empty string if its first argument is not a
30091 prvs-signed address, thus causing the &%condition%& condition to be false. If
30092 the first argument is a syntactically valid prvs-signed address, the yield is
30093 the third string (in this case &"1"&), whether or not the cryptographic and
30094 timeout checks succeed. The &$prvscheck_result$& variable contains the result
30095 of the checks (empty for failure, &"1"& for success).
30096
30097 There is one more issue you must consider when implementing prvs-signing:
30098 you have to ensure that the routers accept prvs-signed addresses and
30099 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
30100 router to remove the signature with a configuration along these lines:
30101 .code
30102 batv_redirect:
30103   driver = redirect
30104   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
30105 .endd
30106 This works because, if the third argument of &%prvscheck%& is empty, the result
30107 of the expansion of a prvs-signed address is the decoded value of the original
30108 address. This router should probably be the first of your routers that handles
30109 local addresses.
30110
30111 To create BATV-signed addresses in the first place, a transport of this form
30112 can be used:
30113 .code
30114 external_smtp_batv:
30115   driver = smtp
30116   return_path = ${prvs {$return_path} \
30117                        {${lookup mysql{SELECT \
30118                        secret FROM batv_prvs WHERE \
30119                        sender='${quote_mysql:$sender_address}'} \
30120                        {$value}fail}}}
30121 .endd
30122 If no key can be found for the existing return path, no signing takes place.
30123
30124
30125
30126 .section "Using an ACL to control relaying" "SECTrelaycontrol"
30127 .cindex "&ACL;" "relay control"
30128 .cindex "relaying" "control by ACL"
30129 .cindex "policy control" "relay control"
30130 An MTA is said to &'relay'& a message if it receives it from some host and
30131 delivers it directly to another host as a result of a remote address contained
30132 within it. Redirecting a local address via an alias or forward file and then
30133 passing the message on to another host is not relaying,
30134 .cindex "&""percent hack""&"
30135 but a redirection as a result of the &"percent hack"& is.
30136
30137 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
30138 A host which is acting as a gateway or an MX backup is concerned with incoming
30139 relaying from arbitrary hosts to a specific set of domains. On the other hand,
30140 a host which is acting as a smart host for a number of clients is concerned
30141 with outgoing relaying from those clients to the Internet at large. Often the
30142 same host is fulfilling both functions,
30143 . ///
30144 . as illustrated in the diagram below,
30145 . ///
30146 but in principle these two kinds of relaying are entirely independent. What is
30147 not wanted is the transmission of mail from arbitrary remote hosts through your
30148 system to arbitrary domains.
30149
30150
30151 You can implement relay control by means of suitable statements in the ACL that
30152 runs for each RCPT command. For convenience, it is often easiest to use
30153 Exim's named list facility to define the domains and hosts involved. For
30154 example, suppose you want to do the following:
30155
30156 .ilist
30157 Deliver a number of domains to mailboxes on the local host (or process them
30158 locally in some other way). Let's say these are &'my.dom1.example'& and
30159 &'my.dom2.example'&.
30160 .next
30161 Relay mail for a number of other domains for which you are the secondary MX.
30162 These might be &'friend1.example'& and &'friend2.example'&.
30163 .next
30164 Relay mail from the hosts on your local LAN, to whatever domains are involved.
30165 Suppose your LAN is 192.168.45.0/24.
30166 .endlist
30167
30168
30169 In the main part of the configuration, you put the following definitions:
30170 .code
30171 domainlist local_domains    = my.dom1.example : my.dom2.example
30172 domainlist relay_to_domains = friend1.example : friend2.example
30173 hostlist   relay_from_hosts = 192.168.45.0/24
30174 .endd
30175 Now you can use these definitions in the ACL that is run for every RCPT
30176 command:
30177 .code
30178 acl_check_rcpt:
30179   accept domains = +local_domains : +relay_to_domains
30180   accept hosts   = +relay_from_hosts
30181 .endd
30182 The first statement accepts any RCPT command that contains an address in
30183 the local or relay domains. For any other domain, control passes to the second
30184 statement, which accepts the command only if it comes from one of the relay
30185 hosts. In practice, you will probably want to make your ACL more sophisticated
30186 than this, for example, by including sender and recipient verification. The
30187 default configuration includes a more comprehensive example, which is described
30188 in chapter &<<CHAPdefconfil>>&.
30189
30190
30191
30192 .section "Checking a relay configuration" "SECTcheralcon"
30193 .cindex "relaying" "checking control of"
30194 You can check the relay characteristics of your configuration in the same way
30195 that you can test any ACL behaviour for an incoming SMTP connection, by using
30196 the &%-bh%& option to run a fake SMTP session with which you interact.
30197
30198 For specifically testing for unwanted relaying, the host
30199 &'relay-test.mail-abuse.org'& provides a useful service. If you telnet to this
30200 host from the host on which Exim is running, using the normal telnet port, you
30201 will see a normal telnet connection message and then quite a long delay. Be
30202 patient. The remote host is making an SMTP connection back to your host, and
30203 trying a number of common probes to test for open relay vulnerability. The
30204 results of the tests will eventually appear on your terminal.
30205 .ecindex IIDacl
30206
30207
30208
30209 . ////////////////////////////////////////////////////////////////////////////
30210 . ////////////////////////////////////////////////////////////////////////////
30211
30212 .chapter "Content scanning at ACL time" "CHAPexiscan"
30213 .scindex IIDcosca "content scanning" "at ACL time"
30214 The extension of Exim to include content scanning at ACL time, formerly known
30215 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
30216 was integrated into the main source for Exim release 4.50, and Tom continues to
30217 maintain it. Most of the wording of this chapter is taken from Tom's
30218 specification.
30219
30220 It is also possible to scan the content of messages at other times. The
30221 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
30222 scanning after all the ACLs have run. A transport filter can be used to scan
30223 messages at delivery time (see the &%transport_filter%& option, described in
30224 chapter &<<CHAPtransportgeneric>>&).
30225
30226 If you want to include the ACL-time content-scanning features when you compile
30227 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
30228 &_Local/Makefile_&. When you do that, the Exim binary is built with:
30229
30230 .ilist
30231 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
30232 for all MIME parts for SMTP and non-SMTP messages, respectively.
30233 .next
30234 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
30235 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
30236 run at the end of message reception (the &%acl_smtp_data%& ACL).
30237 .next
30238 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
30239 of messages, or parts of messages, for debugging purposes.
30240 .next
30241 Additional expansion variables that are set in the new ACL and by the new
30242 conditions.
30243 .next
30244 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
30245 .endlist
30246
30247 There is another content-scanning configuration option for &_Local/Makefile_&,
30248 called WITH_OLD_DEMIME. If this is set, the old, deprecated &%demime%& ACL
30249 condition is compiled, in addition to all the other content-scanning features.
30250
30251 Content-scanning is continually evolving, and new features are still being
30252 added. While such features are still unstable and liable to incompatible
30253 changes, they are made available in Exim by setting options whose names begin
30254 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
30255 this manual. You can find out about them by reading the file called
30256 &_doc/experimental.txt_&.
30257
30258 All the content-scanning facilities work on a MBOX copy of the message that is
30259 temporarily created in a file called:
30260 .display
30261 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
30262 .endd
30263 The &_.eml_& extension is a friendly hint to virus scanners that they can
30264 expect an MBOX-like structure inside that file. The file is created when the
30265 first content scanning facility is called. Subsequent calls to content
30266 scanning conditions open the same file again. The directory is recursively
30267 removed when the &%acl_smtp_data%& ACL has finished running, unless
30268 .code
30269 control = no_mbox_unspool
30270 .endd
30271 has been encountered. When the MIME ACL decodes files, they are put into the
30272 same directory by default.
30273
30274
30275
30276 .section "Scanning for viruses" "SECTscanvirus"
30277 .cindex "virus scanning"
30278 .cindex "content scanning" "for viruses"
30279 .cindex "content scanning" "the &%malware%& condition"
30280 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
30281 It supports a &"generic"& interface to scanners called via the shell, and
30282 specialized interfaces for &"daemon"& type virus scanners, which are resident
30283 in memory and thus are much faster.
30284
30285
30286 .oindex "&%av_scanner%&"
30287 You can set the &%av_scanner%& option in first part of the Exim configuration
30288 file to specify which scanner to use, together with any additional options that
30289 are needed. The basic syntax is as follows:
30290 .display
30291 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
30292 .endd
30293 If you do not set &%av_scanner%&, it defaults to
30294 .code
30295 av_scanner = sophie:/var/run/sophie
30296 .endd
30297 If the value of &%av_scanner%& starts with a dollar character, it is expanded
30298 before use.
30299 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
30300 The following scanner types are supported in this release:
30301
30302 .vlist
30303 .vitem &%aveserver%&
30304 .cindex "virus scanners" "Kaspersky"
30305 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
30306 at &url(http://www.kaspersky.com). This scanner type takes one option,
30307 which is the path to the daemon's UNIX socket. The default is shown in this
30308 example:
30309 .code
30310 av_scanner = aveserver:/var/run/aveserver
30311 .endd
30312
30313
30314 .vitem &%clamd%&
30315 .cindex "virus scanners" "clamd"
30316 This daemon-type scanner is GPL and free. You can get it at
30317 &url(http://www.clamav.net/). Some older versions of clamd do not seem to
30318 unpack MIME containers, so it used to be recommended to unpack MIME attachments
30319 in the MIME ACL. This no longer believed to be necessary. One option is
30320 required: either the path and name of a UNIX socket file, or a hostname or IP
30321 number, and a port, separated by space, as in the second of these examples:
30322 .code
30323 av_scanner = clamd:/opt/clamd/socket
30324 av_scanner = clamd:192.0.2.3 1234
30325 av_scanner = clamd:192.0.2.3 1234:local
30326 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
30327 .endd
30328 If the value of av_scanner points to a UNIX socket file or contains the local
30329 keyword, then the ClamAV interface will pass a filename containing the data
30330 to be scanned, which will should normally result in less I/O happening and be
30331 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
30332 Exim does not assume that there is a common filesystem with the remote host.
30333 There is an option WITH_OLD_CLAMAV_STREAM in &_src/EDITME_& available, should
30334 you be running a version of ClamAV prior to 0.95.
30335
30336 The final example shows that multiple TCP targets can be specified.  Exim will
30337 randomly use one for each incoming email (i.e. it load balances them).  Note
30338 that only TCP targets may be used if specifying a list of scanners; a UNIX
30339 socket cannot be mixed in with TCP targets.  If one of the servers becomes
30340 unavailable, Exim will try the remaining one(s) until it finds one that works.
30341 When a clamd server becomes unreachable, Exim will log a message.  Exim does
30342 not keep track of scanner state between multiple messages, and the scanner
30343 selection is random, so the message will get logged in the mainlog for each
30344 email that the down scanner gets chosen first (message wrapped to be readable):
30345 .code
30346 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
30347    clamd: connection to localhost, port 3310 failed
30348    (Connection refused)
30349 .endd
30350
30351 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
30352 contributing the code for this scanner.
30353
30354 .vitem &%cmdline%&
30355 .cindex "virus scanners" "command line interface"
30356 This is the keyword for the generic command line scanner interface. It can be
30357 used to attach virus scanners that are invoked from the shell. This scanner
30358 type takes 3 mandatory options:
30359
30360 .olist
30361 The full path and name of the scanner binary, with all command line options,
30362 and a placeholder (&`%s`&) for the directory to scan.
30363
30364 .next
30365 A regular expression to match against the STDOUT and STDERR output of the
30366 virus scanner. If the expression matches, a virus was found. You must make
30367 absolutely sure that this expression matches on &"virus found"&. This is called
30368 the &"trigger"& expression.
30369
30370 .next
30371 Another regular expression, containing exactly one pair of parentheses, to
30372 match the name of the virus found in the scanners output. This is called the
30373 &"name"& expression.
30374 .endlist olist
30375
30376 For example, Sophos Sweep reports a virus on a line like this:
30377 .code
30378 Virus 'W32/Magistr-B' found in file ./those.bat
30379 .endd
30380 For the trigger expression, we can match the phrase &"found in file"&. For the
30381 name expression, we want to extract the W32/Magistr-B string, so we can match
30382 for the single quotes left and right of it. Altogether, this makes the
30383 configuration setting:
30384 .code
30385 av_scanner = cmdline:\
30386              /path/to/sweep -ss -all -rec -archive %s:\
30387              found in file:'(.+)'
30388 .endd
30389 .vitem &%drweb%&
30390 .cindex "virus scanners" "DrWeb"
30391 The DrWeb daemon scanner (&url(http://www.sald.com/)) interface
30392 takes one option,
30393 either a full path to a UNIX socket,
30394 or host and port specifiers separated by white space.
30395 The host may be a name or an IP address; the port is either a
30396 single number or a pair of numbers with a dash between.
30397 For example:
30398 .code
30399 av_scanner = drweb:/var/run/drwebd.sock
30400 av_scanner = drweb:192.168.2.20 31337
30401 .endd
30402 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
30403 is used. Thanks to Alex Miller for contributing the code for this scanner.
30404
30405 .vitem &%f-protd%&
30406 .cindex "virus scanners" "f-protd"
30407 The f-protd scanner is accessed via HTTP over TCP.
30408 One argument is taken, being a space-separated hostname and port number
30409 (or port-range).
30410 For example:
30411 .code
30412 av_scanner = f-protd:localhost 10200-10204
30413 .endd
30414 If you omit the argument, the default values show above are used.
30415
30416 .vitem &%fsecure%&
30417 .cindex "virus scanners" "F-Secure"
30418 The F-Secure daemon scanner (&url(http://www.f-secure.com)) takes one
30419 argument which is the path to a UNIX socket. For example:
30420 .code
30421 av_scanner = fsecure:/path/to/.fsav
30422 .endd
30423 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
30424 Thelmen for contributing the code for this scanner.
30425
30426 .vitem &%kavdaemon%&
30427 .cindex "virus scanners" "Kaspersky"
30428 This is the scanner daemon of Kaspersky Version 4. This version of the
30429 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
30430 scanner type takes one option, which is the path to the daemon's UNIX socket.
30431 For example:
30432 .code
30433 av_scanner = kavdaemon:/opt/AVP/AvpCtl
30434 .endd
30435 The default path is &_/var/run/AvpCtl_&.
30436
30437 .vitem &%mksd%&
30438 .cindex "virus scanners" "mksd"
30439 This is a daemon type scanner that is aimed mainly at Polish users, though some
30440 parts of documentation are now available in English. You can get it at
30441 &url(http://linux.mks.com.pl/). The only option for this scanner type is
30442 the maximum number of processes used simultaneously to scan the attachments,
30443 provided that the demime facility is employed and also provided that mksd has
30444 been run with at least the same number of child processes. For example:
30445 .code
30446 av_scanner = mksd:2
30447 .endd
30448 You can safely omit this option (the default value is 1).
30449
30450 .vitem &%sock%&
30451 .cindex "virus scanners" "simple socket-connected"
30452 This is a general-purpose way of talking to simple scanner daemons
30453 running on the local machine.
30454 There are four options:
30455 an address (which may be an IP addres and port, or the path of a Unix socket),
30456 a commandline to send (may include a single %s which will be replaced with
30457 the path to the mail file to be scanned),
30458 an RE to trigger on from the returned data,
30459 an RE to extract malware_name from the returned data.
30460 For example:
30461 .code
30462 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)\$
30463 .endd
30464 Default for the socket specifier is &_/tmp/malware.sock_&.
30465 Default for the commandline is &_%s\n_&.
30466 Both regular-expressions are required.
30467
30468 .vitem &%sophie%&
30469 .cindex "virus scanners" "Sophos and Sophie"
30470 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
30471 You can get Sophie at &url(http://www.clanfield.info/sophie/). The only option
30472 for this scanner type is the path to the UNIX socket that Sophie uses for
30473 client communication. For example:
30474 .code
30475 av_scanner = sophie:/tmp/sophie
30476 .endd
30477 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
30478 the option.
30479 .endlist
30480
30481 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
30482 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
30483 ACL.
30484
30485 The &%av_scanner%& option is expanded each time &%malware%& is called. This
30486 makes it possible to use different scanners. See further below for an example.
30487 The &%malware%& condition caches its results, so when you use it multiple times
30488 for the same message, the actual scanning process is only carried out once.
30489 However, using expandable items in &%av_scanner%& disables this caching, in
30490 which case each use of the &%malware%& condition causes a new scan of the
30491 message.
30492
30493 The &%malware%& condition takes a right-hand argument that is expanded before
30494 use. It can then be one of
30495
30496 .ilist
30497 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
30498 The condition succeeds if a virus was found, and fail otherwise. This is the
30499 recommended usage.
30500 .next
30501 &"false"& or &"0"& or an empty string, in which case no scanning is done and
30502 the condition fails immediately.
30503 .next
30504 A regular expression, in which case the message is scanned for viruses. The
30505 condition succeeds if a virus is found and its name matches the regular
30506 expression. This allows you to take special actions on certain types of virus.
30507 .endlist
30508
30509 You can append &`/defer_ok`& to the &%malware%& condition to accept messages
30510 even if there is a problem with the virus scanner. Otherwise, such a problem
30511 causes the ACL to defer.
30512
30513 .vindex "&$malware_name$&"
30514 When a virus is found, the condition sets up an expansion variable called
30515 &$malware_name$& that contains the name of the virus. You can use it in a
30516 &%message%& modifier that specifies the error returned to the sender, and/or in
30517 logging data.
30518
30519 If your virus scanner cannot unpack MIME and TNEF containers itself, you should
30520 use the &%demime%& condition (see section &<<SECTdemimecond>>&) before the
30521 &%malware%& condition.
30522
30523 Beware the interaction of Exim's &%message_size_limit%& with any size limits
30524 imposed by your anti-virus scanner.
30525
30526 Here is a very simple scanning example:
30527 .code
30528 deny message = This message contains malware ($malware_name)
30529      demime = *
30530      malware = *
30531 .endd
30532 The next example accepts messages when there is a problem with the scanner:
30533 .code
30534 deny message = This message contains malware ($malware_name)
30535      demime = *
30536      malware = */defer_ok
30537 .endd
30538 The next example shows how to use an ACL variable to scan with both sophie and
30539 aveserver. It assumes you have set:
30540 .code
30541 av_scanner = $acl_m0
30542 .endd
30543 in the main Exim configuration.
30544 .code
30545 deny message = This message contains malware ($malware_name)
30546      set acl_m0 = sophie
30547      malware = *
30548
30549 deny message = This message contains malware ($malware_name)
30550      set acl_m0 = aveserver
30551      malware = *
30552 .endd
30553
30554
30555 .section "Scanning with SpamAssassin" "SECTscanspamass"
30556 .cindex "content scanning" "for spam"
30557 .cindex "spam scanning"
30558 .cindex "SpamAssassin"
30559 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
30560 score and a report for the message. You can get SpamAssassin at
30561 &url(http://www.spamassassin.org), or, if you have a working Perl
30562 installation, you can use CPAN by running:
30563 .code
30564 perl -MCPAN -e 'install Mail::SpamAssassin'
30565 .endd
30566 SpamAssassin has its own set of configuration files. Please review its
30567 documentation to see how you can tweak it. The default installation should work
30568 nicely, however.
30569
30570 .oindex "&%spamd_address%&"
30571 After having installed and configured SpamAssassin, start the &%spamd%& daemon.
30572 By default, it listens on 127.0.0.1, TCP port 783. If you use another host or
30573 port for &%spamd%&, you must set the &%spamd_address%& option in the global
30574 part of the Exim configuration as follows (example):
30575 .code
30576 spamd_address = 192.168.99.45 387
30577 .endd
30578 You do not need to set this option if you use the default. As of version 2.60,
30579 &%spamd%& also supports communication over UNIX sockets. If you want to use
30580 these, supply &%spamd_address%& with an absolute file name instead of a
30581 address/port pair:
30582 .code
30583 spamd_address = /var/run/spamd_socket
30584 .endd
30585 You can have multiple &%spamd%& servers to improve scalability. These can
30586 reside on other hardware reachable over the network. To specify multiple
30587 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
30588 option, separated with colons:
30589 .code
30590 spamd_address = 192.168.2.10 783 : \
30591                 192.168.2.11 783 : \
30592                 192.168.2.12 783
30593 .endd
30594 Up to 32 &%spamd%& servers are supported. The servers are queried in a random
30595 fashion. When a server fails to respond to the connection attempt, all other
30596 servers are tried until one succeeds. If no server responds, the &%spam%&
30597 condition defers.
30598
30599 &*Warning*&: It is not possible to use the UNIX socket connection method with
30600 multiple &%spamd%& servers.
30601
30602 The &%spamd_address%& variable is expanded before use if it starts with
30603 a dollar sign. In this case, the expansion may return a string that is
30604 used as the list so that multiple spamd servers can be the result of an
30605 expansion.
30606
30607 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
30608 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
30609 .code
30610 deny message = This message was classified as SPAM
30611      spam = joe
30612 .endd
30613 The right-hand side of the &%spam%& condition specifies a name. This is
30614 relevant if you have set up multiple SpamAssassin profiles. If you do not want
30615 to scan using a specific profile, but rather use the SpamAssassin system-wide
30616 default profile, you can scan for an unknown name, or simply use &"nobody"&.
30617 However, you must put something on the right-hand side.
30618
30619 The name allows you to use per-domain or per-user antispam profiles in
30620 principle, but this is not straightforward in practice, because a message may
30621 have multiple recipients, not necessarily all in the same domain. Because the
30622 &%spam%& condition has to be called from a DATA ACL in order to be able to
30623 read the contents of the message, the variables &$local_part$& and &$domain$&
30624 are not set.
30625
30626 The right-hand side of the &%spam%& condition is expanded before being used, so
30627 you can put lookups or conditions there. When the right-hand side evaluates to
30628 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
30629
30630
30631 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
30632 large ones may cause significant performance degradation. As most spam messages
30633 are quite small, it is recommended that you do not scan the big ones. For
30634 example:
30635 .code
30636 deny message = This message was classified as SPAM
30637      condition = ${if < {$message_size}{10K}}
30638      spam = nobody
30639 .endd
30640
30641 The &%spam%& condition returns true if the threshold specified in the user's
30642 SpamAssassin profile has been matched or exceeded. If you want to use the
30643 &%spam%& condition for its side effects (see the variables below), you can make
30644 it always return &"true"& by appending &`:true`& to the username.
30645
30646 .cindex "spam scanning" "returned variables"
30647 When the &%spam%& condition is run, it sets up a number of expansion
30648 variables. These variables are saved with the received message, thus they are
30649 available for use at delivery time.
30650
30651 .vlist
30652 .vitem &$spam_score$&
30653 The spam score of the message, for example &"3.4"& or &"30.5"&. This is useful
30654 for inclusion in log or reject messages.
30655
30656 .vitem &$spam_score_int$&
30657 The spam score of the message, multiplied by ten, as an integer value. For
30658 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
30659 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
30660 The integer value is useful for numeric comparisons in conditions.
30661
30662 .vitem &$spam_bar$&
30663 A string consisting of a number of &"+"& or &"-"& characters, representing the
30664 integer part of the spam score value. A spam score of 4.4 would have a
30665 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
30666 headers, since MUAs can match on such strings.
30667
30668 .vitem &$spam_report$&
30669 A multiline text table, containing the full SpamAssassin report for the
30670 message. Useful for inclusion in headers or reject messages.
30671 .endlist
30672
30673 The &%spam%& condition caches its results unless expansion in
30674 spamd_address was used. If you call it again with the same user name, it
30675 does not scan again, but rather returns the same values as before.
30676
30677 The &%spam%& condition returns DEFER if there is any error while running
30678 the message through SpamAssassin or if the expansion of spamd_address
30679 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
30680 statement block), append &`/defer_ok`& to the right-hand side of the
30681 spam condition, like this:
30682 .code
30683 deny message = This message was classified as SPAM
30684      spam    = joe/defer_ok
30685 .endd
30686 This causes messages to be accepted even if there is a problem with &%spamd%&.
30687
30688 Here is a longer, commented example of the use of the &%spam%&
30689 condition:
30690 .code
30691 # put headers in all messages (no matter if spam or not)
30692 warn  spam = nobody:true
30693       add_header = X-Spam-Score: $spam_score ($spam_bar)
30694       add_header = X-Spam-Report: $spam_report
30695
30696 # add second subject line with *SPAM* marker when message
30697 # is over threshold
30698 warn  spam = nobody
30699       add_header = Subject: *SPAM* $h_Subject:
30700
30701 # reject spam at high scores (> 12)
30702 deny  message = This message scored $spam_score spam points.
30703       spam = nobody:true
30704       condition = ${if >{$spam_score_int}{120}{1}{0}}
30705 .endd
30706
30707
30708
30709 .section "Scanning MIME parts" "SECTscanmimepart"
30710 .cindex "content scanning" "MIME parts"
30711 .cindex "MIME content scanning"
30712 .oindex "&%acl_smtp_mime%&"
30713 .oindex "&%acl_not_smtp_mime%&"
30714 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
30715 each MIME part of an SMTP message, including multipart types, in the sequence
30716 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
30717 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
30718 options may both refer to the same ACL if you want the same processing in both
30719 cases.
30720
30721 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
30722 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
30723 the case of a non-SMTP message. However, a MIME ACL is called only if the
30724 message contains a &'Content-Type:'& header line. When a call to a MIME
30725 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
30726 result code is sent to the client. In the case of an SMTP message, the
30727 &%acl_smtp_data%& ACL is not called when this happens.
30728
30729 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
30730 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
30731 condition to match against the raw MIME part. You can also use the
30732 &%mime_regex%& condition to match against the decoded MIME part (see section
30733 &<<SECTscanregex>>&).
30734
30735 At the start of a MIME ACL, a number of variables are set from the header
30736 information for the relevant MIME part. These are described below. The contents
30737 of the MIME part are not by default decoded into a disk file except for MIME
30738 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
30739 part into a disk file, you can use the &%decode%& condition. The general
30740 syntax is:
30741 .display
30742 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
30743 .endd
30744 The right hand side is expanded before use. After expansion,
30745 the value can be:
30746
30747 .olist
30748 &"0"& or &"false"&, in which case no decoding is done.
30749 .next
30750 The string &"default"&. In that case, the file is put in the temporary
30751 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
30752 a sequential file name consisting of the message id and a sequence number. The
30753 full path and name is available in &$mime_decoded_filename$& after decoding.
30754 .next
30755 A full path name starting with a slash. If the full name is an existing
30756 directory, it is used as a replacement for the default directory. The filename
30757 is then sequentially assigned. If the path does not exist, it is used as
30758 the full path and file name.
30759 .next
30760 If the string does not start with a slash, it is used as the
30761 filename, and the default path is then used.
30762 .endlist
30763 The &%decode%& condition normally succeeds. It is only false for syntax
30764 errors or unusual circumstances such as memory shortages. You can easily decode
30765 a file with its original, proposed filename using
30766 .code
30767 decode = $mime_filename
30768 .endd
30769 However, you should keep in mind that &$mime_filename$& might contain
30770 anything. If you place files outside of the default path, they are not
30771 automatically unlinked.
30772
30773 For RFC822 attachments (these are messages attached to messages, with a
30774 content-type of &"message/rfc822"&), the ACL is called again in the same manner
30775 as for the primary message, only that the &$mime_is_rfc822$& expansion
30776 variable is set (see below). Attached messages are always decoded to disk
30777 before being checked, and the files are unlinked once the check is done.
30778
30779 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
30780 used to match regular expressions against raw and decoded MIME parts,
30781 respectively. They are described in section &<<SECTscanregex>>&.
30782
30783 .cindex "MIME content scanning" "returned variables"
30784 The following list describes all expansion variables that are
30785 available in the MIME ACL:
30786
30787 .vlist
30788 .vitem &$mime_boundary$&
30789 If the current part is a multipart (see &$mime_is_multipart$&) below, it should
30790 have a boundary string, which is stored in this variable. If the current part
30791 has no boundary parameter in the &'Content-Type:'& header, this variable
30792 contains the empty string.
30793
30794 .vitem &$mime_charset$&
30795 This variable contains the character set identifier, if one was found in the
30796 &'Content-Type:'& header. Examples for charset identifiers are:
30797 .code
30798 us-ascii
30799 gb2312 (Chinese)
30800 iso-8859-1
30801 .endd
30802 Please note that this value is not normalized, so you should do matches
30803 case-insensitively.
30804
30805 .vitem &$mime_content_description$&
30806 This variable contains the normalized content of the &'Content-Description:'&
30807 header. It can contain a human-readable description of the parts content. Some
30808 implementations repeat the filename for attachments here, but they are usually
30809 only used for display purposes.
30810
30811 .vitem &$mime_content_disposition$&
30812 This variable contains the normalized content of the &'Content-Disposition:'&
30813 header. You can expect strings like &"attachment"& or &"inline"& here.
30814
30815 .vitem &$mime_content_id$&
30816 This variable contains the normalized content of the &'Content-ID:'& header.
30817 This is a unique ID that can be used to reference a part from another part.
30818
30819 .vitem &$mime_content_size$&
30820 This variable is set only after the &%decode%& modifier (see above) has been
30821 successfully run. It contains the size of the decoded part in kilobytes. The
30822 size is always rounded up to full kilobytes, so only a completely empty part
30823 has a &$mime_content_size$& of zero.
30824
30825 .vitem &$mime_content_transfer_encoding$&
30826 This variable contains the normalized content of the
30827 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
30828 type. Typical values are &"base64"& and &"quoted-printable"&.
30829
30830 .vitem &$mime_content_type$&
30831 If the MIME part has a &'Content-Type:'& header, this variable contains its
30832 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
30833 are some examples of popular MIME types, as they may appear in this variable:
30834 .code
30835 text/plain
30836 text/html
30837 application/octet-stream
30838 image/jpeg
30839 audio/midi
30840 .endd
30841 If the MIME part has no &'Content-Type:'& header, this variable contains the
30842 empty string.
30843
30844 .vitem &$mime_decoded_filename$&
30845 This variable is set only after the &%decode%& modifier (see above) has been
30846 successfully run. It contains the full path and file name of the file
30847 containing the decoded data.
30848 .endlist
30849
30850 .cindex "RFC 2047"
30851 .vlist
30852 .vitem &$mime_filename$&
30853 This is perhaps the most important of the MIME variables. It contains a
30854 proposed filename for an attachment, if one was found in either the
30855 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
30856 RFC2047 decoded, but no additional sanity checks are done. If no filename was
30857 found, this variable contains the empty string.
30858
30859 .vitem &$mime_is_coverletter$&
30860 This variable attempts to differentiate the &"cover letter"& of an e-mail from
30861 attached data. It can be used to clamp down on flashy or unnecessarily encoded
30862 content in the cover letter, while not restricting attachments at all.
30863
30864 The variable contains 1 (true) for a MIME part believed to be part of the
30865 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
30866 follows:
30867
30868 .olist
30869 The outermost MIME part of a message is always a cover letter.
30870
30871 .next
30872 If a multipart/alternative or multipart/related MIME part is a cover letter,
30873 so are all MIME subparts within that multipart.
30874
30875 .next
30876 If any other multipart is a cover letter, the first subpart is a cover letter,
30877 and the rest are attachments.
30878
30879 .next
30880 All parts contained within an attachment multipart are attachments.
30881 .endlist olist
30882
30883 As an example, the following will ban &"HTML mail"& (including that sent with
30884 alternative plain text), while allowing HTML files to be attached. HTML
30885 coverletter mail attached to non-HMTL coverletter mail will also be allowed:
30886 .code
30887 deny message = HTML mail is not accepted here
30888 !condition = $mime_is_rfc822
30889 condition = $mime_is_coverletter
30890 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
30891 .endd
30892 .vitem &$mime_is_multipart$&
30893 This variable has the value 1 (true) when the current part has the main type
30894 &"multipart"&, for example &"multipart/alternative"& or &"multipart/mixed"&.
30895 Since multipart entities only serve as containers for other parts, you may not
30896 want to carry out specific actions on them.
30897
30898 .vitem &$mime_is_rfc822$&
30899 This variable has the value 1 (true) if the current part is not a part of the
30900 checked message itself, but part of an attached message. Attached message
30901 decoding is fully recursive.
30902
30903 .vitem &$mime_part_count$&
30904 This variable is a counter that is raised for each processed MIME part. It
30905 starts at zero for the very first part (which is usually a multipart). The
30906 counter is per-message, so it is reset when processing RFC822 attachments (see
30907 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
30908 complete, so you can use it in the DATA ACL to determine the number of MIME
30909 parts of a message. For non-MIME messages, this variable contains the value -1.
30910 .endlist
30911
30912
30913
30914 .section "Scanning with regular expressions" "SECTscanregex"
30915 .cindex "content scanning" "with regular expressions"
30916 .cindex "regular expressions" "content scanning with"
30917 You can specify your own custom regular expression matches on the full body of
30918 the message, or on individual MIME parts.
30919
30920 The &%regex%& condition takes one or more regular expressions as arguments and
30921 matches them against the full message (when called in the DATA ACL) or a raw
30922 MIME part (when called in the MIME ACL). The &%regex%& condition matches
30923 linewise, with a maximum line length of 32K characters. That means you cannot
30924 have multiline matches with the &%regex%& condition.
30925
30926 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
30927 to 32K of decoded content (the whole content at once, not linewise). If the
30928 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
30929 is decoded automatically when &%mime_regex%& is executed (using default path
30930 and filename values). If the decoded data is larger than  32K, only the first
30931 32K characters are checked.
30932
30933 The regular expressions are passed as a colon-separated list. To include a
30934 literal colon, you must double it. Since the whole right-hand side string is
30935 expanded before being used, you must also escape dollar signs and backslashes
30936 with more backslashes, or use the &`\N`& facility to disable expansion.
30937 Here is a simple example that contains two regular expressions:
30938 .code
30939 deny message = contains blacklisted regex ($regex_match_string)
30940      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
30941 .endd
30942 The conditions returns true if any one of the regular expressions matches. The
30943 &$regex_match_string$& expansion variable is then set up and contains the
30944 matching regular expression.
30945
30946 &*Warning*&: With large messages, these conditions can be fairly
30947 CPU-intensive.
30948
30949
30950
30951
30952 .section "The demime condition" "SECTdemimecond"
30953 .cindex "content scanning" "MIME checking"
30954 .cindex "MIME content scanning"
30955 The &%demime%& ACL condition provides MIME unpacking, sanity checking and file
30956 extension blocking. It is usable only in the DATA and non-SMTP ACLs. The
30957 &%demime%& condition uses a simpler interface to MIME decoding than the MIME
30958 ACL functionality, but provides no additional facilities. Please note that this
30959 condition is deprecated and kept only for backward compatibility. You must set
30960 the WITH_OLD_DEMIME option in &_Local/Makefile_& at build time to be able to
30961 use the &%demime%& condition.
30962
30963 The &%demime%& condition unpacks MIME containers in the message. It detects
30964 errors in MIME containers and can match file extensions found in the message
30965 against a list. Using this facility produces files containing the unpacked MIME
30966 parts of the message in the temporary scan directory. If you do antivirus
30967 scanning, it is recommended that you use the &%demime%& condition before the
30968 antivirus (&%malware%&) condition.
30969
30970 On the right-hand side of the &%demime%& condition you can pass a
30971 colon-separated list of file extensions that it should match against. For
30972 example:
30973 .code
30974 deny message = Found blacklisted file attachment
30975      demime  = vbs:com:bat:pif:prf:lnk
30976 .endd
30977 If one of the file extensions is found, the condition is true, otherwise it is
30978 false. If there is a temporary error while demimeing (for example, &"disk
30979 full"&), the condition defers, and the message is temporarily rejected (unless
30980 the condition is on a &%warn%& verb).
30981
30982 The right-hand side is expanded before being treated as a list, so you can have
30983 conditions and lookups there. If it expands to an empty string, &"false"&, or
30984 zero (&"0"&), no demimeing is done and the condition is false.
30985
30986 The &%demime%& condition set the following variables:
30987
30988 .vlist
30989 .vitem &$demime_errorlevel$&
30990 .vindex "&$demime_errorlevel$&"
30991 When an error is detected in a MIME container, this variable contains the
30992 severity of the error, as an integer number. The higher the value, the more
30993 severe the error (the current maximum value is 3). If this variable is unset or
30994 zero, no error occurred.
30995
30996 .vitem &$demime_reason$&
30997 .vindex "&$demime_reason$&"
30998 When &$demime_errorlevel$& is greater than zero, this variable contains a
30999 human-readable text string describing the MIME error that occurred.
31000 .endlist
31001
31002 .vlist
31003 .vitem &$found_extension$&
31004 .vindex "&$found_extension$&"
31005 When the &%demime%& condition is true, this variable contains the file
31006 extension it found.
31007 .endlist
31008
31009 Both &$demime_errorlevel$& and &$demime_reason$& are set by the first call of
31010 the &%demime%& condition, and are not changed on subsequent calls.
31011
31012 If you do not want to check for file extensions, but rather use the &%demime%&
31013 condition for unpacking or error checking purposes, pass &"*"& as the
31014 right-hand side value. Here is a more elaborate example of how to use this
31015 facility:
31016 .code
31017 # Reject messages with serious MIME container errors
31018 deny  message = Found MIME error ($demime_reason).
31019       demime = *
31020       condition = ${if >{$demime_errorlevel}{2}{1}{0}}
31021
31022 # Reject known virus spreading file extensions.
31023 # Accepting these is pretty much braindead.
31024 deny  message = contains $found_extension file (blacklisted).
31025       demime  = com:vbs:bat:pif:scr
31026
31027 # Freeze .exe and .doc files. Postmaster can
31028 # examine them and eventually thaw them.
31029 deny  log_message = Another $found_extension file.
31030       demime = exe:doc
31031       control = freeze
31032 .endd
31033 .ecindex IIDcosca
31034
31035
31036
31037
31038 . ////////////////////////////////////////////////////////////////////////////
31039 . ////////////////////////////////////////////////////////////////////////////
31040
31041 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
31042          "Local scan function"
31043 .scindex IIDlosca "&[local_scan()]& function" "description of"
31044 .cindex "customizing" "input scan using C function"
31045 .cindex "policy control" "by local scan function"
31046 In these days of email worms, viruses, and ever-increasing spam, some sites
31047 want to apply a lot of checking to messages before accepting them.
31048
31049 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
31050 passing messages to external virus and spam scanning software. You can also do
31051 a certain amount in Exim itself through string expansions and the &%condition%&
31052 condition in the ACL that runs after the SMTP DATA command or the ACL for
31053 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
31054
31055 To allow for further customization to a site's own requirements, there is the
31056 possibility of linking Exim with a private message scanning function, written
31057 in C. If you want to run code that is written in something other than C, you
31058 can of course use a little C stub to call it.
31059
31060 The local scan function is run once for every incoming message, at the point
31061 when Exim is just about to accept the message.
31062 It can therefore be used to control non-SMTP messages from local processes as
31063 well as messages arriving via SMTP.
31064
31065 Exim applies a timeout to calls of the local scan function, and there is an
31066 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
31067 Zero means &"no timeout"&.
31068 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
31069 before calling the local scan function, so that the most common types of crash
31070 are caught. If the timeout is exceeded or one of those signals is caught, the
31071 incoming message is rejected with a temporary error if it is an SMTP message.
31072 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
31073 code. The incident is logged on the main and reject logs.
31074
31075
31076
31077 .section "Building Exim to use a local scan function" "SECID207"
31078 .cindex "&[local_scan()]& function" "building Exim to use"
31079 To make use of the local scan function feature, you must tell Exim where your
31080 function is before building Exim, by setting LOCAL_SCAN_SOURCE in your
31081 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
31082 directory, so you might set
31083 .code
31084 LOCAL_SCAN_SOURCE=Local/local_scan.c
31085 .endd
31086 for example. The function must be called &[local_scan()]&. It is called by
31087 Exim after it has received a message, when the success return code is about to
31088 be sent. This is after all the ACLs have been run. The return code from your
31089 function controls whether the message is actually accepted or not. There is a
31090 commented template function (that just accepts the message) in the file
31091 _src/local_scan.c_.
31092
31093 If you want to make use of Exim's run time configuration file to set options
31094 for your &[local_scan()]& function, you must also set
31095 .code
31096 LOCAL_SCAN_HAS_OPTIONS=yes
31097 .endd
31098 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
31099
31100
31101
31102
31103 .section "API for local_scan()" "SECTapiforloc"
31104 .cindex "&[local_scan()]& function" "API description"
31105 You must include this line near the start of your code:
31106 .code
31107 #include "local_scan.h"
31108 .endd
31109 This header file defines a number of variables and other values, and the
31110 prototype for the function itself. Exim is coded to use unsigned char values
31111 almost exclusively, and one of the things this header defines is a shorthand
31112 for &`unsigned char`& called &`uschar`&.
31113 It also contains the following macro definitions, to simplify casting character
31114 strings and pointers to character strings:
31115 .code
31116 #define CS   (char *)
31117 #define CCS  (const char *)
31118 #define CSS  (char **)
31119 #define US   (unsigned char *)
31120 #define CUS  (const unsigned char *)
31121 #define USS  (unsigned char **)
31122 .endd
31123 The function prototype for &[local_scan()]& is:
31124 .code
31125 extern int local_scan(int fd, uschar **return_text);
31126 .endd
31127 The arguments are as follows:
31128
31129 .ilist
31130 &%fd%& is a file descriptor for the file that contains the body of the message
31131 (the -D file). The file is open for reading and writing, but updating it is not
31132 recommended. &*Warning*&: You must &'not'& close this file descriptor.
31133
31134 The descriptor is positioned at character 19 of the file, which is the first
31135 character of the body itself, because the first 19 characters are the message
31136 id followed by &`-D`& and a newline. If you rewind the file, you should use the
31137 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
31138 case this changes in some future version.
31139 .next
31140 &%return_text%& is an address which you can use to return a pointer to a text
31141 string at the end of the function. The value it points to on entry is NULL.
31142 .endlist
31143
31144 The function must return an &%int%& value which is one of the following macros:
31145
31146 .vlist
31147 .vitem &`LOCAL_SCAN_ACCEPT`&
31148 .vindex "&$local_scan_data$&"
31149 The message is accepted. If you pass back a string of text, it is saved with
31150 the message, and made available in the variable &$local_scan_data$&. No
31151 newlines are permitted (if there are any, they are turned into spaces) and the
31152 maximum length of text is 1000 characters.
31153
31154 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
31155 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
31156 queued without immediate delivery, and is frozen.
31157
31158 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
31159 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
31160 queued without immediate delivery.
31161
31162 .vitem &`LOCAL_SCAN_REJECT`&
31163 The message is rejected; the returned text is used as an error message which is
31164 passed back to the sender and which is also logged. Newlines are permitted &--
31165 they cause a multiline response for SMTP rejections, but are converted to
31166 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
31167 used.
31168
31169 .vitem &`LOCAL_SCAN_TEMPREJECT`&
31170 The message is temporarily rejected; the returned text is used as an error
31171 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
31172 problem"& is used.
31173
31174 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
31175 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
31176 message is not written to the reject log. It has the effect of unsetting the
31177 &%rejected_header%& log selector for just this rejection. If
31178 &%rejected_header%& is already unset (see the discussion of the
31179 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
31180 same as LOCAL_SCAN_REJECT.
31181
31182 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
31183 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
31184 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
31185 .endlist
31186
31187 If the message is not being received by interactive SMTP, rejections are
31188 reported by writing to &%stderr%& or by sending an email, as configured by the
31189 &%-oe%& command line options.
31190
31191
31192
31193 .section "Configuration options for local_scan()" "SECTconoptloc"
31194 .cindex "&[local_scan()]& function" "configuration options"
31195 It is possible to have option settings in the main configuration file
31196 that set values in static variables in the &[local_scan()]& module. If you
31197 want to do this, you must have the line
31198 .code
31199 LOCAL_SCAN_HAS_OPTIONS=yes
31200 .endd
31201 in your &_Local/Makefile_& when you build Exim. (This line is in
31202 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
31203 file, you must define static variables to hold the option values, and a table
31204 to define them.
31205
31206 The table must be a vector called &%local_scan_options%&, of type
31207 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
31208 and a pointer to the variable that holds the value. The entries must appear in
31209 alphabetical order. Following &%local_scan_options%& you must also define a
31210 variable called &%local_scan_options_count%& that contains the number of
31211 entries in the table. Here is a short example, showing two kinds of option:
31212 .code
31213 static int my_integer_option = 42;
31214 static uschar *my_string_option = US"a default string";
31215
31216 optionlist local_scan_options[] = {
31217   { "my_integer", opt_int,       &my_integer_option },
31218   { "my_string",  opt_stringptr, &my_string_option }
31219 };
31220
31221 int local_scan_options_count =
31222   sizeof(local_scan_options)/sizeof(optionlist);
31223 .endd
31224 The values of the variables can now be changed from Exim's runtime
31225 configuration file by including a local scan section as in this example:
31226 .code
31227 begin local_scan
31228 my_integer = 99
31229 my_string = some string of text...
31230 .endd
31231 The available types of option data are as follows:
31232
31233 .vlist
31234 .vitem &*opt_bool*&
31235 This specifies a boolean (true/false) option. The address should point to a
31236 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
31237 that are defined as &"1"& and &"0"&, respectively. If you want to detect
31238 whether such a variable has been set at all, you can initialize it to
31239 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
31240 values.)
31241
31242 .vitem &*opt_fixed*&
31243 This specifies a fixed point number, such as is used for load averages.
31244 The address should point to a variable of type &`int`&. The value is stored
31245 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
31246
31247 .vitem &*opt_int*&
31248 This specifies an integer; the address should point to a variable of type
31249 &`int`&. The value may be specified in any of the integer formats accepted by
31250 Exim.
31251
31252 .vitem &*opt_mkint*&
31253 This is the same as &%opt_int%&, except that when such a value is output in a
31254 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
31255 printed with the suffix K or M.
31256
31257 .vitem &*opt_octint*&
31258 This also specifies an integer, but the value is always interpreted as an
31259 octal integer, whether or not it starts with the digit zero, and it is
31260 always output in octal.
31261
31262 .vitem &*opt_stringptr*&
31263 This specifies a string value; the address must be a pointer to a
31264 variable that points to a string (for example, of type &`uschar *`&).
31265
31266 .vitem &*opt_time*&
31267 This specifies a time interval value. The address must point to a variable of
31268 type &`int`&. The value that is placed there is a number of seconds.
31269 .endlist
31270
31271 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
31272 out the values of all the &[local_scan()]& options.
31273
31274
31275
31276 .section "Available Exim variables" "SECID208"
31277 .cindex "&[local_scan()]& function" "available Exim variables"
31278 The header &_local_scan.h_& gives you access to a number of C variables. These
31279 are the only ones that are guaranteed to be maintained from release to release.
31280 Note, however, that you can obtain the value of any Exim expansion variable,
31281 including &$recipients$&, by calling &'expand_string()'&. The exported
31282 C variables are as follows:
31283
31284 .vlist
31285 .vitem &*int&~body_linecount*&
31286 This variable contains the number of lines in the message's body.
31287
31288 .vitem &*int&~body_zerocount*&
31289 This variable contains the number of binary zero bytes in the message's body.
31290
31291 .vitem &*unsigned&~int&~debug_selector*&
31292 This variable is set to zero when no debugging is taking place. Otherwise, it
31293 is a bitmap of debugging selectors. Two bits are identified for use in
31294 &[local_scan()]&; they are defined as macros:
31295
31296 .ilist
31297 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
31298 testing option that is not privileged &-- any caller may set it. All the
31299 other selector bits can be set only by admin users.
31300
31301 .next
31302 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
31303 by the &`+local_scan`& debug selector. It is not included in the default set
31304 of debugging bits.
31305 .endlist ilist
31306
31307 Thus, to write to the debugging output only when &`+local_scan`& has been
31308 selected, you should use code like this:
31309 .code
31310 if ((debug_selector & D_local_scan) != 0)
31311   debug_printf("xxx", ...);
31312 .endd
31313 .vitem &*uschar&~*expand_string_message*&
31314 After a failing call to &'expand_string()'& (returned value NULL), the
31315 variable &%expand_string_message%& contains the error message, zero-terminated.
31316
31317 .vitem &*header_line&~*header_list*&
31318 A pointer to a chain of header lines. The &%header_line%& structure is
31319 discussed below.
31320
31321 .vitem &*header_line&~*header_last*&
31322 A pointer to the last of the header lines.
31323
31324 .vitem &*uschar&~*headers_charset*&
31325 The value of the &%headers_charset%& configuration option.
31326
31327 .vitem &*BOOL&~host_checking*&
31328 This variable is TRUE during a host checking session that is initiated by the
31329 &%-bh%& command line option.
31330
31331 .vitem &*uschar&~*interface_address*&
31332 The IP address of the interface that received the message, as a string. This
31333 is NULL for locally submitted messages.
31334
31335 .vitem &*int&~interface_port*&
31336 The port on which this message was received. When testing with the &%-bh%&
31337 command line option, the value of this variable is -1 unless a port has been
31338 specified via the &%-oMi%& option.
31339
31340 .vitem &*uschar&~*message_id*&
31341 This variable contains Exim's message id for the incoming message (the value of
31342 &$message_exim_id$&) as a zero-terminated string.
31343
31344 .vitem &*uschar&~*received_protocol*&
31345 The name of the protocol by which the message was received.
31346
31347 .vitem &*int&~recipients_count*&
31348 The number of accepted recipients.
31349
31350 .vitem &*recipient_item&~*recipients_list*&
31351 .cindex "recipient" "adding in local scan"
31352 .cindex "recipient" "removing in local scan"
31353 The list of accepted recipients, held in a vector of length
31354 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
31355 can add additional recipients by calling &'receive_add_recipient()'& (see
31356 below). You can delete recipients by removing them from the vector and
31357 adjusting the value in &%recipients_count%&. In particular, by setting
31358 &%recipients_count%& to zero you remove all recipients. If you then return the
31359 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
31360 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
31361 and then call &'receive_add_recipient()'& as often as needed.
31362
31363 .vitem &*uschar&~*sender_address*&
31364 The envelope sender address. For bounce messages this is the empty string.
31365
31366 .vitem &*uschar&~*sender_host_address*&
31367 The IP address of the sending host, as a string. This is NULL for
31368 locally-submitted messages.
31369
31370 .vitem &*uschar&~*sender_host_authenticated*&
31371 The name of the authentication mechanism that was used, or NULL if the message
31372 was not received over an authenticated SMTP connection.
31373
31374 .vitem &*uschar&~*sender_host_name*&
31375 The name of the sending host, if known.
31376
31377 .vitem &*int&~sender_host_port*&
31378 The port on the sending host.
31379
31380 .vitem &*BOOL&~smtp_input*&
31381 This variable is TRUE for all SMTP input, including BSMTP.
31382
31383 .vitem &*BOOL&~smtp_batched_input*&
31384 This variable is TRUE for BSMTP input.
31385
31386 .vitem &*int&~store_pool*&
31387 The contents of this variable control which pool of memory is used for new
31388 requests. See section &<<SECTmemhanloc>>& for details.
31389 .endlist
31390
31391
31392 .section "Structure of header lines" "SECID209"
31393 The &%header_line%& structure contains the members listed below.
31394 You can add additional header lines by calling the &'header_add()'& function
31395 (see below). You can cause header lines to be ignored (deleted) by setting
31396 their type to *.
31397
31398
31399 .vlist
31400 .vitem &*struct&~header_line&~*next*&
31401 A pointer to the next header line, or NULL for the last line.
31402
31403 .vitem &*int&~type*&
31404 A code identifying certain headers that Exim recognizes. The codes are printing
31405 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
31406 Notice in particular that any header line whose type is * is not transmitted
31407 with the message. This flagging is used for header lines that have been
31408 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
31409 lines.) Effectively, * means &"deleted"&.
31410
31411 .vitem &*int&~slen*&
31412 The number of characters in the header line, including the terminating and any
31413 internal newlines.
31414
31415 .vitem &*uschar&~*text*&
31416 A pointer to the text of the header. It always ends with a newline, followed by
31417 a zero byte. Internal newlines are preserved.
31418 .endlist
31419
31420
31421
31422 .section "Structure of recipient items" "SECID210"
31423 The &%recipient_item%& structure contains these members:
31424
31425 .vlist
31426 .vitem &*uschar&~*address*&
31427 This is a pointer to the recipient address as it was received.
31428
31429 .vitem &*int&~pno*&
31430 This is used in later Exim processing when top level addresses are created by
31431 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
31432 and must always contain -1 at this stage.
31433
31434 .vitem &*uschar&~*errors_to*&
31435 If this value is not NULL, bounce messages caused by failing to deliver to the
31436 recipient are sent to the address it contains. In other words, it overrides the
31437 envelope sender for this one recipient. (Compare the &%errors_to%& generic
31438 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
31439 an unqualified address, Exim qualifies it using the domain from
31440 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
31441 is NULL for all recipients.
31442 .endlist
31443
31444
31445
31446 .section "Available Exim functions" "SECID211"
31447 .cindex "&[local_scan()]& function" "available Exim functions"
31448 The header &_local_scan.h_& gives you access to a number of Exim functions.
31449 These are the only ones that are guaranteed to be maintained from release to
31450 release:
31451
31452 .vlist
31453 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
31454        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
31455
31456 This function creates a child process that runs the command specified by
31457 &%argv%&. The environment for the process is specified by &%envp%&, which can
31458 be NULL if no environment variables are to be passed. A new umask is supplied
31459 for the process in &%newumask%&.
31460
31461 Pipes to the standard input and output of the new process are set up
31462 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
31463 standard error is cloned to the standard output. If there are any file
31464 descriptors &"in the way"& in the new process, they are closed. If the final
31465 argument is TRUE, the new process is made into a process group leader.
31466
31467 The function returns the pid of the new process, or -1 if things go wrong.
31468
31469 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
31470 This function waits for a child process to terminate, or for a timeout (in
31471 seconds) to expire. A timeout value of zero means wait as long as it takes. The
31472 return value is as follows:
31473
31474 .ilist
31475 >= 0
31476
31477 The process terminated by a normal exit and the value is the process
31478 ending status.
31479
31480 .next
31481 < 0 and > &--256
31482
31483 The process was terminated by a signal and the value is the negation of the
31484 signal number.
31485
31486 .next
31487 &--256
31488
31489 The process timed out.
31490 .next
31491 &--257
31492
31493 The was some other error in wait(); &%errno%& is still set.
31494 .endlist
31495
31496 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
31497 This function provide you with a means of submitting a new message to
31498 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
31499 want, but this packages it all up for you.) The function creates a pipe,
31500 forks a subprocess that is running
31501 .code
31502 exim -t -oem -oi -f <>
31503 .endd
31504 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
31505 that is connected to the standard input. The yield of the function is the PID
31506 of the subprocess. You can then write a message to the file descriptor, with
31507 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
31508
31509 When you have finished, call &'child_close()'& to wait for the process to
31510 finish and to collect its ending status. A timeout value of zero is usually
31511 fine in this circumstance. Unless you have made a mistake with the recipient
31512 addresses, you should get a return code of zero.
31513
31514
31515 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
31516        *sender_authentication)*&
31517 This function is a more sophisticated version of &'child_open()'&. The command
31518 that it runs is:
31519 .display
31520 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
31521 .endd
31522 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
31523
31524
31525 .vitem &*void&~debug_printf(char&~*,&~...)*&
31526 This is Exim's debugging function, with arguments as for &'(printf()'&. The
31527 output is written to the standard error stream. If no debugging is selected,
31528 calls to &'debug_printf()'& have no effect. Normally, you should make calls
31529 conditional on the &`local_scan`& debug selector by coding like this:
31530 .code
31531 if ((debug_selector & D_local_scan) != 0)
31532   debug_printf("xxx", ...);
31533 .endd
31534
31535 .vitem &*uschar&~*expand_string(uschar&~*string)*&
31536 This is an interface to Exim's string expansion code. The return value is the
31537 expanded string, or NULL if there was an expansion failure.
31538 The C variable &%expand_string_message%& contains an error message after an
31539 expansion failure. If expansion does not change the string, the return value is
31540 the pointer to the input string. Otherwise, the return value points to a new
31541 block of memory that was obtained by a call to &'store_get()'&. See section
31542 &<<SECTmemhanloc>>& below for a discussion of memory handling.
31543
31544 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
31545 This function allows you to an add additional header line at the end of the
31546 existing ones. The first argument is the type, and should normally be a space
31547 character. The second argument is a format string and any number of
31548 substitution arguments as for &[sprintf()]&. You may include internal newlines
31549 if you want, and you must ensure that the string ends with a newline.
31550
31551 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
31552         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
31553 This function adds a new header line at a specified point in the header
31554 chain. The header itself is specified as for &'header_add()'&.
31555
31556 If &%name%& is NULL, the new header is added at the end of the chain if
31557 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
31558 NULL, the header lines are searched for the first non-deleted header that
31559 matches the name. If one is found, the new header is added before it if
31560 &%after%& is false. If &%after%& is true, the new header is added after the
31561 found header and any adjacent subsequent ones with the same name (even if
31562 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
31563 option controls where the header is added. If it is true, addition is at the
31564 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
31565 headers, or at the top if there are no &'Received:'& headers, you could use
31566 .code
31567 header_add_at_position(TRUE, US"Received", TRUE,
31568   ' ', "X-xxx: ...");
31569 .endd
31570 Normally, there is always at least one non-deleted &'Received:'& header, but
31571 there may not be if &%received_header_text%& expands to an empty string.
31572
31573
31574 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
31575 This function removes header lines. If &%occurrence%& is zero or negative, all
31576 occurrences of the header are removed. If occurrence is greater than zero, that
31577 particular instance of the header is removed. If no header(s) can be found that
31578 match the specification, the function does nothing.
31579
31580
31581 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
31582         int&~length,&~BOOL&~notdel)*&"
31583 This function tests whether the given header has the given name. It is not just
31584 a string comparison, because white space is permitted between the name and the
31585 colon. If the &%notdel%& argument is true, a false return is forced for all
31586 &"deleted"& headers; otherwise they are not treated specially. For example:
31587 .code
31588 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
31589 .endd
31590 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
31591 .cindex "base64 encoding" "functions for &[local_scan()]& use"
31592 This function base64-encodes a string, which is passed by address and length.
31593 The text may contain bytes of any value, including zero. The result is passed
31594 back in dynamic memory that is obtained by calling &'store_get()'&. It is
31595 zero-terminated.
31596
31597 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
31598 This function decodes a base64-encoded string. Its arguments are a
31599 zero-terminated base64-encoded string and the address of a variable that is set
31600 to point to the result, which is in dynamic memory. The length of the decoded
31601 string is the yield of the function. If the input is invalid base64 data, the
31602 yield is -1. A zero byte is added to the end of the output string to make it
31603 easy to interpret as a C string (assuming it contains no zeros of its own). The
31604 added zero byte is not included in the returned count.
31605
31606 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
31607 This function checks for a match in a domain list. Domains are always
31608 matched caselessly. The return value is one of the following:
31609 .display
31610 &`OK     `& match succeeded
31611 &`FAIL   `& match failed
31612 &`DEFER  `& match deferred
31613 .endd
31614 DEFER is usually caused by some kind of lookup defer, such as the
31615 inability to contact a database.
31616
31617 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
31618         BOOL&~caseless)*&"
31619 This function checks for a match in a local part list. The third argument
31620 controls case-sensitivity. The return values are as for
31621 &'lss_match_domain()'&.
31622
31623 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
31624         BOOL&~caseless)*&"
31625 This function checks for a match in an address list. The third argument
31626 controls the case-sensitivity of the local part match. The domain is always
31627 matched caselessly. The return values are as for &'lss_match_domain()'&.
31628
31629 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
31630         uschar&~*list)*&"
31631 This function checks for a match in a host list. The most common usage is
31632 expected to be
31633 .code
31634 lss_match_host(sender_host_name, sender_host_address, ...)
31635 .endd
31636 .vindex "&$sender_host_address$&"
31637 An empty address field matches an empty item in the host list. If the host name
31638 is NULL, the name corresponding to &$sender_host_address$& is automatically
31639 looked up if a host name is required to match an item in the list. The return
31640 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
31641 returns ERROR in the case when it had to look up a host name, but the lookup
31642 failed.
31643
31644 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
31645         *format,&~...)*&"
31646 This function writes to Exim's log files. The first argument should be zero (it
31647 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
31648 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
31649 them. It specifies to which log or logs the message is written. The remaining
31650 arguments are a format and relevant insertion arguments. The string should not
31651 contain any newlines, not even at the end.
31652
31653
31654 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
31655 This function adds an additional recipient to the message. The first argument
31656 is the recipient address. If it is unqualified (has no domain), it is qualified
31657 with the &%qualify_recipient%& domain. The second argument must always be -1.
31658
31659 This function does not allow you to specify a private &%errors_to%& address (as
31660 described with the structure of &%recipient_item%& above), because it pre-dates
31661 the addition of that field to the structure. However, it is easy to add such a
31662 value afterwards. For example:
31663 .code
31664  receive_add_recipient(US"monitor@mydom.example", -1);
31665  recipients_list[recipients_count-1].errors_to =
31666    US"postmaster@mydom.example";
31667 .endd
31668
31669 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
31670 This is a convenience function to remove a named recipient from the list of
31671 recipients. It returns true if a recipient was removed, and false if no
31672 matching recipient could be found. The argument must be a complete email
31673 address.
31674 .endlist
31675
31676
31677 .cindex "RFC 2047"
31678 .vlist
31679 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
31680   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
31681 This function decodes strings that are encoded according to RFC 2047. Typically
31682 these are the contents of header lines. First, each &"encoded word"& is decoded
31683 from the Q or B encoding into a byte-string. Then, if provided with the name of
31684 a charset encoding, and if the &[iconv()]& function is available, an attempt is
31685 made  to translate the result to the named character set. If this fails, the
31686 binary string is returned with an error message.
31687
31688 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
31689 maximum MIME word length is enforced. The third argument is the target
31690 encoding, or NULL if no translation is wanted.
31691
31692 .cindex "binary zero" "in RFC 2047 decoding"
31693 .cindex "RFC 2047" "binary zero in"
31694 If a binary zero is encountered in the decoded string, it is replaced by the
31695 contents of the &%zeroval%& argument. For use with Exim headers, the value must
31696 not be 0 because header lines are handled as zero-terminated strings.
31697
31698 The function returns the result of processing the string, zero-terminated; if
31699 &%lenptr%& is not NULL, the length of the result is set in the variable to
31700 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
31701
31702 If an error is encountered, the function returns NULL and uses the &%error%&
31703 argument to return an error message. The variable pointed to by &%error%& is
31704 set to NULL if there is no error; it may be set non-NULL even when the function
31705 returns a non-NULL value if decoding was successful, but there was a problem
31706 with translation.
31707
31708
31709 .vitem &*int&~smtp_fflush(void)*&
31710 This function is used in conjunction with &'smtp_printf()'&, as described
31711 below.
31712
31713 .vitem &*void&~smtp_printf(char&~*,&~...)*&
31714 The arguments of this function are like &[printf()]&; it writes to the SMTP
31715 output stream. You should use this function only when there is an SMTP output
31716 stream, that is, when the incoming message is being received via interactive
31717 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
31718 is FALSE. If you want to test for an incoming message from another host (as
31719 opposed to a local process that used the &%-bs%& command line option), you can
31720 test the value of &%sender_host_address%&, which is non-NULL when a remote host
31721 is involved.
31722
31723 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
31724 output function, so it can be used for all forms of SMTP connection.
31725
31726 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
31727 must start with an appropriate response code: 550 if you are going to return
31728 LOCAL_SCAN_REJECT, 451 if you are going to return
31729 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
31730 initial lines of a multi-line response, the code must be followed by a hyphen
31731 to indicate that the line is not the final response line. You must also ensure
31732 that the lines you write terminate with CRLF. For example:
31733 .code
31734 smtp_printf("550-this is some extra info\r\n");
31735 return LOCAL_SCAN_REJECT;
31736 .endd
31737 Note that you can also create multi-line responses by including newlines in
31738 the data returned via the &%return_text%& argument. The added value of using
31739 &'smtp_printf()'& is that, for instance, you could introduce delays between
31740 multiple output lines.
31741
31742 The &'smtp_printf()'& function does not return any error indication, because it
31743 does not automatically flush pending output, and therefore does not test
31744 the state of the stream. (In the main code of Exim, flushing and error
31745 detection is done when Exim is ready for the next SMTP input command.) If
31746 you want to flush the output and check for an error (for example, the
31747 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
31748 arguments. It flushes the output stream, and returns a non-zero value if there
31749 is an error.
31750
31751 .vitem &*void&~*store_get(int)*&
31752 This function accesses Exim's internal store (memory) manager. It gets a new
31753 chunk of memory whose size is given by the argument. Exim bombs out if it ever
31754 runs out of memory. See the next section for a discussion of memory handling.
31755
31756 .vitem &*void&~*store_get_perm(int)*&
31757 This function is like &'store_get()'&, but it always gets memory from the
31758 permanent pool. See the next section for a discussion of memory handling.
31759
31760 .vitem &*uschar&~*string_copy(uschar&~*string)*&
31761 See below.
31762
31763 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
31764 See below.
31765
31766 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
31767 These three functions create strings using Exim's dynamic memory facilities.
31768 The first makes a copy of an entire string. The second copies up to a maximum
31769 number of characters, indicated by the second argument. The third uses a format
31770 and insertion arguments to create a new string. In each case, the result is a
31771 pointer to a new string in the current memory pool. See the next section for
31772 more discussion.
31773 .endlist
31774
31775
31776
31777 .section "More about Exim's memory handling" "SECTmemhanloc"
31778 .cindex "&[local_scan()]& function" "memory handling"
31779 No function is provided for freeing memory, because that is never needed.
31780 The dynamic memory that Exim uses when receiving a message is automatically
31781 recycled if another message is received by the same process (this applies only
31782 to incoming SMTP connections &-- other input methods can supply only one
31783 message at a time). After receiving the last message, a reception process
31784 terminates.
31785
31786 Because it is recycled, the normal dynamic memory cannot be used for holding
31787 data that must be preserved over a number of incoming messages on the same SMTP
31788 connection. However, Exim in fact uses two pools of dynamic memory; the second
31789 one is not recycled, and can be used for this purpose.
31790
31791 If you want to allocate memory that remains available for subsequent messages
31792 in the same SMTP connection, you should set
31793 .code
31794 store_pool = POOL_PERM
31795 .endd
31796 before calling the function that does the allocation. There is no need to
31797 restore the value if you do not need to; however, if you do want to revert to
31798 the normal pool, you can either restore the previous value of &%store_pool%& or
31799 set it explicitly to POOL_MAIN.
31800
31801 The pool setting applies to all functions that get dynamic memory, including
31802 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
31803 There is also a convenience function called &'store_get_perm()'& that gets a
31804 block of memory from the permanent pool while preserving the value of
31805 &%store_pool%&.
31806 .ecindex IIDlosca
31807
31808
31809
31810
31811 . ////////////////////////////////////////////////////////////////////////////
31812 . ////////////////////////////////////////////////////////////////////////////
31813
31814 .chapter "System-wide message filtering" "CHAPsystemfilter"
31815 .scindex IIDsysfil1 "filter" "system filter"
31816 .scindex IIDsysfil2 "filtering all mail"
31817 .scindex IIDsysfil3 "system filter"
31818 The previous chapters (on ACLs and the local scan function) describe checks
31819 that can be applied to messages before they are accepted by a host. There is
31820 also a mechanism for checking messages once they have been received, but before
31821 they are delivered. This is called the &'system filter'&.
31822
31823 The system filter operates in a similar manner to users' filter files, but it
31824 is run just once per message (however many recipients the message has).
31825 It should not normally be used as a substitute for routing, because &%deliver%&
31826 commands in a system router provide new envelope recipient addresses.
31827 The system filter must be an Exim filter. It cannot be a Sieve filter.
31828
31829 The system filter is run at the start of a delivery attempt, before any routing
31830 is done. If a message fails to be completely delivered at the first attempt,
31831 the system filter is run again at the start of every retry.
31832 If you want your filter to do something only once per message, you can make use
31833 of the &%first_delivery%& condition in an &%if%& command in the filter to
31834 prevent it happening on retries.
31835
31836 .vindex "&$domain$&"
31837 .vindex "&$local_part$&"
31838 &*Warning*&: Because the system filter runs just once, variables that are
31839 specific to individual recipient addresses, such as &$local_part$& and
31840 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
31841 you want to run a centrally-specified filter for each recipient address
31842 independently, you can do so by setting up a suitable &(redirect)& router, as
31843 described in section &<<SECTperaddfil>>& below.
31844
31845
31846 .section "Specifying a system filter" "SECID212"
31847 .cindex "uid (user id)" "system filter"
31848 .cindex "gid (group id)" "system filter"
31849 The name of the file that contains the system filter must be specified by
31850 setting &%system_filter%&. If you want the filter to run under a uid and gid
31851 other than root, you must also set &%system_filter_user%& and
31852 &%system_filter_group%& as appropriate. For example:
31853 .code
31854 system_filter = /etc/mail/exim.filter
31855 system_filter_user = exim
31856 .endd
31857 If a system filter generates any deliveries directly to files or pipes (via the
31858 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
31859 specified by setting &%system_filter_file_transport%& and
31860 &%system_filter_pipe_transport%&, respectively. Similarly,
31861 &%system_filter_reply_transport%& must be set to handle any messages generated
31862 by the &%reply%& command.
31863
31864
31865 .section "Testing a system filter" "SECID213"
31866 You can run simple tests of a system filter in the same way as for a user
31867 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
31868 are permitted only in system filters are recognized.
31869
31870 If you want to test the combined effect of a system filter and a user filter,
31871 you can use both &%-bF%& and &%-bf%& on the same command line.
31872
31873
31874
31875 .section "Contents of a system filter" "SECID214"
31876 The language used to specify system filters is the same as for users' filter
31877 files. It is described in the separate end-user document &'Exim's interface to
31878 mail filtering'&. However, there are some additional features that are
31879 available only in system filters; these are described in subsequent sections.
31880 If they are encountered in a user's filter file or when testing with &%-bf%&,
31881 they cause errors.
31882
31883 .cindex "frozen messages" "manual thaw; testing in filter"
31884 There are two special conditions which, though available in users' filter
31885 files, are designed for use in system filters. The condition &%first_delivery%&
31886 is true only for the first attempt at delivering a message, and
31887 &%manually_thawed%& is true only if the message has been frozen, and
31888 subsequently thawed by an admin user. An explicit forced delivery counts as a
31889 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
31890
31891 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
31892 specify an &"unseen"& (non-significant) delivery, and that delivery does not
31893 succeed, it will not be tried again.
31894 If you want Exim to retry an unseen delivery until it succeeds, you should
31895 arrange to set it up every time the filter runs.
31896
31897 When a system filter finishes running, the values of the variables &$n0$& &--
31898 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
31899 users' filter files. Thus a system filter can, for example, set up &"scores"&
31900 to which users' filter files can refer.
31901
31902
31903
31904 .section "Additional variable for system filters" "SECID215"
31905 .vindex "&$recipients$&"
31906 The expansion variable &$recipients$&, containing a list of all the recipients
31907 of the message (separated by commas and white space), is available in system
31908 filters. It is not available in users' filters for privacy reasons.
31909
31910
31911
31912 .section "Defer, freeze, and fail commands for system filters" "SECID216"
31913 .cindex "freezing messages"
31914 .cindex "message" "freezing"
31915 .cindex "message" "forced failure"
31916 .cindex "&%fail%&" "in system filter"
31917 .cindex "&%freeze%& in system filter"
31918 .cindex "&%defer%& in system filter"
31919 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
31920 always available in system filters, but are not normally enabled in users'
31921 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
31922 for the &(redirect)& router.) These commands can optionally be followed by the
31923 word &%text%& and a string containing an error message, for example:
31924 .code
31925 fail text "this message looks like spam to me"
31926 .endd
31927 The keyword &%text%& is optional if the next character is a double quote.
31928
31929 The &%defer%& command defers delivery of the original recipients of the
31930 message. The &%fail%& command causes all the original recipients to be failed,
31931 and a bounce message to be created. The &%freeze%& command suspends all
31932 delivery attempts for the original recipients. In all cases, any new deliveries
31933 that are specified by the filter are attempted as normal after the filter has
31934 run.
31935
31936 The &%freeze%& command is ignored if the message has been manually unfrozen and
31937 not manually frozen since. This means that automatic freezing by a system
31938 filter can be used as a way of checking out suspicious messages. If a message
31939 is found to be all right, manually unfreezing it allows it to be delivered.
31940
31941 .cindex "log" "&%fail%& command log line"
31942 .cindex "&%fail%&" "log line; reducing"
31943 The text given with a fail command is used as part of the bounce message as
31944 well as being written to the log. If the message is quite long, this can fill
31945 up a lot of log space when such failures are common. To reduce the size of the
31946 log message, Exim interprets the text in a special way if it starts with the
31947 two characters &`<<`& and contains &`>>`& later. The text between these two
31948 strings is written to the log, and the rest of the text is used in the bounce
31949 message. For example:
31950 .code
31951 fail "<<filter test 1>>Your message is rejected \
31952      because it contains attachments that we are \
31953      not prepared to receive."
31954 .endd
31955
31956 .cindex "loop" "caused by &%fail%&"
31957 Take great care with the &%fail%& command when basing the decision to fail on
31958 the contents of the message, because the bounce message will of course include
31959 the contents of the original message and will therefore trigger the &%fail%&
31960 command again (causing a mail loop) unless steps are taken to prevent this.
31961 Testing the &%error_message%& condition is one way to prevent this. You could
31962 use, for example
31963 .code
31964 if $message_body contains "this is spam" and not error_message
31965 then fail text "spam is not wanted here" endif
31966 .endd
31967 though of course that might let through unwanted bounce messages. The
31968 alternative is clever checking of the body and/or headers to detect bounces
31969 generated by the filter.
31970
31971 The interpretation of a system filter file ceases after a
31972 &%defer%&,
31973 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
31974 set up earlier in the filter file are honoured, so you can use a sequence such
31975 as
31976 .code
31977 mail ...
31978 freeze
31979 .endd
31980 to send a specified message when the system filter is freezing (or deferring or
31981 failing) a message. The normal deliveries for the message do not, of course,
31982 take place.
31983
31984
31985
31986 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
31987 .cindex "header lines" "adding; in system filter"
31988 .cindex "header lines" "removing; in system filter"
31989 .cindex "filter" "header lines; adding/removing"
31990 Two filter commands that are available only in system filters are:
31991 .code
31992 headers add <string>
31993 headers remove <string>
31994 .endd
31995 The argument for the &%headers add%& is a string that is expanded and then
31996 added to the end of the message's headers. It is the responsibility of the
31997 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
31998 space is ignored, and if the string is otherwise empty, or if the expansion is
31999 forced to fail, the command has no effect.
32000
32001 You can use &"\n"& within the string, followed by white space, to specify
32002 continued header lines. More than one header may be added in one command by
32003 including &"\n"& within the string without any following white space. For
32004 example:
32005 .code
32006 headers add "X-header-1: ....\n  \
32007              continuation of X-header-1 ...\n\
32008              X-header-2: ...."
32009 .endd
32010 Note that the header line continuation white space after the first newline must
32011 be placed before the backslash that continues the input string, because white
32012 space after input continuations is ignored.
32013
32014 The argument for &%headers remove%& is a colon-separated list of header names.
32015 This command applies only to those headers that are stored with the message;
32016 those that are added at delivery time (such as &'Envelope-To:'& and
32017 &'Return-Path:'&) cannot be removed by this means. If there is more than one
32018 header with the same name, they are all removed.
32019
32020 The &%headers%& command in a system filter makes an immediate change to the set
32021 of header lines that was received with the message (with possible additions
32022 from ACL processing). Subsequent commands in the system filter operate on the
32023 modified set, which also forms the basis for subsequent message delivery.
32024 Unless further modified during routing or transporting, this set of headers is
32025 used for all recipients of the message.
32026
32027 During routing and transporting, the variables that refer to the contents of
32028 header lines refer only to those lines that are in this set. Thus, header lines
32029 that are added by a system filter are visible to users' filter files and to all
32030 routers and transports. This contrasts with the manipulation of header lines by
32031 routers and transports, which is not immediate, but which instead is saved up
32032 until the message is actually being written (see section
32033 &<<SECTheadersaddrem>>&).
32034
32035 If the message is not delivered at the first attempt, header lines that were
32036 added by the system filter are stored with the message, and so are still
32037 present at the next delivery attempt. Header lines that were removed are still
32038 present, but marked &"deleted"& so that they are not transported with the
32039 message. For this reason, it is usual to make the &%headers%& command
32040 conditional on &%first_delivery%& so that the set of header lines is not
32041 modified more than once.
32042
32043 Because header modification in a system filter acts immediately, you have to
32044 use an indirect approach if you want to modify the contents of a header line.
32045 For example:
32046 .code
32047 headers add "Old-Subject: $h_subject:"
32048 headers remove "Subject"
32049 headers add "Subject: new subject (was: $h_old-subject:)"
32050 headers remove "Old-Subject"
32051 .endd
32052
32053
32054
32055 .section "Setting an errors address in a system filter" "SECID217"
32056 .cindex "envelope sender"
32057 In a system filter, if a &%deliver%& command is followed by
32058 .code
32059 errors_to <some address>
32060 .endd
32061 in order to change the envelope sender (and hence the error reporting) for that
32062 delivery, any address may be specified. (In a user filter, only the current
32063 user's address can be set.) For example, if some mail is being monitored, you
32064 might use
32065 .code
32066 unseen deliver monitor@spying.example errors_to root@local.example
32067 .endd
32068 to take a copy which would not be sent back to the normal error reporting
32069 address if its delivery failed.
32070
32071
32072
32073 .section "Per-address filtering" "SECTperaddfil"
32074 .vindex "&$domain$&"
32075 .vindex "&$local_part$&"
32076 In contrast to the system filter, which is run just once per message for each
32077 delivery attempt, it is also possible to set up a system-wide filtering
32078 operation that runs once for each recipient address. In this case, variables
32079 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
32080 filter file could be made dependent on them. This is an example of a router
32081 which implements such a filter:
32082 .code
32083 central_filter:
32084   check_local_user
32085   driver = redirect
32086   domains = +local_domains
32087   file = /central/filters/$local_part
32088   no_verify
32089   allow_filter
32090   allow_freeze
32091 .endd
32092 The filter is run in a separate process under its own uid. Therefore, either
32093 &%check_local_user%& must be set (as above), in which case the filter is run as
32094 the local user, or the &%user%& option must be used to specify which user to
32095 use. If both are set, &%user%& overrides.
32096
32097 Care should be taken to ensure that none of the commands in the filter file
32098 specify a significant delivery if the message is to go on to be delivered to
32099 its intended recipient. The router will not then claim to have dealt with the
32100 address, so it will be passed on to subsequent routers to be delivered in the
32101 normal way.
32102 .ecindex IIDsysfil1
32103 .ecindex IIDsysfil2
32104 .ecindex IIDsysfil3
32105
32106
32107
32108
32109
32110
32111 . ////////////////////////////////////////////////////////////////////////////
32112 . ////////////////////////////////////////////////////////////////////////////
32113
32114 .chapter "Message processing" "CHAPmsgproc"
32115 .scindex IIDmesproc "message" "general processing"
32116 Exim performs various transformations on the sender and recipient addresses of
32117 all messages that it handles, and also on the messages' header lines. Some of
32118 these are optional and configurable, while others always take place. All of
32119 this processing, except rewriting as a result of routing, and the addition or
32120 removal of header lines while delivering, happens when a message is received,
32121 before it is placed on Exim's queue.
32122
32123 Some of the automatic processing takes place by default only for
32124 &"locally-originated"& messages. This adjective is used to describe messages
32125 that are not received over TCP/IP, but instead are passed to an Exim process on
32126 its standard input. This includes the interactive &"local SMTP"& case that is
32127 set up by the &%-bs%& command line option.
32128
32129 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
32130 or ::1) are not considered to be locally-originated. Exim does not treat the
32131 loopback interface specially in any way.
32132
32133 If you want the loopback interface to be treated specially, you must ensure
32134 that there are appropriate entries in your ACLs.
32135
32136
32137
32138
32139 .section "Submission mode for non-local messages" "SECTsubmodnon"
32140 .cindex "message" "submission"
32141 .cindex "submission mode"
32142 Processing that happens automatically for locally-originated messages (unless
32143 &%suppress_local_fixups%& is set) can also be requested for messages that are
32144 received over TCP/IP. The term &"submission mode"& is used to describe this
32145 state. Submission mode is set by the modifier
32146 .code
32147 control = submission
32148 .endd
32149 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
32150 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
32151 a local submission, and is normally used when the source of the message is
32152 known to be an MUA running on a client host (as opposed to an MTA). For
32153 example, to set submission mode for messages originating on the IPv4 loopback
32154 interface, you could include the following in the MAIL ACL:
32155 .code
32156 warn  hosts = 127.0.0.1
32157       control = submission
32158 .endd
32159 .cindex "&%sender_retain%& submission option"
32160 There are some options that can be used when setting submission mode. A slash
32161 is used to separate options. For example:
32162 .code
32163 control = submission/sender_retain
32164 .endd
32165 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
32166 true and &%local_from_check%& false for the current incoming message. The first
32167 of these allows an existing &'Sender:'& header in the message to remain, and
32168 the second suppresses the check to ensure that &'From:'& matches the
32169 authenticated sender. With this setting, Exim still fixes up messages by adding
32170 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
32171 attempt to check sender authenticity in header lines.
32172
32173 When &%sender_retain%& is not set, a submission mode setting may specify a
32174 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
32175 example:
32176 .code
32177 control = submission/domain=some.domain
32178 .endd
32179 The domain may be empty. How this value is used is described in sections
32180 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
32181 that allows you to specify the user's full name for inclusion in a created
32182 &'Sender:'& or &'From:'& header line. For example:
32183 .code
32184 accept authenticated = *
32185        control = submission/domain=wonderland.example/\
32186                             name=${lookup {$authenticated_id} \
32187                                    lsearch {/etc/exim/namelist}}
32188 .endd
32189 Because the name may contain any characters, including slashes, the &%name%&
32190 option must be given last. The remainder of the string is used as the name. For
32191 the example above, if &_/etc/exim/namelist_& contains:
32192 .code
32193 bigegg:  Humpty Dumpty
32194 .endd
32195 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
32196 line would be:
32197 .code
32198 Sender: Humpty Dumpty <bigegg@wonderland.example>
32199 .endd
32200 .cindex "return path" "in submission mode"
32201 By default, submission mode forces the return path to the same address as is
32202 used to create the &'Sender:'& header. However, if &%sender_retain%& is
32203 specified, the return path is also left unchanged.
32204
32205 &*Note*&: The changes caused by submission mode take effect after the predata
32206 ACL. This means that any sender checks performed before the fix-ups use the
32207 untrusted sender address specified by the user, not the trusted sender address
32208 specified by submission mode. Although this might be slightly unexpected, it
32209 does mean that you can configure ACL checks to spot that a user is trying to
32210 spoof another's address.
32211
32212 .section "Line endings" "SECTlineendings"
32213 .cindex "line endings"
32214 .cindex "carriage return"
32215 .cindex "linefeed"
32216 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
32217 linefeed) is the line ending for messages transmitted over the Internet using
32218 SMTP over TCP/IP. However, within individual operating systems, different
32219 conventions are used. For example, Unix-like systems use just LF, but others
32220 use CRLF or just CR.
32221
32222 Exim was designed for Unix-like systems, and internally, it stores messages
32223 using the system's convention of a single LF as a line terminator. When
32224 receiving a message, all line endings are translated to this standard format.
32225 Originally, it was thought that programs that passed messages directly to an
32226 MTA within an operating system would use that system's convention. Experience
32227 has shown that this is not the case; for example, there are Unix applications
32228 that use CRLF in this circumstance. For this reason, and for compatibility with
32229 other MTAs, the way Exim handles line endings for all messages is now as
32230 follows:
32231
32232 .ilist
32233 LF not preceded by CR is treated as a line ending.
32234 .next
32235 CR is treated as a line ending; if it is immediately followed by LF, the LF
32236 is ignored.
32237 .next
32238 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
32239 nor a local message in the state where a line containing only a dot is a
32240 terminator.
32241 .next
32242 If a bare CR is encountered within a header line, an extra space is added after
32243 the line terminator so as not to end the header line. The reasoning behind this
32244 is that bare CRs in header lines are most likely either to be mistakes, or
32245 people trying to play silly games.
32246 .next
32247 If the first header line received in a message ends with CRLF, a subsequent
32248 bare LF in a header line is treated in the same way as a bare CR in a header
32249 line.
32250 .endlist
32251
32252
32253
32254
32255
32256 .section "Unqualified addresses" "SECID218"
32257 .cindex "unqualified addresses"
32258 .cindex "address" "qualification"
32259 By default, Exim expects every envelope address it receives from an external
32260 host to be fully qualified. Unqualified addresses cause negative responses to
32261 SMTP commands. However, because SMTP is used as a means of transporting
32262 messages from MUAs running on personal workstations, there is sometimes a
32263 requirement to accept unqualified addresses from specific hosts or IP networks.
32264
32265 Exim has two options that separately control which hosts may send unqualified
32266 sender or recipient addresses in SMTP commands, namely
32267 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
32268 cases, if an unqualified address is accepted, it is qualified by adding the
32269 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
32270
32271 .oindex "&%qualify_domain%&"
32272 .oindex "&%qualify_recipient%&"
32273 Unqualified addresses in header lines are automatically qualified for messages
32274 that are locally originated, unless the &%-bnq%& option is given on the command
32275 line. For messages received over SMTP, unqualified addresses in header lines
32276 are qualified only if unqualified addresses are permitted in SMTP commands. In
32277 other words, such qualification is also controlled by
32278 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
32279
32280
32281
32282
32283 .section "The UUCP From line" "SECID219"
32284 .cindex "&""From""& line"
32285 .cindex "UUCP" "&""From""& line"
32286 .cindex "sender" "address"
32287 .oindex "&%uucp_from_pattern%&"
32288 .oindex "&%uucp_from_sender%&"
32289 .cindex "envelope sender"
32290 .cindex "Sendmail compatibility" "&""From""& line"
32291 Messages that have come from UUCP (and some other applications) often begin
32292 with a line containing the envelope sender and a timestamp, following the word
32293 &"From"&. Examples of two common formats are:
32294 .code
32295 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
32296 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
32297 .endd
32298 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
32299 Exim recognizes such lines at the start of messages that are submitted to it
32300 via the command line (that is, on the standard input). It does not recognize
32301 such lines in incoming SMTP messages, unless the sending host matches
32302 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
32303 and &%ignore_fromline_local%& is set. The recognition is controlled by a
32304 regular expression that is defined by the &%uucp_from_pattern%& option, whose
32305 default value matches the two common cases shown above and puts the address
32306 that follows &"From"& into &$1$&.
32307
32308 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
32309 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
32310 a trusted user, the message's sender address is constructed by expanding the
32311 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
32312 then parsed as an RFC 2822 address. If there is no domain, the local part is
32313 qualified with &%qualify_domain%& unless it is the empty string. However, if
32314 the command line &%-f%& option is used, it overrides the &"From"& line.
32315
32316 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
32317 sender address is not changed. This is also the case for incoming SMTP messages
32318 that are permitted to contain &"From"& lines.
32319
32320 Only one &"From"& line is recognized. If there is more than one, the second is
32321 treated as a data line that starts the body of the message, as it is not valid
32322 as a header line. This also happens if a &"From"& line is present in an
32323 incoming SMTP message from a source that is not permitted to send them.
32324
32325
32326
32327 .section "Resent- header lines" "SECID220"
32328 .cindex "&%Resent-%& header lines"
32329 RFC 2822 makes provision for sets of header lines starting with the string
32330 &`Resent-`& to be added to a message when it is resent by the original
32331 recipient to somebody else. These headers are &'Resent-Date:'&,
32332 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
32333 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
32334
32335 .blockquote
32336 &'Resent fields are strictly informational. They MUST NOT be used in the normal
32337 processing of replies or other such automatic actions on messages.'&
32338 .endblockquote
32339
32340 This leaves things a bit vague as far as other processing actions such as
32341 address rewriting are concerned. Exim treats &%Resent-%& header lines as
32342 follows:
32343
32344 .ilist
32345 A &'Resent-From:'& line that just contains the login id of the submitting user
32346 is automatically rewritten in the same way as &'From:'& (see below).
32347 .next
32348 If there's a rewriting rule for a particular header line, it is also applied to
32349 &%Resent-%& header lines of the same type. For example, a rule that rewrites
32350 &'From:'& also rewrites &'Resent-From:'&.
32351 .next
32352 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
32353 also removed.
32354 .next
32355 For a locally-submitted message,
32356 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
32357 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
32358 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
32359 included in log lines in this case.
32360 .next
32361 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
32362 &%Resent-%& header lines are present.
32363 .endlist
32364
32365
32366
32367
32368 .section "The Auto-Submitted: header line" "SECID221"
32369 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
32370 includes the header line:
32371 .code
32372 Auto-Submitted: auto-replied
32373 .endd
32374
32375 .section "The Bcc: header line" "SECID222"
32376 .cindex "&'Bcc:'& header line"
32377 If Exim is called with the &%-t%& option, to take recipient addresses from a
32378 message's header, it removes any &'Bcc:'& header line that may exist (after
32379 extracting its addresses). If &%-t%& is not present on the command line, any
32380 existing &'Bcc:'& is not removed.
32381
32382
32383 .section "The Date: header line" "SECID223"
32384 .cindex "&'Date:'& header line"
32385 If a locally-generated or submission-mode message has no &'Date:'& header line,
32386 Exim adds one, using the current date and time, unless the
32387 &%suppress_local_fixups%& control has been specified.
32388
32389 .section "The Delivery-date: header line" "SECID224"
32390 .cindex "&'Delivery-date:'& header line"
32391 .oindex "&%delivery_date_remove%&"
32392 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
32393 set. Exim can be configured to add them to the final delivery of messages. (See
32394 the generic &%delivery_date_add%& transport option.) They should not be present
32395 in messages in transit. If the &%delivery_date_remove%& configuration option is
32396 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
32397 messages.
32398
32399
32400 .section "The Envelope-to: header line" "SECID225"
32401 .cindex "&'Envelope-to:'& header line"
32402 .oindex "&%envelope_to_remove%&"
32403 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
32404 Exim can be configured to add them to the final delivery of messages. (See the
32405 generic &%envelope_to_add%& transport option.) They should not be present in
32406 messages in transit. If the &%envelope_to_remove%& configuration option is set
32407 (the default), Exim removes &'Envelope-to:'& header lines from incoming
32408 messages.
32409
32410
32411 .section "The From: header line" "SECTthefrohea"
32412 .cindex "&'From:'& header line"
32413 .cindex "Sendmail compatibility" "&""From""& line"
32414 .cindex "message" "submission"
32415 .cindex "submission mode"
32416 If a submission-mode message does not contain a &'From:'& header line, Exim
32417 adds one if either of the following conditions is true:
32418
32419 .ilist
32420 The envelope sender address is not empty (that is, this is not a bounce
32421 message). The added header line copies the envelope sender address.
32422 .next
32423 .vindex "&$authenticated_id$&"
32424 The SMTP session is authenticated and &$authenticated_id$& is not empty.
32425 .olist
32426 .vindex "&$qualify_domain$&"
32427 If no domain is specified by the submission control, the local part is
32428 &$authenticated_id$& and the domain is &$qualify_domain$&.
32429 .next
32430 If a non-empty domain is specified by the submission control, the local
32431 part is &$authenticated_id$&, and the domain is the specified domain.
32432 .next
32433 If an empty domain is specified by the submission control,
32434 &$authenticated_id$& is assumed to be the complete address.
32435 .endlist
32436 .endlist
32437
32438 A non-empty envelope sender takes precedence.
32439
32440 If a locally-generated incoming message does not contain a &'From:'& header
32441 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
32442 containing the sender's address. The calling user's login name and full name
32443 are used to construct the address, as described in section &<<SECTconstr>>&.
32444 They are obtained from the password data by calling &[getpwuid()]& (but see the
32445 &%unknown_login%& configuration option). The address is qualified with
32446 &%qualify_domain%&.
32447
32448 For compatibility with Sendmail, if an incoming, non-SMTP message has a
32449 &'From:'& header line containing just the unqualified login name of the calling
32450 user, this is replaced by an address containing the user's login name and full
32451 name as described in section &<<SECTconstr>>&.
32452
32453
32454 .section "The Message-ID: header line" "SECID226"
32455 .cindex "&'Message-ID:'& header line"
32456 .cindex "message" "submission"
32457 .oindex "&%message_id_header_text%&"
32458 If a locally-generated or submission-mode incoming message does not contain a
32459 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
32460 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
32461 to the message. If there are any &'Resent-:'& headers in the message, it
32462 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
32463 message id, preceded by the letter E to ensure it starts with a letter, and
32464 followed by @ and the primary host name. Additional information can be included
32465 in this header line by setting the &%message_id_header_text%& and/or
32466 &%message_id_header_domain%& options.
32467
32468
32469 .section "The Received: header line" "SECID227"
32470 .cindex "&'Received:'& header line"
32471 A &'Received:'& header line is added at the start of every message. The
32472 contents are defined by the &%received_header_text%& configuration option, and
32473 Exim automatically adds a semicolon and a timestamp to the configured string.
32474
32475 The &'Received:'& header is generated as soon as the message's header lines
32476 have been received. At this stage, the timestamp in the &'Received:'& header
32477 line is the time that the message started to be received. This is the value
32478 that is seen by the DATA ACL and by the &[local_scan()]& function.
32479
32480 Once a message is accepted, the timestamp in the &'Received:'& header line is
32481 changed to the time of acceptance, which is (apart from a small delay while the
32482 -H spool file is written) the earliest time at which delivery could start.
32483
32484
32485 .section "The References: header line" "SECID228"
32486 .cindex "&'References:'& header line"
32487 Messages created by the &(autoreply)& transport include a &'References:'&
32488 header line. This is constructed according to the rules that are described in
32489 section 3.64 of RFC 2822 (which states that replies should contain such a
32490 header line), and section 3.14 of RFC 3834 (which states that automatic
32491 responses are not different in this respect). However, because some mail
32492 processing software does not cope well with very long header lines, no more
32493 than 12 message IDs are copied from the &'References:'& header line in the
32494 incoming message. If there are more than 12, the first one and then the final
32495 11 are copied, before adding the message ID of the incoming message.
32496
32497
32498
32499 .section "The Return-path: header line" "SECID229"
32500 .cindex "&'Return-path:'& header line"
32501 .oindex "&%return_path_remove%&"
32502 &'Return-path:'& header lines are defined as something an MTA may insert when
32503 it does the final delivery of messages. (See the generic &%return_path_add%&
32504 transport option.) Therefore, they should not be present in messages in
32505 transit. If the &%return_path_remove%& configuration option is set (the
32506 default), Exim removes &'Return-path:'& header lines from incoming messages.
32507
32508
32509
32510 .section "The Sender: header line" "SECTthesenhea"
32511 .cindex "&'Sender:'& header line"
32512 .cindex "message" "submission"
32513 For a locally-originated message from an untrusted user, Exim may remove an
32514 existing &'Sender:'& header line, and it may add a new one. You can modify
32515 these actions by setting the &%local_sender_retain%& option true, the
32516 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
32517 control setting.
32518
32519 When a local message is received from an untrusted user and
32520 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
32521 control has not been set, a check is made to see if the address given in the
32522 &'From:'& header line is the correct (local) sender of the message. The address
32523 that is expected has the login name as the local part and the value of
32524 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
32525 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
32526 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
32527 line is added to the message.
32528
32529 If you set &%local_from_check%& false, this checking does not occur. However,
32530 the removal of an existing &'Sender:'& line still happens, unless you also set
32531 &%local_sender_retain%& to be true. It is not possible to set both of these
32532 options true at the same time.
32533
32534 .cindex "submission mode"
32535 By default, no processing of &'Sender:'& header lines is done for messages
32536 received over TCP/IP or for messages submitted by trusted users. However, when
32537 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
32538 not specified on the submission control, the following processing takes place:
32539
32540 .vindex "&$authenticated_id$&"
32541 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
32542 authenticated, and &$authenticated_id$& is not empty, a sender address is
32543 created as follows:
32544
32545 .ilist
32546 .vindex "&$qualify_domain$&"
32547 If no domain is specified by the submission control, the local part is
32548 &$authenticated_id$& and the domain is &$qualify_domain$&.
32549 .next
32550 If a non-empty domain is specified by the submission control, the local part
32551 is &$authenticated_id$&, and the domain is the specified domain.
32552 .next
32553 If an empty domain is specified by the submission control,
32554 &$authenticated_id$& is assumed to be the complete address.
32555 .endlist
32556
32557 This address is compared with the address in the &'From:'& header line. If they
32558 are different, a &'Sender:'& header line containing the created address is
32559 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
32560 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
32561
32562 .cindex "return path" "created from &'Sender:'&"
32563 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
32564 the message (the envelope sender address) is changed to be the same address,
32565 except in the case of submission mode when &%sender_retain%& is specified.
32566
32567
32568
32569 .section "Adding and removing header lines in routers and transports" &&&
32570          "SECTheadersaddrem"
32571 .cindex "header lines" "adding; in router or transport"
32572 .cindex "header lines" "removing; in router or transport"
32573 When a message is delivered, the addition and removal of header lines can be
32574 specified in a system filter, or on any of the routers and transports that
32575 process the message. Section &<<SECTaddremheasys>>& contains details about
32576 modifying headers in a system filter. Header lines can also be added in an ACL
32577 as a message is received (see section &<<SECTaddheadacl>>&).
32578
32579 In contrast to what happens in a system filter, header modifications that are
32580 specified on routers and transports apply only to the particular recipient
32581 addresses that are being processed by those routers and transports. These
32582 changes do not actually take place until a copy of the message is being
32583 transported. Therefore, they do not affect the basic set of header lines, and
32584 they do not affect the values of the variables that refer to header lines.
32585
32586 &*Note*&: In particular, this means that any expansions in the configuration of
32587 the transport cannot refer to the modified header lines, because such
32588 expansions all occur before the message is actually transported.
32589
32590 For both routers and transports, the argument of a &%headers_add%&
32591 option must be in the form of one or more RFC 2822 header lines, separated by
32592 newlines (coded as &"\n"&). For example:
32593 .code
32594 headers_add = X-added-header: added by $primary_hostname\n\
32595               X-added-second: another added header line
32596 .endd
32597 Exim does not check the syntax of these added header lines.
32598
32599 Multiple &%headers_add%& options for a single router or transport can be
32600 specified; the values will append to a single list of header lines.
32601 Each header-line is separately expanded.
32602
32603 The argument of a &%headers_remove%& option must consist of a colon-separated
32604 list of header names. This is confusing, because header names themselves are
32605 often terminated by colons. In this case, the colons are the list separators,
32606 not part of the names. For example:
32607 .code
32608 headers_remove = return-receipt-to:acknowledge-to
32609 .endd
32610
32611 Multiple &%headers_remove%& options for a single router or transport can be
32612 specified; the arguments will append to a single header-names list.
32613 Each item is separately expanded.
32614 Note that colons in complex expansions which are used to
32615 form all or part of a &%headers_remove%& list
32616 will act as list separators.
32617
32618 When &%headers_add%& or &%headers_remove%& is specified on a router,
32619 items are expanded at routing time,
32620 and then associated with all addresses that are
32621 accepted by that router, and also with any new addresses that it generates. If
32622 an address passes through several routers as a result of aliasing or
32623 forwarding, the changes are cumulative.
32624
32625 .oindex "&%unseen%&"
32626 However, this does not apply to multiple routers that result from the use of
32627 the &%unseen%& option. Any header modifications that were specified by the
32628 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
32629
32630 Addresses that end up with different &%headers_add%& or &%headers_remove%&
32631 settings cannot be delivered together in a batch, so a transport is always
32632 dealing with a set of addresses that have the same header-processing
32633 requirements.
32634
32635 The transport starts by writing the original set of header lines that arrived
32636 with the message, possibly modified by the system filter. As it writes out
32637 these lines, it consults the list of header names that were attached to the
32638 recipient address(es) by &%headers_remove%& options in routers, and it also
32639 consults the transport's own &%headers_remove%& option. Header lines whose
32640 names are on either of these lists are not written out. If there are multiple
32641 instances of any listed header, they are all skipped.
32642
32643 After the remaining original header lines have been written, new header
32644 lines that were specified by routers' &%headers_add%& options are written, in
32645 the order in which they were attached to the address. These are followed by any
32646 header lines specified by the transport's &%headers_add%& option.
32647
32648 This way of handling header line modifications in routers and transports has
32649 the following consequences:
32650
32651 .ilist
32652 The original set of header lines, possibly modified by the system filter,
32653 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
32654 to it, at all times.
32655 .next
32656 Header lines that are added by a router's
32657 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
32658 expansion syntax in subsequent routers or the transport.
32659 .next
32660 Conversely, header lines that are specified for removal by &%headers_remove%&
32661 in a router remain visible to subsequent routers and the transport.
32662 .next
32663 Headers added to an address by &%headers_add%& in a router cannot be removed by
32664 a later router or by a transport.
32665 .next
32666 An added header can refer to the contents of an original header that is to be
32667 removed, even it has the same name as the added header. For example:
32668 .code
32669 headers_remove = subject
32670 headers_add = Subject: new subject (was: $h_subject:)
32671 .endd
32672 .endlist
32673
32674 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
32675 for a &(redirect)& router that has the &%one_time%& option set.
32676
32677
32678
32679
32680
32681 .section "Constructed addresses" "SECTconstr"
32682 .cindex "address" "constructed"
32683 .cindex "constructed address"
32684 When Exim constructs a sender address for a locally-generated message, it uses
32685 the form
32686 .display
32687 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
32688 .endd
32689 For example:
32690 .code
32691 Zaphod Beeblebrox <zaphod@end.univ.example>
32692 .endd
32693 The user name is obtained from the &%-F%& command line option if set, or
32694 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
32695 &"gecos"& field from the password entry. If the &"gecos"& field contains an
32696 ampersand character, this is replaced by the login name with the first letter
32697 upper cased, as is conventional in a number of operating systems. See the
32698 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
32699 The &%unknown_username%& option can be used to specify user names in cases when
32700 there is no password file entry.
32701
32702 .cindex "RFC 2047"
32703 In all cases, the user name is made to conform to RFC 2822 by quoting all or
32704 parts of it if necessary. In addition, if it contains any non-printing
32705 characters, it is encoded as described in RFC 2047, which defines a way of
32706 including non-ASCII characters in header lines. The value of the
32707 &%headers_charset%& option specifies the name of the encoding that is used (the
32708 characters are assumed to be in this encoding). The setting of
32709 &%print_topbitchars%& controls whether characters with the top bit set (that
32710 is, with codes greater than 127) count as printing characters or not.
32711
32712
32713
32714 .section "Case of local parts" "SECID230"
32715 .cindex "case of local parts"
32716 .cindex "local part" "case of"
32717 RFC 2822 states that the case of letters in the local parts of addresses cannot
32718 be assumed to be non-significant. Exim preserves the case of local parts of
32719 addresses, but by default it uses a lower-cased form when it is routing,
32720 because on most Unix systems, usernames are in lower case and case-insensitive
32721 routing is required. However, any particular router can be made to use the
32722 original case for local parts by setting the &%caseful_local_part%& generic
32723 router option.
32724
32725 .cindex "mixed-case login names"
32726 If you must have mixed-case user names on your system, the best way to proceed,
32727 assuming you want case-independent handling of incoming email, is to set up
32728 your first router to convert incoming local parts in your domains to the
32729 correct case by means of a file lookup. For example:
32730 .code
32731 correct_case:
32732   driver = redirect
32733   domains = +local_domains
32734   data = ${lookup{$local_part}cdb\
32735               {/etc/usercased.cdb}{$value}fail}\
32736               @$domain
32737 .endd
32738 For this router, the local part is forced to lower case by the default action
32739 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
32740 up a new local part in the correct case. If you then set &%caseful_local_part%&
32741 on any subsequent routers which process your domains, they will operate on
32742 local parts with the correct case in a case-sensitive manner.
32743
32744
32745
32746 .section "Dots in local parts" "SECID231"
32747 .cindex "dot" "in local part"
32748 .cindex "local part" "dots in"
32749 RFC 2822 forbids empty components in local parts. That is, an unquoted local
32750 part may not begin or end with a dot, nor have two consecutive dots in the
32751 middle. However, it seems that many MTAs do not enforce this, so Exim permits
32752 empty components for compatibility.
32753
32754
32755
32756 .section "Rewriting addresses" "SECID232"
32757 .cindex "rewriting" "addresses"
32758 Rewriting of sender and recipient addresses, and addresses in headers, can
32759 happen automatically, or as the result of configuration options, as described
32760 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
32761 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
32762
32763 Automatic rewriting includes qualification, as mentioned above. The other case
32764 in which it can happen is when an incomplete non-local domain is given. The
32765 routing process may cause this to be expanded into the full domain name. For
32766 example, a header such as
32767 .code
32768 To: hare@teaparty
32769 .endd
32770 might get rewritten as
32771 .code
32772 To: hare@teaparty.wonderland.fict.example
32773 .endd
32774 Rewriting as a result of routing is the one kind of message processing that
32775 does not happen at input time, as it cannot be done until the address has
32776 been routed.
32777
32778 Strictly, one should not do &'any'& deliveries of a message until all its
32779 addresses have been routed, in case any of the headers get changed as a
32780 result of routing. However, doing this in practice would hold up many
32781 deliveries for unreasonable amounts of time, just because one address could not
32782 immediately be routed. Exim therefore does not delay other deliveries when
32783 routing of one or more addresses is deferred.
32784 .ecindex IIDmesproc
32785
32786
32787
32788 . ////////////////////////////////////////////////////////////////////////////
32789 . ////////////////////////////////////////////////////////////////////////////
32790
32791 .chapter "SMTP processing" "CHAPSMTP"
32792 .scindex IIDsmtpproc1 "SMTP" "processing details"
32793 .scindex IIDsmtpproc2 "LMTP" "processing details"
32794 Exim supports a number of different ways of using the SMTP protocol, and its
32795 LMTP variant, which is an interactive protocol for transferring messages into a
32796 closed mail store application. This chapter contains details of how SMTP is
32797 processed. For incoming mail, the following are available:
32798
32799 .ilist
32800 SMTP over TCP/IP (Exim daemon or &'inetd'&);
32801 .next
32802 SMTP over the standard input and output (the &%-bs%& option);
32803 .next
32804 Batched SMTP on the standard input (the &%-bS%& option).
32805 .endlist
32806
32807 For mail delivery, the following are available:
32808
32809 .ilist
32810 SMTP over TCP/IP (the &(smtp)& transport);
32811 .next
32812 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
32813 &"lmtp"&);
32814 .next
32815 LMTP over a pipe to a process running in the local host (the &(lmtp)&
32816 transport);
32817 .next
32818 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
32819 the &%use_bsmtp%& option set).
32820 .endlist
32821
32822 &'Batched SMTP'& is the name for a process in which batches of messages are
32823 stored in or read from files (or pipes), in a format in which SMTP commands are
32824 used to contain the envelope information.
32825
32826
32827
32828 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
32829 .cindex "SMTP" "outgoing over TCP/IP"
32830 .cindex "outgoing SMTP over TCP/IP"
32831 .cindex "LMTP" "over TCP/IP"
32832 .cindex "outgoing LMTP over TCP/IP"
32833 .cindex "EHLO"
32834 .cindex "HELO"
32835 .cindex "SIZE option on MAIL command"
32836 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
32837 The &%protocol%& option selects which protocol is to be used, but the actual
32838 processing is the same in both cases.
32839
32840 If, in response to its EHLO command, Exim is told that the SIZE
32841 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
32842 command. The value of <&'n'&> is the message size plus the value of the
32843 &%size_addition%& option (default 1024) to allow for additions to the message
32844 such as per-transport header lines, or changes made in a
32845 .cindex "transport" "filter"
32846 .cindex "filter" "transport filter"
32847 transport filter. If &%size_addition%& is set negative, the use of SIZE is
32848 suppressed.
32849
32850 If the remote server advertises support for PIPELINING, Exim uses the
32851 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
32852 required for the transaction.
32853
32854 If the remote server advertises support for the STARTTLS command, and Exim
32855 was built to support TLS encryption, it tries to start a TLS session unless the
32856 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
32857 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
32858 is called for verification.
32859
32860 If the remote server advertises support for the AUTH command, Exim scans
32861 the authenticators configuration for any suitable client settings, as described
32862 in chapter &<<CHAPSMTPAUTH>>&.
32863
32864 .cindex "carriage return"
32865 .cindex "linefeed"
32866 Responses from the remote host are supposed to be terminated by CR followed by
32867 LF. However, there are known to be hosts that do not send CR characters, so in
32868 order to be able to interwork with such hosts, Exim treats LF on its own as a
32869 line terminator.
32870
32871 If a message contains a number of different addresses, all those with the same
32872 characteristics (for example, the same envelope sender) that resolve to the
32873 same set of hosts, in the same order, are sent in a single SMTP transaction,
32874 even if they are for different domains, unless there are more than the setting
32875 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
32876 they are split into groups containing no more than &%max_rcpt%&s addresses
32877 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
32878 in parallel sessions. The order of hosts with identical MX values is not
32879 significant when checking whether addresses can be batched in this way.
32880
32881 When the &(smtp)& transport suffers a temporary failure that is not
32882 message-related, Exim updates its transport-specific database, which contains
32883 records indexed by host name that remember which messages are waiting for each
32884 particular host. It also updates the retry database with new retry times.
32885
32886 .cindex "hints database" "retry keys"
32887 Exim's retry hints are based on host name plus IP address, so if one address of
32888 a multi-homed host is broken, it will soon be skipped most of the time.
32889 See the next section for more detail about error handling.
32890
32891 .cindex "SMTP" "passed connection"
32892 .cindex "SMTP" "batching over TCP/IP"
32893 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
32894 looks in the hints database for the transport to see if there are any queued
32895 messages waiting for the host to which it is connected. If it finds one, it
32896 creates a new Exim process using the &%-MC%& option (which can only be used by
32897 a process running as root or the Exim user) and passes the TCP/IP socket to it
32898 so that it can deliver another message using the same socket. The new process
32899 does only those deliveries that are routed to the connected host, and may in
32900 turn pass the socket on to a third process, and so on.
32901
32902 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
32903 limit the number of messages sent down a single TCP/IP connection.
32904
32905 .cindex "asterisk" "after IP address"
32906 The second and subsequent messages delivered down an existing connection are
32907 identified in the main log by the addition of an asterisk after the closing
32908 square bracket of the IP address.
32909
32910
32911
32912
32913 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
32914 .cindex "error" "in outgoing SMTP"
32915 .cindex "SMTP" "errors in outgoing"
32916 .cindex "host" "error"
32917 Three different kinds of error are recognized for outgoing SMTP: host errors,
32918 message errors, and recipient errors.
32919
32920 .vlist
32921 .vitem "&*Host errors*&"
32922 A host error is not associated with a particular message or with a
32923 particular recipient of a message. The host errors are:
32924
32925 .ilist
32926 Connection refused or timed out,
32927 .next
32928 Any error response code on connection,
32929 .next
32930 Any error response code to EHLO or HELO,
32931 .next
32932 Loss of connection at any time, except after &"."&,
32933 .next
32934 I/O errors at any time,
32935 .next
32936 Timeouts during the session, other than in response to MAIL, RCPT or
32937 the &"."& at the end of the data.
32938 .endlist ilist
32939
32940 For a host error, a permanent error response on connection, or in response to
32941 EHLO, causes all addresses routed to the host to be failed. Any other host
32942 error causes all addresses to be deferred, and retry data to be created for the
32943 host. It is not tried again, for any message, until its retry time arrives. If
32944 the current set of addresses are not all delivered in this run (to some
32945 alternative host), the message is added to the list of those waiting for this
32946 host, so if it is still undelivered when a subsequent successful delivery is
32947 made to the host, it will be sent down the same SMTP connection.
32948
32949 .vitem "&*Message errors*&"
32950 .cindex "message" "error"
32951 A message error is associated with a particular message when sent to a
32952 particular host, but not with a particular recipient of the message. The
32953 message errors are:
32954
32955 .ilist
32956 Any error response code to MAIL, DATA, or the &"."& that terminates
32957 the data,
32958 .next
32959 Timeout after MAIL,
32960 .next
32961 Timeout or loss of connection after the &"."& that terminates the data. A
32962 timeout after the DATA command itself is treated as a host error, as is loss of
32963 connection at any other time.
32964 .endlist ilist
32965
32966 For a message error, a permanent error response (5&'xx'&) causes all addresses
32967 to be failed, and a delivery error report to be returned to the sender. A
32968 temporary error response (4&'xx'&), or one of the timeouts, causes all
32969 addresses to be deferred. Retry data is not created for the host, but instead,
32970 a retry record for the combination of host plus message id is created. The
32971 message is not added to the list of those waiting for this host. This ensures
32972 that the failing message will not be sent to this host again until the retry
32973 time arrives. However, other messages that are routed to the host are not
32974 affected, so if it is some property of the message that is causing the error,
32975 it will not stop the delivery of other mail.
32976
32977 If the remote host specified support for the SIZE parameter in its response
32978 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
32979 over-large message will cause a message error because the error arrives as a
32980 response to MAIL.
32981
32982 .vitem "&*Recipient errors*&"
32983 .cindex "recipient" "error"
32984 A recipient error is associated with a particular recipient of a message. The
32985 recipient errors are:
32986
32987 .ilist
32988 Any error response to RCPT,
32989 .next
32990 Timeout after RCPT.
32991 .endlist
32992
32993 For a recipient error, a permanent error response (5&'xx'&) causes the
32994 recipient address to be failed, and a bounce message to be returned to the
32995 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
32996 address to be deferred, and routing retry data to be created for it. This is
32997 used to delay processing of the address in subsequent queue runs, until its
32998 routing retry time arrives. This applies to all messages, but because it
32999 operates only in queue runs, one attempt will be made to deliver a new message
33000 to the failing address before the delay starts to operate. This ensures that,
33001 if the failure is really related to the message rather than the recipient
33002 (&"message too big for this recipient"& is a possible example), other messages
33003 have a chance of getting delivered. If a delivery to the address does succeed,
33004 the retry information gets cleared, so all stuck messages get tried again, and
33005 the retry clock is reset.
33006
33007 The message is not added to the list of those waiting for this host. Use of the
33008 host for other messages is unaffected, and except in the case of a timeout,
33009 other recipients are processed independently, and may be successfully delivered
33010 in the current SMTP session. After a timeout it is of course impossible to
33011 proceed with the session, so all addresses get deferred. However, those other
33012 than the one that failed do not suffer any subsequent retry delays. Therefore,
33013 if one recipient is causing trouble, the others have a chance of getting
33014 through when a subsequent delivery attempt occurs before the failing
33015 recipient's retry time.
33016 .endlist
33017
33018 In all cases, if there are other hosts (or IP addresses) available for the
33019 current set of addresses (for example, from multiple MX records), they are
33020 tried in this run for any undelivered addresses, subject of course to their
33021 own retry data. In other words, recipient error retry data does not take effect
33022 until the next delivery attempt.
33023
33024 Some hosts have been observed to give temporary error responses to every
33025 MAIL command at certain times (&"insufficient space"& has been seen). It
33026 would be nice if such circumstances could be recognized, and defer data for the
33027 host itself created, but this is not possible within the current Exim design.
33028 What actually happens is that retry data for every (host, message) combination
33029 is created.
33030
33031 The reason that timeouts after MAIL and RCPT are treated specially is that
33032 these can sometimes arise as a result of the remote host's verification
33033 procedures. Exim makes this assumption, and treats them as if a temporary error
33034 response had been received. A timeout after &"."& is treated specially because
33035 it is known that some broken implementations fail to recognize the end of the
33036 message if the last character of the last line is a binary zero. Thus, it is
33037 helpful to treat this case as a message error.
33038
33039 Timeouts at other times are treated as host errors, assuming a problem with the
33040 host, or the connection to it. If a timeout after MAIL, RCPT,
33041 or &"."& is really a connection problem, the assumption is that at the next try
33042 the timeout is likely to occur at some other point in the dialogue, causing it
33043 then to be treated as a host error.
33044
33045 There is experimental evidence that some MTAs drop the connection after the
33046 terminating &"."& if they do not like the contents of the message for some
33047 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
33048 should be given. That is why Exim treats this case as a message rather than a
33049 host error, in order not to delay other messages to the same host.
33050
33051
33052
33053
33054 .section "Incoming SMTP messages over TCP/IP" "SECID233"
33055 .cindex "SMTP" "incoming over TCP/IP"
33056 .cindex "incoming SMTP over TCP/IP"
33057 .cindex "inetd"
33058 .cindex "daemon"
33059 Incoming SMTP messages can be accepted in one of two ways: by running a
33060 listening daemon, or by using &'inetd'&. In the latter case, the entry in
33061 &_/etc/inetd.conf_& should be like this:
33062 .code
33063 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
33064 .endd
33065 Exim distinguishes between this case and the case of a locally running user
33066 agent using the &%-bs%& option by checking whether or not the standard input is
33067 a socket. When it is, either the port must be privileged (less than 1024), or
33068 the caller must be root or the Exim user. If any other user passes a socket
33069 with an unprivileged port number, Exim prints a message on the standard error
33070 stream and exits with an error code.
33071
33072 By default, Exim does not make a log entry when a remote host connects or
33073 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
33074 unexpected. It can be made to write such log entries by setting the
33075 &%smtp_connection%& log selector.
33076
33077 .cindex "carriage return"
33078 .cindex "linefeed"
33079 Commands from the remote host are supposed to be terminated by CR followed by
33080 LF. However, there are known to be hosts that do not send CR characters. In
33081 order to be able to interwork with such hosts, Exim treats LF on its own as a
33082 line terminator.
33083 Furthermore, because common code is used for receiving messages from all
33084 sources, a CR on its own is also interpreted as a line terminator. However, the
33085 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
33086
33087 .cindex "EHLO" "invalid data"
33088 .cindex "HELO" "invalid data"
33089 One area that sometimes gives rise to problems concerns the EHLO or
33090 HELO commands. Some clients send syntactically invalid versions of these
33091 commands, which Exim rejects by default. (This is nothing to do with verifying
33092 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
33093 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
33094 match the broken hosts that send invalid commands.
33095
33096 .cindex "SIZE option on MAIL command"
33097 .cindex "MAIL" "SIZE option"
33098 The amount of disk space available is checked whenever SIZE is received on
33099 a MAIL command, independently of whether &%message_size_limit%& or
33100 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
33101 false. A temporary error is given if there is not enough space. If
33102 &%check_spool_space%& is set, the check is for that amount of space plus the
33103 value given with SIZE, that is, it checks that the addition of the incoming
33104 message will not reduce the space below the threshold.
33105
33106 When a message is successfully received, Exim includes the local message id in
33107 its response to the final &"."& that terminates the data. If the remote host
33108 logs this text it can help with tracing what has happened to a message.
33109
33110 The Exim daemon can limit the number of simultaneous incoming connections it is
33111 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
33112 number of simultaneous incoming connections from a single remote host (see the
33113 &%smtp_accept_max_per_host%& option). Additional connection attempts are
33114 rejected using the SMTP temporary error code 421.
33115
33116 The Exim daemon does not rely on the SIGCHLD signal to detect when a
33117 subprocess has finished, as this can get lost at busy times. Instead, it looks
33118 for completed subprocesses every time it wakes up. Provided there are other
33119 things happening (new incoming calls, starts of queue runs), completed
33120 processes will be noticed and tidied away. On very quiet systems you may
33121 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
33122 it will be noticed when the daemon next wakes up.
33123
33124 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
33125 and can also be set up to reject SMTP calls from non-reserved hosts at times of
33126 high system load &-- for details see the &%smtp_accept_reserve%&,
33127 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
33128 applies in both the daemon and &'inetd'& cases.
33129
33130 Exim normally starts a delivery process for each message received, though this
33131 can be varied by means of the &%-odq%& command line option and the
33132 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
33133 number of simultaneously running delivery processes started in this way from
33134 SMTP input can be limited by the &%smtp_accept_queue%& and
33135 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
33136 subsequently received messages are just put on the input queue without starting
33137 a delivery process.
33138
33139 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
33140 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
33141 started up from the &'inetd'& daemon, because in that case each connection is
33142 handled by an entirely independent Exim process. Control by load average is,
33143 however, available with &'inetd'&.
33144
33145 Exim can be configured to verify addresses in incoming SMTP commands as they
33146 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
33147 to rewrite addresses at this time &-- before any syntax checking is done. See
33148 section &<<SECTrewriteS>>&.
33149
33150 Exim can also be configured to limit the rate at which a client host submits
33151 MAIL and RCPT commands in a single SMTP session. See the
33152 &%smtp_ratelimit_hosts%& option.
33153
33154
33155
33156 .section "Unrecognized SMTP commands" "SECID234"
33157 .cindex "SMTP" "unrecognized commands"
33158 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
33159 commands during a single SMTP connection, it drops the connection after sending
33160 the error response to the last command. The default value for
33161 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
33162 abuse that subvert web servers into making connections to SMTP ports; in these
33163 circumstances, a number of non-SMTP lines are sent first.
33164
33165
33166 .section "Syntax and protocol errors in SMTP commands" "SECID235"
33167 .cindex "SMTP" "syntax errors"
33168 .cindex "SMTP" "protocol errors"
33169 A syntax error is detected if an SMTP command is recognized, but there is
33170 something syntactically wrong with its data, for example, a malformed email
33171 address in a RCPT command. Protocol errors include invalid command
33172 sequencing such as RCPT before MAIL. If Exim receives more than
33173 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
33174 drops the connection after sending the error response to the last command. The
33175 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
33176 broken clients that loop sending bad commands (yes, it has been seen).
33177
33178
33179
33180 .section "Use of non-mail SMTP commands" "SECID236"
33181 .cindex "SMTP" "non-mail commands"
33182 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
33183 DATA. Exim counts such commands, and drops the connection if there are too
33184 many of them in a single SMTP session. This action catches some
33185 denial-of-service attempts and things like repeated failing AUTHs, or a mad
33186 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
33187 defines what &"too many"& means. Its default value is 10.
33188
33189 When a new message is expected, one occurrence of RSET is not counted. This
33190 allows a client to send one RSET between messages (this is not necessary,
33191 but some clients do it). Exim also allows one uncounted occurrence of HELO
33192 or EHLO, and one occurrence of STARTTLS between messages. After
33193 starting up a TLS session, another EHLO is expected, and so it too is not
33194 counted.
33195
33196 The first occurrence of AUTH in a connection, or immediately following
33197 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
33198 RCPT, DATA, and QUIT are counted.
33199
33200 You can control which hosts are subject to the limit set by
33201 &%smtp_accept_max_nonmail%& by setting
33202 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
33203 the limit apply to all hosts. This option means that you can exclude any
33204 specific badly-behaved hosts that you have to live with.
33205
33206
33207
33208
33209 .section "The VRFY and EXPN commands" "SECID237"
33210 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
33211 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
33212 appropriate) in order to decide whether the command should be accepted or not.
33213 If no ACL is defined, the command is rejected.
33214
33215 .cindex "VRFY" "processing"
33216 When VRFY is accepted, it runs exactly the same code as when Exim is
33217 called with the &%-bv%& option.
33218
33219 .cindex "EXPN" "processing"
33220 When EXPN is accepted, a single-level expansion of the address is done.
33221 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
33222 than a verification (the &%-bv%& option). If an unqualified local part is given
33223 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
33224 of VRFY and EXPN commands are logged on the main and reject logs, and
33225 VRFY verification failures are logged on the main log for consistency with
33226 RCPT failures.
33227
33228
33229
33230 .section "The ETRN command" "SECTETRN"
33231 .cindex "ETRN" "processing"
33232 RFC 1985 describes an SMTP command called ETRN that is designed to
33233 overcome the security problems of the TURN command (which has fallen into
33234 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
33235 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
33236 should be accepted or not. If no ACL is defined, the command is rejected.
33237
33238 The ETRN command is concerned with &"releasing"& messages that are awaiting
33239 delivery to certain hosts. As Exim does not organize its message queue by host,
33240 the only form of ETRN that is supported by default is the one where the
33241 text starts with the &"#"& prefix, in which case the remainder of the text is
33242 specific to the SMTP server. A valid ETRN command causes a run of Exim with
33243 the &%-R%& option to happen, with the remainder of the ETRN text as its
33244 argument. For example,
33245 .code
33246 ETRN #brigadoon
33247 .endd
33248 runs the command
33249 .code
33250 exim -R brigadoon
33251 .endd
33252 which causes a delivery attempt on all messages with undelivered addresses
33253 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
33254 default), Exim prevents the simultaneous execution of more than one queue run
33255 for the same argument string as a result of an ETRN command. This stops
33256 a misbehaving client from starting more than one queue runner at once.
33257
33258 .cindex "hints database" "ETRN serialization"
33259 Exim implements the serialization by means of a hints database in which a
33260 record is written whenever a process is started by ETRN, and deleted when
33261 the process completes. However, Exim does not keep the SMTP session waiting for
33262 the ETRN process to complete. Once ETRN is accepted, the client is sent
33263 a &"success"& return code. Obviously there is scope for hints records to get
33264 left lying around if there is a system or program crash. To guard against this,
33265 Exim ignores any records that are more than six hours old.
33266
33267 .oindex "&%smtp_etrn_command%&"
33268 For more control over what ETRN does, the &%smtp_etrn_command%& option can
33269 used. This specifies a command that is run whenever ETRN is received,
33270 whatever the form of its argument. For
33271 example:
33272 .code
33273 smtp_etrn_command = /etc/etrn_command $domain \
33274                     $sender_host_address
33275 .endd
33276 .vindex "&$domain$&"
33277 The string is split up into arguments which are independently expanded. The
33278 expansion variable &$domain$& is set to the argument of the ETRN command,
33279 and no syntax checking is done on the contents of this argument. Exim does not
33280 wait for the command to complete, so its status code is not checked. Exim runs
33281 under its own uid and gid when receiving incoming SMTP, so it is not possible
33282 for it to change them before running the command.
33283
33284
33285
33286 .section "Incoming local SMTP" "SECID238"
33287 .cindex "SMTP" "local incoming"
33288 Some user agents use SMTP to pass messages to their local MTA using the
33289 standard input and output, as opposed to passing the envelope on the command
33290 line and writing the message to the standard input. This is supported by the
33291 &%-bs%& option. This form of SMTP is handled in the same way as incoming
33292 messages over TCP/IP (including the use of ACLs), except that the envelope
33293 sender given in a MAIL command is ignored unless the caller is trusted. In
33294 an ACL you can detect this form of SMTP input by testing for an empty host
33295 identification. It is common to have this as the first line in the ACL that
33296 runs for RCPT commands:
33297 .code
33298 accept hosts = :
33299 .endd
33300 This accepts SMTP messages from local processes without doing any other tests.
33301
33302
33303
33304 .section "Outgoing batched SMTP" "SECTbatchSMTP"
33305 .cindex "SMTP" "batched outgoing"
33306 .cindex "batched SMTP output"
33307 Both the &(appendfile)& and &(pipe)& transports can be used for handling
33308 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
33309 be output in BSMTP format. No SMTP responses are possible for this form of
33310 delivery. All it is doing is using SMTP commands as a way of transmitting the
33311 envelope along with the message.
33312
33313 The message is written to the file or pipe preceded by the SMTP commands
33314 MAIL and RCPT, and followed by a line containing a single dot. Lines in
33315 the message that start with a dot have an extra dot added. The SMTP command
33316 HELO is not normally used. If it is required, the &%message_prefix%& option
33317 can be used to specify it.
33318
33319 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
33320 one recipient address at a time by default. However, you can arrange for them
33321 to handle several addresses at once by setting the &%batch_max%& option. When
33322 this is done for BSMTP, messages may contain multiple RCPT commands. See
33323 chapter &<<CHAPbatching>>& for more details.
33324
33325 .vindex "&$host$&"
33326 When one or more addresses are routed to a BSMTP transport by a router that
33327 sets up a host list, the name of the first host on the list is available to the
33328 transport in the variable &$host$&. Here is an example of such a transport and
33329 router:
33330 .code
33331 begin routers
33332 route_append:
33333   driver = manualroute
33334   transport = smtp_appendfile
33335   route_list = domain.example  batch.host.example
33336
33337 begin transports
33338 smtp_appendfile:
33339   driver = appendfile
33340   directory = /var/bsmtp/$host
33341   batch_max = 1000
33342   use_bsmtp
33343   user = exim
33344 .endd
33345 This causes messages addressed to &'domain.example'& to be written in BSMTP
33346 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
33347 message (unless there are more than 1000 recipients).
33348
33349
33350
33351 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
33352 .cindex "SMTP" "batched incoming"
33353 .cindex "batched SMTP input"
33354 The &%-bS%& command line option causes Exim to accept one or more messages by
33355 reading SMTP on the standard input, but to generate no responses. If the caller
33356 is trusted, the senders in the MAIL commands are believed; otherwise the
33357 sender is always the caller of Exim. Unqualified senders and receivers are not
33358 rejected (there seems little point) but instead just get qualified. HELO
33359 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
33360 as NOOP; QUIT quits.
33361
33362 Minimal policy checking is done for BSMTP input. Only the non-SMTP
33363 ACL is run in the same way as for non-SMTP local input.
33364
33365 If an error is detected while reading a message, including a missing &"."& at
33366 the end, Exim gives up immediately. It writes details of the error to the
33367 standard output in a stylized way that the calling program should be able to
33368 make some use of automatically, for example:
33369 .code
33370 554 Unexpected end of file
33371 Transaction started in line 10
33372 Error detected in line 14
33373 .endd
33374 It writes a more verbose version, for human consumption, to the standard error
33375 file, for example:
33376 .code
33377 An error was detected while processing a file of BSMTP input.
33378 The error message was:
33379
33380 501 '>' missing at end of address
33381
33382 The SMTP transaction started in line 10.
33383 The error was detected in line 12.
33384 The SMTP command at fault was:
33385
33386 rcpt to:<malformed@in.com.plete
33387
33388 1 previous message was successfully processed.
33389 The rest of the batch was abandoned.
33390 .endd
33391 The return code from Exim is zero only if there were no errors. It is 1 if some
33392 messages were accepted before an error was detected, and 2 if no messages were
33393 accepted.
33394 .ecindex IIDsmtpproc1
33395 .ecindex IIDsmtpproc2
33396
33397
33398
33399 . ////////////////////////////////////////////////////////////////////////////
33400 . ////////////////////////////////////////////////////////////////////////////
33401
33402 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
33403          "Customizing messages"
33404 When a message fails to be delivered, or remains on the queue for more than a
33405 configured amount of time, Exim sends a message to the original sender, or
33406 to an alternative configured address. The text of these messages is built into
33407 the code of Exim, but it is possible to change it, either by adding a single
33408 string, or by replacing each of the paragraphs by text supplied in a file.
33409
33410 The &'From:'& and &'To:'& header lines are automatically generated; you can
33411 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
33412 option. Exim also adds the line
33413 .code
33414 Auto-Submitted: auto-generated
33415 .endd
33416 to all warning and bounce messages,
33417
33418
33419 .section "Customizing bounce messages" "SECID239"
33420 .cindex "customizing" "bounce message"
33421 .cindex "bounce message" "customizing"
33422 If &%bounce_message_text%& is set, its contents are included in the default
33423 message immediately after &"This message was created automatically by mail
33424 delivery software."& The string is not expanded. It is not used if
33425 &%bounce_message_file%& is set.
33426
33427 When &%bounce_message_file%& is set, it must point to a template file for
33428 constructing error messages. The file consists of a series of text items,
33429 separated by lines consisting of exactly four asterisks. If the file cannot be
33430 opened, default text is used and a message is written to the main and panic
33431 logs. If any text item in the file is empty, default text is used for that
33432 item.
33433
33434 .vindex "&$bounce_recipient$&"
33435 .vindex "&$bounce_return_size_limit$&"
33436 Each item of text that is read from the file is expanded, and there are two
33437 expansion variables which can be of use here: &$bounce_recipient$& is set to
33438 the recipient of an error message while it is being created, and
33439 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
33440 option, rounded to a whole number.
33441
33442 The items must appear in the file in the following order:
33443
33444 .ilist
33445 The first item is included in the headers, and should include at least a
33446 &'Subject:'& header. Exim does not check the syntax of these headers.
33447 .next
33448 The second item forms the start of the error message. After it, Exim lists the
33449 failing addresses with their error messages.
33450 .next
33451 The third item is used to introduce any text from pipe transports that is to be
33452 returned to the sender. It is omitted if there is no such text.
33453 .next
33454 The fourth item is used to introduce the copy of the message that is returned
33455 as part of the error report.
33456 .next
33457 The fifth item is added after the fourth one if the returned message is
33458 truncated because it is bigger than &%return_size_limit%&.
33459 .next
33460 The sixth item is added after the copy of the original message.
33461 .endlist
33462
33463 The default state (&%bounce_message_file%& unset) is equivalent to the
33464 following file, in which the sixth item is empty. The &'Subject:'& and some
33465 other lines have been split in order to fit them on the page:
33466 .code
33467 Subject: Mail delivery failed
33468   ${if eq{$sender_address}{$bounce_recipient}
33469   {: returning message to sender}}
33470 ****
33471 This message was created automatically by mail delivery software.
33472
33473 A message ${if eq{$sender_address}{$bounce_recipient}
33474   {that you sent }{sent by
33475
33476 <$sender_address>
33477
33478 }}could not be delivered to all of its recipients.
33479 This is a permanent error. The following address(es) failed:
33480 ****
33481 The following text was generated during the delivery attempt(s):
33482 ****
33483 ------ This is a copy of the message, including all the headers.
33484   ------
33485 ****
33486 ------ The body of the message is $message_size characters long;
33487   only the first
33488 ------ $bounce_return_size_limit or so are included here.
33489 ****
33490 .endd
33491 .section "Customizing warning messages" "SECTcustwarn"
33492 .cindex "customizing" "warning message"
33493 .cindex "warning of delay" "customizing the message"
33494 The option &%warn_message_file%& can be pointed at a template file for use when
33495 warnings about message delays are created. In this case there are only three
33496 text sections:
33497
33498 .ilist
33499 The first item is included in the headers, and should include at least a
33500 &'Subject:'& header. Exim does not check the syntax of these headers.
33501 .next
33502 The second item forms the start of the warning message. After it, Exim lists
33503 the delayed addresses.
33504 .next
33505 The third item then ends the message.
33506 .endlist
33507
33508 The default state is equivalent to the following file, except that some lines
33509 have been split here, in order to fit them on the page:
33510 .code
33511 Subject: Warning: message $message_exim_id delayed
33512   $warn_message_delay
33513 ****
33514 This message was created automatically by mail delivery software.
33515
33516 A message ${if eq{$sender_address}{$warn_message_recipients}
33517 {that you sent }{sent by
33518
33519 <$sender_address>
33520
33521 }}has not been delivered to all of its recipients after
33522 more than $warn_message_delay on the queue on $primary_hostname.
33523
33524 The message identifier is:     $message_exim_id
33525 The subject of the message is: $h_subject
33526 The date of the message is:    $h_date
33527
33528 The following address(es) have not yet been delivered:
33529 ****
33530 No action is required on your part. Delivery attempts will
33531 continue for some time, and this warning may be repeated at
33532 intervals if the message remains undelivered. Eventually the
33533 mail delivery software will give up, and when that happens,
33534 the message will be returned to you.
33535 .endd
33536 .vindex "&$warn_message_delay$&"
33537 .vindex "&$warn_message_recipients$&"
33538 However, in the default state the subject and date lines are omitted if no
33539 appropriate headers exist. During the expansion of this file,
33540 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
33541 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
33542 of recipients for the warning message. There may be more than one if there are
33543 multiple addresses with different &%errors_to%& settings on the routers that
33544 handled them.
33545
33546
33547
33548
33549 . ////////////////////////////////////////////////////////////////////////////
33550 . ////////////////////////////////////////////////////////////////////////////
33551
33552 .chapter "Some common configuration settings" "CHAPcomconreq"
33553 This chapter discusses some configuration settings that seem to be fairly
33554 common. More examples and discussion can be found in the Exim book.
33555
33556
33557
33558 .section "Sending mail to a smart host" "SECID240"
33559 .cindex "smart host" "example router"
33560 If you want to send all mail for non-local domains to a &"smart host"&, you
33561 should replace the default &(dnslookup)& router with a router which does the
33562 routing explicitly:
33563 .code
33564 send_to_smart_host:
33565   driver = manualroute
33566   route_list = !+local_domains smart.host.name
33567   transport = remote_smtp
33568 .endd
33569 You can use the smart host's IP address instead of the name if you wish.
33570 If you are using Exim only to submit messages to a smart host, and not for
33571 receiving incoming messages, you can arrange for it to do the submission
33572 synchronously by setting the &%mua_wrapper%& option (see chapter
33573 &<<CHAPnonqueueing>>&).
33574
33575
33576
33577
33578 .section "Using Exim to handle mailing lists" "SECTmailinglists"
33579 .cindex "mailing lists"
33580 Exim can be used to run simple mailing lists, but for large and/or complicated
33581 requirements, the use of additional specialized mailing list software such as
33582 Majordomo or Mailman is recommended.
33583
33584 The &(redirect)& router can be used to handle mailing lists where each list
33585 is maintained in a separate file, which can therefore be managed by an
33586 independent manager. The &%domains%& router option can be used to run these
33587 lists in a separate domain from normal mail. For example:
33588 .code
33589 lists:
33590   driver = redirect
33591   domains = lists.example
33592   file = /usr/lists/$local_part
33593   forbid_pipe
33594   forbid_file
33595   errors_to = $local_part-request@lists.example
33596   no_more
33597 .endd
33598 This router is skipped for domains other than &'lists.example'&. For addresses
33599 in that domain, it looks for a file that matches the local part. If there is no
33600 such file, the router declines, but because &%no_more%& is set, no subsequent
33601 routers are tried, and so the whole delivery fails.
33602
33603 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
33604 expanded into a file name or a pipe delivery, which is usually inappropriate in
33605 a mailing list.
33606
33607 .oindex "&%errors_to%&"
33608 The &%errors_to%& option specifies that any delivery errors caused by addresses
33609 taken from a mailing list are to be sent to the given address rather than the
33610 original sender of the message. However, before acting on this, Exim verifies
33611 the error address, and ignores it if verification fails.
33612
33613 For example, using the configuration above, mail sent to
33614 &'dicts@lists.example'& is passed on to those addresses contained in
33615 &_/usr/lists/dicts_&, with error reports directed to
33616 &'dicts-request@lists.example'&, provided that this address can be verified.
33617 There could be a file called &_/usr/lists/dicts-request_& containing
33618 the address(es) of this particular list's manager(s), but other approaches,
33619 such as setting up an earlier router (possibly using the &%local_part_prefix%&
33620 or &%local_part_suffix%& options) to handle addresses of the form
33621 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
33622
33623
33624
33625 .section "Syntax errors in mailing lists" "SECID241"
33626 .cindex "mailing lists" "syntax errors in"
33627 If an entry in redirection data contains a syntax error, Exim normally defers
33628 delivery of the original address. That means that a syntax error in a mailing
33629 list holds up all deliveries to the list. This may not be appropriate when a
33630 list is being maintained automatically from data supplied by users, and the
33631 addresses are not rigorously checked.
33632
33633 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
33634 entries that fail to parse, noting the incident in the log. If in addition
33635 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
33636 whenever a broken address is skipped. It is usually appropriate to set
33637 &%syntax_errors_to%& to the same address as &%errors_to%&.
33638
33639
33640
33641 .section "Re-expansion of mailing lists" "SECID242"
33642 .cindex "mailing lists" "re-expansion of"
33643 Exim remembers every individual address to which a message has been delivered,
33644 in order to avoid duplication, but it normally stores only the original
33645 recipient addresses with a message. If all the deliveries to a mailing list
33646 cannot be done at the first attempt, the mailing list is re-expanded when the
33647 delivery is next tried. This means that alterations to the list are taken into
33648 account at each delivery attempt, so addresses that have been added to
33649 the list since the message arrived will therefore receive a copy of the
33650 message, even though it pre-dates their subscription.
33651
33652 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
33653 on the &(redirect)& router. If this is done, any addresses generated by the
33654 router that fail to deliver at the first attempt are added to the message as
33655 &"top level"& addresses, and the parent address that generated them is marked
33656 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
33657 subsequent delivery attempts. The disadvantage of this is that if any of the
33658 failing addresses are incorrect, correcting them in the file has no effect on
33659 pre-existing messages.
33660
33661 The original top-level address is remembered with each of the generated
33662 addresses, and is output in any log messages. However, any intermediate parent
33663 addresses are not recorded. This makes a difference to the log only if the
33664 &%all_parents%& selector is set, but for mailing lists there is normally only
33665 one level of expansion anyway.
33666
33667
33668
33669 .section "Closed mailing lists" "SECID243"
33670 .cindex "mailing lists" "closed"
33671 The examples so far have assumed open mailing lists, to which anybody may
33672 send mail. It is also possible to set up closed lists, where mail is accepted
33673 from specified senders only. This is done by making use of the generic
33674 &%senders%& option to restrict the router that handles the list.
33675
33676 The following example uses the same file as a list of recipients and as a list
33677 of permitted senders. It requires three routers:
33678 .code
33679 lists_request:
33680   driver = redirect
33681   domains = lists.example
33682   local_part_suffix = -request
33683   file = /usr/lists/$local_part$local_part_suffix
33684   no_more
33685
33686 lists_post:
33687   driver = redirect
33688   domains = lists.example
33689   senders = ${if exists {/usr/lists/$local_part}\
33690              {lsearch;/usr/lists/$local_part}{*}}
33691   file = /usr/lists/$local_part
33692   forbid_pipe
33693   forbid_file
33694   errors_to = $local_part-request@lists.example
33695   no_more
33696
33697 lists_closed:
33698   driver = redirect
33699   domains = lists.example
33700   allow_fail
33701   data = :fail: $local_part@lists.example is a closed mailing list
33702 .endd
33703 All three routers have the same &%domains%& setting, so for any other domains,
33704 they are all skipped. The first router runs only if the local part ends in
33705 &%-request%&. It handles messages to the list manager(s) by means of an open
33706 mailing list.
33707
33708 The second router runs only if the &%senders%& precondition is satisfied. It
33709 checks for the existence of a list that corresponds to the local part, and then
33710 checks that the sender is on the list by means of a linear search. It is
33711 necessary to check for the existence of the file before trying to search it,
33712 because otherwise Exim thinks there is a configuration error. If the file does
33713 not exist, the expansion of &%senders%& is *, which matches all senders. This
33714 means that the router runs, but because there is no list, declines, and
33715 &%no_more%& ensures that no further routers are run. The address fails with an
33716 &"unrouteable address"& error.
33717
33718 The third router runs only if the second router is skipped, which happens when
33719 a mailing list exists, but the sender is not on it. This router forcibly fails
33720 the address, giving a suitable error message.
33721
33722
33723
33724
33725 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
33726 .cindex "VERP"
33727 .cindex "Variable Envelope Return Paths"
33728 .cindex "envelope sender"
33729 Variable Envelope Return Paths &-- see &url(http://cr.yp.to/proto/verp.txt) &--
33730 are a way of helping mailing list administrators discover which subscription
33731 address is the cause of a particular delivery failure. The idea is to encode
33732 the original recipient address in the outgoing envelope sender address, so that
33733 if the message is forwarded by another host and then subsequently bounces, the
33734 original recipient can be extracted from the recipient address of the bounce.
33735
33736 .oindex &%errors_to%&
33737 .oindex &%return_path%&
33738 Envelope sender addresses can be modified by Exim using two different
33739 facilities: the &%errors_to%& option on a router (as shown in previous mailing
33740 list examples), or the &%return_path%& option on a transport. The second of
33741 these is effective only if the message is successfully delivered to another
33742 host; it is not used for errors detected on the local host (see the description
33743 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
33744 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
33745 .code
33746 verp_smtp:
33747   driver = smtp
33748   max_rcpt = 1
33749   return_path = \
33750     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
33751       {$1-request+$local_part=$domain@your.dom.example}fail}
33752 .endd
33753 This has the effect of rewriting the return path (envelope sender) on outgoing
33754 SMTP messages, if the local part of the original return path ends in
33755 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
33756 local part and domain of the recipient into the return path. Suppose, for
33757 example, that a message whose return path has been set to
33758 &'somelist-request@your.dom.example'& is sent to
33759 &'subscriber@other.dom.example'&. In the transport, the return path is
33760 rewritten as
33761 .code
33762 somelist-request+subscriber=other.dom.example@your.dom.example
33763 .endd
33764 .vindex "&$local_part$&"
33765 For this to work, you must tell Exim to send multiple copies of messages that
33766 have more than one recipient, so that each copy has just one recipient. This is
33767 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
33768 might be sent to several different recipients in the same domain, in which case
33769 &$local_part$& is not available in the transport, because it is not unique.
33770
33771 Unless your host is doing nothing but mailing list deliveries, you should
33772 probably use a separate transport for the VERP deliveries, so as not to use
33773 extra resources in making one-per-recipient copies for other deliveries. This
33774 can easily be done by expanding the &%transport%& option in the router:
33775 .code
33776 dnslookup:
33777   driver = dnslookup
33778   domains = ! +local_domains
33779   transport = \
33780     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
33781       {verp_smtp}{remote_smtp}}
33782   no_more
33783 .endd
33784 If you want to change the return path using &%errors_to%& in a router instead
33785 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
33786 routers that handle mailing list addresses. This will ensure that all delivery
33787 errors, including those detected on the local host, are sent to the VERP
33788 address.
33789
33790 On a host that does no local deliveries and has no manual routing, only the
33791 &(dnslookup)& router needs to be changed. A special transport is not needed for
33792 SMTP deliveries. Every mailing list recipient has its own return path value,
33793 and so Exim must hand them to the transport one at a time. Here is an example
33794 of a &(dnslookup)& router that implements VERP:
33795 .code
33796 verp_dnslookup:
33797   driver = dnslookup
33798   domains = ! +local_domains
33799   transport = remote_smtp
33800   errors_to = \
33801     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
33802      {$1-request+$local_part=$domain@your.dom.example}fail}
33803   no_more
33804 .endd
33805 Before you start sending out messages with VERPed return paths, you must also
33806 configure Exim to accept the bounce messages that come back to those paths.
33807 Typically this is done by setting a &%local_part_suffix%& option for a
33808 router, and using this to route the messages to wherever you want to handle
33809 them.
33810
33811 The overhead incurred in using VERP depends very much on the size of the
33812 message, the number of recipient addresses that resolve to the same remote
33813 host, and the speed of the connection over which the message is being sent. If
33814 a lot of addresses resolve to the same host and the connection is slow, sending
33815 a separate copy of the message for each address may take substantially longer
33816 than sending a single copy with many recipients (for which VERP cannot be
33817 used).
33818
33819
33820
33821
33822
33823
33824 .section "Virtual domains" "SECTvirtualdomains"
33825 .cindex "virtual domains"
33826 .cindex "domain" "virtual"
33827 The phrase &'virtual domain'& is unfortunately used with two rather different
33828 meanings:
33829
33830 .ilist
33831 A domain for which there are no real mailboxes; all valid local parts are
33832 aliases for other email addresses. Common examples are organizational
33833 top-level domains and &"vanity"& domains.
33834 .next
33835 One of a number of independent domains that are all handled by the same host,
33836 with mailboxes on that host, but where the mailbox owners do not necessarily
33837 have login accounts on that host.
33838 .endlist
33839
33840 The first usage is probably more common, and does seem more &"virtual"& than
33841 the second. This kind of domain can be handled in Exim with a straightforward
33842 aliasing router. One approach is to create a separate alias file for each
33843 virtual domain. Exim can test for the existence of the alias file to determine
33844 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
33845 to a router of this form:
33846 .code
33847 virtual:
33848   driver = redirect
33849   domains = dsearch;/etc/mail/virtual
33850   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
33851   no_more
33852 .endd
33853 The &%domains%& option specifies that the router is to be skipped, unless there
33854 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
33855 domain that is being processed. When the router runs, it looks up the local
33856 part in the file to find a new address (or list of addresses). The &%no_more%&
33857 setting ensures that if the lookup fails (leading to &%data%& being an empty
33858 string), Exim gives up on the address without trying any subsequent routers.
33859
33860 This one router can handle all the virtual domains because the alias file names
33861 follow a fixed pattern. Permissions can be arranged so that appropriate people
33862 can edit the different alias files. A successful aliasing operation results in
33863 a new envelope recipient address, which is then routed from scratch.
33864
33865 The other kind of &"virtual"& domain can also be handled in a straightforward
33866 way. One approach is to create a file for each domain containing a list of
33867 valid local parts, and use it in a router like this:
33868 .code
33869 my_domains:
33870   driver = accept
33871   domains = dsearch;/etc/mail/domains
33872   local_parts = lsearch;/etc/mail/domains/$domain
33873   transport = my_mailboxes
33874 .endd
33875 The address is accepted if there is a file for the domain, and the local part
33876 can be found in the file. The &%domains%& option is used to check for the
33877 file's existence because &%domains%& is tested before the &%local_parts%&
33878 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
33879 because that option is tested after &%local_parts%&. The transport is as
33880 follows:
33881 .code
33882 my_mailboxes:
33883   driver = appendfile
33884   file = /var/mail/$domain/$local_part
33885   user = mail
33886 .endd
33887 This uses a directory of mailboxes for each domain. The &%user%& setting is
33888 required, to specify which uid is to be used for writing to the mailboxes.
33889
33890 The configuration shown here is just one example of how you might support this
33891 requirement. There are many other ways this kind of configuration can be set
33892 up, for example, by using a database instead of separate files to hold all the
33893 information about the domains.
33894
33895
33896
33897 .section "Multiple user mailboxes" "SECTmulbox"
33898 .cindex "multiple mailboxes"
33899 .cindex "mailbox" "multiple"
33900 .cindex "local part" "prefix"
33901 .cindex "local part" "suffix"
33902 Heavy email users often want to operate with multiple mailboxes, into which
33903 incoming mail is automatically sorted. A popular way of handling this is to
33904 allow users to use multiple sender addresses, so that replies can easily be
33905 identified. Users are permitted to add prefixes or suffixes to their local
33906 parts for this purpose. The wildcard facility of the generic router options
33907 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
33908 example, consider this router:
33909 .code
33910 userforward:
33911   driver = redirect
33912   check_local_user
33913   file = $home/.forward
33914   local_part_suffix = -*
33915   local_part_suffix_optional
33916   allow_filter
33917 .endd
33918 .vindex "&$local_part_suffix$&"
33919 It runs a user's &_.forward_& file for all local parts of the form
33920 &'username-*'&. Within the filter file the user can distinguish different
33921 cases by testing the variable &$local_part_suffix$&. For example:
33922 .code
33923 if $local_part_suffix contains -special then
33924 save /home/$local_part/Mail/special
33925 endif
33926 .endd
33927 If the filter file does not exist, or does not deal with such addresses, they
33928 fall through to subsequent routers, and, assuming no subsequent use of the
33929 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
33930 control over which suffixes are valid.
33931
33932 Alternatively, a suffix can be used to trigger the use of a different
33933 &_.forward_& file &-- which is the way a similar facility is implemented in
33934 another MTA:
33935 .code
33936 userforward:
33937   driver = redirect
33938   check_local_user
33939   file = $home/.forward$local_part_suffix
33940   local_part_suffix = -*
33941   local_part_suffix_optional
33942   allow_filter
33943 .endd
33944 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
33945 example, &_.forward-special_& is used. Once again, if the appropriate file
33946 does not exist, or does not deal with the address, it is passed on to
33947 subsequent routers, which could, if required, look for an unqualified
33948 &_.forward_& file to use as a default.
33949
33950
33951
33952 .section "Simplified vacation processing" "SECID244"
33953 .cindex "vacation processing"
33954 The traditional way of running the &'vacation'& program is for a user to set up
33955 a pipe command in a &_.forward_& file
33956 (see section &<<SECTspecitredli>>& for syntax details).
33957 This is prone to error by inexperienced users. There are two features of Exim
33958 that can be used to make this process simpler for users:
33959
33960 .ilist
33961 A local part prefix such as &"vacation-"& can be specified on a router which
33962 can cause the message to be delivered directly to the &'vacation'& program, or
33963 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
33964 &_.forward_& file are then much simpler. For example:
33965 .code
33966 spqr, vacation-spqr
33967 .endd
33968 .next
33969 The &%require_files%& generic router option can be used to trigger a
33970 vacation delivery by checking for the existence of a certain file in the
33971 user's home directory. The &%unseen%& generic option should also be used, to
33972 ensure that the original delivery also proceeds. In this case, all the user has
33973 to do is to create a file called, say, &_.vacation_&, containing a vacation
33974 message.
33975 .endlist
33976
33977 Another advantage of both these methods is that they both work even when the
33978 use of arbitrary pipes by users is locked out.
33979
33980
33981
33982 .section "Taking copies of mail" "SECID245"
33983 .cindex "message" "copying every"
33984 Some installations have policies that require archive copies of all messages to
33985 be made. A single copy of each message can easily be taken by an appropriate
33986 command in a system filter, which could, for example, use a different file for
33987 each day's messages.
33988
33989 There is also a shadow transport mechanism that can be used to take copies of
33990 messages that are successfully delivered by local transports, one copy per
33991 delivery. This could be used, &'inter alia'&, to implement automatic
33992 notification of delivery by sites that insist on doing such things.
33993
33994
33995
33996 .section "Intermittently connected hosts" "SECID246"
33997 .cindex "intermittently connected hosts"
33998 It has become quite common (because it is cheaper) for hosts to connect to the
33999 Internet periodically rather than remain connected all the time. The normal
34000 arrangement is that mail for such hosts accumulates on a system that is
34001 permanently connected.
34002
34003 Exim was designed for use on permanently connected hosts, and so it is not
34004 particularly well-suited to use in an intermittently connected environment.
34005 Nevertheless there are some features that can be used.
34006
34007
34008 .section "Exim on the upstream server host" "SECID247"
34009 It is tempting to arrange for incoming mail for the intermittently connected
34010 host to remain on Exim's queue until the client connects. However, this
34011 approach does not scale very well. Two different kinds of waiting message are
34012 being mixed up in the same queue &-- those that cannot be delivered because of
34013 some temporary problem, and those that are waiting for their destination host
34014 to connect. This makes it hard to manage the queue, as well as wasting
34015 resources, because each queue runner scans the entire queue.
34016
34017 A better approach is to separate off those messages that are waiting for an
34018 intermittently connected host. This can be done by delivering these messages
34019 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
34020 format, from where they are transmitted by other software when their
34021 destination connects. This makes it easy to collect all the mail for one host
34022 in a single directory, and to apply local timeout rules on a per-message basis
34023 if required.
34024
34025 On a very small scale, leaving the mail on Exim's queue can be made to work. If
34026 you are doing this, you should configure Exim with a long retry period for the
34027 intermittent host. For example:
34028 .code
34029 cheshire.wonderland.fict.example    *   F,5d,24h
34030 .endd
34031 This stops a lot of failed delivery attempts from occurring, but Exim remembers
34032 which messages it has queued up for that host. Once the intermittent host comes
34033 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
34034 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
34035 causes all the queued up messages to be delivered, often down a single SMTP
34036 connection. While the host remains connected, any new messages get delivered
34037 immediately.
34038
34039 If the connecting hosts do not have fixed IP addresses, that is, if a host is
34040 issued with a different IP address each time it connects, Exim's retry
34041 mechanisms on the holding host get confused, because the IP address is normally
34042 used as part of the key string for holding retry information. This can be
34043 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
34044 Since this has disadvantages for permanently connected hosts, it is best to
34045 arrange a separate transport for the intermittently connected ones.
34046
34047
34048
34049 .section "Exim on the intermittently connected client host" "SECID248"
34050 The value of &%smtp_accept_queue_per_connection%& should probably be
34051 increased, or even set to zero (that is, disabled) on the intermittently
34052 connected host, so that all incoming messages down a single connection get
34053 delivered immediately.
34054
34055 .cindex "SMTP" "passed connection"
34056 .cindex "SMTP" "multiple deliveries"
34057 .cindex "multiple SMTP deliveries"
34058 Mail waiting to be sent from an intermittently connected host will probably
34059 not have been routed, because without a connection DNS lookups are not
34060 possible. This means that if a normal queue run is done at connection time,
34061 each message is likely to be sent in a separate SMTP session. This can be
34062 avoided by starting the queue run with a command line option beginning with
34063 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
34064 first pass, routing is done but no deliveries take place. The second pass is a
34065 normal queue run; since all the messages have been previously routed, those
34066 destined for the same host are likely to get sent as multiple deliveries in a
34067 single SMTP connection.
34068
34069
34070
34071 . ////////////////////////////////////////////////////////////////////////////
34072 . ////////////////////////////////////////////////////////////////////////////
34073
34074 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
34075          "Exim as a non-queueing client"
34076 .cindex "client, non-queueing"
34077 .cindex "smart host" "suppressing queueing"
34078 On a personal computer, it is a common requirement for all
34079 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
34080 configured to operate that way, for all the popular operating systems.
34081 However, there are some MUAs for Unix-like systems that cannot be so
34082 configured: they submit messages using the command line interface of
34083 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
34084 messages this way.
34085
34086 If the personal computer runs continuously, there is no problem, because it can
34087 run a conventional MTA that handles delivery to the smart host, and deal with
34088 any delays via its queueing mechanism. However, if the computer does not run
34089 continuously or runs different operating systems at different times, queueing
34090 email is not desirable.
34091
34092 There is therefore a requirement for something that can provide the
34093 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
34094 any queueing or retrying facilities. Furthermore, the delivery to the smart
34095 host should be synchronous, so that if it fails, the sending MUA is immediately
34096 informed. In other words, we want something that extends an MUA that submits
34097 to a local MTA via the command line so that it behaves like one that submits
34098 to a remote smart host using TCP/SMTP.
34099
34100 There are a number of applications (for example, there is one called &'ssmtp'&)
34101 that do this job. However, people have found them to be lacking in various
34102 ways. For instance, you might want to allow aliasing and forwarding to be done
34103 before sending a message to the smart host.
34104
34105 Exim already had the necessary infrastructure for doing this job. Just a few
34106 tweaks were needed to make it behave as required, though it is somewhat of an
34107 overkill to use a fully-featured MTA for this purpose.
34108
34109 .oindex "&%mua_wrapper%&"
34110 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
34111 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
34112 assumes that it is being used to &"wrap"& a command-line MUA in the manner
34113 just described. As well as setting &%mua_wrapper%&, you also need to provide a
34114 compatible router and transport configuration. Typically there will be just one
34115 router and one transport, sending everything to a smart host.
34116
34117 When run in MUA wrapping mode, the behaviour of Exim changes in the
34118 following ways:
34119
34120 .ilist
34121 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
34122 In other words, the only way to submit messages is via the command line.
34123 .next
34124 Each message is synchronously delivered as soon as it is received (&%-odi%& is
34125 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
34126 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
34127 does not finish until the delivery attempt is complete. If the delivery is
34128 successful, a zero return code is given.
34129 .next
34130 Address redirection is permitted, but the final routing for all addresses must
34131 be to the same remote transport, and to the same list of hosts. Furthermore,
34132 the return address (envelope sender) must be the same for all recipients, as
34133 must any added or deleted header lines. In other words, it must be possible to
34134 deliver the message in a single SMTP transaction, however many recipients there
34135 are.
34136 .next
34137 If these conditions are not met, or if routing any address results in a
34138 failure or defer status, or if Exim is unable to deliver all the recipients
34139 successfully to one of the smart hosts, delivery of the entire message fails.
34140 .next
34141 Because no queueing is allowed, all failures are treated as permanent; there
34142 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
34143 smart host. Furthermore, because only a single yes/no response can be given to
34144 the caller, it is not possible to deliver to some recipients and not others. If
34145 there is an error (temporary or permanent) for any recipient, all are failed.
34146 .next
34147 If more than one smart host is listed, Exim will try another host after a
34148 connection failure or a timeout, in the normal way. However, if this kind of
34149 failure happens for all the hosts, the delivery fails.
34150 .next
34151 When delivery fails, an error message is written to the standard error stream
34152 (as well as to Exim's log), and Exim exits to the caller with a return code
34153 value 1. The message is expunged from Exim's spool files. No bounce messages
34154 are ever generated.
34155 .next
34156 No retry data is maintained, and any retry rules are ignored.
34157 .next
34158 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
34159 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
34160 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
34161 .endlist
34162
34163 The overall effect is that Exim makes a single synchronous attempt to deliver
34164 the message, failing if there is any kind of problem. Because no local
34165 deliveries are done and no daemon can be run, Exim does not need root
34166 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
34167 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
34168 the advantages and disadvantages of running without root privilege.
34169
34170
34171
34172
34173 . ////////////////////////////////////////////////////////////////////////////
34174 . ////////////////////////////////////////////////////////////////////////////
34175
34176 .chapter "Log files" "CHAPlog"
34177 .scindex IIDloggen "log" "general description"
34178 .cindex "log" "types of"
34179 Exim writes three different logs, referred to as the main log, the reject log,
34180 and the panic log:
34181
34182 .ilist
34183 .cindex "main log"
34184 The main log records the arrival of each message and each delivery in a single
34185 line in each case. The format is as compact as possible, in an attempt to keep
34186 down the size of log files. Two-character flag sequences make it easy to pick
34187 out these lines. A number of other events are recorded in the main log. Some of
34188 them are optional, in which case the &%log_selector%& option controls whether
34189 they are included or not. A Perl script called &'eximstats'&, which does simple
34190 analysis of main log files, is provided in the Exim distribution (see section
34191 &<<SECTmailstat>>&).
34192 .next
34193 .cindex "reject log"
34194 The reject log records information from messages that are rejected as a result
34195 of a configuration option (that is, for policy reasons).
34196 The first line of each rejection is a copy of the line that is also written to
34197 the main log. Then, if the message's header has been read at the time the log
34198 is written, its contents are written to this log. Only the original header
34199 lines are available; header lines added by ACLs are not logged. You can use the
34200 reject log to check that your policy controls are working correctly; on a busy
34201 host this may be easier than scanning the main log for rejection messages. You
34202 can suppress the writing of the reject log by setting &%write_rejectlog%&
34203 false.
34204 .next
34205 .cindex "panic log"
34206 .cindex "system log"
34207 When certain serious errors occur, Exim writes entries to its panic log. If the
34208 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
34209 are usually written to the main log as well, but can get lost amid the mass of
34210 other entries. The panic log should be empty under normal circumstances. It is
34211 therefore a good idea to check it (or to have a &'cron'& script check it)
34212 regularly, in order to become aware of any problems. When Exim cannot open its
34213 panic log, it tries as a last resort to write to the system log (syslog). This
34214 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
34215 message itself is written at priority LOG_CRIT.
34216 .endlist
34217
34218 Every log line starts with a timestamp, in the format shown in the following
34219 example. Note that many of the examples shown in this chapter are line-wrapped.
34220 In the log file, this would be all on one line:
34221 .code
34222 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
34223   by QUIT
34224 .endd
34225 By default, the timestamps are in the local timezone. There are two
34226 ways of changing this:
34227
34228 .ilist
34229 You can set the &%timezone%& option to a different time zone; in particular, if
34230 you set
34231 .code
34232 timezone = UTC
34233 .endd
34234 the timestamps will be in UTC (aka GMT).
34235 .next
34236 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
34237 example:
34238 .code
34239 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
34240 .endd
34241 .endlist
34242
34243 .cindex "log" "process ids in"
34244 .cindex "pid (process id)" "in log lines"
34245 Exim does not include its process id in log lines by default, but you can
34246 request that it does so by specifying the &`pid`& log selector (see section
34247 &<<SECTlogselector>>&). When this is set, the process id is output, in square
34248 brackets, immediately after the time and date.
34249
34250
34251
34252
34253 .section "Where the logs are written" "SECTwhelogwri"
34254 .cindex "log" "destination"
34255 .cindex "log" "to file"
34256 .cindex "log" "to syslog"
34257 .cindex "syslog"
34258 The logs may be written to local files, or to syslog, or both. However, it
34259 should be noted that many syslog implementations use UDP as a transport, and
34260 are therefore unreliable in the sense that messages are not guaranteed to
34261 arrive at the loghost, nor is the ordering of messages necessarily maintained.
34262 It has also been reported that on large log files (tens of megabytes) you may
34263 need to tweak syslog to prevent it syncing the file with each write &-- on
34264 Linux this has been seen to make syslog take 90% plus of CPU time.
34265
34266 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
34267 &_Local/Makefile_& or by setting &%log_file_path%& in the run time
34268 configuration. This latter string is expanded, so it can contain, for example,
34269 references to the host name:
34270 .code
34271 log_file_path = /var/log/$primary_hostname/exim_%slog
34272 .endd
34273 It is generally advisable, however, to set the string in &_Local/Makefile_&
34274 rather than at run time, because then the setting is available right from the
34275 start of Exim's execution. Otherwise, if there's something it wants to log
34276 before it has read the configuration file (for example, an error in the
34277 configuration file) it will not use the path you want, and may not be able to
34278 log at all.
34279
34280 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
34281 list, currently limited to at most two items. This is one option where the
34282 facility for changing a list separator may not be used. The list must always be
34283 colon-separated. If an item in the list is &"syslog"& then syslog is used;
34284 otherwise the item must either be an absolute path, containing &`%s`& at the
34285 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
34286 implying the use of a default path.
34287
34288 When Exim encounters an empty item in the list, it searches the list defined by
34289 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
34290 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
34291 mean &"use the path specified at build time"&. It no such item exists, log
34292 files are written in the &_log_& subdirectory of the spool directory. This is
34293 equivalent to the setting:
34294 .code
34295 log_file_path = $spool_directory/log/%slog
34296 .endd
34297 If you do not specify anything at build time or run time, that is where the
34298 logs are written.
34299
34300 A log file path may also contain &`%D`& or &`%M`& if datestamped log file names
34301 are in use &-- see section &<<SECTdatlogfil>>& below.
34302
34303 Here are some examples of possible settings:
34304 .display
34305 &`LOG_FILE_PATH=syslog                    `& syslog only
34306 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
34307 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
34308 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
34309 .endd
34310 If there are more than two paths in the list, the first is used and a panic
34311 error is logged.
34312
34313
34314
34315 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
34316 .cindex "log" "cycling local files"
34317 .cindex "cycling logs"
34318 .cindex "&'exicyclog'&"
34319 .cindex "log" "local files; writing to"
34320 Some operating systems provide centralized and standardized methods for cycling
34321 log files. For those that do not, a utility script called &'exicyclog'& is
34322 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
34323 main and reject logs each time it is called. The maximum number of old logs to
34324 keep can be set. It is suggested this script is run as a daily &'cron'& job.
34325
34326 An Exim delivery process opens the main log when it first needs to write to it,
34327 and it keeps the file open in case subsequent entries are required &-- for
34328 example, if a number of different deliveries are being done for the same
34329 message. However, remote SMTP deliveries can take a long time, and this means
34330 that the file may be kept open long after it is renamed if &'exicyclog'& or
34331 something similar is being used to rename log files on a regular basis. To
34332 ensure that a switch of log files is noticed as soon as possible, Exim calls
34333 &[stat()]& on the main log's name before reusing an open file, and if the file
34334 does not exist, or its inode has changed, the old file is closed and Exim
34335 tries to open the main log from scratch. Thus, an old log file may remain open
34336 for quite some time, but no Exim processes should write to it once it has been
34337 renamed.
34338
34339
34340
34341 .section "Datestamped log files" "SECTdatlogfil"
34342 .cindex "log" "datestamped files"
34343 Instead of cycling the main and reject log files by renaming them
34344 periodically, some sites like to use files whose names contain a datestamp,
34345 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
34346 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
34347 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
34348 point where the datestamp is required. For example:
34349 .code
34350 log_file_path = /var/spool/exim/log/%slog-%D
34351 log_file_path = /var/log/exim-%s-%D.log
34352 log_file_path = /var/spool/exim/log/%D-%slog
34353 log_file_path = /var/log/exim/%s.%M
34354 .endd
34355 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
34356 examples of names generated by the above examples:
34357 .code
34358 /var/spool/exim/log/mainlog-20021225
34359 /var/log/exim-reject-20021225.log
34360 /var/spool/exim/log/20021225-mainlog
34361 /var/log/exim/main.200212
34362 .endd
34363 When this form of log file is specified, Exim automatically switches to new
34364 files at midnight. It does not make any attempt to compress old logs; you
34365 will need to write your own script if you require this. You should not
34366 run &'exicyclog'& with this form of logging.
34367
34368 The location of the panic log is also determined by &%log_file_path%&, but it
34369 is not datestamped, because rotation of the panic log does not make sense.
34370 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
34371 the string. In addition, if it immediately follows a slash, a following
34372 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
34373 character is removed. Thus, the four examples above would give these panic
34374 log names:
34375 .code
34376 /var/spool/exim/log/paniclog
34377 /var/log/exim-panic.log
34378 /var/spool/exim/log/paniclog
34379 /var/log/exim/panic
34380 .endd
34381
34382
34383 .section "Logging to syslog" "SECID249"
34384 .cindex "log" "syslog; writing to"
34385 The use of syslog does not change what Exim logs or the format of its messages,
34386 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
34387 Exim's log lines are omitted when these lines are sent to syslog. Apart from
34388 that, the same strings are written to syslog as to log files. The syslog
34389 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
34390 by default, but you can change these by setting the &%syslog_facility%& and
34391 &%syslog_processname%& options, respectively. If Exim was compiled with
34392 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
34393 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
34394 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
34395 the time and host name to each line.
34396 The three log streams are mapped onto syslog priorities as follows:
34397
34398 .ilist
34399 &'mainlog'& is mapped to LOG_INFO
34400 .next
34401 &'rejectlog'& is mapped to LOG_NOTICE
34402 .next
34403 &'paniclog'& is mapped to LOG_ALERT
34404 .endlist
34405
34406 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
34407 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
34408 these are routed by syslog to the same place. You can suppress this duplication
34409 by setting &%syslog_duplication%& false.
34410
34411 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
34412 entries contain multiple lines when headers are included. To cope with both
34413 these cases, entries written to syslog are split into separate &[syslog()]&
34414 calls at each internal newline, and also after a maximum of
34415 870 data characters. (This allows for a total syslog line length of 1024, when
34416 additions such as timestamps are added.) If you are running a syslog
34417 replacement that can handle lines longer than the 1024 characters allowed by
34418 RFC 3164, you should set
34419 .code
34420 SYSLOG_LONG_LINES=yes
34421 .endd
34422 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
34423 lines, but it still splits at internal newlines in &'reject'& log entries.
34424
34425 To make it easy to re-assemble split lines later, each component of a split
34426 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
34427 where <&'n'&> is the component number and <&'m'&> is the total number of
34428 components in the entry. The / delimiter is used when the line was split
34429 because it was too long; if it was split because of an internal newline, the \
34430 delimiter is used. For example, supposing the length limit to be 50 instead of
34431 870, the following would be the result of a typical rejection message to
34432 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
34433 name, and pid as added by syslog:
34434 .code
34435 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
34436 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
34437 [3/5]  when scanning for sender: missing or malformed lo
34438 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
34439 [5/5] mple>)
34440 .endd
34441 The same error might cause the following lines to be written to &"rejectlog"&
34442 (LOG_NOTICE):
34443 .code
34444 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
34445 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
34446 [3/18] er when scanning for sender: missing or malformed
34447 [4/18]  local part in "<>" (envelope sender is <ph10@cam
34448 [5\18] .example>)
34449 [6\18] Recipients: ph10@some.domain.cam.example
34450 [7\18] P Received: from [127.0.0.1] (ident=ph10)
34451 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
34452 [9\18]        id 16RdAL-0006pc-00
34453 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
34454 [11\18] 09:43 +0100
34455 [12\18] F From: <>
34456 [13\18]   Subject: this is a test header
34457 [18\18]   X-something: this is another header
34458 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
34459 [16\18] le>
34460 [17\18] B Bcc:
34461 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
34462 .endd
34463 Log lines that are neither too long nor contain newlines are written to syslog
34464 without modification.
34465
34466 If only syslog is being used, the Exim monitor is unable to provide a log tail
34467 display, unless syslog is routing &'mainlog'& to a file on the local host and
34468 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
34469 where it is.
34470
34471
34472
34473 .section "Log line flags" "SECID250"
34474 One line is written to the main log for each message received, and for each
34475 successful, unsuccessful, and delayed delivery. These lines can readily be
34476 picked out by the distinctive two-character flags that immediately follow the
34477 timestamp. The flags are:
34478 .display
34479 &`<=`&     message arrival
34480 &`=>`&     normal message delivery
34481 &`->`&     additional address in same delivery
34482 &`>>`&     cutthrough message delivery
34483 &`*>`&     delivery suppressed by &%-N%&
34484 &`**`&     delivery failed; address bounced
34485 &`==`&     delivery deferred; temporary problem
34486 .endd
34487
34488
34489 .section "Logging message reception" "SECID251"
34490 .cindex "log" "reception line"
34491 The format of the single-line entry in the main log that is written for every
34492 message received is shown in the basic example below, which is split over
34493 several lines in order to fit it on the page:
34494 .code
34495 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
34496   H=mailer.fict.example [192.168.123.123] U=exim
34497   P=smtp S=5678 id=<incoming message id>
34498 .endd
34499 The address immediately following &"<="& is the envelope sender address. A
34500 bounce message is shown with the sender address &"<>"&, and if it is locally
34501 generated, this is followed by an item of the form
34502 .code
34503 R=<message id>
34504 .endd
34505 which is a reference to the message that caused the bounce to be sent.
34506
34507 .cindex "HELO"
34508 .cindex "EHLO"
34509 For messages from other hosts, the H and U fields identify the remote host and
34510 record the RFC 1413 identity of the user that sent the message, if one was
34511 received. The number given in square brackets is the IP address of the sending
34512 host. If there is a single, unparenthesized  host name in the H field, as
34513 above, it has been verified to correspond to the IP address (see the
34514 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
34515 by the remote host in the SMTP HELO or EHLO command, and has not been
34516 verified. If verification yields a different name to that given for HELO or
34517 EHLO, the verified name appears first, followed by the HELO or EHLO
34518 name in parentheses.
34519
34520 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
34521 without brackets, in the HELO or EHLO command, leading to entries in
34522 the log containing text like these examples:
34523 .code
34524 H=(10.21.32.43) [192.168.8.34]
34525 H=([10.21.32.43]) [192.168.8.34]
34526 .endd
34527 This can be confusing. Only the final address in square brackets can be relied
34528 on.
34529
34530 For locally generated messages (that is, messages not received over TCP/IP),
34531 the H field is omitted, and the U field contains the login name of the caller
34532 of Exim.
34533
34534 .cindex "authentication" "logging"
34535 .cindex "AUTH" "logging"
34536 For all messages, the P field specifies the protocol used to receive the
34537 message. This is the value that is stored in &$received_protocol$&. In the case
34538 of incoming SMTP messages, the value indicates whether or not any SMTP
34539 extensions (ESMTP), encryption, or authentication were used. If the SMTP
34540 session was encrypted, there is an additional X field that records the cipher
34541 suite that was used.
34542
34543 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
34544 hosts that have authenticated themselves using the SMTP AUTH command. The first
34545 value is used when the SMTP connection was encrypted (&"secure"&). In this case
34546 there is an additional item A= followed by the name of the authenticator that
34547 was used. If an authenticated identification was set up by the authenticator's
34548 &%server_set_id%& option, this is logged too, separated by a colon from the
34549 authenticator name.
34550
34551 .cindex "size" "of message"
34552 The id field records the existing message id, if present. The size of the
34553 received message is given by the S field. When the message is delivered,
34554 headers may be removed or added, so that the size of delivered copies of the
34555 message may not correspond with this value (and indeed may be different to each
34556 other).
34557
34558 The &%log_selector%& option can be used to request the logging of additional
34559 data when a message is received. See section &<<SECTlogselector>>& below.
34560
34561
34562
34563 .section "Logging deliveries" "SECID252"
34564 .cindex "log" "delivery line"
34565 The format of the single-line entry in the main log that is written for every
34566 delivery is shown in one of the examples below, for local and remote
34567 deliveries, respectively. Each example has been split into two lines in order
34568 to fit it on the page:
34569 .code
34570 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
34571   <marv@hitch.fict.example> R=localuser T=local_delivery
34572 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
34573   monk@holistic.fict.example R=dnslookup T=remote_smtp
34574   H=holistic.fict.example [192.168.234.234]
34575 .endd
34576 For ordinary local deliveries, the original address is given in angle brackets
34577 after the final delivery address, which might be a pipe or a file. If
34578 intermediate address(es) exist between the original and the final address, the
34579 last of these is given in parentheses after the final address. The R and T
34580 fields record the router and transport that were used to process the address.
34581
34582 If SMTP AUTH was used for the delivery there is an additional item A=
34583 followed by the name of the authenticator that was used.
34584 If an authenticated identification was set up by the authenticator's &%client_set_id%&
34585 option, this is logged too, separated by a colon from the authenticator name.
34586
34587 If a shadow transport was run after a successful local delivery, the log line
34588 for the successful delivery has an item added on the end, of the form
34589 .display
34590 &`ST=<`&&'shadow transport name'&&`>`&
34591 .endd
34592 If the shadow transport did not succeed, the error message is put in
34593 parentheses afterwards.
34594
34595 .cindex "asterisk" "after IP address"
34596 When more than one address is included in a single delivery (for example, two
34597 SMTP RCPT commands in one transaction) the second and subsequent addresses are
34598 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
34599 down a single SMTP connection, an asterisk follows the IP address in the log
34600 lines for the second and subsequent messages.
34601
34602 .cindex "delivery" "cutthrough; logging"
34603 .cindex "cutthrough" "logging"
34604 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
34605 line precedes the reception line, since cutthrough waits for a possible
34606 rejection from the destination in case it can reject the sourced item.
34607
34608 The generation of a reply message by a filter file gets logged as a
34609 &"delivery"& to the addressee, preceded by &">"&.
34610
34611 The &%log_selector%& option can be used to request the logging of additional
34612 data when a message is delivered. See section &<<SECTlogselector>>& below.
34613
34614
34615 .section "Discarded deliveries" "SECID253"
34616 .cindex "discarded messages"
34617 .cindex "message" "discarded"
34618 .cindex "delivery" "discarded; logging"
34619 When a message is discarded as a result of the command &"seen finish"& being
34620 obeyed in a filter file which generates no deliveries, a log entry of the form
34621 .code
34622 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
34623   <low.club@bridge.example> R=userforward
34624 .endd
34625 is written, to record why no deliveries are logged. When a message is discarded
34626 because it is aliased to &":blackhole:"& the log line is like this:
34627 .code
34628 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
34629   <hole@nowhere.example> R=blackhole_router
34630 .endd
34631
34632
34633 .section "Deferred deliveries" "SECID254"
34634 When a delivery is deferred, a line of the following form is logged:
34635 .code
34636 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
34637   R=dnslookup T=smtp defer (146): Connection refused
34638 .endd
34639 In the case of remote deliveries, the error is the one that was given for the
34640 last IP address that was tried. Details of individual SMTP failures are also
34641 written to the log, so the above line would be preceded by something like
34642 .code
34643 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
34644   mail1.endrest.example [192.168.239.239]: Connection refused
34645 .endd
34646 When a deferred address is skipped because its retry time has not been reached,
34647 a message is written to the log, but this can be suppressed by setting an
34648 appropriate value in &%log_selector%&.
34649
34650
34651
34652 .section "Delivery failures" "SECID255"
34653 .cindex "delivery" "failure; logging"
34654 If a delivery fails because an address cannot be routed, a line of the
34655 following form is logged:
34656 .code
34657 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
34658   <jim@trek99.example>: unknown mail domain
34659 .endd
34660 If a delivery fails at transport time, the router and transport are shown, and
34661 the response from the remote host is included, as in this example:
34662 .code
34663 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
34664   R=dnslookup T=remote_smtp: SMTP error from remote mailer
34665   after pipelined RCPT TO:<ace400@pb.example>: host
34666   pbmail3.py.example [192.168.63.111]: 553 5.3.0
34667   <ace400@pb.example>...Addressee unknown
34668 .endd
34669 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
34670 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
34671 disabling PIPELINING. The log lines for all forms of delivery failure are
34672 flagged with &`**`&.
34673
34674
34675
34676 .section "Fake deliveries" "SECID256"
34677 .cindex "delivery" "fake; logging"
34678 If a delivery does not actually take place because the &%-N%& option has been
34679 used to suppress it, a normal delivery line is written to the log, except that
34680 &"=>"& is replaced by &"*>"&.
34681
34682
34683
34684 .section "Completion" "SECID257"
34685 A line of the form
34686 .code
34687 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
34688 .endd
34689 is written to the main log when a message is about to be removed from the spool
34690 at the end of its processing.
34691
34692
34693
34694
34695 .section "Summary of Fields in Log Lines" "SECID258"
34696 .cindex "log" "summary of fields"
34697 A summary of the field identifiers that are used in log lines is shown in
34698 the following table:
34699 .display
34700 &`A   `&        authenticator name (and optional id and sender)
34701 &`C   `&        SMTP confirmation on delivery
34702 &`    `&        command list for &"no mail in SMTP session"&
34703 &`CV  `&        certificate verification status
34704 &`D   `&        duration of &"no mail in SMTP session"&
34705 &`DN  `&        distinguished name from peer certificate
34706 &`DT  `&        on &`=>`& lines: time taken for a delivery
34707 &`F   `&        sender address (on delivery lines)
34708 &`H   `&        host name and IP address
34709 &`I   `&        local interface used
34710 &`id  `&        message id for incoming message
34711 &`P   `&        on &`<=`& lines: protocol used
34712 &`    `&        on &`=>`& and &`**`& lines: return path
34713 &`QT  `&        on &`=>`& lines: time spent on queue so far
34714 &`    `&        on &"Completed"& lines: time spent on queue
34715 &`R   `&        on &`<=`& lines: reference for local bounce
34716 &`    `&        on &`=>`&  &`**`& and &`==`& lines: router name
34717 &`S   `&        size of message
34718 &`SNI `&        server name indication from TLS client hello
34719 &`ST  `&        shadow transport name
34720 &`T   `&        on &`<=`& lines: message subject (topic)
34721 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
34722 &`U   `&        local user or RFC 1413 identity
34723 &`X   `&        TLS cipher suite
34724 .endd
34725
34726
34727 .section "Other log entries" "SECID259"
34728 Various other types of log entry are written from time to time. Most should be
34729 self-explanatory. Among the more common are:
34730
34731 .ilist
34732 .cindex "retry" "time not reached"
34733 &'retry time not reached'&&~&~An address previously suffered a temporary error
34734 during routing or local delivery, and the time to retry has not yet arrived.
34735 This message is not written to an individual message log file unless it happens
34736 during the first delivery attempt.
34737 .next
34738 &'retry time not reached for any host'&&~&~An address previously suffered
34739 temporary errors during remote delivery, and the retry time has not yet arrived
34740 for any of the hosts to which it is routed.
34741 .next
34742 .cindex "spool directory" "file locked"
34743 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
34744 some other Exim process is already working on the message. This can be quite
34745 common if queue running processes are started at frequent intervals. The
34746 &'exiwhat'& utility script can be used to find out what Exim processes are
34747 doing.
34748 .next
34749 .cindex "error" "ignored"
34750 &'error ignored'&&~&~There are several circumstances that give rise to this
34751 message:
34752 .olist
34753 Exim failed to deliver a bounce message whose age was greater than
34754 &%ignore_bounce_errors_after%&. The bounce was discarded.
34755 .next
34756 A filter file set up a delivery using the &"noerror"& option, and the delivery
34757 failed. The delivery was discarded.
34758 .next
34759 A delivery set up by a router configured with
34760 . ==== As this is a nested list, any displays it contains must be indented
34761 . ==== as otherwise they are too far to the left.
34762 .code
34763     errors_to = <>
34764 .endd
34765 failed. The delivery was discarded.
34766 .endlist olist
34767 .endlist ilist
34768
34769
34770
34771
34772
34773 .section "Reducing or increasing what is logged" "SECTlogselector"
34774 .cindex "log" "selectors"
34775 By setting the &%log_selector%& global option, you can disable some of Exim's
34776 default logging, or you can request additional logging. The value of
34777 &%log_selector%& is made up of names preceded by plus or minus characters. For
34778 example:
34779 .code
34780 log_selector = +arguments -retry_defer
34781 .endd
34782 The list of optional log items is in the following table, with the default
34783 selection marked by asterisks:
34784 .display
34785 &` 8bitmime                   `&  received 8BITMIME status
34786 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
34787 &` address_rewrite            `&  address rewriting
34788 &` all_parents                `&  all parents in => lines
34789 &` arguments                  `&  command line arguments
34790 &`*connection_reject          `&  connection rejections
34791 &`*delay_delivery             `&  immediate delivery delayed
34792 &` deliver_time               `&  time taken to perform delivery
34793 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
34794 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
34795 &`*etrn                       `&  ETRN commands
34796 &`*host_lookup_failed         `&  as it says
34797 &` ident_timeout              `&  timeout for ident connection
34798 &` incoming_interface         `&  incoming interface on <= lines
34799 &` incoming_port              `&  incoming port on <= lines
34800 &`*lost_incoming_connection   `&  as it says (includes timeouts)
34801 &` outgoing_port              `&  add remote port to => lines
34802 &`*queue_run                  `&  start and end queue runs
34803 &` queue_time                 `&  time on queue for one recipient
34804 &` queue_time_overall         `&  time on queue for whole message
34805 &` pid                        `&  Exim process id
34806 &` received_recipients        `&  recipients on <= lines
34807 &` received_sender            `&  sender on <= lines
34808 &`*rejected_header            `&  header contents on reject log
34809 &`*retry_defer                `&  &"retry time not reached"&
34810 &` return_path_on_delivery    `&  put return path on => and ** lines
34811 &` sender_on_delivery         `&  add sender to => lines
34812 &`*sender_verify_fail         `&  sender verification failures
34813 &`*size_reject                `&  rejection because too big
34814 &`*skip_delivery              `&  delivery skipped in a queue run
34815 &`*smtp_confirmation          `&  SMTP confirmation on => lines
34816 &` smtp_connection            `&  SMTP connections
34817 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
34818 &` smtp_mailauth              `&  AUTH argument to MAIL commands
34819 &` smtp_no_mail               `&  session with no MAIL commands
34820 &` smtp_protocol_error        `&  SMTP protocol errors
34821 &` smtp_syntax_error          `&  SMTP syntax errors
34822 &` subject                    `&  contents of &'Subject:'& on <= lines
34823 &`*tls_certificate_verified   `&  certificate verification status
34824 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
34825 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
34826 &` tls_sni                    `&  TLS SNI on <= lines
34827 &` unknown_in_list            `&  DNS lookup failed in list match
34828
34829 &` all                        `&  all of the above
34830 .endd
34831 More details on each of these items follows:
34832
34833 .ilist
34834 .cindex "8BITMIME"
34835 .cindex "log" "8BITMIME"
34836 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
34837 which may help in tracking down interoperability issues with ancient MTAs
34838 that are not 8bit clean.  This is added to the &"<="& line, tagged with
34839 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
34840 &`7BIT`& and &`8BITMIME`& respectively.
34841 .next
34842 .cindex "&%warn%& ACL verb" "log when skipping"
34843 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
34844 its conditions cannot be evaluated, a log line to this effect is written if
34845 this log selector is set.
34846 .next
34847 .cindex "log" "rewriting"
34848 .cindex "rewriting" "logging"
34849 &%address_rewrite%&: This applies both to global rewrites and per-transport
34850 rewrites, but not to rewrites in filters run as an unprivileged user (because
34851 such users cannot access the log).
34852 .next
34853 .cindex "log" "full parentage"
34854 &%all_parents%&: Normally only the original and final addresses are logged on
34855 delivery lines; with this selector, intermediate parents are given in
34856 parentheses between them.
34857 .next
34858 .cindex "log" "Exim arguments"
34859 .cindex "Exim arguments, logging"
34860 &%arguments%&: This causes Exim to write the arguments with which it was called
34861 to the main log, preceded by the current working directory. This is a debugging
34862 feature, added to make it easier to find out how certain MUAs call
34863 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
34864 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
34865 that are empty or that contain white space are quoted. Non-printing characters
34866 are shown as escape sequences. This facility cannot log unrecognized arguments,
34867 because the arguments are checked before the configuration file is read. The
34868 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
34869 between the caller and Exim.
34870 .next
34871 .cindex "log" "connection rejections"
34872 &%connection_reject%&: A log entry is written whenever an incoming SMTP
34873 connection is rejected, for whatever reason.
34874 .next
34875 .cindex "log" "delayed delivery"
34876 .cindex "delayed delivery, logging"
34877 &%delay_delivery%&: A log entry is written whenever a delivery process is not
34878 started for an incoming message because the load is too high or too many
34879 messages were received on one connection. Logging does not occur if no delivery
34880 process is started because &%queue_only%& is set or &%-odq%& was used.
34881 .next
34882 .cindex "log" "delivery duration"
34883 &%deliver_time%&: For each delivery, the amount of real time it has taken to
34884 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
34885 .next
34886 .cindex "log" "message size on delivery"
34887 .cindex "size" "of message"
34888 &%delivery_size%&: For each delivery, the size of message delivered is added to
34889 the &"=>"& line, tagged with S=.
34890 .next
34891 .cindex "log" "dnslist defer"
34892 .cindex "DNS list" "logging defer"
34893 .cindex "black list (DNS)"
34894 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
34895 DNS black list suffers a temporary error.
34896 .next
34897 .cindex "log" "ETRN commands"
34898 .cindex "ETRN" "logging"
34899 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
34900 is run to determine whether or not it is actually accepted. An invalid ETRN
34901 command, or one received within a message transaction is not logged by this
34902 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
34903 .next
34904 .cindex "log" "host lookup failure"
34905 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
34906 any addresses, or when a lookup of an IP address fails to find a host name, a
34907 log line is written. This logging does not apply to direct DNS lookups when
34908 routing email addresses, but it does apply to &"byname"& lookups.
34909 .next
34910 .cindex "log" "ident timeout"
34911 .cindex "RFC 1413" "logging timeout"
34912 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
34913 client's ident port times out.
34914 .next
34915 .cindex "log" "incoming interface"
34916 .cindex "interface" "logging"
34917 &%incoming_interface%&: The interface on which a message was received is added
34918 to the &"<="& line as an IP address in square brackets, tagged by I= and
34919 followed by a colon and the port number. The local interface and port are also
34920 added to other SMTP log lines, for example &"SMTP connection from"&, and to
34921 rejection lines.
34922 .next
34923 .cindex "log" "incoming remote port"
34924 .cindex "port" "logging remote"
34925 .cindex "TCP/IP" "logging incoming remote port"
34926 .vindex "&$sender_fullhost$&"
34927 .vindex "&$sender_rcvhost$&"
34928 &%incoming_port%&: The remote port number from which a message was received is
34929 added to log entries and &'Received:'& header lines, following the IP address
34930 in square brackets, and separated from it by a colon. This is implemented by
34931 changing the value that is put in the &$sender_fullhost$& and
34932 &$sender_rcvhost$& variables. Recording the remote port number has become more
34933 important with the widening use of NAT (see RFC 2505).
34934 .next
34935 .cindex "log" "dropped connection"
34936 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
34937 connection is unexpectedly dropped.
34938 .next
34939 .cindex "log" "outgoing remote port"
34940 .cindex "port" "logging outgoint remote"
34941 .cindex "TCP/IP" "logging ougtoing remote port"
34942 &%outgoing_port%&: The remote port number is added to delivery log lines (those
34943 containing => tags) following the IP address. This option is not included in
34944 the default setting, because for most ordinary configurations, the remote port
34945 number is always 25 (the SMTP port).
34946 .next
34947 .cindex "log" "process ids in"
34948 .cindex "pid (process id)" "in log lines"
34949 &%pid%&: The current process id is added to every log line, in square brackets,
34950 immediately after the time and date.
34951 .next
34952 .cindex "log" "queue run"
34953 .cindex "queue runner" "logging"
34954 &%queue_run%&: The start and end of every queue run are logged.
34955 .next
34956 .cindex "log" "queue time"
34957 &%queue_time%&: The amount of time the message has been in the queue on the
34958 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
34959 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
34960 includes reception time as well as the delivery time for the current address.
34961 This means that it may be longer than the difference between the arrival and
34962 delivery log line times, because the arrival log line is not written until the
34963 message has been successfully received.
34964 .next
34965 &%queue_time_overall%&: The amount of time the message has been in the queue on
34966 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
34967 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
34968 message, so it includes reception time as well as the total delivery time.
34969 .next
34970 .cindex "log" "recipients"
34971 &%received_recipients%&: The recipients of a message are listed in the main log
34972 as soon as the message is received. The list appears at the end of the log line
34973 that is written when a message is received, preceded by the word &"for"&. The
34974 addresses are listed after they have been qualified, but before any rewriting
34975 has taken place.
34976 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
34977 in the list.
34978 .next
34979 .cindex "log" "sender reception"
34980 &%received_sender%&: The unrewritten original sender of a message is added to
34981 the end of the log line that records the message's arrival, after the word
34982 &"from"& (before the recipients if &%received_recipients%& is also set).
34983 .next
34984 .cindex "log" "header lines for rejection"
34985 &%rejected_header%&: If a message's header has been received at the time a
34986 rejection is written to the reject log, the complete header is added to the
34987 log. Header logging can be turned off individually for messages that are
34988 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
34989 .next
34990 .cindex "log" "retry defer"
34991 &%retry_defer%&: A log line is written if a delivery is deferred because a
34992 retry time has not yet been reached. However, this &"retry time not reached"&
34993 message is always omitted from individual message logs after the first delivery
34994 attempt.
34995 .next
34996 .cindex "log" "return path"
34997 &%return_path_on_delivery%&: The return path that is being transmitted with
34998 the message is included in delivery and bounce lines, using the tag P=.
34999 This is omitted if no delivery actually happens, for example, if routing fails,
35000 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
35001 .next
35002 .cindex "log" "sender on delivery"
35003 &%sender_on_delivery%&: The message's sender address is added to every delivery
35004 and bounce line, tagged by F= (for &"from"&).
35005 This is the original sender that was received with the message; it is not
35006 necessarily the same as the outgoing return path.
35007 .next
35008 .cindex "log" "sender verify failure"
35009 &%sender_verify_fail%&: If this selector is unset, the separate log line that
35010 gives details of a sender verification failure is not written. Log lines for
35011 the rejection of SMTP commands contain just &"sender verify failed"&, so some
35012 detail is lost.
35013 .next
35014 .cindex "log" "size rejection"
35015 &%size_reject%&: A log line is written whenever a message is rejected because
35016 it is too big.
35017 .next
35018 .cindex "log" "frozen messages; skipped"
35019 .cindex "frozen messages" "logging skipping"
35020 &%skip_delivery%&: A log line is written whenever a message is skipped during a
35021 queue run because it is frozen or because another process is already delivering
35022 it.
35023 .cindex "&""spool file is locked""&"
35024 The message that is written is &"spool file is locked"&.
35025 .next
35026 .cindex "log" "smtp confirmation"
35027 .cindex "SMTP" "logging confirmation"
35028 .cindex "LMTP" "logging confirmation"
35029 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
35030 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
35031 A number of MTAs (including Exim) return an identifying string in this
35032 response.
35033 .next
35034 .cindex "log" "SMTP connections"
35035 .cindex "SMTP" "logging connections"
35036 &%smtp_connection%&: A log line is written whenever an SMTP connection is
35037 established or closed, unless the connection is from a host that matches
35038 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
35039 only when the closure is unexpected.) This applies to connections from local
35040 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
35041 dropped in the middle of a message, a log line is always written, whether or
35042 not this selector is set, but otherwise nothing is written at the start and end
35043 of connections unless this selector is enabled.
35044
35045 For TCP/IP connections to an Exim daemon, the current number of connections is
35046 included in the log message for each new connection, but note that the count is
35047 reset if the daemon is restarted.
35048 Also, because connections are closed (and the closure is logged) in
35049 subprocesses, the count may not include connections that have been closed but
35050 whose termination the daemon has not yet noticed. Thus, while it is possible to
35051 match up the opening and closing of connections in the log, the value of the
35052 logged counts may not be entirely accurate.
35053 .next
35054 .cindex "log" "SMTP transaction; incomplete"
35055 .cindex "SMTP" "logging incomplete transactions"
35056 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
35057 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
35058 and the message sender plus any accepted recipients are included in the log
35059 line. This can provide evidence of dictionary attacks.
35060 .next
35061 .cindex "log" "non-MAIL SMTP sessions"
35062 .cindex "MAIL" "logging session without"
35063 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
35064 connection terminates without having issued a MAIL command. This includes both
35065 the case when the connection is dropped, and the case when QUIT is used. It
35066 does not include cases where the connection is rejected right at the start (by
35067 an ACL, or because there are too many connections, or whatever). These cases
35068 already have their own log lines.
35069
35070 The log line that is written contains the identity of the client in the usual
35071 way, followed by D= and a time, which records the duration of the connection.
35072 If the connection was authenticated, this fact is logged exactly as it is for
35073 an incoming message, with an A= item. If the connection was encrypted, CV=,
35074 DN=, and X= items may appear as they do for an incoming message, controlled by
35075 the same logging options.
35076
35077 Finally, if any SMTP commands were issued during the connection, a C= item
35078 is added to the line, listing the commands that were used. For example,
35079 .code
35080 C=EHLO,QUIT
35081 .endd
35082 shows that the client issued QUIT straight after EHLO. If there were fewer
35083 than 20 commands, they are all listed. If there were more than 20 commands,
35084 the last 20 are listed, preceded by &"..."&. However, with the default
35085 setting of 10 for &%smtp_accep_max_nonmail%&, the connection will in any case
35086 have been aborted before 20 non-mail commands are processed.
35087 .next
35088 &%smtp_mailauth%&: A third subfield with the authenticated sender,
35089 colon-separated, is appended to the A= item for a message arrival or delivery
35090 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
35091 was accepted or used.
35092 .next
35093 .cindex "log" "SMTP protocol error"
35094 .cindex "SMTP" "logging protocol error"
35095 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
35096 encountered. Exim does not have perfect detection of all protocol errors
35097 because of transmission delays and the use of pipelining. If PIPELINING has
35098 been advertised to a client, an Exim server assumes that the client will use
35099 it, and therefore it does not count &"expected"& errors (for example, RCPT
35100 received after rejecting MAIL) as protocol errors.
35101 .next
35102 .cindex "SMTP" "logging syntax errors"
35103 .cindex "SMTP" "syntax errors; logging"
35104 .cindex "SMTP" "unknown command; logging"
35105 .cindex "log" "unknown SMTP command"
35106 .cindex "log" "SMTP syntax error"
35107 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
35108 encountered. An unrecognized command is treated as a syntax error. For an
35109 external connection, the host identity is given; for an internal connection
35110 using &%-bs%& the sender identification (normally the calling user) is given.
35111 .next
35112 .cindex "log" "subject"
35113 .cindex "subject, logging"
35114 &%subject%&: The subject of the message is added to the arrival log line,
35115 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
35116 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
35117 specifies whether characters with values greater than 127 should be logged
35118 unchanged, or whether they should be rendered as escape sequences.
35119 .next
35120 .cindex "log" "certificate verification"
35121 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
35122 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
35123 verified, and &`CV=no`& if not.
35124 .next
35125 .cindex "log" "TLS cipher"
35126 .cindex "TLS" "logging cipher"
35127 &%tls_cipher%&: When a message is sent or received over an encrypted
35128 connection, the cipher suite used is added to the log line, preceded by X=.
35129 .next
35130 .cindex "log" "TLS peer DN"
35131 .cindex "TLS" "logging peer DN"
35132 &%tls_peerdn%&: When a message is sent or received over an encrypted
35133 connection, and a certificate is supplied by the remote host, the peer DN is
35134 added to the log line, preceded by DN=.
35135 .next
35136 .cindex "log" "TLS SNI"
35137 .cindex "TLS" "logging SNI"
35138 &%tls_sni%&: When a message is received over an encrypted connection, and
35139 the remote host provided the Server Name Indication extension, the SNI is
35140 added to the log line, preceded by SNI=.
35141 .next
35142 .cindex "log" "DNS failure in list"
35143 &%unknown_in_list%&: This setting causes a log entry to be written when the
35144 result of a list match is failure because a DNS lookup failed.
35145 .endlist
35146
35147
35148 .section "Message log" "SECID260"
35149 .cindex "message" "log file for"
35150 .cindex "log" "message log; description of"
35151 .cindex "&_msglog_& directory"
35152 .oindex "&%preserve_message_logs%&"
35153 In addition to the general log files, Exim writes a log file for each message
35154 that it handles. The names of these per-message logs are the message ids, and
35155 they are kept in the &_msglog_& sub-directory of the spool directory. Each
35156 message log contains copies of the log lines that apply to the message. This
35157 makes it easier to inspect the status of an individual message without having
35158 to search the main log. A message log is deleted when processing of the message
35159 is complete, unless &%preserve_message_logs%& is set, but this should be used
35160 only with great care because they can fill up your disk very quickly.
35161
35162 On a heavily loaded system, it may be desirable to disable the use of
35163 per-message logs, in order to reduce disk I/O. This can be done by setting the
35164 &%message_logs%& option false.
35165 .ecindex IIDloggen
35166
35167
35168
35169
35170 . ////////////////////////////////////////////////////////////////////////////
35171 . ////////////////////////////////////////////////////////////////////////////
35172
35173 .chapter "Exim utilities" "CHAPutils"
35174 .scindex IIDutils "utilities"
35175 A number of utility scripts and programs are supplied with Exim and are
35176 described in this chapter. There is also the Exim Monitor, which is covered in
35177 the next chapter. The utilities described here are:
35178
35179 .itable none 0 0 3  7* left  15* left  40* left
35180 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
35181   "list what Exim processes are doing"
35182 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
35183 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
35184 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
35185 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
35186                                                 various criteria"
35187 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
35188 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
35189   "extract statistics from the log"
35190 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
35191   "check address acceptance from given IP"
35192 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
35193 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
35194 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
35195 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
35196 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
35197 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
35198 .endtable
35199
35200 Another utility that might be of use to sites with many MTAs is Tom Kistner's
35201 &'exilog'&. It provides log visualizations across multiple Exim servers. See
35202 &url(http://duncanthrax.net/exilog/) for details.
35203
35204
35205
35206
35207 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
35208 .cindex "&'exiwhat'&"
35209 .cindex "process, querying"
35210 .cindex "SIGUSR1"
35211 On operating systems that can restart a system call after receiving a signal
35212 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
35213 a line describing what it is doing to the file &_exim-process.info_& in the
35214 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
35215 processes it can find, having first emptied the file. It then waits for one
35216 second to allow the Exim processes to react before displaying the results. In
35217 order to run &'exiwhat'& successfully you have to have sufficient privilege to
35218 send the signal to the Exim processes, so it is normally run as root.
35219
35220 &*Warning*&: This is not an efficient process. It is intended for occasional
35221 use by system administrators. It is not sensible, for example, to set up a
35222 script that sends SIGUSR1 signals to Exim processes at short intervals.
35223
35224
35225 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
35226 varies in different operating systems. Not only are different options used,
35227 but the format of the output is different. For this reason, there are some
35228 system configuration options that configure exactly how &'exiwhat'& works. If
35229 it doesn't seem to be working for you, check the following compile-time
35230 options:
35231 .display
35232 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
35233 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
35234 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
35235 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
35236 .endd
35237 An example of typical output from &'exiwhat'& is
35238 .code
35239 164 daemon: -q1h, listening on port 25
35240 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
35241 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
35242   [10.19.42.42] (editor@ref.example)
35243 10592 handling incoming call from [192.168.243.242]
35244 10628 accepting a local non-SMTP message
35245 .endd
35246 The first number in the output line is the process number. The third line has
35247 been split here, in order to fit it on the page.
35248
35249
35250
35251 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
35252 .cindex "&'exiqgrep'&"
35253 .cindex "queue" "grepping"
35254 This utility is a Perl script contributed by Matt Hubbard. It runs
35255 .code
35256 exim -bpu
35257 .endd
35258 or (in case &*-a*& switch is specified)
35259 .code
35260 exim -bp
35261 .endd
35262 The &*-C*& option is used to specify an alternate &_exim.conf_& which might
35263 contain alternate exim configuration the queue management might be using.
35264
35265 to obtain a queue listing, and then greps the output to select messages 
35266 that match given criteria. The following selection options are available:
35267
35268 .vlist
35269 .vitem &*-f*&&~<&'regex'&>
35270 Match the sender address using a case-insensitive search. The field that is
35271 tested is enclosed in angle brackets, so you can test for bounce messages with
35272 .code
35273 exiqgrep -f '^<>$'
35274 .endd
35275 .vitem &*-r*&&~<&'regex'&>
35276 Match a recipient address using a case-insensitve search. The field that is
35277 tested is not enclosed in angle brackets.
35278
35279 .vitem &*-s*&&~<&'regex'&>
35280 Match against the size field.
35281
35282 .vitem &*-y*&&~<&'seconds'&>
35283 Match messages that are younger than the given time.
35284
35285 .vitem &*-o*&&~<&'seconds'&>
35286 Match messages that are older than the given time.
35287
35288 .vitem &*-z*&
35289 Match only frozen messages.
35290
35291 .vitem &*-x*&
35292 Match only non-frozen messages.
35293 .endlist
35294
35295 The following options control the format of the output:
35296
35297 .vlist
35298 .vitem &*-c*&
35299 Display only the count of matching messages.
35300
35301 .vitem &*-l*&
35302 Long format &-- display the full message information as output by Exim. This is
35303 the default.
35304
35305 .vitem &*-i*&
35306 Display message ids only.
35307
35308 .vitem &*-b*&
35309 Brief format &-- one line per message.
35310
35311 .vitem &*-R*&
35312 Display messages in reverse order.
35313
35314 .vitem &*-a*&
35315 Include delivered recipients in queue listing.
35316 .endlist
35317
35318 There is one more option, &%-h%&, which outputs a list of options.
35319
35320
35321
35322 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
35323 .cindex "&'exiqsumm'&"
35324 .cindex "queue" "summary"
35325 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
35326 -bp`& and produces a summary of the messages on the queue. Thus, you use it by
35327 running a command such as
35328 .code
35329 exim -bp | exiqsumm
35330 .endd
35331 The output consists of one line for each domain that has messages waiting for
35332 it, as in the following example:
35333 .code
35334 3   2322   74m   66m  msn.com.example
35335 .endd
35336 Each line lists the number of pending deliveries for a domain, their total
35337 volume, and the length of time that the oldest and the newest messages have
35338 been waiting. Note that the number of pending deliveries is greater than the
35339 number of messages when messages have more than one recipient.
35340
35341 A summary line is output at the end. By default the output is sorted on the
35342 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
35343 the output to be sorted by oldest message and by count of messages,
35344 respectively. There are also three options that split the messages for each
35345 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
35346 separates frozen messages, and &%-s%& separates messages according to their
35347 sender.
35348
35349 The output of &'exim -bp'& contains the original addresses in the message, so
35350 this also applies to the output from &'exiqsumm'&. No domains from addresses
35351 generated by aliasing or forwarding are included (unless the &%one_time%&
35352 option of the &(redirect)& router has been used to convert them into &"top
35353 level"& addresses).
35354
35355
35356
35357
35358 .section "Extracting specific information from the log (exigrep)" &&&
35359          "SECTextspeinf"
35360 .cindex "&'exigrep'&"
35361 .cindex "log" "extracts; grepping for"
35362 The &'exigrep'& utility is a Perl script that searches one or more main log
35363 files for entries that match a given pattern. When it finds a match, it
35364 extracts all the log entries for the relevant message, not just those that
35365 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
35366 given message, or all mail for a given user, or for a given host, for example.
35367 The input files can be in Exim log format or syslog format.
35368 If a matching log line is not associated with a specific message, it is
35369 included in &'exigrep'&'s output without any additional lines. The usage is:
35370 .display
35371 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-M] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
35372 .endd
35373 If no log file names are given on the command line, the standard input is read.
35374
35375 The &%-t%& argument specifies a number of seconds. It adds an additional
35376 condition for message selection. Messages that are complete are shown only if
35377 they spent more than <&'n'&> seconds on the queue.
35378
35379 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
35380 makes it case-sensitive. This may give a performance improvement when searching
35381 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
35382 option; with &%-I%& they do not. In both cases it is possible to change the
35383 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
35384
35385 The &%-l%& option means &"literal"&, that is, treat all characters in the
35386 pattern as standing for themselves. Otherwise the pattern must be a Perl
35387 regular expression.
35388
35389 The &%-v%& option inverts the matching condition. That is, a line is selected
35390 if it does &'not'& match the pattern.
35391
35392 The &%-M%& options means &"related messages"&. &'exigrep'& will show messages
35393 that are generated as a result/response to a message that &'exigrep'& matched
35394 normally.
35395
35396 Example of &%-M%&:
35397 user_a sends a message to user_b, which generates a bounce back to user_b. If
35398 &'exigrep'& is used to search for &"user_a"&, only the first message will be
35399 displayed.  But if &'exigrep'& is used to search for &"user_b"&, the first and
35400 the second (bounce) message will be displayed. Using &%-M%& with &'exigrep'&
35401 when searching for &"user_a"& will show both messages since the bounce is
35402 &"related"& to or a &"result"& of the first message that was found by the
35403 search term.
35404
35405 If the location of a &'zcat'& command is known from the definition of
35406 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
35407 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
35408
35409
35410 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
35411 .cindex "&'exipick'&"
35412 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
35413 lists messages from the queue according to a variety of criteria. For details
35414 of &'exipick'&'s facilities, visit the web page at
35415 &url(http://www.exim.org/eximwiki/ToolExipickManPage) or run &'exipick'& with
35416 the &%--help%& option.
35417
35418
35419 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
35420 .cindex "log" "cycling local files"
35421 .cindex "cycling logs"
35422 .cindex "&'exicyclog'&"
35423 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
35424 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
35425 you are using log files with datestamps in their names (see section
35426 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
35427 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
35428 There are two command line options for &'exicyclog'&:
35429 .ilist
35430 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
35431 default that is set when Exim is built. The default default is 10.
35432 .next
35433 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
35434 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
35435 overriding the script's default, which is to find the setting from Exim's
35436 configuration.
35437 .endlist
35438
35439 Each time &'exicyclog'& is run the file names get &"shuffled down"& by one. If
35440 the main log file name is &_mainlog_& (the default) then when &'exicyclog'& is
35441 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
35442 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
35443 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
35444 logs are handled similarly.
35445
35446 If the limit is greater than 99, the script uses 3-digit numbers such as
35447 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
35448 to one that is greater, or &'vice versa'&, you will have to fix the names of
35449 any existing log files.
35450
35451 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
35452 the end are deleted. All files with numbers greater than 01 are compressed,
35453 using a compression command which is configured by the COMPRESS_COMMAND
35454 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
35455 root &%crontab%& entry of the form
35456 .code
35457 1 0 * * * su exim -c /usr/exim/bin/exicyclog
35458 .endd
35459 assuming you have used the name &"exim"& for the Exim user. You can run
35460 &'exicyclog'& as root if you wish, but there is no need.
35461
35462
35463
35464 .section "Mail statistics (eximstats)" "SECTmailstat"
35465 .cindex "statistics"
35466 .cindex "&'eximstats'&"
35467 A Perl script called &'eximstats'& is provided for extracting statistical
35468 information from log files. The output is either plain text, or HTML.
35469 Exim log files are also supported by the &'Lire'& system produced by the
35470 LogReport Foundation &url(http://www.logreport.org).
35471
35472 The &'eximstats'& script has been hacked about quite a bit over time. The
35473 latest version is the result of some extensive revision by Steve Campbell. A
35474 lot of information is given by default, but there are options for suppressing
35475 various parts of it. Following any options, the arguments to the script are a
35476 list of files, which should be main log files. For example:
35477 .code
35478 eximstats -nr /var/spool/exim/log/mainlog.01
35479 .endd
35480 By default, &'eximstats'& extracts information about the number and volume of
35481 messages received from or delivered to various hosts. The information is sorted
35482 both by message count and by volume, and the top fifty hosts in each category
35483 are listed on the standard output. Similar information, based on email
35484 addresses or domains instead of hosts can be requested by means of various
35485 options. For messages delivered and received locally, similar statistics are
35486 also produced per user.
35487
35488 The output also includes total counts and statistics about delivery errors, and
35489 histograms showing the number of messages received and deliveries made in each
35490 hour of the day. A delivery with more than one address in its envelope (for
35491 example, an SMTP transaction with more than one RCPT command) is counted
35492 as a single delivery by &'eximstats'&.
35493
35494 Though normally more deliveries than receipts are reported (as messages may
35495 have multiple recipients), it is possible for &'eximstats'& to report more
35496 messages received than delivered, even though the queue is empty at the start
35497 and end of the period in question. If an incoming message contains no valid
35498 recipients, no deliveries are recorded for it. A bounce message is handled as
35499 an entirely separate message.
35500
35501 &'eximstats'& always outputs a grand total summary giving the volume and number
35502 of messages received and deliveries made, and the number of hosts involved in
35503 each case. It also outputs the number of messages that were delayed (that is,
35504 not completely delivered at the first attempt), and the number that had at
35505 least one address that failed.
35506
35507 The remainder of the output is in sections that can be independently disabled
35508 or modified by various options. It consists of a summary of deliveries by
35509 transport, histograms of messages received and delivered per time interval
35510 (default per hour), information about the time messages spent on the queue,
35511 a list of relayed messages, lists of the top fifty sending hosts, local
35512 senders, destination hosts, and destination local users by count and by volume,
35513 and a list of delivery errors that occurred.
35514
35515 The relay information lists messages that were actually relayed, that is, they
35516 came from a remote host and were directly delivered to some other remote host,
35517 without being processed (for example, for aliasing or forwarding) locally.
35518
35519 There are quite a few options for &'eximstats'& to control exactly what it
35520 outputs. These are documented in the Perl script itself, and can be extracted
35521 by running the command &(perldoc)& on the script. For example:
35522 .code
35523 perldoc /usr/exim/bin/eximstats
35524 .endd
35525
35526 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
35527 .cindex "&'exim_checkaccess'&"
35528 .cindex "policy control" "checking access"
35529 .cindex "checking access"
35530 The &%-bh%& command line argument allows you to run a fake SMTP session with
35531 debugging output, in order to check what Exim is doing when it is applying
35532 policy controls to incoming SMTP mail. However, not everybody is sufficiently
35533 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
35534 sometimes you just want to answer the question &"Does this address have
35535 access?"& without bothering with any further details.
35536
35537 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
35538 two arguments, an IP address and an email address:
35539 .code
35540 exim_checkaccess 10.9.8.7 A.User@a.domain.example
35541 .endd
35542 The utility runs a call to Exim with the &%-bh%& option, to test whether the
35543 given email address would be accepted in a RCPT command in a TCP/IP
35544 connection from the host with the given IP address. The output of the utility
35545 is either the word &"accepted"&, or the SMTP error response, for example:
35546 .code
35547 Rejected:
35548 550 Relay not permitted
35549 .endd
35550 When running this test, the utility uses &`<>`& as the envelope sender address
35551 for the MAIL command, but you can change this by providing additional
35552 options. These are passed directly to the Exim command. For example, to specify
35553 that the test is to be run with the sender address &'himself@there.example'&
35554 you can use:
35555 .code
35556 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
35557                  -f himself@there.example
35558 .endd
35559 Note that these additional Exim command line items must be given after the two
35560 mandatory arguments.
35561
35562 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
35563 while running its checks. You can run checks that include callouts by using
35564 &%-bhc%&, but this is not yet available in a &"packaged"& form.
35565
35566
35567
35568 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
35569 .cindex "DBM" "building dbm files"
35570 .cindex "building DBM files"
35571 .cindex "&'exim_dbmbuild'&"
35572 .cindex "lower casing"
35573 .cindex "binary zero" "in lookup key"
35574 The &'exim_dbmbuild'& program reads an input file containing keys and data in
35575 the format used by the &(lsearch)& lookup (see section
35576 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
35577 names as keys and the remainder of the information as data. The lower-casing
35578 can be prevented by calling the program with the &%-nolc%& option.
35579
35580 A terminating zero is included as part of the key string. This is expected by
35581 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
35582 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
35583 strings or the data strings. The &(dbmnz)& lookup type can be used with such
35584 files.
35585
35586 The program requires two arguments: the name of the input file (which can be a
35587 single hyphen to indicate the standard input), and the name of the output file.
35588 It creates the output under a temporary name, and then renames it if all went
35589 well.
35590
35591 .cindex "USE_DB"
35592 If the native DB interface is in use (USE_DB is set in a compile-time
35593 configuration file &-- this is common in free versions of Unix) the two file
35594 names must be different, because in this mode the Berkeley DB functions create
35595 a single output file using exactly the name given. For example,
35596 .code
35597 exim_dbmbuild /etc/aliases /etc/aliases.db
35598 .endd
35599 reads the system alias file and creates a DBM version of it in
35600 &_/etc/aliases.db_&.
35601
35602 In systems that use the &'ndbm'& routines (mostly proprietary versions of
35603 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
35604 environment, the suffixes are added to the second argument of
35605 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
35606 when the Berkeley functions are used in compatibility mode (though this is not
35607 recommended), because in that case it adds a &_.db_& suffix to the file name.
35608
35609 If a duplicate key is encountered, the program outputs a warning, and when it
35610 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
35611 option is used. By default, only the first of a set of duplicates is used &--
35612 this makes it compatible with &(lsearch)& lookups. There is an option
35613 &%-lastdup%& which causes it to use the data for the last duplicate instead.
35614 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
35615 &%stderr%&. For other errors, where it doesn't actually make a new file, the
35616 return code is 2.
35617
35618
35619
35620
35621 .section "Finding individual retry times (exinext)" "SECTfinindret"
35622 .cindex "retry" "times"
35623 .cindex "&'exinext'&"
35624 A utility called &'exinext'& (mostly a Perl script) provides the ability to
35625 fish specific information out of the retry database. Given a mail domain (or a
35626 complete address), it looks up the hosts for that domain, and outputs any retry
35627 information for the hosts or for the domain. At present, the retry information
35628 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
35629 output. For example:
35630 .code
35631 $ exinext piglet@milne.fict.example
35632 kanga.milne.example:192.168.8.1 error 146: Connection refused
35633   first failed: 21-Feb-1996 14:57:34
35634   last tried:   21-Feb-1996 14:57:34
35635   next try at:  21-Feb-1996 15:02:34
35636 roo.milne.example:192.168.8.3 error 146: Connection refused
35637   first failed: 20-Jan-1996 13:12:08
35638   last tried:   21-Feb-1996 11:42:03
35639   next try at:  21-Feb-1996 19:42:03
35640   past final cutoff time
35641 .endd
35642 You can also give &'exinext'& a local part, without a domain, and it
35643 will give any retry information for that local part in your default domain.
35644 A message id can be used to obtain retry information pertaining to a specific
35645 message. This exists only when an attempt to deliver a message to a remote host
35646 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
35647 &'exinext'& is not particularly efficient, but then it is not expected to be
35648 run very often.
35649
35650 The &'exinext'& utility calls Exim to find out information such as the location
35651 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
35652 passed on to the &'exim'& commands. The first specifies an alternate Exim
35653 configuration file, and the second sets macros for use within the configuration
35654 file. These features are mainly to help in testing, but might also be useful in
35655 environments where more than one configuration file is in use.
35656
35657
35658
35659 .section "Hints database maintenance" "SECThindatmai"
35660 .cindex "hints database" "maintenance"
35661 .cindex "maintaining Exim's hints database"
35662 Three utility programs are provided for maintaining the DBM files that Exim
35663 uses to contain its delivery hint information. Each program requires two
35664 arguments. The first specifies the name of Exim's spool directory, and the
35665 second is the name of the database it is to operate on. These are as follows:
35666
35667 .ilist
35668 &'retry'&: the database of retry information
35669 .next
35670 &'wait-'&<&'transport name'&>: databases of information about messages waiting
35671 for remote hosts
35672 .next
35673 &'callout'&: the callout cache
35674 .next
35675 &'ratelimit'&: the data for implementing the ratelimit ACL condition
35676 .next
35677 &'misc'&: other hints data
35678 .endlist
35679
35680 The &'misc'& database is used for
35681
35682 .ilist
35683 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
35684 .next
35685 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
35686 &(smtp)& transport)
35687 .endlist
35688
35689
35690
35691 .section "exim_dumpdb" "SECID261"
35692 .cindex "&'exim_dumpdb'&"
35693 The entire contents of a database are written to the standard output by the
35694 &'exim_dumpdb'& program, which has no options or arguments other than the
35695 spool and database names. For example, to dump the retry database:
35696 .code
35697 exim_dumpdb /var/spool/exim retry
35698 .endd
35699 Two lines of output are produced for each entry:
35700 .code
35701 T:mail.ref.example:192.168.242.242 146 77 Connection refused
35702 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
35703 .endd
35704 The first item on the first line is the key of the record. It starts with one
35705 of the letters R, or T, depending on whether it refers to a routing or
35706 transport retry. For a local delivery, the next part is the local address; for
35707 a remote delivery it is the name of the remote host, followed by its failing IP
35708 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
35709 transport). If the remote port is not the standard one (port 25), it is added
35710 to the IP address. Then there follows an error code, an additional error code,
35711 and a textual description of the error.
35712
35713 The three times on the second line are the time of first failure, the time of
35714 the last delivery attempt, and the computed time for the next attempt. The line
35715 ends with an asterisk if the cutoff time for the last retry rule has been
35716 exceeded.
35717
35718 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
35719 consists of a host name followed by a list of ids for messages that are or were
35720 waiting to be delivered to that host. If there are a very large number for any
35721 one host, continuation records, with a sequence number added to the host name,
35722 may be seen. The data in these records is often out of date, because a message
35723 may be routed to several alternative hosts, and Exim makes no effort to keep
35724 cross-references.
35725
35726
35727
35728 .section "exim_tidydb" "SECID262"
35729 .cindex "&'exim_tidydb'&"
35730 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
35731 database. If run with no options, it removes all records that are more than 30
35732 days old. The age is calculated from the date and time that the record was last
35733 updated. Note that, in the case of the retry database, it is &'not'& the time
35734 since the first delivery failure. Information about a host that has been down
35735 for more than 30 days will remain in the database, provided that the record is
35736 updated sufficiently often.
35737
35738 The cutoff date can be altered by means of the &%-t%& option, which must be
35739 followed by a time. For example, to remove all records older than a week from
35740 the retry database:
35741 .code
35742 exim_tidydb -t 7d /var/spool/exim retry
35743 .endd
35744 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
35745 message ids. In the former these appear as data in records keyed by host &--
35746 they were messages that were waiting for that host &-- and in the latter they
35747 are the keys for retry information for messages that have suffered certain
35748 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
35749 message ids in database records are those of messages that are still on the
35750 queue. Message ids for messages that no longer exist are removed from
35751 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
35752 For the &'retry'& database, records whose keys are non-existent message ids are
35753 removed. The &'exim_tidydb'& utility outputs comments on the standard output
35754 whenever it removes information from the database.
35755
35756 Certain records are automatically removed by Exim when they are no longer
35757 needed, but others are not. For example, if all the MX hosts for a domain are
35758 down, a retry record is created for each one. If the primary MX host comes back
35759 first, its record is removed when Exim successfully delivers to it, but the
35760 records for the others remain because Exim has not tried to use those hosts.
35761
35762 It is important, therefore, to run &'exim_tidydb'& periodically on all the
35763 hints databases. You should do this at a quiet time of day, because it requires
35764 a database to be locked (and therefore inaccessible to Exim) while it does its
35765 work. Removing records from a DBM file does not normally make the file smaller,
35766 but all the common DBM libraries are able to re-use the space that is released.
35767 After an initial phase of increasing in size, the databases normally reach a
35768 point at which they no longer get any bigger, as long as they are regularly
35769 tidied.
35770
35771 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
35772 databases is likely to keep on increasing.
35773
35774
35775
35776
35777 .section "exim_fixdb" "SECID263"
35778 .cindex "&'exim_fixdb'&"
35779 The &'exim_fixdb'& program is a utility for interactively modifying databases.
35780 Its main use is for testing Exim, but it might also be occasionally useful for
35781 getting round problems in a live system. It has no options, and its interface
35782 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
35783 key of a database record can then be entered, and the data for that record is
35784 displayed.
35785
35786 If &"d"& is typed at the next prompt, the entire record is deleted. For all
35787 except the &'retry'& database, that is the only operation that can be carried
35788 out. For the &'retry'& database, each field is output preceded by a number, and
35789 data for individual fields can be changed by typing the field number followed
35790 by new data, for example:
35791 .code
35792 > 4 951102:1000
35793 .endd
35794 resets the time of the next delivery attempt. Time values are given as a
35795 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
35796 used as optional separators.
35797
35798
35799
35800
35801 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
35802 .cindex "mailbox" "maintenance"
35803 .cindex "&'exim_lock'&"
35804 .cindex "locking mailboxes"
35805 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
35806 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
35807 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
35808 a user agent while investigating a problem. The utility requires the name of
35809 the file as its first argument. If the locking is successful, the second
35810 argument is run as a command (using C's &[system()]& function); if there is no
35811 second argument, the value of the SHELL environment variable is used; if this
35812 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
35813 is unlocked and the utility ends. The following options are available:
35814
35815 .vlist
35816 .vitem &%-fcntl%&
35817 Use &[fcntl()]& locking on the open mailbox.
35818
35819 .vitem &%-flock%&
35820 Use &[flock()]& locking on the open mailbox, provided the operating system
35821 supports it.
35822
35823 .vitem &%-interval%&
35824 This must be followed by a number, which is a number of seconds; it sets the
35825 interval to sleep between retries (default 3).
35826
35827 .vitem &%-lockfile%&
35828 Create a lock file before opening the mailbox.
35829
35830 .vitem &%-mbx%&
35831 Lock the mailbox using MBX rules.
35832
35833 .vitem &%-q%&
35834 Suppress verification output.
35835
35836 .vitem &%-retries%&
35837 This must be followed by a number; it sets the number of times to try to get
35838 the lock (default 10).
35839
35840 .vitem &%-restore_time%&
35841 This option causes &%exim_lock%& to restore the modified and read times to the
35842 locked file before exiting. This allows you to access a locked mailbox (for
35843 example, to take a backup copy) without disturbing the times that the user
35844 subsequently sees.
35845
35846 .vitem &%-timeout%&
35847 This must be followed by a number, which is a number of seconds; it sets a
35848 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
35849 default), a non-blocking call is used.
35850
35851 .vitem &%-v%&
35852 Generate verbose output.
35853 .endlist
35854
35855 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
35856 default is to create a lock file and also to use &[fcntl()]& locking on the
35857 mailbox, which is the same as Exim's default. The use of &%-flock%& or
35858 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
35859 requires that the directory containing the file be writeable. Locking by lock
35860 file does not last for ever; Exim assumes that a lock file is expired if it is
35861 more than 30 minutes old.
35862
35863 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
35864 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
35865 to be taken out on the open mailbox, and an exclusive lock on the file
35866 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
35867 number of the mailbox file. When the locking is released, if an exclusive lock
35868 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
35869
35870 The default output contains verification of the locking that takes place. The
35871 &%-v%& option causes some additional information to be given. The &%-q%& option
35872 suppresses all output except error messages.
35873
35874 A command such as
35875 .code
35876 exim_lock /var/spool/mail/spqr
35877 .endd
35878 runs an interactive shell while the file is locked, whereas
35879 .display
35880 &`exim_lock -q /var/spool/mail/spqr <<End`&
35881 <&'some commands'&>
35882 &`End`&
35883 .endd
35884 runs a specific non-interactive sequence of commands while the file is locked,
35885 suppressing all verification output. A single command can be run by a command
35886 such as
35887 .code
35888 exim_lock -q /var/spool/mail/spqr \
35889   "cp /var/spool/mail/spqr /some/where"
35890 .endd
35891 Note that if a command is supplied, it must be entirely contained within the
35892 second argument &-- hence the quotes.
35893 .ecindex IIDutils
35894
35895
35896 . ////////////////////////////////////////////////////////////////////////////
35897 . ////////////////////////////////////////////////////////////////////////////
35898
35899 .chapter "The Exim monitor" "CHAPeximon"
35900 .scindex IIDeximon "Exim monitor" "description"
35901 .cindex "X-windows"
35902 .cindex "&'eximon'&"
35903 .cindex "Local/eximon.conf"
35904 .cindex "&_exim_monitor/EDITME_&"
35905 The Exim monitor is an application which displays in an X window information
35906 about the state of Exim's queue and what Exim is doing. An admin user can
35907 perform certain operations on messages from this GUI interface; however all
35908 such facilities are also available from the command line, and indeed, the
35909 monitor itself makes use of the command line to perform any actions requested.
35910
35911
35912
35913 .section "Running the monitor" "SECID264"
35914 The monitor is started by running the script called &'eximon'&. This is a shell
35915 script that sets up a number of environment variables, and then runs the
35916 binary called &_eximon.bin_&. The default appearance of the monitor window can
35917 be changed by editing the &_Local/eximon.conf_& file created by editing
35918 &_exim_monitor/EDITME_&. Comments in that file describe what the various
35919 parameters are for.
35920
35921 The parameters that get built into the &'eximon'& script can be overridden for
35922 a particular invocation by setting up environment variables of the same names,
35923 preceded by &`EXIMON_`&. For example, a shell command such as
35924 .code
35925 EXIMON_LOG_DEPTH=400 eximon
35926 .endd
35927 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
35928 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
35929 overrides the Exim log file configuration. This makes it possible to have
35930 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
35931 syslog messages are routed to a file on the local host.
35932
35933 X resources can be used to change the appearance of the window in the normal
35934 way. For example, a resource setting of the form
35935 .code
35936 Eximon*background: gray94
35937 .endd
35938 changes the colour of the background to light grey rather than white. The
35939 stripcharts are drawn with both the data lines and the reference lines in
35940 black. This means that the reference lines are not visible when on top of the
35941 data. However, their colour can be changed by setting a resource called
35942 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
35943 For example, if your X server is running Unix, you could set up lighter
35944 reference lines in the stripcharts by obeying
35945 .code
35946 xrdb -merge <<End
35947 Eximon*highlight: gray
35948 End
35949 .endd
35950 .cindex "admin user"
35951 In order to see the contents of messages on the queue, and to operate on them,
35952 &'eximon'& must either be run as root or by an admin user.
35953
35954 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
35955 contain X11 resource parameters interpreted by the X11 library.  In addition,
35956 if the first parameter starts with the string "gdb" then it is removed and the
35957 binary is invoked under gdb (the parameter is used as the gdb command-name, so
35958 versioned variants of gdb can be invoked).
35959
35960 The monitor's window is divided into three parts. The first contains one or
35961 more stripcharts and two action buttons, the second contains a &"tail"& of the
35962 main log file, and the third is a display of the queue of messages awaiting
35963 delivery, with two more action buttons. The following sections describe these
35964 different parts of the display.
35965
35966
35967
35968
35969 .section "The stripcharts" "SECID265"
35970 .cindex "stripchart"
35971 The first stripchart is always a count of messages on the queue. Its name can
35972 be configured by setting QUEUE_STRIPCHART_NAME in the
35973 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
35974 configuration script by regular expression matches on log file entries, making
35975 it possible to display, for example, counts of messages delivered to certain
35976 hosts or using certain transports. The supplied defaults display counts of
35977 received and delivered messages, and of local and SMTP deliveries. The default
35978 period between stripchart updates is one minute; this can be adjusted by a
35979 parameter in the &_Local/eximon.conf_& file.
35980
35981 The stripchart displays rescale themselves automatically as the value they are
35982 displaying changes. There are always 10 horizontal lines in each chart; the
35983 title string indicates the value of each division when it is greater than one.
35984 For example, &"x2"& means that each division represents a value of 2.
35985
35986 It is also possible to have a stripchart which shows the percentage fullness of
35987 a particular disk partition, which is useful when local deliveries are confined
35988 to a single partition.
35989
35990 .cindex "&%statvfs%& function"
35991 This relies on the availability of the &[statvfs()]& function or equivalent in
35992 the operating system. Most, but not all versions of Unix that support Exim have
35993 this. For this particular stripchart, the top of the chart always represents
35994 100%, and the scale is given as &"x10%"&. This chart is configured by setting
35995 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
35996 &_Local/eximon.conf_& file.
35997
35998
35999
36000
36001 .section "Main action buttons" "SECID266"
36002 .cindex "size" "of monitor window"
36003 .cindex "Exim monitor" "window size"
36004 .cindex "window size"
36005 Below the stripcharts there is an action button for quitting the monitor. Next
36006 to this is another button marked &"Size"&. They are placed here so that
36007 shrinking the window to its default minimum size leaves just the queue count
36008 stripchart and these two buttons visible. Pressing the &"Size"& button causes
36009 the window to expand to its maximum size, unless it is already at the maximum,
36010 in which case it is reduced to its minimum.
36011
36012 When expanding to the maximum, if the window cannot be fully seen where it
36013 currently is, it is moved back to where it was the last time it was at full
36014 size. When it is expanding from its minimum size, the old position is
36015 remembered, and next time it is reduced to the minimum it is moved back there.
36016
36017 The idea is that you can keep a reduced window just showing one or two
36018 stripcharts at a convenient place on your screen, easily expand it to show
36019 the full window when required, and just as easily put it back to what it was.
36020 The idea is copied from what the &'twm'& window manager does for its
36021 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
36022 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
36023
36024 Normally, the monitor starts up with the window at its full size, but it can be
36025 built so that it starts up with the window at its smallest size, by setting
36026 START_SMALL=yes in &_Local/eximon.conf_&.
36027
36028
36029
36030 .section "The log display" "SECID267"
36031 .cindex "log" "tail of; in monitor"
36032 The second section of the window is an area in which a display of the tail of
36033 the main log is maintained.
36034 To save space on the screen, the timestamp on each log line is shortened by
36035 removing the date and, if &%log_timezone%& is set, the timezone.
36036 The log tail is not available when the only destination for logging data is
36037 syslog, unless the syslog lines are routed to a local file whose name is passed
36038 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
36039
36040 The log sub-window has a scroll bar at its lefthand side which can be used to
36041 move back to look at earlier text, and the up and down arrow keys also have a
36042 scrolling effect. The amount of log that is kept depends on the setting of
36043 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
36044 to use. When this is full, the earlier 50% of data is discarded &-- this is
36045 much more efficient than throwing it away line by line. The sub-window also has
36046 a horizontal scroll bar for accessing the ends of long log lines. This is the
36047 only means of horizontal scrolling; the right and left arrow keys are not
36048 available. Text can be cut from this part of the window using the mouse in the
36049 normal way. The size of this subwindow is controlled by parameters in the
36050 configuration file &_Local/eximon.conf_&.
36051
36052 Searches of the text in the log window can be carried out by means of the ^R
36053 and ^S keystrokes, which default to a reverse and a forward search,
36054 respectively. The search covers only the text that is displayed in the window.
36055 It cannot go further back up the log.
36056
36057 The point from which the search starts is indicated by a caret marker. This is
36058 normally at the end of the text in the window, but can be positioned explicitly
36059 by pointing and clicking with the left mouse button, and is moved automatically
36060 by a successful search. If new text arrives in the window when it is scrolled
36061 back, the caret remains where it is, but if the window is not scrolled back,
36062 the caret is moved to the end of the new text.
36063
36064 Pressing ^R or ^S pops up a window into which the search text can be typed.
36065 There are buttons for selecting forward or reverse searching, for carrying out
36066 the search, and for cancelling. If the &"Search"& button is pressed, the search
36067 happens and the window remains so that further searches can be done. If the
36068 &"Return"& key is pressed, a single search is done and the window is closed. If
36069 ^C is typed the search is cancelled.
36070
36071 The searching facility is implemented using the facilities of the Athena text
36072 widget. By default this pops up a window containing both &"search"& and
36073 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
36074 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
36075 However, the linkers in BSDI and HP-UX seem unable to handle an externally
36076 provided version of &%TextPop%& when the remaining parts of the text widget
36077 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
36078 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
36079 on these systems, at the expense of having unwanted items in the search popup
36080 window.
36081
36082
36083
36084 .section "The queue display" "SECID268"
36085 .cindex "queue" "display in monitor"
36086 The bottom section of the monitor window contains a list of all messages that
36087 are on the queue, which includes those currently being received or delivered,
36088 as well as those awaiting delivery. The size of this subwindow is controlled by
36089 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
36090 at which it is updated is controlled by another parameter in the same file &--
36091 the default is 5 minutes, since queue scans can be quite expensive. However,
36092 there is an &"Update"& action button just above the display which can be used
36093 to force an update of the queue display at any time.
36094
36095 When a host is down for some time, a lot of pending mail can build up for it,
36096 and this can make it hard to deal with other messages on the queue. To help
36097 with this situation there is a button next to &"Update"& called &"Hide"&. If
36098 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
36099 type anything in here and press &"Return"&, the text is added to a chain of
36100 such texts, and if every undelivered address in a message matches at least one
36101 of the texts, the message is not displayed.
36102
36103 If there is an address that does not match any of the texts, all the addresses
36104 are displayed as normal. The matching happens on the ends of addresses so, for
36105 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
36106 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
36107 has been set up, a button called &"Unhide"& is displayed. If pressed, it
36108 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
36109 a hide request is automatically cancelled after one hour.
36110
36111 While the dialogue box is displayed, you can't press any buttons or do anything
36112 else to the monitor window. For this reason, if you want to cut text from the
36113 queue display to use in the dialogue box, you have to do the cutting before
36114 pressing the &"Hide"& button.
36115
36116 The queue display contains, for each unhidden queued message, the length of
36117 time it has been on the queue, the size of the message, the message id, the
36118 message sender, and the first undelivered recipient, all on one line. If it is
36119 a bounce message, the sender is shown as &"<>"&. If there is more than one
36120 recipient to which the message has not yet been delivered, subsequent ones are
36121 listed on additional lines, up to a maximum configured number, following which
36122 an ellipsis is displayed. Recipients that have already received the message are
36123 not shown.
36124
36125 .cindex "frozen messages" "display"
36126 If a message is frozen, an asterisk is displayed at the left-hand side.
36127
36128 The queue display has a vertical scroll bar, and can also be scrolled by means
36129 of the arrow keys. Text can be cut from it using the mouse in the normal way.
36130 The text searching facilities, as described above for the log window, are also
36131 available, but the caret is always moved to the end of the text when the queue
36132 display is updated.
36133
36134
36135
36136 .section "The queue menu" "SECID269"
36137 .cindex "queue" "menu in monitor"
36138 If the &%shift%& key is held down and the left button is clicked when the mouse
36139 pointer is over the text for any message, an action menu pops up, and the first
36140 line of the queue display for the message is highlighted. This does not affect
36141 any selected text.
36142
36143 If you want to use some other event for popping up the menu, you can set the
36144 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
36145 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
36146 value set in this parameter is a standard X event description. For example, to
36147 run eximon using &%ctrl%& rather than &%shift%& you could use
36148 .code
36149 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
36150 .endd
36151 The title of the menu is the message id, and it contains entries which act as
36152 follows:
36153
36154 .ilist
36155 &'message log'&: The contents of the message log for the message are displayed
36156 in a new text window.
36157 .next
36158 &'headers'&: Information from the spool file that contains the envelope
36159 information and headers is displayed in a new text window. See chapter
36160 &<<CHAPspool>>& for a description of the format of spool files.
36161 .next
36162 &'body'&: The contents of the spool file containing the body of the message are
36163 displayed in a new text window. There is a default limit of 20,000 bytes to the
36164 amount of data displayed. This can be changed by setting the BODY_MAX
36165 option at compile time, or the EXIMON_BODY_MAX option at run time.
36166 .next
36167 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
36168 delivery of the message. This causes an automatic thaw if the message is
36169 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
36170 a new text window. The delivery is run in a separate process, to avoid holding
36171 up the monitor while the delivery proceeds.
36172 .next
36173 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
36174 that the message be frozen.
36175 .next
36176 .cindex "thawing messages"
36177 .cindex "unfreezing messages"
36178 .cindex "frozen messages" "thawing"
36179 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
36180 that the message be thawed.
36181 .next
36182 .cindex "delivery" "forcing failure"
36183 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
36184 that Exim gives up trying to deliver the message. A bounce message is generated
36185 for any remaining undelivered addresses.
36186 .next
36187 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
36188 that the message be deleted from the system without generating a bounce
36189 message.
36190 .next
36191 &'add recipient'&: A dialog box is displayed into which a recipient address can
36192 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
36193 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
36194 Otherwise it must be entered as a fully qualified address. Pressing RETURN
36195 causes a call to Exim to be made using the &%-Mar%& option to request that an
36196 additional recipient be added to the message, unless the entry box is empty, in
36197 which case no action is taken.
36198 .next
36199 &'mark delivered'&: A dialog box is displayed into which a recipient address
36200 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
36201 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
36202 Otherwise it must be entered as a fully qualified address. Pressing RETURN
36203 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
36204 recipient address as already delivered, unless the entry box is empty, in which
36205 case no action is taken.
36206 .next
36207 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
36208 mark all recipient addresses as already delivered.
36209 .next
36210 &'edit sender'&: A dialog box is displayed initialized with the current
36211 sender's address. Pressing RETURN causes a call to Exim to be made using the
36212 &%-Mes%& option to replace the sender address, unless the entry box is empty,
36213 in which case no action is taken. If you want to set an empty sender (as in
36214 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
36215 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
36216 the address is qualified with that domain.
36217 .endlist
36218
36219 When a delivery is forced, a window showing the &%-v%& output is displayed. In
36220 other cases when a call to Exim is made, if there is any output from Exim (in
36221 particular, if the command fails) a window containing the command and the
36222 output is displayed. Otherwise, the results of the action are normally apparent
36223 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
36224 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
36225 if no output is generated.
36226
36227 The queue display is automatically updated for actions such as freezing and
36228 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
36229 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
36230 force an update of the display after one of these actions.
36231
36232 In any text window that is displayed as result of a menu action, the normal
36233 cut-and-paste facility is available, and searching can be carried out using ^R
36234 and ^S, as described above for the log tail window.
36235 .ecindex IIDeximon
36236
36237
36238
36239
36240
36241 . ////////////////////////////////////////////////////////////////////////////
36242 . ////////////////////////////////////////////////////////////////////////////
36243
36244 .chapter "Security considerations" "CHAPsecurity"
36245 .scindex IIDsecurcon "security" "discussion of"
36246 This chapter discusses a number of issues concerned with security, some of
36247 which are also covered in other parts of this manual.
36248
36249 For reasons that this author does not understand, some people have promoted
36250 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
36251 existence of this chapter in the documentation. However, the intent of the
36252 chapter is simply to describe the way Exim works in relation to certain
36253 security concerns, not to make any specific claims about the effectiveness of
36254 its security as compared with other MTAs.
36255
36256 What follows is a description of the way Exim is supposed to be. Best efforts
36257 have been made to try to ensure that the code agrees with the theory, but an
36258 absence of bugs can never be guaranteed. Any that are reported will get fixed
36259 as soon as possible.
36260
36261
36262 .section "Building a more &""hardened""& Exim" "SECID286"
36263 .cindex "security" "build-time features"
36264 There are a number of build-time options that can be set in &_Local/Makefile_&
36265 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
36266 Exim administrator who does not have the root password, or by someone who has
36267 penetrated the Exim (but not the root) account. These options are as follows:
36268
36269 .ilist
36270 ALT_CONFIG_PREFIX can be set to a string that is required to match the
36271 start of any file names used with the &%-C%& option. When it is set, these file
36272 names are also not allowed to contain the sequence &"/../"&. (However, if the
36273 value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
36274 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
36275 default setting for &%ALT_CONFIG_PREFIX%&.
36276
36277 If the permitted configuration files are confined to a directory to
36278 which only root has access, this guards against someone who has broken
36279 into the Exim account from running a privileged Exim with an arbitrary
36280 configuration file, and using it to break into other accounts.
36281 .next
36282
36283 If a non-trusted configuration file (i.e. not the default configuration file
36284 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
36285 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
36286 the next item), then root privilege is retained only if the caller of Exim is
36287 root. This locks out the possibility of testing a configuration using &%-C%&
36288 right through message reception and delivery, even if the caller is root. The
36289 reception works, but by that time, Exim is running as the Exim user, so when
36290 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
36291 privilege to be lost. However, root can test reception and delivery using two
36292 separate commands.
36293
36294 .next
36295 The WHITELIST_D_MACROS build option declares some macros to be safe to override
36296 with &%-D%& if the real uid is one of root, the Exim run-time user or the
36297 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
36298 requiring the run-time value supplied to &%-D%& to match a regex that errs on
36299 the restrictive side.  Requiring build-time selection of safe macros is onerous
36300 but this option is intended solely as a transition mechanism to permit
36301 previously-working configurations to continue to work after release 4.73.
36302 .next
36303 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
36304 is disabled.
36305 .next
36306 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
36307 never to be used for any deliveries. This is like the &%never_users%& runtime
36308 option, but it cannot be overridden; the runtime option adds additional users
36309 to the list. The default setting is &"root"&; this prevents a non-root user who
36310 is permitted to modify the runtime file from using Exim as a way to get root.
36311 .endlist
36312
36313
36314
36315 .section "Root privilege" "SECID270"
36316 .cindex "setuid"
36317 .cindex "root privilege"
36318 The Exim binary is normally setuid to root, which means that it gains root
36319 privilege (runs as root) when it starts execution. In some special cases (for
36320 example, when the daemon is not in use and there are no local deliveries), it
36321 may be possible to run Exim setuid to some user other than root. This is
36322 discussed in the next section. However, in most installations, root privilege
36323 is required for two things:
36324
36325 .ilist
36326 To set up a socket connected to the standard SMTP port (25) when initialising
36327 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
36328 not required.
36329 .next
36330 To be able to change uid and gid in order to read users' &_.forward_& files and
36331 perform local deliveries as the receiving user or as specified in the
36332 configuration.
36333 .endlist
36334
36335 It is not necessary to be root to do any of the other things Exim does, such as
36336 receiving messages and delivering them externally over SMTP, and it is
36337 obviously more secure if Exim does not run as root except when necessary.
36338 For this reason, a user and group for Exim to use must be defined in
36339 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
36340 group"&. Their values can be changed by the run time configuration, though this
36341 is not recommended. Often a user called &'exim'& is used, but some sites use
36342 &'mail'& or another user name altogether.
36343
36344 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
36345 abdication; the process cannot regain root afterwards. Prior to release 4.00,
36346 &[seteuid()]& was used in some circumstances, but this is no longer the case.
36347
36348 After a new Exim process has interpreted its command line options, it changes
36349 uid and gid in the following cases:
36350
36351 .ilist
36352 .oindex "&%-C%&"
36353 .oindex "&%-D%&"
36354 If the &%-C%& option is used to specify an alternate configuration file, or if
36355 the &%-D%& option is used to define macro values for the configuration, and the
36356 calling process is not running as root, the uid and gid are changed to those of
36357 the calling process.
36358 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
36359 option may not be used at all.
36360 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
36361 can be supplied if the calling process is running as root, the Exim run-time
36362 user or CONFIGURE_OWNER, if defined.
36363 .next
36364 .oindex "&%-be%&"
36365 .oindex "&%-bf%&"
36366 .oindex "&%-bF%&"
36367 If the expansion test option (&%-be%&) or one of the filter testing options
36368 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
36369 calling process.
36370 .next
36371 If the process is not a daemon process or a queue runner process or a delivery
36372 process or a process for testing address routing (started with &%-bt%&), the
36373 uid and gid are changed to the Exim user and group. This means that Exim always
36374 runs under its own uid and gid when receiving messages. This also applies when
36375 testing address verification
36376 .oindex "&%-bv%&"
36377 .oindex "&%-bh%&"
36378 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
36379 option).
36380 .next
36381 For a daemon, queue runner, delivery, or address testing process, the uid
36382 remains as root at this stage, but the gid is changed to the Exim group.
36383 .endlist
36384
36385 The processes that initially retain root privilege behave as follows:
36386
36387 .ilist
36388 A daemon process changes the gid to the Exim group and the uid to the Exim
36389 user after setting up one or more listening sockets. The &[initgroups()]&
36390 function is called, so that if the Exim user is in any additional groups, they
36391 will be used during message reception.
36392 .next
36393 A queue runner process retains root privilege throughout its execution. Its
36394 job is to fork a controlled sequence of delivery processes.
36395 .next
36396 A delivery process retains root privilege throughout most of its execution,
36397 but any actual deliveries (that is, the transports themselves) are run in
36398 subprocesses which always change to a non-root uid and gid. For local
36399 deliveries this is typically the uid and gid of the owner of the mailbox; for
36400 remote deliveries, the Exim uid and gid are used. Once all the delivery
36401 subprocesses have been run, a delivery process changes to the Exim uid and gid
36402 while doing post-delivery tidying up such as updating the retry database and
36403 generating bounce and warning messages.
36404
36405 While the recipient addresses in a message are being routed, the delivery
36406 process runs as root. However, if a user's filter file has to be processed,
36407 this is done in a subprocess that runs under the individual user's uid and
36408 gid. A system filter is run as root unless &%system_filter_user%& is set.
36409 .next
36410 A process that is testing addresses (the &%-bt%& option) runs as root so that
36411 the routing is done in the same environment as a message delivery.
36412 .endlist
36413
36414
36415
36416
36417 .section "Running Exim without privilege" "SECTrunexiwitpri"
36418 .cindex "privilege, running without"
36419 .cindex "unprivileged running"
36420 .cindex "root privilege" "running without"
36421 Some installations like to run Exim in an unprivileged state for more of its
36422 operation, for added security. Support for this mode of operation is provided
36423 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
36424 gid are changed to the Exim user and group at the start of a delivery process
36425 (and also queue runner and address testing processes). This means that address
36426 routing is no longer run as root, and the deliveries themselves cannot change
36427 to any other uid.
36428
36429 .cindex SIGHUP
36430 .cindex "daemon" "restarting"
36431 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
36432 that the daemon can still be started in the usual way, and it can respond
36433 correctly to SIGHUP because the re-invocation regains root privilege.
36434
36435 An alternative approach is to make Exim setuid to the Exim user and also setgid
36436 to the Exim group. If you do this, the daemon must be started from a root
36437 process. (Calling Exim from a root process makes it behave in the way it does
36438 when it is setuid root.) However, the daemon cannot restart itself after a
36439 SIGHUP signal because it cannot regain privilege.
36440
36441 It is still useful to set &%deliver_drop_privilege%& in this case, because it
36442 stops Exim from trying to re-invoke itself to do a delivery after a message has
36443 been received. Such a re-invocation is a waste of resources because it has no
36444 effect.
36445
36446 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
36447 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
36448 to the Exim user seems a clean approach, but there is one complication:
36449
36450 In this style of operation, Exim is running with the real uid and gid set to
36451 those of the calling process, and the effective uid/gid set to Exim's values.
36452 Ideally, any association with the calling process' uid/gid should be dropped,
36453 that is, the real uid/gid should be reset to the effective values so as to
36454 discard any privileges that the caller may have. While some operating systems
36455 have a function that permits this action for a non-root effective uid, quite a
36456 number of them do not. Because of this lack of standardization, Exim does not
36457 address this problem at this time.
36458
36459 For this reason, the recommended approach for &"mostly unprivileged"& running
36460 is to keep the Exim binary setuid to root, and to set
36461 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
36462 be used in the most straightforward way.
36463
36464 If you configure Exim not to run delivery processes as root, there are a
36465 number of restrictions on what you can do:
36466
36467 .ilist
36468 You can deliver only as the Exim user/group. You should  explicitly use the
36469 &%user%& and &%group%& options to override routers or local transports that
36470 normally deliver as the recipient. This makes sure that configurations that
36471 work in this mode function the same way in normal mode. Any implicit or
36472 explicit specification of another user causes an error.
36473 .next
36474 Use of &_.forward_& files is severely restricted, such that it is usually
36475 not worthwhile to include them in the configuration.
36476 .next
36477 Users who wish to use &_.forward_& would have to make their home directory and
36478 the file itself accessible to the Exim user. Pipe and append-to-file entries,
36479 and their equivalents in Exim filters, cannot be used. While they could be
36480 enabled in the Exim user's name, that would be insecure and not very useful.
36481 .next
36482 Unless the local user mailboxes are all owned by the Exim user (possible in
36483 some POP3 or IMAP-only environments):
36484
36485 .olist
36486 They must be owned by the Exim group and be writeable by that group. This
36487 implies you must set &%mode%& in the appendfile configuration, as well as the
36488 mode of the mailbox files themselves.
36489 .next
36490 You must set &%no_check_owner%&, since most or all of the files will not be
36491 owned by the Exim user.
36492 .next
36493 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
36494 on a newly created mailbox when unprivileged. This also implies that new
36495 mailboxes need to be created manually.
36496 .endlist olist
36497 .endlist ilist
36498
36499
36500 These restrictions severely restrict what can be done in local deliveries.
36501 However, there are no restrictions on remote deliveries. If you are running a
36502 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
36503 gives more security at essentially no cost.
36504
36505 If you are using the &%mua_wrapper%& facility (see chapter
36506 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
36507
36508
36509
36510
36511 .section "Delivering to local files" "SECID271"
36512 Full details of the checks applied by &(appendfile)& before it writes to a file
36513 are given in chapter &<<CHAPappendfile>>&.
36514
36515
36516
36517 .section "Running local commands" "SECTsecconslocalcmds"
36518 .cindex "security" "local commands"
36519 .cindex "security" "command injection attacks"
36520 There are a number of ways in which an administrator can configure Exim to run
36521 commands based upon received, untrustworthy, data. Further, in some
36522 configurations a user who can control a &_.forward_& file can also arrange to
36523 run commands. Configuration to check includes, but is not limited to:
36524
36525 .ilist
36526 Use of &%use_shell%& in the pipe transport: various forms of shell command
36527 injection may be possible with this option present. It is dangerous and should
36528 be used only with considerable caution. Consider constraints which whitelist
36529 allowed characters in a variable which is to be used in a pipe transport that
36530 has &%use_shell%& enabled.
36531 .next
36532 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
36533 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
36534 &_.forward_& files in a redirect router. If Exim is running on a central mail
36535 hub to which ordinary users do not have shell access, but home directories are
36536 NFS mounted (for instance) then administrators should review the list of these
36537 forbid options available, and should bear in mind that the options that may
36538 need forbidding can change as new features are added between releases.
36539 .next
36540 The &%${run...}%& expansion item does not use a shell by default, but
36541 administrators can configure use of &_/bin/sh_& as part of the command.
36542 Such invocations should be viewed with prejudicial suspicion.
36543 .next
36544 Administrators who use embedded Perl are advised to explore how Perl's
36545 taint checking might apply to their usage.
36546 .next
36547 Use of &%${expand...}%& is somewhat analagous to shell's eval builtin and
36548 administrators are well advised to view its use with suspicion, in case (for
36549 instance) it allows a local-part to contain embedded Exim directives.
36550 .next
36551 Use of &%${match_local_part...}%& and friends becomes more dangerous if
36552 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
36553 each can reference arbitrary lists and files, rather than just being a list
36554 of opaque strings.
36555 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
36556 real-world security vulnerabilities caused by its use with untrustworthy data
36557 injected in, for SQL injection attacks.
36558 Consider the use of the &%inlisti%& expansion condition instead.
36559 .endlist
36560
36561
36562
36563
36564 .section "Trust in configuration data" "SECTsecconfdata"
36565 .cindex "security" "data sources"
36566 .cindex "security" "regular expressions"
36567 .cindex "regular expressions" "security"
36568 .cindex "PCRE" "security"
36569 If configuration data for Exim can come from untrustworthy sources, there
36570 are some issues to be aware of:
36571
36572 .ilist
36573 Use of &%${expand...}%& may provide a path for shell injection attacks.
36574 .next
36575 Letting untrusted data provide a regular expression is unwise.
36576 .next
36577 Using &%${match...}%& to apply a fixed regular expression against untrusted
36578 data may result in pathological behaviour within PCRE.  Be aware of what
36579 "backtracking" means and consider options for being more strict with a regular
36580 expression. Avenues to explore include limiting what can match (avoiding &`.`&
36581 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
36582 possessive quantifiers or just not using regular expressions against untrusted
36583 data.
36584 .next
36585 It can be important to correctly use &%${quote:...}%&,
36586 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
36587 items to ensure that data is correctly constructed.
36588 .next
36589 Some lookups might return multiple results, even though normal usage is only
36590 expected to yield one result.
36591 .endlist
36592
36593
36594
36595
36596 .section "IPv4 source routing" "SECID272"
36597 .cindex "source routing" "in IP packets"
36598 .cindex "IP source routing"
36599 Many operating systems suppress IP source-routed packets in the kernel, but
36600 some cannot be made to do this, so Exim does its own check. It logs incoming
36601 IPv4 source-routed TCP calls, and then drops them. Things are all different in
36602 IPv6. No special checking is currently done.
36603
36604
36605
36606 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
36607 Support for these SMTP commands is disabled by default. If required, they can
36608 be enabled by defining suitable ACLs.
36609
36610
36611
36612
36613 .section "Privileged users" "SECID274"
36614 .cindex "trusted users"
36615 .cindex "admin user"
36616 .cindex "privileged user"
36617 .cindex "user" "trusted"
36618 .cindex "user" "admin"
36619 Exim recognizes two sets of users with special privileges. Trusted users are
36620 able to submit new messages to Exim locally, but supply their own sender
36621 addresses and information about a sending host. For other users submitting
36622 local messages, Exim sets up the sender address from the uid, and doesn't
36623 permit a remote host to be specified.
36624
36625 .oindex "&%-f%&"
36626 However, an untrusted user is permitted to use the &%-f%& command line option
36627 in the special form &%-f <>%& to indicate that a delivery failure for the
36628 message should not cause an error report. This affects the message's envelope,
36629 but it does not affect the &'Sender:'& header. Untrusted users may also be
36630 permitted to use specific forms of address with the &%-f%& option by setting
36631 the &%untrusted_set_sender%& option.
36632
36633 Trusted users are used to run processes that receive mail messages from some
36634 other mail domain and pass them on to Exim for delivery either locally, or over
36635 the Internet. Exim trusts a caller that is running as root, as the Exim user,
36636 as any user listed in the &%trusted_users%& configuration option, or under any
36637 group listed in the &%trusted_groups%& option.
36638
36639 Admin users are permitted to do things to the messages on Exim's queue. They
36640 can freeze or thaw messages, cause them to be returned to their senders, remove
36641 them entirely, or modify them in various ways. In addition, admin users can run
36642 the Exim monitor and see all the information it is capable of providing, which
36643 includes the contents of files on the spool.
36644
36645 .oindex "&%-M%&"
36646 .oindex "&%-q%&"
36647 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
36648 delivery of messages on its queue is restricted to admin users. This
36649 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
36650 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
36651 queue is also restricted to admin users. This restriction can be relaxed by
36652 setting &%no_queue_list_requires_admin%&.
36653
36654 Exim recognizes an admin user if the calling process is running as root or as
36655 the Exim user or if any of the groups associated with the calling process is
36656 the Exim group. It is not necessary actually to be running under the Exim
36657 group. However, if admin users who are not root or the Exim user are to access
36658 the contents of files on the spool via the Exim monitor (which runs
36659 unprivileged), Exim must be built to allow group read access to its spool
36660 files.
36661
36662
36663
36664 .section "Spool files" "SECID275"
36665 .cindex "spool directory" "files"
36666 Exim's spool directory and everything it contains is owned by the Exim user and
36667 set to the Exim group. The mode for spool files is defined in the
36668 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
36669 any user who is a member of the Exim group can access these files.
36670
36671
36672
36673 .section "Use of argv[0]" "SECID276"
36674 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
36675 of specific strings, Exim assumes certain options. For example, calling Exim
36676 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
36677 to calling it with the option &%-bS%&. There are no security implications in
36678 this.
36679
36680
36681
36682 .section "Use of %f formatting" "SECID277"
36683 The only use made of &"%f"& by Exim is in formatting load average values. These
36684 are actually stored in integer variables as 1000 times the load average.
36685 Consequently, their range is limited and so therefore is the length of the
36686 converted output.
36687
36688
36689
36690 .section "Embedded Exim path" "SECID278"
36691 Exim uses its own path name, which is embedded in the code, only when it needs
36692 to re-exec in order to regain root privilege. Therefore, it is not root when it
36693 does so. If some bug allowed the path to get overwritten, it would lead to an
36694 arbitrary program's being run as exim, not as root.
36695
36696
36697
36698 .section "Dynamic module directory" "SECTdynmoddir"
36699 Any dynamically loadable modules must be installed into the directory
36700 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
36701 loading it.
36702
36703
36704 .section "Use of sprintf()" "SECID279"
36705 .cindex "&[sprintf()]&"
36706 A large number of occurrences of &"sprintf"& in the code are actually calls to
36707 &'string_sprintf()'&, a function that returns the result in malloc'd store.
36708 The intermediate formatting is done into a large fixed buffer by a function
36709 that runs through the format string itself, and checks the length of each
36710 conversion before performing it, thus preventing buffer overruns.
36711
36712 The remaining uses of &[sprintf()]& happen in controlled circumstances where
36713 the output buffer is known to be sufficiently long to contain the converted
36714 string.
36715
36716
36717
36718 .section "Use of debug_printf() and log_write()" "SECID280"
36719 Arbitrary strings are passed to both these functions, but they do their
36720 formatting by calling the function &'string_vformat()'&, which runs through
36721 the format string itself, and checks the length of each conversion.
36722
36723
36724
36725 .section "Use of strcat() and strcpy()" "SECID281"
36726 These are used only in cases where the output buffer is known to be large
36727 enough to hold the result.
36728 .ecindex IIDsecurcon
36729
36730
36731
36732
36733 . ////////////////////////////////////////////////////////////////////////////
36734 . ////////////////////////////////////////////////////////////////////////////
36735
36736 .chapter "Format of spool files" "CHAPspool"
36737 .scindex IIDforspo1 "format" "spool files"
36738 .scindex IIDforspo2 "spool directory" "format of files"
36739 .scindex IIDforspo3 "spool files" "format of"
36740 .cindex "spool files" "editing"
36741 A message on Exim's queue consists of two files, whose names are the message id
36742 followed by -D and -H, respectively. The data portion of the message is kept in
36743 the -D file on its own. The message's envelope, status, and headers are all
36744 kept in the -H file, whose format is described in this chapter. Each of these
36745 two files contains the final component of its own name as its first line. This
36746 is insurance against disk crashes where the directory is lost but the files
36747 themselves are recoverable.
36748
36749 Some people are tempted into editing -D files in order to modify messages. You
36750 need to be extremely careful if you do this; it is not recommended and you are
36751 on your own if you do it. Here are some of the pitfalls:
36752
36753 .ilist
36754 You must ensure that Exim does not try to deliver the message while you are
36755 fiddling with it. The safest way is to take out a write lock on the -D file,
36756 which is what Exim itself does, using &[fcntl()]&. If you update the file in
36757 place, the lock will be retained. If you write a new file and rename it, the
36758 lock will be lost at the instant of rename.
36759 .next
36760 .vindex "&$body_linecount$&"
36761 If you change the number of lines in the file, the value of
36762 &$body_linecount$&, which is stored in the -H file, will be incorrect. At
36763 present, this value is not used by Exim, but there is no guarantee that this
36764 will always be the case.
36765 .next
36766 If the message is in MIME format, you must take care not to break it.
36767 .next
36768 If the message is cryptographically signed, any change will invalidate the
36769 signature.
36770 .endlist
36771 All in all, modifying -D files is fraught with danger.
36772
36773 Files whose names end with -J may also be seen in the &_input_& directory (or
36774 its subdirectories when &%split_spool_directory%& is set). These are journal
36775 files, used to record addresses to which the message has been delivered during
36776 the course of a delivery attempt. If there are still undelivered recipients at
36777 the end, the -H file is updated, and the -J file is deleted. If, however, there
36778 is some kind of crash (for example, a power outage) before this happens, the -J
36779 file remains in existence. When Exim next processes the message, it notices the
36780 -J file and uses it to update the -H file before starting the next delivery
36781 attempt.
36782
36783 .section "Format of the -H file" "SECID282"
36784 .cindex "uid (user id)" "in spool file"
36785 .cindex "gid (group id)" "in spool file"
36786 The second line of the -H file contains the login name for the uid of the
36787 process that called Exim to read the message, followed by the numerical uid and
36788 gid. For a locally generated message, this is normally the user who sent the
36789 message. For a message received over TCP/IP via the daemon, it is
36790 normally the Exim user.
36791
36792 The third line of the file contains the address of the message's sender as
36793 transmitted in the envelope, contained in angle brackets. The sender address is
36794 empty for bounce messages. For incoming SMTP mail, the sender address is given
36795 in the MAIL command. For locally generated mail, the sender address is
36796 created by Exim from the login name of the current user and the configured
36797 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
36798 leading &"From&~"& line if the caller is trusted, or if the supplied address is
36799 &"<>"& or an address that matches &%untrusted_set_senders%&.
36800
36801 The fourth line contains two numbers. The first is the time that the message
36802 was received, in the conventional Unix form &-- the number of seconds since the
36803 start of the epoch. The second number is a count of the number of messages
36804 warning of delayed delivery that have been sent to the sender.
36805
36806 There follow a number of lines starting with a hyphen. These can appear in any
36807 order, and are omitted when not relevant:
36808
36809 .vlist
36810 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
36811 This item is obsolete, and is not generated from Exim release 4.61 onwards;
36812 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
36813 recognized, to provide backward compatibility. In the old format, a line of
36814 this form is present for every ACL variable that is not empty. The number
36815 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
36816 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
36817 the data string for the variable. The string itself starts at the beginning of
36818 the next line, and is followed by a newline character. It may contain internal
36819 newlines.
36820
36821 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
36822 A line of this form is present for every ACL connection variable that is
36823 defined. Note that there is a space between &%-aclc%& and the rest of the name.
36824 The length is the length of the data string for the variable. The string itself
36825 starts at the beginning of the next line, and is followed by a newline
36826 character. It may contain internal newlines.
36827
36828 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
36829 A line of this form is present for every ACL message variable that is defined.
36830 Note that there is a space between &%-aclm%& and the rest of the name. The
36831 length is the length of the data string for the variable. The string itself
36832 starts at the beginning of the next line, and is followed by a newline
36833 character. It may contain internal newlines.
36834
36835 .vitem "&%-active_hostname%&&~<&'hostname'&>"
36836 This is present if, when the message was received over SMTP, the value of
36837 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
36838
36839 .vitem &%-allow_unqualified_recipient%&
36840 This is present if unqualified recipient addresses are permitted in header
36841 lines (to stop such addresses from being qualified if rewriting occurs at
36842 transport time). Local messages that were input using &%-bnq%& and remote
36843 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
36844
36845 .vitem &%-allow_unqualified_sender%&
36846 This is present if unqualified sender addresses are permitted in header lines
36847 (to stop such addresses from being qualified if rewriting occurs at transport
36848 time). Local messages that were input using &%-bnq%& and remote messages from
36849 hosts that match &%sender_unqualified_hosts%& set this flag.
36850
36851 .vitem "&%-auth_id%&&~<&'text'&>"
36852 The id information for a message received on an authenticated SMTP connection
36853 &-- the value of the &$authenticated_id$& variable.
36854
36855 .vitem "&%-auth_sender%&&~<&'address'&>"
36856 The address of an authenticated sender &-- the value of the
36857 &$authenticated_sender$& variable.
36858
36859 .vitem "&%-body_linecount%&&~<&'number'&>"
36860 This records the number of lines in the body of the message, and is always
36861 present.
36862
36863 .vitem "&%-body_zerocount%&&~<&'number'&>"
36864 This records the number of binary zero bytes in the body of the message, and is
36865 present if the number is greater than zero.
36866
36867 .vitem &%-deliver_firsttime%&
36868 This is written when a new message is first added to the spool. When the spool
36869 file is updated after a deferral, it is omitted.
36870
36871 .vitem "&%-frozen%&&~<&'time'&>"
36872 .cindex "frozen messages" "spool data"
36873 The message is frozen, and the freezing happened at <&'time'&>.
36874
36875 .vitem "&%-helo_name%&&~<&'text'&>"
36876 This records the host name as specified by a remote host in a HELO or EHLO
36877 command.
36878
36879 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
36880 This records the IP address of the host from which the message was received and
36881 the remote port number that was used. It is omitted for locally generated
36882 messages.
36883
36884 .vitem "&%-host_auth%&&~<&'text'&>"
36885 If the message was received on an authenticated SMTP connection, this records
36886 the name of the authenticator &-- the value of the
36887 &$sender_host_authenticated$& variable.
36888
36889 .vitem &%-host_lookup_failed%&
36890 This is present if an attempt to look up the sending host's name from its IP
36891 address failed. It corresponds to the &$host_lookup_failed$& variable.
36892
36893 .vitem "&%-host_name%&&~<&'text'&>"
36894 .cindex "reverse DNS lookup"
36895 .cindex "DNS" "reverse lookup"
36896 This records the name of the remote host from which the message was received,
36897 if the host name was looked up from the IP address when the message was being
36898 received. It is not present if no reverse lookup was done.
36899
36900 .vitem "&%-ident%&&~<&'text'&>"
36901 For locally submitted messages, this records the login of the originating user,
36902 unless it was a trusted user and the &%-oMt%& option was used to specify an
36903 ident value. For messages received over TCP/IP, this records the ident string
36904 supplied by the remote host, if any.
36905
36906 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
36907 This records the IP address of the local interface and the port number through
36908 which a message was received from a remote host. It is omitted for locally
36909 generated messages.
36910
36911 .vitem &%-local%&
36912 The message is from a local sender.
36913
36914 .vitem &%-localerror%&
36915 The message is a locally-generated bounce message.
36916
36917 .vitem "&%-local_scan%&&~<&'string'&>"
36918 This records the data string that was returned by the &[local_scan()]& function
36919 when the message was received &-- the value of the &$local_scan_data$&
36920 variable. It is omitted if no data was returned.
36921
36922 .vitem &%-manual_thaw%&
36923 The message was frozen but has been thawed manually, that is, by an explicit
36924 Exim command rather than via the auto-thaw process.
36925
36926 .vitem &%-N%&
36927 A testing delivery process was started using the &%-N%& option to suppress any
36928 actual deliveries, but delivery was deferred. At any further delivery attempts,
36929 &%-N%& is assumed.
36930
36931 .vitem &%-received_protocol%&
36932 This records the value of the &$received_protocol$& variable, which contains
36933 the name of the protocol by which the message was received.
36934
36935 .vitem &%-sender_set_untrusted%&
36936 The envelope sender of this message was set by an untrusted local caller (used
36937 to ensure that the caller is displayed in queue listings).
36938
36939 .vitem "&%-spam_score_int%&&~<&'number'&>"
36940 If a message was scanned by SpamAssassin, this is present. It records the value
36941 of &$spam_score_int$&.
36942
36943 .vitem &%-tls_certificate_verified%&
36944 A TLS certificate was received from the client that sent this message, and the
36945 certificate was verified by the server.
36946
36947 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
36948 When the message was received over an encrypted connection, this records the
36949 name of the cipher suite that was used.
36950
36951 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
36952 When the message was received over an encrypted connection, and a certificate
36953 was received from the client, this records the Distinguished Name from that
36954 certificate.
36955 .endlist
36956
36957 Following the options there is a list of those addresses to which the message
36958 is not to be delivered. This set of addresses is initialized from the command
36959 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
36960 is set; otherwise it starts out empty. Whenever a successful delivery is made,
36961 the address is added to this set. The addresses are kept internally as a
36962 balanced binary tree, and it is a representation of that tree which is written
36963 to the spool file. If an address is expanded via an alias or forward file, the
36964 original address is added to the tree when deliveries to all its child
36965 addresses are complete.
36966
36967 If the tree is empty, there is a single line in the spool file containing just
36968 the text &"XX"&. Otherwise, each line consists of two letters, which are either
36969 Y or N, followed by an address. The address is the value for the node of the
36970 tree, and the letters indicate whether the node has a left branch and/or a
36971 right branch attached to it, respectively. If branches exist, they immediately
36972 follow. Here is an example of a three-node tree:
36973 .code
36974 YY darcy@austen.fict.example
36975 NN alice@wonderland.fict.example
36976 NN editor@thesaurus.ref.example
36977 .endd
36978 After the non-recipients tree, there is a list of the message's recipients.
36979 This is a simple list, preceded by a count. It includes all the original
36980 recipients of the message, including those to whom the message has already been
36981 delivered. In the simplest case, the list contains one address per line. For
36982 example:
36983 .code
36984 4
36985 editor@thesaurus.ref.example
36986 darcy@austen.fict.example
36987 rdo@foundation
36988 alice@wonderland.fict.example
36989 .endd
36990 However, when a child address has been added to the top-level addresses as a
36991 result of the use of the &%one_time%& option on a &(redirect)& router, each
36992 line is of the following form:
36993 .display
36994 <&'top-level address'&> <&'errors_to address'&> &&&
36995   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
36996 .endd
36997 The 01 flag bit indicates the presence of the three other fields that follow
36998 the top-level address. Other bits may be used in future to support additional
36999 fields. The <&'parent number'&> is the offset in the recipients list of the
37000 original parent of the &"one time"& address. The first two fields are the
37001 envelope sender that is associated with this address and its length. If the
37002 length is zero, there is no special envelope sender (there are then two space
37003 characters in the line). A non-empty field can arise from a &(redirect)& router
37004 that has an &%errors_to%& setting.
37005
37006
37007 A blank line separates the envelope and status information from the headers
37008 which follow. A header may occupy several lines of the file, and to save effort
37009 when reading it in, each header is preceded by a number and an identifying
37010 character. The number is the number of characters in the header, including any
37011 embedded newlines and the terminating newline. The character is one of the
37012 following:
37013
37014 .table2 50pt
37015 .row <&'blank'&>         "header in which Exim has no special interest"
37016 .row &`B`&               "&'Bcc:'& header"
37017 .row &`C`&               "&'Cc:'& header"
37018 .row &`F`&               "&'From:'& header"
37019 .row &`I`&               "&'Message-id:'& header"
37020 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
37021 .row &`R`&               "&'Reply-To:'& header"
37022 .row &`S`&               "&'Sender:'& header"
37023 .row &`T`&               "&'To:'& header"
37024 .row &`*`&               "replaced or deleted header"
37025 .endtable
37026
37027 Deleted or replaced (rewritten) headers remain in the spool file for debugging
37028 purposes. They are not transmitted when the message is delivered. Here is a
37029 typical set of headers:
37030 .code
37031 111P Received: by hobbit.fict.example with local (Exim 4.00)
37032 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
37033 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
37034 038* X-rewrote-sender: bb@hobbit.fict.example
37035 042* From: Bilbo Baggins <bb@hobbit.fict.example>
37036 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
37037 099* To: alice@wonderland.fict.example, rdo@foundation,
37038 darcy@austen.fict.example, editor@thesaurus.ref.example
37039 104T To: alice@wonderland.fict.example, rdo@foundation.example,
37040 darcy@austen.fict.example, editor@thesaurus.ref.example
37041 038  Date: Fri, 11 May 2001 10:28:59 +0100
37042 .endd
37043 The asterisked headers indicate that the envelope sender, &'From:'& header, and
37044 &'To:'& header have been rewritten, the last one because routing expanded the
37045 unqualified domain &'foundation'&.
37046 .ecindex IIDforspo1
37047 .ecindex IIDforspo2
37048 .ecindex IIDforspo3
37049
37050 . ////////////////////////////////////////////////////////////////////////////
37051 . ////////////////////////////////////////////////////////////////////////////
37052
37053 .chapter "Support for DKIM (DomainKeys Identified Mail)" "CHAPdkim" &&&
37054          "DKIM Support"
37055 .cindex "DKIM"
37056
37057 DKIM is a mechanism by which messages sent by some entity can be provably
37058 linked to a domain which that entity controls.  It permits reputation to
37059 be tracked on a per-domain basis, rather than merely upon source IP address.
37060 DKIM is documented in RFC 4871.
37061
37062 Since version 4.70, DKIM support is compiled into Exim by default. It can be
37063 disabled by setting DISABLE_DKIM=yes in Local/Makefile.
37064
37065 Exim's DKIM implementation allows to
37066 .olist
37067 Sign outgoing messages: This function is implemented in the SMTP transport.
37068 It can co-exist with all other Exim features
37069 (including transport filters)
37070 except cutthrough delivery.
37071 .next
37072 Verify signatures in incoming messages: This is implemented by an additional
37073 ACL (acl_smtp_dkim), which can be called several times per message, with
37074 different signature contexts.
37075 .endlist
37076
37077 In typical Exim style, the verification implementation does not include any
37078 default "policy". Instead it enables you to build your own policy using
37079 Exim's standard controls.
37080
37081 Please note that verification of DKIM signatures in incoming mail is turned
37082 on by default for logging purposes. For each signature in incoming email,
37083 exim will log a line displaying the most important signature details, and the
37084 signature status. Here is an example (with line-breaks added for clarity):
37085 .code
37086 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
37087     d=facebookmail.com s=q1-2009b
37088     c=relaxed/relaxed a=rsa-sha1
37089     i=@facebookmail.com t=1252484542 [verification succeeded]
37090 .endd
37091 You might want to turn off DKIM verification processing entirely for internal
37092 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
37093 control modifier. This should typically be done in the RCPT ACL, at points
37094 where you accept mail from relay sources (internal hosts or authenticated
37095 senders).
37096
37097
37098 .section "Signing outgoing messages" "SECID513"
37099 .cindex "DKIM" "signing"
37100
37101 Signing is implemented by setting private options on the SMTP transport.
37102 These options take (expandable) strings as arguments.
37103
37104 .option dkim_domain smtp string&!! unset
37105 MANDATORY:
37106 The domain you want to sign with. The result of this expanded
37107 option is put into the &%$dkim_domain%& expansion variable.
37108
37109 .option dkim_selector smtp string&!! unset
37110 MANDATORY:
37111 This sets the key selector string. You can use the &%$dkim_domain%& expansion
37112 variable to look up a matching selector. The result is put in the expansion
37113 variable &%$dkim_selector%& which should be used in the &%dkim_private_key%&
37114 option along with &%$dkim_domain%&.
37115
37116 .option dkim_private_key smtp string&!! unset
37117 MANDATORY:
37118 This sets the private key to use. You can use the &%$dkim_domain%& and
37119 &%$dkim_selector%& expansion variables to determine the private key to use.
37120 The result can either
37121 .ilist
37122 be a valid RSA private key in ASCII armor, including line breaks.
37123 .next
37124 start with a slash, in which case it is treated as a file that contains
37125 the private key.
37126 .next
37127 be "0", "false" or the empty string, in which case the message will not
37128 be signed. This case will not result in an error, even if &%dkim_strict%&
37129 is set.
37130 .endlist
37131
37132 .option dkim_canon smtp string&!! unset
37133 OPTIONAL:
37134 This option sets the canonicalization method used when signing a message.
37135 The DKIM RFC currently supports two methods: "simple" and "relaxed".
37136 The option defaults to "relaxed" when unset. Note: the current implementation
37137 only supports using the same canonicalization method for both headers and body.
37138
37139 .option dkim_strict smtp string&!! unset
37140 OPTIONAL:
37141 This  option  defines  how  Exim  behaves  when  signing a message that
37142 should be signed fails for some reason.  When the expansion evaluates to
37143 either "1" or "true", Exim will defer. Otherwise Exim will send the message
37144 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
37145 variables here.
37146
37147 .option dkim_sign_headers smtp string&!! unset
37148 OPTIONAL:
37149 When set, this option must expand to (or be specified as) a colon-separated
37150 list of header names. Headers with these names will be included in the message
37151 signature. When unspecified, the header names recommended in RFC4871 will be
37152 used.
37153
37154
37155 .section "Verifying DKIM signatures in incoming mail" "SECID514"
37156 .cindex "DKIM" "verification"
37157
37158 Verification of DKIM signatures in incoming email is implemented via the
37159 &%acl_smtp_dkim%& ACL. By default, this ACL is called once for each
37160 syntactically(!) correct signature in the incoming message.
37161 A missing ACL definition defaults to accept.
37162 If any ACL call does not acccept, the message is not accepted.
37163 If a cutthrough delivery was in progress for the message it is
37164 summarily dropped (having wasted the transmission effort).
37165
37166 To evaluate the signature in the ACL a large number of expansion variables
37167 containing the signature status and its details are set up during the
37168 runtime of the ACL.
37169
37170 Calling the ACL only for existing signatures is not sufficient to build
37171 more advanced policies. For that reason, the global option
37172 &%dkim_verify_signers%&, and a global expansion variable
37173 &%$dkim_signers%& exist.
37174
37175 The global option &%dkim_verify_signers%& can be set to a colon-separated
37176 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
37177 called. It is expanded when the message has been received. At this point,
37178 the expansion variable &%$dkim_signers%& already contains a colon-separated
37179 list of signer domains and identities for the message. When
37180 &%dkim_verify_signers%& is not specified in the main configuration,
37181 it defaults as:
37182 .code
37183 dkim_verify_signers = $dkim_signers
37184 .endd
37185 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
37186 DKIM signature in the message. Current DKIM verifiers may want to explicitly
37187 call the ACL for known domains or identities. This would be achieved as follows:
37188 .code
37189 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
37190 .endd
37191 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
37192 and "ebay.com", plus all domains and identities that have signatures in the message.
37193 You can also be more creative in constructing your policy. For example:
37194 .code
37195 dkim_verify_signers = $sender_address_domain:$dkim_signers
37196 .endd
37197
37198 If a domain or identity is listed several times in the (expanded) value of
37199 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
37200
37201
37202 Inside the &%acl_smtp_dkim%&, the following expansion variables are
37203 available (from most to least important):
37204
37205
37206 .vlist
37207 .vitem &%$dkim_cur_signer%&
37208 The signer that is being evaluated in this ACL run. This can be a domain or
37209 an identity. This is one of the list items from the expanded main option
37210 &%dkim_verify_signers%& (see above).
37211 .vitem &%$dkim_verify_status%&
37212 A string describing the general status of the signature. One of
37213 .ilist
37214 &%none%&: There is no signature in the message for the current domain or
37215 identity (as reflected by &%$dkim_cur_signer%&).
37216 .next
37217 &%invalid%&: The signature could not be verified due to a processing error.
37218 More detail is available in &%$dkim_verify_reason%&.
37219 .next
37220 &%fail%&: Verification of the signature failed.  More detail is
37221 available in &%$dkim_verify_reason%&.
37222 .next
37223 &%pass%&: The signature passed verification. It is valid.
37224 .endlist
37225 .vitem &%$dkim_verify_reason%&
37226 A string giving a litte bit more detail when &%$dkim_verify_status%& is either
37227 "fail" or "invalid". One of
37228 .ilist
37229 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
37230 key for the domain could not be retrieved. This may be a temporary problem.
37231 .next
37232 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
37233 record for the domain is syntactically invalid.
37234 .next
37235 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
37236 body hash does not match the one specified in the signature header. This
37237 means that the message body was modified in transit.
37238 .next
37239 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
37240 could not be verified. This may mean that headers were modified,
37241 re-written or otherwise changed in a way which is incompatible with
37242 DKIM verification. It may of course also mean that the signature is forged.
37243 .endlist
37244 .vitem &%$dkim_domain%&
37245 The signing domain. IMPORTANT: This variable is only populated if there is
37246 an actual signature in the message for the current domain or identity (as
37247 reflected by &%$dkim_cur_signer%&).
37248 .vitem &%$dkim_identity%&
37249 The signing identity, if present. IMPORTANT: This variable is only populated
37250 if there is an actual signature in the message for the current domain or
37251 identity (as reflected by &%$dkim_cur_signer%&).
37252 .vitem &%$dkim_selector%&
37253 The key record selector string.
37254 .vitem &%$dkim_algo%&
37255 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
37256 .vitem &%$dkim_canon_body%&
37257 The body canonicalization method. One of 'relaxed' or 'simple'.
37258 .vitem &%dkim_canon_headers%&
37259 The header canonicalization method. One of 'relaxed' or 'simple'.
37260 .vitem &%$dkim_copiedheaders%&
37261 A transcript of headers and their values which are included in the signature
37262 (copied from the 'z=' tag of the signature).
37263 .vitem &%$dkim_bodylength%&
37264 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
37265 limit was set by the signer, "9999999999999" is returned. This makes sure
37266 that this variable always expands to an integer value.
37267 .vitem &%$dkim_created%&
37268 UNIX timestamp reflecting the date and time when the signature was created.
37269 When this was not specified by the signer, "0" is returned.
37270 .vitem &%$dkim_expires%&
37271 UNIX timestamp reflecting the date and time when the signer wants the
37272 signature to be treated as "expired". When this was not specified by the
37273 signer, "9999999999999" is returned. This makes it possible to do useful
37274 integer size comparisons against this value.
37275 .vitem &%$dkim_headernames%&
37276 A colon-separated list of names of headers included in the signature.
37277 .vitem &%$dkim_key_testing%&
37278 "1" if the key record has the "testing" flag set, "0" if not.
37279 .vitem &%$dkim_key_nosubdomains%&
37280 "1" if the key record forbids subdomaining, "0" otherwise.
37281 .vitem &%$dkim_key_srvtype%&
37282 Service type (tag s=) from the key record. Defaults to "*" if not specified
37283 in the key record.
37284 .vitem &%$dkim_key_granularity%&
37285 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
37286 in the key record.
37287 .vitem &%$dkim_key_notes%&
37288 Notes from the key record (tag n=).
37289 .endlist
37290
37291 In addition, two ACL conditions are provided:
37292
37293 .vlist
37294 .vitem &%dkim_signers%&
37295 ACL condition that checks a colon-separated list of domains or identities
37296 for a match against the domain or identity that the ACL is currently verifying
37297 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
37298 verb to a group of domains or identities. For example:
37299
37300 .code
37301 # Warn when Mail purportedly from GMail has no signature at all
37302 warn log_message = GMail sender without DKIM signature
37303      sender_domains = gmail.com
37304      dkim_signers = gmail.com
37305      dkim_status = none
37306 .endd
37307
37308 .vitem &%dkim_status%&
37309 ACL condition that checks a colon-separated list of possible DKIM verification
37310 results against the actual result of verification. This is typically used
37311 to restrict an ACL verb to a list of verification outcomes, for example:
37312
37313 .code
37314 deny message = Mail from Paypal with invalid/missing signature
37315      sender_domains = paypal.com:paypal.de
37316      dkim_signers = paypal.com:paypal.de
37317      dkim_status = none:invalid:fail
37318 .endd
37319
37320 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
37321 see the documentation of the &%$dkim_verify_status%& expansion variable above
37322 for more information of what they mean.
37323 .endlist
37324
37325 . ////////////////////////////////////////////////////////////////////////////
37326 . ////////////////////////////////////////////////////////////////////////////
37327
37328 .chapter "Adding new drivers or lookup types" "CHID13" &&&
37329          "Adding drivers or lookups"
37330 .cindex "adding drivers"
37331 .cindex "new drivers, adding"
37332 .cindex "drivers" "adding new"
37333 The following actions have to be taken in order to add a new router, transport,
37334 authenticator, or lookup type to Exim:
37335
37336 .olist
37337 Choose a name for the driver or lookup type that does not conflict with any
37338 existing name; I will use &"newdriver"& in what follows.
37339 .next
37340 Add to &_src/EDITME_& the line:
37341 .display
37342 <&'type'&>&`_NEWDRIVER=yes`&
37343 .endd
37344 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
37345 code is not to be included in the binary by default, comment this line out. You
37346 should also add any relevant comments about the driver or lookup type.
37347 .next
37348 Add to &_src/config.h.defaults_& the line:
37349 .code
37350 #define <type>_NEWDRIVER
37351 .endd
37352 .next
37353 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
37354 and create a table entry as is done for all the other drivers and lookup types.
37355 .next
37356 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
37357 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
37358 Add your &`NEWDRIVER`& to that list.
37359 As long as the dynamic module would be named &_newdriver.so_&, you can use the
37360 simple form that most lookups have.
37361 .next
37362 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
37363 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
37364 driver or lookup type and add it to the definition of OBJ.
37365 .next
37366 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
37367 &_src_&.
37368 .next
37369 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
37370 as for other drivers and lookups.
37371 .endlist
37372
37373 Then all you need to do is write the code! A good way to start is to make a
37374 proforma by copying an existing module of the same type, globally changing all
37375 occurrences of the name, and cutting out most of the code. Note that any
37376 options you create must be listed in alphabetical order, because the tables are
37377 searched using a binary chop procedure.
37378
37379 There is a &_README_& file in each of the sub-directories of &_src_& describing
37380 the interface that is expected.
37381
37382
37383
37384
37385 . ////////////////////////////////////////////////////////////////////////////
37386 . ////////////////////////////////////////////////////////////////////////////
37387
37388 . /////////////////////////////////////////////////////////////////////////////
37389 . These lines are processing instructions for the Simple DocBook Processor that
37390 . Philip Hazel has developed as a less cumbersome way of making PostScript and
37391 . PDFs than using xmlto and fop. They will be ignored by all other XML
37392 . processors.
37393 . /////////////////////////////////////////////////////////////////////////////
37394
37395 .literal xml
37396 <?sdop
37397   format="newpage"
37398   foot_right_recto="&chaptertitle;"
37399   foot_right_verso="&chaptertitle;"
37400 ?>
37401 .literal off
37402
37403 .makeindex "Options index"   "option"
37404 .makeindex "Variables index" "variable"
37405 .makeindex "Concept index"   "concept"
37406
37407
37408 . /////////////////////////////////////////////////////////////////////////////
37409 . /////////////////////////////////////////////////////////////////////////////